CodeGenerator 类
用于将代码块转换为语言的代码生成器的类。
Signature:
export declare class CodeGenerator
构造函数
| 构造函数 | 修饰符 | 说明 |
|---|---|---|
| (构造函数)(名称) | 构造 CodeGenerator 类的新实例 |
属性
| 属性 | 修饰符 | 类型 | 说明 |
|---|---|---|---|
| COMMENT_WRAP | number | 封装前注释的长度上限。不考虑缩进级别。 | |
| definitions_ | protected |
{ [键: 字符串]: 字符串; } | 要在代码前面输出的定义字典。 |
| forBlock | Record<string, (block: Block, generator: this) => [string, number] | string | null> | 块生成器函数的字典，由块类型键控。每个块生成器函数都采用两个参数： - 为调用 CodeGenerator（或子类）实例生成代码的块；这样，函数就可以调用下面定义的方法（例如 blockToCode）或对相关子类（例如 JavascripGenerator）调用。 并返回： - [代码, 优先级] 元组（对于值/表达式块），或者 - 包含所生成代码的字符串（对于语句块），或者 - 如果不应为块发出任何代码，则为 null。 |
|
| FUNCTION_NAME_PLACEHOLDER_ | string | 它在使用 CodeGenerator.provideFunction_ 定义的函数中用作占位符。而不能是可以合法出现在函数定义（或注释）中的法律代码，也不能混淆正则表达式解析器。 | |
| FUNCTION_NAME_PLACEHOLDER_REGEXP_ | RegExp | ||
| functionNames_ | protected |
{ [键: 字符串]: 字符串; } | 将定义中的所需函数名称映射到实际函数名称的字典（以避免与用户函数冲突）。 |
| 缩进 | string | 缩进方法。默认为两个空格，但语言生成器可能会覆盖此设置，以增加缩进量或更改为制表符。 | |
| INFINITE_LOOP_TRAP | 字符串 | null | 将任意代码注入到可能会导致无限循环的位置。“%1”的所有实例都会被替换为失败的块 ID。例如 checkTimeout(%1);\n |
|
| isInitialized | boolean | null | 是否已调用 init 方法。如果生成器在创建后将此标记设为 false 并在 init 中设为 true，则当生成器尚未初始化时，blockToCode 会发出一条警告。如不更改，此标记将不会产生任何影响。 | |
| name_ | string | ||
| nameDB_? | 姓名 | （可选）包含变量和过程名称的数据库。 | |
| ORDER_OVERRIDES | 数字 [][] | 不需要括号的外层对外组合的列表。 | |
| RESERVED_WORDS_ | protected |
string | 以英文逗号分隔的保留字列表。 |
| STATEMENT_PREFIX | 字符串 | null | 在每个语句之前注入的任意代码。“%1”的所有实例都将替换为语句的块 ID。例如 highlight(%1);\n |
|
| STATEMENT_SUFFIX | 字符串 | null | 在每个语句后注入的任意代码。“%1”的所有实例都将替换为语句的块 ID。例如 highlight(%1);\n |
方法
| 方法 | 修饰符 | 说明 |
|---|---|---|
| addLoopTrap(branch, block) | 向循环的内容添加无限循环陷阱。在循环代码块的开头（即执行循环语句之后）添加语句后缀，并在循环代码块的末尾（即执行循环语句之前）添加语句前缀。 | |
| addReservedWords(words) | 向该语言的保留字词列表添加一个或多个字词。 | |
| allNestedComments(block) | 以递归方式在块树中实现“蜘蛛”程序，返回其所有注释。 | |
| blockToCode(block, opt_thisOnly) | 为指定的代码块（以及附加的代码块）生成代码。必须在调用此函数之前初始化生成器。 | |
| finish（代码） | 钩子在代码生成结束时运行代码。子类可以覆盖此设置，例如，在生成的代码前面加上 import 语句或变量定义。 | |
| getProcedureName(name) | 获取用户定义的过程的唯一法定名称。在调用此方法之前，该类的 nameDB_ 属性必须已初始化。此操作通常在代码生成器类的 init 函数中完成。 |
|
| getVariableName(nameOrId) | 获取用户定义的变量的唯一法定名称。在调用此方法之前，该类的 nameDB_ 属性必须已初始化。此操作通常在代码生成器类的 init 函数中完成。 |
|
| init(_workspace) | 钩子机制，用于在代码生成开始之前运行代码。子类可以覆盖此设置，例如，为了初始化变量名称数据库。 | |
| injectId(msg, block) | 将块 ID 注入消息中以替换“%1”。用于 STATEMENT_PREFIX、STATEMENT_SUFFIX 和 INFINITE_LOOP_TRAP。 | |
| prefixLines(text, prefix) | 在每行代码前面附加一个通用前缀。适用于缩进代码或添加注释标记。 | |
| provideFunction_(desiredName, 代码) | 定义要包含在生成的代码中的开发者定义的函数（而非用户定义的过程）。用于创建私有辅助函数。第一次使用指定 requiredName 调用该方法时，系统会保存代码并生成实际名称。使用相同 requiredName 的后续调用不会产生任何影响，但具有相同的返回值。 调用方应确保不同的辅助函数不会使用同一个 requiredName（例如，使用“colourRandom”和“listRandom”，而非“random”）。没有与预留字、用户定义的变量或过程名称冲突的风险。 调用 CodeGenerator.finish() 时，该代码即会被输出。 |
|
| scrub_(_block, code, _opt_thisOnly) | 根据代码块生成代码的常见任务。此方法从 blockToCode 调用，并对每个代码块（而不仅仅是顶级代码块）调用。例如，子类可以覆盖此设置，例如，为块后面的语句生成代码，或者为指定块以及任何连接的值块处理注释。 | |
| scrubNakedValue(line) | 裸值是输出未插入任何内容的顶级块。子类可以覆盖此属性，例如，如果其语言不允许裸值。 | |
| statementToCode(block, name) | 生成一个代码字符串，表示附加到命名语句输入的块。缩进代码。这主要在生成器中使用。尝试生成代码以评估时，请使用 workspaceToCode 或 blockToCode 查看。 | |
| valueToCode(block, name, outerOrder) | 生成表示指定值输入的代码。 | |
| workspaceToCode(workspace) | 为工作区中的所有代码块生成指定语言的代码。 |