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