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