函数

func assertParentContext(String)

public func assertParentContext(parentMacroName: String): Unit

功能：检查当前宏调用是否在特定的宏调用内。若检查不符合预期，编译器出现一个错误提示。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

parentMacroName: String - 待检查的外层宏调用的名字。

func cangjieLex(String)

public func cangjieLex(code: String): Tokens

功能：将字符串转换为 Tokens 对象。

参数：

code: String - 待词法解析的字符串。

返回值：

Tokens - 词法解析得到的 Tokens。

异常：

IllegalMemoryException - 当申请内存失败时，抛出异常。
IllegalArgumentException - 当输入的 code 无法被正确的解析为 Tokens 时，抛出异常。

func cangjieLex(String, Bool)

public func cangjieLex(code: String, truncated: Bool): Tokens

功能：将字符串转换为 Tokens 对象。

参数：

code: String - 待词法解析的字符串。
truncated: Bool - 是否删减解析后 Tokens 中的 Token(END)。

返回值：

Tokens - 词法解析得到的 Tokens。

异常：

IllegalMemoryException - 当申请内存失败，抛出异常时，抛出异常。
IllegalArgumentException - 当输入的 code 无法被正确的解析为 Tokens 时，抛出异常。

func compareTokens(Tokens, Tokens)

public func compareTokens(tokens1: Tokens, tokens2: Tokens): Bool

功能：用于比较两个Tokens是否一致。

参数：

tokens1: Tokens - 需要比较的第一个 Tokens。
tokens2: Tokens - 需要比较的第二个 Tokens。

返回值：

Bool - 如果两个 Tokens 内容相同（除了换行符、结束符和位置信息）则返回 true。

func diagReport(DiagReportLevel, Tokens, String, String)

public func diagReport(level: DiagReportLevel, tokens: Tokens, message: String, hint: String): Unit

功能：报错接口，在编译过程的宏展开阶段输出错误提示信息，支持 WARNING 和 ERROR 两个等级的报错。

注意：

该接口在错误等级为 ERROR 时会终止编译过程，但不会终止宏展开过程，建议用户调用接口后直接 return 或者抛出异常来终止宏展开过程。

该接口会按照 cjc 标准报错的接口，将传入的 tokens 所在行的代码列出，并对 tokens 的内容用波浪线进行标注， message 信息将展示在首行， hint 信息将紧跟波浪线进行展示。

报错引用的源码内容目前仅依据第一个 Token 的开始位置和最后一个 Token 的结束位置确定，不校验中间 Token 位置信息的一致性。

该接口在非宏展开过程中调用无效，参见示例代码。

参数：

level: DiagReportLevel - 报错信息等级。
tokens: Tokens - 报错信息中所引用源码内容对应的 Tokens。
message: String - 报错的主信息。
hint: String - 辅助提示信息。

异常：

ASTException - 当输入的 Tokens 存在以下错误时，抛出异常。
- 输入的 Tokens 为空；
- 输入的 Tokens 中的 Token 来自于不同的源文件；
- 输入的 Tokens 中首位 Token 位置早于末位 Token 位置；
- 输入的 Tokens 中的 Token 位置范围超出了宏调用的位置范围。

func getChildMessages(String)

public func getChildMessages(children:String): ArrayList<MacroMessage>

功能：获取特定内层宏发送的信息。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

children: String - 待接收信息的内层宏名称。

返回值：

ArrayList<MacroMessage> - 返回一组 MacroMessage 的对象。

func getTokenKind(UInt16)

public func getTokenKind(no: UInt16): TokenKind

功能：将词法单元种类序号转化为 TokenKind。

参数：

no: UInt16 - 需要转换的序号。

返回值：

TokenKind - 词法单元种类序号对应的 TokenKind。

func insideParentContext(String)

public func insideParentContext(parentMacroName: String): Bool

功能：检查当前宏调用是否在特定的宏调用内，返回一个布尔值。

注意：

在嵌套宏场景下，内层宏也可以通过发送键/值对的方式与外层宏通信。当内层宏执行时，通过调用标准库函数 setItem 向外层宏发送信息；随后，当外层宏执行时，调用标准库函数 getChildMessages 接收每一个内层宏发送的信息（一组键/值对映射）。

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

parentMacroName: String - 待检查的外层宏调用的名字。

返回值：

Bool - 若当前宏嵌套在特定的宏调用内，返回 true。

func parseDecl(Tokens, String)

public func parseDecl(input: Tokens, astKind!: String = ""): Decl

功能：用于解析一组词法单元，获取一个 Decl 类型的节点。

参数：

input: Tokens - 待解析源码的词法单元。
astKind!: String - 用于指定解析特定的节点类型，有效支持的值为：PrimaryCtorDecl 和 PropMemberDecl。
- PrimaryCtorDecl: 解析主构造函数。
- PropMemberDecl: 解析prop声明的getter和setter函数。

返回值：

Decl - 一个 Decl 类型的节点。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Decl 节点时，抛出异常。

示例：

以下代码展示 astKind 设为 PropMemberDecl 的案例。在这个参数下，可以使用 parseDecl 解析 prop 的getter和setter函数，解析结果为 FuncDecl 类型（如果不设置astKind，则会因为没有 func 关键字而无法解析）。

import std.ast.*

main() {
    let getter = quote( get() { _val } )
    let setter = quote( set(v) { _val = v })
    let getterDecl = parseDecl(getter, astKind: "PropMemberDecl")
    let setterDecl = parseDecl(setter, astKind: "PropMemberDecl")
    println((getterDecl as FuncDecl).getOrThrow().block.toTokens())
    println((setterDecl as FuncDecl).getOrThrow().block.toTokens())
}

运行结果：

{
    _val
}

{
    _val = v
}

以下代码展示 astKind 设为 PrimaryCtorDecl 的案例。在这个参数下，可以使用 parseDecl 解析主构造函数节点，解析结果为 PrimaryCtorDecl 类型（如果不设置 astKind，则会因为没有 func 关键字而无法解析）。

import std.ast.*

main() {
    let ctor = quote(
        Point(var x: Int32, var y: Int32) {}
    )
    let ctorDecl = parseDecl(ctor, astKind: "PrimaryCtorDecl")
    println(ctorDecl is PrimaryCtorDecl)
    println(ctorDecl.toTokens())
}

运行结果：

true
Point(var x: Int32, var y: Int32) {
}

func parseDeclFragment(Tokens, Int64)

public func parseDeclFragment(input: Tokens, startFrom !: Int64 = 0): (Decl, Int64)

功能：用于解析一组词法单元，获取一个 Decl 类型的节点和继续解析节点的索引。

参数：

input: Tokens - 待解析源码的词法单元。
startFrom!: Int64 - 起始位置。

返回值：

(Decl, Int64) - 语法树节点，继续解析的位置。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Decl 节点时，抛出异常。

func parseExpr(Tokens)

public func parseExpr(input: Tokens): Expr

功能：用于解析一组词法单元，获取一个 Expr 类型的节点。

参数：

input: Tokens - 待解析源码的词法单元。

返回值：

Expr - 一个 Expr 类型的节点。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Expr 节点时，抛出异常。

func parseExprFragment(Tokens, Int64)

public func parseExprFragment(input: Tokens, startFrom !: Int64 = 0): (Expr, Int64)

功能：用于解析一组词法单元，获取一个 Expr 类型的节点和继续解析节点的索引。

参数：

input: Tokens - 待解析源码的词法单元。
startFrom!: Int64 - 起始位置。

返回值：

(Expr, Int64) - 语法树节点，继续解析的位置。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Expr 节点时，抛出异常。

func parsePattern(Tokens)

public func parsePattern(input: Tokens): Pattern

功能：用于解析一组词法单元，获取一个 Pattern 类型的节点。

参数：

input: Tokens - 待解析源码的词法单元。

返回值：

Pattern - 一个 Pattern 类型的节点。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Pattern 节点时，抛出异常。

func parsePatternFragment(Tokens, Int64)

public func parsePatternFragment(input: Tokens, startFrom !: Int64 = 0): (Pattern, Int64)

功能：用于解析一组词法单元，获取一个 Pattern 类型的节点和继续解析节点的索引。

参数：

input: Tokens - 待解析源码的词法单元。
startFrom!: Int64 - 起始位置。

返回值：

(Pattern, Int64) - 语法树节点，继续解析的位置。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Pattern 节点时，抛出异常。

func parseProgram(Tokens)

public func parseProgram(input: Tokens): Program

功能：用于解析单个仓颉文件的源码，获取一个 Program 类型的节点。

参数：

input: Tokens - 待解析源码的词法单元。

返回值：

Program - 一个 Program 类型的节点。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 Program 节点时，抛出异常。

func parseType(Tokens)

public func parseType(input: Tokens): TypeNode

功能：用于解析一组词法单元，获取一个 TypeNode 类型的节点。

参数：

input: Tokens - 待解析源码的词法单元。

返回值：

TypeNode - 一个 TypeNode 类型的节点。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 TypeNode 节点时，抛出异常。

func parseTypeFragment(Tokens, Int64)

public func parseTypeFragment(input: Tokens, startFrom !: Int64 = 0): (TypeNode, Int64)

功能：用于解析一组词法单元，获取一个 TypeNode 类型的节点和继续解析节点的索引。

参数：

input: Tokens - 待解析源码的词法单元。
startFrom!: Int64 - 起始位置。

返回值：

(TypeNode, Int64) - 语法树节点，继续解析的位置。

异常：

ParseASTException - 当输入的 Tokens 类型无法构造为 TypeNode 节点时，抛出异常。

func setItem(String, Bool)

public func setItem(key: String, value: Bool): Unit

功能：内层宏通过该接口发送 Bool 类型的信息到外层宏。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

key: String - 发送的关键字，用于检索信息。
value: Bool - 要发送的 Bool 类型的信息。

func setItem(String, Int64)

public func setItem(key: String, value: Int64): Unit

功能：内层宏通过该接口发送 Int64 类型的信息到外层宏。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

key: String - 发送的关键字，用于检索信息。
value: Int64 - 要发送的 Int64 类型的信息。

func setItem(String, String)

public func setItem(key: String, value: String): Unit

功能：内层宏通过该接口发送 String 类型的信息到外层宏。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

key: String - 发送的关键字，用于检索信息。
value: String - 要发送的 String 类型的信息。

func setItem(String, Tokens)

public func setItem(key: String, value: Tokens): Unit

功能：内层宏通过该接口发送 Tokens 类型的信息到外层宏。

注意：

该函数只能作为函数被直接调用，不能作为赋值给变量，不能作为实参或返回值使用。

参数：

key: String - 发送的关键字，用于检索信息。
value: Tokens - 要发送的 Tokens 类型的信息。

仓颉编程语言库 API