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