仓颉编程语言：宏的实现

本章节介绍仓颉宏的定义和使用，仓颉宏可以分为非属性宏和属性宏。同时本章节还会介绍宏出现嵌套时的行为。

非属性宏

非属性宏只接受被转换的代码，不接受其他参数（属性），其定义格式如下：

import std.ast.*

public macro MacroName(args: Tokens): Tokens {
    ... // Macro body
}

宏的调用格式如下：

@MacroName(...)

宏调用使用 () 括起来。括号里面可以是任意合法 tokens，也可以是空。

当宏作用于声明时，一般可以省略括号。参考下面例子

@MacroName func name() {}        // Before a FuncDecl
@MacroName struct name {}        // Before a StructDecl
@MacroName class name {}         // Before a ClassDecl
@MacroName var a = 1             // Before a VarDecl
@MacroName enum e {}             // Before a enum
@MacroName interface i {}        // Before a InterfaceDecl
@MacroName extend e <: i {}      // Before a ExtendDecl
@MacroName mut prop i: Int64 {}  // Before a PropDecl
@MacroName @AnotherMacro(input)  // Before a macro call

宏展开过程作用于仓颉语法树，宏展开后，编译器会继续进行后续的编译过程，因此，用户需要保证宏展开后的代码依然是合法的仓颉代码，否则可能引发编译问题。当宏用于声明时，如果省略括号，宏的输入必须是语法合法的声明，IDE 也会提供相应的语法检查和高亮。

下面是几个宏应用的典型示例。

• 示例 1

  宏定义文件 macro_definition.cj

  macro package macro_definition
  
  import std.ast.*
  
  public macro TestDef(input: Tokens): Tokens {
      println("I'm in macro body")
      return input
  }

  宏调用文件 macro_call.cj

  package macro_calling
  
  import macro_definition.*
  
  main(): Int64 {
      println("I'm in function body")
      let a: Int64 = @TestDef(1 + 2)
      println("a = ${a}")
      return 0
  }

  上述代码的编译过程可以参考宏的编译和使用。

  我们在用例中添加了打印信息，其中宏定义中的 I'm in macro body 将在编译 macro_call.cj 的期间输出，即对宏定义求值。同时，宏调用点被展开，如编译如下代码：

  let a: Int64 = @TestDef(1 + 2)

  编译器将宏返回的 Tokens 更新到调用点的语法树上，得到如下代码：

  let a: Int64 = 1 + 2

  也就是说，可执行程序中的代码