第 12 章 语言扩展

12 属性

• 12.1 内置属性

(在 OCaml 4.02 中引入，在 4.03 中添加了除表达式外的构造的中缀表示法)

属性是语法树的“装饰”，类型检查器大多会忽略它们，但外部工具可以使用它们。属性由一个标识符和一个有效负载组成，有效负载可以是结构、类型表达式（以 : 为前缀）、签名（以 : 为前缀）或模式（以 ? 为前缀），后面可以选择跟随一个 when 子句

属性的第一种形式附加在“代数”类别上，使用后缀表示法

这种形式的属性也可以插入到多态变体类型表达式中的 `tag-name 后面 (tag-spec-first、tag-spec、tag-spec-full) 或 method-type 中的 method-name 后面。

相同的语法形式也用于将属性附加到类型声明中的标签和构造函数

注意：当标签声明后面跟着分号时，属性也可以放在分号后面（在这种情况下，它们会与之前指定的属性合并）。

属性的第二种形式附加到“块”上，例如类型声明、类字段等

属性的第三种形式出现在模块或类子语言中的独立结构或签名项中。它们没有附加到语法树中的任何特定节点

(注意：与上面语法描述的相反，item-attributes 不能附加到 class-field-spec 和 class-field 中的这些浮动属性上。)

也可以使用中缀语法指定属性。例如

let[@foo] x = 2 in x + 1          === (let x = 2 [@@foo] in x + 1)
begin[@foo][@bar x] ... end       === (begin ... end)[@foo][@bar x]
module[@foo] M = ...              === module M = ... [@@foo]
type[@foo] t = T                  === type t = T [@@foo]
method[@foo] m = ...              === method m = ... [@@foo]

对于 let，属性应用于每个绑定

let[@foo] x = 2 and y = 3 in x + y === (let x = 2 [@@foo] and y = 3 in x + y)
let[@foo] x = 2
and[@bar] y = 3 in x + y           === (let x = 2 [@@foo] and y = 3 [@@bar] in x + y)

12.1 内置属性

某些属性会被类型检查器理解

• “ocaml.warning” 或 “warning”，带有字符串字面量作为有效负载。这可以作为浮动属性用于签名/结构/对象/对象类型中。该字符串会被解析，并在属性与当前签名/结构/对象/对象类型的结尾之间的范围内，产生与 -w 命令行选项相同的效果。该属性还可以附加到任何支持属性的语法项（例如表达式或类型表达式）上，在这种情况下，其作用域仅限于该项。请注意，对于特定警告使用哪个作用域并没有明确定义。这是实现相关的，并且可能在不同版本之间发生变化。某些警告甚至完全不受“ocaml.warning”的控制（例如，警告 1、2、14、29 和 50）。
• “ocaml.warnerror” 或 “warnerror”，带有字符串字面量作为有效负载。与“ocaml.warning”相同，用于 -warn-error 命令行选项。
• “ocaml.alert” 或 “alert”：请参阅第 12.21 节。
• “ocaml.deprecated” 或 “deprecated”：是“deprecated”警告的别名，请参阅第 12.21 节。
• “ocaml.deprecated_mutable” 或 “deprecated_mutable”。可以应用于可变记录标签。如果该标签随后用于修改字段（使用“expr.l <- expr”），则会触发“deprecated”警告。如果属性的有效负载是字符串字面量，则警告消息将包含此文本。
• “ocaml.ppwarning” 或 “ppwarning”，在任何上下文中，带有字符串字面量作为有效负载。编译器会将该文本报告为警告 (22)（目前，警告位置是字符串有效负载的位置）。这主要对需要向用户传达警告的预处理器有用。这也可以用于显式标记某些代码位置以供进一步检查。
• “ocaml.warn_on_literal_pattern” 或 “warn_on_literal_pattern” 用于注释类型定义中的构造函数。当使用常量字面量作为参数对该构造函数进行模式匹配时，就会发出警告 (52)。此属性表示其参数纯粹用于信息，并且将来可能会发生变化的构造函数。因此，使用常量字面量对该参数进行模式匹配不可靠。例如，所有内置异常构造函数都标记为“warn_on_literal_pattern”。请注意，由于实现限制，此警告 (52) 仅针对单参数构造函数触发。
• “ocaml.tailcall” 或 “tailcall” 可以应用于函数应用，以检查该调用是否进行了尾调用优化。如果不是这种情况，则会发出警告 (51)。
• “ocaml.inline” 或 “inline” 在函数或函子定义上采用“never”、“always”或无有效负载。如果未提供有效负载，则默认值为“always”。此有效负载控制何时应内联带注释函数的应用。
• “ocaml.inlined” 或 “inlined” 可以应用于任何函数或函子应用，以检查编译器是否内联了该调用。如果未内联该调用，则会发出警告 (55)。
• “ocaml.noalloc”、“ocaml.unboxed”和“ocaml.untagged” 或 “noalloc”、“unboxed”和“untagged” 可用于外部定义，以获得对 C 到 OCaml 接口的更精细控制。有关更多详细信息，请参阅 22.11。
• “ocaml.immediate” 或 “immediate” 应用于抽象类型，将该类型标记为具有非指针实现（例如“int”、“bool”、“char”或枚举类型）。这些立即类型的变异不会激活垃圾回收器的写屏障，这可以显著提高严重依赖可变状态的程序的性能。
• “ocaml.immediate64” 或 “immediate64” 应用于抽象类型，将该类型标记为在 64 位平台上具有非指针实现。在其他平台上不作任何假设。为了生成具有“immediate64”属性的类型，必须使用“Sys.Immediate64.Make”函子。
• ocaml.unboxed 或 unboxed 可用于类型定义，如果该类型是单字段记录或具有单个参数的单个构造函数的具体类型。它告诉编译器通过删除表示记录或构造函数的块来优化类型的表示（即，此类型的值在物理上等于其参数）。在 GADT 的情况下，会应用一个额外的限制：参数不能是存在变量、由存在类型变量表示，也不能是应用于存在类型变量的抽象类型构造函数。
• ocaml.boxed 或 boxed 可用于类型定义，表示与 ocaml.unboxed 相反：保留类型的未优化表示。当没有注释时，默认值当前为 boxed，但将来可能会更改。
• ocaml.local 或 local 在函数定义上采用“never”、“always”、“maybe”或无有效负载。如果未提供有效负载，则默认值为 always。该属性控制一种优化，该优化包括将函数编译为静态延续。与内联相反，此优化不会复制函数的主体。当函数的所有引用都是完全应用时，这才是可能的，所有引用都共享相同的延续（例如，模式匹配的几个分支的返回值）。never 禁用优化，always 断言优化适用（否则会发出警告 55），而 maybe 允许优化在可能时应用（当未指定属性时，这是默认行为）。在调试模式 (-g) 下使用字节码编译器以及标记有 ocaml.inline always 或 ocaml.unrolled 属性（取代 ocaml.local）的函数时，会隐式禁用此优化。