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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
|
%%
%% %CopyrightBegin%
%%
%% Copyright Ericsson AB 1996-2017. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%
%% %CopyrightEnd%
%%
-module(erl_anno).
-export([new/1, is_anno/1]).
-export([column/1, end_location/1, file/1, generated/1,
line/1, location/1, record/1, text/1]).
-export([set_file/2, set_generated/2, set_line/2, set_location/2,
set_record/2, set_text/2]).
%% To be used when necessary to avoid Dialyzer warnings.
-export([to_term/1, from_term/1]).
-export_type([anno/0, line/0, column/0, location/0, text/0]).
-export_type([anno_term/0]).
-define(LN(L), is_integer(L), L >= 0).
-define(COL(C), (is_integer(C) andalso C >= 1)).
%% Location.
-define(LCOLUMN(C), ?COL(C)).
-define(LLINE(L), ?LN(L)).
%% Debug: define DEBUG to make sure that annotations are handled as an
%% opaque type. Note that all abstract code need to be compiled with
%% DEBUG=true. See also ./erl_pp.erl and ./erl_parse.yrl.
%-define(DEBUG, true).
-type annotation() :: {'file', filename()}
| {'generated', generated()}
| {'location', location()}
| {'record', record()}
| {'text', string()}.
-ifdef(DEBUG).
-opaque anno() :: [annotation(), ...].
-else.
-opaque anno() :: location() | [annotation(), ...].
-endif.
-type anno_term() :: term().
-type column() :: pos_integer().
-type generated() :: boolean().
-type filename() :: file:filename_all().
-type line() :: non_neg_integer().
-type location() :: line() | {line(), column()}.
-type record() :: boolean().
-type text() :: string().
-ifdef(DEBUG).
%% Anything 'false' accepted by the compiler.
-define(ALINE(A), is_reference(A)).
-define(ACOLUMN(A), is_reference(A)).
-else.
-define(ALINE(L), ?LN(L)).
-define(ACOLUMN(C), ?COL(C)).
-endif.
-spec to_term(Anno) -> anno_term() when
Anno :: anno().
-ifdef(DEBUG).
to_term(Anno) ->
simplify(Anno).
-else.
to_term(Anno) ->
Anno.
-endif.
-spec from_term(Term) -> Anno when
Term :: anno_term(),
Anno :: anno().
-ifdef(DEBUG).
from_term(Term) when is_list(Term) ->
Term;
from_term(Line) when is_integer(Line), Line < 0 -> % Before OTP 19
set_generated(true, new(-Line));
from_term(Term) ->
[{location, Term}].
-else.
from_term(Line) when is_integer(Line), Line < 0 -> % Before OTP 19
set_generated(true, new(-Line));
from_term(Term) ->
Term.
-endif.
-spec new(Location) -> anno() when
Location :: location().
new(Line) when ?LLINE(Line) ->
new_location(Line);
new({Line, Column}=Loc) when ?LLINE(Line), ?LCOLUMN(Column) ->
new_location(Loc);
new(Term) ->
erlang:error(badarg, [Term]).
-ifdef(DEBUG).
new_location(Location) ->
[{location, Location}].
-else.
new_location(Location) ->
Location.
-endif.
-spec is_anno(Term) -> boolean() when
Term :: any().
is_anno(Line) when ?ALINE(Line) ->
true;
is_anno({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
true;
is_anno(Anno) ->
(Anno =/= [] andalso
is_anno1(Anno) andalso
lists:keymember(location, 1, Anno)).
is_anno1([{Item, Value}|Anno]) ->
is_anno2(Item, Value) andalso is_anno1(Anno);
is_anno1(A) ->
A =:= [].
is_anno2(location, Line) when ?LN(Line) ->
true;
is_anno2(location, {Line, Column}) when ?LN(Line), ?COL(Column) ->
true;
is_anno2(generated, true) ->
true;
is_anno2(file, Filename) ->
is_filename(Filename);
is_anno2(record, true) ->
true;
is_anno2(text, Text) ->
is_string(Text);
is_anno2(_, _) ->
false.
is_filename(T) ->
is_list(T) orelse is_binary(T).
is_string(T) ->
is_list(T).
-spec column(Anno) -> column() | 'undefined' when
Anno :: anno().
column({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
Column;
column(Line) when ?ALINE(Line) ->
undefined;
column(Anno) ->
case location(Anno) of
{_Line, Column} ->
Column;
_Line ->
undefined
end.
-spec end_location(Anno) -> location() | 'undefined' when
Anno :: anno().
end_location(Anno) ->
case text(Anno) of
undefined ->
undefined;
Text ->
case location(Anno) of
{Line, Column} ->
end_location(Text, Line, Column);
Line ->
end_location(Text, Line)
end
end.
-spec file(Anno) -> filename() | 'undefined' when
Anno :: anno().
file(Line) when ?ALINE(Line) ->
undefined;
file({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
undefined;
file(Anno) ->
anno_info(Anno, file).
-spec generated(Anno) -> generated() when
Anno :: anno().
generated(Line) when ?ALINE(Line) ->
false;
generated({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
false;
generated(Anno) ->
anno_info(Anno, generated, false).
-spec line(Anno) -> line() when
Anno :: anno().
line(Anno) ->
case location(Anno) of
{Line, _Column} ->
Line;
Line ->
Line
end.
-spec location(Anno) -> location() when
Anno :: anno().
location(Line) when ?ALINE(Line) ->
Line;
location({Line, Column}=Location) when ?ALINE(Line), ?ACOLUMN(Column) ->
Location;
location(Anno) ->
anno_info(Anno, location).
-spec record(Anno) -> record() when
Anno :: anno().
record(Line) when ?ALINE(Line) ->
false;
record({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
false;
record(Anno) ->
anno_info(Anno, record, false).
-spec text(Anno) -> text() | 'undefined' when
Anno :: anno().
text(Line) when ?ALINE(Line) ->
undefined;
text({Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column) ->
undefined;
text(Anno) ->
anno_info(Anno, text).
-spec set_file(File, Anno) -> Anno when
File :: filename(),
Anno :: anno().
set_file(File, Anno) ->
set(file, File, Anno).
-spec set_generated(Generated, Anno) -> Anno when
Generated :: generated(),
Anno :: anno().
set_generated(Generated, Anno) ->
set(generated, Generated, Anno).
-spec set_line(Line, Anno) -> Anno when
Line :: line(),
Anno :: anno().
set_line(Line, Anno) ->
case location(Anno) of
{_Line, Column} ->
set_location({Line, Column}, Anno);
_Line ->
set_location(Line, Anno)
end.
-spec set_location(Location, Anno) -> Anno when
Location :: location(),
Anno :: anno().
set_location(Line, L) when ?ALINE(L), ?LLINE(Line) ->
new_location(Line);
set_location(Line, {L, Column}) when ?ALINE(L), ?ACOLUMN(Column),
?LLINE(Line) ->
new_location(Line);
set_location({L, C}=Loc, Line) when ?ALINE(Line), ?LLINE(L), ?LCOLUMN(C) ->
new_location(Loc);
set_location({L, C}=Loc, {Line, Column}) when ?ALINE(Line), ?ACOLUMN(Column),
?LLINE(L), ?LCOLUMN(C) ->
new_location(Loc);
set_location(Location, Anno) ->
set(location, Location, Anno).
-spec set_record(Record, Anno) -> Anno when
Record :: record(),
Anno :: anno().
set_record(Record, Anno) ->
set(record, Record, Anno).
-spec set_text(Text, Anno) -> Anno when
Text :: text(),
Anno :: anno().
set_text(Text, Anno) ->
set(text, Text, Anno).
set(Item, Value, Anno) ->
case {is_settable(Item, Value), Anno} of
{true, Line} when ?ALINE(Line) ->
set_anno(Item, Value, [{location, Line}]);
{true, {L, C}=Location} when ?ALINE(L), ?ACOLUMN(C) ->
set_anno(Item, Value, [{location, Location}]);
{true, A} when is_list(A), A =/= [] ->
set_anno(Item, Value, Anno);
_ ->
erlang:error(badarg, [Item, Value, Anno])
end.
set_anno(Item, Value, Anno) ->
case default(Item, Value) of
true ->
reset(Anno, Item);
false ->
R = case anno_info(Anno, Item) of
undefined ->
[{Item, Value}|Anno];
_ ->
lists:keyreplace(Item, 1, Anno, {Item, Value})
end,
reset_simplify(R)
end.
reset(Anno, Item) ->
A = lists:keydelete(Item, 1, Anno),
reset_simplify(A).
-ifdef(DEBUG).
reset_simplify(A) ->
A.
-else.
reset_simplify(A) ->
simplify(A).
-endif.
simplify([{location, Location}]) ->
Location;
simplify(Anno) ->
Anno.
anno_info(Anno, Item, Default) ->
try lists:keyfind(Item, 1, Anno) of
false ->
Default;
{Item, Value} ->
Value
catch
_:_ ->
erlang:error(badarg, [Anno])
end.
anno_info(Anno, Item) ->
try lists:keyfind(Item, 1, Anno) of
{Item, Value} ->
Value;
false ->
undefined
catch
_:_ ->
erlang:error(badarg, [Anno])
end.
end_location("", Line, Column) ->
{Line, Column};
end_location([$\n|String], Line, _Column) ->
end_location(String, Line+1, 1);
end_location([_|String], Line, Column) ->
end_location(String, Line, Column+1).
end_location("", Line) ->
Line;
end_location([$\n|String], Line) ->
end_location(String, Line+1);
end_location([_|String], Line) ->
end_location(String, Line).
is_settable(file, File) ->
is_filename(File);
is_settable(generated, Boolean) when Boolean; not Boolean ->
true;
is_settable(location, Line) when ?LLINE(Line) ->
true;
is_settable(location, {Line, Column}) when ?LLINE(Line), ?LCOLUMN(Column) ->
true;
is_settable(record, Boolean) when Boolean; not Boolean ->
true;
is_settable(text, Text) ->
is_string(Text);
is_settable(_, _) ->
false.
default(generated, false) -> true;
default(record, false) -> true;
default(_, _) -> false.
|
