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