]> git.wincent.com - wikitext.git/blob - ext/parser.c
Remove unnecessary allocation from _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 == '"')                 // QUOT
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 == '&')            // AMP
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 == '<')           // LESS_THAN
763         {
764             free(dest_ptr);
765             rb_raise(rb_eRangeError, "invalid link text (\"<\" may not appear in link text)");
766         }
767         else if (*src == '>')           // GREATER_THAN
768         {
769             free(dest_ptr);
770             rb_raise(rb_eRangeError, "invalid link text (\">\" may not appear in link text)");
771         }
772         else if (*src == ' ' && src == start && !rollback)
773             start++;                // we eat leading space
774         else if (*src >= 0x20 && *src <= 0x7e)    // printable ASCII
775         {
776             *dest = *src;
777             dest++;
778         }
779         else    // all others: must convert to entities
780         {
781             long        width;
782             VALUE       entity      = _Wikitext_utf32_char_to_entity(_Wikitext_utf8_to_utf32(src, end, &width, dest_ptr));
783             char        *entity_src = RSTRING_PTR(entity);
784             long        entity_len  = RSTRING_LEN(entity); // should always be 8 characters (8 bytes)
785             memcpy(dest, entity_src, entity_len);
786             dest        += entity_len;
787             src         += width;
788             non_space   = dest;
789             continue;
790         }
791         if (*src != ' ')
792             non_space = dest;
793         src++;
794     }
795
796     // trim trailing space if necessary
797     if (!rollback && non_space > dest_ptr && dest != non_space)
798         len = non_space - dest_ptr;
799     else
800         len = dest - dest_ptr;
801     VALUE out = rb_str_new(dest_ptr, len);
802     free(dest_ptr);
803     return out;
804 }
805
806 VALUE Wikitext_parser_sanitize_link_target(VALUE self, VALUE string)
807 {
808     parser_t parser;
809     parser.link_target = str_new_from_string(string);
810     GC_WRAP_STR(parser.link_target, link_target_gc);
811     return _Wikitext_parser_sanitize_link_target(&parser, false);
812 }
813
814 // encodes the input string according to RFCs 2396 and 2718
815 // leading and trailing whitespace trimmed
816 // note that the first character of the target link is not case-sensitive
817 // (this is a recommended application-level constraint; it is not imposed at this level)
818 // this is to allow links like:
819 //         ...the [[foo]] is...
820 // to be equivalent to:
821 //         thing. [[Foo]] was...
822 static void _Wikitext_parser_encode_link_target(parser_t *parser)
823 {
824     VALUE in                = string_from_str(parser->link_target);
825     char        *input      = RSTRING_PTR(in);
826     char        *start      = input;            // remember this so we can check if we're at the start
827     long        len         = RSTRING_LEN(in);
828     if (!(len > 0))
829         return;
830     char        *end        = input + len;
831     static char hex[]       = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
832
833     // to avoid most reallocations start with a destination buffer twice the size of the source
834     // this handles the most common case (where most chars are in the ASCII range and don't require more storage, but there are
835     // often quite a few spaces, which are encoded as "%20" and occupy 3 bytes)
836     // the worst case is where _every_ byte must be written out using 3 bytes
837     long        dest_len    = len * 2;
838     char        *dest       = ALLOC_N(char, dest_len);
839     char        *dest_ptr   = dest; // hang on to this so we can pass it to free() later
840     char        *non_space  = dest; // remember last non-space character output
841     for (; input < end; input++)
842     {
843         if ((dest + 3) > (dest_ptr + dest_len))     // worst case: a single character may grow to 3 characters once encoded
844         {
845             // outgrowing buffer, must reallocate
846             char *old_dest      = dest;
847             char *old_dest_ptr  = dest_ptr;
848             dest_len            += len;
849             dest                = realloc(dest_ptr, dest_len);
850             if (dest == NULL)
851             {
852                 // would have used reallocf, but this has to run on Linux too, not just Darwin
853                 free(dest_ptr);
854                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
855             }
856             dest_ptr    = dest;
857             dest        = dest_ptr + (old_dest - old_dest_ptr);
858             non_space   = dest_ptr + (non_space - old_dest_ptr);
859         }
860
861         // pass through unreserved characters
862         if (((*input >= 'a') && (*input <= 'z')) ||
863             ((*input >= 'A') && (*input <= 'Z')) ||
864             ((*input >= '0') && (*input <= '9')) ||
865             (*input == '-') ||
866             (*input == '_') ||
867             (*input == '.') ||
868             (*input == '~'))
869         {
870             *dest++     = *input;
871             non_space   = dest;
872         }
873         else if (*input == ' ' && input == start)
874             start++;                    // we eat leading space
875         else if (*input == ' ' && parser->space_to_underscore)
876             *dest++     = '_';
877         else    // everything else gets URL-encoded
878         {
879             *dest++     = '%';
880             *dest++     = hex[(unsigned char)(*input) / 16];   // left
881             *dest++     = hex[(unsigned char)(*input) % 16];   // right
882             if (*input != ' ')
883                 non_space = dest;
884         }
885     }
886
887     // trim trailing space if necessary
888     if (non_space > dest_ptr && dest != non_space)
889         dest_len = non_space - dest_ptr;
890     else
891         dest_len = dest - dest_ptr;
892
893     // TOOD: try to avoid this copy by working directly inside link_target buffer
894     str_clear(parser->link_target);
895     str_append(parser->link_target, dest_ptr, dest_len);
896     free(dest_ptr);
897 }
898
899 VALUE Wikitext_parser_encode_link_target(VALUE self, VALUE in)
900 {
901     parser_t parser;
902     parser.space_to_underscore      = false;
903     parser.link_target              = str_new_from_string(in);
904     GC_WRAP_STR(parser.link_target, link_target_gc);
905     _Wikitext_parser_encode_link_target(&parser);
906     return string_from_str(parser.link_target);
907 }
908
909 // this method exposed for testing only
910 VALUE Wikitext_parser_encode_special_link_target(VALUE self, VALUE in)
911 {
912     parser_t parser;
913     parser.space_to_underscore      = false;
914     parser.link_target              = str_new_from_string(in);
915     GC_WRAP_STR(parser.link_target, link_target_gc);
916     _Wikitext_parser_encode_link_target(&parser);
917     return string_from_str(parser.link_target);
918 }
919
920 // returns 1 (true) if supplied string is blank (nil, empty, or all whitespace)
921 // returns 0 (false) otherwise
922 bool _Wikitext_blank(str_t *str)
923 {
924     if (str->len == 0)
925         return true;
926     for (char *ptr = str->ptr,
927         *end = str->ptr + str->len;
928         ptr < end; ptr++)
929     {
930         if (*ptr != ' ')
931             return false;
932     }
933     return true;
934 }
935
936 void _Wikitext_rollback_failed_internal_link(parser_t *parser)
937 {
938     if (!IN(LINK_START))
939         return; // nothing to do!
940     int scope_includes_separator = IN(SEPARATOR);
941     _Wikitext_pop_from_stack_up_to(parser, NULL, LINK_START, true);
942     str_append(parser->output, link_start, sizeof(link_start) - 1);
943     if (parser->link_target->len > 0)
944     {
945         // TODO: make _Wikitext_parser_sanitize_link_target return something else? or append directly to buffer would be much better
946         VALUE sanitized = _Wikitext_parser_sanitize_link_target(parser, true);
947         str_append_string(parser->output, sanitized);
948         if (scope_includes_separator)
949         {
950             str_append(parser->output, separator, sizeof(separator) - 1);
951             if (parser->link_text->len > 0)
952                 str_append_str(parser->output, parser->link_text);
953         }
954     }
955     parser->capture = NULL;
956     str_clear(parser->link_target);
957     str_clear(parser->link_text);
958 }
959
960 void _Wikitext_rollback_failed_external_link(parser_t *parser)
961 {
962     if (!IN(EXT_LINK_START))
963         return; // nothing to do!
964
965     // store a couple of values before popping
966     int scope_includes_space = IN(SPACE);
967     VALUE link_class = IN(PATH) ? Qnil : parser->external_link_class;
968     _Wikitext_pop_from_stack_up_to(parser, NULL, EXT_LINK_START, true);
969
970     str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
971     if (parser->link_target->len > 0)
972     {
973         _Wikitext_append_hyperlink(parser, Qnil, string_from_str(parser->link_target), Qnil, link_class, true);
974         if (scope_includes_space)
975         {
976             str_append(parser->output, space, sizeof(space) - 1);
977             if (parser->link_text->len > 0)
978                 str_append_str(parser->output, parser->link_text);
979         }
980     }
981     parser->capture = NULL;
982     str_clear(parser->link_target);
983     str_clear(parser->link_text);
984 }
985
986 void _Wikitext_rollback_failed_link(parser_t *parser)
987 {
988     _Wikitext_rollback_failed_internal_link(parser);
989     _Wikitext_rollback_failed_external_link(parser);
990 }
991
992 VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
993 {
994     // process arguments
995     VALUE options;
996     if (rb_scan_args(argc, argv, "01", &options) == 0) // 0 mandatory arguments, 1 optional argument
997         options = Qnil;
998
999     // defaults
1000     VALUE autolink                      = Qtrue;
1001     VALUE line_ending                   = rb_str_new2("\n");
1002     VALUE external_link_class           = rb_str_new2("external");
1003     VALUE mailto_class                  = rb_str_new2("mailto");
1004     VALUE internal_link_prefix          = rb_str_new2("/wiki/");
1005     VALUE img_prefix                    = rb_str_new2("/images/");
1006     VALUE space_to_underscore           = Qtrue;
1007     VALUE minimum_fulltext_token_length = INT2NUM(3);
1008     VALUE base_heading_level            = INT2NUM(0);
1009
1010     // process options hash (override defaults)
1011     if (!NIL_P(options) && TYPE(options) == T_HASH)
1012     {
1013 #define OVERRIDE_IF_SET(name)   rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern(#name))) == Qtrue ? \
1014                                 rb_hash_aref(options, ID2SYM(rb_intern(#name))) : name
1015         autolink                        = OVERRIDE_IF_SET(autolink);
1016         line_ending                     = OVERRIDE_IF_SET(line_ending);
1017         external_link_class             = OVERRIDE_IF_SET(external_link_class);
1018         mailto_class                    = OVERRIDE_IF_SET(mailto_class);
1019         internal_link_prefix            = OVERRIDE_IF_SET(internal_link_prefix);
1020         img_prefix                      = OVERRIDE_IF_SET(img_prefix);
1021         space_to_underscore             = OVERRIDE_IF_SET(space_to_underscore);
1022         minimum_fulltext_token_length   = OVERRIDE_IF_SET(minimum_fulltext_token_length);
1023         base_heading_level              = OVERRIDE_IF_SET(base_heading_level);
1024     }
1025
1026     // no need to call super here; rb_call_super()
1027     rb_iv_set(self, "@autolink",                        autolink);
1028     rb_iv_set(self, "@line_ending",                     line_ending);
1029     rb_iv_set(self, "@external_link_class",             external_link_class);
1030     rb_iv_set(self, "@mailto_class",                    mailto_class);
1031     rb_iv_set(self, "@internal_link_prefix",            internal_link_prefix);
1032     rb_iv_set(self, "@img_prefix",                      img_prefix);
1033     rb_iv_set(self, "@space_to_underscore",             space_to_underscore);
1034     rb_iv_set(self, "@minimum_fulltext_token_length",   minimum_fulltext_token_length);
1035     rb_iv_set(self, "@base_heading_level",              base_heading_level);
1036     return self;
1037 }
1038
1039 VALUE Wikitext_parser_profiling_parse(VALUE self, VALUE string)
1040 {
1041     for (int i = 0; i < 100000; i++)
1042         Wikitext_parser_parse(1, &string, self);
1043     return Qnil;
1044 }
1045
1046 VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
1047 {
1048     // process arguments
1049     VALUE string, options;
1050     if (rb_scan_args(argc, argv, "11", &string, &options) == 1) // 1 mandatory argument, 1 optional argument
1051         options = Qnil;
1052     if (NIL_P(string))
1053         return Qnil;
1054     string = StringValue(string);
1055
1056     // process options hash
1057     int base_indent = 0;
1058     int base_heading_level = NUM2INT(rb_iv_get(self, "@base_heading_level"));
1059     if (!NIL_P(options) && TYPE(options) == T_HASH)
1060     {
1061         // :indent => 0 (or more)
1062         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("indent"))) == Qtrue)
1063         {
1064             VALUE indent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));
1065             if (indent == Qfalse)
1066                 base_indent = -1; // indentation disabled
1067             else
1068             {
1069                 base_indent = NUM2INT(indent);
1070                 if (base_indent < 0)
1071                     base_indent = 0;
1072             }
1073         }
1074
1075         // :base_heading_level => 0/1/2/3/4/5/6
1076         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("base_heading_level"))) == Qtrue)
1077             base_heading_level = NUM2INT(rb_hash_aref(options, ID2SYM(rb_intern("base_heading_level"))));
1078     }
1079
1080     // normalize, regardless of whether this came from instance variable or override
1081     if (base_heading_level < 0)
1082         base_heading_level = 0;
1083     if (base_heading_level > 6)
1084         base_heading_level = 6;
1085
1086     // set up scanner
1087     char *p = RSTRING_PTR(string);
1088     long len = RSTRING_LEN(string);
1089     char *pe = p + len;
1090
1091     // access these once per parse
1092     VALUE line_ending   = rb_iv_get(self, "@line_ending");
1093     line_ending         = StringValue(line_ending);
1094     VALUE link_class    = rb_iv_get(self, "@external_link_class");
1095     link_class          = NIL_P(link_class) ? Qnil : StringValue(link_class);
1096     VALUE mailto_class  = rb_iv_get(self, "@mailto_class");
1097     mailto_class        = NIL_P(mailto_class) ? Qnil : StringValue(mailto_class);
1098     VALUE prefix        = rb_iv_get(self, "@internal_link_prefix");
1099
1100     // set up parser struct to make passing parameters a little easier
1101     parser_t *parser                = parser_new();
1102     GC_WRAP_PARSER(parser, parser_gc);
1103     parser->external_link_class     = link_class;
1104     parser->mailto_class            = mailto_class;
1105     parser->img_prefix              = rb_iv_get(self, "@img_prefix");
1106     parser->autolink                = rb_iv_get(self, "@autolink") == Qtrue ? true : false;
1107     parser->space_to_underscore     = rb_iv_get(self, "@space_to_underscore") == Qtrue ? true : false;
1108     parser->line_ending             = str_new_from_string(line_ending);
1109     parser->base_indent             = base_indent;
1110     parser->base_heading_level      = base_heading_level;
1111
1112     // this simple looping design leads to a single enormous function,
1113     // but it's faster than doing actual recursive descent and also secure in the face of
1114     // malicious input that seeks to overflow the stack
1115     // (with "<blockquote><blockquote><blockquote>..." times by 10,000, for example)
1116     // given that we expect to deal with a lot of malformed input, a recursive descent design is less appropriate
1117     // than a straightforward looping translator like this one anyway
1118     token_t _token;
1119     _token.type = NO_TOKEN;
1120     token_t *token = NULL;
1121     do
1122     {
1123         // note that whenever we grab a token we push it into the line buffer
1124         // this provides us with context-sensitive "memory" of what's been seen so far on this line
1125 #define NEXT_TOKEN()    token = &_token, next_token(token, token, NULL, pe), ary_push(parser->line_buffer, token->type)
1126
1127         // check to see if we have a token hanging around from a previous iteration of this loop
1128         if (token == NULL)
1129         {
1130             if (_token.type == NO_TOKEN)
1131             {
1132                 // first time here (haven't started scanning yet)
1133                 token = &_token;
1134                 next_token(token, NULL, p, pe);
1135                 ary_push(parser->line_buffer, token->type);
1136             }
1137             else
1138                 // already scanning
1139                 NEXT_TOKEN();
1140         }
1141         int type = token->type;
1142
1143         // can't declare new variables inside a switch statement, so predeclare them here
1144         long remove_strong          = -1;
1145         long remove_em              = -1;
1146
1147         // general purpose counters, flags and pointers
1148         long i                      = 0;
1149         long j                      = 0;
1150         long k                      = 0;
1151         str_t *output               = NULL;
1152
1153         // The following giant switch statement contains cases for all the possible token types.
1154         // In the most basic sense we are emitting the HTML that corresponds to each token,
1155         // but some tokens require context information in order to decide what to output.
1156         // For example, does the STRONG token (''') translate to <strong> or </strong>?
1157         // So when looking at any given token we have three state-maintaining variables which gives us a notion of "where we are":
1158         //
1159         //  - the "scope" stack (indicates what HTML DOM structures we are currently nested inside, similar to a CSS selector)
1160         //  - the line buffer (records tokens seen so far on the current line)
1161         //  - the line "scope" stack (indicates what the scope should be based only on what is visible on the line so far)
1162         //
1163         // Although this is fairly complicated, there is one key simplifying factor:
1164         // The translator continuously performs auto-correction, and this means that we always have a guarantee that the
1165         // scope stack (up to the current token) is valid; our translator can take this as a given.
1166         // Auto-correction basically consists of inserting missing tokens (preventing subsquent HTML from being messed up),
1167         // or converting illegal (unexpected) tokens to their plain text equivalents (providing visual feedback to Wikitext author).
1168         switch (type)
1169         {
1170             case PRE:
1171                 if (IN(NO_WIKI_START) || IN(PRE_START))
1172                 {
1173                     str_append(parser->output, space, sizeof(space) - 1);
1174                     break;
1175                 }
1176                 else if (IN(BLOCKQUOTE_START))
1177                 {
1178                     // this kind of nesting not allowed (to avoid user confusion)
1179                     _Wikitext_pop_excess_elements(parser);
1180                     _Wikitext_start_para_if_necessary(parser);
1181                     output = parser->capture ? parser->capture : parser->output;
1182                     str_append(output, space, sizeof(space) - 1);
1183                     break;
1184                 }
1185
1186                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1187                 ary_push(parser->line, PRE);
1188                 i = ary_count(parser->line, BLOCKQUOTE);
1189                 j = ary_count(parser->scope, BLOCKQUOTE);
1190                 if (i < j)
1191                 {
1192                     // must pop (reduce nesting level)
1193                     for (i = j - i; i > 0; i--)
1194                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1195                 }
1196
1197                 if (!IN(PRE))
1198                 {
1199                     parser->pending_crlf = false;
1200                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1201                     _Wikitext_indent(parser);
1202                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1203                     ary_push(parser->scope, PRE);
1204                 }
1205                 break;
1206
1207             case PRE_START:
1208                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1209                 {
1210                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1211                     str_append(parser->output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1212                 }
1213                 else if (IN(BLOCKQUOTE_START))
1214                 {
1215                     _Wikitext_rollback_failed_link(parser); // if any
1216                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1217                     _Wikitext_indent(parser);
1218                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1219                     ary_push(parser->scope, PRE_START);
1220                     ary_push(parser->line, PRE_START);
1221                 }
1222                 else if (IN(BLOCKQUOTE))
1223                 {
1224                     if (token->column_start == 1) // only allowed in first column
1225                     {
1226                         _Wikitext_rollback_failed_link(parser); // if any
1227                         _Wikitext_pop_all_from_stack(parser);
1228                         _Wikitext_indent(parser);
1229                         str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1230                         ary_push(parser->scope, PRE_START);
1231                         ary_push(parser->line, PRE_START);
1232                     }
1233                     else // PRE_START illegal here
1234                     {
1235                         output = parser->capture ? parser->capture : parser->output;
1236                         _Wikitext_pop_excess_elements(parser);
1237                         _Wikitext_start_para_if_necessary(parser);
1238                         str_append(output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1239                     }
1240                 }
1241                 else
1242                 {
1243                     _Wikitext_rollback_failed_link(parser); // if any
1244                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1245                     _Wikitext_indent(parser);
1246                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1247                     ary_push(parser->scope, PRE_START);
1248                     ary_push(parser->line, PRE_START);
1249                 }
1250                 break;
1251
1252             case PRE_END:
1253                 if (IN(NO_WIKI_START) || IN(PRE))
1254                 {
1255                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1256                     str_append(parser->output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1257                 }
1258                 else
1259                 {
1260                     if (IN(PRE_START))
1261                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE_START, true);
1262                     else
1263                     {
1264                         output = parser->capture ? parser->capture : parser->output;
1265                         _Wikitext_pop_excess_elements(parser);
1266                         _Wikitext_start_para_if_necessary(parser);
1267                         str_append(output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1268                     }
1269                 }
1270                 break;
1271
1272             case BLOCKQUOTE:
1273                 if (IN(NO_WIKI_START) || IN(PRE_START))
1274                     // no need to check for <pre>; can never appear inside it
1275                     str_append(parser->output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1276                 else if (IN(BLOCKQUOTE_START))
1277                 {
1278                     // this kind of nesting not allowed (to avoid user confusion)
1279                     _Wikitext_pop_excess_elements(parser);
1280                     _Wikitext_start_para_if_necessary(parser);
1281                     output = parser->capture ? parser->capture : parser->output;
1282                     str_append(output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1283                     break;
1284                 }
1285                 else
1286                 {
1287                     ary_push(parser->line, BLOCKQUOTE);
1288
1289                     // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1290                     i = ary_count(parser->line, BLOCKQUOTE);
1291                     j = ary_count(parser->scope, BLOCKQUOTE);
1292
1293                     // 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
1294                     while (NEXT_TOKEN(), (token->type == BLOCKQUOTE))
1295                     {
1296                         ary_push(parser->line, BLOCKQUOTE);
1297                         i++;
1298                     }
1299
1300                     // now decide whether to push, pop or do nothing
1301                     if (i > j)
1302                     {
1303                         // must push (increase nesting level)
1304                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1305                         for (i = i - j; i > 0; i--)
1306                         {
1307                             _Wikitext_indent(parser);
1308                             str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1309                             str_append_str(parser->output, parser->line_ending);
1310                             ary_push(parser->scope, BLOCKQUOTE);
1311                         }
1312                     }
1313                     else if (i < j)
1314                     {
1315                         // must pop (reduce nesting level)
1316                         for (i = j - i; i > 0; i--)
1317                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1318                     }
1319
1320                     // jump to top of the loop to process token we scanned during lookahead
1321                     continue;
1322                 }
1323                 break;
1324
1325             case BLOCKQUOTE_START:
1326                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1327                 {
1328                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1329                     str_append(parser->output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1330                 }
1331                 else if (IN(BLOCKQUOTE_START))
1332                 {
1333                     // nesting is fine here
1334                     _Wikitext_rollback_failed_link(parser); // if any
1335                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1336                     _Wikitext_indent(parser);
1337                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1338                     str_append_str(parser->output, parser->line_ending);
1339                     ary_push(parser->scope, BLOCKQUOTE_START);
1340                     ary_push(parser->line, BLOCKQUOTE_START);
1341                 }
1342                 else if (IN(BLOCKQUOTE))
1343                 {
1344                     if (token->column_start == 1) // only allowed in first column
1345                     {
1346                         _Wikitext_rollback_failed_link(parser); // if any
1347                         _Wikitext_pop_all_from_stack(parser);
1348                         _Wikitext_indent(parser);
1349                         str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1350                         str_append_str(parser->output, parser->line_ending);
1351                         ary_push(parser->scope, BLOCKQUOTE_START);
1352                         ary_push(parser->line, BLOCKQUOTE_START);
1353                     }
1354                     else // BLOCKQUOTE_START illegal here
1355                     {
1356                         output = parser->capture ? parser->capture : parser->output;
1357                         _Wikitext_pop_excess_elements(parser);
1358                         _Wikitext_start_para_if_necessary(parser);
1359                         str_append(output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1360                     }
1361                 }
1362                 else
1363                 {
1364                     // would be nice to eliminate the repetition here but it's probably the clearest way
1365                     _Wikitext_rollback_failed_link(parser); // if any
1366                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1367                     _Wikitext_indent(parser);
1368                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1369                     str_append_str(parser->output, parser->line_ending);
1370                     ary_push(parser->scope, BLOCKQUOTE_START);
1371                     ary_push(parser->line, BLOCKQUOTE_START);
1372                 }
1373                 break;
1374
1375             case BLOCKQUOTE_END:
1376                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1377                 {
1378                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1379                     str_append(parser->output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1380                 }
1381                 else
1382                 {
1383                     if (IN(BLOCKQUOTE_START))
1384                         _Wikitext_pop_from_stack_up_to(parser, parser->output, BLOCKQUOTE_START, true);
1385                     else
1386                     {
1387                         output = parser->capture ? parser->capture : parser->output;
1388                         _Wikitext_pop_excess_elements(parser);
1389                         _Wikitext_start_para_if_necessary(parser);
1390                         str_append(output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1391                     }
1392                 }
1393                 break;
1394
1395             case NO_WIKI_START:
1396                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1397                 {
1398                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1399                     str_append(parser->output, escaped_no_wiki_start, sizeof(escaped_no_wiki_start) - 1);
1400                 }
1401                 else
1402                 {
1403                     _Wikitext_pop_excess_elements(parser);
1404                     _Wikitext_start_para_if_necessary(parser);
1405                     ary_push(parser->scope, NO_WIKI_START);
1406                     ary_push(parser->line, NO_WIKI_START);
1407                 }
1408                 break;
1409
1410             case NO_WIKI_END:
1411                 if (IN(NO_WIKI_START))
1412                     // <nowiki> should always only ever be the last item in the stack, but use the helper routine just in case
1413                     _Wikitext_pop_from_stack_up_to(parser, NULL, NO_WIKI_START, true);
1414                 else
1415                 {
1416                     _Wikitext_pop_excess_elements(parser);
1417                     _Wikitext_start_para_if_necessary(parser);
1418                     str_append(parser->output, escaped_no_wiki_end, sizeof(escaped_no_wiki_end) - 1);
1419                 }
1420                 break;
1421
1422             case STRONG_EM:
1423                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1424                 {
1425                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1426                     str_append(parser->output, literal_strong_em, sizeof(literal_strong_em) - 1);
1427                     break;
1428                 }
1429
1430                 output = parser->capture ? parser->capture : parser->output;
1431                 _Wikitext_pop_excess_elements(parser);
1432
1433                 // if you've seen STRONG/STRONG_START or EM/EM_START, must close them in the reverse order that you saw them!
1434                 // otherwise, must open them
1435                 remove_strong  = -1;
1436                 remove_em      = -1;
1437                 j              = parser->scope->count;
1438                 for (j = j - 1; j >= 0; j--)
1439                 {
1440                     int val = ary_entry(parser->scope, j);
1441                     if (val == STRONG || val == STRONG_START)
1442                     {
1443                         str_append(output, strong_end, sizeof(strong_end) - 1);
1444                         remove_strong = j;
1445                     }
1446                     else if (val == EM || val == EM_START)
1447                     {
1448                         str_append(output, em_end, sizeof(em_end) - 1);
1449                         remove_em = j;
1450                     }
1451                 }
1452
1453                 if (remove_strong > remove_em)      // must remove strong first
1454                 {
1455                     ary_pop(parser->scope);
1456                     if (remove_em > -1)
1457                         ary_pop(parser->scope);
1458                     else    // there was no em to remove!, so consider this an opening em tag
1459                     {
1460                         str_append(output, em_start, sizeof(em_start) - 1);
1461                         ary_push(parser->scope, EM);
1462                         ary_push(parser->line, EM);
1463                     }
1464                 }
1465                 else if (remove_em > remove_strong) // must remove em first
1466                 {
1467                     ary_pop(parser->scope);
1468                     if (remove_strong > -1)
1469                         ary_pop(parser->scope);
1470                     else    // there was no strong to remove!, so consider this an opening strong tag
1471                     {
1472                         str_append(output, strong_start, sizeof(strong_start) - 1);
1473                         ary_push(parser->scope, STRONG);
1474                         ary_push(parser->line, STRONG);
1475                     }
1476                 }
1477                 else    // no strong or em to remove, so this must be a new opening of both
1478                 {
1479                     _Wikitext_start_para_if_necessary(parser);
1480                     str_append(output, strong_em_start, sizeof(strong_em_start) - 1);
1481                     ary_push(parser->scope, STRONG);
1482                     ary_push(parser->line, STRONG);
1483                     ary_push(parser->scope, EM);
1484                     ary_push(parser->line, EM);
1485                 }
1486                 break;
1487
1488             case STRONG:
1489                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1490                 {
1491                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1492                     str_append(parser->output, literal_strong, sizeof(literal_strong) - 1);
1493                 }
1494                 else
1495                 {
1496                     output = parser->capture ? parser->capture : parser->output;
1497                     if (IN(STRONG_START))
1498                         // already in span started with <strong>, no choice but to emit this literally
1499                         str_append(output, literal_strong, sizeof(literal_strong) - 1);
1500                     else if (IN(STRONG))
1501                         // STRONG already seen, this is a closing tag
1502                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG, true);
1503                     else
1504                     {
1505                         // this is a new opening
1506                         _Wikitext_pop_excess_elements(parser);
1507                         _Wikitext_start_para_if_necessary(parser);
1508                         str_append(output, strong_start, sizeof(strong_start) - 1);
1509                         ary_push(parser->scope, STRONG);
1510                         ary_push(parser->line, STRONG);
1511                     }
1512                 }
1513                 break;
1514
1515             case STRONG_START:
1516                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1517                 {
1518                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1519                     str_append(parser->output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1520                 }
1521                 else
1522                 {
1523                     output = parser->capture ? parser->capture : parser->output;
1524                     if (IN(STRONG_START) || IN(STRONG))
1525                         str_append(output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1526                     else
1527                     {
1528                         _Wikitext_pop_excess_elements(parser);
1529                         _Wikitext_start_para_if_necessary(parser);
1530                         str_append(output, strong_start, sizeof(strong_start) - 1);
1531                         ary_push(parser->scope, STRONG_START);
1532                         ary_push(parser->line, STRONG_START);
1533                     }
1534                 }
1535                 break;
1536
1537             case STRONG_END:
1538                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1539                 {
1540                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1541                     str_append(parser->output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1542                 }
1543                 else
1544                 {
1545                     output = parser->capture ? parser->capture : parser->output;
1546                     if (IN(STRONG_START))
1547                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG_START, true);
1548                     else
1549                     {
1550                         // no STRONG_START in scope, so must interpret the STRONG_END without any special meaning
1551                         _Wikitext_pop_excess_elements(parser);
1552                         _Wikitext_start_para_if_necessary(parser);
1553                         str_append(output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1554                     }
1555                 }
1556                 break;
1557
1558             case EM:
1559                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1560                 {
1561                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1562                     str_append(parser->output, literal_em, sizeof(literal_em) - 1);
1563                 }
1564                 else
1565                 {
1566                     output = parser->capture ? parser->capture : parser->output;
1567                     if (IN(EM_START))
1568                         // already in span started with <em>, no choice but to emit this literally
1569                         str_append(output, literal_em, sizeof(literal_em) - 1);
1570                     else if (IN(EM))
1571                         // EM already seen, this is a closing tag
1572                         _Wikitext_pop_from_stack_up_to(parser, output, EM, true);
1573                     else
1574                     {
1575                         // this is a new opening
1576                         _Wikitext_pop_excess_elements(parser);
1577                         _Wikitext_start_para_if_necessary(parser);
1578                         str_append(output, em_start, sizeof(em_start) - 1);
1579                         ary_push(parser->scope, EM);
1580                         ary_push(parser->line, EM);
1581                     }
1582                 }
1583                 break;
1584
1585             case EM_START:
1586                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1587                 {
1588                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1589                     str_append(parser->output, escaped_em_start, sizeof(escaped_em_start) - 1);
1590                 }
1591                 else
1592                 {
1593                     output = parser->capture ? parser->capture : parser->output;
1594                     if (IN(EM_START) || IN(EM))
1595                         str_append(output, escaped_em_start, sizeof(escaped_em_start) - 1);
1596                     else
1597                     {
1598                         _Wikitext_pop_excess_elements(parser);
1599                         _Wikitext_start_para_if_necessary(parser);
1600                         str_append(output, em_start, sizeof(em_start) - 1);
1601                         ary_push(parser->scope, EM_START);
1602                         ary_push(parser->line, EM_START);
1603                     }
1604                 }
1605                 break;
1606
1607             case EM_END:
1608                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1609                 {
1610                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1611                     str_append(parser->output, escaped_em_end, sizeof(escaped_em_end) - 1);
1612                 }
1613                 else
1614                 {
1615                     output = parser->capture ? parser->capture : parser->output;
1616                     if (IN(EM_START))
1617                         _Wikitext_pop_from_stack_up_to(parser, output, EM_START, true);
1618                     else
1619                     {
1620                         // no EM_START in scope, so must interpret the TT_END without any special meaning
1621                         _Wikitext_pop_excess_elements(parser);
1622                         _Wikitext_start_para_if_necessary(parser);
1623                         str_append(output, escaped_em_end, sizeof(escaped_em_end) - 1);
1624                     }
1625                 }
1626                 break;
1627
1628             case TT:
1629                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1630                 {
1631                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1632                     str_append(parser->output, backtick, sizeof(backtick) - 1);
1633                 }
1634                 else
1635                 {
1636                     output = parser->capture ? parser->capture : parser->output;
1637                     if (IN(TT_START))
1638                         // already in span started with <tt>, no choice but to emit this literally
1639                         str_append(output, backtick, sizeof(backtick) - 1);
1640                     else if (IN(TT))
1641                         // TT (`) already seen, this is a closing tag
1642                         _Wikitext_pop_from_stack_up_to(parser, output, TT, true);
1643                     else
1644                     {
1645                         // this is a new opening
1646                         _Wikitext_pop_excess_elements(parser);
1647                         _Wikitext_start_para_if_necessary(parser);
1648                         str_append(output, tt_start, sizeof(tt_start) - 1);
1649                         ary_push(parser->scope, TT);
1650                         ary_push(parser->line, TT);
1651                     }
1652                 }
1653                 break;
1654
1655             case TT_START:
1656                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1657                 {
1658                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1659                     str_append(parser->output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1660                 }
1661                 else
1662                 {
1663                     output = parser->capture ? parser->capture : parser->output;
1664                     if (IN(TT_START) || IN(TT))
1665                         str_append(output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1666                     else
1667                     {
1668                         _Wikitext_pop_excess_elements(parser);
1669                         _Wikitext_start_para_if_necessary(parser);
1670                         str_append(output, tt_start, sizeof(tt_start) - 1);
1671                         ary_push(parser->scope, TT_START);
1672                         ary_push(parser->line, TT_START);
1673                     }
1674                 }
1675                 break;
1676
1677             case TT_END:
1678                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1679                 {
1680                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1681                     str_append(parser->output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1682                 }
1683                 else
1684                 {
1685                     output = parser->capture ? parser->capture : parser->output;
1686                     if (IN(TT_START))
1687                         _Wikitext_pop_from_stack_up_to(parser, output, TT_START, true);
1688                     else
1689                     {
1690                         // no TT_START in scope, so must interpret the TT_END without any special meaning
1691                         _Wikitext_pop_excess_elements(parser);
1692                         _Wikitext_start_para_if_necessary(parser);
1693                         str_append(output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1694                     }
1695                 }
1696                 break;
1697
1698             case OL:
1699             case UL:
1700                 if (IN(NO_WIKI_START) || IN(PRE_START))
1701                 {
1702                     // no need to check for PRE; can never appear inside it
1703                     str_append(parser->output, token->start, TOKEN_LEN(token));
1704                     break;
1705                 }
1706
1707                 // count number of tokens in line and scope stacks
1708                 int bq_count = ary_count(parser->scope, BLOCKQUOTE_START);
1709                 i = parser->line->count - ary_count(parser->line, BLOCKQUOTE_START);
1710                 j = parser->scope->count - bq_count;
1711                 k = i;
1712
1713                 // list tokens can be nested so look ahead for any more which might affect the decision to push or pop
1714                 for (;;)
1715                 {
1716                     type = token->type;
1717                     if (type == OL || type == UL)
1718                     {
1719                         token = NULL;
1720                         if (i - k >= 2)                             // already seen at least one OL or UL
1721                         {
1722                             ary_push(parser->line, NESTED_LIST);    // which means this is a nested list
1723                             i += 3;
1724                         }
1725                         else
1726                             i += 2;
1727                         ary_push(parser->line, type);
1728                         ary_push(parser->line, LI);
1729
1730                         // want to compare line with scope but can only do so if scope has enough items on it
1731                         if (j >= i)
1732                         {
1733                             if (ary_entry(parser->scope, i + bq_count - 2) == type &&
1734                                 ary_entry(parser->scope, i + bq_count - 1) == LI)
1735                             {
1736                                 // line and scope match at this point: do nothing yet
1737                             }
1738                             else
1739                             {
1740                                 // item just pushed onto line does not match corresponding slot of scope!
1741                                 for (; j >= i - 2; j--)
1742                                     // must pop back before emitting
1743                                     _Wikitext_pop_from_stack(parser, NULL);
1744
1745                                 // will emit UL or OL, then LI
1746                                 break;
1747                             }
1748                         }
1749                         else        // line stack size now exceeds scope stack size: must increase nesting level
1750                             break;  // will emit UL or OL, then LI
1751                     }
1752                     else
1753                     {
1754                         // not a OL or UL token!
1755                         if (j == i)
1756                             // must close existing LI and re-open new one
1757                             _Wikitext_pop_from_stack(parser, NULL);
1758                         else if (j > i)
1759                         {
1760                             // item just pushed onto line does not match corresponding slot of scope!
1761                             for (; j >= i; j--)
1762                                 // must pop back before emitting
1763                                 _Wikitext_pop_from_stack(parser, NULL);
1764                         }
1765                         break;
1766                     }
1767                     NEXT_TOKEN();
1768                 }
1769
1770                 // will emit
1771                 if (type == OL || type == UL)
1772                 {
1773                     // if LI is at the top of a stack this is the start of a nested list
1774                     if (j > 0 && ary_entry(parser->scope, -1) == LI)
1775                     {
1776                         // so we should precede it with a CRLF, and indicate that it's a nested list
1777                         str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1778                         ary_push(parser->scope, NESTED_LIST);
1779                     }
1780                     else
1781                     {
1782                         // this is a new list
1783                         if (IN(BLOCKQUOTE_START))
1784                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1785                         else
1786                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1787                     }
1788
1789                     // emit
1790                     _Wikitext_indent(parser);
1791                     if (type == OL)
1792                         str_append(parser->output, ol_start, sizeof(ol_start) - 1);
1793                     else if (type == UL)
1794                         str_append(parser->output, ul_start, sizeof(ul_start) - 1);
1795                     ary_push(parser->scope, type);
1796                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1797                 }
1798                 else if (type == SPACE)
1799                     // silently throw away the optional SPACE token after final list marker
1800                     token = NULL;
1801
1802                 _Wikitext_indent(parser);
1803                 str_append(parser->output, li_start, sizeof(li_start) - 1);
1804                 ary_push(parser->scope, LI);
1805
1806                 // any subsequent UL or OL tokens on this line are syntax errors and must be emitted literally
1807                 if (type == OL || type == UL)
1808                 {
1809                     k = 0;
1810                     while (k++, NEXT_TOKEN(), (type = token->type))
1811                     {
1812                         if (type == OL || type == UL)
1813                             str_append(parser->output, token->start, TOKEN_LEN(token));
1814                         else if (type == SPACE && k == 1)
1815                         {
1816                             // silently throw away the optional SPACE token after final list marker
1817                             token = NULL;
1818                             break;
1819                         }
1820                         else
1821                             break;
1822                     }
1823                 }
1824
1825                 // jump to top of the loop to process token we scanned during lookahead
1826                 continue;
1827
1828             case H6_START:
1829             case H5_START:
1830             case H4_START:
1831             case H3_START:
1832             case H2_START:
1833             case H1_START:
1834                 if (IN(NO_WIKI_START) || IN(PRE_START))
1835                 {
1836                     // no need to check for PRE; can never appear inside it
1837                     str_append(parser->output, token->start, TOKEN_LEN(token));
1838                     break;
1839                 }
1840
1841                 // pop up to but not including the last BLOCKQUOTE on the scope stack
1842                 if (IN(BLOCKQUOTE_START))
1843                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1844                 else
1845                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1846
1847                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1848                 ary_push(parser->line, type);
1849                 i = ary_count(parser->line, BLOCKQUOTE);
1850                 j = ary_count(parser->scope, BLOCKQUOTE);
1851
1852                 // decide whether we need to pop off excess BLOCKQUOTE tokens (will never need to push; that is handled above in the BLOCKQUOTE case itself)
1853                 if (i < j)
1854                 {
1855                     // must pop (reduce nesting level)
1856                     for (i = j - i; i > 0; i--)
1857                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1858                 }
1859
1860                 // discard any whitespace here (so that "== foo ==" will be translated to "<h2>foo</h2>" rather than "<h2> foo </h2")
1861                 while (NEXT_TOKEN(), (token->type == SPACE))
1862                     ; // discard
1863
1864                 ary_push(parser->scope, type);
1865                 _Wikitext_indent(parser);
1866
1867                 // take base_heading_level into account
1868                 type += base_heading_level;
1869                 if (type > H6_START) // no need to check for underflow (base_heading_level never negative)
1870                     type = H6_START;
1871
1872                 // rather than repeat all that code for each kind of heading, share it and use a conditional here
1873                 if (type == H6_START)
1874                     str_append(parser->output, h6_start, sizeof(h6_start) - 1);
1875                 else if (type == H5_START)
1876                     str_append(parser->output, h5_start, sizeof(h5_start) - 1);
1877                 else if (type == H4_START)
1878                     str_append(parser->output, h4_start, sizeof(h4_start) - 1);
1879                 else if (type == H3_START)
1880                     str_append(parser->output, h3_start, sizeof(h3_start) - 1);
1881                 else if (type == H2_START)
1882                     str_append(parser->output, h2_start, sizeof(h2_start) - 1);
1883                 else if (type == H1_START)
1884                     str_append(parser->output, h1_start, sizeof(h1_start) - 1);
1885
1886                 // jump to top of the loop to process token we scanned during lookahead
1887                 continue;
1888
1889             case H6_END:
1890                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1891                 {
1892                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1893                     str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1894                 }
1895                 else
1896                 {
1897                     _Wikitext_rollback_failed_external_link(parser); // if any
1898                     if (!IN(H6_START))
1899                     {
1900                         // literal output only if not in h6 scope (we stay silent in that case)
1901                         _Wikitext_start_para_if_necessary(parser);
1902                         str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1903                     }
1904                 }
1905                 break;
1906
1907             case H5_END:
1908                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1909                 {
1910                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1911                     str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1912                 }
1913                 else
1914                 {
1915                     _Wikitext_rollback_failed_external_link(parser); // if any
1916                     if (!IN(H5_START))
1917                     {
1918                         // literal output only if not in h5 scope (we stay silent in that case)
1919                         _Wikitext_start_para_if_necessary(parser);
1920                         str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1921                     }
1922                 }
1923                 break;
1924
1925             case H4_END:
1926                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1927                 {
1928                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1929                     str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1930                 }
1931                 else
1932                 {
1933                     _Wikitext_rollback_failed_external_link(parser); // if any
1934                     if (!IN(H4_START))
1935                     {
1936                         // literal output only if not in h4 scope (we stay silent in that case)
1937                         _Wikitext_start_para_if_necessary(parser);
1938                         str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1939                     }
1940                 }
1941                 break;
1942
1943             case H3_END:
1944                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1945                 {
1946                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1947                     str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1948                 }
1949                 else
1950                 {
1951                     _Wikitext_rollback_failed_external_link(parser); // if any
1952                     if (!IN(H3_START))
1953                     {
1954                         // literal output only if not in h3 scope (we stay silent in that case)
1955                         _Wikitext_start_para_if_necessary(parser);
1956                         str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1957                     }
1958                 }
1959                 break;
1960
1961             case H2_END:
1962                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1963                 {
1964                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1965                     str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
1966                 }
1967                 else
1968                 {
1969                     _Wikitext_rollback_failed_external_link(parser); // if any
1970                     if (!IN(H2_START))
1971                     {
1972                         // literal output only if not in h2 scope (we stay silent in that case)
1973                         _Wikitext_start_para_if_necessary(parser);
1974                         str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
1975                     }
1976                 }
1977                 break;
1978
1979             case H1_END:
1980                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1981                 {
1982                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1983                     str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
1984                 }
1985                 else
1986                 {
1987                     _Wikitext_rollback_failed_external_link(parser); // if any
1988                     if (!IN(H1_START))
1989                     {
1990                         // literal output only if not in h1 scope (we stay silent in that case)
1991                         _Wikitext_start_para_if_necessary(parser);
1992                         str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
1993                     }
1994                 }
1995                 break;
1996
1997             case MAIL:
1998                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1999                 {
2000                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2001                     str_append(parser->output, token->start, TOKEN_LEN(token));
2002                 }
2003                 else
2004                 {
2005                     _Wikitext_pop_excess_elements(parser);
2006                     _Wikitext_start_para_if_necessary(parser);
2007                     _Wikitext_append_hyperlink(parser, rb_str_new2("mailto:"), TOKEN_TEXT(token), Qnil, mailto_class, true);
2008                 }
2009                 break;
2010
2011             case URI:
2012                 if (IN(NO_WIKI_START))
2013                     // user can temporarily suppress autolinking by using <nowiki></nowiki>
2014                     // note that unlike MediaWiki, we do allow autolinking inside PRE blocks
2015                     str_append(parser->output, token->start, TOKEN_LEN(token));
2016                 else if (IN(LINK_START))
2017                 {
2018                     // if the URI were allowed it would have been handled already in LINK_START
2019                     _Wikitext_rollback_failed_internal_link(parser);
2020                     _Wikitext_append_hyperlink(parser, Qnil, TOKEN_TEXT(token), Qnil, parser->external_link_class, true);
2021                 }
2022                 else if (IN(EXT_LINK_START))
2023                 {
2024                     if (parser->link_target->len == 0)
2025                     {
2026                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2027                         i = TOKEN_TEXT(token);
2028                         NEXT_TOKEN();
2029                         if (token->type == SPACE)
2030                         {
2031                             ary_push(parser->scope, SPACE);
2032                             str_append_string(parser->link_target, i);
2033                             str_clear(parser->link_text);
2034                             parser->capture     = parser->link_text;
2035                             token               = NULL; // silently consume space
2036                         }
2037                         else
2038                         {
2039                             // didn't see the space! this must be an error
2040                             _Wikitext_pop_from_stack(parser, NULL);
2041                             _Wikitext_pop_excess_elements(parser);
2042                             _Wikitext_start_para_if_necessary(parser);
2043                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2044                             _Wikitext_append_hyperlink(parser, Qnil, i, Qnil, parser->external_link_class, true);
2045                         }
2046                     }
2047                     else
2048                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2049                 }
2050                 else
2051                 {
2052                     _Wikitext_pop_excess_elements(parser);
2053                     _Wikitext_start_para_if_necessary(parser);
2054                     _Wikitext_append_hyperlink(parser, Qnil, TOKEN_TEXT(token), Qnil, parser->external_link_class, true);
2055                 }
2056                 break;
2057
2058             case PATH:
2059                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2060                     str_append(parser->output, token->start, TOKEN_LEN(token));
2061                 else if (IN(EXT_LINK_START))
2062                 {
2063                     if (parser->link_target->len == 0)
2064                     {
2065                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2066                         i = TOKEN_TEXT(token);
2067                         NEXT_TOKEN();
2068                         if (token->type == SPACE)
2069                         {
2070                             ary_push(parser->scope, PATH);
2071                             ary_push(parser->scope, SPACE);
2072                             str_append_string(parser->link_target, i);
2073                             str_clear(parser->link_text);
2074                             parser->capture     = parser->link_text;
2075                             token               = NULL; // silently consume space
2076                         }
2077                         else
2078                         {
2079                             // didn't see the space! this must be an error
2080                             _Wikitext_pop_from_stack(parser, NULL);
2081                             _Wikitext_pop_excess_elements(parser);
2082                             _Wikitext_start_para_if_necessary(parser);
2083                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2084                             str_append_string(parser->output, i);
2085                         }
2086                     }
2087                     else
2088                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2089                 }
2090                 else
2091                 {
2092                     output = parser->capture ? parser->capture : parser->output;
2093                     _Wikitext_pop_excess_elements(parser);
2094                     _Wikitext_start_para_if_necessary(parser);
2095                     str_append(output, token->start, TOKEN_LEN(token));
2096                 }
2097                 break;
2098
2099             // internal links (links to other wiki articles) look like this:
2100             //      [[another article]] (would point at, for example, "/wiki/another_article")
2101             //      [[the other article|the link text we'll use for it]]
2102             //      [[the other article | the link text we'll use for it]]
2103             // MediaWiki has strict requirements about what it will accept as a link target:
2104             //      all wikitext markup is disallowed:
2105             //          example [[foo ''bar'' baz]]
2106             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2107             //          example [[foo <em>bar</em> baz]]
2108             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2109             //          example [[foo <nowiki>''</nowiki> baz]]
2110             //          renders [[foo '' baz]]                  (ie. not a link)
2111             //          example [[foo <bar> baz]]
2112             //          renders [[foo &lt;bar&gt; baz]]         (ie. not a link)
2113             //      HTML entities and non-ASCII, however, make it through:
2114             //          example [[foo &euro;]]
2115             //          renders <a href="/wiki/Foo_%E2%82%AC">foo &euro;</a>
2116             //          example [[foo €]]
2117             //          renders <a href="/wiki/Foo_%E2%82%AC">foo €</a>
2118             // we'll impose similar restrictions here for the link target; allowed tokens will be:
2119             //      SPACE, SPECIAL_URI_CHARS, PRINTABLE, PATH, ALNUM, DEFAULT, QUOT and AMP
2120             // everything else will be rejected
2121             case LINK_START:
2122                 output = parser->capture ? parser->capture : parser->output;
2123                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2124                 {
2125                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2126                     str_append(output, link_start, sizeof(link_start) - 1);
2127                 }
2128                 else if (IN(EXT_LINK_START))
2129                     // already in external link scope! (and in fact, must be capturing link_text right now)
2130                     str_append(output, link_start, sizeof(link_start) - 1);
2131                 else if (IN(LINK_START))
2132                 {
2133                     // already in internal link scope! this is a syntax error
2134                     _Wikitext_rollback_failed_internal_link(parser);
2135                     str_append(parser->output, link_start, sizeof(link_start) - 1);
2136                 }
2137                 else if (IN(SEPARATOR))
2138                 {
2139                     // scanning internal link text
2140                 }
2141                 else // not in internal link scope yet
2142                 {
2143                     // will either emit a link, or the rollback of a failed link, so start the para now
2144                     _Wikitext_pop_excess_elements(parser);
2145                     _Wikitext_start_para_if_necessary(parser);
2146                     ary_push(parser->scope, LINK_START);
2147
2148                     // look ahead and try to gobble up link target
2149                     while (NEXT_TOKEN(), (type = token->type))
2150                     {
2151                         if (type == SPACE               ||
2152                             type == SPECIAL_URI_CHARS   ||
2153                             type == PATH                ||
2154                             type == PRINTABLE           ||
2155                             type == ALNUM               ||
2156                             type == DEFAULT             ||
2157                             type == QUOT                ||
2158                             type == QUOT_ENTITY         ||
2159                             type == AMP                 ||
2160                             type == AMP_ENTITY          ||
2161                             type == IMG_START           ||
2162                             type == IMG_END             ||
2163                             type == LEFT_CURLY          ||
2164                             type == RIGHT_CURLY)
2165                         {
2166                             // accumulate these tokens into link_target
2167                             if (parser->link_target->len == 0)
2168                             {
2169                                 str_clear(parser->link_target);
2170                                 parser->capture = parser->link_target;
2171                             }
2172                             if (type == QUOT_ENTITY)
2173                                 // don't insert the entity, insert the literal quote
2174                                 str_append(parser->link_target, quote, sizeof(quote) - 1);
2175                             else if (type == AMP_ENTITY)
2176                                 // don't insert the entity, insert the literal ampersand
2177                                 str_append(parser->link_target, ampersand, sizeof(ampersand) - 1);
2178                             else
2179                                 str_append(parser->link_target, token->start, TOKEN_LEN(token));
2180                         }
2181                         else if (type == LINK_END)
2182                         {
2183                             if (parser->link_target->len == 0) // bail for inputs like "[[]]"
2184                                 _Wikitext_rollback_failed_internal_link(parser);
2185                             break; // jump back to top of loop (will handle this in LINK_END case below)
2186                         }
2187                         else if (type == SEPARATOR)
2188                         {
2189                             if (parser->link_target->len == 0) // bail for inputs like "[[|"
2190                                 _Wikitext_rollback_failed_internal_link(parser);
2191                             else
2192                             {
2193                                 ary_push(parser->scope, SEPARATOR);
2194                                 str_clear(parser->link_text);
2195                                 parser->capture     = parser->link_text;
2196                                 token               = NULL;
2197                             }
2198                             break;
2199                         }
2200                         else // unexpected token (syntax error)
2201                         {
2202                             _Wikitext_rollback_failed_internal_link(parser);
2203                             break; // jump back to top of loop to handle unexpected token
2204                         }
2205                     }
2206
2207                     // jump to top of the loop to process token we scanned during lookahead (if any)
2208                     continue;
2209                 }
2210                 break;
2211
2212             case LINK_END:
2213                 output = parser->capture ? parser->capture : parser->output;
2214                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2215                 {
2216                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2217                     str_append(output, link_end, sizeof(link_end) - 1);
2218                 }
2219                 else if (IN(EXT_LINK_START))
2220                     // already in external link scope! (and in fact, must be capturing link_text right now)
2221                     str_append(output, link_end, sizeof(link_end) - 1);
2222                 else if (IN(LINK_START)) // in internal link scope!
2223                 {
2224                     if (_Wikitext_blank(parser->link_target))
2225                     {
2226                         // special case for inputs like "[[    ]]"
2227                         _Wikitext_rollback_failed_internal_link(parser);
2228                         str_append(parser->output, link_end, sizeof(link_end) - 1);
2229                         break;
2230                     }
2231                     if (parser->link_text->len == 0 ||
2232                         _Wikitext_blank(parser->link_text))
2233                     {
2234                         // use link target as link text
2235                         str_clear(parser->link_text);
2236                         str_append_string(parser->link_text, _Wikitext_parser_sanitize_link_target(parser, false));
2237                     }
2238                     else
2239                         _Wikitext_parser_trim_link_text(parser);
2240                     _Wikitext_parser_encode_link_target(parser);
2241                     _Wikitext_pop_from_stack_up_to(parser, output, LINK_START, true);
2242                     parser->capture = NULL;
2243                     _Wikitext_append_hyperlink(parser, prefix, string_from_str(parser->link_target), string_from_str(parser->link_text), Qnil, false);
2244                     str_clear(parser->link_target);
2245                     str_clear(parser->link_text);
2246                 }
2247                 else // wasn't in internal link scope
2248                 {
2249                     _Wikitext_pop_excess_elements(parser);
2250                     _Wikitext_start_para_if_necessary(parser);
2251                     str_append(output, link_end, sizeof(link_end) - 1);
2252                 }
2253                 break;
2254
2255             // external links look like this:
2256             //      [http://google.com/ the link text]
2257             //      [/other/page/on/site see this page]
2258             // strings in square brackets which don't match this syntax get passed through literally; eg:
2259             //      he was very angery [sic] about the turn of events
2260             case EXT_LINK_START:
2261                 output = parser->capture ? parser->capture : parser->output;
2262                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2263                 {
2264                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2265                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2266                 }
2267                 else if (IN(EXT_LINK_START))
2268                     // already in external link scope! (and in fact, must be capturing link_text right now)
2269                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2270                 else if (IN(LINK_START))
2271                 {
2272                     // already in internal link scope!
2273                     if (parser->link_target->len == 0)
2274                         // this must be the first character of our link target
2275                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2276                     else if (IN(SPACE))
2277                         // link target has already been scanned
2278                         str_append(parser->link_text, ext_link_start, sizeof(ext_link_start) - 1);
2279                     else
2280                         // TODO: possibly roll this condition into the above
2281                         // add to existing link target
2282                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2283                 }
2284                 else // not in external link scope yet
2285                 {
2286                     // will either emit a link, or the rollback of a failed link, so start the para now
2287                     _Wikitext_pop_excess_elements(parser);
2288                     _Wikitext_start_para_if_necessary(parser);
2289
2290                     // look ahead: expect an absolute URI (with protocol) or "relative" (path) URI
2291                     NEXT_TOKEN();
2292                     if (token->type == URI || token->type == PATH)
2293                         ary_push(parser->scope, EXT_LINK_START);    // so far so good, jump back to the top of the loop
2294                     else
2295                         // only get here if there was a syntax error (missing URI)
2296                         str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2297                     continue; // jump back to top of loop to handle token (either URI or whatever it is)
2298                 }
2299                 break;
2300
2301             case EXT_LINK_END:
2302                 output = parser->capture ? parser->capture : parser->output;
2303                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2304                 {
2305                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2306                     str_append(output, ext_link_end, sizeof(ext_link_end) - 1);
2307                 }
2308                 else if (IN(EXT_LINK_START))
2309                 {
2310                     if (parser->link_text->len == 0)
2311                         // syntax error: external link with no link text
2312                         _Wikitext_rollback_failed_external_link(parser);
2313                     else
2314                     {
2315                         // success!
2316                         j = IN(PATH) ? Qnil : parser->external_link_class;
2317                         _Wikitext_pop_from_stack_up_to(parser, output, EXT_LINK_START, true);
2318                         parser->capture = NULL;
2319                         _Wikitext_append_hyperlink(parser, Qnil, string_from_str(parser->link_target), string_from_str(parser->link_text), j, false);
2320                     }
2321                     str_clear(parser->link_target);
2322                     str_clear(parser->link_text);
2323                 }
2324                 else
2325                 {
2326                     _Wikitext_pop_excess_elements(parser);
2327                     _Wikitext_start_para_if_necessary(parser);
2328                     str_append(parser->output, ext_link_end, sizeof(ext_link_end) - 1);
2329                 }
2330                 break;
2331
2332             case SEPARATOR:
2333                 output = parser->capture ? parser->capture : parser->output;
2334                 _Wikitext_pop_excess_elements(parser);
2335                 _Wikitext_start_para_if_necessary(parser);
2336                 str_append(output, separator, sizeof(separator) - 1);
2337                 break;
2338
2339             case SPACE:
2340                 output = parser->capture ? parser->capture : parser->output;
2341                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2342                 {
2343                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2344                     str_append(output, token->start, TOKEN_LEN(token));
2345                 }
2346                 else
2347                 {
2348                     // peek ahead to see next token
2349                     char    *token_ptr  = token->start;
2350                     int     token_len   = TOKEN_LEN(token);
2351                     NEXT_TOKEN();
2352                     type = token->type;
2353                     if (((type == H6_END) && IN(H6_START)) ||
2354                         ((type == H5_END) && IN(H5_START)) ||
2355                         ((type == H4_END) && IN(H4_START)) ||
2356                         ((type == H3_END) && IN(H3_START)) ||
2357                         ((type == H2_END) && IN(H2_START)) ||
2358                         ((type == H1_END) && IN(H1_START)))
2359                     {
2360                         // will suppress emission of space (discard) if next token is a H6_END, H5_END etc and we are in the corresponding scope
2361                     }
2362                     else
2363                     {
2364                         // emit the space
2365                         _Wikitext_pop_excess_elements(parser);
2366                         _Wikitext_start_para_if_necessary(parser);
2367                         str_append(output, token_ptr, token_len);
2368                     }
2369
2370                     // jump to top of the loop to process token we scanned during lookahead
2371                     continue;
2372                 }
2373                 break;
2374
2375             case QUOT_ENTITY:
2376             case AMP_ENTITY:
2377             case NAMED_ENTITY:
2378             case DECIMAL_ENTITY:
2379                 // pass these through unaltered as they are case sensitive
2380                 output = parser->capture ? parser->capture : parser->output;
2381                 _Wikitext_pop_excess_elements(parser);
2382                 _Wikitext_start_para_if_necessary(parser);
2383                 str_append(output, token->start, TOKEN_LEN(token));
2384                 break;
2385
2386             case HEX_ENTITY:
2387                 // normalize hex entities (downcase them)
2388                 output = parser->capture ? parser->capture : parser->output;
2389                 _Wikitext_pop_excess_elements(parser);
2390                 _Wikitext_start_para_if_necessary(parser);
2391                 str_append(output, token->start, TOKEN_LEN(token));
2392                 _Wikitext_downcase_bang(output->ptr + output->len - TOKEN_LEN(token), TOKEN_LEN(token));
2393                 break;
2394
2395             case QUOT:
2396                 output = parser->capture ? parser->capture : parser->output;
2397                 _Wikitext_pop_excess_elements(parser);
2398                 _Wikitext_start_para_if_necessary(parser);
2399                 str_append(output, quot_entity, sizeof(quot_entity) - 1);
2400                 break;
2401
2402             case AMP:
2403                 output = parser->capture ? parser->capture : parser->output;
2404                 _Wikitext_pop_excess_elements(parser);
2405                 _Wikitext_start_para_if_necessary(parser);
2406                 str_append(output, amp_entity, sizeof(amp_entity) - 1);
2407                 break;
2408
2409             case LESS:
2410                 output = parser->capture ? parser->capture : parser->output;
2411                 _Wikitext_pop_excess_elements(parser);
2412                 _Wikitext_start_para_if_necessary(parser);
2413                 str_append(output, lt_entity, sizeof(lt_entity) - 1);
2414                 break;
2415
2416             case GREATER:
2417                 output = parser->capture ? parser->capture : parser->output;
2418                 _Wikitext_pop_excess_elements(parser);
2419                 _Wikitext_start_para_if_necessary(parser);
2420                 str_append(output, gt_entity, sizeof(gt_entity) - 1);
2421                 break;
2422
2423             case IMG_START:
2424                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2425                 {
2426                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2427                     str_append(parser->output, token->start, TOKEN_LEN(token));
2428                 }
2429                 else if (parser->capture)
2430                     str_append(parser->capture, token->start, TOKEN_LEN(token));
2431                 else
2432                 {
2433                     // not currently capturing: will be emitting something on success or failure, so get ready
2434                     _Wikitext_pop_excess_elements(parser);
2435                     _Wikitext_start_para_if_necessary(parser);
2436
2437                     // scan ahead consuming PATH, PRINTABLE, ALNUM and SPECIAL_URI_CHARS tokens
2438                     // will cheat here and abuse the link_target capture buffer to accumulate text
2439                     while (NEXT_TOKEN(), (type = token->type))
2440                     {
2441                         if (type == PATH || type == PRINTABLE || type == ALNUM || type == SPECIAL_URI_CHARS)
2442                             str_append(parser->link_target, token->start, TOKEN_LEN(token));
2443                         else if (type == IMG_END && parser->link_target->len > 0)
2444                         {
2445                             // success
2446                             _Wikitext_append_img(parser, parser->link_target->ptr, parser->link_target->len);
2447                             token = NULL;
2448                             break;
2449                         }
2450                         else // unexpected token or zero-length target (syntax error)
2451                         {
2452                             // rollback
2453                             str_append(parser->output, literal_img_start, sizeof(literal_img_start) - 1);
2454                             if (parser->link_target->len > 0)
2455                                 str_append(parser->output, parser->link_target->ptr, parser->link_target->len);
2456                             break;
2457                         }
2458                     }
2459
2460                     // jump to top of the loop to process token we scanned during lookahead
2461                     str_clear(parser->link_target);
2462                     continue;
2463                 }
2464                 break;
2465
2466             case CRLF:
2467                 i = parser->pending_crlf;
2468                 parser->pending_crlf = false;
2469                 _Wikitext_rollback_failed_link(parser); // if any
2470                 if (IN(NO_WIKI_START) || IN(PRE_START))
2471                 {
2472                     ary_clear(parser->line_buffer);
2473                     str_append_str(parser->output, parser->line_ending);
2474                     break;
2475                 }
2476                 else if (IN(PRE))
2477                 {
2478                     // beware when BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, that must be end of PRE block
2479                     if (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE)
2480                         // don't emit in this case
2481                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2482                     else
2483                     {
2484                         if (ary_entry(parser->line_buffer, -2) == PRE)
2485                         {
2486                              // only thing on line is the PRE: emit pending line ending (if we had one)
2487                              if (i)
2488                                  str_append_str(parser->output, parser->line_ending);
2489                         }
2490
2491                         // clear these _before_ calling NEXT_TOKEN (NEXT_TOKEN adds to the line_buffer)
2492                         ary_clear(parser->line);
2493                         ary_clear(parser->line_buffer);
2494
2495                         // peek ahead to see if this is definitely the end of the PRE block
2496                         NEXT_TOKEN();
2497                         type = token->type;
2498                         if (type != BLOCKQUOTE && type != PRE)
2499                             // this is definitely the end of the block, so don't emit
2500                             _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2501                         else
2502                             // potentially will emit
2503                             parser->pending_crlf = true;
2504
2505                         continue; // jump back to top of loop to handle token grabbed via lookahead
2506                     }
2507                 }
2508                 else
2509                 {
2510                     parser->pending_crlf = true;
2511
2512                     // count number of BLOCKQUOTE tokens in line buffer (can be zero) and pop back to that level
2513                     // as a side effect, this handles any open span-level elements and unclosed blocks
2514                     // (with special handling for P blocks and LI elements)
2515                     i = ary_count(parser->line, BLOCKQUOTE) + ary_count(parser->scope, BLOCKQUOTE_START);
2516                     for (j = parser->scope->count; j > i; j--)
2517                     {
2518                         if (parser->scope->count > 0 && ary_entry(parser->scope, -1) == LI)
2519                         {
2520                             parser->pending_crlf = false;
2521                             break;
2522                         }
2523
2524                         // special handling on last iteration through the loop if the top item on the scope is a P block
2525                         if ((j - i == 1) && ary_entry(parser->scope, -1) == P)
2526                         {
2527                             // if nothing or BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, this must be a paragraph break
2528                             // (note that we have to make sure we're not inside a BLOCKQUOTE_START block
2529                             // because in those blocks BLOCKQUOTE tokens have no special meaning)
2530                             if (NO_ITEM(ary_entry(parser->line_buffer, -2)) ||
2531                                 (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE && !IN(BLOCKQUOTE_START)))
2532                                 // paragraph break
2533                                 parser->pending_crlf = false;
2534                             else
2535                                 // not a paragraph break!
2536                                 continue;
2537                         }
2538                         _Wikitext_pop_from_stack(parser, NULL);
2539                     }
2540                 }
2541
2542                 // delete the entire contents of the line scope stack and buffer
2543                 ary_clear(parser->line);
2544                 ary_clear(parser->line_buffer);
2545                 break;
2546
2547             case SPECIAL_URI_CHARS:
2548             case PRINTABLE:
2549             case ALNUM:
2550             case IMG_END:
2551             case LEFT_CURLY:
2552             case RIGHT_CURLY:
2553                 output = parser->capture ? parser->capture : parser->output;
2554                 _Wikitext_pop_excess_elements(parser);
2555                 _Wikitext_start_para_if_necessary(parser);
2556                 str_append(output, token->start, TOKEN_LEN(token));
2557                 break;
2558
2559             case DEFAULT:
2560                 output = parser->capture ? parser->capture : parser->output;
2561                 _Wikitext_pop_excess_elements(parser);
2562                 _Wikitext_start_para_if_necessary(parser);
2563                 str_append_string(output, _Wikitext_utf32_char_to_entity(token->code_point));    // convert to entity
2564                 break;
2565
2566             case END_OF_FILE:
2567                 // special case for input like " foo\n " (see pre_spec.rb)
2568                 if (IN(PRE) &&
2569                     ary_entry(parser->line_buffer, -2) == PRE &&
2570                     parser->pending_crlf)
2571                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2572
2573                 // close any open scopes on hitting EOF
2574                 _Wikitext_rollback_failed_link(parser); // if any
2575                 _Wikitext_pop_all_from_stack(parser);
2576                 goto return_output; // break not enough here (want to break out of outer while loop, not inner switch statement)
2577
2578             default:
2579                 break;
2580         }
2581
2582         // reset current token; forcing lexer to return another token at the top of the loop
2583         token = NULL;
2584     } while (1);
2585 return_output:
2586     // TODO: make this fast
2587     return string_from_str(parser->output);
2588 }