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