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