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