第 12 章 語言擴展

12 屬性

• 12.1 內建屬性

(在 OCaml 4.02 中引入，4.03 中為表達式以外的建構新增了中綴表示法)

屬性是語法樹的「裝飾」，主要被類型檢查器忽略，但可以被外部工具使用。屬性由識別符和有效負載組成，有效負載可以是結構、類型表達式(以:為前綴)、簽名(以:為前綴)或模式(以?為前綴)，可選地後面跟著 when 子句

第一種形式的屬性附加在「代數」類別的後綴表示法上

這種形式的屬性也可以插入在多態變體類型表達式(tag-spec-first、tag-spec、tag-spec-full)中的`tag-name之後，或在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），會隱式停用最佳化。