-
Notifications
You must be signed in to change notification settings - Fork 11
update preprocessor documentation #52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
momo773510
wants to merge
4
commits into
cppdoc-cc:main
Choose a base branch
from
momo773510:add_doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+438
−0
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
95a439b
update preprocessor documentation
momo773510 a69c304
feat: migrate cpp/templates cpp/exceptions from cppref
momo773510 db6d7de
Merge branch 'main' of https://github.com/momo773510/cppdoc into add_doc
momo773510 b16f791
fix preprocessor doc
momo773510 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| --- | ||
| title: preprocessor | ||
| cppdoc: | ||
| keys: ["cpp.lang.main"] | ||
| --- | ||
|
|
||
| import { Desc, DescList, DocLink } from '@components/index'; | ||
| import { Revision, RevisionBlock } from "@components/revision"; | ||
| import { DR, DRList } from "@components/defect-report"; | ||
|
|
||
| The preprocessor is executed at <DocLink src="/cpp/language/translation_phases" anchor="Phase_4">translation phase 4</DocLink>, before the compilation. The result of preprocessing is a single file which is then passed to the actual compiler. | ||
|
|
||
| ## Directives | ||
|
|
||
| The preprocessing directives control the behavior of the preprocessor. Each directive occupies one line and has the following format: | ||
|
|
||
| * the `#` character. | ||
| * a sequence of: | ||
| * a standard-defined directive name (listed [below](#Capabilities)) followed by the corresponding arguments, or | ||
| * one or more <DocLink src="/cpp/language/translation_phases" anchor="Phase_3">preprocessing tokens</DocLink> where the beginning token is not a standard-defined directive name, in this case the directive is conditionally-supported with implementation-defined semantics <Revision until="C++23">(e.g. a common non-standard extension is the directive `#warning` which emits a user-defined message during compilation)</Revision>, or | ||
| * nothing, in this case the directive has no effect. | ||
| * a line break. | ||
|
|
||
| <Revision since="C++20">The <DocLink src="/cpp/language/modules">module and import directives</DocLink> are also preprocessing directives.</Revision> | ||
|
|
||
| Preprocessing directives must not come from macro expansion. | ||
|
|
||
| ```cpp | ||
| #define EMPTY | ||
| EMPTY # include <file.h> // not a preprocessing directive | ||
| ``` | ||
|
|
||
| ## Capabilities | ||
|
|
||
| The preprocessor has the source file translation capabilities: | ||
|
|
||
| * **<DocLink src="/cpp/preprocessor/conditional">conditionally</DocLink>** compile parts of source file (controlled by directive `#if`, `#ifdef`, `#ifndef`, `#else`, <Revision since="C++23">`#elif`, `#elifdef`, `#elifndef`</Revision>, and `#endif`). | ||
| * **<DocLink src="/cpp/preprocessor/replace">replace</DocLink>** text macros while possibly concatenating or quoting identifiers (controlled by directives `#define` and `#undef`, and operators `#` and `##`). | ||
| * **<DocLink src="/cpp/preprocessor/include">include</DocLink>** other files (controlled by directive `#include` <Revision since="C++23">and checked with `__has_include` </Revision>). | ||
| * cause an **<DocLink src="/cpp/preprocessor/error">error</DocLink>** <Revision since="C++17">or **<DocLink src="/cpp/preprocessor/error">warning</DocLink>** </Revision> (controlled by directive `#error` <Revision since="C++23">or `#warning` respectively</Revision>). | ||
|
|
||
| The following aspects of the preprocessor can be controlled: | ||
|
|
||
| * **<DocLink src="/cpp/preprocessor/impl">implementation-defined</DocLink>** behavior (controlled by directive `#pragma` <Revision since="C++11">and operator `_Pragma` </Revision>). In addition, some compilers support (to varying degrees) the operator `__pragma` as a *non-standard* extension. | ||
| * **<DocLink src="/cpp/preprocessor/line">file name and line information</DocLink>** available to the preprocessor (controlled by directive `#line`). | ||
|
|
||
| ## Defect reports | ||
|
|
||
| The following behavior-changing defect reports were applied retroactively to previously published C++ standards. | ||
|
|
||
| <DRList> | ||
| <DR kind="cwg" id={2001} std="C++98"> | ||
| <Fragment slot="behavior-published"> | ||
| the behavior of using non-standard-defined directives was not clear | ||
| </Fragment> | ||
| <Fragment slot="correct-behavior"> | ||
| made conditionally-supported | ||
| </Fragment> | ||
| </DR> | ||
| </DRList> | ||
|
|
||
| ## See also | ||
|
|
||
| <DescList> | ||
| <Desc> | ||
| <DocLink slot="item" src="/cpp/preprocessor/replace" anchor="Predefined_macros">C++ documentation</DocLink> for <span>Predefined Macro Symbols</span> | ||
| </Desc> | ||
| <Desc> | ||
| <DocLink slot="item" src="/cpp/symbol_index/macro">C++ documentation</DocLink> for <span>Macro Symbol Index</span> | ||
| </Desc> | ||
| <Desc> | ||
| <DocLink slot="item" src="/c/preprocessor">C documentation</DocLink> for <span>preprocessor</span> | ||
| </Desc> | ||
| </DescList> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be clearer not to say "non-standard extension", because almost nothing can be considered as "standard extension". It would make more sense to say "conforming/conformant extension". But given a large number of extensions are conforming, I think we should only additionally note non-conforming cases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe that make sense. but the statement is just a copy from cppreference. i use LLM to replicate it and could not distinguish the better one.