| 1 |
# clang pseudoparser |
| 2 |
|
| 3 |
This directory implements an approximate heuristic parser for C++, based on the |
| 4 |
clang lexer, the C++ grammar, and the GLR parsing algorithm. |
| 5 |
|
| 6 |
It parses a file in isolation, without reading its included headers. |
| 7 |
The result is a strict syntactic tree whose structure follows the C++ grammar. |
| 8 |
There is no semantic analysis, apart from guesses to disambiguate the parse. |
| 9 |
Disambiguation can optionally be guided by an AST or a symbol index. |
| 10 |
|
| 11 |
For now, the best reference on intended scope is the [design proposal], |
| 12 |
with further discussion on the [RFC]. |
| 13 |
|
| 14 |
## Dependencies between pseudoparser and clang |
| 15 |
|
| 16 |
Dependencies are limited because they don't make sense, but also to avoid |
| 17 |
placing a burden on clang mantainers. |
| 18 |
|
| 19 |
The pseudoparser reuses the clang lexer (clangLex and clangBasic libraries) but |
| 20 |
not the higher-level libraries (Parse, Sema, AST, Frontend...). |
| 21 |
|
| 22 |
When the pseudoparser should be used together with an AST (e.g. to guide |
| 23 |
disambiguation), this is a separate "bridge" library that depends on both. |
| 24 |
|
| 25 |
Clang does not depend on the pseudoparser at all. If this seems useful in future |
| 26 |
it should be discussed by RFC. |
| 27 |
|
| 28 |
## Parity between pseudoparser and clang |
| 29 |
|
| 30 |
The pseudoparser aims to understand real-world code, and particularly the |
| 31 |
languages and extensions supported by Clang. |
| 32 |
|
| 33 |
However we don't try to keep these in lockstep: there's no expectation that |
| 34 |
Clang parser changes are accompanied by pseudoparser changes or vice versa. |
| 35 |
|
| 36 |
[design proposal]: https://docs.google.com/document/d/1eGkTOsFja63wsv8v0vd5JdoTonj-NlN3ujGF0T7xDbM/edit |
| 37 |
[RFC]: https://discourse.llvm.org/t/rfc-a-c-pseudo-parser-for-tooling/59217/49 |