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