Source file `zero_alloc_annotations.ml`

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
(******************************************************************************
 *                                  OxCaml                                    *
 *                         Greta Yorsh, Jane Street                           *
 * -------------------------------------------------------------------------- *
 *                               MIT License                                  *
 *                                                                            *
 * Copyright (c) 2024 Jane Street Group LLC                                   *
 * opensource-contacts@janestreet.com                                         *
 *                                                                            *
 * Permission is hereby granted, free of charge, to any person obtaining a    *
 * copy of this software and associated documentation files (the "Software"), *
 * to deal in the Software without restriction, including without limitation  *
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
 * and/or sell copies of the Software, and to permit persons to whom the      *
 * Software is furnished to do so, subject to the following conditions:       *
 *                                                                            *
 * The above copyright notice and this permission notice shall be included    *
 * in all copies or substantial portions of the Software.                     *
 *                                                                            *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
 * DEALINGS IN THE SOFTWARE.                                                  *
 ******************************************************************************)
module Check = struct
  type t =
    | Check_default
    | Check_all
    | Check_opt_only
    | No_check

  let all = [Check_default; Check_all; Check_opt_only; No_check]

  let to_string = function
    | Check_default -> "default"
    | Check_all -> "all"
    | Check_opt_only -> "opt"
    | No_check -> "none"

  let equal t1 t2 =
    match t1, t2 with
    | Check_default, Check_default -> true
    | Check_all, Check_all -> true
    | No_check, No_check -> true
    | Check_opt_only, Check_opt_only -> true
    | (Check_default | Check_all | Check_opt_only | No_check), _ -> false

  let of_string v =
    let f t = if String.equal (to_string t) v then Some t else None in
    List.find_map f all

  let doc =
    "\n\
    \    The argument specifies which annotations to check: \n\
    \      \"opt\" means attributes with \"opt\" payload and is intended for \
     debugging;\n\
    \      \"default\" means attributes without \"opt\" payload; \n\
    \      \"all\" covers both \"opt\" and \"default\" and is intended for \
     optimized builds."
end

module Assert = struct
  type t =
    | Assert_default
    | Assert_all
    | Assert_all_opt

  let all = [Assert_default; Assert_all; Assert_all_opt]

  let to_string = function
    | Assert_default -> "default"
    | Assert_all -> "all"
    | Assert_all_opt -> "all_opt"

  let equal t1 t2 =
    match t1, t2 with
    | Assert_default, Assert_default -> true
    | Assert_all, Assert_all -> true
    | Assert_all_opt, Assert_all_opt -> true
    | (Assert_default | Assert_all | Assert_all_opt), _ -> false

  let of_string v =
    let f t = if String.equal (to_string t) v then Some t else None in
    List.find_map f all

  let doc =
    "\n\
    \    The argument specifies which annotations to use: \n\
    \      \"all\" is equivalent to adding [@@@zero_alloc all]\n\
    \      \"all_opt\" is equivalent to adding [@@@zero_alloc all_opt]\n\
    \      \"default\" does not add any attributes."
end