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
|
% Handle string and string-like interpolations.
-module(elixir_interpolation).
-export([extract/6, unescape_string/1, unescape_string/2,
unescape_tokens/1, unescape_map/1]).
-include("elixir.hrl").
-include("elixir_tokenizer.hrl").
%% Extract string interpolations
extract(Line, Column, Scope, Interpol, String, Last) ->
extract(String, [], [], Line, Column, Scope, Interpol, Last).
%% Terminators
extract([], _Buffer, _Output, Line, Column, #elixir_tokenizer{cursor_completion=false}, _Interpol, Last) ->
{error, {string, Line, Column, io_lib:format("missing terminator: ~ts", [[Last]]), []}};
extract([], Buffer, Output, Line, Column, Scope, _Interpol, _Last) ->
finish_extraction([], Buffer, Output, Line, Column, Scope);
extract([Last | Rest], Buffer, Output, Line, Column, Scope, _Interpol, Last) ->
finish_extraction(Rest, Buffer, Output, Line, Column + 1, Scope);
%% Going through the string
extract([$\\, $\r, $\n | Rest], Buffer, Output, Line, _Column, Scope, Interpol, Last) ->
extract_nl(Rest, [$\n, $\r, $\\ | Buffer], Output, Line, Scope, Interpol, Last);
extract([$\\, $\n | Rest], Buffer, Output, Line, _Column, Scope, Interpol, Last) ->
extract_nl(Rest, [$\n, $\\ | Buffer], Output, Line, Scope, Interpol, Last);
extract([$\n | Rest], Buffer, Output, Line, _Column, Scope, Interpol, Last) ->
extract_nl(Rest, [$\n | Buffer], Output, Line, Scope, Interpol, Last);
extract([$\\, Last | Rest], Buffer, Output, Line, Column, Scope, Interpol, Last) ->
extract(Rest, [Last | Buffer], Output, Line, Column+2, Scope, Interpol, Last);
extract([$\\, Last, Last, Last | Rest], Buffer, Output, Line, Column, Scope, Interpol, [Last, Last, Last] = All) ->
extract(Rest, [Last, Last, Last | Buffer], Output, Line, Column+4, Scope, Interpol, All);
extract([$\\, $#, ${ | Rest], Buffer, Output, Line, Column, Scope, true, Last) ->
extract(Rest, [${, $#, $\\ | Buffer], Output, Line, Column+3, Scope, true, Last);
extract([$#, ${ | Rest], Buffer, Output, Line, Column, Scope, true, Last) ->
Output1 = build_string(Buffer, Output),
case elixir_tokenizer:tokenize(Rest, Line, Column + 2, Scope#elixir_tokenizer{terminators=[]}) of
{error, {EndLine, EndColumn, _, "}"}, [$} | NewRest], Warnings, Tokens} ->
NewScope = Scope#elixir_tokenizer{warnings=Warnings},
Output2 = build_interpol(Line, Column, EndLine, EndColumn, lists:reverse(Tokens), Output1),
extract(NewRest, [], Output2, EndLine, EndColumn + 1, NewScope, true, Last);
{error, Reason, _, _, _} ->
{error, Reason};
{ok, EndLine, EndColumn, Warnings, Tokens} when Scope#elixir_tokenizer.cursor_completion /= false ->
NewScope = Scope#elixir_tokenizer{warnings=Warnings, cursor_completion=noprune},
Output2 = build_interpol(Line, Column, EndLine, EndColumn, Tokens, Output1),
extract([], [], Output2, EndLine, EndColumn, NewScope, true, Last);
{ok, _, _, _, _} ->
{error, {string, Line, Column, "missing interpolation terminator: \"}\"", []}}
end;
extract([$\\ | Rest], Buffer, Output, Line, Column, Scope, Interpol, Last) ->
extract_char(Rest, [$\\ | Buffer], Output, Line, Column + 1, Scope, Interpol, Last);
%% Catch all clause
extract([Char1, Char2 | Rest], Buffer, Output, Line, Column, Scope, Interpol, Last)
when Char1 =< 255, Char2 =< 255 ->
extract([Char2 | Rest], [Char1 | Buffer], Output, Line, Column + 1, Scope, Interpol, Last);
extract(Rest, Buffer, Output, Line, Column, Scope, Interpol, Last) ->
extract_char(Rest, Buffer, Output, Line, Column, Scope, Interpol, Last).
extract_char(Rest, Buffer, Output, Line, Column, Scope, Interpol, Last) ->
case unicode_util:gc(Rest) of
[Char | _] when ?bidi(Char) ->
Token = io_lib:format("\\u~4.16.0B", [Char]),
Pre = "invalid bidirectional formatting character in string: ",
Pos = io_lib:format(". If you want to use such character, use it in its escaped ~ts form instead", [Token]),
{error, {Line, Column, {Pre, Pos}, Token}};
[Char | NewRest] ->
extract(NewRest, [Char | Buffer], Output, Line, Column + 1, Scope, Interpol, Last);
[] ->
extract([], Buffer, Output, Line, Column, Scope, Interpol, Last)
end.
%% Handle newlines. Heredocs require special attention
extract_nl(Rest, Buffer, Output, Line, Scope, Interpol, [H,H,H] = Last) ->
case strip_horizontal_space(Rest, Buffer, 1) of
{[H,H,H|NewRest], _NewBuffer, Column} ->
finish_extraction(NewRest, Buffer, Output, Line + 1, Column + 3, Scope);
{NewRest, NewBuffer, Column} ->
extract(NewRest, NewBuffer, Output, Line + 1, Column, Scope, Interpol, Last)
end;
extract_nl(Rest, Buffer, Output, Line, Scope, Interpol, Last) ->
extract(Rest, Buffer, Output, Line + 1, 1, Scope, Interpol, Last).
strip_horizontal_space([H | T], Buffer, Counter) when H =:= $\s; H =:= $\t ->
strip_horizontal_space(T, [H | Buffer], Counter + 1);
strip_horizontal_space(T, Buffer, Counter) ->
{T, Buffer, Counter}.
%% Unescape a series of tokens as returned by extract.
unescape_tokens(Tokens) ->
try [unescape_token(Token, fun unescape_map/1) || Token <- Tokens] of
Unescaped -> {ok, Unescaped}
catch
{error, _Reason, _Token} = Error -> Error
end.
unescape_token(Token, Map) when is_list(Token) ->
unescape_chars(elixir_utils:characters_to_binary(Token), Map);
unescape_token(Token, Map) when is_binary(Token) ->
unescape_chars(Token, Map);
unescape_token(Other, _Map) ->
Other.
% Unescape string. This is called by Elixir. Wrapped by convenience.
unescape_string(String) ->
unescape_string(String, fun unescape_map/1).
unescape_string(String, Map) ->
try
unescape_chars(String, Map)
catch
{error, Reason, _} ->
Message = elixir_utils:characters_to_binary(Reason),
error('Elixir.ArgumentError':exception([{message, Message}]))
end.
% Unescape chars. For instance, "\" "n" (two chars) needs to be converted to "\n" (one char).
unescape_chars(String, Map) ->
unescape_chars(String, Map, <<>>).
unescape_chars(<<$\\, $x, Rest/binary>>, Map, Acc) ->
case Map(hex) of
true -> unescape_hex(Rest, Map, Acc);
false -> unescape_chars(Rest, Map, <<Acc/binary, $\\, $x>>)
end;
unescape_chars(<<$\\, $u, Rest/binary>>, Map, Acc) ->
case Map(unicode) of
true -> unescape_unicode(Rest, Map, Acc);
false -> unescape_chars(Rest, Map, <<Acc/binary, $\\, $u>>)
end;
unescape_chars(<<$\\, $\n, Rest/binary>>, Map, Acc) ->
case Map(newline) of
true -> unescape_chars(Rest, Map, Acc);
false -> unescape_chars(Rest, Map, <<Acc/binary, $\\, $\n>>)
end;
unescape_chars(<<$\\, $\r, $\n, Rest/binary>>, Map, Acc) ->
case Map(newline) of
true -> unescape_chars(Rest, Map, Acc);
false -> unescape_chars(Rest, Map, <<Acc/binary, $\\, $\r, $\n>>)
end;
unescape_chars(<<$\\, Escaped, Rest/binary>>, Map, Acc) ->
case Map(Escaped) of
false -> unescape_chars(Rest, Map, <<Acc/binary, $\\, Escaped>>);
Other -> unescape_chars(Rest, Map, <<Acc/binary, Other>>)
end;
unescape_chars(<<Char, Rest/binary>>, Map, Acc) ->
unescape_chars(Rest, Map, <<Acc/binary, Char>>);
unescape_chars(<<>>, _Map, Acc) -> Acc.
% Unescape Helpers
unescape_hex(<<A, B, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B) ->
Bytes = list_to_integer([A, B], 16),
unescape_chars(Rest, Map, <<Acc/binary, Bytes>>);
%% TODO: Remove deprecated sequences on v2.0
unescape_hex(<<A, Rest/binary>>, Map, Acc) when ?is_hex(A) ->
io:format(standard_error, "warning: \\xH inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A], Acc, 16);
unescape_hex(<<${, A, $}, Rest/binary>>, Map, Acc) when ?is_hex(A) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A], Acc, 16);
unescape_hex(<<${, A, B, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A, B], Acc, 16);
unescape_hex(<<${, A, B, C, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A, B, C], Acc, 16);
unescape_hex(<<${, A, B, C, D, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A, B, C, D], Acc, 16);
unescape_hex(<<${, A, B, C, D, E, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D), ?is_hex(E) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A, B, C, D, E], Acc, 16);
unescape_hex(<<${, A, B, C, D, E, F, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D), ?is_hex(E), ?is_hex(F) ->
io:format(standard_error, "warning: \\x{H*} inside strings/sigils/chars is deprecated, please use \\xHH (byte) or \\uHHHH (code point) instead~n", []),
append_codepoint(Rest, Map, [A, B, C, D, E, F], Acc, 16);
unescape_hex(<<_/binary>>, _Map, _Acc) ->
throw({error, "invalid hex escape character, expected \\xHH where H is a hexadecimal digit", "\\x"}).
%% Finish deprecated sequences
unescape_unicode(<<A, B, C, D, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D) ->
append_codepoint(Rest, Map, [A, B, C, D], Acc, 16);
unescape_unicode(<<${, A, $}, Rest/binary>>, Map, Acc) when ?is_hex(A) ->
append_codepoint(Rest, Map, [A], Acc, 16);
unescape_unicode(<<${, A, B, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B) ->
append_codepoint(Rest, Map, [A, B], Acc, 16);
unescape_unicode(<<${, A, B, C, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C) ->
append_codepoint(Rest, Map, [A, B, C], Acc, 16);
unescape_unicode(<<${, A, B, C, D, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D) ->
append_codepoint(Rest, Map, [A, B, C, D], Acc, 16);
unescape_unicode(<<${, A, B, C, D, E, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D), ?is_hex(E) ->
append_codepoint(Rest, Map, [A, B, C, D, E], Acc, 16);
unescape_unicode(<<${, A, B, C, D, E, F, $}, Rest/binary>>, Map, Acc) when ?is_hex(A), ?is_hex(B), ?is_hex(C), ?is_hex(D), ?is_hex(E), ?is_hex(F) ->
append_codepoint(Rest, Map, [A, B, C, D, E, F], Acc, 16);
unescape_unicode(<<_/binary>>, _Map, _Acc) ->
throw({error, "invalid Unicode escape character, expected \\uHHHH or \\u{H*} where H is a hexadecimal digit", "\\u"}).
append_codepoint(Rest, Map, List, Acc, Base) ->
Codepoint = list_to_integer(List, Base),
try <<Acc/binary, Codepoint/utf8>> of
Binary -> unescape_chars(Rest, Map, Binary)
catch
error:badarg ->
throw({error, "invalid or reserved Unicode code point \\u{" ++ List ++ "}", "\\u"})
end.
unescape_map(newline) -> true;
unescape_map(unicode) -> true;
unescape_map(hex) -> true;
unescape_map($0) -> 0;
unescape_map($a) -> 7;
unescape_map($b) -> $\b;
unescape_map($d) -> $\d;
unescape_map($e) -> $\e;
unescape_map($f) -> $\f;
unescape_map($n) -> $\n;
unescape_map($r) -> $\r;
unescape_map($s) -> $\s;
unescape_map($t) -> $\t;
unescape_map($v) -> $\v;
unescape_map(E) -> E.
% Extract Helpers
finish_extraction(Remaining, Buffer, Output, Line, Column, Scope) ->
Final = case build_string(Buffer, Output) of
[] -> [[]];
F -> F
end,
{Line, Column, lists:reverse(Final), Remaining, Scope}.
build_string([], Output) -> Output;
build_string(Buffer, Output) -> [lists:reverse(Buffer) | Output].
build_interpol(Line, Column, EndLine, EndColumn, Buffer, Output) ->
[{{Line, Column, nil}, {EndLine, EndColumn, nil}, Buffer} | Output].
|