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