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