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