模組 Misc.Magic_number

module Magic_number: sig .. end

---

典型的魔術數字是 "Caml1999I011"；它由一個字母數字前綴組成，這裡為 Caml1990I，後接一個版本號，這裡為 011。前綴識別版本化數據的種類：這裡的 I 表示這是 .cmi 檔案的魔術數字。

所有魔術數字都有相同的位元組長度， magic_length，這對使用者來說很重要，因為它提供了讀取位元組序列以獲取應為魔術數字的位元組數。典型的使用者程式碼會像這樣：

        let ic = open_in_bin path in
        let magic =
          try really_input_string ic Magic_number.magic_length
          with End_of_file -> ... in
        match Magic_number.parse magic with
        | Error parse_error -> ...
        | Ok info -> ...
      

給定的編譯器版本期望每種物件檔案都有一個特定的版本，如果給定不支援的版本，則會失敗。由於版本是單調遞增的，您可以將已解析的版本與某種類型的預期「目前版本」進行比較，以判斷錯誤魔術物件檔案是來自過去還是未來。

一個期望給定種類的魔術數字的「目前支援版本」的程式碼區塊範例，這裡為 Cmxa，如下所示：

        let ic = open_in_bin path in
        begin
          try Magic_number.(expect_current Cmxa (get_info ic)) with
          | Parse_error error -> ...
          | Unexpected error -> ...
        end;
        ...
      

解析錯誤會區分以下輸入：Not_a_magic_number str，這可能來自完全不同的檔案；以及 Truncated str，由作為有效魔術數字（可能為空）的前綴的標頭引發。

意外錯誤對應於有效的魔術數字，但不是預期的數字，原因可能是它對應於不同的種類，或是更新或更舊的版本。

輔助函式 explain_parse_error 和 explain_unexpected_error 將會產生每個錯誤的文字說明，以便在錯誤訊息中使用。

type native_obj_config = {

flambda : bool;

}

val native_obj_config : native_obj_config

type version = int 

type kind = 

|	Exec
|	Cmi
|	Cmo
|	Cma
|	Cmx of native_obj_config
|	Cmxa of native_obj_config
|	Cmxs
|	Cmt
|	Ast_impl
|	Ast_intf

type info = {

	kind : kind;
	version : version;	(*	注意：某些版本的編譯器對所有種類都使用相同的 version 後綴，但其他版本則對不同的種類使用不同的版本計數器。我們只能假設版本在編譯器版本之間是單調遞增的（不一定總是加一）。	*)

}

type raw = string 

解析魔術數字

type parse_error = 

|	Truncated of string
|	Not_a_magic_number of string

val explain_parse_error : kind option -> parse_error -> string

val parse : raw ->
       (info, parse_error) result

val read_info : in_channel ->
       (info, parse_error) result

val magic_length : int

檢查魔術數字是否為當前版本

type 'a unexpected = {

	expected : 'a;
	actual : 'a;

}

type unexpected_error = 

|	Kind of kind unexpected
|	Version of kind * version unexpected

val check_current : kind ->
       info ->
       (unit, unexpected_error) result

val explain_unexpected_error : unexpected_error -> string

type error = 

|	Parse_error of parse_error
|	Unexpected_error of unexpected_error

val read_current_info : expected_kind:kind option ->
       in_channel ->
       (info, error) result

關於魔術數字的資訊

val string_of_kind : kind -> string

val human_name_of_kind : kind -> string

val current_raw : kind -> raw

val current_version : kind -> version

原始表示法

主要用於內部使用和測試。

type raw_kind = string 

val parse_kind : raw_kind -> kind option

val raw_kind : kind -> raw_kind

val raw : info -> raw

val all_kinds : kind list