C preprocessor

The C preprocessor (CPP) is a text file processor that is used with C, C++ and other programming tools. The preprocessor provides for file inclusion (often header files), macro expansion, conditional compilation, and line control. Although named in association with C and used with C, the preprocessor capabilities are not inherently tied to the C language. It can and is used to process other kinds of files. ^[1]

C, C++, and Objective-C compilers provide a preprocessor capability, as it is required by the definition of each language. Some compilers provide extensions and deviations from the target language standard. Some provide options to control standards compliance. For instance, the GNU C preprocessor can be made more standards compliant by supplying certain command-line flags. ^[2]

Features of the preprocessor are encoded in source code as directives that start with #.

Although C++ source files are often named with a .cpp extension, that is an abbreviation for "C plus plus"; not C preprocessor.

History

The preprocessor was introduced to C around 1973 at the urging of Alan Snyder and also in recognition of the usefulness of the file inclusion mechanisms available in BCPL and PL/I. The first version offered file inclusion via #include and parameterless string replacement macros via #define. It was extended shortly after, firstly by Mike Lesk and then by John Reiser, to add arguments to macros and to support conditional compilation. ^[3]

The C preprocessor was part of a long macro-language tradition at Bell Labs, which was started by Douglas Eastwood and Douglas McIlroy in 1959. ^[4]

Phases

Preprocessing is defined by the first four (of eight) phases of translation specified in the C Standard.

1. Trigraph replacement: The preprocessor replaces trigraph sequences with the characters they represent. This phase will be removed in C23 following the steps of C++17.
2. Line splicing: Physical source lines that are continued with escaped newline sequences are spliced to form logical lines.
3. Tokenization: The preprocessor breaks the result into preprocessing tokens and whitespace. It replaces comments with whitespace.
4. Macro expansion and directive handling: Preprocessing directive lines, including file inclusion and conditional compilation, are executed. The preprocessor simultaneously expands macros and, since the 1999 version of the C standard, handles _Pragma operators.

Features

File inclusion

To include the content of one file into another, the preprocessor replaces a line that starts with #include with the content of the file specified after the directive. The inclusion may be logical in the sense that the resulting content may not be stored on disk and certainly is not overwritten to the source file.

In the following example code, the preprocessor replaces the line #include <stdio.h> with the content of the standard library header file named 'stdio.h' in which the function printf() and other symbols are declared.

#include<stdio.h>intmain(void){printf("Hello, World!\n");return0;}

In this case, the file name is enclosed in angle brackets to denote that it is a system file. For a file in the codebase being built, double-quotes are used instead. The preprocessor may use a different search algorithm to find the file based on this distinction.

For C, a header file is usually named with a .h extension. In C++, the convension for file extension varies with common extensions .h and .hpp. But the preprocessor includes a file regardless of the extension. In fact, sometimes code includes .c or .cpp files.

To prevent including the same file multiple times which often leads to a compiler error, a header file typically contains an include guard or if supported by the preprocessor #pragma once to prevent multiple inclusion.

Conditional compilation

Conditional compilation is supported via the if-else core directives #if, #else, #elif, and #endif and with contraction directives #ifdef and #ifndef which stand for #if defined(...) and #if !defined(...), respectively. In the following example code, the printf() call is only included for compilation if VERBOSE is defined.

#ifdef VERBOSEprintf("trace message");#endif

The following demonstrates more complex logic:

#if !(defined __LP64__ || defined __LLP64__) || defined _WIN32 && !defined _WIN64// code for a 32-bit system#else// code for a 64-bit system#endif

Macro string replacement

Object-like

A macro specifies how to replace text in the source code with other text. An object-like macro defines a token that the preprocessor replaces with other text. It does not include parameter syntax and therefore cannot support parameterization. The following macro definition associates the text "1 / 12" with the token "VALUE":

#define VALUE 1 / 12

Function-like

A function-like macro supports parameters; although the parameter list can be empty. The following macro definition associates the expression "(A + B)" with the token "ADD" that has parameters "A" and "B".

#define ADD(A, B) (A + B)

A function-like macro declaration cannot have whitespace between the token and the first, opening parenthesis. If whitespace is present, the macro is interpreted as object-like with everything starting at the first parenthesis included in the replacement text.

Expansion

The preprocessor replaces each token of the code that matches a macro token with the associated replacement text in what is known as macro expansion. Note that text of string literals and comments is not parsed as tokens and is therefore ignored for macro expansion. For a function-like macro, the macro parameters are also replaced with the values specified in the macro reference. For example, ADD(VALUE, 2) expands to 1 / 12 + 2.

Variadic

A variadic macro (introduced with C99) accepts a varying number of arguments which is particularly useful when wrapping functions that accept a variable number of parameters, such as printf .

Order of expansion

Function-like macro expansion occurs in the following stages:

1. Stringification operations are replaced with the textual representation of their argument's replacement list (without performing expansion).
2. Parameters are replaced with their replacement list (without performing expansion).
3. Concatenation operations are replaced with the concatenated result of the two operands (without expanding the resulting token).
4. Tokens originating from parameters are expanded.
5. The resulting tokens are expanded as normal.

This may produce surprising results:

#define HE HI#define LLO _THERE#define HELLO "HI THERE"#define CAT(a,b) a##b#define XCAT(a,b) CAT(a,b)#define CALL(fn) fn(HE,LLO)CAT(HE,LLO)// "HI THERE", because concatenation occurs before normal expansionXCAT(HE,LLO)// HI_THERE, because the tokens originating from parameters ("HE" and "LLO") are expanded firstCALL(CAT)// "HI THERE", because this evaluates to CAT(a,b)

Undefine macro

A macro definition can be removed from the preprocessor context via #undef such that subsequent reference to the macro token will not expand. For example:

#undef VALUE

Predefined macros

The preprocessor provides some macro definitions automatically. The C standard specifies that __FILE__ expands to the name of the file being processed and __LINE__ expands to the number of the line that contains the directive. The following macro, DEBUGPRINT, formats and prints a message with the file name and line number.

#define DEBUGPRINT(_fmt, ...) printf("[%s:%d]: " _fmt, __FILE__, __LINE__, __VA_ARGS__)

For the example code below that is on line 30 of file "util.c" and for count 123, the output is: "[util.c:30]: count=123".

DEBUGPRINT("count=%d\n",count);

The first C Standard specified that __STDC__ expand to "1" if the implementation conforms to the ISO standard and "0" otherwise and that __STDC_VERSION__ expand to a numeric literal specifying the version of the standard supported by the implementation. Standard C++ compilers support the __cplusplus macro. Compilers running in non-standard mode must not set these macros or must define others to signal the differences.

Other standard macros include __DATE__, the current date, and __TIME__, the current time.

The second edition of the C Standard, C99, added support for __func__, which contains the name of the function definition within which it is contained, but because the preprocessor is agnostic to the grammar of C, this must be done in the compiler itself using a variable local to the function.

One little-known usage pattern of the C preprocessor is known as X-Macros. ^{[5] [6] [7]} An X-Macro is a header file. Commonly, these use the extension .def instead of the traditional .h . This file contains a list of similar macro calls, which can be referred to as "component macros." The include file is then referenced repeatedly.

Many compilers define additional, non-standard macros. A common reference for these macros is the Pre-defined C/C++ Compiler Macros project, which lists "various pre-defined compiler macros that can be used to identify standards, compilers, operating systems, hardware architectures, and even basic run-time libraries at compile-time."

Most compilers targeting Microsoft Windows implicitly define _WIN32. ^[8] This allows code, including preprocessor commands, to compile only when targeting Windows systems. A few compilers define WIN32 instead. For such compilers that do not implicitly define the _WIN32 macro, it can be specified on the compiler's command line, using -D_WIN32.

#ifdef __unix__ /* __unix__ is usually defined by compilers targeting Unix systems */#include<unistd.h>#elif defined _WIN32 /* _WIN32 is usually defined by compilers targeting 32 or 64 bit Windows systems */#include<windows.h>#endif

The example code tests if a macro __unix__ is defined. If it is, the file <unistd.h> is then included. Otherwise, it tests if a macro _WIN32 is defined instead. If it is, the file <windows.h> is then included.

Line control

The values of the predefined macros __FILE__ and __LINE__ can be set for a subsequent line via the #line directive. In the code below, __LINE__ expands to 314 and __FILE__ to "pi.c".

#line 314 "pi.c"printf("line=%d file=%s\n",__LINE__,__FILE__);

Token stringification

The stringification operator (a.k.a. stringizing operator), denoted by # converts a token into a string literal, escaping any quotes or backslashes as needed. For definition:

#define str(s) #s

str(\n) expands to "\n" and str(p = "foo\n";) expands to "p = \"foo\\n\";".

If stringification of the expansion of a macro argument is desired, two levels of macros must be used. For definition:

#define xstr(s) str(s)#define str(s) #s#define foo 4

str(foo) expands to "foo" and xstr(foo) expands to "4".

A macro argument cannot be combined with additional text and then stringified. However, a series of adjacent string literals and stringified arguments, also string literals, are concatenated by the C compiler.

Token concatenation

The token pasting operator, denoted by ##, concatenates two tokens into one. For definition:

#define DECLARE_STRUCT_TYPE(name) typedef struct name##_s name##_t

DECLARE_STRUCT_TYPE(g_object) expands to typedef struct g_object_s g_object_t.

Abort

Processing can be aborted via the #error directive. For example:

#if RUBY_VERSION == 190#error Ruby version 1.9.0 is not supported#endif

Binary resource inclusion

C23 introduces the #embed directive for binary resource inclusion which allows including the content of a binary file into a source even though it's not valid C code. ^[9] This allows binary resources (like images) to be included into a program without requiring processing by external tools like xxd -i and without the use of string literals which have a length limit on MSVC. Similarly to xxd -i the directive is replaced by a comma separated list of integers corresponding to the data of the specified resource. More precisely, if an array of type unsigned char is initialized using an #embed directive, the result is the same as-if the resource was written to the array using fread (unless a parameter changes the embed element width to something other than CHAR_BIT ). Apart from the convenience, #embed is also easier for compilers to handle, since they are allowed to skip expanding the directive to its full form due to the as-if rule.

The file to embed is specified the same as for #include– either with brackets or double quotes. The directive also allows certain parameters to be passed to it to customize its behavior. The C standard defines some parameters and implementations may define additional. The limit parameter is used to limit the width of the included data. It is mostly intended to be used with "infinite" files like urandom. The prefix and suffix parameters allow for specifying a prefix and suffix to the embedded data. Finally, the if_empty parameter replaces the entire directive if the resource is empty. All standard parameters can be surrounded by double underscores, just like standard attributes on C23, for example __prefix__ is interchangeable with prefix. Implementation-defined parameters use a form similar to attribute syntax (e.g., vendor::attr) but without the square brackets. While all standard parameters require an argument to be passed to them (e.g., limit requires a width), this is generally optional and even the set of parentheses can be omitted if an argument is not required, which might be the case for some implementation-defined parameters.

Non-standard features

Pragma

The #pragma directive is defined by standard languages, but with little or no requirements for syntax after its name so that compilers are free to define subsequent syntax and associated behavior. For instance, a pragma is often used to allow suppression of error messages, manage heap and stack debugging and so on.

C99 introduced a few standard pragmas, taking the form #pragma STDC ..., which are used to control the floating-point implementation. The alternative, macro-like form _Pragma(...) was also added.

Trigraphs

Many implementations do not support trigraphs or do not replace them by default.

Warning

Many implementations (such as the C compilers by GNU, Intel, Microsoft and IBM) provide a non-standard directive to print a message without aborting, typically to warn about the use of deprecated functionality. For example:

// GNU, Intel and IBM#warning "Do not use ABC, which is deprecated. Use XYZ instead."

// Microsoft#pragma message("Do not use ABC, which is deprecated. Use XYZ instead.")

C23 ^[10] and C++23 ^[11] standardize #warning.

Assertion

Some Unix preprocessors provided an assertion feature – which has little similarity to standard library assertions. ^[12]

Include next

GCC provides #include_next for chaining headers of the same name. ^[13]

Import

Unlike C and C++, Objective-C includes an #import directive that is like #include but results in a file being included only once – eliminating the need for include guards and #pragma once.

Other uses

Traditionally, the C preprocessor was a separate development tool from the compiler with which it is usually used. In that case, it can be used separately from the compiler. Notable examples include use with the (deprecated) imake system and for preprocessing Fortran. However, use as a general purpose preprocessor is limited since the source code language must be relatively C-like for the preprocessor to parse it. ^[2]

The GNU Fortran compiler runs "traditional mode" CPP before compiling Fortran code if certain file extensions are used. ^[14] Intel offers a Fortran preprocessor, fpp, for use with the ifort compiler, which has similar capabilities. ^[15]

CPP also works acceptably with most assembly languages and Algol-like languages. This requires that the language syntax not conflict with CPP syntax, which means no lines starting with # and that double quotes, which CPP interprets as string literals and thus ignores, don't have syntactical meaning other than that. The "traditional mode" (acting like a pre-ISO C preprocessor) is generally more permissive and better suited for such use. ^[16]

Some modern compilers such as the GNU C Compiler provide preprocessing as a feature of the compiler; not as a separate tool.

Limitations

Text substitution limitations

Text substitution has a relatively high risk of causing a software bug as compared to other programming constructs. ^{[17] [18]}

Hidden multiple evaluation

Consider the common definition of a max macro:

#define max(a,b) (((a) > (b)) ? (a) : (b))

The expressions represented by a and b are both evaluated two times due to macro expansion, but this aspect is not obvious in the code where the macro is referenced. If the actual expressions have constant value, then multiple evaluation is not problematic from a logic standpoint even though it can affect runtime performance. But if an expression evaluates to a different value on subsequent evaluation, then the result may be unexpected. For example, given int i = 1; j = 2;, the result of max(i,j) is 2. If a and b were only evaluated once, the result of max(i++,j++) would be the same, but with double evaluation the result is 3.

Hidden order of operation

Failure to bracket arguments can lead to unexpected results. For example, a macro to double a value might be written as:

#define double(x) 2 * x

But double(1 + 2) expands to 2 * 1 + 2 which due to order of operations, evaluates to 4 when the expected is 6. To mitigate this problem, a macro should bracket all expressions and substitution variables:

#define double(x) (2 * (x))

Not general purpose

The C preprocessor is not Turing-complete, but comes close. Recursive computations can be specified, but with a fixed upper bound on the amount of recursion performed. ^[19] However, the C preprocessor is not designed to be, nor does it perform well as, a general-purpose programming language. As the C preprocessor does not have features of some other preprocessors, such as recursive macros, selective expansion according to quoting, and string evaluation in conditionals, it is very limited in comparison to a more general macro processor such as m4.

Phase out

Due to its limitations, C and C++ language features have been added over the years to minimize the value and need for the preprocessor.

Constant

For a long time, a preprocessor macro provided the preferred way to define a constant value. An alternative has always been to define a const variable, but that results in consuming runtime memory. A newer language construct (since C++11 and C23), constexpr allows for declaring a compile-time constant value that need not consume runtime memory. ^[20]

Inline function

For a long time, a function-like macro was the only way to define function-like behavior that did not incur runtime function call overhead. Via the inline keyword and optimizing compilers that inline automatically, some functions can be invoked without call overhead.

Import

The include directive limits code structure since it only allows including the content of one file into another. More modern languages support a module concept that has public symbols that other modules import – instead of including file content. Many contend that resulting code is easier to maintain since there is only one file for a module; not both a header and a body. C++20 adds a module concept and an import statement that is not handled via preprocessing. ^{[21] [22]}

See also

• C syntax
• Make
• m4 (computer language)
• PL/I preprocessor

References

1. General-purpose text preprocessing with the C preprocessor. Featuring JavaScript
2. "The C Preprocessor: Overview" . Retrieved 17 July 2016.
3. Ritchie (1993)
4. "Bell SAP – SAP with conditional and recursive macros". HOPL: Online Historical Encyclopaedia of Programming Languages.
5. Wirzenius, Lars. C "Preprocessor Trick For Implementing Similar Data Types". Retrieved January 9, 2011
6. Meyers, Randy (May 2001). "The New C: X Macros". Dr. Dobb's Journal. Retrieved 1 May 2008.
7. Beal, Stephan (August 2004). "Supermacros" . Retrieved 27 October 2008.{{cite journal}}: Cite journal requires |journal= (help)
8. List of predefined ANSI C and Microsoft C++ implementation macros.
9. "WG14-N3017 : #embed – a scannable, tooling-friendly binary resource inclusion mechanism". open-std.org. 27 June 2022. Archived from the original on 24 December 2022.
10. "WG14-N3096 : Draft for ISO/IEC 9899:2023" (PDF). open-std.org. 1 April 2023. Archived (PDF) from the original on 2 April 2023.
11. "Working Draft, Standard for Programming Language C++" (PDF). 22 March 2023.
12. GCC Obsolete features
13. "Wrapper Headers (The C Preprocessor)".
14. "1.3 Preprocessing and conditional compilation". GNU Project.
15. "Using the fpp Preprocessor". Intel. Retrieved 14 October 2015.
16. "Overview (The C Preprocessor)". gcc.gnu.org. Having said that, you can often get away with using cpp on things which are not C. Other Algol-ish programming languages are often safe (Ada, etc.) So is assembly, with caution. -traditional-cpp mode preserves more white space, and is otherwise more permissive. Many of the problems can be avoided by writing C or C++ style comments instead of native language comments, and keeping macros simple.
17. Gerard J. Holzmann. "The power of ten - Rules for developing safety critical code" (PDF). safety of macros. p. 4.
18. Michael D. Ernst; Greg J. Badros; David Notkin (December 2002). "An Empirical Analysis of C Preprocessor Use". C Preprocessor, Macros. 28 (12): 1146–1170. doi:10.1109/TSE.2002.1158288.
19. "Is the C99 preprocessor Turing complete?". Archived from the original on 24 April 2016.
20. Gabriel Dos Reis; Bjarne Stroustrup (22 March 2010). "General Constant Expressions for System Programming Languages, Proceedings SAC '10" (PDF). Archived (PDF) from the original on 13 June 2018. Retrieved 8 July 2024.
21. "N4720: Working Draft, Extensions to C++ for Modules" (PDF). Archived (PDF) from the original on 30 April 2019.
22. "P1857R1 – Modules Dependency Discovery".

Sources

• Ritchie, Dennis M. (March 1993). "The Development of the C Language". ACM SIGPLAN Notices. 28 (3). ACM: 201–208. doi: 10.1145/155360.155580 .
• Ritchie, Dennis M. (1993). "The Development of the C Language". The Second ACM SIGPLAN Conference on History of Programming Languages (HOPL-II). ACM. pp. 201–208. doi:10.1145/154766.155580. ISBN   0-89791-570-4 . Retrieved 4 November 2014.

External links

• ISO/IEC 9899. The latest publicly available version of the C11 standard is the final draft.
• GNU CPP online manual
• Visual Studio .NET preprocessor reference
• Pre-defined C/C++ Compiler Macros project: lists "various pre-defined compiler macros that can be used to identify standards, compilers, operating systems, hardware architectures, and even basic run-time libraries at compile-time"