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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
(**************************************************************************)
(* *)
(* OCaml *)
(* *)
(* Alain Frisch, LexiFi *)
(* *)
(* Copyright 2012 Institut National de Recherche en Informatique et *)
(* en Automatique. *)
(* *)
(* All rights reserved. This file is distributed under the terms of *)
(* the GNU Lesser General Public License version 2.1, with the *)
(* special exception on linking described in the file LICENSE. *)
(* *)
(**************************************************************************)
open Asttypes
open Parsetree
let string_of_cst = function
| Pconst_string(s, _) -> Some s
| _ -> None
let string_of_payload = function
| PStr[{pstr_desc=Pstr_eval({pexp_desc=Pexp_constant c},_)}] ->
string_of_cst c
| _ -> None
let string_of_opt_payload p =
match string_of_payload p with
| Some s -> s
| None -> ""
let rec error_of_extension ext =
match ext with
| ({txt = ("ocaml.error"|"error") as txt; loc}, p) ->
let rec sub_from inner =
match inner with
| {pstr_desc=Pstr_extension (ext, _)} :: rest ->
error_of_extension ext :: sub_from rest
| _ :: rest ->
(Location.errorf ~loc
"Invalid syntax for sub-error of extension '%s'." txt) ::
sub_from rest
| [] -> []
in
begin match p with
| PStr [] -> raise Location.Already_displayed_error
| PStr({pstr_desc=Pstr_eval
({pexp_desc=Pexp_constant(Pconst_string(msg,_))}, _)}::
{pstr_desc=Pstr_eval
({pexp_desc=Pexp_constant(Pconst_string(if_highlight,_))}, _)}::
inner) ->
Location.error ~loc ~if_highlight ~sub:(sub_from inner) msg
| PStr({pstr_desc=Pstr_eval
({pexp_desc=Pexp_constant(Pconst_string(msg,_))}, _)}::inner) ->
Location.error ~loc ~sub:(sub_from inner) msg
| _ -> Location.errorf ~loc "Invalid syntax for extension '%s'." txt
end
| ({txt; loc}, _) ->
Location.errorf ~loc "Uninterpreted extension '%s'." txt
let cat s1 s2 =
if s2 = "" then s1 else s1 ^ "\n" ^ s2
let partition_deprecated_attrs =
List.partition
(function
| ({txt = "ocaml.deprecated"|"deprecated"; _}, _) -> true
| _ -> false
)
let rec deprecated_of_attrs = function
| [] -> None
| ({txt = "ocaml.deprecated"|"deprecated"; _}, p) :: _ ->
Some (string_of_opt_payload p)
| _ :: tl -> deprecated_of_attrs tl
let check_deprecated loc attrs s =
match deprecated_of_attrs attrs with
| None -> ()
| Some txt -> Location.deprecated loc (cat s txt)
let check_deprecated_inclusion ~def ~use loc attrs1 attrs2 s =
match deprecated_of_attrs attrs1, deprecated_of_attrs attrs2 with
| None, _ | Some _, Some _ -> ()
| Some txt, None -> Location.deprecated ~def ~use loc (cat s txt)
let rec deprecated_mutable_of_attrs = function
| [] -> None
| ({txt = "ocaml.deprecated_mutable"|"deprecated_mutable"; _}, p) :: _ ->
Some (string_of_opt_payload p)
| _ :: tl -> deprecated_mutable_of_attrs tl
let check_deprecated_mutable loc attrs s =
match deprecated_mutable_of_attrs attrs with
| None -> ()
| Some txt ->
Location.deprecated loc (Printf.sprintf "mutating field %s" (cat s txt))
let check_deprecated_mutable_inclusion ~def ~use loc attrs1 attrs2 s =
match deprecated_mutable_of_attrs attrs1,
deprecated_mutable_of_attrs attrs2
with
| None, _ | Some _, Some _ -> ()
| Some txt, None ->
Location.deprecated ~def ~use loc
(Printf.sprintf "mutating field %s" (cat s txt))
let rec deprecated_of_sig = function
| {psig_desc = Psig_attribute a} :: tl ->
begin match deprecated_of_attrs [a] with
| None -> deprecated_of_sig tl
| Some _ as r -> r
end
| _ -> None
let rec deprecated_of_str = function
| {pstr_desc = Pstr_attribute a} :: tl ->
begin match deprecated_of_attrs [a] with
| None -> deprecated_of_str tl
| Some _ as r -> r
end
| _ -> None
let emit_external_warnings =
(* Note: this is run as a preliminary pass when type-checking an
interface or implementation. This allows to cover all kinds of
attributes, but the drawback is that it doesn't take local
configuration of warnings (with '@@warning'/'@@warnerror'
attributes) into account. We should rather check for
'ppwarning' attributes during the actual type-checking, making
sure to cover all contexts (easier and more ugly alternative:
duplicate here the logic which control warnings locally). *)
let open Ast_iterator in
{
default_iterator with
attribute = (fun _ a ->
match a with
| {txt="ocaml.ppwarning"|"ppwarning"},
PStr[{pstr_desc=Pstr_eval({pexp_desc=Pexp_constant
(Pconst_string (s, _))},_);
pstr_loc}] ->
Location.prerr_warning pstr_loc (Warnings.Preprocessor s)
| _ -> ()
)
}
let warning_scope = ref []
let warning_enter_scope () =
warning_scope := (Warnings.backup ()) :: !warning_scope
let warning_leave_scope () =
match !warning_scope with
| [] -> assert false
| hd :: tl ->
Warnings.restore hd;
warning_scope := tl
let warning_attribute attrs =
let process loc txt errflag payload =
match string_of_payload payload with
| Some s ->
begin try Warnings.parse_options errflag s
with Arg.Bad _ ->
Location.prerr_warning loc
(Warnings.Attribute_payload
(txt, "Ill-formed list of warnings"))
end
| None ->
Location.prerr_warning loc
(Warnings.Attribute_payload
(txt, "A single string literal is expected"))
in
List.iter
(function
| ({txt = ("ocaml.warning"|"warning") as txt; loc}, payload) ->
process loc txt false payload
| ({txt = ("ocaml.warnerror"|"warnerror") as txt; loc}, payload) ->
process loc txt true payload
| _ ->
()
)
attrs
let with_warning_attribute attrs f =
try
warning_enter_scope ();
warning_attribute attrs;
let ret = f () in
warning_leave_scope ();
ret
with exn ->
warning_leave_scope ();
raise exn
let warn_on_literal_pattern =
List.exists
(function
| ({txt="ocaml.warn_on_literal_pattern"|"warn_on_literal_pattern"; _}, _)
-> true
| _ -> false
)
let explicit_arity =
List.exists
(function
| ({txt="ocaml.explicit_arity"|"explicit_arity"; _}, _) -> true
| _ -> false
)
let immediate =
List.exists
(function
| ({txt="ocaml.immediate"|"immediate"; _}, _) -> true
| _ -> false
)
(* The "ocaml.boxed (default)" and "ocaml.unboxed (default)"
attributes cannot be input by the user, they are added by the
compiler when applying the default setting. This is done to record
in the .cmi the default used by the compiler when compiling the
source file because the default can change between compiler
invocations. *)
let check l (x, _) = List.mem x.txt l
let has_unboxed attr =
List.exists (check ["ocaml.unboxed"; "unboxed"])
attr
let has_boxed attr =
List.exists (check ["ocaml.boxed"; "boxed"]) attr
|
