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