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