仓颉编程入门 -- 宏的介绍

宏的介绍

在编程中，宏可以被视为一种强大的工具，它允许开发者在编译时期对代码进行变换。与普通的函数不同，宏不仅操作数据值，还直接操作代码本身。通过宏，我们可以将复杂的、重复的代码模式抽象化，并在编译时自动生成这些模式的具体实现。

假设我们有一个需求：在开发过程中频繁地需要打印变量或表达式的值及其表达式本身，以便于调试。传统的做法是通过编写大量的 print 语句来实现，但这既繁琐又容易出错。宏提供了一种优雅的解决方案，让我们能够定义一个 dprint 宏，自动完成这一任务。

宏的定义与实现

为了定义并实现 dprint 宏，我们首先需要了解宏的工作环境和相关概念。在假设的编程语言（这里称为“仓颉”）中，宏通常定义在专门的宏包中，并引入必要的标准库类型，如 Tokens，它代表了代码片段的抽象表示。

// 在 macros/dprint.cj 文件中  
macro package define  
  
import std.ast.*  
  
// 定义一个宏 dprint，它接受 Tokens 类型的输入并返回 Tokens 类型的输出  
public macro dprint(input: Tokens): Tokens {  
    // 将输入的 Tokens 转换为字符串，表示原始代码片段  
    let inputStr = input.toString()  
  
    // 使用 quote 表达式构建新的 Tokens，它将输出原始表达式及其计算结果  
    // 注意：这里使用了字符串插值来插入原始表达式字符串和表达式本身  
    let result = quote {  
        print($(inputStr) + " = ")  
        println($(input))  
    }  
  
    // 返回构建好的 Tokens  
    return result  
}

使用宏

定义好宏之后，我们就可以在程序中通过特定的语法（这里使用 @ 前缀）来调用它了。

// 在 main.cj 文件中  
import define.*  
  
main() {  
    let x = 3  
    let y = 2  
  
    // 调用 dprint 宏，打印变量 x 的值和表达式  
    @dprint(x)  
  
    // 调用 dprint 宏，打印表达式 x + y 的值和表达式本身  
    @dprint(x + y)  
}

请注意，得到的目录结构如下：

src
|-- macros
| -- dprint.cj – main.cj

编译与运行

为了使用上述宏，我们需要先编译宏定义文件，然后将编译后的宏与主程序一起编译。

# 编译宏定义文件  
cjc macros/*.cj --compile-macro
cjc main.cj -o main

运行程序后，我们应该能看到输出如下：

x = 3  
x + y = 5

第 1 行：

plaintext复制代码

macro package define

说明： 在仓颉语言中，为了保持代码的组织性和清晰度，宏被要求声明在独立的包中。这样的设计有助于避免宏与公共函数或变量之间的潜在冲突。通过macro package define，我们创建了一个名为define（或任何你希望命名的）宏包，用于专门存放宏定义。

第 2 行：

plaintext复制代码

import std.ast.*

说明： 在编写宏时，我们经常需要操作代码的底层表示，如Tokens和语法树节点等。这些类型由仓颉的标准库std.ast提供。通过import std.ast.*，我们导入了std.ast包中的所有内容，这样在宏的代码中就可以直接使用这些类型了。

第 3 行：

plaintext复制代码

public macro dprint(input: Tokens): Tokens

说明： 在这里，我们声明了一个公开的宏dprint。它是一个非属性宏，意味着它不会修改或扩展已存在的类、函数或变量的属性。dprint宏接受一个Tokens类型的参数input，这个参数代表了传递给宏的程序片段。宏的返回值同样是Tokens类型，表示经过宏处理后的新程序片段。

第 4 行：

plaintext复制代码

let inputStr = input.toString()

说明： 在宏的实现中，我们首先调用input.toString()方法将输入的Tokens转换成了一个字符串inputStr。这个字符串包含了传递给宏的原始代码片段，比如"x"或"x + y"。转换成字符串是为了后续构建包含该表达式的打印语句。

第 5-7 行：

let result = quote(  
    print($(inputStr) + " = "),  
    println($(input))  
)

说明： 接下来，我们使用quote表达式来构造一个新的Tokens，它表示一个打印语句，先打印原始表达式字符串和" = "，然后换行打印表达式的计算结果。在quote中，我们使用了插值$(...)来动态地插入表达式的值。$(inputStr)被替换为包含原始表达式的字符串（带引号），而$(input)则被替换为原始的Tokens，即未经字符串化的代码片段。这样，如果输入的表达式是x + y，那么quote表达式将生成类似于print("x + y" + " = ")和println(x + y)的代码。

注意： 我稍微调整了quote的使用方式，使其更接近于大多数编程语言中字符串模板或内联代码片段的书写习惯。不过，具体语法可能因仓颉语言的实际实现而异。

第 8 行：

plaintext复制代码

return result