ext/parser.c

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