模块 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 后缀，但其他编译器对不同类型使用不同的版本计数器。我们只能假设版本在编译器版本之间单调递增（不一定是每次递增 1）。	*)

}

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