]> git.wincent.com - wikitext.git/blob - ext/parser.c
Rename _Wikitext_hyperlink to _Wikitext_append_hyperlink
[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 // prepare hyperlink and append it to parser->output
234 void _Wikitext_append_hyperlink(parser_t *parser, VALUE link_prefix, VALUE link_target, VALUE link_text, VALUE link_class)
235 {
236     rb_str_cat(parser->output, a_start, sizeof(a_start) - 1);               // <a href="
237     if (!NIL_P(link_prefix))
238         rb_str_append(parser->output, link_prefix);
239     rb_str_append(parser->output, link_target);
240
241     // special handling for mailto URIs
242     const char *mailto = "mailto:";
243     if (NIL_P(link_prefix) &&
244         RSTRING_LEN(link_target) >= (long)sizeof(mailto) &&
245         strncmp(mailto, RSTRING_PTR(link_target), sizeof(mailto)) == 0)
246         link_class = parser->mailto_class; // use mailto_class from parser
247     if (link_class != Qnil)
248     {
249         rb_str_cat(parser->output, a_class, sizeof(a_class) - 1);           // " class="
250         rb_str_append(parser->output, link_class);
251     }
252     rb_str_cat(parser->output, a_start_close, sizeof(a_start_close) - 1);   // ">
253     rb_str_append(parser->output, link_text);
254     rb_str_cat(parser->output, a_end, sizeof(a_end) - 1);                   // </a>
255 }
256
257 void _Wikitext_append_img(parser_t *parser, char *token_ptr, int token_len)
258 {
259     rb_str_cat(parser->output, img_start, sizeof(img_start) - 1);   // <img src="
260     if (!NIL_P(parser->img_prefix) && *token_ptr != '/')            // len always > 0
261         rb_str_append(parser->output, parser->img_prefix);
262     rb_str_cat(parser->output, token_ptr, token_len);
263     rb_str_cat(parser->output, img_alt, sizeof(img_alt) - 1);       // " alt="
264     rb_str_cat(parser->output, token_ptr, token_len);
265     rb_str_cat(parser->output, img_end, sizeof(img_end) - 1);       // " />
266 }
267
268 // will emit indentation only if we are about to emit any of:
269 //      <blockquote>, <p>, <ul>, <ol>, <li>, <h1> etc, <pre>
270 // each time we enter one of those spans must ++ the indentation level
271 void _Wikitext_indent(parser_t *parser)
272 {
273     if (parser->base_indent == -1) // indentation disabled
274         return;
275     int space_count = parser->current_indent + parser->base_indent;
276     if (space_count > 0)
277     {
278         char *old_end, *new_end;
279         if (parser->tabulation->len < space_count)
280             str_grow(parser->tabulation, space_count); // reallocates if necessary
281         old_end = parser->tabulation->ptr + parser->tabulation->len;
282         new_end = parser->tabulation->ptr + space_count;
283         while (old_end < new_end)
284             *old_end++ = ' ';
285         if (space_count > parser->tabulation->len)
286             parser->tabulation->len = space_count;
287         rb_str_cat(parser->output, parser->tabulation->ptr, space_count);
288     }
289     parser->current_indent += 2;
290 }
291
292 void _Wikitext_dedent(parser_t *parser, VALUE emit)
293 {
294     if (parser->base_indent == -1) // indentation disabled
295         return;
296     parser->current_indent -= 2;
297     if (emit != Qtrue)
298         return;
299     int space_count = parser->current_indent + parser->base_indent;
300     if (space_count > 0)
301         rb_str_cat(parser->output, parser->tabulation->ptr, space_count);
302 }
303
304 // Pops a single item off the parser's scope stack.
305 // A corresponding closing tag is written to the target string.
306 // The target string may be the main output buffer, or a substring capturing buffer if a link is being scanned.
307 void _Wikitext_pop_from_stack(parser_t *parser, VALUE target)
308 {
309     int top = ary_entry(parser->scope, -1);
310     if (NO_ITEM(top))
311         return;
312     if (NIL_P(target))
313         target = parser->output;
314
315     // for headings, take base_heading_level into account
316     if (top >= H1_START && top <= H6_START)
317     {
318         top += parser->base_heading_level;
319         // no need to check for underflow (base_heading_level is never negative)
320         if (top > H6_START)
321             top = H6_START;
322     }
323
324     switch (top)
325     {
326         case PRE:
327         case PRE_START:
328             rb_str_cat(target, pre_end, sizeof(pre_end) - 1);
329             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
330             _Wikitext_dedent(parser, Qfalse);
331             break;
332
333         case BLOCKQUOTE:
334         case BLOCKQUOTE_START:
335             _Wikitext_dedent(parser, Qtrue);
336             rb_str_cat(target, blockquote_end, sizeof(blockquote_end) - 1);
337             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
338             break;
339
340         case NO_WIKI_START:
341             // not a real HTML tag; so nothing to pop
342             break;
343
344         case STRONG:
345         case STRONG_START:
346             rb_str_cat(target, strong_end, sizeof(strong_end) - 1);
347             break;
348
349         case EM:
350         case EM_START:
351             rb_str_cat(target, em_end, sizeof(em_end) - 1);
352             break;
353
354         case TT:
355         case TT_START:
356             rb_str_cat(target, tt_end, sizeof(tt_end) - 1);
357             break;
358
359         case OL:
360             _Wikitext_dedent(parser, Qtrue);
361             rb_str_cat(target, ol_end, sizeof(ol_end) - 1);
362             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
363             break;
364
365         case UL:
366             _Wikitext_dedent(parser, Qtrue);
367             rb_str_cat(target, ul_end, sizeof(ul_end) - 1);
368             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
369             break;
370
371         case NESTED_LIST:
372             // next token to pop will be a LI
373             // LI is an interesting token because sometimes we want it to behave like P (ie. do a non-emitting indent)
374             // and other times we want it to behave like BLOCKQUOTE (ie. when it has a nested list inside)
375             // hence this hack: we do an emitting dedent on behalf of the LI that we know must be coming
376             // and then when we pop the actual LI itself (below) we do the standard non-emitting indent
377             _Wikitext_dedent(parser, Qtrue);    // we really only want to emit the spaces
378             parser->current_indent += 2;        // we don't want to decrement the actual indent level, so put it back
379             break;
380
381         case LI:
382             rb_str_cat(target, li_end, sizeof(li_end) - 1);
383             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
384             _Wikitext_dedent(parser, Qfalse);
385             break;
386
387         case H6_START:
388             rb_str_cat(target, h6_end, sizeof(h6_end) - 1);
389             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
390             _Wikitext_dedent(parser, Qfalse);
391             break;
392
393         case H5_START:
394             rb_str_cat(target, h5_end, sizeof(h5_end) - 1);
395             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
396             _Wikitext_dedent(parser, Qfalse);
397             break;
398
399         case H4_START:
400             rb_str_cat(target, h4_end, sizeof(h4_end) - 1);
401             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
402             _Wikitext_dedent(parser, Qfalse);
403             break;
404
405         case H3_START:
406             rb_str_cat(target, h3_end, sizeof(h3_end) - 1);
407             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
408             _Wikitext_dedent(parser, Qfalse);
409             break;
410
411         case H2_START:
412             rb_str_cat(target, h2_end, sizeof(h2_end) - 1);
413             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
414             _Wikitext_dedent(parser, Qfalse);
415             break;
416
417         case H1_START:
418             rb_str_cat(target, h1_end, sizeof(h1_end) - 1);
419             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
420             _Wikitext_dedent(parser, Qfalse);
421             break;
422
423         case LINK_START:
424             // not an HTML tag; so nothing to emit
425             break;
426
427         case EXT_LINK_START:
428             // not an HTML tag; so nothing to emit
429             break;
430
431         case PATH:
432             // not an HTML tag; so nothing to emit
433             break;
434
435         case SPACE:
436             // not an HTML tag (only used to separate an external link target from the link text); so nothing to emit
437             break;
438
439         case SEPARATOR:
440             // not an HTML tag (only used to separate an external link target from the link text); so nothing to emit
441             break;
442
443         case P:
444             rb_str_cat(target, p_end, sizeof(p_end) - 1);
445             rb_str_cat(target, parser->line_ending->ptr, parser->line_ending->len);
446             _Wikitext_dedent(parser, Qfalse);
447             break;
448
449         case END_OF_FILE:
450             // nothing to do
451             break;
452
453         default:
454             // should probably raise an exception here
455             break;
456     }
457     ary_pop(parser->scope);
458 }
459
460 // Pops items off the top of parser's scope stack, accumulating closing tags for them into the target string, until item is reached.
461 // If including is Qtrue then the item itself is also popped.
462 // The target string may be the main output buffer, or a substring capturing buffer when scanning links.
463 void _Wikitext_pop_from_stack_up_to(parser_t *parser, VALUE target, int item, VALUE including)
464 {
465     int continue_looping = 1;
466     do
467     {
468         int top = ary_entry(parser->scope, -1);
469         if (NO_ITEM(top))
470             return;
471         if (top == item)
472         {
473             if (including != Qtrue)
474                 return;
475             continue_looping = 0;
476         }
477         _Wikitext_pop_from_stack(parser, target);
478     } while (continue_looping);
479 }
480
481 void _Wikitext_pop_all_from_stack(parser_t *parser, VALUE target)
482 {
483     while (!NO_ITEM(ary_entry(parser->scope, -1)))
484         _Wikitext_pop_from_stack(parser, target);
485 }
486
487 void _Wikitext_start_para_if_necessary(parser_t *parser)
488 {
489     if (!NIL_P(parser->capture))    // we don't do anything if in capturing mode
490         return;
491
492     // if no block open yet, or top of stack is BLOCKQUOTE/BLOCKQUOTE_START (with nothing in it yet)
493     if (parser->scope->count == 0 ||
494         ary_entry(parser->scope, -1) == BLOCKQUOTE ||
495         ary_entry(parser->scope, -1) == BLOCKQUOTE_START)
496     {
497         _Wikitext_indent(parser);
498         rb_str_cat(parser->output, p_start, sizeof(p_start) - 1);
499         ary_push(parser->scope, P);
500         ary_push(parser->line, P);
501     }
502     else if (parser->pending_crlf == Qtrue)
503     {
504         if (IN(P))
505             // already in a paragraph block; convert pending CRLF into a space
506             rb_str_cat(parser->output, space, sizeof(space) - 1);
507         else if (IN(PRE))
508             // PRE blocks can have pending CRLF too (helps us avoid emitting the trailing newline)
509             rb_str_cat(parser->output, parser->line_ending->ptr, parser->line_ending->len);
510     }
511     parser->pending_crlf = Qfalse;
512 }
513
514 void _Wikitext_emit_pending_crlf_if_necessary(parser_t *parser)
515 {
516     if (parser->pending_crlf == Qtrue)
517     {
518         rb_str_cat(parser->output, parser->line_ending->ptr, parser->line_ending->len);
519         parser->pending_crlf = Qfalse;
520     }
521 }
522
523 // Helper function that pops any excess elements off scope (pushing is already handled in the respective rules).
524 // For example, given input like:
525 //
526 //      > > foo
527 //      bar
528 //
529 // Upon seeing "bar", we want to pop two BLOCKQUOTE elements from the scope.
530 // The reverse case (shown below) is handled from inside the BLOCKQUOTE rule itself:
531 //
532 //      foo
533 //      > > bar
534 //
535 // Things are made slightly more complicated by the fact that there is one block-level tag that can be on the scope
536 // but not on the line scope:
537 //
538 //      <blockquote>foo
539 //      bar</blockquote>
540 //
541 // Here on seeing "bar" we have one item on the scope (BLOCKQUOTE_START) which we don't want to pop, but we have nothing
542 // on the line scope.
543 // Luckily, BLOCKQUOTE_START tokens can only appear at the start of the scope array, so we can check for them first before
544 // entering the for loop.
545 void _Wikitext_pop_excess_elements(parser_t *parser)
546 {
547     if (!NIL_P(parser->capture)) // we don't pop anything if in capturing mode
548         return;
549     for (int i = parser->scope->count - ary_count(parser->scope, BLOCKQUOTE_START), j = parser->line->count; i > j; i--)
550     {
551         // special case for last item on scope
552         if (i - j == 1)
553         {
554             // don't auto-pop P if it is only item on scope
555             if (ary_entry(parser->scope, -1) == P)
556             {
557                 // add P to the line scope to prevent us entering the loop at all next time around
558                 ary_push(parser->line, P);
559                 continue;
560             }
561         }
562         _Wikitext_pop_from_stack(parser, parser->output);
563     }
564 }
565
566 #define INVALID_ENCODING(msg)  do { if (dest_ptr) free(dest_ptr); rb_raise(eWikitextParserError, "invalid encoding: " msg); } while(0)
567
568 // convert a single UTF-8 codepoint to UTF-32
569 // expects an input buffer, src, containing a UTF-8 encoded character (which may be multi-byte)
570 // the end of the input buffer, end, is also passed in to allow the detection of invalidly truncated codepoints
571 // the number of bytes in the UTF-8 character (between 1 and 4) is returned by reference in width_out
572 // raises a RangeError if the supplied character is invalid UTF-8
573 // (in which case it also frees the block of memory indicated by dest_ptr if it is non-NULL)
574 uint32_t _Wikitext_utf8_to_utf32(char *src, char *end, long *width_out, void *dest_ptr)
575 {
576     uint32_t dest;
577     if ((unsigned char)src[0] <= 0x7f)                      // ASCII
578     {
579         dest = src[0];
580         *width_out = 1;
581     }
582     else if ((src[0] & 0xe0) == 0xc0)                       // byte starts with 110..... : this should be a two-byte sequence
583     {
584         if (src + 1 >= end)
585             INVALID_ENCODING("truncated byte sequence");    // no second byte
586         else if (((unsigned char)src[0] == 0xc0) || ((unsigned char)src[0] == 0xc1))
587             INVALID_ENCODING("overlong encoding");          // overlong encoding: lead byte of 110..... but code point <= 127
588         else if ((src[1] & 0xc0) != 0x80 )
589             INVALID_ENCODING("malformed byte sequence");    // should have second byte starting with 10......
590         dest = ((uint32_t)(src[0] & 0x1f)) << 6 | (src[1] & 0x3f);
591         *width_out = 2;
592     }
593     else if ((src[0] & 0xf0) == 0xe0)                       // byte starts with 1110.... : this should be a three-byte sequence
594     {
595         if (src + 2 >= end)
596             INVALID_ENCODING("truncated byte sequence");    // missing second or third byte
597         else if (((src[1] & 0xc0) != 0x80 ) || ((src[2] & 0xc0) != 0x80 ))
598             INVALID_ENCODING("malformed byte sequence");    // should have second and third bytes starting with 10......
599         dest = ((uint32_t)(src[0] & 0x0f)) << 12 | ((uint32_t)(src[1] & 0x3f)) << 6 | (src[2] & 0x3f);
600         *width_out = 3;
601     }
602     else if ((src[0] & 0xf8) == 0xf0)                       // bytes starts with 11110... : this should be a four-byte sequence
603     {
604         if (src + 3 >= end)
605             INVALID_ENCODING("truncated byte sequence");    // missing second, third, or fourth byte
606         else if ((unsigned char)src[0] >= 0xf5 && (unsigned char)src[0] <= 0xf7)
607             INVALID_ENCODING("overlong encoding");          // disallowed by RFC 3629 (codepoints above 0x10ffff)
608         else if (((src[1] & 0xc0) != 0x80 ) || ((src[2] & 0xc0) != 0x80 ) || ((src[3] & 0xc0) != 0x80 ))
609             INVALID_ENCODING("malformed byte sequence");    // should have second and third bytes starting with 10......
610         dest = ((uint32_t)(src[0] & 0x07)) << 18 | ((uint32_t)(src[1] & 0x3f)) << 12 | ((uint32_t)(src[1] & 0x3f)) << 6 | (src[2] & 0x3f);
611         *width_out = 4;
612     }
613     else                                                    // invalid input
614         INVALID_ENCODING("unexpected byte");
615     return dest;
616 }
617
618 VALUE _Wikitext_utf32_char_to_entity(uint32_t character)
619 {
620     // TODO: consider special casing some entities (ie. quot, amp, lt, gt etc)?
621     char hex_string[8]  = { '&', '#', 'x', 0, 0, 0, 0, ';' };
622     char scratch        = (character & 0xf000) >> 12;
623     hex_string[3]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
624     scratch             = (character & 0x0f00) >> 8;
625     hex_string[4]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
626     scratch             = (character & 0x00f0) >> 4;
627     hex_string[5]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
628     scratch             = character & 0x000f;
629     hex_string[6]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
630     return rb_str_new((const char *)hex_string, sizeof(hex_string));
631 }
632
633 VALUE _Wikitext_parser_trim_link_target(VALUE string)
634 {
635     string              = StringValue(string);
636     char    *src        = RSTRING_PTR(string);
637     char    *start      = src;                  // remember this so we can check if we're at the start
638     char    *left       = src;
639     char    *non_space  = src;                  // remember last non-space character output
640     long    len         = RSTRING_LEN(string);
641     char    *end        = src + len;
642     while (src < end)
643     {
644         if (*src == ' ')
645         {
646             if (src == left)
647                 left++;
648         }
649         else
650             non_space = src;
651         src++;
652     }
653     if (left == start && non_space + 1 == end)
654         return string;
655     else
656         return rb_str_new(left, (non_space + 1) - left);
657 }
658
659 // - non-printable (non-ASCII) characters converted to numeric entities
660 // - QUOT and AMP characters converted to named entities
661 // - if rollback is Qtrue, there is no special treatment of spaces
662 // - if rollback is Qfalse, leading and trailing whitespace trimmed
663 VALUE _Wikitext_parser_sanitize_link_target(parser_t *parser, VALUE rollback)
664 {
665     VALUE string        = StringValue(parser->link_target); // raises if string is nil or doesn't quack like a string
666     char    *src        = RSTRING_PTR(string);
667     char    *start      = src;                  // remember this so we can check if we're at the start
668     long    len         = RSTRING_LEN(string);
669     char    *end        = src + len;
670
671     // start with a destination buffer twice the size of the source, will realloc if necessary
672     // slop = (len / 8) * 8 (ie. one in every 8 characters can be converted into an entity, each entity requires 8 bytes)
673     // this efficiently handles the most common case (where the size of the buffer doesn't change much)
674     char    *dest       = ALLOC_N(char, len * 2);
675     char    *dest_ptr   = dest; // hang on to this so we can pass it to free() later
676     char    *non_space  = dest; // remember last non-space character output
677     while (src < end)
678     {
679         // need at most 8 characters (8 bytes) to display each character
680         if (dest + 8 > dest_ptr + len)                      // outgrowing buffer, must reallocate
681         {
682             char *old_dest      = dest;
683             char *old_dest_ptr  = dest_ptr;
684             len                 = len + (end - src) * 8;    // allocate enough for worst case
685             dest                = realloc(dest_ptr, len);   // will never have to realloc more than once
686             if (dest == NULL)
687             {
688                 // would have used reallocf, but this has to run on Linux too, not just Darwin
689                 free(dest_ptr);
690                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
691             }
692             dest_ptr    = dest;
693             dest        = dest_ptr + (old_dest - old_dest_ptr);
694             non_space   = dest_ptr + (non_space - old_dest_ptr);
695         }
696
697         if (*src == '"')                 // QUOT
698         {
699             char quot_entity_literal[] = { '&', 'q', 'u', 'o', 't', ';' };  // no trailing NUL
700             memcpy(dest, quot_entity_literal, sizeof(quot_entity_literal));
701             dest += sizeof(quot_entity_literal);
702         }
703         else if (*src == '&')            // AMP
704         {
705             char amp_entity_literal[] = { '&', 'a', 'm', 'p', ';' };    // no trailing NUL
706             memcpy(dest, amp_entity_literal, sizeof(amp_entity_literal));
707             dest += sizeof(amp_entity_literal);
708         }
709         else if (*src == '<')           // LESS_THAN
710         {
711             free(dest_ptr);
712             rb_raise(rb_eRangeError, "invalid link text (\"<\" may not appear in link text)");
713         }
714         else if (*src == '>')           // GREATER_THAN
715         {
716             free(dest_ptr);
717             rb_raise(rb_eRangeError, "invalid link text (\">\" may not appear in link text)");
718         }
719         else if (*src == ' ' && src == start && rollback == Qfalse)
720             start++;                // we eat leading space
721         else if (*src >= 0x20 && *src <= 0x7e)    // printable ASCII
722         {
723             *dest = *src;
724             dest++;
725         }
726         else    // all others: must convert to entities
727         {
728             long        width;
729             VALUE       entity      = _Wikitext_utf32_char_to_entity(_Wikitext_utf8_to_utf32(src, end, &width, dest_ptr));
730             char        *entity_src = RSTRING_PTR(entity);
731             long        entity_len  = RSTRING_LEN(entity); // should always be 8 characters (8 bytes)
732             memcpy(dest, entity_src, entity_len);
733             dest        += entity_len;
734             src         += width;
735             non_space   = dest;
736             continue;
737         }
738         if (*src != ' ')
739             non_space = dest;
740         src++;
741     }
742
743     // trim trailing space if necessary
744     if (rollback == Qfalse && non_space > dest_ptr && dest != non_space)
745         len = non_space - dest_ptr;
746     else
747         len = dest - dest_ptr;
748     VALUE out = rb_str_new(dest_ptr, len);
749     free(dest_ptr);
750     return out;
751 }
752
753 VALUE Wikitext_parser_sanitize_link_target(VALUE self, VALUE string)
754 {
755     parser_t parser;
756     parser.link_target          = string;
757     return _Wikitext_parser_sanitize_link_target(&parser, Qfalse);
758 }
759
760 // encodes the input string according to RFCs 2396 and 2718
761 // leading and trailing whitespace trimmed
762 // note that the first character of the target link is not case-sensitive
763 // (this is a recommended application-level constraint; it is not imposed at this level)
764 // this is to allow links like:
765 //         ...the [[foo]] is...
766 // to be equivalent to:
767 //         thing. [[Foo]] was...
768 static void _Wikitext_parser_encode_link_target(parser_t *parser)
769 {
770     VALUE in                = StringValue(parser->link_target);
771     char        *input      = RSTRING_PTR(in);
772     char        *start      = input;            // remember this so we can check if we're at the start
773     long        len         = RSTRING_LEN(in);
774     if (!(len > 0))
775         return;
776     char        *end        = input + len;
777     static char hex[]       = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
778
779     // to avoid most reallocations start with a destination buffer twice the size of the source
780     // this handles the most common case (where most chars are in the ASCII range and don't require more storage, but there are
781     // often quite a few spaces, which are encoded as "%20" and occupy 3 bytes)
782     // the worst case is where _every_ byte must be written out using 3 bytes
783     long        dest_len    = len * 2;
784     char        *dest       = ALLOC_N(char, dest_len);
785     char        *dest_ptr   = dest; // hang on to this so we can pass it to free() later
786     char        *non_space  = dest; // remember last non-space character output
787     for (; input < end; input++)
788     {
789         if ((dest + 3) > (dest_ptr + dest_len))     // worst case: a single character may grow to 3 characters once encoded
790         {
791             // outgrowing buffer, must reallocate
792             char *old_dest      = dest;
793             char *old_dest_ptr  = dest_ptr;
794             dest_len            += len;
795             dest                = realloc(dest_ptr, dest_len);
796             if (dest == NULL)
797             {
798                 // would have used reallocf, but this has to run on Linux too, not just Darwin
799                 free(dest_ptr);
800                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
801             }
802             dest_ptr    = dest;
803             dest        = dest_ptr + (old_dest - old_dest_ptr);
804             non_space   = dest_ptr + (non_space - old_dest_ptr);
805         }
806
807         // pass through unreserved characters
808         if (((*input >= 'a') && (*input <= 'z')) ||
809             ((*input >= 'A') && (*input <= 'Z')) ||
810             ((*input >= '0') && (*input <= '9')) ||
811             (*input == '-') ||
812             (*input == '_') ||
813             (*input == '.') ||
814             (*input == '~'))
815         {
816             *dest++     = *input;
817             non_space   = dest;
818         }
819         else if (*input == ' ' && input == start)
820             start++;                    // we eat leading space
821         else if (*input == ' ' && parser->space_to_underscore == Qtrue)
822             *dest++     = '_';
823         else    // everything else gets URL-encoded
824         {
825             *dest++     = '%';
826             *dest++     = hex[(unsigned char)(*input) / 16];   // left
827             *dest++     = hex[(unsigned char)(*input) % 16];   // right
828             if (*input != ' ')
829                 non_space = dest;
830         }
831     }
832
833     // trim trailing space if necessary
834     if (non_space > dest_ptr && dest != non_space)
835         dest_len = non_space - dest_ptr;
836     else
837         dest_len = dest - dest_ptr;
838     parser->link_target = rb_str_new(dest_ptr, dest_len);
839     free(dest_ptr);
840 }
841
842 VALUE Wikitext_parser_encode_link_target(VALUE self, VALUE in)
843 {
844     parser_t parser;
845     parser.link_target              = in;
846     parser.space_to_underscore      = Qfalse;
847     _Wikitext_parser_encode_link_target(&parser);
848     return parser.link_target;
849 }
850
851 // this method exposed for testing only
852 VALUE Wikitext_parser_encode_special_link_target(VALUE self, VALUE in)
853 {
854     parser_t parser;
855     parser.link_target              = in;
856     parser.space_to_underscore      = Qfalse;
857     _Wikitext_parser_encode_link_target(&parser);
858     return parser.link_target;
859 }
860
861 // returns 1 (true) if supplied string is blank (nil, empty, or all whitespace)
862 // returns 0 (false) otherwise
863 int _Wikitext_blank(VALUE str)
864 {
865     if (NIL_P(str) || RSTRING_LEN(str) == 0)
866         return 1;
867     for (char *ptr = RSTRING_PTR(str),
868         *end = RSTRING_PTR(str) + RSTRING_LEN(str);
869         ptr < end; ptr++)
870     {
871         if (*ptr != ' ')
872             return 0;
873     }
874     return 1;
875 }
876
877 void _Wikitext_rollback_failed_link(parser_t *parser)
878 {
879     if (!IN(LINK_START))
880         return; // nothing to do!
881     int scope_includes_separator = IN(SEPARATOR);
882     _Wikitext_pop_from_stack_up_to(parser, Qnil, LINK_START, Qtrue);
883     rb_str_cat(parser->output, link_start, sizeof(link_start) - 1);
884     if (!NIL_P(parser->link_target))
885     {
886         VALUE sanitized = _Wikitext_parser_sanitize_link_target(parser, Qtrue);
887         rb_str_append(parser->output, sanitized);
888         if (scope_includes_separator)
889         {
890             rb_str_cat(parser->output, separator, sizeof(separator) - 1);
891             if (!NIL_P(parser->link_text))
892                 rb_str_append(parser->output, parser->link_text);
893         }
894     }
895     parser->capture     = Qnil;
896     parser->link_target = Qnil;
897     parser->link_text   = Qnil;
898 }
899
900 void _Wikitext_rollback_failed_external_link(parser_t *parser)
901 {
902     if (!IN(EXT_LINK_START))
903         return; // nothing to do!
904     int scope_includes_space = IN(SPACE); // remember this before popping
905     _Wikitext_pop_from_stack_up_to(parser, Qnil, EXT_LINK_START, Qtrue);
906     rb_str_cat(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
907     if (!NIL_P(parser->link_target))
908     {
909         if (parser->autolink == Qtrue)
910             _Wikitext_append_hyperlink(parser, Qnil, parser->link_target, parser->link_target, parser->external_link_class);
911         else
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                         _Wikitext_append_hyperlink(parser, rb_str_new2("mailto:"), i, i, mailto_class);
1964                     else
1965                         rb_str_append(parser->output, i);
1966                 }
1967                 break;
1968
1969             case URI:
1970                 if (IN(NO_WIKI_START))
1971                     // user can temporarily suppress autolinking by using <nowiki></nowiki>
1972                     // note that unlike MediaWiki, we do allow autolinking inside PRE blocks
1973                     rb_str_cat(parser->output, token->start, TOKEN_LEN(token));
1974                 else if (IN(LINK_START))
1975                 {
1976                     // if the URI were allowed it would have been handled already in LINK_START
1977                     _Wikitext_rollback_failed_link(parser);
1978                     i = TOKEN_TEXT(token);
1979                     if (parser->autolink == Qtrue)
1980                         _Wikitext_append_hyperlink(parser, Qnil, i, i, parser->external_link_class); // link target, link text
1981                     else
1982                         rb_str_append(parser->output, i);
1983                 }
1984                 else if (IN(EXT_LINK_START))
1985                 {
1986                     if (NIL_P(parser->link_target))
1987                     {
1988                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
1989                         i = TOKEN_TEXT(token);
1990                         NEXT_TOKEN();
1991                         if (token->type == SPACE)
1992                         {
1993                             ary_push(parser->scope, SPACE);
1994                             parser->link_target = i;
1995                             parser->link_text   = rb_str_new2("");
1996                             parser->capture     = parser->link_text;
1997                             token               = NULL; // silently consume space
1998                         }
1999                         else
2000                         {
2001                             // didn't see the space! this must be an error
2002                             _Wikitext_pop_from_stack(parser, Qnil);
2003                             _Wikitext_pop_excess_elements(parser);
2004                             _Wikitext_start_para_if_necessary(parser);
2005                             rb_str_cat(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2006                             if (parser->autolink == Qtrue)
2007                                 _Wikitext_append_hyperlink(parser, Qnil, i, i, parser->external_link_class); // link target, link text
2008                             else
2009                                 rb_str_append(parser->output, i);
2010                         }
2011                     }
2012                     else
2013                     {
2014                         if (NIL_P(parser->link_text))
2015                             // this must be the first part of our link text
2016                             parser->link_text = TOKEN_TEXT(token);
2017                         else
2018                             // add to existing link text
2019                             rb_str_cat(parser->link_text, token->start, TOKEN_LEN(token));
2020                     }
2021                 }
2022                 else
2023                 {
2024                     // in plain scope, will turn into autolink (with appropriate, user-configurable CSS)
2025                     _Wikitext_pop_excess_elements(parser);
2026                     _Wikitext_start_para_if_necessary(parser);
2027                     i = TOKEN_TEXT(token);
2028                     if (parser->autolink == Qtrue)
2029                         _Wikitext_append_hyperlink(parser, Qnil, i, i, parser->external_link_class); // link target, link text
2030                     else
2031                         rb_str_append(parser->output, i);
2032                 }
2033                 break;
2034
2035             case PATH:
2036                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2037                     rb_str_cat(parser->output, token->start, TOKEN_LEN(token));
2038                 else if (IN(EXT_LINK_START))
2039                 {
2040                     if (NIL_P(parser->link_target))
2041                     {
2042                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2043                         i = TOKEN_TEXT(token);
2044                         NEXT_TOKEN();
2045                         if (token->type == SPACE)
2046                         {
2047                             ary_push(parser->scope, PATH);
2048                             ary_push(parser->scope, SPACE);
2049                             parser->link_target = i;
2050                             parser->link_text   = rb_str_new2("");
2051                             parser->capture     = parser->link_text;
2052                             token               = NULL; // silently consume space
2053                         }
2054                         else
2055                         {
2056                             // didn't see the space! this must be an error
2057                             _Wikitext_pop_from_stack(parser, Qnil);
2058                             _Wikitext_pop_excess_elements(parser);
2059                             _Wikitext_start_para_if_necessary(parser);
2060                             rb_str_cat(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2061                             rb_str_append(parser->output, i);
2062                         }
2063                     }
2064                     else
2065                     {
2066                         if (NIL_P(parser->link_text))
2067                             // this must be the first part of our link text
2068                             parser->link_text = TOKEN_TEXT(token);
2069                         else
2070                             // add to existing link text
2071                             rb_str_cat(parser->link_text, token->start, TOKEN_LEN(token));
2072                     }
2073                 }
2074                 else
2075                 {
2076                     i = NIL_P(parser->capture) ? parser->output : parser->capture;
2077                     _Wikitext_pop_excess_elements(parser);
2078                     _Wikitext_start_para_if_necessary(parser);
2079                     rb_str_cat(i, token->start, TOKEN_LEN(token));
2080                 }
2081                 break;
2082
2083             // internal links (links to other wiki articles) look like this:
2084             //      [[another article]] (would point at, for example, "/wiki/another_article")
2085             //      [[the other article|the link text we'll use for it]]
2086             //      [[the other article | the link text we'll use for it]]
2087             // MediaWiki has strict requirements about what it will accept as a link target:
2088             //      all wikitext markup is disallowed:
2089             //          example [[foo ''bar'' baz]]
2090             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2091             //          example [[foo <em>bar</em> baz]]
2092             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2093             //          example [[foo <nowiki>''</nowiki> baz]]
2094             //          renders [[foo '' baz]]                  (ie. not a link)
2095             //          example [[foo <bar> baz]]
2096             //          renders [[foo &lt;bar&gt; baz]]         (ie. not a link)
2097             //      HTML entities and non-ASCII, however, make it through:
2098             //          example [[foo &euro;]]
2099             //          renders <a href="/wiki/Foo_%E2%82%AC">foo &euro;</a>
2100             //          example [[foo €]]
2101             //          renders <a href="/wiki/Foo_%E2%82%AC">foo €</a>
2102             // we'll impose similar restrictions here for the link target; allowed tokens will be:
2103             //      SPACE, SPECIAL_URI_CHARS, PRINTABLE, PATH, ALNUM, DEFAULT, QUOT and AMP
2104             // everything else will be rejected
2105             case LINK_START:
2106                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2107                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2108                 {
2109                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2110                     rb_str_cat(i, link_start, sizeof(link_start) - 1);
2111                 }
2112                 else if (IN(EXT_LINK_START))
2113                     // already in external link scope! (and in fact, must be capturing link_text right now)
2114                     rb_str_cat(i, link_start, sizeof(link_start) - 1);
2115                 else if (IN(LINK_START))
2116                 {
2117                     // already in internal link scope! this is a syntax error
2118                     _Wikitext_rollback_failed_link(parser);
2119                     rb_str_cat(parser->output, link_start, sizeof(link_start) - 1);
2120                 }
2121                 else if (IN(SEPARATOR))
2122                 {
2123                     // scanning internal link text
2124                 }
2125                 else // not in internal link scope yet
2126                 {
2127                     // will either emit a link, or the rollback of a failed link, so start the para now
2128                     _Wikitext_pop_excess_elements(parser);
2129                     _Wikitext_start_para_if_necessary(parser);
2130                     ary_push(parser->scope, LINK_START);
2131
2132                     // look ahead and try to gobble up link target
2133                     while (NEXT_TOKEN(), (type = token->type))
2134                     {
2135                         if (type == SPACE               ||
2136                             type == SPECIAL_URI_CHARS   ||
2137                             type == PATH                ||
2138                             type == PRINTABLE           ||
2139                             type == ALNUM               ||
2140                             type == DEFAULT             ||
2141                             type == QUOT                ||
2142                             type == QUOT_ENTITY         ||
2143                             type == AMP                 ||
2144                             type == AMP_ENTITY          ||
2145                             type == IMG_START           ||
2146                             type == IMG_END             ||
2147                             type == LEFT_CURLY          ||
2148                             type == RIGHT_CURLY)
2149                         {
2150                             // accumulate these tokens into link_target
2151                             if (NIL_P(parser->link_target))
2152                             {
2153                                 parser->link_target = rb_str_new2("");
2154                                 parser->capture     = parser->link_target;
2155                             }
2156                             if (type == QUOT_ENTITY)
2157                                 // don't insert the entity, insert the literal quote
2158                                 rb_str_cat(parser->link_target, quote, sizeof(quote) - 1);
2159                             else if (type == AMP_ENTITY)
2160                                 // don't insert the entity, insert the literal ampersand
2161                                 rb_str_cat(parser->link_target, ampersand, sizeof(ampersand) - 1);
2162                             else
2163                                 rb_str_cat(parser->link_target, token->start, TOKEN_LEN(token));
2164                         }
2165                         else if (type == LINK_END)
2166                         {
2167                             if (NIL_P(parser->link_target)) // bail for inputs like "[[]]"
2168                                 _Wikitext_rollback_failed_link(parser);
2169                             break; // jump back to top of loop (will handle this in LINK_END case below)
2170                         }
2171                         else if (type == SEPARATOR)
2172                         {
2173                             if (NIL_P(parser->link_target)) // bail for inputs like "[[|"
2174                                 _Wikitext_rollback_failed_link(parser);
2175                             else
2176                             {
2177                                 ary_push(parser->scope, SEPARATOR);
2178                                 parser->link_text   = rb_str_new2("");
2179                                 parser->capture     = parser->link_text;
2180                                 token               = NULL;
2181                             }
2182                             break;
2183                         }
2184                         else // unexpected token (syntax error)
2185                         {
2186                             _Wikitext_rollback_failed_link(parser);
2187                             break; // jump back to top of loop to handle unexpected token
2188                         }
2189                     }
2190
2191                     // jump to top of the loop to process token we scanned during lookahead (if any)
2192                     continue;
2193                 }
2194                 break;
2195
2196             case LINK_END:
2197                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2198                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2199                 {
2200                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2201                     rb_str_cat(i, link_end, sizeof(link_end) - 1);
2202                 }
2203                 else if (IN(EXT_LINK_START))
2204                     // already in external link scope! (and in fact, must be capturing link_text right now)
2205                     rb_str_cat(i, link_end, sizeof(link_end) - 1);
2206                 else if (IN(LINK_START)) // in internal link scope!
2207                 {
2208                     if (_Wikitext_blank(parser->link_target))
2209                     {
2210                         // special case for inputs like "[[    ]]"
2211                         _Wikitext_rollback_failed_link(parser);
2212                         rb_str_cat(parser->output, link_end, sizeof(link_end) - 1);
2213                         break;
2214                     }
2215                     if (NIL_P(parser->link_text) || RSTRING_LEN(parser->link_text) == 0)
2216                         // use link target as link text
2217                         parser->link_text = _Wikitext_parser_sanitize_link_target(parser, Qfalse);
2218                     else
2219                         parser->link_text = _Wikitext_parser_trim_link_target(parser->link_text);
2220                     _Wikitext_parser_encode_link_target(parser);
2221                     _Wikitext_pop_from_stack_up_to(parser, i, LINK_START, Qtrue);
2222                     parser->capture     = Qnil;
2223                     _Wikitext_append_hyperlink(parser, prefix, parser->link_target, parser->link_text, Qnil);
2224                     parser->link_target = Qnil;
2225                     parser->link_text   = Qnil;
2226                 }
2227                 else // wasn't in internal link scope
2228                 {
2229                     _Wikitext_pop_excess_elements(parser);
2230                     _Wikitext_start_para_if_necessary(parser);
2231                     rb_str_cat(i, link_end, sizeof(link_end) - 1);
2232                 }
2233                 break;
2234
2235             // external links look like this:
2236             //      [http://google.com/ the link text]
2237             //      [/other/page/on/site see this page]
2238             // strings in square brackets which don't match this syntax get passed through literally; eg:
2239             //      he was very angery [sic] about the turn of events
2240             case EXT_LINK_START:
2241                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2242                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2243                 {
2244                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2245                     rb_str_cat(i, ext_link_start, sizeof(ext_link_start) - 1);
2246                 }
2247                 else if (IN(EXT_LINK_START))
2248                     // already in external link scope! (and in fact, must be capturing link_text right now)
2249                     rb_str_cat(i, ext_link_start, sizeof(ext_link_start) - 1);
2250                 else if (IN(LINK_START))
2251                 {
2252                     // already in internal link scope!
2253                     i = rb_str_new(ext_link_start, sizeof(ext_link_start) - 1);
2254                     if (NIL_P(parser->link_target))
2255                         // this must be the first character of our link target
2256                         parser->link_target = i;
2257                     else if (IN(SPACE))
2258                     {
2259                         // link target has already been scanned
2260                         if (NIL_P(parser->link_text))
2261                             // this must be the first character of our link text
2262                             parser->link_text = i;
2263                         else
2264                             // add to existing link text
2265                             rb_str_append(parser->link_text, i);
2266                     }
2267                     else
2268                         // add to existing link target
2269                         rb_str_append(parser->link_target, i);
2270                 }
2271                 else // not in external link scope yet
2272                 {
2273                     // will either emit a link, or the rollback of a failed link, so start the para now
2274                     _Wikitext_pop_excess_elements(parser);
2275                     _Wikitext_start_para_if_necessary(parser);
2276
2277                     // look ahead: expect an absolute URI (with protocol) or "relative" (path) URI
2278                     NEXT_TOKEN();
2279                     if (token->type == URI || token->type == PATH)
2280                         ary_push(parser->scope, EXT_LINK_START);    // so far so good, jump back to the top of the loop
2281                     else
2282                         // only get here if there was a syntax error (missing URI)
2283                         rb_str_cat(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2284                     continue; // jump back to top of loop to handle token (either URI or whatever it is)
2285                 }
2286                 break;
2287
2288             case EXT_LINK_END:
2289                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2290                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2291                 {
2292                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2293                     rb_str_cat(i, ext_link_end, sizeof(ext_link_end) - 1);
2294                 }
2295                 else if (IN(EXT_LINK_START))
2296                 {
2297                     if (NIL_P(parser->link_text))
2298                         // syntax error: external link with no link text
2299                         _Wikitext_rollback_failed_external_link(parser);
2300                     else
2301                     {
2302                         // success!
2303                         j = IN(PATH) ? Qnil : parser->external_link_class;
2304                         _Wikitext_pop_from_stack_up_to(parser, i, EXT_LINK_START, Qtrue);
2305                         parser->capture = Qnil;
2306                         _Wikitext_append_hyperlink(parser, Qnil, parser->link_target, parser->link_text, j);
2307                     }
2308                     parser->link_target = Qnil;
2309                     parser->link_text   = Qnil;
2310                 }
2311                 else
2312                 {
2313                     _Wikitext_pop_excess_elements(parser);
2314                     _Wikitext_start_para_if_necessary(parser);
2315                     rb_str_cat(parser->output, ext_link_end, sizeof(ext_link_end) - 1);
2316                 }
2317                 break;
2318
2319             case SEPARATOR:
2320                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2321                 _Wikitext_pop_excess_elements(parser);
2322                 _Wikitext_start_para_if_necessary(parser);
2323                 rb_str_cat(i, separator, sizeof(separator) - 1);
2324                 break;
2325
2326             case SPACE:
2327                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2328                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2329                 {
2330                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2331                     rb_str_cat(i, token->start, TOKEN_LEN(token));
2332                 }
2333                 else
2334                 {
2335                     // peek ahead to see next token
2336                     char    *token_ptr  = token->start;
2337                     int     token_len   = TOKEN_LEN(token);
2338                     NEXT_TOKEN();
2339                     type = token->type;
2340                     if (((type == H6_END) && IN(H6_START)) ||
2341                         ((type == H5_END) && IN(H5_START)) ||
2342                         ((type == H4_END) && IN(H4_START)) ||
2343                         ((type == H3_END) && IN(H3_START)) ||
2344                         ((type == H2_END) && IN(H2_START)) ||
2345                         ((type == H1_END) && IN(H1_START)))
2346                     {
2347                         // will suppress emission of space (discard) if next token is a H6_END, H5_END etc and we are in the corresponding scope
2348                     }
2349                     else
2350                     {
2351                         // emit the space
2352                         _Wikitext_pop_excess_elements(parser);
2353                         _Wikitext_start_para_if_necessary(parser);
2354                         rb_str_cat(i, token_ptr, token_len);
2355                     }
2356
2357                     // jump to top of the loop to process token we scanned during lookahead
2358                     continue;
2359                 }
2360                 break;
2361
2362             case QUOT_ENTITY:
2363             case AMP_ENTITY:
2364             case NAMED_ENTITY:
2365             case DECIMAL_ENTITY:
2366                 // pass these through unaltered as they are case sensitive
2367                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2368                 _Wikitext_pop_excess_elements(parser);
2369                 _Wikitext_start_para_if_necessary(parser);
2370                 rb_str_cat(i, token->start, TOKEN_LEN(token));
2371                 break;
2372
2373             case HEX_ENTITY:
2374                 // normalize hex entities (downcase them)
2375                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2376                 _Wikitext_pop_excess_elements(parser);
2377                 _Wikitext_start_para_if_necessary(parser);
2378                 rb_str_append(i, _Wikitext_downcase(TOKEN_TEXT(token)));
2379                 break;
2380
2381             case QUOT:
2382                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2383                 _Wikitext_pop_excess_elements(parser);
2384                 _Wikitext_start_para_if_necessary(parser);
2385                 rb_str_cat(i, quot_entity, sizeof(quot_entity) - 1);
2386                 break;
2387
2388             case AMP:
2389                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2390                 _Wikitext_pop_excess_elements(parser);
2391                 _Wikitext_start_para_if_necessary(parser);
2392                 rb_str_cat(i, amp_entity, sizeof(amp_entity) - 1);
2393                 break;
2394
2395             case LESS:
2396                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2397                 _Wikitext_pop_excess_elements(parser);
2398                 _Wikitext_start_para_if_necessary(parser);
2399                 rb_str_cat(i, lt_entity, sizeof(lt_entity) - 1);
2400                 break;
2401
2402             case GREATER:
2403                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2404                 _Wikitext_pop_excess_elements(parser);
2405                 _Wikitext_start_para_if_necessary(parser);
2406                 rb_str_cat(i, gt_entity, sizeof(gt_entity) - 1);
2407                 break;
2408
2409             case IMG_START:
2410                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2411                 {
2412                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2413                     rb_str_cat(parser->output, token->start, TOKEN_LEN(token));
2414                 }
2415                 else if (!NIL_P(parser->capture))
2416                     rb_str_cat(parser->capture, token->start, TOKEN_LEN(token));
2417                 else
2418                 {
2419                     // not currently capturing: will be emitting something on success or failure, so get ready
2420                     _Wikitext_pop_excess_elements(parser);
2421                     _Wikitext_start_para_if_necessary(parser);
2422
2423                     // scan ahead consuming PATH, PRINTABLE, ALNUM and SPECIAL_URI_CHARS tokens
2424                     // will cheat here and abuse the link_target capture buffer to accumulate text
2425                     if (NIL_P(parser->link_target))
2426                         parser->link_target = rb_str_new2("");
2427                     while (NEXT_TOKEN(), (type = token->type))
2428                     {
2429                         if (type == PATH || type == PRINTABLE || type == ALNUM || type == SPECIAL_URI_CHARS)
2430                             rb_str_cat(parser->link_target, token->start, TOKEN_LEN(token));
2431                         else if (type == IMG_END && RSTRING_LEN(parser->link_target) > 0)
2432                         {
2433                             // success
2434                             _Wikitext_append_img(parser, RSTRING_PTR(parser->link_target), RSTRING_LEN(parser->link_target));
2435                             token = NULL;
2436                             break;
2437                         }
2438                         else // unexpected token or zero-length target (syntax error)
2439                         {
2440                             // rollback
2441                             rb_str_cat(parser->output, literal_img_start, sizeof(literal_img_start) - 1);
2442                             rb_str_cat(parser->output, RSTRING_PTR(parser->link_target), RSTRING_LEN(parser->link_target));
2443                             break;
2444                         }
2445                     }
2446
2447                     // jump to top of the loop to process token we scanned during lookahead
2448                     parser->link_target = Qnil;
2449                     continue;
2450                 }
2451                 break;
2452
2453             case CRLF:
2454                 i = parser->pending_crlf;
2455                 parser->pending_crlf = Qfalse;
2456                 _Wikitext_rollback_failed_link(parser);             // if any
2457                 _Wikitext_rollback_failed_external_link(parser);    // if any
2458                 if (IN(NO_WIKI_START) || IN(PRE_START))
2459                 {
2460                     ary_clear(parser->line_buffer);
2461                     rb_str_cat(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2462                     break;
2463                 }
2464                 else if (IN(PRE))
2465                 {
2466                     // beware when BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, that must be end of PRE block
2467                     if (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE)
2468                         // don't emit in this case
2469                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, Qtrue);
2470                     else
2471                     {
2472                         if (ary_entry(parser->line_buffer, -2) == PRE)
2473                         {
2474                              // only thing on line is the PRE: emit pending line ending (if we had one)
2475                              if (i == Qtrue)
2476                                  rb_str_cat(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2477                         }
2478
2479                         // clear these _before_ calling NEXT_TOKEN (NEXT_TOKEN adds to the line_buffer)
2480                         ary_clear(parser->line);
2481                         ary_clear(parser->line_buffer);
2482
2483                         // peek ahead to see if this is definitely the end of the PRE block
2484                         NEXT_TOKEN();
2485                         type = token->type;
2486                         if (type != BLOCKQUOTE && type != PRE)
2487                             // this is definitely the end of the block, so don't emit
2488                             _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, Qtrue);
2489                         else
2490                             // potentially will emit
2491                             parser->pending_crlf = Qtrue;
2492
2493                         continue; // jump back to top of loop to handle token grabbed via lookahead
2494                     }
2495                 }
2496                 else
2497                 {
2498                     parser->pending_crlf = Qtrue;
2499
2500                     // count number of BLOCKQUOTE tokens in line buffer (can be zero) and pop back to that level
2501                     // as a side effect, this handles any open span-level elements and unclosed blocks
2502                     // (with special handling for P blocks and LI elements)
2503                     i = ary_count(parser->line, BLOCKQUOTE) + ary_count(parser->scope, BLOCKQUOTE_START);
2504                     for (j = parser->scope->count; j > i; j--)
2505                     {
2506                         if (parser->scope->count > 0 && ary_entry(parser->scope, -1) == LI)
2507                         {
2508                             parser->pending_crlf = Qfalse;
2509                             break;
2510                         }
2511
2512                         // special handling on last iteration through the loop if the top item on the scope is a P block
2513                         if ((j - i == 1) && ary_entry(parser->scope, -1) == P)
2514                         {
2515                             // if nothing or BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, this must be a paragraph break
2516                             // (note that we have to make sure we're not inside a BLOCKQUOTE_START block
2517                             // because in those blocks BLOCKQUOTE tokens have no special meaning)
2518                             if (NO_ITEM(ary_entry(parser->line_buffer, -2)) ||
2519                                 (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE && !IN(BLOCKQUOTE_START)))
2520                                 // paragraph break
2521                                 parser->pending_crlf = Qfalse;
2522                             else
2523                                 // not a paragraph break!
2524                                 continue;
2525                         }
2526                         _Wikitext_pop_from_stack(parser, Qnil);
2527                     }
2528                 }
2529
2530                 // delete the entire contents of the line scope stack and buffer
2531                 ary_clear(parser->line);
2532                 ary_clear(parser->line_buffer);
2533                 break;
2534
2535             case SPECIAL_URI_CHARS:
2536             case PRINTABLE:
2537             case ALNUM:
2538             case IMG_END:
2539             case LEFT_CURLY:
2540             case RIGHT_CURLY:
2541                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2542                 _Wikitext_pop_excess_elements(parser);
2543                 _Wikitext_start_para_if_necessary(parser);
2544                 rb_str_cat(i, token->start, TOKEN_LEN(token));
2545                 break;
2546
2547             case DEFAULT:
2548                 i = NIL_P(parser->capture) ? parser->output : parser->capture;
2549                 _Wikitext_pop_excess_elements(parser);
2550                 _Wikitext_start_para_if_necessary(parser);
2551                 rb_str_append(i, _Wikitext_utf32_char_to_entity(token->code_point));    // convert to entity
2552                 break;
2553
2554             case END_OF_FILE:
2555                 // special case for input like " foo\n " (see pre_spec.rb)
2556                 if (IN(PRE) &&
2557                     ary_entry(parser->line_buffer, -2) == PRE &&
2558                     parser->pending_crlf == Qtrue)
2559                     rb_str_cat(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2560
2561                 // close any open scopes on hitting EOF
2562                 _Wikitext_rollback_failed_external_link(parser);    // if any
2563                 _Wikitext_rollback_failed_link(parser);             // if any
2564                 for (i = 0, j = parser->scope->count; i < j; i++)
2565                     _Wikitext_pop_from_stack(parser, Qnil);
2566                 goto return_output; // break not enough here (want to break out of outer while loop, not inner switch statement)
2567
2568             default:
2569                 break;
2570         }
2571
2572         // reset current token; forcing lexer to return another token at the top of the loop
2573         token = NULL;
2574     } while (1);
2575 return_output:
2576     return parser->output;
2577 }