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
|
%% Copyright (c) 2017-2018, Loïc Hoguin <[email protected]>
%%
%% Permission to use, copy, modify, and/or distribute this software for any
%% purpose with or without fee is hereby granted, provided that the above
%% copyright notice and this permission notice appear in all copies.
%%
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
%% This pass walks over the tree and parses inline elements.
-module(asciideck_inline_pass).
-export([run/1]).
-import(asciideck_block_parser, [trim/1, while/2]).
-type inline_ast() :: list(). %% @todo
-export_type([inline_ast/0]).
run([]) ->
[];
run([Data|Tail]) when is_binary(Data) ->
[inline(Data)|run(Tail)];
%% We do not do any inline formatting for verbatim blocks,
%% for example listing blocks.
%%
%% @todo subs is a list of values.
run([Item={_, #{<<"subs">> := <<"verbatim">>}, _, _}|Tail]) ->
[Item|run(Tail)];
%% Labeled lists' labels can also have inline formatting.
run([{Type, Attrs=#{label := Label}, Items, Ann}|Tail]) when is_list(Items) ->
[{Type, Attrs#{label => inline(Label)}, run(Items), Ann}|run(Tail)];
run([{Type, Attrs, Items, Ann}|Tail]) when is_list(Items) ->
[{Type, Attrs, run(Items), Ann}|run(Tail)];
run([{Type, Attrs, Data, Ann}|Tail]) ->
[{Type, Attrs, inline(Data), Ann}|run(Tail)].
%% We reduce inline content with a single text element
%% with no formatting to a simple binary.
inline(<<>>) ->
<<>>;
inline(Data) ->
case inline(Data, <<>>, []) of
[] -> <<>>;
[Text] when is_binary(Text) -> Text;
AST -> AST
end.
-spec inline(binary(), binary(), inline_ast()) -> inline_ast().
inline(<<>>, <<>>, Acc) ->
lists:reverse(Acc);
inline(<<>>, BinAcc, Acc) ->
lists:reverse([BinAcc|Acc]);
inline(Data, BinAcc, Acc) ->
oneof(Data, BinAcc, Acc, [
%% Links.
fun xref/2,
fun link/2,
fun http_link/2,
fun https_link/2,
fun mailto_link/2,
%% Quoted text.
fun emphasized_single_quote/2,
fun emphasized_underline/2,
fun strong/2,
%% Passthrough macros.
fun inline_literal_passthrough/2,
%% Line breaks.
fun line_break/2
]).
%% The inline pass replaces \r\n and \n with a simple space
%% when it occurs within normal text.
oneof(<<$\r, $\n, Rest/bits>>, BinAcc, Acc, []) ->
inline(Rest, <<BinAcc/binary, $\s>>, Acc);
oneof(<<$\n, Rest/bits>>, BinAcc, Acc, []) ->
inline(Rest, <<BinAcc/binary, $\s>>, Acc);
oneof(<<C, Rest/bits>>, BinAcc, Acc, []) ->
inline(Rest, <<BinAcc/binary, C>>, Acc);
oneof(Data, BinAcc, Acc, [Parse|Tail]) ->
Prev = case BinAcc of
<<>> -> undefined;
_ -> binary:last(BinAcc)
end,
try Parse(Data, Prev) of
{ok, Inline, Rest} when BinAcc =:= <<>> ->
inline(Rest, BinAcc, [Inline|Acc]);
{ok, Inline, Rest} ->
inline(Rest, <<>>, [Inline, BinAcc|Acc]);
{skip, Text, Rest} ->
oneof(Rest, <<BinAcc/binary, Text/binary>>, Acc, Tail)
catch _:_ ->
oneof(Data, BinAcc, Acc, Tail)
end.
-ifdef(TEST).
text_test() ->
<<>> = inline(<<>>),
<<"Hello, Robert">> = inline(<<"Hello, Robert">>),
ok.
-endif.
-define(IS_BOUNDARY(C), C =:= undefined; C =:= $\s; C =:= $\t; C =:= $\r; C =:= $\n; C =:= $().
%% Asciidoc User Guide 21.2.1
%%
%% We currently do not implement the <<...>> form.
xref(<<"xref:", IDAndCaption/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
%% ID must not contain whitespace characters.
{ID, <<"[", Caption0/bits>>} = while(fun(C) ->
(C =/= $[) andalso (C =/= $\s) andalso (C =/= $\t)
end, IDAndCaption),
%% It is followed by a caption.
{Caption1, <<"]", Rest/bits>>} = while(fun(C) ->
C =/= $]
end, Caption0),
Caption = trim(Caption1),
{ok, {xref, #{
id => ID
}, Caption, inline}, Rest}.
-ifdef(TEST).
xref_test() ->
[{xref, #{
id := <<"tiger_image">>
}, <<"face of a tiger">>, _}] = inline(<<"xref:tiger_image[face of a tiger]">>),
ok.
-endif.
%% Asciidoc User Guide 21.1.3
link(<<"link:", TargetAndCaption/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
%% Target must not contain whitespace characters.
{Target, <<"[", Caption0/bits>>} = while(fun(C) ->
(C =/= $[) andalso (C =/= $\s) andalso (C =/= $\t)
andalso (C =/= $\r) andalso (C =/= $\n)
end, TargetAndCaption),
%% It is followed by a caption.
{Caption1, <<"]", Rest/bits>>} = while(fun(C) ->
C =/= $]
end, Caption0),
Caption = trim(Caption1),
{ok, {link, #{
target => Target
}, Caption, inline}, Rest}.
-ifdef(TEST).
link_test() ->
[{link, #{
target := <<"downloads/foo.zip">>
}, <<"download foo.zip">>, _}] = inline(<<"link:downloads/foo.zip[download foo.zip]">>),
[{link, #{
target := <<"chapter1.asciidoc#fragment">>
}, <<"Chapter 1.">>, _}] = inline(<<"link:chapter1.asciidoc#fragment[Chapter 1.]">>),
[
{link, #{target := <<"first.zip">>}, <<"first">>, _},
<<", ">>,
{link, #{target := <<"second.zip">>}, <<"second">>, _}
] = inline(<<"link:first.zip[first],\nlink:second.zip[second]">>),
ok.
-endif.
%% Asciidoc User Guide 21.1.1
http_link(<<"http:", Rest/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
direct_link(Rest, <<"http:">>).
direct_link(Data, Prefix) ->
%% Target must not contain whitespace characters.
{Target0, Rest0} = while(fun(C) ->
(C =/= $[) andalso (C =/= $\s) andalso (C =/= $\t)
andalso (C =/= $\r) andalso (C =/= $\n)
andalso (C =/= $,)
end, Data),
%% The link must be more than just the prefix.
false = Target0 =:= <<>>,
Target = <<Prefix/binary, Target0/binary>>,
%% It is optionally followed by a caption. Otherwise
%% the link itself is the caption.
case Rest0 of
<<"[", Caption0/bits>> ->
{Caption1, <<"]", Rest/bits>>} = while(fun(C) ->
C =/= $]
end, Caption0),
Caption = trim(Caption1),
case Caption of
<<>> ->
{ok, {link, #{
target => Target
}, Target, inline}, Rest};
_ ->
{ok, {link, #{
target => Target
}, Caption, inline}, Rest}
end;
_ ->
{ok, {link, #{
target => Target
}, Target, inline}, Rest0}
end.
-ifdef(TEST).
http_link_test() ->
<<"Incomplete http: link">> = inline(<<"Incomplete http: link">>),
[
{link, #{
target := <<"http://example.org:8080">>
}, <<"http://example.org:8080">>, _},
<<", continued">>
] = inline(<<"http://example.org:8080, continued">>),
[
<<"If you have ">>,
{link, #{
target := <<"http://example.org/hello#fragment">>
}, <<"http://example.org/hello#fragment">>, _},
<<" then:">>
] = inline(<<"If you have http://example.org/hello#fragment then:">>),
[
<<"If you have ">>,
{link, #{
target := <<"http://example.org/hello#fragment">>
}, <<"http://example.org/hello#fragment">>, _},
<<" then:">>
] = inline(<<"If you have http://example.org/hello#fragment\nthen:">>),
[
<<"Oh, ">>,
{link, #{
target := <<"http://example.org/hello#fragment">>
}, <<"hello there">>, _},
<<", young lad.">>
] = inline(<<"Oh, http://example.org/hello#fragment[hello there], young lad.">>),
ok.
-endif.
%% Asciidoc User Guide 21.1.1
https_link(<<"https:", Rest/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
direct_link(Rest, <<"https:">>).
-ifdef(TEST).
https_link_test() ->
<<"Incomplete https: link">> = inline(<<"Incomplete https: link">>),
[
{link, #{
target := <<"https://example.org:8080">>
}, <<"https://example.org:8080">>, _},
<<", continued">>
] = inline(<<"https://example.org:8080, continued">>),
[
<<"If you have ">>,
{link, #{
target := <<"https://example.org/hello#fragment">>
}, <<"https://example.org/hello#fragment">>, _},
<<" then:">>
] = inline(<<"If you have https://example.org/hello#fragment then:">>),
[
<<"If you have ">>,
{link, #{
target := <<"https://example.org/hello#fragment">>
}, <<"https://example.org/hello#fragment">>, _},
<<" then:">>
] = inline(<<"If you have https://example.org/hello#fragment\nthen:">>),
[
<<"Oh, ">>,
{link, #{
target := <<"https://example.org/hello#fragment">>
}, <<"hello there">>, _},
<<", young lad.">>
] = inline(<<"Oh, https://example.org/hello#fragment[hello there], young lad.">>),
ok.
-endif.
%% Asciidoc User Guide 21.1.1
mailto_link(<<"mailto:", Rest0/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
{ok, {link, Attrs, Caption0, Ann}, Rest} = direct_link(Rest0, <<"mailto:">>),
Caption = case Caption0 of
<<"mailto:", Caption1/bits>> -> Caption1;
_ -> Caption0
end,
{ok, {link, Attrs, Caption, Ann}, Rest}.
-ifdef(TEST).
mailto_link_test() ->
[
{link, #{
target := <<"mailto:[email protected]">>
}, <<"email Joe Bloggs">>, _}
] = inline(<<"mailto:[email protected][email Joe Bloggs]">>),
[
{link, #{
target := <<"mailto:[email protected]">>
}, <<"[email protected]">>, _}
] = inline(<<"mailto:[email protected][]">>),
ok.
-endif.
%% Asciidoc User Guide 10.1
%% @todo <<"\\**"
%% @todo <<"\\*"
%% @todo <<"**"
emphasized_single_quote(Data, Prev) ->
quoted_text(Data, Prev, emphasized, $', $').
emphasized_underline(Data, Prev) ->
quoted_text(Data, Prev, emphasized, $_, $_).
strong(Data, Prev) ->
quoted_text(Data, Prev, strong, $*, $*).
quoted_text(<<Left, Rest0/bits>>, Prev, Type, Left, Right) when ?IS_BOUNDARY(Prev) ->
{Content, <<Right, Rest/bits>>} = while(fun(C) -> C =/= Right end, Rest0),
{ok, {Type, #{
left => Left,
right => Right
}, inline(Content), inline}, Rest}.
-ifdef(TEST).
emphasized_test() ->
[
<<"Word phrases ">>,
{emphasized, #{left := $', right := $'},
<<"enclosed in single quote characters">>, _},
<<" (acute accents) or ">>,
{emphasized, #{left := $_, right := $_},
<<"underline characters">>, _},
<<" are emphasized.">>
] = inline(<<
"Word phrases 'enclosed in single quote characters' (acute accents) "
"or _underline characters_ are emphasized."
>>),
ok.
strong_test() ->
[
<<"Word phrases ">>,
{strong, #{left := $*, right := $*},
<<"enclosed in asterisk characters">>, _},
<<" are rendered in a strong font (usually bold).">>
] = inline(<<
"Word phrases *enclosed in asterisk characters* "
"are rendered in a strong font (usually bold)."
>>),
ok.
-endif.
%% Asciidoc User Guide 21.4
inline_literal_passthrough(<<"`", Rest0/bits>>, Prev) when ?IS_BOUNDARY(Prev) ->
{Content, <<"`", Rest/bits>>} = while(fun(C) -> C =/= $` end, Rest0),
{ok, {inline_literal_passthrough, #{}, Content, inline}, Rest}.
-ifdef(TEST).
inline_literal_passthrough_test() ->
[
<<"Word phrases ">>,
{inline_literal_passthrough, #{}, <<"enclosed in backtick characters">>, _},
<<" (grave accents)...">>
] = inline(<<"Word phrases `enclosed in backtick characters` (grave accents)...">>),
ok.
-endif.
-define(IS_WS(C), (C =:= $\s) or (C =:= $\t)).
%% Asciidoc User Guide 10.3
line_break(<<C, "+", Rest0/bits>>, _) when ?IS_WS(C) ->
%% @todo Rest0 until \r or \n is whitespace.
{ok, {line_break, #{}, <<>>, inline}, Rest0}.
|
