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