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