LLVM教程2——Kaleidoscope 实现解析器和 AST

最新推荐文章于 2023-03-05 16:57:05 发布

like不倒翁

最新推荐文章于 2023-03-05 16:57:05 发布

阅读量619

点赞数

分类专栏： LLVM 编译原理软件分析文章标签： LLVM Clang C++ 编译

原文链接：https://llvm.org/docs/tutorial/MyFirstLanguageFrontend/LangImpl02.html

版权

编译原理同时被 3 个专栏收录

7 篇文章 0 订阅

订阅专栏

软件分析

5 篇文章 1 订阅

订阅专栏

LLVM

2 篇文章 0 订阅

订阅专栏

2. 万花筒：实现解析器和 AST

2.1. 第 2 章简介

欢迎阅读“使用 LLVM 实现语言”教程的第 2 章。本章向您展示如何使用第 1 章中构建的词法分析器为我们的 Kaleidoscope 语言构建一个完整的解析器。有了解析器后，我们将定义并构建一个抽象语法树(AST)。

我们将构建的解析器结合使用递归下降解析和运算符优先解析来解析 Kaleidoscope 语言（后者用于二进制表达式，前者用于其他所有内容）。在我们开始解析之前，让我们先谈谈解析器的输出：抽象语法树。

2.2. 抽象语法树（AST）

程序的 AST 以一种便于编译器的后期阶段（例如代码生成）解释的方式捕获其行为。我们基本上希望语言中的每个结构都有一个对象，而 AST 应该紧密地模拟语言。在 Kaleidoscope 中，我们有表达式、原型和函数对象。我们首先从表达式开始：

/// ExprAST - Base class for all expression nodes.
class ExprAST {
public:
  virtual ~ExprAST() {}
};

/// NumberExprAST - Expression class for numeric literals like "1.0".
class NumberExprAST : public ExprAST {
  double Val;

public:
  NumberExprAST(double Val) : Val(Val) {}
};

上面的代码显示了基本 ExprAST 类和我们用于数字文字的一个子类的定义。关于此代码需要注意的重要一点是 NumberExprAST 类将文字的数值捕获为实例变量。这允许编译器的后续阶段知道存储的数值是什么。

现在我们只创建 AST，所以它们没有有用的访问器方法。例如，添加一个虚拟方法来漂亮地打印代码将非常容易。以下是我们将在 Kaleidoscope 语言的基本形式中使用的其他表达式 AST 节点定义：

/// VariableExprAST - Expression class for referencing a variable, like "a".
class VariableExprAST : public ExprAST {
  std::string Name;

public:
  VariableExprAST(const std::string &Name) : Name(Name) {}
};

/// BinaryExprAST - Expression class for a binary operator.
class BinaryExprAST : public ExprAST {
  char Op;
  std::unique_ptr<ExprAST> LHS, RHS;

public:
  BinaryExprAST(char op, std::unique_ptr<ExprAST> LHS,
                std::unique_ptr<ExprAST> RHS)
    : Op(op), LHS(std::move(LHS)), RHS(std::move(RHS)) {}
};

/// CallExprAST - Expression class for function calls.
class CallExprAST : public ExprAST {
  std::string Callee;
  std::vector<std::unique_ptr<ExprAST>> Args;

public:
  CallExprAST(const std::string &Callee,
              std::vector<std::unique_ptr<ExprAST>> Args)
    : Callee(Callee), Args(std::move(Args)) {}
};

这一切（有意）相当直接：变量捕获变量名称，二元运算符捕获它们的操作码（例如“+”），调用捕获函数名称以及任何参数表达式的列表。我们的 AST 的优点之一是它捕获了语言特性，而无需讨论语言的语法。请注意，这里没有讨论二元运算符的优先级、词法结构等。

对于我们的基本语言，这些是我们将定义的所有表达式节点。因为它没有条件控制流，所以它不是图灵完备的；我们将在以后的文章中解决这个问题。接下来我们需要做的两件事是一种谈论函数接口的方式，以及一种谈论函数本身的方式：

/// PrototypeAST - This class represents the "prototype" for a function,
/// which captures its name, and its argument names (thus implicitly the number
/// of arguments the function takes).
class PrototypeAST {
  std::string Name;
  std::vector<std::string> Args;

public:
  PrototypeAST(const std::string &name, std::vector<std::string> Args)
    : Name(name), Args(std::move(Args)) {}

  const std::string &getName() const { return Name; }
};

/// FunctionAST - This class represents a function definition itself.
class FunctionAST {
  std::unique_ptr<PrototypeAST> Proto;
  std::unique_ptr<ExprAST> Body;

public:
  FunctionAST(std::unique_ptr<PrototypeAST> Proto,
              std::unique_ptr<ExprAST> Body)
    : Proto(std::move(Proto)), Body(std::move(Body)) {}
};

在 Kaleidoscope 中，函数的类型只包含参数的个数。由于所有值都是双精度浮点数，因此不需要在任何地方存储每个参数的类型。在更激进和现实的语言中，“ExprAST”类可能有一个类型字段。

有了这个脚手架，我们现在可以讨论 Kaleidoscope 中的解析表达式和函数体。

2.3. 解析器基础

现在我们有了要构建的 AST，我们需要定义解析器代码来构建它。这里的想法是，我们想要将诸如“x+y”之类的东西（由词法分析器作为三个标记返回）解析为一个 AST，可以通过这样的调用生成：

auto LHS = std::make_unique<VariableExprAST>("x");
auto RHS = std::make_unique<VariableExprAST>("y");
auto Result = std::make_unique<BinaryExprAST>('+', std::move(LHS),
                                              std::move(RHS));

为了做到这一点，我们将从定义一些基本的辅助例程开始：

/// CurTok/getNextToken - Provide a simple token buffer.  CurTok is the current
/// token the parser is looking at.  getNextToken reads another token from the
/// lexer and updates CurTok with its results.
static int CurTok;//语法分析器正在查看的token
static int getNextToken() {
  return CurTok = gettok();//查看下一个token并更新CurTok
}

这在词法分析器周围实现了一个简单的令牌缓冲区。这使我们能够提前查看词法分析器返回的内容。我们解析器中的每个函数都假定 CurTok 是当前需要解析的标记。

/// LogError* - These are little helper functions for error handling.
std::unique_ptr<ExprAST> LogError(const char *Str) {
  fprintf(stderr, "LogError: %s\n", Str);
  return nullptr;
}
std::unique_ptr<PrototypeAST> LogErrorP(const char *Str) {
  LogError(Str);
  return nullptr;
}

这些LogError例程是简单的辅助例程，我们的解析器将使用它们来处理错误。我们的解析器中的错误恢复不是最好的，也不是特别用户友好，但对于我们的教程来说已经足够了。这些例程可以更轻松地处理具有各种返回类型的例程中的错误：它们始终返回 null。

有了这些基本的辅助函数，我们就可以实现语法的第一部分：数字文字。

2.4. 基本表达式解析

我们从数字文字开始，因为它们最容易处理。对于语法中的每个产生式，我们将定义一个解析该产生式的函数。对于数字文字，我们有：

/// numberexpr ::= number
static std::unique_ptr<ExprAST> ParseNumberExpr() {
  auto Result = std::make_unique<NumberExprAST>(NumVal);
  getNextToken(); // consume the number
  return std::move(Result);
}

这个例程非常简单：它期望在当前token是一个tok_number token时被调用。它获取当前数值，创建一个NumberExprAST节点，将词法分析器推进到下一个token，最后返回。

这有一些有趣的方面。最重要的一点是，这个例程会吃掉与产生式对应的所有标记，并返回带有下一个标记（不属于语法产生式）的词法分析器缓冲区。这是递归下降解析器的一种相当标准的方法。举个更好的例子，括号运算符定义如下：

/// parenexpr ::= '(' expression ')'
static std::unique_ptr<ExprAST> ParseParenExpr() {
  getNextToken(); // eat (.
  auto V = ParseExpression();
  if (!V)
    return nullptr;

  if (CurTok != ')')
    return LogError("expected ')'");
  getNextToken(); // eat ).
  return V;
}

这个函数说明了关于解析器的一些有趣的事情：

\1) 它显示了我们如何使用 LogError 例程。调用时，此函数期望当前标记为 ‘(’ 标记，但在解析子表达式后，可能没有 ‘)’ 等待。例如，如果用户输入“(4 x”而不是“(4)”，解析器应该发出一个错误。因为可能会发生错误，解析器需要一种方法来表明它们发生了：在我们的解析器中，我们返回错误时为 null。

2）这个函数还有一个有趣的地方是它通过调用来使用递归ParseExpression（我们很快就会看到 ParseExpression可以调用ParseParenExpr）。这很强大，因为它允许我们处理递归语法，并使每个产生式都非常简单。请注意，括号不会导致 AST 节点本身的构造。虽然我们可以这样做，但括号最重要的作用是引导解析器并提供分组。一旦解析器构造了 AST，就不需要括号了。

下一个简单的产生式用于处理变量引用和函数调用：

/// identifierexpr
///   ::= identifier
///   ::= identifier '(' expression* ')'
static std::unique_ptr<ExprAST> ParseIdentifierExpr() {
  std::string IdName = IdentifierStr;

  getNextToken();  // eat identifier.

  if (CurTok != '(') // Simple variable ref.  VariableExprAST 节点
    return std::make_unique<VariableExprAST>(IdName);

  // Call.   CallExprAST节点
  getNextToken();  // eat (
  std::vector<std::unique_ptr<ExprAST>> Args;
  if (CurTok != ')') {
    while (1) {
      if (auto Arg = ParseExpression())
        Args.push_back(std::move(Arg));
      else
        return nullptr;

      if (CurTok == ')')
        break;

      if (CurTok != ',')
        return LogError("Expected ')' or ',' in argument list");
      getNextToken();
    }
  }

  // Eat the ')'.
  getNextToken();

  return std::make_unique<CallExprAST>(IdName, std::move(Args));
}

此例程遵循与其他例程相同的样式。（如果当前token是一个tok_identifier token，它预计会被调用）。它还具有递归和错误处理。一个有趣的方面是它使用前瞻性来确定当前标识符是一个独立的变量引用还是一个函数调用表达式。它通过检查标识符后的token是否为“(”token来处理此问题，并根据需要构造 aVariableExprAST或 CallExprAST节点。

现在我们已经准备好所有简单的表达式解析逻辑，我们可以定义一个辅助函数来将它包装到一个入口点中。我们称这类表达式为“primary”表达式，原因在本教程后面会变得更加清楚。为了解析任意primary表达式，我们需要确定它是哪种表达式：

/// primary
///   ::= identifierexpr
///   ::= numberexpr
///   ::= parenexpr
static std::unique_ptr<ExprAST> ParsePrimary() {
  switch (CurTok) {
  default:
    return LogError("unknown token when expecting an expression");
  case tok_identifier:
    return ParseIdentifierExpr();
  case tok_number:
    return ParseNumberExpr();
  case '(':
    return ParseParenExpr();
  }
}

既然您看到了这个函数的定义，就更清楚了为什么我们可以在各种函数中假设 CurTok 的状态。这使用前瞻来确定正在检查哪种表达式，然后使用函数调用对其进行解析。

现在处理了基本表达式，我们需要处理二进制表达式。它们有点复杂。

2.5. 二进制表达式解析

二进制表达式更难解析，因为它们通常是模棱两可的。例如，当给定字符串“x+yz”时，解析器可以选择将其解析为“(x+y)z”或“x+(yz)”。根据数学上的常见定义，我们期望后面的解析，因为“”（乘法）比“+”（加法）具有更高的优先级。

有很多方法可以处理这个问题，但一种优雅而有效的方法是使用Operator-Precedence Parsing。这种解析技术使用二元运算符的优先级来指导递归。首先，我们需要一个优先级表：

/// BinopPrecedence - This holds the precedence for each binary operator that is
/// defined.
static std::map<char, int> BinopPrecedence;

/// GetTokPrecedence - Get the precedence of the pending binary operator token.
static int GetTokPrecedence() {
  if (!isascii(CurTok))
    return -1;

  // Make sure it's a declared binop.
  int TokPrec = BinopPrecedence[CurTok];
  if (TokPrec <= 0) return -1;
  return TokPrec;
}

int main() {
  // Install standard binary operators.
  // 1 is lowest precedence.
  BinopPrecedence['<'] = 10;
  BinopPrecedence['+'] = 20;
  BinopPrecedence['-'] = 20;
  BinopPrecedence['*'] = 40;  // highest.
  ...
}

对于 Kaleidoscope 的基本形式，我们将只支持 4 个二元运算符（这显然可以由您，我们勇敢无畏的读者进行扩展）。该GetTokPrecedence函数返回当前标记的优先级，如果标记不是二元运算符，则返回 -1。有了映射可以很容易地添加新的运算符，并清楚地表明该算法不依赖于所涉及的特定运算符，但是消除映射并在 GetTokPrecedence函数中进行比较就足够容易了。（或者只使用固定大小的数组）。

通过上面定义的帮助器，我们现在可以开始解析二进制表达式了。运算符优先级解析的基本思想是将具有可能不明确的二元运算符的表达式分解成多个部分。例如，考虑表达式“a+b+(c+d)*e*f+g”。运算符优先级解析将其视为由二元运算符分隔的主要表达式流。因此，它将首先解析前导主表达式“a”，然后它会看到二元对 [+, b] [+, (c+d)] [*, e] [*, f] 和 [+, g ]. 请注意，因为括号是基本表达式，二进制表达式解析器根本不需要担心像 (c+d) 这样的嵌套子表达式。

首先，表达式是一个主表达式，后面可能跟着一系列 [binop,primaryexpr] 对：

/// expression
///   ::= primary binoprhs
///
static std::unique_ptr<ExprAST> ParseExpression() {
  auto LHS = ParsePrimary();
  if (!LHS)
    return nullptr;

  return ParseBinOpRHS(0, std::move(LHS));
}

ParseBinOpRHS是为我们解析对序列的函数。它需要一个优先级和一个指向到目前为止已解析部分的表达式的指针。请注意，“x”是一个完全有效的表达式：因此，“binoprhs”（pairs中的操作符）允许为空，在这种情况下，它返回传递给它的表达式。在我们上面的示例中，代码将“a”的表达式传递给ParseBinOpRHS当前标记为“+”。

传入ParseBinOpRHS的优先级值表示允许函数吃掉的*最小运算符优先级。*例如，如果当前对是 [+, x] 并ParseBinOpRHS以 40 的优先级传递，则它不会消耗任何标记（因为 ‘+’ 的优先级只有 20）。考虑到这一点，ParseBinOpRHS 开始于：

/// binoprhs
///   ::= ('+' primary)*
static std::unique_ptr<ExprAST> ParseBinOpRHS(int ExprPrec,
                                              std::unique_ptr<ExprAST> LHS) {
  // If this is a binop, find its precedence.
  while (1) {
    int TokPrec = GetTokPrecedence();// 得到当前Token的优先级

    // If this is a binop that binds at least as tightly as the current binop,
    // consume it, otherwise we are done.
    if (TokPrec < ExprPrec)  //当前的Token与前面的token进行比较，也相当于与左边表达式比较优先级
      return LHS;

此代码获取当前token的优先级并检查是否太低。因为我们将无效标记定义为具有 -1 的优先级，所以此检查隐含地知道当标记流用完二元运算符时 pair-stream 结束。如果检查成功，我们就知道token是一个二元运算符，并且它将包含在这个表达式中：

// Okay, we know this is a binop.   当ExprPrec==0时，代码能运行在这里，说明当前的Token是一个二元运算符。
int BinOp = CurTok;
getNextToken();  // eat binop

// Parse the primary expression after the binary operator.
auto RHS = ParsePrimary();
if (!RHS)
  return nullptr;

因此，此代码吃掉（并记住）二元运算符，然后解析后面的主要表达式。这构建了整个对，其中第一个是运行示例的 [+, b] 。

现在我们已经解析了表达式的左侧和一对 RHS 序列，我们必须决定表达式的关联方式。特别是，我们可以有“(a+b) binop unparsed”或“a + (b binop unparsed)”。为了确定这一点，我们向前看“binop”以确定其优先级并将其与 BinOp 的优先级（在本例中为“+”）进行比较：

// If BinOp binds less tightly with RHS than the operator after RHS, let
// the pending operator take RHS as its LHS.
int NextPrec = GetTokPrecedence();
if (TokPrec < NextPrec) {//当前的token与下一个比较，也相当于与右边表达式比较优先级

如果“RHS”右侧的二元运算符的优先级低于或等于我们当前运算符的优先级，那么我们知道括号关联为“(a+b)二元运算符…”。在我们的示例中，当前运算符是“+”，下一个运算符是“+”，我们知道它们具有相同的优先级。在这种情况下，我们将为“a+b”创建 AST 节点，然后继续解析：

      ... if body omitted ...
    }

    // Merge LHS/RHS.
    LHS = std::make_unique<BinaryExprAST>(BinOp, std::move(LHS),
                                           std::move(RHS));
  }  // loop around to the top of the while loop.
}
//a+b+(c+d)*e*f+g

在我们上面的例子中，这会将“a+b+”变成“(a+b)”并执行循环的下一次迭代，“+”作为当前标记。上面的代码会将“(c+d)”作为主要表达式来获取、记忆和解析，这使得当前对等于 [+, (c+d)]。然后它将评估上面的“if”条件，“*”作为主要右侧的 binop。在这种情况下，“*”的优先级高于“+”的优先级，因此将进入 if 条件。

这里留下的关键问题是“if 条件如何完整解析右侧”？特别是，要为我们的示例正确构建 AST，它需要获取所有“(c+d)*e*f”作为 RHS 表达式变量。执行此操作的代码出奇地简单（根据上下文重复上述两个块中的代码）：

    // If BinOp binds less tightly with RHS than the operator after RHS, let
    // the pending operator take RHS as its LHS.
    int NextPrec = GetTokPrecedence();
    if (TokPrec < NextPrec) {
      RHS = ParseBinOpRHS(TokPrec+1, std::move(RHS));
      if (!RHS)
        return nullptr;
    }
    // Merge LHS/RHS.
    LHS = std::make_unique<BinaryExprAST>(BinOp, std::move(LHS),
                                           std::move(RHS));
  }  // loop around to the top of the while loop.
}

在这一点上，我们知道我们主要的 RHS 的二元运算符比我们当前正在解析的 binop 具有更高的优先级。因此，我们知道任何运算符优先级都高于“+”的对序列应该一起解析并返回为“RHS”。为此，我们递归调用ParseBinOpRHS指定“TokPrec+1”作为其继续所需的最低优先级的函数。在我们上面的示例中，这将导致它返回“(c+d)*e*f”的 AST 节点作为 RHS，然后将其设置为 ‘+’ 表达式的 RHS。

最后，在 while 循环的下一次迭代中，“+g”部分被解析并添加到 AST 中。通过这一小段代码（14 行非常重要的代码），我们以一种非常优雅的方式正确地处理了完全通用的二进制表达式解析。这是这段代码的旋风之旅，它有些微妙。我建议通过一些棘手的例子来了解它是如何工作的。

这结束了表达式的处理。此时，我们可以将解析器指向任意标记流并从中构建表达式，并在不属于表达式的第一个标记处停止。接下来我们需要处理函数定义等。

2.6. 解析其余部分

接下来缺少的是函数原型的处理。在 Kaleidoscope 中，它们既用于“外部”函数声明，也用于函数体定义。执行此操作的代码很简单，也不是很有趣（一旦你从表达式中幸存下来）：

/// prototype
///   ::= id '(' id* ')'
static std::unique_ptr<PrototypeAST> ParsePrototype() {
  if (CurTok != tok_identifier)
    return LogErrorP("Expected function name in prototype");

  std::string FnName = IdentifierStr;
  getNextToken();

  if (CurTok != '(')
    return LogErrorP("Expected '(' in prototype");

  // Read the list of argument names.
  std::vector<std::string> ArgNames;
  while (getNextToken() == tok_identifier)
    ArgNames.push_back(IdentifierStr);
  if (CurTok != ')')
    return LogErrorP("Expected ')' in prototype");

  // success.
  getNextToken();  // eat ')'.

  return std::make_unique<PrototypeAST>(FnName, std::move(ArgNames));
}

鉴于此，函数定义非常简单，只是一个原型加上一个表达式来实现函数体：

/// definition ::= 'def' prototype expression
static std::unique_ptr<FunctionAST> ParseDefinition() {
  getNextToken();  // eat def.
  auto Proto = ParsePrototype();
  if (!Proto) return nullptr;

  if (auto E = ParseExpression())
    return std::make_unique<FunctionAST>(std::move(Proto), std::move(E));
  return nullptr;
}

此外，我们支持’extern’来声明’sin’和’cos’等函数，并支持用户函数的前向声明。这些“外部”只是没有主体的原型：

/// external ::= 'extern' prototype
static std::unique_ptr<PrototypeAST> ParseExtern() {
  getNextToken();  // eat extern.
  return ParsePrototype();//返回原始   类型
}

最后，我们还将让用户键入任意顶级表达式并即时计算它们。我们将通过为它们定义匿名 nullary（零参数）函数来处理这个问题：

/// toplevelexpr ::= expression
static std::unique_ptr<FunctionAST> ParseTopLevelExpr() {
  if (auto E = ParseExpression()) {
    // Make an anonymous proto.
    auto Proto = std::make_unique<PrototypeAST>("", std::vector<std::string>());
    return std::make_unique<FunctionAST>(std::move(Proto), std::move(E));
  }
  return nullptr;
}

现在我们有了所有的部分，让我们构建一个小驱动程序，让我们实际执行我们构建的代码！

2.7. 驱动

这个驱动程序简单地调用所有带有顶层调度循环的解析部分。这里没有太多有趣的地方，所以我只包含顶级循环。请参阅下面“顶级解析”部分中的完整代码。

/// top ::= definition | external | expression | ';'
static void MainLoop() {
  while (1) {
    fprintf(stderr, "ready> ");
    switch (CurTok) {
    case tok_eof:
      return;
    case ';': // ignore top-level semicolons.
      getNextToken();
      break;
    case tok_def:
      HandleDefinition();
      break;
    case tok_extern:
      HandleExtern();
      break;
    default:
      HandleTopLevelExpression();
      break;
    }
  }
}

其中最有趣的部分是我们忽略了顶级分号。你问这是为什么？基本原因是，如果您在命令行键入“4 + 5”，解析器不知道这是否是您将键入的内容的结尾。例如，在下一行中，您可以键入“def foo …”，在这种情况下，4+5 是顶级表达式的结尾。或者，您可以键入“* 6”，这将继续表达式。有了顶级分号，您就可以输入“4+5;”，解析器就会知道您已经完成了。

2.8. 结论

通过不到 400 行注释代码（240 行非注释、非空白代码），我们完全定义了我们的最小语言，包括词法分析器、解析器和 AST 构建器。完成后，可执行文件将验证 Kaleidoscope 代码并告诉我们它是否在语法上无效。例如，这是一个示例交互：

$ ./a.out
ready> def foo(x y) x+foo(y, 4.0);
Parsed a function definition.
ready> def foo(x y) x+y y;
Parsed a function definition.
Parsed a top-level expr
ready> def foo(x y) x+y );
Parsed a function definition.
Error: unknown token when expecting an expression
ready> extern sin(a);
ready> Parsed an extern
ready> ^D
$

这里有很大的扩展空间。您可以定义新的 AST 节点，以多种方式扩展语言等。在下一期中，我们将介绍如何从 AST 生成 LLVM 中间表示 (IR)。

2.9. 完整代码清单

这是我们运行示例的完整代码清单。因为这使用了 LLVM 库，所以我们需要链接它们。为此，我们使用 llvm-config工具来通知我们的 makefile/命令行关于使用哪些选项：

# Compile
clang++ -g -O3 toy.cpp `llvm-config --cxxflags`
# Run
./a.out

这是代码：

#include <cctype>
#include <cstdio>
#include <cstdlib>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>

//===----------------------------------------------------------------------===//
// Lexer
//===----------------------------------------------------------------------===//

// The lexer returns tokens [0-255] if it is an unknown character, otherwise one
// of these for known things.
enum Token {
  tok_eof = -1,

  // commands
  tok_def = -2,
  tok_extern = -3,

  // primary
  tok_identifier = -4,
  tok_number = -5
};

static std::string IdentifierStr; // Filled in if tok_identifier
static double NumVal;             // Filled in if tok_number

/// gettok - Return the next token from standard input.
static int gettok() {
  static int LastChar = ' ';

  // Skip any whitespace.
  while (isspace(LastChar))
    LastChar = getchar();

  if (isalpha(LastChar)) { // identifier: [a-zA-Z][a-zA-Z0-9]*
    IdentifierStr = LastChar;
    while (isalnum((LastChar = getchar())))
      IdentifierStr += LastChar;

    if (IdentifierStr == "def")
      return tok_def;
    if (IdentifierStr == "extern")
      return tok_extern;
    return tok_identifier;
  }

  if (isdigit(LastChar) || LastChar == '.') { // Number: [0-9.]+
    std::string NumStr;
    do {
      NumStr += LastChar;
      LastChar = getchar();
    } while (isdigit(LastChar) || LastChar == '.');

    NumVal = strtod(NumStr.c_str(), nullptr);
    return tok_number;
  }

  if (LastChar == '#') {
    // Comment until end of line.
    do
      LastChar = getchar();
    while (LastChar != EOF && LastChar != '\n' && LastChar != '\r');

    if (LastChar != EOF)
      return gettok();
  }

  // Check for end of file.  Don't eat the EOF.
  if (LastChar == EOF)
    return tok_eof;

  // Otherwise, just return the character as its ascii value.
  int ThisChar = LastChar;
  LastChar = getchar();
  return ThisChar;
}

//===----------------------------------------------------------------------===//
// Abstract Syntax Tree (aka Parse Tree)
//===----------------------------------------------------------------------===//

namespace {

/// ExprAST - Base class for all expression nodes.
class ExprAST {
public:
  virtual ~ExprAST() = default;
};

/// NumberExprAST - Expression class for numeric literals like "1.0".
class NumberExprAST : public ExprAST {
  double Val;

public:
  NumberExprAST(double Val) : Val(Val) {}
};

/// VariableExprAST - Expression class for referencing a variable, like "a".
class VariableExprAST : public ExprAST {
  std::string Name;

public:
  VariableExprAST(const std::string &Name) : Name(Name) {}
};

/// BinaryExprAST - Expression class for a binary operator.
class BinaryExprAST : public ExprAST {
  char Op;
  std::unique_ptr<ExprAST> LHS, RHS;

public:
  BinaryExprAST(char Op, std::unique_ptr<ExprAST> LHS,
                std::unique_ptr<ExprAST> RHS)
      : Op(Op), LHS(std::move(LHS)), RHS(std::move(RHS)) {}
};

/// CallExprAST - Expression class for function calls.
class CallExprAST : public ExprAST {
  std::string Callee;
  std::vector<std::unique_ptr<ExprAST>> Args;

public:
  CallExprAST(const std::string &Callee,
              std::vector<std::unique_ptr<ExprAST>> Args)
      : Callee(Callee), Args(std::move(Args)) {}
};

/// PrototypeAST - This class represents the "prototype" for a function,
/// which captures its name, and its argument names (thus implicitly the number
/// of arguments the function takes).
class PrototypeAST {
  std::string Name;
  std::vector<std::string> Args;

public:
  PrototypeAST(const std::string &Name, std::vector<std::string> Args)
      : Name(Name), Args(std::move(Args)) {}

  const std::string &getName() const { return Name; }
};

/// FunctionAST - This class represents a function definition itself.
class FunctionAST {
  std::unique_ptr<PrototypeAST> Proto;
  std::unique_ptr<ExprAST> Body;

public:
  FunctionAST(std::unique_ptr<PrototypeAST> Proto,
              std::unique_ptr<ExprAST> Body)
      : Proto(std::move(Proto)), Body(std::move(Body)) {}
};

} // end anonymous namespace

//===----------------------------------------------------------------------===//
// Parser
//===----------------------------------------------------------------------===//

/// CurTok/getNextToken - Provide a simple token buffer.  CurTok is the current
/// token the parser is looking at.  getNextToken reads another token from the
/// lexer and updates CurTok with its results.
static int CurTok;
static int getNextToken() { return CurTok = gettok(); }

/// BinopPrecedence - This holds the precedence for each binary operator that is
/// defined.
static std::map<char, int> BinopPrecedence;

/// GetTokPrecedence - Get the precedence of the pending binary operator token.
static int GetTokPrecedence() {
  if (!isascii(CurTok))
    return -1;

  // Make sure it's a declared binop.
  int TokPrec = BinopPrecedence[CurTok];
  if (TokPrec <= 0)
    return -1;
  return TokPrec;
}

/// LogError* - These are little helper functions for error handling.
std::unique_ptr<ExprAST> LogError(const char *Str) {
  fprintf(stderr, "Error: %s\n", Str);
  return nullptr;
}
std::unique_ptr<PrototypeAST> LogErrorP(const char *Str) {
  LogError(Str);
  return nullptr;
}

static std::unique_ptr<ExprAST> ParseExpression();

/// numberexpr ::= number
static std::unique_ptr<ExprAST> ParseNumberExpr() {
  auto Result = std::make_unique<NumberExprAST>(NumVal);
  getNextToken(); // consume the number
  return std::move(Result);
}

/// parenexpr ::= '(' expression ')'
static std::unique_ptr<ExprAST> ParseParenExpr() {
  getNextToken(); // eat (.
  auto V = ParseExpression();
  if (!V)
    return nullptr;

  if (CurTok != ')')
    return LogError("expected ')'");
  getNextToken(); // eat ).
  return V;
}

/// identifierexpr
///   ::= identifier
///   ::= identifier '(' expression* ')'
static std::unique_ptr<ExprAST> ParseIdentifierExpr() {
  std::string IdName = IdentifierStr;

  getNextToken(); // eat identifier.

  if (CurTok != '(') // Simple variable ref.
    return std::make_unique<VariableExprAST>(IdName);

  // Call.
  getNextToken(); // eat (
  std::vector<std::unique_ptr<ExprAST>> Args;
  if (CurTok != ')') {
    while (true) {
      if (auto Arg = ParseExpression())
        Args.push_back(std::move(Arg));
      else
        return nullptr;

      if (CurTok == ')')
        break;

      if (CurTok != ',')
        return LogError("Expected ')' or ',' in argument list");
      getNextToken();
    }
  }

  // Eat the ')'.
  getNextToken();

  return std::make_unique<CallExprAST>(IdName, std::move(Args));
}

/// primary
///   ::= identifierexpr
///   ::= numberexpr
///   ::= parenexpr
static std::unique_ptr<ExprAST> ParsePrimary() {
  switch (CurTok) {
  default:
    return LogError("unknown token when expecting an expression");
  case tok_identifier:
    return ParseIdentifierExpr();
  case tok_number:
    return ParseNumberExpr();
  case '(':
    return ParseParenExpr();
  }
}

/// binoprhs
///   ::= ('+' primary)*
static std::unique_ptr<ExprAST> ParseBinOpRHS(int ExprPrec,
                                              std::unique_ptr<ExprAST> LHS) {
  // If this is a binop, find its precedence.
  while (true) {
    int TokPrec = GetTokPrecedence();

    // If this is a binop that binds at least as tightly as the current binop,
    // consume it, otherwise we are done.
    if (TokPrec < ExprPrec)
      return LHS;

    // Okay, we know this is a binop.
    int BinOp = CurTok;
    getNextToken(); // eat binop

    // Parse the primary expression after the binary operator.
    auto RHS = ParsePrimary();
    if (!RHS)
      return nullptr;

    // If BinOp binds less tightly with RHS than the operator after RHS, let
    // the pending operator take RHS as its LHS.
    int NextPrec = GetTokPrecedence();
    if (TokPrec < NextPrec) {
      RHS = ParseBinOpRHS(TokPrec + 1, std::move(RHS));
      if (!RHS)
        return nullptr;
    }

    // Merge LHS/RHS.
    LHS =
        std::make_unique<BinaryExprAST>(BinOp, std::move(LHS), std::move(RHS));
  }
}

/// expression
///   ::= primary binoprhs
///
static std::unique_ptr<ExprAST> ParseExpression() {
  auto LHS = ParsePrimary();
  if (!LHS)
    return nullptr;

  return ParseBinOpRHS(0, std::move(LHS));
}

/// prototype
///   ::= id '(' id* ')'
static std::unique_ptr<PrototypeAST> ParsePrototype() {
  if (CurTok != tok_identifier)
    return LogErrorP("Expected function name in prototype");

  std::string FnName = IdentifierStr;
  getNextToken();

  if (CurTok != '(')
    return LogErrorP("Expected '(' in prototype");

  std::vector<std::string> ArgNames;
  while (getNextToken() == tok_identifier)
    ArgNames.push_back(IdentifierStr);
  if (CurTok != ')')
    return LogErrorP("Expected ')' in prototype");

  // success.
  getNextToken(); // eat ')'.

  return std::make_unique<PrototypeAST>(FnName, std::move(ArgNames));
}

/// definition ::= 'def' prototype expression
static std::unique_ptr<FunctionAST> ParseDefinition() {
  getNextToken(); // eat def.
  auto Proto = ParsePrototype();
  if (!Proto)
    return nullptr;

  if (auto E = ParseExpression())
    return std::make_unique<FunctionAST>(std::move(Proto), std::move(E));
  return nullptr;
}

/// toplevelexpr ::= expression
static std::unique_ptr<FunctionAST> ParseTopLevelExpr() {
  if (auto E = ParseExpression()) {
    // Make an anonymous proto.
    auto Proto = std::make_unique<PrototypeAST>("__anon_expr",
                                                std::vector<std::string>());
    return std::make_unique<FunctionAST>(std::move(Proto), std::move(E));
  }
  return nullptr;
}

/// external ::= 'extern' prototype
static std::unique_ptr<PrototypeAST> ParseExtern() {
  getNextToken(); // eat extern.
  return ParsePrototype();
}

//===----------------------------------------------------------------------===//
// Top-Level parsing
//===----------------------------------------------------------------------===//

static void HandleDefinition() {
  if (ParseDefinition()) {
    fprintf(stderr, "Parsed a function definition.\n");
  } else {
    // Skip token for error recovery.
    getNextToken();
  }
}

static void HandleExtern() {
  if (ParseExtern()) {
    fprintf(stderr, "Parsed an extern\n");
  } else {
    // Skip token for error recovery.
    getNextToken();
  }
}

static void HandleTopLevelExpression() {
  // Evaluate a top-level expression into an anonymous function.
  if (ParseTopLevelExpr()) {
    fprintf(stderr, "Parsed a top-level expr\n");
  } else {
    // Skip token for error recovery.
    getNextToken();
  }
}

/// top ::= definition | external | expression | ';'
static void MainLoop() {
  while (true) {
    fprintf(stderr, "ready> ");
    switch (CurTok) {
    case tok_eof:
      return;
    case ';': // ignore top-level semicolons.
      getNextToken();
      break;
    case tok_def:
      HandleDefinition();
      break;
    case tok_extern:
      HandleExtern();
      break;
    default:
      HandleTopLevelExpression();
      break;
    }
  }
}

//===----------------------------------------------------------------------===//
// Main driver code.
//===----------------------------------------------------------------------===//

int main() {
  // Install standard binary operators.
  // 1 is lowest precedence.
  BinopPrecedence['<'] = 10;
  BinopPrecedence['+'] = 20;
  BinopPrecedence['-'] = 20;
  BinopPrecedence['*'] = 40; // highest.

  // Prime the first token.
  fprintf(stderr, "ready> ");
  getNextToken();

  // Run the main "interpreter loop" now.
  MainLoop();

  return 0;
}

Next: 为 LLVM IR 实现代码生成