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