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