]> git.wincent.com - wikitext.git/blob - ext/parser.c
Collapse conditional inside _Wikitext_parser_sanitize_link_target
[wikitext.git] / ext / parser.c
1 // Copyright 2007-2009 Wincent Colaiuta. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are met:
5 //
6 // 1. Redistributions of source code must retain the above copyright notice,
7 //    this list of conditions and the following disclaimer.
8 // 2. Redistributions in binary form must reproduce the above copyright notice,
9 //    this list of conditions and the following disclaimer in the documentation
10 //    and/or other materials provided with the distribution.
11 //
12 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
13 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
16 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
17 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
18 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
19 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
20 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
21 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
22 // POSSIBILITY OF SUCH DAMAGE.
23
24 #include <stdbool.h>
25
26 #include "parser.h"
27 #include "ary.h"
28 #include "str.h"
29 #include "wikitext.h"
30 #include "wikitext_ragel.h"
31
32 #define IN(type) ary_includes(parser->scope, type)
33
34 // poor man's object orientation in C:
35 // instead of parsing around multiple parameters between functions in the parser
36 // we pack everything into a struct and pass around only a pointer to that
37 typedef struct
38 {
39     str_t   *capture;               // capturing to link_target, link_text, or NULL (direct to output, not capturing)
40     str_t   *output;                // for accumulating output to be returned
41     str_t   *link_target;           // short term "memory" for parsing links
42     str_t   *link_text;             // short term "memory" for parsing links
43     str_t   *line_ending;
44     str_t   *tabulation;            // caching buffer for emitting indentation
45     ary_t   *scope;                 // stack for tracking scope
46     ary_t   *line;                  // stack for tracking scope as implied by current line
47     ary_t   *line_buffer;           // stack for tracking raw tokens (not scope) on current line
48     VALUE   external_link_class;    // CSS class applied to external links
49     VALUE   mailto_class;           // CSS class applied to email (mailto) links
50     VALUE   img_prefix;             // path prepended when emitting img tags
51     int     base_indent;            // controlled by the :indent option to Wikitext::Parser#parse
52     int     current_indent;         // fluctuates according to currently nested structures
53     int     base_heading_level;
54     bool    pending_crlf;
55     bool    autolink;
56     bool    space_to_underscore;
57 } parser_t;
58
59 const char escaped_no_wiki_start[]      = "&lt;nowiki&gt;";
60 const char escaped_no_wiki_end[]        = "&lt;/nowiki&gt;";
61 const char literal_strong_em[]          = "'''''";
62 const char literal_strong[]             = "'''";
63 const char literal_em[]                 = "''";
64 const char escaped_em_start[]           = "&lt;em&gt;";
65 const char escaped_em_end[]             = "&lt;/em&gt;";
66 const char escaped_strong_start[]       = "&lt;strong&gt;";
67 const char escaped_strong_end[]         = "&lt;/strong&gt;";
68 const char escaped_tt_start[]           = "&lt;tt&gt;";
69 const char escaped_tt_end[]             = "&lt;/tt&gt;";
70 const char literal_h6[]                 = "======";
71 const char literal_h5[]                 = "=====";
72 const char literal_h4[]                 = "====";
73 const char literal_h3[]                 = "===";
74 const char literal_h2[]                 = "==";
75 const char literal_h1[]                 = "=";
76 const char pre_start[]                  = "<pre>";
77 const char pre_end[]                    = "</pre>";
78 const char escaped_pre_start[]          = "&lt;pre&gt;";
79 const char escaped_pre_end[]            = "&lt;/pre&gt;";
80 const char blockquote_start[]           = "<blockquote>";
81 const char blockquote_end[]             = "</blockquote>";
82 const char escaped_blockquote_start[]   = "&lt;blockquote&gt;";
83 const char escaped_blockquote_end[]     = "&lt;/blockquote&gt;";
84 const char strong_em_start[]            = "<strong><em>";
85 const char strong_start[]               = "<strong>";
86 const char strong_end[]                 = "</strong>";
87 const char em_start[]                   = "<em>";
88 const char em_end[]                     = "</em>";
89 const char tt_start[]                   = "<tt>";
90 const char tt_end[]                     = "</tt>";
91 const char ol_start[]                   = "<ol>";
92 const char ol_end[]                     = "</ol>";
93 const char ul_start[]                   = "<ul>";
94 const char ul_end[]                     = "</ul>";
95 const char li_start[]                   = "<li>";
96 const char li_end[]                     = "</li>";
97 const char h6_start[]                   = "<h6>";
98 const char h6_end[]                     = "</h6>";
99 const char h5_start[]                   = "<h5>";
100 const char h5_end[]                     = "</h5>";
101 const char h4_start[]                   = "<h4>";
102 const char h4_end[]                     = "</h4>";
103 const char h3_start[]                   = "<h3>";
104 const char h3_end[]                     = "</h3>";
105 const char h2_start[]                   = "<h2>";
106 const char h2_end[]                     = "</h2>";
107 const char h1_start[]                   = "<h1>";
108 const char h1_end[]                     = "</h1>";
109 const char p_start[]                    = "<p>";
110 const char p_end[]                      = "</p>";
111 const char space[]                      = " ";
112 const char a_start[]                    = "<a href=\"";
113 const char a_class[]                    = "\" class=\"";
114 const char a_start_close[]              = "\">";
115 const char a_end[]                      = "</a>";
116 const char link_start[]                 = "[[";
117 const char link_end[]                   = "]]";
118 const char separator[]                  = "|";
119 const char ext_link_start[]             = "[";
120 const char backtick[]                   = "`";
121 const char quote[]                      = "\"";
122 const char ampersand[]                  = "&";
123 const char quot_entity[]                = "&quot;";
124 const char amp_entity[]                 = "&amp;";
125 const char lt_entity[]                  = "&lt;";
126 const char gt_entity[]                  = "&gt;";
127 const char escaped_blockquote[]         = "&gt; ";
128 const char ext_link_end[]               = "]";
129 const char literal_img_start[]          = "{{";
130 const char img_start[]                  = "<img src=\"";
131 const char img_end[]                    = "\" />";
132 const char img_alt[]                    = "\" alt=\"";
133
134 // Mark the parser struct designated by ptr as a participant in Ruby's
135 // mark-and-sweep garbage collection scheme. A variable named name is placed on
136 // the C stack to prevent the structure from being prematurely collected.
137 #define GC_WRAP_PARSER(ptr, name) volatile VALUE name __attribute__((unused)) = Data_Wrap_Struct(rb_cObject, 0, parser_free, ptr)
138
139 parser_t *parser_new(void)
140 {
141     parser_t *parser                = ALLOC_N(parser_t, 1);
142     parser->capture                 = NULL; // not a real instance, pointer to other member's instance
143     parser->output                  = str_new();
144     parser->link_target             = str_new();
145     parser->link_text               = str_new();
146     parser->line_ending             = NULL; // caller should set up
147     parser->tabulation              = str_new();
148     parser->scope                   = ary_new();
149     parser->line                    = ary_new();
150     parser->line_buffer             = ary_new();
151     parser->external_link_class     = Qnil; // caller should set up
152     parser->mailto_class            = Qnil; // caller should set up
153     parser->img_prefix              = Qnil; // caller should set up
154     parser->base_indent             = 0;
155     parser->current_indent          = 0;
156     parser->base_heading_level      = 0;
157     parser->pending_crlf            = false;
158     parser->autolink                = true;
159     parser->space_to_underscore     = true;
160     return parser;
161 }
162
163 void parser_free(parser_t *parser)
164 {
165     // we don't free parser->capture; it's just a redundant pointer
166     if (parser->output)         str_free(parser->output);
167     if (parser->link_target)    str_free(parser->link_target);
168     if (parser->link_text)      str_free(parser->link_text);
169     if (parser->line_ending)    str_free(parser->line_ending);
170     if (parser->tabulation)     str_free(parser->tabulation);
171     if (parser->scope)          ary_free(parser->scope);
172     if (parser->line)           ary_free(parser->line);
173     if (parser->line_buffer)    ary_free(parser->line_buffer);
174     free(parser);
175 }
176
177 // for testing and debugging only
178 VALUE Wikitext_parser_tokenize(VALUE self, VALUE string)
179 {
180     if (NIL_P(string))
181         return Qnil;
182     string = StringValue(string);
183     VALUE tokens = rb_ary_new();
184     char *p = RSTRING_PTR(string);
185     long len = RSTRING_LEN(string);
186     char *pe = p + len;
187     token_t token;
188     next_token(&token, NULL, p, pe);
189     rb_ary_push(tokens, _Wikitext_token(&token));
190     while (token.type != END_OF_FILE)
191     {
192         next_token(&token, &token, NULL, pe);
193         rb_ary_push(tokens, _Wikitext_token(&token));
194     }
195     return tokens;
196 }
197
198 // for benchmarking raw tokenization speed only
199 VALUE Wikitext_parser_benchmarking_tokenize(VALUE self, VALUE string)
200 {
201     if (NIL_P(string))
202         return Qnil;
203     string = StringValue(string);
204     char *p = RSTRING_PTR(string);
205     long len = RSTRING_LEN(string);
206     char *pe = p + len;
207     token_t token;
208     next_token(&token, NULL, p, pe);
209     while (token.type != END_OF_FILE)
210         next_token(&token, &token, NULL, pe);
211     return Qnil;
212 }
213
214 VALUE Wikitext_parser_fulltext_tokenize(int argc, VALUE *argv, VALUE self)
215 {
216     // process arguments
217     VALUE string, options;
218     if (rb_scan_args(argc, argv, "11", &string, &options) == 1) // 1 mandatory argument, 1 optional argument
219         options = Qnil;
220     if (NIL_P(string))
221         return Qnil;
222     string = StringValue(string);
223     VALUE tokens = rb_ary_new();
224
225     // check instance variables
226     VALUE min = rb_iv_get(self, "@minimum_fulltext_token_length");
227
228     // process options hash (can override instance variables)
229     if (!NIL_P(options) && TYPE(options) == T_HASH)
230     {
231         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("minimum"))) == Qtrue)
232             min = rb_hash_aref(options, ID2SYM(rb_intern("minimum")));
233     }
234     int min_len = NIL_P(min) ? 3 : NUM2INT(min);
235     if (min_len < 0)
236         min_len = 0;
237
238     // set up scanner
239     char *p = RSTRING_PTR(string);
240     long len = RSTRING_LEN(string);
241     char *pe = p + len;
242     token_t token;
243     token_t *_token = &token;
244     next_token(&token, NULL, p, pe);
245     while (token.type != END_OF_FILE)
246     {
247         switch (token.type)
248         {
249             case URI:
250             case MAIL:
251             case ALNUM:
252                 if (TOKEN_LEN(_token) >= min_len)
253                     rb_ary_push(tokens, TOKEN_TEXT(_token));
254                 break;
255             default:
256                 // ignore everything else
257                 break;
258         }
259         next_token(&token, &token, NULL, pe);
260     }
261     return tokens;
262 }
263
264 // we downcase "in place", overwriting the original contents of the buffer
265 void _Wikitext_downcase_bang(char *ptr, long len)
266 {
267     for (long i = 0; i < len; i++)
268     {
269         if (ptr[i] >= 'A' && ptr[i] <= 'Z')
270             ptr[i] += 32;
271     }
272 }
273
274 // prepare hyperlink and append it to parser->output
275 // if check_autolink is true, checks parser->autolink to decide whether to emit a real hyperlink
276 // or merely the literal link target
277 // if link_text is Qnil, the link_target is re-used for the link text
278 void _Wikitext_append_hyperlink(parser_t *parser, VALUE link_prefix, VALUE link_target, VALUE link_text, VALUE link_class, bool check_autolink)
279 {
280     if (check_autolink && !parser->autolink)
281         str_append_string(parser->output, link_target);
282     else
283     {
284         str_append(parser->output, a_start, sizeof(a_start) - 1);               // <a href="
285         if (!NIL_P(link_prefix))
286             str_append_string(parser->output, link_prefix);
287         str_append_string(parser->output, link_target);
288
289         // special handling for mailto URIs
290         const char *mailto = "mailto:";
291         if (NIL_P(link_prefix) &&
292             RSTRING_LEN(link_target) >= (long)sizeof(mailto) &&
293             strncmp(mailto, RSTRING_PTR(link_target), sizeof(mailto)) == 0)
294             link_class = parser->mailto_class; // use mailto_class from parser
295         if (link_class != Qnil)
296         {
297             str_append(parser->output, a_class, sizeof(a_class) - 1);           // " class="
298             str_append_string(parser->output, link_class);
299         }
300         str_append(parser->output, a_start_close, sizeof(a_start_close) - 1);   // ">
301         if (NIL_P(link_text)) // re-use link_target
302             str_append_string(parser->output, link_target);
303         else
304             str_append_string(parser->output, link_text);
305         str_append(parser->output, a_end, sizeof(a_end) - 1);                   // </a>
306     }
307 }
308
309 void _Wikitext_append_img(parser_t *parser, char *token_ptr, int token_len)
310 {
311     str_append(parser->output, img_start, sizeof(img_start) - 1);   // <img src="
312     if (!NIL_P(parser->img_prefix) && *token_ptr != '/')            // len always > 0
313         str_append_string(parser->output, parser->img_prefix);
314     str_append(parser->output, token_ptr, token_len);
315     str_append(parser->output, img_alt, sizeof(img_alt) - 1);       // " alt="
316     str_append(parser->output, token_ptr, token_len);
317     str_append(parser->output, img_end, sizeof(img_end) - 1);       // " />
318 }
319
320 // will emit indentation only if we are about to emit any of:
321 //      <blockquote>, <p>, <ul>, <ol>, <li>, <h1> etc, <pre>
322 // each time we enter one of those spans must ++ the indentation level
323 void _Wikitext_indent(parser_t *parser)
324 {
325     if (parser->base_indent == -1) // indentation disabled
326         return;
327     int space_count = parser->current_indent + parser->base_indent;
328     if (space_count > 0)
329     {
330         char *old_end, *new_end;
331         if (parser->tabulation->len < space_count)
332             str_grow(parser->tabulation, space_count); // reallocates if necessary
333         old_end = parser->tabulation->ptr + parser->tabulation->len;
334         new_end = parser->tabulation->ptr + space_count;
335         while (old_end < new_end)
336             *old_end++ = ' ';
337         if (space_count > parser->tabulation->len)
338             parser->tabulation->len = space_count;
339         str_append(parser->output, parser->tabulation->ptr, space_count);
340     }
341     parser->current_indent += 2;
342 }
343
344 void _Wikitext_dedent(parser_t *parser, VALUE emit)
345 {
346     if (parser->base_indent == -1) // indentation disabled
347         return;
348     parser->current_indent -= 2;
349     if (emit != Qtrue)
350         return;
351     int space_count = parser->current_indent + parser->base_indent;
352     if (space_count > 0)
353         str_append(parser->output, parser->tabulation->ptr, space_count);
354 }
355
356 // Pops a single item off the parser's scope stack.
357 // A corresponding closing tag is written to the target string.
358 // The target string may be the main output buffer, or a substring capturing buffer if a link is being scanned.
359 void _Wikitext_pop_from_stack(parser_t *parser, str_t *target)
360 {
361     int top = ary_entry(parser->scope, -1);
362     if (NO_ITEM(top))
363         return;
364     if (!target)
365         target = parser->output;
366
367     // for headings, take base_heading_level into account
368     if (top >= H1_START && top <= H6_START)
369     {
370         top += parser->base_heading_level;
371         // no need to check for underflow (base_heading_level is never negative)
372         if (top > H6_START)
373             top = H6_START;
374     }
375
376     switch (top)
377     {
378         case PRE:
379         case PRE_START:
380             str_append(target, pre_end, sizeof(pre_end) - 1);
381             str_append_str(target, parser->line_ending);
382             _Wikitext_dedent(parser, Qfalse);
383             break;
384
385         case BLOCKQUOTE:
386         case BLOCKQUOTE_START:
387             _Wikitext_dedent(parser, Qtrue);
388             str_append(target, blockquote_end, sizeof(blockquote_end) - 1);
389             str_append_str(target, parser->line_ending);
390             break;
391
392         case NO_WIKI_START:
393             // not a real HTML tag; so nothing to pop
394             break;
395
396         case STRONG:
397         case STRONG_START:
398             str_append(target, strong_end, sizeof(strong_end) - 1);
399             break;
400
401         case EM:
402         case EM_START:
403             str_append(target, em_end, sizeof(em_end) - 1);
404             break;
405
406         case TT:
407         case TT_START:
408             str_append(target, tt_end, sizeof(tt_end) - 1);
409             break;
410
411         case OL:
412             _Wikitext_dedent(parser, Qtrue);
413             str_append(target, ol_end, sizeof(ol_end) - 1);
414             str_append_str(target, parser->line_ending);
415             break;
416
417         case UL:
418             _Wikitext_dedent(parser, Qtrue);
419             str_append(target, ul_end, sizeof(ul_end) - 1);
420             str_append_str(target, parser->line_ending);
421             break;
422
423         case NESTED_LIST:
424             // next token to pop will be a LI
425             // LI is an interesting token because sometimes we want it to behave like P (ie. do a non-emitting indent)
426             // and other times we want it to behave like BLOCKQUOTE (ie. when it has a nested list inside)
427             // hence this hack: we do an emitting dedent on behalf of the LI that we know must be coming
428             // and then when we pop the actual LI itself (below) we do the standard non-emitting indent
429             _Wikitext_dedent(parser, Qtrue);    // we really only want to emit the spaces
430             parser->current_indent += 2;        // we don't want to decrement the actual indent level, so put it back
431             break;
432
433         case LI:
434             str_append(target, li_end, sizeof(li_end) - 1);
435             str_append_str(target, parser->line_ending);
436             _Wikitext_dedent(parser, Qfalse);
437             break;
438
439         case H6_START:
440             str_append(target, h6_end, sizeof(h6_end) - 1);
441             str_append_str(target, parser->line_ending);
442             _Wikitext_dedent(parser, Qfalse);
443             break;
444
445         case H5_START:
446             str_append(target, h5_end, sizeof(h5_end) - 1);
447             str_append_str(target, parser->line_ending);
448             _Wikitext_dedent(parser, Qfalse);
449             break;
450
451         case H4_START:
452             str_append(target, h4_end, sizeof(h4_end) - 1);
453             str_append_str(target, parser->line_ending);
454             _Wikitext_dedent(parser, Qfalse);
455             break;
456
457         case H3_START:
458             str_append(target, h3_end, sizeof(h3_end) - 1);
459             str_append_str(target, parser->line_ending);
460             _Wikitext_dedent(parser, Qfalse);
461             break;
462
463         case H2_START:
464             str_append(target, h2_end, sizeof(h2_end) - 1);
465             str_append_str(target, parser->line_ending);
466             _Wikitext_dedent(parser, Qfalse);
467             break;
468
469         case H1_START:
470             str_append(target, h1_end, sizeof(h1_end) - 1);
471             str_append_str(target, parser->line_ending);
472             _Wikitext_dedent(parser, Qfalse);
473             break;
474
475         case LINK_START:
476             // not an HTML tag; so nothing to emit
477             break;
478
479         case EXT_LINK_START:
480             // not an HTML tag; so nothing to emit
481             break;
482
483         case PATH:
484             // not an HTML tag; so nothing to emit
485             break;
486
487         case SPACE:
488             // not an HTML tag (only used to separate an external link target from the link text); so nothing to emit
489             break;
490
491         case SEPARATOR:
492             // not an HTML tag (only used to separate an external link target from the link text); so nothing to emit
493             break;
494
495         case P:
496             str_append(target, p_end, sizeof(p_end) - 1);
497             str_append_str(target, parser->line_ending);
498             _Wikitext_dedent(parser, Qfalse);
499             break;
500
501         case END_OF_FILE:
502             // nothing to do
503             break;
504
505         default:
506             // should probably raise an exception here
507             break;
508     }
509     ary_pop(parser->scope);
510 }
511
512 // Pops items off the top of parser's scope stack, accumulating closing tags for them into the target string, until item is reached.
513 // If including is true then the item itself is also popped.
514 // The target string may be the main output buffer, or a substring capturing buffer when scanning links.
515 void _Wikitext_pop_from_stack_up_to(parser_t *parser, str_t *target, int item, bool including)
516 {
517     int continue_looping = 1;
518     do
519     {
520         int top = ary_entry(parser->scope, -1);
521         if (NO_ITEM(top))
522             return;
523         if (top == item)
524         {
525             if (!including)
526                 return;
527             continue_looping = 0;
528         }
529         _Wikitext_pop_from_stack(parser, target);
530     } while (continue_looping);
531 }
532
533 void _Wikitext_pop_all_from_stack(parser_t *parser)
534 {
535     for (int i = 0, max = parser->scope->count; i < max; i++)
536         _Wikitext_pop_from_stack(parser, NULL);
537 }
538
539 void _Wikitext_start_para_if_necessary(parser_t *parser)
540 {
541     if (parser->capture)
542         return;
543
544     // if no block open yet, or top of stack is BLOCKQUOTE/BLOCKQUOTE_START (with nothing in it yet)
545     if (parser->scope->count == 0 ||
546         ary_entry(parser->scope, -1) == BLOCKQUOTE ||
547         ary_entry(parser->scope, -1) == BLOCKQUOTE_START)
548     {
549         _Wikitext_indent(parser);
550         str_append(parser->output, p_start, sizeof(p_start) - 1);
551         ary_push(parser->scope, P);
552         ary_push(parser->line, P);
553     }
554     else if (parser->pending_crlf)
555     {
556         if (IN(P))
557             // already in a paragraph block; convert pending CRLF into a space
558             str_append(parser->output, space, sizeof(space) - 1);
559         else if (IN(PRE))
560             // PRE blocks can have pending CRLF too (helps us avoid emitting the trailing newline)
561             str_append_str(parser->output, parser->line_ending);
562     }
563     parser->pending_crlf = false;
564 }
565
566 void _Wikitext_emit_pending_crlf_if_necessary(parser_t *parser)
567 {
568     if (parser->pending_crlf)
569     {
570         str_append_str(parser->output, parser->line_ending);
571         parser->pending_crlf = false;
572     }
573 }
574
575 // Helper function that pops any excess elements off scope (pushing is already handled in the respective rules).
576 // For example, given input like:
577 //
578 //      > > foo
579 //      bar
580 //
581 // Upon seeing "bar", we want to pop two BLOCKQUOTE elements from the scope.
582 // The reverse case (shown below) is handled from inside the BLOCKQUOTE rule itself:
583 //
584 //      foo
585 //      > > bar
586 //
587 // Things are made slightly more complicated by the fact that there is one block-level tag that can be on the scope
588 // but not on the line scope:
589 //
590 //      <blockquote>foo
591 //      bar</blockquote>
592 //
593 // Here on seeing "bar" we have one item on the scope (BLOCKQUOTE_START) which we don't want to pop, but we have nothing
594 // on the line scope.
595 // Luckily, BLOCKQUOTE_START tokens can only appear at the start of the scope array, so we can check for them first before
596 // entering the for loop.
597 void _Wikitext_pop_excess_elements(parser_t *parser)
598 {
599     if (parser->capture)
600         return;
601     for (int i = parser->scope->count - ary_count(parser->scope, BLOCKQUOTE_START), j = parser->line->count; i > j; i--)
602     {
603         // special case for last item on scope
604         if (i - j == 1)
605         {
606             // don't auto-pop P if it is only item on scope
607             if (ary_entry(parser->scope, -1) == P)
608             {
609                 // add P to the line scope to prevent us entering the loop at all next time around
610                 ary_push(parser->line, P);
611                 continue;
612             }
613         }
614         _Wikitext_pop_from_stack(parser, NULL);
615     }
616 }
617
618 #define INVALID_ENCODING(msg)  do { if (dest_ptr) free(dest_ptr); rb_raise(eWikitextParserError, "invalid encoding: " msg); } while(0)
619
620 // convert a single UTF-8 codepoint to UTF-32
621 // expects an input buffer, src, containing a UTF-8 encoded character (which may be multi-byte)
622 // the end of the input buffer, end, is also passed in to allow the detection of invalidly truncated codepoints
623 // the number of bytes in the UTF-8 character (between 1 and 4) is returned by reference in width_out
624 // raises a RangeError if the supplied character is invalid UTF-8
625 // (in which case it also frees the block of memory indicated by dest_ptr if it is non-NULL)
626 uint32_t _Wikitext_utf8_to_utf32(char *src, char *end, long *width_out, void *dest_ptr)
627 {
628     uint32_t dest;
629     if ((unsigned char)src[0] <= 0x7f)                      // ASCII
630     {
631         dest = src[0];
632         *width_out = 1;
633     }
634     else if ((src[0] & 0xe0) == 0xc0)                       // byte starts with 110..... : this should be a two-byte sequence
635     {
636         if (src + 1 >= end)
637             INVALID_ENCODING("truncated byte sequence");    // no second byte
638         else if (((unsigned char)src[0] == 0xc0) || ((unsigned char)src[0] == 0xc1))
639             INVALID_ENCODING("overlong encoding");          // overlong encoding: lead byte of 110..... but code point <= 127
640         else if ((src[1] & 0xc0) != 0x80 )
641             INVALID_ENCODING("malformed byte sequence");    // should have second byte starting with 10......
642         dest = ((uint32_t)(src[0] & 0x1f)) << 6 | (src[1] & 0x3f);
643         *width_out = 2;
644     }
645     else if ((src[0] & 0xf0) == 0xe0)                       // byte starts with 1110.... : this should be a three-byte sequence
646     {
647         if (src + 2 >= end)
648             INVALID_ENCODING("truncated byte sequence");    // missing second or third byte
649         else if (((src[1] & 0xc0) != 0x80 ) || ((src[2] & 0xc0) != 0x80 ))
650             INVALID_ENCODING("malformed byte sequence");    // should have second and third bytes starting with 10......
651         dest = ((uint32_t)(src[0] & 0x0f)) << 12 | ((uint32_t)(src[1] & 0x3f)) << 6 | (src[2] & 0x3f);
652         *width_out = 3;
653     }
654     else if ((src[0] & 0xf8) == 0xf0)                       // bytes starts with 11110... : this should be a four-byte sequence
655     {
656         if (src + 3 >= end)
657             INVALID_ENCODING("truncated byte sequence");    // missing second, third, or fourth byte
658         else if ((unsigned char)src[0] >= 0xf5 && (unsigned char)src[0] <= 0xf7)
659             INVALID_ENCODING("overlong encoding");          // disallowed by RFC 3629 (codepoints above 0x10ffff)
660         else if (((src[1] & 0xc0) != 0x80 ) || ((src[2] & 0xc0) != 0x80 ) || ((src[3] & 0xc0) != 0x80 ))
661             INVALID_ENCODING("malformed byte sequence");    // should have second and third bytes starting with 10......
662         dest = ((uint32_t)(src[0] & 0x07)) << 18 | ((uint32_t)(src[1] & 0x3f)) << 12 | ((uint32_t)(src[1] & 0x3f)) << 6 | (src[2] & 0x3f);
663         *width_out = 4;
664     }
665     else                                                    // invalid input
666         INVALID_ENCODING("unexpected byte");
667     return dest;
668 }
669
670 VALUE _Wikitext_utf32_char_to_entity(uint32_t character)
671 {
672     // TODO: consider special casing some entities (ie. quot, amp, lt, gt etc)?
673     char hex_string[8]  = { '&', '#', 'x', 0, 0, 0, 0, ';' };
674     char scratch        = (character & 0xf000) >> 12;
675     hex_string[3]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
676     scratch             = (character & 0x0f00) >> 8;
677     hex_string[4]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
678     scratch             = (character & 0x00f0) >> 4;
679     hex_string[5]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
680     scratch             = character & 0x000f;
681     hex_string[6]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
682     return rb_str_new((const char *)hex_string, sizeof(hex_string));
683 }
684
685 // trim parser->link_text in place
686 void _Wikitext_parser_trim_link_text(parser_t *parser)
687 {
688     char    *src        = parser->link_text->ptr;
689     char    *start      = src;                  // remember this so we can check if we're at the start
690     char    *left       = src;
691     char    *non_space  = src;                  // remember last non-space character output
692     long    len         = parser->link_text->len;
693     char    *end        = src + len;
694     while (src < end)
695     {
696         if (*src == ' ')
697         {
698             if (src == left)
699                 left++;
700         }
701         else
702             non_space = src;
703         src++;
704     }
705     if (left != start || non_space + 1 != end)
706     {
707         // TODO: could potentially avoid this memmove by extending the str_t struct with an "offset" or "free" member
708         parser->link_text->len = (non_space + 1) - left;
709         memmove(parser->link_text->ptr, left, parser->link_text->len);
710     }
711 }
712
713 // - non-printable (non-ASCII) characters converted to numeric entities
714 // - QUOT and AMP characters converted to named entities
715 // - if rollback is true, there is no special treatment of spaces
716 // - if rollback is false, leading and trailing whitespace trimmed
717 VALUE _Wikitext_parser_sanitize_link_target(parser_t *parser, bool rollback)
718 {
719     char    *src    = parser->link_target->ptr;
720     char    *start  = src;                  // remember this so we can check if we're at the start
721     long    len     = parser->link_target->len;
722     char    *end    = src + len;
723
724     // start with a destination buffer twice the size of the source, will realloc if necessary
725     // slop = (len / 8) * 8 (ie. one in every 8 characters can be converted into an entity, each entity requires 8 bytes)
726     // this efficiently handles the most common case (where the size of the buffer doesn't change much)
727     char    *dest       = ALLOC_N(char, len * 2);
728     char    *dest_ptr   = dest; // hang on to this so we can pass it to free() later
729     char    *non_space  = dest; // remember last non-space character output
730     while (src < end)
731     {
732         // need at most 8 characters (8 bytes) to display each character
733         if (dest + 8 > dest_ptr + len)                      // outgrowing buffer, must reallocate
734         {
735             char *old_dest      = dest;
736             char *old_dest_ptr  = dest_ptr;
737             len                 = len + (end - src) * 8;    // allocate enough for worst case
738             dest                = realloc(dest_ptr, len);   // will never have to realloc more than once
739             if (dest == NULL)
740             {
741                 // would have used reallocf, but this has to run on Linux too, not just Darwin
742                 free(dest_ptr);
743                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
744             }
745             dest_ptr    = dest;
746             dest        = dest_ptr + (old_dest - old_dest_ptr);
747             non_space   = dest_ptr + (non_space - old_dest_ptr);
748         }
749
750         if (*src == '"')
751         {
752             char quot_entity_literal[] = { '&', 'q', 'u', 'o', 't', ';' };  // no trailing NUL
753             memcpy(dest, quot_entity_literal, sizeof(quot_entity_literal));
754             dest += sizeof(quot_entity_literal);
755         }
756         else if (*src == '&')
757         {
758             char amp_entity_literal[] = { '&', 'a', 'm', 'p', ';' };    // no trailing NUL
759             memcpy(dest, amp_entity_literal, sizeof(amp_entity_literal));
760             dest += sizeof(amp_entity_literal);
761         }
762         else if (*src == '<' || *src == '>')
763         {
764             free(dest_ptr);
765             rb_raise(rb_eRangeError, "invalid link text (\"%c\" may not appear in link text)", *src);
766         }
767         else if (*src == ' ' && src == start && !rollback)
768             start++;                            // we eat leading space
769         else if (*src >= 0x20 && *src <= 0x7e)  // printable ASCII
770         {
771             *dest = *src;
772             dest++;
773         }
774         else    // all others: must convert to entities
775         {
776             long        width;
777             VALUE       entity      = _Wikitext_utf32_char_to_entity(_Wikitext_utf8_to_utf32(src, end, &width, dest_ptr));
778             char        *entity_src = RSTRING_PTR(entity);
779             long        entity_len  = RSTRING_LEN(entity); // should always be 8 characters (8 bytes)
780             memcpy(dest, entity_src, entity_len);
781             dest        += entity_len;
782             src         += width;
783             non_space   = dest;
784             continue;
785         }
786         if (*src != ' ')
787             non_space = dest;
788         src++;
789     }
790
791     // trim trailing space if necessary
792     if (!rollback && non_space > dest_ptr && dest != non_space)
793         len = non_space - dest_ptr;
794     else
795         len = dest - dest_ptr;
796     VALUE out = rb_str_new(dest_ptr, len);
797     free(dest_ptr);
798     return out;
799 }
800
801 VALUE Wikitext_parser_sanitize_link_target(VALUE self, VALUE string)
802 {
803     parser_t parser;
804     parser.link_target = str_new_from_string(string);
805     GC_WRAP_STR(parser.link_target, link_target_gc);
806     return _Wikitext_parser_sanitize_link_target(&parser, false);
807 }
808
809 // encodes the input string according to RFCs 2396 and 2718
810 // leading and trailing whitespace trimmed
811 // note that the first character of the target link is not case-sensitive
812 // (this is a recommended application-level constraint; it is not imposed at this level)
813 // this is to allow links like:
814 //         ...the [[foo]] is...
815 // to be equivalent to:
816 //         thing. [[Foo]] was...
817 static void _Wikitext_parser_encode_link_target(parser_t *parser)
818 {
819     VALUE in                = string_from_str(parser->link_target);
820     char        *input      = RSTRING_PTR(in);
821     char        *start      = input;            // remember this so we can check if we're at the start
822     long        len         = RSTRING_LEN(in);
823     if (!(len > 0))
824         return;
825     char        *end        = input + len;
826     static char hex[]       = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
827
828     // to avoid most reallocations start with a destination buffer twice the size of the source
829     // this handles the most common case (where most chars are in the ASCII range and don't require more storage, but there are
830     // often quite a few spaces, which are encoded as "%20" and occupy 3 bytes)
831     // the worst case is where _every_ byte must be written out using 3 bytes
832     long        dest_len    = len * 2;
833     char        *dest       = ALLOC_N(char, dest_len);
834     char        *dest_ptr   = dest; // hang on to this so we can pass it to free() later
835     char        *non_space  = dest; // remember last non-space character output
836     for (; input < end; input++)
837     {
838         if ((dest + 3) > (dest_ptr + dest_len))     // worst case: a single character may grow to 3 characters once encoded
839         {
840             // outgrowing buffer, must reallocate
841             char *old_dest      = dest;
842             char *old_dest_ptr  = dest_ptr;
843             dest_len            += len;
844             dest                = realloc(dest_ptr, dest_len);
845             if (dest == NULL)
846             {
847                 // would have used reallocf, but this has to run on Linux too, not just Darwin
848                 free(dest_ptr);
849                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
850             }
851             dest_ptr    = dest;
852             dest        = dest_ptr + (old_dest - old_dest_ptr);
853             non_space   = dest_ptr + (non_space - old_dest_ptr);
854         }
855
856         // pass through unreserved characters
857         if (((*input >= 'a') && (*input <= 'z')) ||
858             ((*input >= 'A') && (*input <= 'Z')) ||
859             ((*input >= '0') && (*input <= '9')) ||
860             (*input == '-') ||
861             (*input == '_') ||
862             (*input == '.') ||
863             (*input == '~'))
864         {
865             *dest++     = *input;
866             non_space   = dest;
867         }
868         else if (*input == ' ' && input == start)
869             start++;                    // we eat leading space
870         else if (*input == ' ' && parser->space_to_underscore)
871             *dest++     = '_';
872         else    // everything else gets URL-encoded
873         {
874             *dest++     = '%';
875             *dest++     = hex[(unsigned char)(*input) / 16];   // left
876             *dest++     = hex[(unsigned char)(*input) % 16];   // right
877             if (*input != ' ')
878                 non_space = dest;
879         }
880     }
881
882     // trim trailing space if necessary
883     if (non_space > dest_ptr && dest != non_space)
884         dest_len = non_space - dest_ptr;
885     else
886         dest_len = dest - dest_ptr;
887
888     // TOOD: try to avoid this copy by working directly inside link_target buffer
889     str_clear(parser->link_target);
890     str_append(parser->link_target, dest_ptr, dest_len);
891     free(dest_ptr);
892 }
893
894 VALUE Wikitext_parser_encode_link_target(VALUE self, VALUE in)
895 {
896     parser_t parser;
897     parser.space_to_underscore      = false;
898     parser.link_target              = str_new_from_string(in);
899     GC_WRAP_STR(parser.link_target, link_target_gc);
900     _Wikitext_parser_encode_link_target(&parser);
901     return string_from_str(parser.link_target);
902 }
903
904 // this method exposed for testing only
905 VALUE Wikitext_parser_encode_special_link_target(VALUE self, VALUE in)
906 {
907     parser_t parser;
908     parser.space_to_underscore      = false;
909     parser.link_target              = str_new_from_string(in);
910     GC_WRAP_STR(parser.link_target, link_target_gc);
911     _Wikitext_parser_encode_link_target(&parser);
912     return string_from_str(parser.link_target);
913 }
914
915 // returns 1 (true) if supplied string is blank (nil, empty, or all whitespace)
916 // returns 0 (false) otherwise
917 bool _Wikitext_blank(str_t *str)
918 {
919     if (str->len == 0)
920         return true;
921     for (char *ptr = str->ptr,
922         *end = str->ptr + str->len;
923         ptr < end; ptr++)
924     {
925         if (*ptr != ' ')
926             return false;
927     }
928     return true;
929 }
930
931 void _Wikitext_rollback_failed_internal_link(parser_t *parser)
932 {
933     if (!IN(LINK_START))
934         return; // nothing to do!
935     int scope_includes_separator = IN(SEPARATOR);
936     _Wikitext_pop_from_stack_up_to(parser, NULL, LINK_START, true);
937     str_append(parser->output, link_start, sizeof(link_start) - 1);
938     if (parser->link_target->len > 0)
939     {
940         // TODO: make _Wikitext_parser_sanitize_link_target return something else? or append directly to buffer would be much better
941         VALUE sanitized = _Wikitext_parser_sanitize_link_target(parser, true);
942         str_append_string(parser->output, sanitized);
943         if (scope_includes_separator)
944         {
945             str_append(parser->output, separator, sizeof(separator) - 1);
946             if (parser->link_text->len > 0)
947                 str_append_str(parser->output, parser->link_text);
948         }
949     }
950     parser->capture = NULL;
951     str_clear(parser->link_target);
952     str_clear(parser->link_text);
953 }
954
955 void _Wikitext_rollback_failed_external_link(parser_t *parser)
956 {
957     if (!IN(EXT_LINK_START))
958         return; // nothing to do!
959
960     // store a couple of values before popping
961     int scope_includes_space = IN(SPACE);
962     VALUE link_class = IN(PATH) ? Qnil : parser->external_link_class;
963     _Wikitext_pop_from_stack_up_to(parser, NULL, EXT_LINK_START, true);
964
965     str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
966     if (parser->link_target->len > 0)
967     {
968         _Wikitext_append_hyperlink(parser, Qnil, string_from_str(parser->link_target), Qnil, link_class, true);
969         if (scope_includes_space)
970         {
971             str_append(parser->output, space, sizeof(space) - 1);
972             if (parser->link_text->len > 0)
973                 str_append_str(parser->output, parser->link_text);
974         }
975     }
976     parser->capture = NULL;
977     str_clear(parser->link_target);
978     str_clear(parser->link_text);
979 }
980
981 void _Wikitext_rollback_failed_link(parser_t *parser)
982 {
983     _Wikitext_rollback_failed_internal_link(parser);
984     _Wikitext_rollback_failed_external_link(parser);
985 }
986
987 VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
988 {
989     // process arguments
990     VALUE options;
991     if (rb_scan_args(argc, argv, "01", &options) == 0) // 0 mandatory arguments, 1 optional argument
992         options = Qnil;
993
994     // defaults
995     VALUE autolink                      = Qtrue;
996     VALUE line_ending                   = rb_str_new2("\n");
997     VALUE external_link_class           = rb_str_new2("external");
998     VALUE mailto_class                  = rb_str_new2("mailto");
999     VALUE internal_link_prefix          = rb_str_new2("/wiki/");
1000     VALUE img_prefix                    = rb_str_new2("/images/");
1001     VALUE space_to_underscore           = Qtrue;
1002     VALUE minimum_fulltext_token_length = INT2NUM(3);
1003     VALUE base_heading_level            = INT2NUM(0);
1004
1005     // process options hash (override defaults)
1006     if (!NIL_P(options) && TYPE(options) == T_HASH)
1007     {
1008 #define OVERRIDE_IF_SET(name)   rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern(#name))) == Qtrue ? \
1009                                 rb_hash_aref(options, ID2SYM(rb_intern(#name))) : name
1010         autolink                        = OVERRIDE_IF_SET(autolink);
1011         line_ending                     = OVERRIDE_IF_SET(line_ending);
1012         external_link_class             = OVERRIDE_IF_SET(external_link_class);
1013         mailto_class                    = OVERRIDE_IF_SET(mailto_class);
1014         internal_link_prefix            = OVERRIDE_IF_SET(internal_link_prefix);
1015         img_prefix                      = OVERRIDE_IF_SET(img_prefix);
1016         space_to_underscore             = OVERRIDE_IF_SET(space_to_underscore);
1017         minimum_fulltext_token_length   = OVERRIDE_IF_SET(minimum_fulltext_token_length);
1018         base_heading_level              = OVERRIDE_IF_SET(base_heading_level);
1019     }
1020
1021     // no need to call super here; rb_call_super()
1022     rb_iv_set(self, "@autolink",                        autolink);
1023     rb_iv_set(self, "@line_ending",                     line_ending);
1024     rb_iv_set(self, "@external_link_class",             external_link_class);
1025     rb_iv_set(self, "@mailto_class",                    mailto_class);
1026     rb_iv_set(self, "@internal_link_prefix",            internal_link_prefix);
1027     rb_iv_set(self, "@img_prefix",                      img_prefix);
1028     rb_iv_set(self, "@space_to_underscore",             space_to_underscore);
1029     rb_iv_set(self, "@minimum_fulltext_token_length",   minimum_fulltext_token_length);
1030     rb_iv_set(self, "@base_heading_level",              base_heading_level);
1031     return self;
1032 }
1033
1034 VALUE Wikitext_parser_profiling_parse(VALUE self, VALUE string)
1035 {
1036     for (int i = 0; i < 100000; i++)
1037         Wikitext_parser_parse(1, &string, self);
1038     return Qnil;
1039 }
1040
1041 VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
1042 {
1043     // process arguments
1044     VALUE string, options;
1045     if (rb_scan_args(argc, argv, "11", &string, &options) == 1) // 1 mandatory argument, 1 optional argument
1046         options = Qnil;
1047     if (NIL_P(string))
1048         return Qnil;
1049     string = StringValue(string);
1050
1051     // process options hash
1052     int base_indent = 0;
1053     int base_heading_level = NUM2INT(rb_iv_get(self, "@base_heading_level"));
1054     if (!NIL_P(options) && TYPE(options) == T_HASH)
1055     {
1056         // :indent => 0 (or more)
1057         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("indent"))) == Qtrue)
1058         {
1059             VALUE indent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));
1060             if (indent == Qfalse)
1061                 base_indent = -1; // indentation disabled
1062             else
1063             {
1064                 base_indent = NUM2INT(indent);
1065                 if (base_indent < 0)
1066                     base_indent = 0;
1067             }
1068         }
1069
1070         // :base_heading_level => 0/1/2/3/4/5/6
1071         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("base_heading_level"))) == Qtrue)
1072             base_heading_level = NUM2INT(rb_hash_aref(options, ID2SYM(rb_intern("base_heading_level"))));
1073     }
1074
1075     // normalize, regardless of whether this came from instance variable or override
1076     if (base_heading_level < 0)
1077         base_heading_level = 0;
1078     if (base_heading_level > 6)
1079         base_heading_level = 6;
1080
1081     // set up scanner
1082     char *p = RSTRING_PTR(string);
1083     long len = RSTRING_LEN(string);
1084     char *pe = p + len;
1085
1086     // access these once per parse
1087     VALUE line_ending   = rb_iv_get(self, "@line_ending");
1088     line_ending         = StringValue(line_ending);
1089     VALUE link_class    = rb_iv_get(self, "@external_link_class");
1090     link_class          = NIL_P(link_class) ? Qnil : StringValue(link_class);
1091     VALUE mailto_class  = rb_iv_get(self, "@mailto_class");
1092     mailto_class        = NIL_P(mailto_class) ? Qnil : StringValue(mailto_class);
1093     VALUE prefix        = rb_iv_get(self, "@internal_link_prefix");
1094
1095     // set up parser struct to make passing parameters a little easier
1096     parser_t *parser                = parser_new();
1097     GC_WRAP_PARSER(parser, parser_gc);
1098     parser->external_link_class     = link_class;
1099     parser->mailto_class            = mailto_class;
1100     parser->img_prefix              = rb_iv_get(self, "@img_prefix");
1101     parser->autolink                = rb_iv_get(self, "@autolink") == Qtrue ? true : false;
1102     parser->space_to_underscore     = rb_iv_get(self, "@space_to_underscore") == Qtrue ? true : false;
1103     parser->line_ending             = str_new_from_string(line_ending);
1104     parser->base_indent             = base_indent;
1105     parser->base_heading_level      = base_heading_level;
1106
1107     // this simple looping design leads to a single enormous function,
1108     // but it's faster than doing actual recursive descent and also secure in the face of
1109     // malicious input that seeks to overflow the stack
1110     // (with "<blockquote><blockquote><blockquote>..." times by 10,000, for example)
1111     // given that we expect to deal with a lot of malformed input, a recursive descent design is less appropriate
1112     // than a straightforward looping translator like this one anyway
1113     token_t _token;
1114     _token.type = NO_TOKEN;
1115     token_t *token = NULL;
1116     do
1117     {
1118         // note that whenever we grab a token we push it into the line buffer
1119         // this provides us with context-sensitive "memory" of what's been seen so far on this line
1120 #define NEXT_TOKEN()    token = &_token, next_token(token, token, NULL, pe), ary_push(parser->line_buffer, token->type)
1121
1122         // check to see if we have a token hanging around from a previous iteration of this loop
1123         if (token == NULL)
1124         {
1125             if (_token.type == NO_TOKEN)
1126             {
1127                 // first time here (haven't started scanning yet)
1128                 token = &_token;
1129                 next_token(token, NULL, p, pe);
1130                 ary_push(parser->line_buffer, token->type);
1131             }
1132             else
1133                 // already scanning
1134                 NEXT_TOKEN();
1135         }
1136         int type = token->type;
1137
1138         // can't declare new variables inside a switch statement, so predeclare them here
1139         long remove_strong          = -1;
1140         long remove_em              = -1;
1141
1142         // general purpose counters, flags and pointers
1143         long i                      = 0;
1144         long j                      = 0;
1145         long k                      = 0;
1146         str_t *output               = NULL;
1147
1148         // The following giant switch statement contains cases for all the possible token types.
1149         // In the most basic sense we are emitting the HTML that corresponds to each token,
1150         // but some tokens require context information in order to decide what to output.
1151         // For example, does the STRONG token (''') translate to <strong> or </strong>?
1152         // So when looking at any given token we have three state-maintaining variables which gives us a notion of "where we are":
1153         //
1154         //  - the "scope" stack (indicates what HTML DOM structures we are currently nested inside, similar to a CSS selector)
1155         //  - the line buffer (records tokens seen so far on the current line)
1156         //  - the line "scope" stack (indicates what the scope should be based only on what is visible on the line so far)
1157         //
1158         // Although this is fairly complicated, there is one key simplifying factor:
1159         // The translator continuously performs auto-correction, and this means that we always have a guarantee that the
1160         // scope stack (up to the current token) is valid; our translator can take this as a given.
1161         // Auto-correction basically consists of inserting missing tokens (preventing subsquent HTML from being messed up),
1162         // or converting illegal (unexpected) tokens to their plain text equivalents (providing visual feedback to Wikitext author).
1163         switch (type)
1164         {
1165             case PRE:
1166                 if (IN(NO_WIKI_START) || IN(PRE_START))
1167                 {
1168                     str_append(parser->output, space, sizeof(space) - 1);
1169                     break;
1170                 }
1171                 else if (IN(BLOCKQUOTE_START))
1172                 {
1173                     // this kind of nesting not allowed (to avoid user confusion)
1174                     _Wikitext_pop_excess_elements(parser);
1175                     _Wikitext_start_para_if_necessary(parser);
1176                     output = parser->capture ? parser->capture : parser->output;
1177                     str_append(output, space, sizeof(space) - 1);
1178                     break;
1179                 }
1180
1181                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1182                 ary_push(parser->line, PRE);
1183                 i = ary_count(parser->line, BLOCKQUOTE);
1184                 j = ary_count(parser->scope, BLOCKQUOTE);
1185                 if (i < j)
1186                 {
1187                     // must pop (reduce nesting level)
1188                     for (i = j - i; i > 0; i--)
1189                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1190                 }
1191
1192                 if (!IN(PRE))
1193                 {
1194                     parser->pending_crlf = false;
1195                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1196                     _Wikitext_indent(parser);
1197                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1198                     ary_push(parser->scope, PRE);
1199                 }
1200                 break;
1201
1202             case PRE_START:
1203                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1204                 {
1205                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1206                     str_append(parser->output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1207                 }
1208                 else if (IN(BLOCKQUOTE_START))
1209                 {
1210                     _Wikitext_rollback_failed_link(parser); // if any
1211                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1212                     _Wikitext_indent(parser);
1213                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1214                     ary_push(parser->scope, PRE_START);
1215                     ary_push(parser->line, PRE_START);
1216                 }
1217                 else if (IN(BLOCKQUOTE))
1218                 {
1219                     if (token->column_start == 1) // only allowed in first column
1220                     {
1221                         _Wikitext_rollback_failed_link(parser); // if any
1222                         _Wikitext_pop_all_from_stack(parser);
1223                         _Wikitext_indent(parser);
1224                         str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1225                         ary_push(parser->scope, PRE_START);
1226                         ary_push(parser->line, PRE_START);
1227                     }
1228                     else // PRE_START illegal here
1229                     {
1230                         output = parser->capture ? parser->capture : parser->output;
1231                         _Wikitext_pop_excess_elements(parser);
1232                         _Wikitext_start_para_if_necessary(parser);
1233                         str_append(output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1234                     }
1235                 }
1236                 else
1237                 {
1238                     _Wikitext_rollback_failed_link(parser); // if any
1239                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1240                     _Wikitext_indent(parser);
1241                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1242                     ary_push(parser->scope, PRE_START);
1243                     ary_push(parser->line, PRE_START);
1244                 }
1245                 break;
1246
1247             case PRE_END:
1248                 if (IN(NO_WIKI_START) || IN(PRE))
1249                 {
1250                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1251                     str_append(parser->output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1252                 }
1253                 else
1254                 {
1255                     if (IN(PRE_START))
1256                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE_START, true);
1257                     else
1258                     {
1259                         output = parser->capture ? parser->capture : parser->output;
1260                         _Wikitext_pop_excess_elements(parser);
1261                         _Wikitext_start_para_if_necessary(parser);
1262                         str_append(output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1263                     }
1264                 }
1265                 break;
1266
1267             case BLOCKQUOTE:
1268                 if (IN(NO_WIKI_START) || IN(PRE_START))
1269                     // no need to check for <pre>; can never appear inside it
1270                     str_append(parser->output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1271                 else if (IN(BLOCKQUOTE_START))
1272                 {
1273                     // this kind of nesting not allowed (to avoid user confusion)
1274                     _Wikitext_pop_excess_elements(parser);
1275                     _Wikitext_start_para_if_necessary(parser);
1276                     output = parser->capture ? parser->capture : parser->output;
1277                     str_append(output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1278                     break;
1279                 }
1280                 else
1281                 {
1282                     ary_push(parser->line, BLOCKQUOTE);
1283
1284                     // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1285                     i = ary_count(parser->line, BLOCKQUOTE);
1286                     j = ary_count(parser->scope, BLOCKQUOTE);
1287
1288                     // given that BLOCKQUOTE tokens can be nested, peek ahead and see if there are any more which might affect the decision to push or pop
1289                     while (NEXT_TOKEN(), (token->type == BLOCKQUOTE))
1290                     {
1291                         ary_push(parser->line, BLOCKQUOTE);
1292                         i++;
1293                     }
1294
1295                     // now decide whether to push, pop or do nothing
1296                     if (i > j)
1297                     {
1298                         // must push (increase nesting level)
1299                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1300                         for (i = i - j; i > 0; i--)
1301                         {
1302                             _Wikitext_indent(parser);
1303                             str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1304                             str_append_str(parser->output, parser->line_ending);
1305                             ary_push(parser->scope, BLOCKQUOTE);
1306                         }
1307                     }
1308                     else if (i < j)
1309                     {
1310                         // must pop (reduce nesting level)
1311                         for (i = j - i; i > 0; i--)
1312                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1313                     }
1314
1315                     // jump to top of the loop to process token we scanned during lookahead
1316                     continue;
1317                 }
1318                 break;
1319
1320             case BLOCKQUOTE_START:
1321                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1322                 {
1323                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1324                     str_append(parser->output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1325                 }
1326                 else if (IN(BLOCKQUOTE_START))
1327                 {
1328                     // nesting is fine here
1329                     _Wikitext_rollback_failed_link(parser); // if any
1330                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1331                     _Wikitext_indent(parser);
1332                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1333                     str_append_str(parser->output, parser->line_ending);
1334                     ary_push(parser->scope, BLOCKQUOTE_START);
1335                     ary_push(parser->line, BLOCKQUOTE_START);
1336                 }
1337                 else if (IN(BLOCKQUOTE))
1338                 {
1339                     if (token->column_start == 1) // only allowed in first column
1340                     {
1341                         _Wikitext_rollback_failed_link(parser); // if any
1342                         _Wikitext_pop_all_from_stack(parser);
1343                         _Wikitext_indent(parser);
1344                         str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1345                         str_append_str(parser->output, parser->line_ending);
1346                         ary_push(parser->scope, BLOCKQUOTE_START);
1347                         ary_push(parser->line, BLOCKQUOTE_START);
1348                     }
1349                     else // BLOCKQUOTE_START illegal here
1350                     {
1351                         output = parser->capture ? parser->capture : parser->output;
1352                         _Wikitext_pop_excess_elements(parser);
1353                         _Wikitext_start_para_if_necessary(parser);
1354                         str_append(output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1355                     }
1356                 }
1357                 else
1358                 {
1359                     // would be nice to eliminate the repetition here but it's probably the clearest way
1360                     _Wikitext_rollback_failed_link(parser); // if any
1361                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1362                     _Wikitext_indent(parser);
1363                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1364                     str_append_str(parser->output, parser->line_ending);
1365                     ary_push(parser->scope, BLOCKQUOTE_START);
1366                     ary_push(parser->line, BLOCKQUOTE_START);
1367                 }
1368                 break;
1369
1370             case BLOCKQUOTE_END:
1371                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1372                 {
1373                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1374                     str_append(parser->output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1375                 }
1376                 else
1377                 {
1378                     if (IN(BLOCKQUOTE_START))
1379                         _Wikitext_pop_from_stack_up_to(parser, parser->output, BLOCKQUOTE_START, true);
1380                     else
1381                     {
1382                         output = parser->capture ? parser->capture : parser->output;
1383                         _Wikitext_pop_excess_elements(parser);
1384                         _Wikitext_start_para_if_necessary(parser);
1385                         str_append(output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1386                     }
1387                 }
1388                 break;
1389
1390             case NO_WIKI_START:
1391                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1392                 {
1393                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1394                     str_append(parser->output, escaped_no_wiki_start, sizeof(escaped_no_wiki_start) - 1);
1395                 }
1396                 else
1397                 {
1398                     _Wikitext_pop_excess_elements(parser);
1399                     _Wikitext_start_para_if_necessary(parser);
1400                     ary_push(parser->scope, NO_WIKI_START);
1401                     ary_push(parser->line, NO_WIKI_START);
1402                 }
1403                 break;
1404
1405             case NO_WIKI_END:
1406                 if (IN(NO_WIKI_START))
1407                     // <nowiki> should always only ever be the last item in the stack, but use the helper routine just in case
1408                     _Wikitext_pop_from_stack_up_to(parser, NULL, NO_WIKI_START, true);
1409                 else
1410                 {
1411                     _Wikitext_pop_excess_elements(parser);
1412                     _Wikitext_start_para_if_necessary(parser);
1413                     str_append(parser->output, escaped_no_wiki_end, sizeof(escaped_no_wiki_end) - 1);
1414                 }
1415                 break;
1416
1417             case STRONG_EM:
1418                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1419                 {
1420                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1421                     str_append(parser->output, literal_strong_em, sizeof(literal_strong_em) - 1);
1422                     break;
1423                 }
1424
1425                 output = parser->capture ? parser->capture : parser->output;
1426                 _Wikitext_pop_excess_elements(parser);
1427
1428                 // if you've seen STRONG/STRONG_START or EM/EM_START, must close them in the reverse order that you saw them!
1429                 // otherwise, must open them
1430                 remove_strong  = -1;
1431                 remove_em      = -1;
1432                 j              = parser->scope->count;
1433                 for (j = j - 1; j >= 0; j--)
1434                 {
1435                     int val = ary_entry(parser->scope, j);
1436                     if (val == STRONG || val == STRONG_START)
1437                     {
1438                         str_append(output, strong_end, sizeof(strong_end) - 1);
1439                         remove_strong = j;
1440                     }
1441                     else if (val == EM || val == EM_START)
1442                     {
1443                         str_append(output, em_end, sizeof(em_end) - 1);
1444                         remove_em = j;
1445                     }
1446                 }
1447
1448                 if (remove_strong > remove_em)      // must remove strong first
1449                 {
1450                     ary_pop(parser->scope);
1451                     if (remove_em > -1)
1452                         ary_pop(parser->scope);
1453                     else    // there was no em to remove!, so consider this an opening em tag
1454                     {
1455                         str_append(output, em_start, sizeof(em_start) - 1);
1456                         ary_push(parser->scope, EM);
1457                         ary_push(parser->line, EM);
1458                     }
1459                 }
1460                 else if (remove_em > remove_strong) // must remove em first
1461                 {
1462                     ary_pop(parser->scope);
1463                     if (remove_strong > -1)
1464                         ary_pop(parser->scope);
1465                     else    // there was no strong to remove!, so consider this an opening strong tag
1466                     {
1467                         str_append(output, strong_start, sizeof(strong_start) - 1);
1468                         ary_push(parser->scope, STRONG);
1469                         ary_push(parser->line, STRONG);
1470                     }
1471                 }
1472                 else    // no strong or em to remove, so this must be a new opening of both
1473                 {
1474                     _Wikitext_start_para_if_necessary(parser);
1475                     str_append(output, strong_em_start, sizeof(strong_em_start) - 1);
1476                     ary_push(parser->scope, STRONG);
1477                     ary_push(parser->line, STRONG);
1478                     ary_push(parser->scope, EM);
1479                     ary_push(parser->line, EM);
1480                 }
1481                 break;
1482
1483             case STRONG:
1484                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1485                 {
1486                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1487                     str_append(parser->output, literal_strong, sizeof(literal_strong) - 1);
1488                 }
1489                 else
1490                 {
1491                     output = parser->capture ? parser->capture : parser->output;
1492                     if (IN(STRONG_START))
1493                         // already in span started with <strong>, no choice but to emit this literally
1494                         str_append(output, literal_strong, sizeof(literal_strong) - 1);
1495                     else if (IN(STRONG))
1496                         // STRONG already seen, this is a closing tag
1497                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG, true);
1498                     else
1499                     {
1500                         // this is a new opening
1501                         _Wikitext_pop_excess_elements(parser);
1502                         _Wikitext_start_para_if_necessary(parser);
1503                         str_append(output, strong_start, sizeof(strong_start) - 1);
1504                         ary_push(parser->scope, STRONG);
1505                         ary_push(parser->line, STRONG);
1506                     }
1507                 }
1508                 break;
1509
1510             case STRONG_START:
1511                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1512                 {
1513                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1514                     str_append(parser->output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1515                 }
1516                 else
1517                 {
1518                     output = parser->capture ? parser->capture : parser->output;
1519                     if (IN(STRONG_START) || IN(STRONG))
1520                         str_append(output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1521                     else
1522                     {
1523                         _Wikitext_pop_excess_elements(parser);
1524                         _Wikitext_start_para_if_necessary(parser);
1525                         str_append(output, strong_start, sizeof(strong_start) - 1);
1526                         ary_push(parser->scope, STRONG_START);
1527                         ary_push(parser->line, STRONG_START);
1528                     }
1529                 }
1530                 break;
1531
1532             case STRONG_END:
1533                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1534                 {
1535                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1536                     str_append(parser->output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1537                 }
1538                 else
1539                 {
1540                     output = parser->capture ? parser->capture : parser->output;
1541                     if (IN(STRONG_START))
1542                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG_START, true);
1543                     else
1544                     {
1545                         // no STRONG_START in scope, so must interpret the STRONG_END without any special meaning
1546                         _Wikitext_pop_excess_elements(parser);
1547                         _Wikitext_start_para_if_necessary(parser);
1548                         str_append(output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1549                     }
1550                 }
1551                 break;
1552
1553             case EM:
1554                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1555                 {
1556                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1557                     str_append(parser->output, literal_em, sizeof(literal_em) - 1);
1558                 }
1559                 else
1560                 {
1561                     output = parser->capture ? parser->capture : parser->output;
1562                     if (IN(EM_START))
1563                         // already in span started with <em>, no choice but to emit this literally
1564                         str_append(output, literal_em, sizeof(literal_em) - 1);
1565                     else if (IN(EM))
1566                         // EM already seen, this is a closing tag
1567                         _Wikitext_pop_from_stack_up_to(parser, output, EM, true);
1568                     else
1569                     {
1570                         // this is a new opening
1571                         _Wikitext_pop_excess_elements(parser);
1572                         _Wikitext_start_para_if_necessary(parser);
1573                         str_append(output, em_start, sizeof(em_start) - 1);
1574                         ary_push(parser->scope, EM);
1575                         ary_push(parser->line, EM);
1576                     }
1577                 }
1578                 break;
1579
1580             case EM_START:
1581                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1582                 {
1583                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1584                     str_append(parser->output, escaped_em_start, sizeof(escaped_em_start) - 1);
1585                 }
1586                 else
1587                 {
1588                     output = parser->capture ? parser->capture : parser->output;
1589                     if (IN(EM_START) || IN(EM))
1590                         str_append(output, escaped_em_start, sizeof(escaped_em_start) - 1);
1591                     else
1592                     {
1593                         _Wikitext_pop_excess_elements(parser);
1594                         _Wikitext_start_para_if_necessary(parser);
1595                         str_append(output, em_start, sizeof(em_start) - 1);
1596                         ary_push(parser->scope, EM_START);
1597                         ary_push(parser->line, EM_START);
1598                     }
1599                 }
1600                 break;
1601
1602             case EM_END:
1603                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1604                 {
1605                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1606                     str_append(parser->output, escaped_em_end, sizeof(escaped_em_end) - 1);
1607                 }
1608                 else
1609                 {
1610                     output = parser->capture ? parser->capture : parser->output;
1611                     if (IN(EM_START))
1612                         _Wikitext_pop_from_stack_up_to(parser, output, EM_START, true);
1613                     else
1614                     {
1615                         // no EM_START in scope, so must interpret the TT_END without any special meaning
1616                         _Wikitext_pop_excess_elements(parser);
1617                         _Wikitext_start_para_if_necessary(parser);
1618                         str_append(output, escaped_em_end, sizeof(escaped_em_end) - 1);
1619                     }
1620                 }
1621                 break;
1622
1623             case TT:
1624                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1625                 {
1626                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1627                     str_append(parser->output, backtick, sizeof(backtick) - 1);
1628                 }
1629                 else
1630                 {
1631                     output = parser->capture ? parser->capture : parser->output;
1632                     if (IN(TT_START))
1633                         // already in span started with <tt>, no choice but to emit this literally
1634                         str_append(output, backtick, sizeof(backtick) - 1);
1635                     else if (IN(TT))
1636                         // TT (`) already seen, this is a closing tag
1637                         _Wikitext_pop_from_stack_up_to(parser, output, TT, true);
1638                     else
1639                     {
1640                         // this is a new opening
1641                         _Wikitext_pop_excess_elements(parser);
1642                         _Wikitext_start_para_if_necessary(parser);
1643                         str_append(output, tt_start, sizeof(tt_start) - 1);
1644                         ary_push(parser->scope, TT);
1645                         ary_push(parser->line, TT);
1646                     }
1647                 }
1648                 break;
1649
1650             case TT_START:
1651                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1652                 {
1653                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1654                     str_append(parser->output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1655                 }
1656                 else
1657                 {
1658                     output = parser->capture ? parser->capture : parser->output;
1659                     if (IN(TT_START) || IN(TT))
1660                         str_append(output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1661                     else
1662                     {
1663                         _Wikitext_pop_excess_elements(parser);
1664                         _Wikitext_start_para_if_necessary(parser);
1665                         str_append(output, tt_start, sizeof(tt_start) - 1);
1666                         ary_push(parser->scope, TT_START);
1667                         ary_push(parser->line, TT_START);
1668                     }
1669                 }
1670                 break;
1671
1672             case TT_END:
1673                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1674                 {
1675                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1676                     str_append(parser->output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1677                 }
1678                 else
1679                 {
1680                     output = parser->capture ? parser->capture : parser->output;
1681                     if (IN(TT_START))
1682                         _Wikitext_pop_from_stack_up_to(parser, output, TT_START, true);
1683                     else
1684                     {
1685                         // no TT_START in scope, so must interpret the TT_END without any special meaning
1686                         _Wikitext_pop_excess_elements(parser);
1687                         _Wikitext_start_para_if_necessary(parser);
1688                         str_append(output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1689                     }
1690                 }
1691                 break;
1692
1693             case OL:
1694             case UL:
1695                 if (IN(NO_WIKI_START) || IN(PRE_START))
1696                 {
1697                     // no need to check for PRE; can never appear inside it
1698                     str_append(parser->output, token->start, TOKEN_LEN(token));
1699                     break;
1700                 }
1701
1702                 // count number of tokens in line and scope stacks
1703                 int bq_count = ary_count(parser->scope, BLOCKQUOTE_START);
1704                 i = parser->line->count - ary_count(parser->line, BLOCKQUOTE_START);
1705                 j = parser->scope->count - bq_count;
1706                 k = i;
1707
1708                 // list tokens can be nested so look ahead for any more which might affect the decision to push or pop
1709                 for (;;)
1710                 {
1711                     type = token->type;
1712                     if (type == OL || type == UL)
1713                     {
1714                         token = NULL;
1715                         if (i - k >= 2)                             // already seen at least one OL or UL
1716                         {
1717                             ary_push(parser->line, NESTED_LIST);    // which means this is a nested list
1718                             i += 3;
1719                         }
1720                         else
1721                             i += 2;
1722                         ary_push(parser->line, type);
1723                         ary_push(parser->line, LI);
1724
1725                         // want to compare line with scope but can only do so if scope has enough items on it
1726                         if (j >= i)
1727                         {
1728                             if (ary_entry(parser->scope, i + bq_count - 2) == type &&
1729                                 ary_entry(parser->scope, i + bq_count - 1) == LI)
1730                             {
1731                                 // line and scope match at this point: do nothing yet
1732                             }
1733                             else
1734                             {
1735                                 // item just pushed onto line does not match corresponding slot of scope!
1736                                 for (; j >= i - 2; j--)
1737                                     // must pop back before emitting
1738                                     _Wikitext_pop_from_stack(parser, NULL);
1739
1740                                 // will emit UL or OL, then LI
1741                                 break;
1742                             }
1743                         }
1744                         else        // line stack size now exceeds scope stack size: must increase nesting level
1745                             break;  // will emit UL or OL, then LI
1746                     }
1747                     else
1748                     {
1749                         // not a OL or UL token!
1750                         if (j == i)
1751                             // must close existing LI and re-open new one
1752                             _Wikitext_pop_from_stack(parser, NULL);
1753                         else if (j > i)
1754                         {
1755                             // item just pushed onto line does not match corresponding slot of scope!
1756                             for (; j >= i; j--)
1757                                 // must pop back before emitting
1758                                 _Wikitext_pop_from_stack(parser, NULL);
1759                         }
1760                         break;
1761                     }
1762                     NEXT_TOKEN();
1763                 }
1764
1765                 // will emit
1766                 if (type == OL || type == UL)
1767                 {
1768                     // if LI is at the top of a stack this is the start of a nested list
1769                     if (j > 0 && ary_entry(parser->scope, -1) == LI)
1770                     {
1771                         // so we should precede it with a CRLF, and indicate that it's a nested list
1772                         str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1773                         ary_push(parser->scope, NESTED_LIST);
1774                     }
1775                     else
1776                     {
1777                         // this is a new list
1778                         if (IN(BLOCKQUOTE_START))
1779                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1780                         else
1781                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1782                     }
1783
1784                     // emit
1785                     _Wikitext_indent(parser);
1786                     if (type == OL)
1787                         str_append(parser->output, ol_start, sizeof(ol_start) - 1);
1788                     else if (type == UL)
1789                         str_append(parser->output, ul_start, sizeof(ul_start) - 1);
1790                     ary_push(parser->scope, type);
1791                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1792                 }
1793                 else if (type == SPACE)
1794                     // silently throw away the optional SPACE token after final list marker
1795                     token = NULL;
1796
1797                 _Wikitext_indent(parser);
1798                 str_append(parser->output, li_start, sizeof(li_start) - 1);
1799                 ary_push(parser->scope, LI);
1800
1801                 // any subsequent UL or OL tokens on this line are syntax errors and must be emitted literally
1802                 if (type == OL || type == UL)
1803                 {
1804                     k = 0;
1805                     while (k++, NEXT_TOKEN(), (type = token->type))
1806                     {
1807                         if (type == OL || type == UL)
1808                             str_append(parser->output, token->start, TOKEN_LEN(token));
1809                         else if (type == SPACE && k == 1)
1810                         {
1811                             // silently throw away the optional SPACE token after final list marker
1812                             token = NULL;
1813                             break;
1814                         }
1815                         else
1816                             break;
1817                     }
1818                 }
1819
1820                 // jump to top of the loop to process token we scanned during lookahead
1821                 continue;
1822
1823             case H6_START:
1824             case H5_START:
1825             case H4_START:
1826             case H3_START:
1827             case H2_START:
1828             case H1_START:
1829                 if (IN(NO_WIKI_START) || IN(PRE_START))
1830                 {
1831                     // no need to check for PRE; can never appear inside it
1832                     str_append(parser->output, token->start, TOKEN_LEN(token));
1833                     break;
1834                 }
1835
1836                 // pop up to but not including the last BLOCKQUOTE on the scope stack
1837                 if (IN(BLOCKQUOTE_START))
1838                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1839                 else
1840                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1841
1842                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1843                 ary_push(parser->line, type);
1844                 i = ary_count(parser->line, BLOCKQUOTE);
1845                 j = ary_count(parser->scope, BLOCKQUOTE);
1846
1847                 // decide whether we need to pop off excess BLOCKQUOTE tokens (will never need to push; that is handled above in the BLOCKQUOTE case itself)
1848                 if (i < j)
1849                 {
1850                     // must pop (reduce nesting level)
1851                     for (i = j - i; i > 0; i--)
1852                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1853                 }
1854
1855                 // discard any whitespace here (so that "== foo ==" will be translated to "<h2>foo</h2>" rather than "<h2> foo </h2")
1856                 while (NEXT_TOKEN(), (token->type == SPACE))
1857                     ; // discard
1858
1859                 ary_push(parser->scope, type);
1860                 _Wikitext_indent(parser);
1861
1862                 // take base_heading_level into account
1863                 type += base_heading_level;
1864                 if (type > H6_START) // no need to check for underflow (base_heading_level never negative)
1865                     type = H6_START;
1866
1867                 // rather than repeat all that code for each kind of heading, share it and use a conditional here
1868                 if (type == H6_START)
1869                     str_append(parser->output, h6_start, sizeof(h6_start) - 1);
1870                 else if (type == H5_START)
1871                     str_append(parser->output, h5_start, sizeof(h5_start) - 1);
1872                 else if (type == H4_START)
1873                     str_append(parser->output, h4_start, sizeof(h4_start) - 1);
1874                 else if (type == H3_START)
1875                     str_append(parser->output, h3_start, sizeof(h3_start) - 1);
1876                 else if (type == H2_START)
1877                     str_append(parser->output, h2_start, sizeof(h2_start) - 1);
1878                 else if (type == H1_START)
1879                     str_append(parser->output, h1_start, sizeof(h1_start) - 1);
1880
1881                 // jump to top of the loop to process token we scanned during lookahead
1882                 continue;
1883
1884             case H6_END:
1885                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1886                 {
1887                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1888                     str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1889                 }
1890                 else
1891                 {
1892                     _Wikitext_rollback_failed_external_link(parser); // if any
1893                     if (!IN(H6_START))
1894                     {
1895                         // literal output only if not in h6 scope (we stay silent in that case)
1896                         _Wikitext_start_para_if_necessary(parser);
1897                         str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1898                     }
1899                 }
1900                 break;
1901
1902             case H5_END:
1903                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1904                 {
1905                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1906                     str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1907                 }
1908                 else
1909                 {
1910                     _Wikitext_rollback_failed_external_link(parser); // if any
1911                     if (!IN(H5_START))
1912                     {
1913                         // literal output only if not in h5 scope (we stay silent in that case)
1914                         _Wikitext_start_para_if_necessary(parser);
1915                         str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1916                     }
1917                 }
1918                 break;
1919
1920             case H4_END:
1921                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1922                 {
1923                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1924                     str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1925                 }
1926                 else
1927                 {
1928                     _Wikitext_rollback_failed_external_link(parser); // if any
1929                     if (!IN(H4_START))
1930                     {
1931                         // literal output only if not in h4 scope (we stay silent in that case)
1932                         _Wikitext_start_para_if_necessary(parser);
1933                         str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1934                     }
1935                 }
1936                 break;
1937
1938             case H3_END:
1939                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1940                 {
1941                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1942                     str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1943                 }
1944                 else
1945                 {
1946                     _Wikitext_rollback_failed_external_link(parser); // if any
1947                     if (!IN(H3_START))
1948                     {
1949                         // literal output only if not in h3 scope (we stay silent in that case)
1950                         _Wikitext_start_para_if_necessary(parser);
1951                         str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1952                     }
1953                 }
1954                 break;
1955
1956             case H2_END:
1957                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1958                 {
1959                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1960                     str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
1961                 }
1962                 else
1963                 {
1964                     _Wikitext_rollback_failed_external_link(parser); // if any
1965                     if (!IN(H2_START))
1966                     {
1967                         // literal output only if not in h2 scope (we stay silent in that case)
1968                         _Wikitext_start_para_if_necessary(parser);
1969                         str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
1970                     }
1971                 }
1972                 break;
1973
1974             case H1_END:
1975                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1976                 {
1977                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1978                     str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
1979                 }
1980                 else
1981                 {
1982                     _Wikitext_rollback_failed_external_link(parser); // if any
1983                     if (!IN(H1_START))
1984                     {
1985                         // literal output only if not in h1 scope (we stay silent in that case)
1986                         _Wikitext_start_para_if_necessary(parser);
1987                         str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
1988                     }
1989                 }
1990                 break;
1991
1992             case MAIL:
1993                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1994                 {
1995                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1996                     str_append(parser->output, token->start, TOKEN_LEN(token));
1997                 }
1998                 else
1999                 {
2000                     _Wikitext_pop_excess_elements(parser);
2001                     _Wikitext_start_para_if_necessary(parser);
2002                     _Wikitext_append_hyperlink(parser, rb_str_new2("mailto:"), TOKEN_TEXT(token), Qnil, mailto_class, true);
2003                 }
2004                 break;
2005
2006             case URI:
2007                 if (IN(NO_WIKI_START))
2008                     // user can temporarily suppress autolinking by using <nowiki></nowiki>
2009                     // note that unlike MediaWiki, we do allow autolinking inside PRE blocks
2010                     str_append(parser->output, token->start, TOKEN_LEN(token));
2011                 else if (IN(LINK_START))
2012                 {
2013                     // if the URI were allowed it would have been handled already in LINK_START
2014                     _Wikitext_rollback_failed_internal_link(parser);
2015                     _Wikitext_append_hyperlink(parser, Qnil, TOKEN_TEXT(token), Qnil, parser->external_link_class, true);
2016                 }
2017                 else if (IN(EXT_LINK_START))
2018                 {
2019                     if (parser->link_target->len == 0)
2020                     {
2021                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2022                         i = TOKEN_TEXT(token);
2023                         NEXT_TOKEN();
2024                         if (token->type == SPACE)
2025                         {
2026                             ary_push(parser->scope, SPACE);
2027                             str_append_string(parser->link_target, i);
2028                             str_clear(parser->link_text);
2029                             parser->capture     = parser->link_text;
2030                             token               = NULL; // silently consume space
2031                         }
2032                         else
2033                         {
2034                             // didn't see the space! this must be an error
2035                             _Wikitext_pop_from_stack(parser, NULL);
2036                             _Wikitext_pop_excess_elements(parser);
2037                             _Wikitext_start_para_if_necessary(parser);
2038                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2039                             _Wikitext_append_hyperlink(parser, Qnil, i, Qnil, parser->external_link_class, true);
2040                         }
2041                     }
2042                     else
2043                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2044                 }
2045                 else
2046                 {
2047                     _Wikitext_pop_excess_elements(parser);
2048                     _Wikitext_start_para_if_necessary(parser);
2049                     _Wikitext_append_hyperlink(parser, Qnil, TOKEN_TEXT(token), Qnil, parser->external_link_class, true);
2050                 }
2051                 break;
2052
2053             case PATH:
2054                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2055                     str_append(parser->output, token->start, TOKEN_LEN(token));
2056                 else if (IN(EXT_LINK_START))
2057                 {
2058                     if (parser->link_target->len == 0)
2059                     {
2060                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2061                         i = TOKEN_TEXT(token);
2062                         NEXT_TOKEN();
2063                         if (token->type == SPACE)
2064                         {
2065                             ary_push(parser->scope, PATH);
2066                             ary_push(parser->scope, SPACE);
2067                             str_append_string(parser->link_target, i);
2068                             str_clear(parser->link_text);
2069                             parser->capture     = parser->link_text;
2070                             token               = NULL; // silently consume space
2071                         }
2072                         else
2073                         {
2074                             // didn't see the space! this must be an error
2075                             _Wikitext_pop_from_stack(parser, NULL);
2076                             _Wikitext_pop_excess_elements(parser);
2077                             _Wikitext_start_para_if_necessary(parser);
2078                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2079                             str_append_string(parser->output, i);
2080                         }
2081                     }
2082                     else
2083                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2084                 }
2085                 else
2086                 {
2087                     output = parser->capture ? parser->capture : parser->output;
2088                     _Wikitext_pop_excess_elements(parser);
2089                     _Wikitext_start_para_if_necessary(parser);
2090                     str_append(output, token->start, TOKEN_LEN(token));
2091                 }
2092                 break;
2093
2094             // internal links (links to other wiki articles) look like this:
2095             //      [[another article]] (would point at, for example, "/wiki/another_article")
2096             //      [[the other article|the link text we'll use for it]]
2097             //      [[the other article | the link text we'll use for it]]
2098             // MediaWiki has strict requirements about what it will accept as a link target:
2099             //      all wikitext markup is disallowed:
2100             //          example [[foo ''bar'' baz]]
2101             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2102             //          example [[foo <em>bar</em> baz]]
2103             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2104             //          example [[foo <nowiki>''</nowiki> baz]]
2105             //          renders [[foo '' baz]]                  (ie. not a link)
2106             //          example [[foo <bar> baz]]
2107             //          renders [[foo &lt;bar&gt; baz]]         (ie. not a link)
2108             //      HTML entities and non-ASCII, however, make it through:
2109             //          example [[foo &euro;]]
2110             //          renders <a href="/wiki/Foo_%E2%82%AC">foo &euro;</a>
2111             //          example [[foo €]]
2112             //          renders <a href="/wiki/Foo_%E2%82%AC">foo €</a>
2113             // we'll impose similar restrictions here for the link target; allowed tokens will be:
2114             //      SPACE, SPECIAL_URI_CHARS, PRINTABLE, PATH, ALNUM, DEFAULT, QUOT and AMP
2115             // everything else will be rejected
2116             case LINK_START:
2117                 output = parser->capture ? parser->capture : parser->output;
2118                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2119                 {
2120                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2121                     str_append(output, link_start, sizeof(link_start) - 1);
2122                 }
2123                 else if (IN(EXT_LINK_START))
2124                     // already in external link scope! (and in fact, must be capturing link_text right now)
2125                     str_append(output, link_start, sizeof(link_start) - 1);
2126                 else if (IN(LINK_START))
2127                 {
2128                     // already in internal link scope! this is a syntax error
2129                     _Wikitext_rollback_failed_internal_link(parser);
2130                     str_append(parser->output, link_start, sizeof(link_start) - 1);
2131                 }
2132                 else if (IN(SEPARATOR))
2133                 {
2134                     // scanning internal link text
2135                 }
2136                 else // not in internal link scope yet
2137                 {
2138                     // will either emit a link, or the rollback of a failed link, so start the para now
2139                     _Wikitext_pop_excess_elements(parser);
2140                     _Wikitext_start_para_if_necessary(parser);
2141                     ary_push(parser->scope, LINK_START);
2142
2143                     // look ahead and try to gobble up link target
2144                     while (NEXT_TOKEN(), (type = token->type))
2145                     {
2146                         if (type == SPACE               ||
2147                             type == SPECIAL_URI_CHARS   ||
2148                             type == PATH                ||
2149                             type == PRINTABLE           ||
2150                             type == ALNUM               ||
2151                             type == DEFAULT             ||
2152                             type == QUOT                ||
2153                             type == QUOT_ENTITY         ||
2154                             type == AMP                 ||
2155                             type == AMP_ENTITY          ||
2156                             type == IMG_START           ||
2157                             type == IMG_END             ||
2158                             type == LEFT_CURLY          ||
2159                             type == RIGHT_CURLY)
2160                         {
2161                             // accumulate these tokens into link_target
2162                             if (parser->link_target->len == 0)
2163                             {
2164                                 str_clear(parser->link_target);
2165                                 parser->capture = parser->link_target;
2166                             }
2167                             if (type == QUOT_ENTITY)
2168                                 // don't insert the entity, insert the literal quote
2169                                 str_append(parser->link_target, quote, sizeof(quote) - 1);
2170                             else if (type == AMP_ENTITY)
2171                                 // don't insert the entity, insert the literal ampersand
2172                                 str_append(parser->link_target, ampersand, sizeof(ampersand) - 1);
2173                             else
2174                                 str_append(parser->link_target, token->start, TOKEN_LEN(token));
2175                         }
2176                         else if (type == LINK_END)
2177                         {
2178                             if (parser->link_target->len == 0) // bail for inputs like "[[]]"
2179                                 _Wikitext_rollback_failed_internal_link(parser);
2180                             break; // jump back to top of loop (will handle this in LINK_END case below)
2181                         }
2182                         else if (type == SEPARATOR)
2183                         {
2184                             if (parser->link_target->len == 0) // bail for inputs like "[[|"
2185                                 _Wikitext_rollback_failed_internal_link(parser);
2186                             else
2187                             {
2188                                 ary_push(parser->scope, SEPARATOR);
2189                                 str_clear(parser->link_text);
2190                                 parser->capture     = parser->link_text;
2191                                 token               = NULL;
2192                             }
2193                             break;
2194                         }
2195                         else // unexpected token (syntax error)
2196                         {
2197                             _Wikitext_rollback_failed_internal_link(parser);
2198                             break; // jump back to top of loop to handle unexpected token
2199                         }
2200                     }
2201
2202                     // jump to top of the loop to process token we scanned during lookahead (if any)
2203                     continue;
2204                 }
2205                 break;
2206
2207             case LINK_END:
2208                 output = parser->capture ? parser->capture : parser->output;
2209                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2210                 {
2211                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2212                     str_append(output, link_end, sizeof(link_end) - 1);
2213                 }
2214                 else if (IN(EXT_LINK_START))
2215                     // already in external link scope! (and in fact, must be capturing link_text right now)
2216                     str_append(output, link_end, sizeof(link_end) - 1);
2217                 else if (IN(LINK_START)) // in internal link scope!
2218                 {
2219                     if (_Wikitext_blank(parser->link_target))
2220                     {
2221                         // special case for inputs like "[[    ]]"
2222                         _Wikitext_rollback_failed_internal_link(parser);
2223                         str_append(parser->output, link_end, sizeof(link_end) - 1);
2224                         break;
2225                     }
2226                     if (parser->link_text->len == 0 ||
2227                         _Wikitext_blank(parser->link_text))
2228                     {
2229                         // use link target as link text
2230                         str_clear(parser->link_text);
2231                         str_append_string(parser->link_text, _Wikitext_parser_sanitize_link_target(parser, false));
2232                     }
2233                     else
2234                         _Wikitext_parser_trim_link_text(parser);
2235                     _Wikitext_parser_encode_link_target(parser);
2236                     _Wikitext_pop_from_stack_up_to(parser, output, LINK_START, true);
2237                     parser->capture = NULL;
2238                     _Wikitext_append_hyperlink(parser, prefix, string_from_str(parser->link_target), string_from_str(parser->link_text), Qnil, false);
2239                     str_clear(parser->link_target);
2240                     str_clear(parser->link_text);
2241                 }
2242                 else // wasn't in internal link scope
2243                 {
2244                     _Wikitext_pop_excess_elements(parser);
2245                     _Wikitext_start_para_if_necessary(parser);
2246                     str_append(output, link_end, sizeof(link_end) - 1);
2247                 }
2248                 break;
2249
2250             // external links look like this:
2251             //      [http://google.com/ the link text]
2252             //      [/other/page/on/site see this page]
2253             // strings in square brackets which don't match this syntax get passed through literally; eg:
2254             //      he was very angery [sic] about the turn of events
2255             case EXT_LINK_START:
2256                 output = parser->capture ? parser->capture : parser->output;
2257                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2258                 {
2259                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2260                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2261                 }
2262                 else if (IN(EXT_LINK_START))
2263                     // already in external link scope! (and in fact, must be capturing link_text right now)
2264                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2265                 else if (IN(LINK_START))
2266                 {
2267                     // already in internal link scope!
2268                     if (parser->link_target->len == 0)
2269                         // this must be the first character of our link target
2270                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2271                     else if (IN(SPACE))
2272                         // link target has already been scanned
2273                         str_append(parser->link_text, ext_link_start, sizeof(ext_link_start) - 1);
2274                     else
2275                         // TODO: possibly roll this condition into the above
2276                         // add to existing link target
2277                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2278                 }
2279                 else // not in external link scope yet
2280                 {
2281                     // will either emit a link, or the rollback of a failed link, so start the para now
2282                     _Wikitext_pop_excess_elements(parser);
2283                     _Wikitext_start_para_if_necessary(parser);
2284
2285                     // look ahead: expect an absolute URI (with protocol) or "relative" (path) URI
2286                     NEXT_TOKEN();
2287                     if (token->type == URI || token->type == PATH)
2288                         ary_push(parser->scope, EXT_LINK_START);    // so far so good, jump back to the top of the loop
2289                     else
2290                         // only get here if there was a syntax error (missing URI)
2291                         str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2292                     continue; // jump back to top of loop to handle token (either URI or whatever it is)
2293                 }
2294                 break;
2295
2296             case EXT_LINK_END:
2297                 output = parser->capture ? parser->capture : parser->output;
2298                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2299                 {
2300                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2301                     str_append(output, ext_link_end, sizeof(ext_link_end) - 1);
2302                 }
2303                 else if (IN(EXT_LINK_START))
2304                 {
2305                     if (parser->link_text->len == 0)
2306                         // syntax error: external link with no link text
2307                         _Wikitext_rollback_failed_external_link(parser);
2308                     else
2309                     {
2310                         // success!
2311                         j = IN(PATH) ? Qnil : parser->external_link_class;
2312                         _Wikitext_pop_from_stack_up_to(parser, output, EXT_LINK_START, true);
2313                         parser->capture = NULL;
2314                         _Wikitext_append_hyperlink(parser, Qnil, string_from_str(parser->link_target), string_from_str(parser->link_text), j, false);
2315                     }
2316                     str_clear(parser->link_target);
2317                     str_clear(parser->link_text);
2318                 }
2319                 else
2320                 {
2321                     _Wikitext_pop_excess_elements(parser);
2322                     _Wikitext_start_para_if_necessary(parser);
2323                     str_append(parser->output, ext_link_end, sizeof(ext_link_end) - 1);
2324                 }
2325                 break;
2326
2327             case SEPARATOR:
2328                 output = parser->capture ? parser->capture : parser->output;
2329                 _Wikitext_pop_excess_elements(parser);
2330                 _Wikitext_start_para_if_necessary(parser);
2331                 str_append(output, separator, sizeof(separator) - 1);
2332                 break;
2333
2334             case SPACE:
2335                 output = parser->capture ? parser->capture : parser->output;
2336                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2337                 {
2338                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2339                     str_append(output, token->start, TOKEN_LEN(token));
2340                 }
2341                 else
2342                 {
2343                     // peek ahead to see next token
2344                     char    *token_ptr  = token->start;
2345                     int     token_len   = TOKEN_LEN(token);
2346                     NEXT_TOKEN();
2347                     type = token->type;
2348                     if (((type == H6_END) && IN(H6_START)) ||
2349                         ((type == H5_END) && IN(H5_START)) ||
2350                         ((type == H4_END) && IN(H4_START)) ||
2351                         ((type == H3_END) && IN(H3_START)) ||
2352                         ((type == H2_END) && IN(H2_START)) ||
2353                         ((type == H1_END) && IN(H1_START)))
2354                     {
2355                         // will suppress emission of space (discard) if next token is a H6_END, H5_END etc and we are in the corresponding scope
2356                     }
2357                     else
2358                     {
2359                         // emit the space
2360                         _Wikitext_pop_excess_elements(parser);
2361                         _Wikitext_start_para_if_necessary(parser);
2362                         str_append(output, token_ptr, token_len);
2363                     }
2364
2365                     // jump to top of the loop to process token we scanned during lookahead
2366                     continue;
2367                 }
2368                 break;
2369
2370             case QUOT_ENTITY:
2371             case AMP_ENTITY:
2372             case NAMED_ENTITY:
2373             case DECIMAL_ENTITY:
2374                 // pass these through unaltered as they are case sensitive
2375                 output = parser->capture ? parser->capture : parser->output;
2376                 _Wikitext_pop_excess_elements(parser);
2377                 _Wikitext_start_para_if_necessary(parser);
2378                 str_append(output, token->start, TOKEN_LEN(token));
2379                 break;
2380
2381             case HEX_ENTITY:
2382                 // normalize hex entities (downcase them)
2383                 output = parser->capture ? parser->capture : parser->output;
2384                 _Wikitext_pop_excess_elements(parser);
2385                 _Wikitext_start_para_if_necessary(parser);
2386                 str_append(output, token->start, TOKEN_LEN(token));
2387                 _Wikitext_downcase_bang(output->ptr + output->len - TOKEN_LEN(token), TOKEN_LEN(token));
2388                 break;
2389
2390             case QUOT:
2391                 output = parser->capture ? parser->capture : parser->output;
2392                 _Wikitext_pop_excess_elements(parser);
2393                 _Wikitext_start_para_if_necessary(parser);
2394                 str_append(output, quot_entity, sizeof(quot_entity) - 1);
2395                 break;
2396
2397             case AMP:
2398                 output = parser->capture ? parser->capture : parser->output;
2399                 _Wikitext_pop_excess_elements(parser);
2400                 _Wikitext_start_para_if_necessary(parser);
2401                 str_append(output, amp_entity, sizeof(amp_entity) - 1);
2402                 break;
2403
2404             case LESS:
2405                 output = parser->capture ? parser->capture : parser->output;
2406                 _Wikitext_pop_excess_elements(parser);
2407                 _Wikitext_start_para_if_necessary(parser);
2408                 str_append(output, lt_entity, sizeof(lt_entity) - 1);
2409                 break;
2410
2411             case GREATER:
2412                 output = parser->capture ? parser->capture : parser->output;
2413                 _Wikitext_pop_excess_elements(parser);
2414                 _Wikitext_start_para_if_necessary(parser);
2415                 str_append(output, gt_entity, sizeof(gt_entity) - 1);
2416                 break;
2417
2418             case IMG_START:
2419                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2420                 {
2421                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2422                     str_append(parser->output, token->start, TOKEN_LEN(token));
2423                 }
2424                 else if (parser->capture)
2425                     str_append(parser->capture, token->start, TOKEN_LEN(token));
2426                 else
2427                 {
2428                     // not currently capturing: will be emitting something on success or failure, so get ready
2429                     _Wikitext_pop_excess_elements(parser);
2430                     _Wikitext_start_para_if_necessary(parser);
2431
2432                     // scan ahead consuming PATH, PRINTABLE, ALNUM and SPECIAL_URI_CHARS tokens
2433                     // will cheat here and abuse the link_target capture buffer to accumulate text
2434                     while (NEXT_TOKEN(), (type = token->type))
2435                     {
2436                         if (type == PATH || type == PRINTABLE || type == ALNUM || type == SPECIAL_URI_CHARS)
2437                             str_append(parser->link_target, token->start, TOKEN_LEN(token));
2438                         else if (type == IMG_END && parser->link_target->len > 0)
2439                         {
2440                             // success
2441                             _Wikitext_append_img(parser, parser->link_target->ptr, parser->link_target->len);
2442                             token = NULL;
2443                             break;
2444                         }
2445                         else // unexpected token or zero-length target (syntax error)
2446                         {
2447                             // rollback
2448                             str_append(parser->output, literal_img_start, sizeof(literal_img_start) - 1);
2449                             if (parser->link_target->len > 0)
2450                                 str_append(parser->output, parser->link_target->ptr, parser->link_target->len);
2451                             break;
2452                         }
2453                     }
2454
2455                     // jump to top of the loop to process token we scanned during lookahead
2456                     str_clear(parser->link_target);
2457                     continue;
2458                 }
2459                 break;
2460
2461             case CRLF:
2462                 i = parser->pending_crlf;
2463                 parser->pending_crlf = false;
2464                 _Wikitext_rollback_failed_link(parser); // if any
2465                 if (IN(NO_WIKI_START) || IN(PRE_START))
2466                 {
2467                     ary_clear(parser->line_buffer);
2468                     str_append_str(parser->output, parser->line_ending);
2469                     break;
2470                 }
2471                 else if (IN(PRE))
2472                 {
2473                     // beware when BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, that must be end of PRE block
2474                     if (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE)
2475                         // don't emit in this case
2476                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2477                     else
2478                     {
2479                         if (ary_entry(parser->line_buffer, -2) == PRE)
2480                         {
2481                              // only thing on line is the PRE: emit pending line ending (if we had one)
2482                              if (i)
2483                                  str_append_str(parser->output, parser->line_ending);
2484                         }
2485
2486                         // clear these _before_ calling NEXT_TOKEN (NEXT_TOKEN adds to the line_buffer)
2487                         ary_clear(parser->line);
2488                         ary_clear(parser->line_buffer);
2489
2490                         // peek ahead to see if this is definitely the end of the PRE block
2491                         NEXT_TOKEN();
2492                         type = token->type;
2493                         if (type != BLOCKQUOTE && type != PRE)
2494                             // this is definitely the end of the block, so don't emit
2495                             _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2496                         else
2497                             // potentially will emit
2498                             parser->pending_crlf = true;
2499
2500                         continue; // jump back to top of loop to handle token grabbed via lookahead
2501                     }
2502                 }
2503                 else
2504                 {
2505                     parser->pending_crlf = true;
2506
2507                     // count number of BLOCKQUOTE tokens in line buffer (can be zero) and pop back to that level
2508                     // as a side effect, this handles any open span-level elements and unclosed blocks
2509                     // (with special handling for P blocks and LI elements)
2510                     i = ary_count(parser->line, BLOCKQUOTE) + ary_count(parser->scope, BLOCKQUOTE_START);
2511                     for (j = parser->scope->count; j > i; j--)
2512                     {
2513                         if (parser->scope->count > 0 && ary_entry(parser->scope, -1) == LI)
2514                         {
2515                             parser->pending_crlf = false;
2516                             break;
2517                         }
2518
2519                         // special handling on last iteration through the loop if the top item on the scope is a P block
2520                         if ((j - i == 1) && ary_entry(parser->scope, -1) == P)
2521                         {
2522                             // if nothing or BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, this must be a paragraph break
2523                             // (note that we have to make sure we're not inside a BLOCKQUOTE_START block
2524                             // because in those blocks BLOCKQUOTE tokens have no special meaning)
2525                             if (NO_ITEM(ary_entry(parser->line_buffer, -2)) ||
2526                                 (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE && !IN(BLOCKQUOTE_START)))
2527                                 // paragraph break
2528                                 parser->pending_crlf = false;
2529                             else
2530                                 // not a paragraph break!
2531                                 continue;
2532                         }
2533                         _Wikitext_pop_from_stack(parser, NULL);
2534                     }
2535                 }
2536
2537                 // delete the entire contents of the line scope stack and buffer
2538                 ary_clear(parser->line);
2539                 ary_clear(parser->line_buffer);
2540                 break;
2541
2542             case SPECIAL_URI_CHARS:
2543             case PRINTABLE:
2544             case ALNUM:
2545             case IMG_END:
2546             case LEFT_CURLY:
2547             case RIGHT_CURLY:
2548                 output = parser->capture ? parser->capture : parser->output;
2549                 _Wikitext_pop_excess_elements(parser);
2550                 _Wikitext_start_para_if_necessary(parser);
2551                 str_append(output, token->start, TOKEN_LEN(token));
2552                 break;
2553
2554             case DEFAULT:
2555                 output = parser->capture ? parser->capture : parser->output;
2556                 _Wikitext_pop_excess_elements(parser);
2557                 _Wikitext_start_para_if_necessary(parser);
2558                 str_append_string(output, _Wikitext_utf32_char_to_entity(token->code_point));    // convert to entity
2559                 break;
2560
2561             case END_OF_FILE:
2562                 // special case for input like " foo\n " (see pre_spec.rb)
2563                 if (IN(PRE) &&
2564                     ary_entry(parser->line_buffer, -2) == PRE &&
2565                     parser->pending_crlf)
2566                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2567
2568                 // close any open scopes on hitting EOF
2569                 _Wikitext_rollback_failed_link(parser); // if any
2570                 _Wikitext_pop_all_from_stack(parser);
2571                 goto return_output; // break not enough here (want to break out of outer while loop, not inner switch statement)
2572
2573             default:
2574                 break;
2575         }
2576
2577         // reset current token; forcing lexer to return another token at the top of the loop
2578         token = NULL;
2579     } while (1);
2580 return_output:
2581     // TODO: make this fast
2582     return string_from_str(parser->output);
2583 }