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