The C Preprocessor

The C Preprocessor is the first stage in the compilation pipeline. It is not part of the C language itself but a separate program that performs simple text-based manipulations on the source code before the code is handed off to the compiler. All preprocessor directives begin with the pound symbol (#).

1. Macro Substitution (#define)

The #define directive is used to define a macro, which is a symbolic name (constant) or a snippet of code that the preprocessor replaces with its defined value throughout the source file.

A. Constant Macros

Defines a symbolic constant. This is similar to a const variable but is handled before compilation.

Syntax: #define MACRO_NAME replacement_text

#define PI 3.14159
#define MAX_SIZE 100

B. Function-like Macros

Defines a macro that behaves like a function, accepting arguments. This is often used for simple, speed-critical operations, as it avoids the overhead of a function call.

// Defines a macro to calculate the square of a number
#define SQUARE(x) ((x) * (x)) 

int result = SQUARE(5); // Preprocessed to: int result = ((5) * (5));

Warning: Always use parentheses around macro arguments (like (x)) and the entire definition (like ((x) * (x))) to prevent unexpected behavior due to operator precedence issues during text substitution.

2. File Inclusion (#include)

The #include directive instructs the preprocessor to replace the directive with the entire contents of the specified file.

3. Conditional Compilation

Conditional compilation directives allow you to include or exclude parts of the source code based on predefined conditions. This is essential for writing platform-dependent code or preventing header files from being included multiple times.

A. Header Guards (#ifndef)

This prevents the same header file from being included multiple times in a project, which would cause compilation errors due to duplicate definitions.

// my_header.h
#ifndef MY_HEADER_H
#define MY_HEADER_H

// Code definitions go here

#endif // MY_HEADER_H

B. Platform-Specific Code (#ifdef)

Use this to conditionally compile code based on the operating system or environment.

#ifdef _WIN32 // Macro defined by the compiler for Windows
    printf("Running on Windows.\n");
#elif __linux__ // Macro defined by the compiler for Linux
    printf("Running on Linux.\n");
#else
    printf("Running on an unknown OS.\n");
#endif

4. Other Directives