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