Clang编译器工具链

$`<...>/llvm-project/install/bin/clang -cc1 -emit-html max.cpp
\end{shell}

通过-cc1选项向Clang前端传递了生成源程序HTML形式的参数，也可以通过-Xclang选项向前端传递一个选项，这需要一个额外的参数来表示该选项本身：

\begin{shell}`$ <...>/llvm-project/install/bin/clang -Xclang
-emit-html max.cpp  -fsyntax-only

int ’int’ [StartOfLine] Loc=<max.cpp:1:1> identifier ’max’
[LeadingSpace] Loc=<max.cpp:1:5> l_paren ’(’ Loc=<max.cpp:1:8> int
’int’ Loc=<max.cpp:1:9> identifier ’a’ [LeadingSpace]
Loc=<max.cpp:1:13> comma ’,’ Loc=<max.cpp:1:14> int ’int’
[LeadingSpace] Loc=<max.cpp:1:16> identifier ’b’ [LeadingSpace]
Loc=<max.cpp:1:20> r_paren ’)’ Loc=<max.cpp:1:21> l_brace ’’
[LeadingSpace] Loc=<max.cpp:1:23> if ’if’ [StartOfLine]
[LeadingSpace] Loc=<max.cpp:2:3> l_paren ’(’ [LeadingSpace]
Loc=<max.cpp:2:6> identifier ’a’ Loc=<max.cpp:2:7> greater ’>’
[LeadingSpace] Loc=<max.cpp:2:9> identifier ’b’ [LeadingSpace]
Loc=<max.cpp:2:11> r_paren ’)’ Loc=<max.cpp:2:12> return ’return’
[StartOfLine] [LeadingSpace] Loc=<max.cpp:3:5> identifier ’a’
[LeadingSpace] Loc=<max.cpp:3:12> semi ’;’ Loc=<max.cpp:3:13>
return ’return’ [StartOfLine] [LeadingSpace] Loc=<max.cpp:4:3>
identifier ’b’ [LeadingSpace] Loc=<max.cpp:4:10> semi ’;’
Loc=<max.cpp:4:11> r_brace ’’ [StartOfLine] Loc=<max.cpp:5:1> eof
” Loc=<max.cpp:5:2>

$`<...>/llvm-project/install/bin/clang -cc1 -ast-dump max.cpp
\end{shell}

输出如下：

\begin{shell}
TranslationUnitDecl 0xa9cb38 <>
|-TypedefDecl 0xa9d3a8 <>
implicit __int128_t '__int128'
| '-BuiltinType 0xa9d100 '__int128'
...
'-FunctionDecl 0xae6a98 <max.cpp:1:1, line:5:1> line:1:5 max
'int (int, int)'
|-ParmVarDecl 0xae6930 <col:9, col:13> col:13 used a 'int'
|-ParmVarDecl 0xae69b0 <col:16, col:20> col:20 used b 'int'
'-CompoundStmt 0xae6cd8 <col:23, line:5:1>
|-IfStmt 0xae6c70 <line:2:3, line:3:12>
| |-BinaryOperator 0xae6c08 <line:2:7, col:11> 'bool' '>'
| | |-ImplicitCastExpr 0xae6bd8 col:7 'int'
| | | '-DeclRefExpr 0xae6b98 col:7 'int' lvalue ParmVar 0xae6930
'a' 'int'
| | '-ImplicitCastExpr 0xae6bf0 col:11 'int'
| | '-DeclRefExpr 0xae6bb8 col:11 'int' lvalue ParmVar 0xae69b0
'b' 'int'
| '-ReturnStmt 0xae6c60 <line:3:5, col:12>
| '-ImplicitCastExpr 0xae6c48 col:12 'int'
| '-DeclRefExpr 0xae6c28 col:12 'int' lvalue ParmVar 0xae6930
'a' 'int'
'-ReturnStmt 0xae6cc8 <line:4:3, col:10>
'-ImplicitCastExpr 0xae6cb0 col:10 'int'
'-DeclRefExpr 0xae6c90 col:10 'int' lvalue ParmVar 0xae69b0
'b' 'int'
\end{shell}

\begin{center}
图2.34: Clang AST dump的输出
\end{center}

Clang使用了一个手工编写的递归下降解析器\footnote{LLVM Community. Clang features. 2023. URL \url{https://clang.llvm.org/features.html}}。这个解析器很简单，这也是选中它的一个关键原因。此外，C/C++语言的复杂规则需要一个易于适应的解析器。

通过示例来探索它是如何工作的。解析从代表单个翻译单元的顶级声明开始，称为TranslationUnitDecl。

一个源文件及其通过预处理指令#include包含的所有头文件（16.5.1.2）和源文件，减去通过条件包含预处理指令（15.2）跳过的源行，称为翻译单元。

解析器首先识别出源代码的初始token对应于函数定义，如C++标准所定义\footnote{International Organization for Standardization. International Standard ISO/IEC 14882:2020(E) – Programming Languages – C++. International Organization for Standardization, 2020. URL \url{https://www.iso.org/standard/73560.html}, dcl.fct.def.general}:

\begin{shell}
function-definition :
... declarator ... function-body
...
\end{shell}

\begin{center}
图2.35: C++标准中的函数定义
\end{center}

相应的代码如下：

\begin{cpp}
int max(...) {
...
}
\end{cpp}

\begin{center}
图2.36: 对应于C++标准中函数定义的部分示例代码
\end{center}

函数定义需要一个声明器和函数体。首先从声明器开始:

\begin{shell}
declarator:
...
... parameters-and-qualifiers ...
...
parameters-and-qualifiers:
( parameter-declaration-clause ) ...
...
parameter-declaration-clause:
parameter-declaration-list ...
parameter-declaration-list:
parameter-declaration
parameter-declaration-list , parameter-declaration
\end{shell}

\begin{center}
图2.37: C++标准中的声明器定义
\end{center}

声明器在一个括号内指定参数声明列表，源码中的相应部分如下所示：

\begin{cpp}
... (int a, int b)
...
\end{cpp}

\begin{center}
图2.38: 对应于C++标准中声明器的部分示例代码
\end{center}

函数定义，还需要一个函数体。C++标准将函数体定义为:

\begin{shell}
function-body:
... compound-statement
...
\end{shell}

\begin{center}
图2.39: C++标准中的函数体定义
\end{center}

函数体由一个复合语句组成，C++标准定义为:

\begin{shell}
compound-statement:
{ statement-seq ... }
statement-seq:
statement
statement-seq statement
\end{shell}

\begin{center}
图2.40: C++标准中的复合语句定义
\end{center}

其描述了一组语句，这些语句都括在大括号内({... ).

我们的程序有两种类型的语句：条件（if）语句和返回语句。这些在C++语法定义中如下所示:

\begin{shell}
statement:
...
selection-statement
...
jump-statement
...
\end{shell}

\begin{center}
图2.41: C++标准中的语句定义
\end{center}

选择语句对应于我们程序中的if条件，而跳转语句对应于返回运算符。

更详细地检查跳转语句:

\begin{shell}
jump-statement:
...
return expr-or-braced-init-list;
...
\end{shell}

\begin{center}
图2.42: C++标准中的跳转语句定义
\end{center}

其中expr-or-braced-init-list定义为:

\begin{shell}
expr-or-braced-init-list:
expression
...
\end{shell}

\begin{center}
图2.43: C++标准中的返回表达式定义
\end{center}

return关键字后面跟着一个表达式和一个分号，其中有一个隐式转换表达式，自动将变量转换为所需的类型（int）。

通过LLDB调试器检查解析器的操作可能会很有启发：

\begin{shell}`$ lldb <...>/llvm-project/install/bin/clang – -cc1
max.cpp