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