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