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 #define INVALID_ENCODING(msg)  do { if (dest_ptr) free(dest_ptr); rb_raise(eWikitextParserError, "invalid encoding: " msg); } while(0)
 620
 621 // Convert a single UTF-8 codepoint to UTF-32
 622 //
 623 // Expects an input buffer, src, containing a UTF-8 encoded character (which
 624 // may be multi-byte). The end of the input buffer, end, is also passed in to
 625 // allow the detection of invalidly truncated codepoints. The number of bytes
 626 // in the UTF-8 character (between 1 and 4) is returned by reference in
 627 // width_out.
 628 //
 629 // Raises a RangeError if the supplied character is invalid UTF-8 (in which
 630 // case it also frees the block of memory indicated by dest_ptr if it is
 631 // non-NULL).
 632 uint32_t _Wikitext_utf8_to_utf32(char *src, char *end, long *width_out, void *dest_ptr)
 633 {
 634     uint32_t dest;
 635     if ((unsigned char)src[0] <= 0x7f)
 636     {
 637         // ASCII
 638         dest = src[0];
 639         *width_out = 1;
 640     }
 641     else if ((src[0] & 0xe0) == 0xc0)
 642     {
 643         // byte starts with 110..... : this should be a two-byte sequence
 644         if (src + 1 >= end)
 645             // no second byte
 646             INVALID_ENCODING("truncated byte sequence");
 647         else if (((unsigned char)src[0] == 0xc0) ||
 648                 ((unsigned char)src[0] == 0xc1))
 649             // overlong encoding: lead byte of 110..... but code point <= 127
 650             INVALID_ENCODING("overlong encoding");
 651         else if ((src[1] & 0xc0) != 0x80 )
 652             // should have second byte starting with 10......
 653             INVALID_ENCODING("malformed byte sequence");
 654
 655         dest =
 656             ((uint32_t)(src[0] & 0x1f)) << 6 |
 657             (src[1] & 0x3f);
 658         *width_out = 2;
 659     }
 660     else if ((src[0] & 0xf0) == 0xe0)
 661     {
 662         // byte starts with 1110.... : this should be a three-byte sequence
 663         if (src + 2 >= end)
 664             // missing second or third byte
 665             INVALID_ENCODING("truncated byte sequence");
 666         else if (((src[1] & 0xc0) != 0x80 ) ||
 667                 ((src[2] & 0xc0) != 0x80 ))
 668             // should have second and third bytes starting with 10......
 669             INVALID_ENCODING("malformed byte sequence");
 670
 671         dest =
 672             ((uint32_t)(src[0] & 0x0f)) << 12 |
 673             ((uint32_t)(src[1] & 0x3f)) << 6 |
 674             (src[2] & 0x3f);
 675         *width_out = 3;
 676     }
 677     else if ((src[0] & 0xf8) == 0xf0)
 678     {
 679         // bytes starts with 11110... : this should be a four-byte sequence
 680         if (src + 3 >= end)
 681             // missing second, third, or fourth byte
 682             INVALID_ENCODING("truncated byte sequence");
 683         else if ((unsigned char)src[0] >= 0xf5 &&
 684                 (unsigned char)src[0] <= 0xf7)
 685             // disallowed by RFC 3629 (codepoints above 0x10ffff)
 686             INVALID_ENCODING("overlong encoding");
 687         else if (((src[1] & 0xc0) != 0x80 ) ||
 688                 ((src[2] & 0xc0) != 0x80 ) ||
 689                 ((src[3] & 0xc0) != 0x80 ))
 690             // should have second and third bytes starting with 10......
 691             INVALID_ENCODING("malformed byte sequence");
 692
 693         dest =
 694             ((uint32_t)(src[0] & 0x07)) << 18 |
 695             ((uint32_t)(src[1] & 0x3f)) << 12 |
 696             ((uint32_t)(src[1] & 0x3f)) << 6 |
 697             (src[2] & 0x3f);
 698         *width_out = 4;
 699     }
 700     else
 701         INVALID_ENCODING("unexpected byte");
 702     return dest;
 703 }
 704
 705 void _Wikitext_append_entity_from_utf32_char(char *output, uint32_t character)
 706 {
 707     // TODO: consider special casing some entities (ie. quot, amp, lt, gt etc)?
 708     char hex_string[8]  = { '&', '#', 'x', 0, 0, 0, 0, ';' };
 709     char scratch        = (character & 0xf000) >> 12;
 710     hex_string[3]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
 711     scratch             = (character & 0x0f00) >> 8;
 712     hex_string[4]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
 713     scratch             = (character & 0x00f0) >> 4;
 714     hex_string[5]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
 715     scratch             = character & 0x000f;
 716     hex_string[6]       = (scratch <= 9 ? scratch + 48 : scratch + 87);
 717     memcpy(output, hex_string, sizeof(hex_string));
 718 }
 719
 720 // trim parser->link_text in place
 721 void _Wikitext_parser_trim_link_text(parser_t *parser)
 722 {
 723     char    *src        = parser->link_text->ptr;
 724     char    *start      = src;                  // remember this so we can check if we're at the start
 725     char    *left       = src;
 726     char    *non_space  = src;                  // remember last non-space character output
 727     long    len         = parser->link_text->len;
 728     char    *end        = src + len;
 729     while (src < end)
 730     {
 731         if (*src == ' ')
 732         {
 733             if (src == left)
 734                 left++;
 735         }
 736         else
 737             non_space = src;
 738         src++;
 739     }
 740     if (left != start || non_space + 1 != end)
 741     {
 742         // TODO: could potentially avoid this memmove by extending the str_t struct with an "offset" or "free" member
 743         parser->link_text->len = (non_space + 1) - left;
 744         memmove(parser->link_text->ptr, left, parser->link_text->len);
 745     }
 746 }
 747
 748 // - non-printable (non-ASCII) characters converted to numeric entities
 749 // - QUOT and AMP characters converted to named entities
 750 // - if rollback is true, there is no special treatment of spaces
 751 // - if rollback is false, leading and trailing whitespace trimmed
 752 void _Wikitext_parser_append_sanitized_link_target(parser_t *parser, str_t *output, bool rollback)
 753 {
 754     char    *src    = parser->link_target->ptr;
 755     char    *start  = src;                  // remember this so we can check if we're at the start
 756     long    len     = parser->link_target->len;
 757     char    *end    = src + len;
 758
 759     // start with a destination buffer twice the size of the source, will realloc if necessary
 760     // slop = (len / 8) * 8 (ie. one in every 8 characters can be converted into an entity, each entity requires 8 bytes)
 761     // this efficiently handles the most common case (where the size of the buffer doesn't change much)
 762     char    *dest       = ALLOC_N(char, len * 2);
 763     char    *dest_ptr   = dest; // hang on to this so we can pass it to free() later
 764     char    *non_space  = dest; // remember last non-space character output
 765     while (src < end)
 766     {
 767         // need at most 8 characters (8 bytes) to display each character
 768         if (dest + 8 > dest_ptr + len)                      // outgrowing buffer, must reallocate
 769         {
 770             char *old_dest      = dest;
 771             char *old_dest_ptr  = dest_ptr;
 772             len                 = len + (end - src) * 8;    // allocate enough for worst case
 773             dest                = realloc(dest_ptr, len);   // will never have to realloc more than once
 774             if (dest == NULL)
 775             {
 776                 // would have used reallocf, but this has to run on Linux too, not just Darwin
 777                 free(dest_ptr);
 778                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
 779             }
 780             dest_ptr    = dest;
 781             dest        = dest_ptr + (old_dest - old_dest_ptr);
 782             non_space   = dest_ptr + (non_space - old_dest_ptr);
 783         }
 784
 785         if (*src == '"')
 786         {
 787             char quot_entity_literal[] = { '&', 'q', 'u', 'o', 't', ';' };  // no trailing NUL
 788             memcpy(dest, quot_entity_literal, sizeof(quot_entity_literal));
 789             dest += sizeof(quot_entity_literal);
 790         }
 791         else if (*src == '&')
 792         {
 793             char amp_entity_literal[] = { '&', 'a', 'm', 'p', ';' };    // no trailing NUL
 794             memcpy(dest, amp_entity_literal, sizeof(amp_entity_literal));
 795             dest += sizeof(amp_entity_literal);
 796         }
 797         else if (*src == '<' || *src == '>')
 798         {
 799             free(dest_ptr);
 800             rb_raise(rb_eRangeError, "invalid link text (\"%c\" may not appear in link text)", *src);
 801         }
 802         else if (*src == ' ' && src == start && !rollback)
 803             start++;                            // we eat leading space
 804         else if (*src >= 0x20 && *src <= 0x7e)  // printable ASCII
 805         {
 806             *dest = *src;
 807             dest++;
 808         }
 809         else    // all others: must convert to entities
 810         {
 811             long        width;
 812             _Wikitext_append_entity_from_utf32_char(dest, _Wikitext_utf8_to_utf32(src, end, &width, dest_ptr));
 813             dest        += 8; // always  8 characters (&#x0000;)
 814             src         += width;
 815             non_space   = dest;
 816             continue;
 817         }
 818         if (*src != ' ')
 819             non_space = dest;
 820         src++;
 821     }
 822
 823     // trim trailing space if necessary
 824     if (!rollback && non_space > dest_ptr && dest != non_space)
 825         len = non_space - dest_ptr;
 826     else
 827         len = dest - dest_ptr;
 828     str_append(output, dest_ptr, len);
 829     free(dest_ptr);
 830 }
 831
 832 VALUE Wikitext_parser_sanitize_link_target(VALUE self, VALUE string)
 833 {
 834     parser_t parser;
 835     parser.link_target = str_new_from_string(string);
 836     GC_WRAP_STR(parser.link_target, link_target_gc);
 837     str_t *output = str_new();
 838     GC_WRAP_STR(output, output_gc);
 839     _Wikitext_parser_append_sanitized_link_target(&parser, output, false);
 840     return string_from_str(output);
 841 }
 842
 843 // encodes the input string according to RFCs 2396 and 2718
 844 // leading and trailing whitespace trimmed
 845 // note that the first character of the target link is not case-sensitive
 846 // (this is a recommended application-level constraint; it is not imposed at this level)
 847 // this is to allow links like:
 848 //         ...the [[foo]] is...
 849 // to be equivalent to:
 850 //         thing. [[Foo]] was...
 851 static void _Wikitext_parser_encode_link_target(parser_t *parser)
 852 {
 853     char        *input      = parser->link_target->ptr;
 854     char        *start      = input;            // remember this so we can check if we're at the start
 855     long        len         = parser->link_target->len;
 856     if (!(len > 0))
 857         return;
 858     char        *end        = input + len;
 859     static char hex[]       = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
 860
 861     // to avoid most reallocations start with a destination buffer twice the size of the source
 862     // this handles the most common case (where most chars are in the ASCII range and don't require more storage, but there are
 863     // often quite a few spaces, which are encoded as "%20" and occupy 3 bytes)
 864     // the worst case is where _every_ byte must be written out using 3 bytes
 865     long        dest_len    = len * 2;
 866     char        *dest       = ALLOC_N(char, dest_len);
 867     char        *dest_ptr   = dest; // hang on to this so we can pass it to free() later
 868     char        *non_space  = dest; // remember last non-space character output
 869     for (; input < end; input++)
 870     {
 871         if ((dest + 3) > (dest_ptr + dest_len))     // worst case: a single character may grow to 3 characters once encoded
 872         {
 873             // outgrowing buffer, must reallocate
 874             char *old_dest      = dest;
 875             char *old_dest_ptr  = dest_ptr;
 876             dest_len            += len;
 877             dest                = realloc(dest_ptr, dest_len);
 878             if (dest == NULL)
 879             {
 880                 // would have used reallocf, but this has to run on Linux too, not just Darwin
 881                 free(dest_ptr);
 882                 rb_raise(rb_eNoMemError, "failed to re-allocate temporary storage (memory allocation error)");
 883             }
 884             dest_ptr    = dest;
 885             dest        = dest_ptr + (old_dest - old_dest_ptr);
 886             non_space   = dest_ptr + (non_space - old_dest_ptr);
 887         }
 888
 889         // pass through unreserved characters
 890         if (((*input >= 'a') && (*input <= 'z')) ||
 891             ((*input >= 'A') && (*input <= 'Z')) ||
 892             ((*input >= '0') && (*input <= '9')) ||
 893             (*input == '-') ||
 894             (*input == '_') ||
 895             (*input == '.') ||
 896             (*input == '~'))
 897         {
 898             *dest++     = *input;
 899             non_space   = dest;
 900         }
 901         else if (*input == ' ' && input == start)
 902             start++;                    // we eat leading space
 903         else if (*input == ' ' && parser->space_to_underscore)
 904             *dest++     = '_';
 905         else    // everything else gets URL-encoded
 906         {
 907             *dest++     = '%';
 908             *dest++     = hex[(unsigned char)(*input) / 16];   // left
 909             *dest++     = hex[(unsigned char)(*input) % 16];   // right
 910             if (*input != ' ')
 911                 non_space = dest;
 912         }
 913     }
 914
 915     // trim trailing space if necessary
 916     if (non_space > dest_ptr && dest != non_space)
 917         dest_len = non_space - dest_ptr;
 918     else
 919         dest_len = dest - dest_ptr;
 920
 921     // TOOD: try to avoid this copy by working directly inside link_target buffer
 922     str_clear(parser->link_target);
 923     str_append(parser->link_target, dest_ptr, dest_len);
 924     free(dest_ptr);
 925 }
 926
 927 VALUE Wikitext_parser_encode_link_target(VALUE self, VALUE in)
 928 {
 929     parser_t parser;
 930     parser.space_to_underscore      = false;
 931     parser.link_target              = str_new_from_string(in);
 932     GC_WRAP_STR(parser.link_target, link_target_gc);
 933     _Wikitext_parser_encode_link_target(&parser);
 934     return string_from_str(parser.link_target);
 935 }
 936
 937 // this method exposed for testing only
 938 VALUE Wikitext_parser_encode_special_link_target(VALUE self, VALUE in)
 939 {
 940     parser_t parser;
 941     parser.space_to_underscore      = false;
 942     parser.link_target              = str_new_from_string(in);
 943     GC_WRAP_STR(parser.link_target, link_target_gc);
 944     _Wikitext_parser_encode_link_target(&parser);
 945     return string_from_str(parser.link_target);
 946 }
 947
 948 // returns 1 (true) if supplied string is blank (nil, empty, or all whitespace)
 949 // returns 0 (false) otherwise
 950 bool _Wikitext_blank(str_t *str)
 951 {
 952     if (str->len == 0)
 953         return true;
 954     for (char *ptr = str->ptr,
 955         *end = str->ptr + str->len;
 956         ptr < end; ptr++)
 957     {
 958         if (*ptr != ' ')
 959             return false;
 960     }
 961     return true;
 962 }
 963
 964 void _Wikitext_rollback_failed_internal_link(parser_t *parser)
 965 {
 966     if (!IN(LINK_START))
 967         return; // nothing to do!
 968     int scope_includes_separator = IN(SEPARATOR);
 969     _Wikitext_pop_from_stack_up_to(parser, NULL, LINK_START, true);
 970     str_append(parser->output, link_start, sizeof(link_start) - 1);
 971     if (parser->link_target->len > 0)
 972     {
 973         _Wikitext_parser_append_sanitized_link_target(parser, parser->output, true);
 974         if (scope_includes_separator)
 975         {
 976             str_append(parser->output, separator, sizeof(separator) - 1);
 977             if (parser->link_text->len > 0)
 978                 str_append_str(parser->output, parser->link_text);
 979         }
 980     }
 981     parser->capture = NULL;
 982     str_clear(parser->link_target);
 983     str_clear(parser->link_text);
 984 }
 985
 986 void _Wikitext_rollback_failed_external_link(parser_t *parser)
 987 {
 988     if (!IN(EXT_LINK_START))
 989         return; // nothing to do!
 990
 991     // store a couple of values before popping
 992     int scope_includes_space = IN(SPACE);
 993     VALUE link_class = IN(PATH) ? Qnil : parser->external_link_class;
 994     _Wikitext_pop_from_stack_up_to(parser, NULL, EXT_LINK_START, true);
 995
 996     str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
 997     if (parser->link_target->len > 0)
 998     {
 999         _Wikitext_append_hyperlink(parser, Qnil, parser->link_target, NULL, link_class, true);
1000         if (scope_includes_space)
1001         {
1002             str_append(parser->output, space, sizeof(space) - 1);
1003             if (parser->link_text->len > 0)
1004                 str_append_str(parser->output, parser->link_text);
1005         }
1006     }
1007     parser->capture = NULL;
1008     str_clear(parser->link_target);
1009     str_clear(parser->link_text);
1010 }
1011
1012 void _Wikitext_rollback_failed_link(parser_t *parser)
1013 {
1014     _Wikitext_rollback_failed_internal_link(parser);
1015     _Wikitext_rollback_failed_external_link(parser);
1016 }
1017
1018 VALUE Wikitext_parser_initialize(int argc, VALUE *argv, VALUE self)
1019 {
1020     // process arguments
1021     VALUE options;
1022     if (rb_scan_args(argc, argv, "01", &options) == 0) // 0 mandatory arguments, 1 optional argument
1023         options = Qnil;
1024
1025     // defaults
1026     VALUE autolink                      = Qtrue;
1027     VALUE line_ending                   = rb_str_new2("\n");
1028     VALUE external_link_class           = rb_str_new2("external");
1029     VALUE mailto_class                  = rb_str_new2("mailto");
1030     VALUE internal_link_prefix          = rb_str_new2("/wiki/");
1031     VALUE img_prefix                    = rb_str_new2("/images/");
1032     VALUE space_to_underscore           = Qtrue;
1033     VALUE minimum_fulltext_token_length = INT2NUM(3);
1034     VALUE base_heading_level            = INT2NUM(0);
1035
1036     // process options hash (override defaults)
1037     if (!NIL_P(options) && TYPE(options) == T_HASH)
1038     {
1039 #define OVERRIDE_IF_SET(name)   rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern(#name))) == Qtrue ? \
1040                                 rb_hash_aref(options, ID2SYM(rb_intern(#name))) : name
1041         autolink                        = OVERRIDE_IF_SET(autolink);
1042         line_ending                     = OVERRIDE_IF_SET(line_ending);
1043         external_link_class             = OVERRIDE_IF_SET(external_link_class);
1044         mailto_class                    = OVERRIDE_IF_SET(mailto_class);
1045         internal_link_prefix            = OVERRIDE_IF_SET(internal_link_prefix);
1046         img_prefix                      = OVERRIDE_IF_SET(img_prefix);
1047         space_to_underscore             = OVERRIDE_IF_SET(space_to_underscore);
1048         minimum_fulltext_token_length   = OVERRIDE_IF_SET(minimum_fulltext_token_length);
1049         base_heading_level              = OVERRIDE_IF_SET(base_heading_level);
1050     }
1051
1052     // no need to call super here; rb_call_super()
1053     rb_iv_set(self, "@autolink",                        autolink);
1054     rb_iv_set(self, "@line_ending",                     line_ending);
1055     rb_iv_set(self, "@external_link_class",             external_link_class);
1056     rb_iv_set(self, "@mailto_class",                    mailto_class);
1057     rb_iv_set(self, "@internal_link_prefix",            internal_link_prefix);
1058     rb_iv_set(self, "@img_prefix",                      img_prefix);
1059     rb_iv_set(self, "@space_to_underscore",             space_to_underscore);
1060     rb_iv_set(self, "@minimum_fulltext_token_length",   minimum_fulltext_token_length);
1061     rb_iv_set(self, "@base_heading_level",              base_heading_level);
1062     return self;
1063 }
1064
1065 VALUE Wikitext_parser_profiling_parse(VALUE self, VALUE string)
1066 {
1067     for (int i = 0; i < 100000; i++)
1068         Wikitext_parser_parse(1, &string, self);
1069     return Qnil;
1070 }
1071
1072 VALUE Wikitext_parser_parse(int argc, VALUE *argv, VALUE self)
1073 {
1074     // process arguments
1075     VALUE string, options;
1076     if (rb_scan_args(argc, argv, "11", &string, &options) == 1) // 1 mandatory argument, 1 optional argument
1077         options = Qnil;
1078     if (NIL_P(string))
1079         return Qnil;
1080     string = StringValue(string);
1081
1082     // process options hash
1083     int base_indent = 0;
1084     int base_heading_level = NUM2INT(rb_iv_get(self, "@base_heading_level"));
1085     if (!NIL_P(options) && TYPE(options) == T_HASH)
1086     {
1087         // :indent => 0 (or more)
1088         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("indent"))) == Qtrue)
1089         {
1090             VALUE indent = rb_hash_aref(options, ID2SYM(rb_intern("indent")));
1091             if (indent == Qfalse)
1092                 base_indent = -1; // indentation disabled
1093             else
1094             {
1095                 base_indent = NUM2INT(indent);
1096                 if (base_indent < 0)
1097                     base_indent = 0;
1098             }
1099         }
1100
1101         // :base_heading_level => 0/1/2/3/4/5/6
1102         if (rb_funcall(options, rb_intern("has_key?"), 1, ID2SYM(rb_intern("base_heading_level"))) == Qtrue)
1103             base_heading_level = NUM2INT(rb_hash_aref(options, ID2SYM(rb_intern("base_heading_level"))));
1104     }
1105
1106     // normalize, regardless of whether this came from instance variable or override
1107     if (base_heading_level < 0)
1108         base_heading_level = 0;
1109     if (base_heading_level > 6)
1110         base_heading_level = 6;
1111
1112     // set up scanner
1113     char *p = RSTRING_PTR(string);
1114     long len = RSTRING_LEN(string);
1115     char *pe = p + len;
1116
1117     // the eventual return value
1118     VALUE out = rb_str_new2("");
1119
1120     // access these once per parse
1121     VALUE line_ending   = rb_iv_get(self, "@line_ending");
1122     line_ending         = StringValue(line_ending);
1123     VALUE link_class    = rb_iv_get(self, "@external_link_class");
1124     link_class          = NIL_P(link_class) ? Qnil : StringValue(link_class);
1125     VALUE mailto_class  = rb_iv_get(self, "@mailto_class");
1126     mailto_class        = NIL_P(mailto_class) ? Qnil : StringValue(mailto_class);
1127     VALUE prefix        = rb_iv_get(self, "@internal_link_prefix");
1128
1129     // set up parser struct to make passing parameters a little easier
1130     parser_t *parser                = parser_new();
1131     GC_WRAP_PARSER(parser, parser_gc);
1132     parser->external_link_class     = link_class;
1133     parser->mailto_class            = mailto_class;
1134     parser->img_prefix              = rb_iv_get(self, "@img_prefix");
1135     parser->autolink                = rb_iv_get(self, "@autolink") == Qtrue ? true : false;
1136     parser->space_to_underscore     = rb_iv_get(self, "@space_to_underscore") == Qtrue ? true : false;
1137     parser->line_ending             = str_new_from_string(line_ending);
1138     parser->base_indent             = base_indent;
1139     parser->base_heading_level      = base_heading_level;
1140
1141     // this simple looping design leads to a single enormous function,
1142     // but it's faster than doing actual recursive descent and also secure in the face of
1143     // malicious input that seeks to overflow the stack
1144     // (with "<blockquote><blockquote><blockquote>..." times by 10,000, for example)
1145     // given that we expect to deal with a lot of malformed input, a recursive descent design is less appropriate
1146     // than a straightforward looping translator like this one anyway
1147     token_t _token;
1148     _token.type = NO_TOKEN;
1149     token_t *token = NULL;
1150     do
1151     {
1152         // note that whenever we grab a token we push it into the line buffer
1153         // this provides us with context-sensitive "memory" of what's been seen so far on this line
1154 #define NEXT_TOKEN()    token = &_token, next_token(token, token, NULL, pe), ary_push(parser->line_buffer, token->type)
1155
1156         // check to see if we have a token hanging around from a previous iteration of this loop
1157         if (token == NULL)
1158         {
1159             if (_token.type == NO_TOKEN)
1160             {
1161                 // first time here (haven't started scanning yet)
1162                 token = &_token;
1163                 next_token(token, NULL, p, pe);
1164                 ary_push(parser->line_buffer, token->type);
1165             }
1166             else
1167                 // already scanning
1168                 NEXT_TOKEN();
1169         }
1170         int type = token->type;
1171
1172         // can't declare new variables inside a switch statement, so predeclare them here
1173         long remove_strong          = -1;
1174         long remove_em              = -1;
1175
1176         // general purpose counters, flags and pointers
1177         long i                      = 0;
1178         long j                      = 0;
1179         long k                      = 0;
1180         str_t *output               = NULL;
1181         str_t _token_str;
1182         str_t *token_str            = &_token_str;
1183
1184         // The following giant switch statement contains cases for all the possible token types.
1185         // In the most basic sense we are emitting the HTML that corresponds to each token,
1186         // but some tokens require context information in order to decide what to output.
1187         // For example, does the STRONG token (''') translate to <strong> or </strong>?
1188         // So when looking at any given token we have three state-maintaining variables which gives us a notion of "where we are":
1189         //
1190         //  - the "scope" stack (indicates what HTML DOM structures we are currently nested inside, similar to a CSS selector)
1191         //  - the line buffer (records tokens seen so far on the current line)
1192         //  - the line "scope" stack (indicates what the scope should be based only on what is visible on the line so far)
1193         //
1194         // Although this is fairly complicated, there is one key simplifying factor:
1195         // The translator continuously performs auto-correction, and this means that we always have a guarantee that the
1196         // scope stack (up to the current token) is valid; our translator can take this as a given.
1197         // Auto-correction basically consists of inserting missing tokens (preventing subsquent HTML from being messed up),
1198         // or converting illegal (unexpected) tokens to their plain text equivalents (providing visual feedback to Wikitext author).
1199         switch (type)
1200         {
1201             case PRE:
1202                 if (IN(NO_WIKI_START) || IN(PRE_START))
1203                 {
1204                     str_append(parser->output, space, sizeof(space) - 1);
1205                     break;
1206                 }
1207                 else if (IN(BLOCKQUOTE_START))
1208                 {
1209                     // this kind of nesting not allowed (to avoid user confusion)
1210                     _Wikitext_pop_excess_elements(parser);
1211                     _Wikitext_start_para_if_necessary(parser);
1212                     output = parser->capture ? parser->capture : parser->output;
1213                     str_append(output, space, sizeof(space) - 1);
1214                     break;
1215                 }
1216
1217                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1218                 ary_push(parser->line, PRE);
1219                 i = ary_count(parser->line, BLOCKQUOTE);
1220                 j = ary_count(parser->scope, BLOCKQUOTE);
1221                 if (i < j)
1222                 {
1223                     // must pop (reduce nesting level)
1224                     for (i = j - i; i > 0; i--)
1225                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1226                 }
1227
1228                 if (!IN(PRE))
1229                 {
1230                     parser->pending_crlf = false;
1231                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1232                     _Wikitext_indent(parser);
1233                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1234                     ary_push(parser->scope, PRE);
1235                 }
1236                 break;
1237
1238             case PRE_START:
1239                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1240                 {
1241                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1242                     str_append(parser->output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1243                 }
1244                 else if (IN(BLOCKQUOTE_START))
1245                 {
1246                     _Wikitext_rollback_failed_link(parser); // if any
1247                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1248                     _Wikitext_indent(parser);
1249                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1250                     ary_push(parser->scope, PRE_START);
1251                     ary_push(parser->line, PRE_START);
1252                 }
1253                 else if (IN(BLOCKQUOTE))
1254                 {
1255                     if (token->column_start == 1) // only allowed in first column
1256                     {
1257                         _Wikitext_rollback_failed_link(parser); // if any
1258                         _Wikitext_pop_all_from_stack(parser);
1259                         _Wikitext_indent(parser);
1260                         str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1261                         ary_push(parser->scope, PRE_START);
1262                         ary_push(parser->line, PRE_START);
1263                     }
1264                     else // PRE_START illegal here
1265                     {
1266                         output = parser->capture ? parser->capture : parser->output;
1267                         _Wikitext_pop_excess_elements(parser);
1268                         _Wikitext_start_para_if_necessary(parser);
1269                         str_append(output, escaped_pre_start, sizeof(escaped_pre_start) - 1);
1270                     }
1271                 }
1272                 else
1273                 {
1274                     _Wikitext_rollback_failed_link(parser); // if any
1275                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1276                     _Wikitext_indent(parser);
1277                     str_append(parser->output, pre_start, sizeof(pre_start) - 1);
1278                     ary_push(parser->scope, PRE_START);
1279                     ary_push(parser->line, PRE_START);
1280                 }
1281                 break;
1282
1283             case PRE_END:
1284                 if (IN(NO_WIKI_START) || IN(PRE))
1285                 {
1286                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1287                     str_append(parser->output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1288                 }
1289                 else
1290                 {
1291                     if (IN(PRE_START))
1292                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE_START, true);
1293                     else
1294                     {
1295                         output = parser->capture ? parser->capture : parser->output;
1296                         _Wikitext_pop_excess_elements(parser);
1297                         _Wikitext_start_para_if_necessary(parser);
1298                         str_append(output, escaped_pre_end, sizeof(escaped_pre_end) - 1);
1299                     }
1300                 }
1301                 break;
1302
1303             case BLOCKQUOTE:
1304                 if (IN(NO_WIKI_START) || IN(PRE_START))
1305                     // no need to check for <pre>; can never appear inside it
1306                     str_append(parser->output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1307                 else if (IN(BLOCKQUOTE_START))
1308                 {
1309                     // this kind of nesting not allowed (to avoid user confusion)
1310                     _Wikitext_pop_excess_elements(parser);
1311                     _Wikitext_start_para_if_necessary(parser);
1312                     output = parser->capture ? parser->capture : parser->output;
1313                     str_append(output, escaped_blockquote, TOKEN_LEN(token) + 3); // will either emit "&gt;" or "&gt; "
1314                     break;
1315                 }
1316                 else
1317                 {
1318                     ary_push(parser->line, BLOCKQUOTE);
1319
1320                     // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1321                     i = ary_count(parser->line, BLOCKQUOTE);
1322                     j = ary_count(parser->scope, BLOCKQUOTE);
1323
1324                     // 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
1325                     while (NEXT_TOKEN(), (token->type == BLOCKQUOTE))
1326                     {
1327                         ary_push(parser->line, BLOCKQUOTE);
1328                         i++;
1329                     }
1330
1331                     // now decide whether to push, pop or do nothing
1332                     if (i > j)
1333                     {
1334                         // must push (increase nesting level)
1335                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1336                         for (i = i - j; i > 0; i--)
1337                         {
1338                             _Wikitext_indent(parser);
1339                             str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1340                             str_append_str(parser->output, parser->line_ending);
1341                             ary_push(parser->scope, BLOCKQUOTE);
1342                         }
1343                     }
1344                     else if (i < j)
1345                     {
1346                         // must pop (reduce nesting level)
1347                         for (i = j - i; i > 0; i--)
1348                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1349                     }
1350
1351                     // jump to top of the loop to process token we scanned during lookahead
1352                     continue;
1353                 }
1354                 break;
1355
1356             case BLOCKQUOTE_START:
1357                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1358                 {
1359                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1360                     str_append(parser->output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1361                 }
1362                 else if (IN(BLOCKQUOTE_START))
1363                 {
1364                     // nesting is fine here
1365                     _Wikitext_rollback_failed_link(parser); // if any
1366                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1367                     _Wikitext_indent(parser);
1368                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1369                     str_append_str(parser->output, parser->line_ending);
1370                     ary_push(parser->scope, BLOCKQUOTE_START);
1371                     ary_push(parser->line, BLOCKQUOTE_START);
1372                 }
1373                 else if (IN(BLOCKQUOTE))
1374                 {
1375                     if (token->column_start == 1) // only allowed in first column
1376                     {
1377                         _Wikitext_rollback_failed_link(parser); // if any
1378                         _Wikitext_pop_all_from_stack(parser);
1379                         _Wikitext_indent(parser);
1380                         str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1381                         str_append_str(parser->output, parser->line_ending);
1382                         ary_push(parser->scope, BLOCKQUOTE_START);
1383                         ary_push(parser->line, BLOCKQUOTE_START);
1384                     }
1385                     else // BLOCKQUOTE_START illegal here
1386                     {
1387                         output = parser->capture ? parser->capture : parser->output;
1388                         _Wikitext_pop_excess_elements(parser);
1389                         _Wikitext_start_para_if_necessary(parser);
1390                         str_append(output, escaped_blockquote_start, sizeof(escaped_blockquote_start) - 1);
1391                     }
1392                 }
1393                 else
1394                 {
1395                     // would be nice to eliminate the repetition here but it's probably the clearest way
1396                     _Wikitext_rollback_failed_link(parser); // if any
1397                     _Wikitext_pop_from_stack_up_to(parser, NULL, P, true);
1398                     _Wikitext_indent(parser);
1399                     str_append(parser->output, blockquote_start, sizeof(blockquote_start) - 1);
1400                     str_append_str(parser->output, parser->line_ending);
1401                     ary_push(parser->scope, BLOCKQUOTE_START);
1402                     ary_push(parser->line, BLOCKQUOTE_START);
1403                 }
1404                 break;
1405
1406             case BLOCKQUOTE_END:
1407                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1408                 {
1409                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1410                     str_append(parser->output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1411                 }
1412                 else
1413                 {
1414                     if (IN(BLOCKQUOTE_START))
1415                         _Wikitext_pop_from_stack_up_to(parser, parser->output, BLOCKQUOTE_START, true);
1416                     else
1417                     {
1418                         output = parser->capture ? parser->capture : parser->output;
1419                         _Wikitext_pop_excess_elements(parser);
1420                         _Wikitext_start_para_if_necessary(parser);
1421                         str_append(output, escaped_blockquote_end, sizeof(escaped_blockquote_end) - 1);
1422                     }
1423                 }
1424                 break;
1425
1426             case NO_WIKI_START:
1427                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1428                 {
1429                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1430                     str_append(parser->output, escaped_no_wiki_start, sizeof(escaped_no_wiki_start) - 1);
1431                 }
1432                 else
1433                 {
1434                     _Wikitext_pop_excess_elements(parser);
1435                     _Wikitext_start_para_if_necessary(parser);
1436                     ary_push(parser->scope, NO_WIKI_START);
1437                     ary_push(parser->line, NO_WIKI_START);
1438                 }
1439                 break;
1440
1441             case NO_WIKI_END:
1442                 if (IN(NO_WIKI_START))
1443                     // <nowiki> should always only ever be the last item in the stack, but use the helper routine just in case
1444                     _Wikitext_pop_from_stack_up_to(parser, NULL, NO_WIKI_START, true);
1445                 else
1446                 {
1447                     _Wikitext_pop_excess_elements(parser);
1448                     _Wikitext_start_para_if_necessary(parser);
1449                     str_append(parser->output, escaped_no_wiki_end, sizeof(escaped_no_wiki_end) - 1);
1450                 }
1451                 break;
1452
1453             case STRONG_EM:
1454                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1455                 {
1456                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1457                     str_append(parser->output, literal_strong_em, sizeof(literal_strong_em) - 1);
1458                     break;
1459                 }
1460
1461                 output = parser->capture ? parser->capture : parser->output;
1462                 _Wikitext_pop_excess_elements(parser);
1463
1464                 // if you've seen STRONG/STRONG_START or EM/EM_START, must close them in the reverse order that you saw them!
1465                 // otherwise, must open them
1466                 remove_strong  = -1;
1467                 remove_em      = -1;
1468                 j              = parser->scope->count;
1469                 for (j = j - 1; j >= 0; j--)
1470                 {
1471                     int val = ary_entry(parser->scope, j);
1472                     if (val == STRONG || val == STRONG_START)
1473                     {
1474                         str_append(output, strong_end, sizeof(strong_end) - 1);
1475                         remove_strong = j;
1476                     }
1477                     else if (val == EM || val == EM_START)
1478                     {
1479                         str_append(output, em_end, sizeof(em_end) - 1);
1480                         remove_em = j;
1481                     }
1482                 }
1483
1484                 if (remove_strong > remove_em)      // must remove strong first
1485                 {
1486                     ary_pop(parser->scope);
1487                     if (remove_em > -1)
1488                         ary_pop(parser->scope);
1489                     else    // there was no em to remove!, so consider this an opening em tag
1490                     {
1491                         str_append(output, em_start, sizeof(em_start) - 1);
1492                         ary_push(parser->scope, EM);
1493                         ary_push(parser->line, EM);
1494                     }
1495                 }
1496                 else if (remove_em > remove_strong) // must remove em first
1497                 {
1498                     ary_pop(parser->scope);
1499                     if (remove_strong > -1)
1500                         ary_pop(parser->scope);
1501                     else    // there was no strong to remove!, so consider this an opening strong tag
1502                     {
1503                         str_append(output, strong_start, sizeof(strong_start) - 1);
1504                         ary_push(parser->scope, STRONG);
1505                         ary_push(parser->line, STRONG);
1506                     }
1507                 }
1508                 else    // no strong or em to remove, so this must be a new opening of both
1509                 {
1510                     _Wikitext_start_para_if_necessary(parser);
1511                     str_append(output, strong_em_start, sizeof(strong_em_start) - 1);
1512                     ary_push(parser->scope, STRONG);
1513                     ary_push(parser->line, STRONG);
1514                     ary_push(parser->scope, EM);
1515                     ary_push(parser->line, EM);
1516                 }
1517                 break;
1518
1519             case STRONG:
1520                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1521                 {
1522                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1523                     str_append(parser->output, literal_strong, sizeof(literal_strong) - 1);
1524                 }
1525                 else
1526                 {
1527                     output = parser->capture ? parser->capture : parser->output;
1528                     if (IN(STRONG_START))
1529                         // already in span started with <strong>, no choice but to emit this literally
1530                         str_append(output, literal_strong, sizeof(literal_strong) - 1);
1531                     else if (IN(STRONG))
1532                         // STRONG already seen, this is a closing tag
1533                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG, true);
1534                     else
1535                     {
1536                         // this is a new opening
1537                         _Wikitext_pop_excess_elements(parser);
1538                         _Wikitext_start_para_if_necessary(parser);
1539                         str_append(output, strong_start, sizeof(strong_start) - 1);
1540                         ary_push(parser->scope, STRONG);
1541                         ary_push(parser->line, STRONG);
1542                     }
1543                 }
1544                 break;
1545
1546             case STRONG_START:
1547                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1548                 {
1549                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1550                     str_append(parser->output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1551                 }
1552                 else
1553                 {
1554                     output = parser->capture ? parser->capture : parser->output;
1555                     if (IN(STRONG_START) || IN(STRONG))
1556                         str_append(output, escaped_strong_start, sizeof(escaped_strong_start) - 1);
1557                     else
1558                     {
1559                         _Wikitext_pop_excess_elements(parser);
1560                         _Wikitext_start_para_if_necessary(parser);
1561                         str_append(output, strong_start, sizeof(strong_start) - 1);
1562                         ary_push(parser->scope, STRONG_START);
1563                         ary_push(parser->line, STRONG_START);
1564                     }
1565                 }
1566                 break;
1567
1568             case STRONG_END:
1569                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1570                 {
1571                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1572                     str_append(parser->output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1573                 }
1574                 else
1575                 {
1576                     output = parser->capture ? parser->capture : parser->output;
1577                     if (IN(STRONG_START))
1578                         _Wikitext_pop_from_stack_up_to(parser, output, STRONG_START, true);
1579                     else
1580                     {
1581                         // no STRONG_START in scope, so must interpret the STRONG_END without any special meaning
1582                         _Wikitext_pop_excess_elements(parser);
1583                         _Wikitext_start_para_if_necessary(parser);
1584                         str_append(output, escaped_strong_end, sizeof(escaped_strong_end) - 1);
1585                     }
1586                 }
1587                 break;
1588
1589             case EM:
1590                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1591                 {
1592                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1593                     str_append(parser->output, literal_em, sizeof(literal_em) - 1);
1594                 }
1595                 else
1596                 {
1597                     output = parser->capture ? parser->capture : parser->output;
1598                     if (IN(EM_START))
1599                         // already in span started with <em>, no choice but to emit this literally
1600                         str_append(output, literal_em, sizeof(literal_em) - 1);
1601                     else if (IN(EM))
1602                         // EM already seen, this is a closing tag
1603                         _Wikitext_pop_from_stack_up_to(parser, output, EM, true);
1604                     else
1605                     {
1606                         // this is a new opening
1607                         _Wikitext_pop_excess_elements(parser);
1608                         _Wikitext_start_para_if_necessary(parser);
1609                         str_append(output, em_start, sizeof(em_start) - 1);
1610                         ary_push(parser->scope, EM);
1611                         ary_push(parser->line, EM);
1612                     }
1613                 }
1614                 break;
1615
1616             case EM_START:
1617                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1618                 {
1619                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1620                     str_append(parser->output, escaped_em_start, sizeof(escaped_em_start) - 1);
1621                 }
1622                 else
1623                 {
1624                     output = parser->capture ? parser->capture : parser->output;
1625                     if (IN(EM_START) || IN(EM))
1626                         str_append(output, escaped_em_start, sizeof(escaped_em_start) - 1);
1627                     else
1628                     {
1629                         _Wikitext_pop_excess_elements(parser);
1630                         _Wikitext_start_para_if_necessary(parser);
1631                         str_append(output, em_start, sizeof(em_start) - 1);
1632                         ary_push(parser->scope, EM_START);
1633                         ary_push(parser->line, EM_START);
1634                     }
1635                 }
1636                 break;
1637
1638             case EM_END:
1639                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1640                 {
1641                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1642                     str_append(parser->output, escaped_em_end, sizeof(escaped_em_end) - 1);
1643                 }
1644                 else
1645                 {
1646                     output = parser->capture ? parser->capture : parser->output;
1647                     if (IN(EM_START))
1648                         _Wikitext_pop_from_stack_up_to(parser, output, EM_START, true);
1649                     else
1650                     {
1651                         // no EM_START in scope, so must interpret the TT_END without any special meaning
1652                         _Wikitext_pop_excess_elements(parser);
1653                         _Wikitext_start_para_if_necessary(parser);
1654                         str_append(output, escaped_em_end, sizeof(escaped_em_end) - 1);
1655                     }
1656                 }
1657                 break;
1658
1659             case TT:
1660                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1661                 {
1662                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1663                     str_append(parser->output, backtick, sizeof(backtick) - 1);
1664                 }
1665                 else
1666                 {
1667                     output = parser->capture ? parser->capture : parser->output;
1668                     if (IN(TT_START))
1669                         // already in span started with <tt>, no choice but to emit this literally
1670                         str_append(output, backtick, sizeof(backtick) - 1);
1671                     else if (IN(TT))
1672                         // TT (`) already seen, this is a closing tag
1673                         _Wikitext_pop_from_stack_up_to(parser, output, TT, true);
1674                     else
1675                     {
1676                         // this is a new opening
1677                         _Wikitext_pop_excess_elements(parser);
1678                         _Wikitext_start_para_if_necessary(parser);
1679                         str_append(output, tt_start, sizeof(tt_start) - 1);
1680                         ary_push(parser->scope, TT);
1681                         ary_push(parser->line, TT);
1682                     }
1683                 }
1684                 break;
1685
1686             case TT_START:
1687                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1688                 {
1689                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1690                     str_append(parser->output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1691                 }
1692                 else
1693                 {
1694                     output = parser->capture ? parser->capture : parser->output;
1695                     if (IN(TT_START) || IN(TT))
1696                         str_append(output, escaped_tt_start, sizeof(escaped_tt_start) - 1);
1697                     else
1698                     {
1699                         _Wikitext_pop_excess_elements(parser);
1700                         _Wikitext_start_para_if_necessary(parser);
1701                         str_append(output, tt_start, sizeof(tt_start) - 1);
1702                         ary_push(parser->scope, TT_START);
1703                         ary_push(parser->line, TT_START);
1704                     }
1705                 }
1706                 break;
1707
1708             case TT_END:
1709                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1710                 {
1711                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1712                     str_append(parser->output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1713                 }
1714                 else
1715                 {
1716                     output = parser->capture ? parser->capture : parser->output;
1717                     if (IN(TT_START))
1718                         _Wikitext_pop_from_stack_up_to(parser, output, TT_START, true);
1719                     else
1720                     {
1721                         // no TT_START in scope, so must interpret the TT_END without any special meaning
1722                         _Wikitext_pop_excess_elements(parser);
1723                         _Wikitext_start_para_if_necessary(parser);
1724                         str_append(output, escaped_tt_end, sizeof(escaped_tt_end) - 1);
1725                     }
1726                 }
1727                 break;
1728
1729             case OL:
1730             case UL:
1731                 if (IN(NO_WIKI_START) || IN(PRE_START))
1732                 {
1733                     // no need to check for PRE; can never appear inside it
1734                     str_append(parser->output, token->start, TOKEN_LEN(token));
1735                     break;
1736                 }
1737
1738                 // count number of tokens in line and scope stacks
1739                 int bq_count = ary_count(parser->scope, BLOCKQUOTE_START);
1740                 i = parser->line->count - ary_count(parser->line, BLOCKQUOTE_START);
1741                 j = parser->scope->count - bq_count;
1742                 k = i;
1743
1744                 // list tokens can be nested so look ahead for any more which might affect the decision to push or pop
1745                 for (;;)
1746                 {
1747                     type = token->type;
1748                     if (type == OL || type == UL)
1749                     {
1750                         token = NULL;
1751                         if (i - k >= 2)                             // already seen at least one OL or UL
1752                         {
1753                             ary_push(parser->line, NESTED_LIST);    // which means this is a nested list
1754                             i += 3;
1755                         }
1756                         else
1757                             i += 2;
1758                         ary_push(parser->line, type);
1759                         ary_push(parser->line, LI);
1760
1761                         // want to compare line with scope but can only do so if scope has enough items on it
1762                         if (j >= i)
1763                         {
1764                             if (ary_entry(parser->scope, i + bq_count - 2) == type &&
1765                                 ary_entry(parser->scope, i + bq_count - 1) == LI)
1766                             {
1767                                 // line and scope match at this point: do nothing yet
1768                             }
1769                             else
1770                             {
1771                                 // item just pushed onto line does not match corresponding slot of scope!
1772                                 for (; j >= i - 2; j--)
1773                                     // must pop back before emitting
1774                                     _Wikitext_pop_from_stack(parser, NULL);
1775
1776                                 // will emit UL or OL, then LI
1777                                 break;
1778                             }
1779                         }
1780                         else        // line stack size now exceeds scope stack size: must increase nesting level
1781                             break;  // will emit UL or OL, then LI
1782                     }
1783                     else
1784                     {
1785                         // not a OL or UL token!
1786                         if (j == i)
1787                             // must close existing LI and re-open new one
1788                             _Wikitext_pop_from_stack(parser, NULL);
1789                         else if (j > i)
1790                         {
1791                             // item just pushed onto line does not match corresponding slot of scope!
1792                             for (; j >= i; j--)
1793                                 // must pop back before emitting
1794                                 _Wikitext_pop_from_stack(parser, NULL);
1795                         }
1796                         break;
1797                     }
1798                     NEXT_TOKEN();
1799                 }
1800
1801                 // will emit
1802                 if (type == OL || type == UL)
1803                 {
1804                     // if LI is at the top of a stack this is the start of a nested list
1805                     if (j > 0 && ary_entry(parser->scope, -1) == LI)
1806                     {
1807                         // so we should precede it with a CRLF, and indicate that it's a nested list
1808                         str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1809                         ary_push(parser->scope, NESTED_LIST);
1810                     }
1811                     else
1812                     {
1813                         // this is a new list
1814                         if (IN(BLOCKQUOTE_START))
1815                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1816                         else
1817                             _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1818                     }
1819
1820                     // emit
1821                     _Wikitext_indent(parser);
1822                     if (type == OL)
1823                         str_append(parser->output, ol_start, sizeof(ol_start) - 1);
1824                     else if (type == UL)
1825                         str_append(parser->output, ul_start, sizeof(ul_start) - 1);
1826                     ary_push(parser->scope, type);
1827                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
1828                 }
1829                 else if (type == SPACE)
1830                     // silently throw away the optional SPACE token after final list marker
1831                     token = NULL;
1832
1833                 _Wikitext_indent(parser);
1834                 str_append(parser->output, li_start, sizeof(li_start) - 1);
1835                 ary_push(parser->scope, LI);
1836
1837                 // any subsequent UL or OL tokens on this line are syntax errors and must be emitted literally
1838                 if (type == OL || type == UL)
1839                 {
1840                     k = 0;
1841                     while (k++, NEXT_TOKEN(), (type = token->type))
1842                     {
1843                         if (type == OL || type == UL)
1844                             str_append(parser->output, token->start, TOKEN_LEN(token));
1845                         else if (type == SPACE && k == 1)
1846                         {
1847                             // silently throw away the optional SPACE token after final list marker
1848                             token = NULL;
1849                             break;
1850                         }
1851                         else
1852                             break;
1853                     }
1854                 }
1855
1856                 // jump to top of the loop to process token we scanned during lookahead
1857                 continue;
1858
1859             case H6_START:
1860             case H5_START:
1861             case H4_START:
1862             case H3_START:
1863             case H2_START:
1864             case H1_START:
1865                 if (IN(NO_WIKI_START) || IN(PRE_START))
1866                 {
1867                     // no need to check for PRE; can never appear inside it
1868                     str_append(parser->output, token->start, TOKEN_LEN(token));
1869                     break;
1870                 }
1871
1872                 // pop up to but not including the last BLOCKQUOTE on the scope stack
1873                 if (IN(BLOCKQUOTE_START))
1874                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE_START, false);
1875                 else
1876                     _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, false);
1877
1878                 // count number of BLOCKQUOTE tokens in line buffer and in scope stack
1879                 ary_push(parser->line, type);
1880                 i = ary_count(parser->line, BLOCKQUOTE);
1881                 j = ary_count(parser->scope, BLOCKQUOTE);
1882
1883                 // decide whether we need to pop off excess BLOCKQUOTE tokens (will never need to push; that is handled above in the BLOCKQUOTE case itself)
1884                 if (i < j)
1885                 {
1886                     // must pop (reduce nesting level)
1887                     for (i = j - i; i > 0; i--)
1888                         _Wikitext_pop_from_stack_up_to(parser, NULL, BLOCKQUOTE, true);
1889                 }
1890
1891                 // discard any whitespace here (so that "== foo ==" will be translated to "<h2>foo</h2>" rather than "<h2> foo </h2")
1892                 while (NEXT_TOKEN(), (token->type == SPACE))
1893                     ; // discard
1894
1895                 ary_push(parser->scope, type);
1896                 _Wikitext_indent(parser);
1897
1898                 // take base_heading_level into account
1899                 type += base_heading_level;
1900                 if (type > H6_START) // no need to check for underflow (base_heading_level never negative)
1901                     type = H6_START;
1902
1903                 // rather than repeat all that code for each kind of heading, share it and use a conditional here
1904                 if (type == H6_START)
1905                     str_append(parser->output, h6_start, sizeof(h6_start) - 1);
1906                 else if (type == H5_START)
1907                     str_append(parser->output, h5_start, sizeof(h5_start) - 1);
1908                 else if (type == H4_START)
1909                     str_append(parser->output, h4_start, sizeof(h4_start) - 1);
1910                 else if (type == H3_START)
1911                     str_append(parser->output, h3_start, sizeof(h3_start) - 1);
1912                 else if (type == H2_START)
1913                     str_append(parser->output, h2_start, sizeof(h2_start) - 1);
1914                 else if (type == H1_START)
1915                     str_append(parser->output, h1_start, sizeof(h1_start) - 1);
1916
1917                 // jump to top of the loop to process token we scanned during lookahead
1918                 continue;
1919
1920             case H6_END:
1921                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1922                 {
1923                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1924                     str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1925                 }
1926                 else
1927                 {
1928                     _Wikitext_rollback_failed_external_link(parser); // if any
1929                     if (!IN(H6_START))
1930                     {
1931                         // literal output only if not in h6 scope (we stay silent in that case)
1932                         _Wikitext_start_para_if_necessary(parser);
1933                         str_append(parser->output, literal_h6, sizeof(literal_h6) - 1);
1934                     }
1935                 }
1936                 break;
1937
1938             case H5_END:
1939                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1940                 {
1941                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1942                     str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1943                 }
1944                 else
1945                 {
1946                     _Wikitext_rollback_failed_external_link(parser); // if any
1947                     if (!IN(H5_START))
1948                     {
1949                         // literal output only if not in h5 scope (we stay silent in that case)
1950                         _Wikitext_start_para_if_necessary(parser);
1951                         str_append(parser->output, literal_h5, sizeof(literal_h5) - 1);
1952                     }
1953                 }
1954                 break;
1955
1956             case H4_END:
1957                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1958                 {
1959                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1960                     str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1961                 }
1962                 else
1963                 {
1964                     _Wikitext_rollback_failed_external_link(parser); // if any
1965                     if (!IN(H4_START))
1966                     {
1967                         // literal output only if not in h4 scope (we stay silent in that case)
1968                         _Wikitext_start_para_if_necessary(parser);
1969                         str_append(parser->output, literal_h4, sizeof(literal_h4) - 1);
1970                     }
1971                 }
1972                 break;
1973
1974             case H3_END:
1975                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1976                 {
1977                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1978                     str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1979                 }
1980                 else
1981                 {
1982                     _Wikitext_rollback_failed_external_link(parser); // if any
1983                     if (!IN(H3_START))
1984                     {
1985                         // literal output only if not in h3 scope (we stay silent in that case)
1986                         _Wikitext_start_para_if_necessary(parser);
1987                         str_append(parser->output, literal_h3, sizeof(literal_h3) - 1);
1988                     }
1989                 }
1990                 break;
1991
1992             case H2_END:
1993                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
1994                 {
1995                     _Wikitext_emit_pending_crlf_if_necessary(parser);
1996                     str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
1997                 }
1998                 else
1999                 {
2000                     _Wikitext_rollback_failed_external_link(parser); // if any
2001                     if (!IN(H2_START))
2002                     {
2003                         // literal output only if not in h2 scope (we stay silent in that case)
2004                         _Wikitext_start_para_if_necessary(parser);
2005                         str_append(parser->output, literal_h2, sizeof(literal_h2) - 1);
2006                     }
2007                 }
2008                 break;
2009
2010             case H1_END:
2011                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2012                 {
2013                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2014                     str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
2015                 }
2016                 else
2017                 {
2018                     _Wikitext_rollback_failed_external_link(parser); // if any
2019                     if (!IN(H1_START))
2020                     {
2021                         // literal output only if not in h1 scope (we stay silent in that case)
2022                         _Wikitext_start_para_if_necessary(parser);
2023                         str_append(parser->output, literal_h1, sizeof(literal_h1) - 1);
2024                     }
2025                 }
2026                 break;
2027
2028             case MAIL:
2029                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2030                 {
2031                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2032                     str_append(parser->output, token->start, TOKEN_LEN(token));
2033                 }
2034                 else
2035                 {
2036                     _Wikitext_pop_excess_elements(parser);
2037                     _Wikitext_start_para_if_necessary(parser);
2038                     token_str->ptr = token->start;
2039                     token_str->len = TOKEN_LEN(token);
2040                     _Wikitext_append_hyperlink(parser, rb_str_new2("mailto:"), token_str, NULL, mailto_class, true);
2041                 }
2042                 break;
2043
2044             case URI:
2045                 if (IN(NO_WIKI_START))
2046                     // user can temporarily suppress autolinking by using <nowiki></nowiki>
2047                     // note that unlike MediaWiki, we do allow autolinking inside PRE blocks
2048                     str_append(parser->output, token->start, TOKEN_LEN(token));
2049                 else if (IN(LINK_START))
2050                 {
2051                     // if the URI were allowed it would have been handled already in LINK_START
2052                     _Wikitext_rollback_failed_internal_link(parser);
2053                     token_str->ptr = token->start;
2054                     token_str->len = TOKEN_LEN(token);
2055                     _Wikitext_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
2056                 }
2057                 else if (IN(EXT_LINK_START))
2058                 {
2059                     if (parser->link_target->len == 0)
2060                     {
2061                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2062                         token_str->ptr = token->start;
2063                         token_str->len = TOKEN_LEN(token);
2064                         NEXT_TOKEN();
2065                         if (token->type == SPACE)
2066                         {
2067                             ary_push(parser->scope, SPACE);
2068                             str_append_str(parser->link_target, token_str);
2069                             str_clear(parser->link_text);
2070                             parser->capture     = parser->link_text;
2071                             token               = NULL; // silently consume space
2072                         }
2073                         else
2074                         {
2075                             // didn't see the space! this must be an error
2076                             _Wikitext_pop_from_stack(parser, NULL);
2077                             _Wikitext_pop_excess_elements(parser);
2078                             _Wikitext_start_para_if_necessary(parser);
2079                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2080                             _Wikitext_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
2081                         }
2082                     }
2083                     else
2084                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2085                 }
2086                 else
2087                 {
2088                     _Wikitext_pop_excess_elements(parser);
2089                     _Wikitext_start_para_if_necessary(parser);
2090                     token_str->ptr = token->start;
2091                     token_str->len = TOKEN_LEN(token);
2092                     _Wikitext_append_hyperlink(parser, Qnil, token_str, NULL, parser->external_link_class, true);
2093                 }
2094                 break;
2095
2096             case PATH:
2097                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2098                     str_append(parser->output, token->start, TOKEN_LEN(token));
2099                 else if (IN(EXT_LINK_START))
2100                 {
2101                     if (parser->link_target->len == 0)
2102                     {
2103                         // this must be our link target: look ahead to make sure we see the space we're expecting to see
2104                         token_str->ptr = token->start;
2105                         token_str->len = TOKEN_LEN(token);
2106                         NEXT_TOKEN();
2107                         if (token->type == SPACE)
2108                         {
2109                             ary_push(parser->scope, PATH);
2110                             ary_push(parser->scope, SPACE);
2111                             str_append_str(parser->link_target, token_str);
2112                             str_clear(parser->link_text);
2113                             parser->capture     = parser->link_text;
2114                             token               = NULL; // silently consume space
2115                         }
2116                         else
2117                         {
2118                             // didn't see the space! this must be an error
2119                             _Wikitext_pop_from_stack(parser, NULL);
2120                             _Wikitext_pop_excess_elements(parser);
2121                             _Wikitext_start_para_if_necessary(parser);
2122                             str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2123                             str_append_str(parser->output, token_str);
2124                         }
2125                     }
2126                     else
2127                         str_append(parser->link_text, token->start, TOKEN_LEN(token));
2128                 }
2129                 else
2130                 {
2131                     output = parser->capture ? parser->capture : parser->output;
2132                     _Wikitext_pop_excess_elements(parser);
2133                     _Wikitext_start_para_if_necessary(parser);
2134                     str_append(output, token->start, TOKEN_LEN(token));
2135                 }
2136                 break;
2137
2138             // internal links (links to other wiki articles) look like this:
2139             //      [[another article]] (would point at, for example, "/wiki/another_article")
2140             //      [[the other article|the link text we'll use for it]]
2141             //      [[the other article | the link text we'll use for it]]
2142             // MediaWiki has strict requirements about what it will accept as a link target:
2143             //      all wikitext markup is disallowed:
2144             //          example [[foo ''bar'' baz]]
2145             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2146             //          example [[foo <em>bar</em> baz]]
2147             //          renders [[foo <em>bar</em> baz]]        (ie. not a link)
2148             //          example [[foo <nowiki>''</nowiki> baz]]
2149             //          renders [[foo '' baz]]                  (ie. not a link)
2150             //          example [[foo <bar> baz]]
2151             //          renders [[foo &lt;bar&gt; baz]]         (ie. not a link)
2152             //      HTML entities and non-ASCII, however, make it through:
2153             //          example [[foo &euro;]]
2154             //          renders <a href="/wiki/Foo_%E2%82%AC">foo &euro;</a>
2155             //          example [[foo €]]
2156             //          renders <a href="/wiki/Foo_%E2%82%AC">foo €</a>
2157             // we'll impose similar restrictions here for the link target; allowed tokens will be:
2158             //      SPACE, SPECIAL_URI_CHARS, PRINTABLE, PATH, ALNUM, DEFAULT, QUOT and AMP
2159             // everything else will be rejected
2160             case LINK_START:
2161                 output = parser->capture ? parser->capture : parser->output;
2162                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2163                 {
2164                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2165                     str_append(output, link_start, sizeof(link_start) - 1);
2166                 }
2167                 else if (IN(EXT_LINK_START))
2168                     // already in external link scope! (and in fact, must be capturing link_text right now)
2169                     str_append(output, link_start, sizeof(link_start) - 1);
2170                 else if (IN(LINK_START))
2171                 {
2172                     // already in internal link scope! this is a syntax error
2173                     _Wikitext_rollback_failed_internal_link(parser);
2174                     str_append(parser->output, link_start, sizeof(link_start) - 1);
2175                 }
2176                 else if (IN(SEPARATOR))
2177                 {
2178                     // scanning internal link text
2179                 }
2180                 else // not in internal link scope yet
2181                 {
2182                     // will either emit a link, or the rollback of a failed link, so start the para now
2183                     _Wikitext_pop_excess_elements(parser);
2184                     _Wikitext_start_para_if_necessary(parser);
2185                     ary_push(parser->scope, LINK_START);
2186
2187                     // look ahead and try to gobble up link target
2188                     while (NEXT_TOKEN(), (type = token->type))
2189                     {
2190                         if (type == SPACE               ||
2191                             type == SPECIAL_URI_CHARS   ||
2192                             type == PATH                ||
2193                             type == PRINTABLE           ||
2194                             type == ALNUM               ||
2195                             type == DEFAULT             ||
2196                             type == QUOT                ||
2197                             type == QUOT_ENTITY         ||
2198                             type == AMP                 ||
2199                             type == AMP_ENTITY          ||
2200                             type == IMG_START           ||
2201                             type == IMG_END             ||
2202                             type == LEFT_CURLY          ||
2203                             type == RIGHT_CURLY)
2204                         {
2205                             // accumulate these tokens into link_target
2206                             if (parser->link_target->len == 0)
2207                             {
2208                                 str_clear(parser->link_target);
2209                                 parser->capture = parser->link_target;
2210                             }
2211                             if (type == QUOT_ENTITY)
2212                                 // don't insert the entity, insert the literal quote
2213                                 str_append(parser->link_target, quote, sizeof(quote) - 1);
2214                             else if (type == AMP_ENTITY)
2215                                 // don't insert the entity, insert the literal ampersand
2216                                 str_append(parser->link_target, ampersand, sizeof(ampersand) - 1);
2217                             else
2218                                 str_append(parser->link_target, token->start, TOKEN_LEN(token));
2219                         }
2220                         else if (type == LINK_END)
2221                         {
2222                             if (parser->link_target->len == 0) // bail for inputs like "[[]]"
2223                                 _Wikitext_rollback_failed_internal_link(parser);
2224                             break; // jump back to top of loop (will handle this in LINK_END case below)
2225                         }
2226                         else if (type == SEPARATOR)
2227                         {
2228                             if (parser->link_target->len == 0) // bail for inputs like "[[|"
2229                                 _Wikitext_rollback_failed_internal_link(parser);
2230                             else
2231                             {
2232                                 ary_push(parser->scope, SEPARATOR);
2233                                 str_clear(parser->link_text);
2234                                 parser->capture     = parser->link_text;
2235                                 token               = NULL;
2236                             }
2237                             break;
2238                         }
2239                         else // unexpected token (syntax error)
2240                         {
2241                             _Wikitext_rollback_failed_internal_link(parser);
2242                             break; // jump back to top of loop to handle unexpected token
2243                         }
2244                     }
2245
2246                     // jump to top of the loop to process token we scanned during lookahead (if any)
2247                     continue;
2248                 }
2249                 break;
2250
2251             case LINK_END:
2252                 output = parser->capture ? parser->capture : parser->output;
2253                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2254                 {
2255                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2256                     str_append(output, link_end, sizeof(link_end) - 1);
2257                 }
2258                 else if (IN(EXT_LINK_START))
2259                     // already in external link scope! (and in fact, must be capturing link_text right now)
2260                     str_append(output, link_end, sizeof(link_end) - 1);
2261                 else if (IN(LINK_START)) // in internal link scope!
2262                 {
2263                     if (_Wikitext_blank(parser->link_target))
2264                     {
2265                         // special case for inputs like "[[    ]]"
2266                         _Wikitext_rollback_failed_internal_link(parser);
2267                         str_append(parser->output, link_end, sizeof(link_end) - 1);
2268                         break;
2269                     }
2270                     if (parser->link_text->len == 0 ||
2271                         _Wikitext_blank(parser->link_text))
2272                     {
2273                         // use link target as link text
2274                         str_clear(parser->link_text);
2275                         _Wikitext_parser_append_sanitized_link_target(parser, parser->link_text, false);
2276                     }
2277                     else
2278                         _Wikitext_parser_trim_link_text(parser);
2279                     _Wikitext_parser_encode_link_target(parser);
2280                     _Wikitext_pop_from_stack_up_to(parser, output, LINK_START, true);
2281                     parser->capture = NULL;
2282                     _Wikitext_append_hyperlink(parser, prefix, parser->link_target, parser->link_text, Qnil, false);
2283                     str_clear(parser->link_target);
2284                     str_clear(parser->link_text);
2285                 }
2286                 else // wasn't in internal link scope
2287                 {
2288                     _Wikitext_pop_excess_elements(parser);
2289                     _Wikitext_start_para_if_necessary(parser);
2290                     str_append(output, link_end, sizeof(link_end) - 1);
2291                 }
2292                 break;
2293
2294             // external links look like this:
2295             //      [http://google.com/ the link text]
2296             //      [/other/page/on/site see this page]
2297             // strings in square brackets which don't match this syntax get passed through literally; eg:
2298             //      he was very angery [sic] about the turn of events
2299             case EXT_LINK_START:
2300                 output = parser->capture ? parser->capture : parser->output;
2301                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2302                 {
2303                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2304                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2305                 }
2306                 else if (IN(EXT_LINK_START))
2307                     // already in external link scope! (and in fact, must be capturing link_text right now)
2308                     str_append(output, ext_link_start, sizeof(ext_link_start) - 1);
2309                 else if (IN(LINK_START))
2310                 {
2311                     // already in internal link scope!
2312                     if (parser->link_target->len == 0)
2313                         // this must be the first character of our link target
2314                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2315                     else if (IN(SPACE))
2316                         // link target has already been scanned
2317                         str_append(parser->link_text, ext_link_start, sizeof(ext_link_start) - 1);
2318                     else
2319                         // TODO: possibly roll this condition into the above
2320                         // add to existing link target
2321                         str_append(parser->link_target, ext_link_start, sizeof(ext_link_start) - 1);
2322                 }
2323                 else // not in external link scope yet
2324                 {
2325                     // will either emit a link, or the rollback of a failed link, so start the para now
2326                     _Wikitext_pop_excess_elements(parser);
2327                     _Wikitext_start_para_if_necessary(parser);
2328
2329                     // look ahead: expect an absolute URI (with protocol) or "relative" (path) URI
2330                     NEXT_TOKEN();
2331                     if (token->type == URI || token->type == PATH)
2332                         ary_push(parser->scope, EXT_LINK_START);    // so far so good, jump back to the top of the loop
2333                     else
2334                         // only get here if there was a syntax error (missing URI)
2335                         str_append(parser->output, ext_link_start, sizeof(ext_link_start) - 1);
2336                     continue; // jump back to top of loop to handle token (either URI or whatever it is)
2337                 }
2338                 break;
2339
2340             case EXT_LINK_END:
2341                 output = parser->capture ? parser->capture : parser->output;
2342                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2343                 {
2344                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2345                     str_append(output, ext_link_end, sizeof(ext_link_end) - 1);
2346                 }
2347                 else if (IN(EXT_LINK_START))
2348                 {
2349                     if (parser->link_text->len == 0)
2350                         // syntax error: external link with no link text
2351                         _Wikitext_rollback_failed_external_link(parser);
2352                     else
2353                     {
2354                         // success!
2355                         j = IN(PATH) ? Qnil : parser->external_link_class;
2356                         _Wikitext_pop_from_stack_up_to(parser, output, EXT_LINK_START, true);
2357                         parser->capture = NULL;
2358                         _Wikitext_append_hyperlink(parser, Qnil, parser->link_target, parser->link_text, j, false);
2359                     }
2360                     str_clear(parser->link_target);
2361                     str_clear(parser->link_text);
2362                 }
2363                 else
2364                 {
2365                     _Wikitext_pop_excess_elements(parser);
2366                     _Wikitext_start_para_if_necessary(parser);
2367                     str_append(parser->output, ext_link_end, sizeof(ext_link_end) - 1);
2368                 }
2369                 break;
2370
2371             case SEPARATOR:
2372                 output = parser->capture ? parser->capture : parser->output;
2373                 _Wikitext_pop_excess_elements(parser);
2374                 _Wikitext_start_para_if_necessary(parser);
2375                 str_append(output, separator, sizeof(separator) - 1);
2376                 break;
2377
2378             case SPACE:
2379                 output = parser->capture ? parser->capture : parser->output;
2380                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2381                 {
2382                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2383                     str_append(output, token->start, TOKEN_LEN(token));
2384                 }
2385                 else
2386                 {
2387                     // peek ahead to see next token
2388                     char    *token_ptr  = token->start;
2389                     int     token_len   = TOKEN_LEN(token);
2390                     NEXT_TOKEN();
2391                     type = token->type;
2392                     if (((type == H6_END) && IN(H6_START)) ||
2393                         ((type == H5_END) && IN(H5_START)) ||
2394                         ((type == H4_END) && IN(H4_START)) ||
2395                         ((type == H3_END) && IN(H3_START)) ||
2396                         ((type == H2_END) && IN(H2_START)) ||
2397                         ((type == H1_END) && IN(H1_START)))
2398                     {
2399                         // will suppress emission of space (discard) if next token is a H6_END, H5_END etc and we are in the corresponding scope
2400                     }
2401                     else
2402                     {
2403                         // emit the space
2404                         _Wikitext_pop_excess_elements(parser);
2405                         _Wikitext_start_para_if_necessary(parser);
2406                         str_append(output, token_ptr, token_len);
2407                     }
2408
2409                     // jump to top of the loop to process token we scanned during lookahead
2410                     continue;
2411                 }
2412                 break;
2413
2414             case QUOT_ENTITY:
2415             case AMP_ENTITY:
2416             case NAMED_ENTITY:
2417             case DECIMAL_ENTITY:
2418                 // pass these through unaltered as they are case sensitive
2419                 output = parser->capture ? parser->capture : parser->output;
2420                 _Wikitext_pop_excess_elements(parser);
2421                 _Wikitext_start_para_if_necessary(parser);
2422                 str_append(output, token->start, TOKEN_LEN(token));
2423                 break;
2424
2425             case HEX_ENTITY:
2426                 // normalize hex entities (downcase them)
2427                 output = parser->capture ? parser->capture : parser->output;
2428                 _Wikitext_pop_excess_elements(parser);
2429                 _Wikitext_start_para_if_necessary(parser);
2430                 str_append(output, token->start, TOKEN_LEN(token));
2431                 _Wikitext_downcase_bang(output->ptr + output->len - TOKEN_LEN(token), TOKEN_LEN(token));
2432                 break;
2433
2434             case QUOT:
2435                 output = parser->capture ? parser->capture : parser->output;
2436                 _Wikitext_pop_excess_elements(parser);
2437                 _Wikitext_start_para_if_necessary(parser);
2438                 str_append(output, quot_entity, sizeof(quot_entity) - 1);
2439                 break;
2440
2441             case AMP:
2442                 output = parser->capture ? parser->capture : parser->output;
2443                 _Wikitext_pop_excess_elements(parser);
2444                 _Wikitext_start_para_if_necessary(parser);
2445                 str_append(output, amp_entity, sizeof(amp_entity) - 1);
2446                 break;
2447
2448             case LESS:
2449                 output = parser->capture ? parser->capture : parser->output;
2450                 _Wikitext_pop_excess_elements(parser);
2451                 _Wikitext_start_para_if_necessary(parser);
2452                 str_append(output, lt_entity, sizeof(lt_entity) - 1);
2453                 break;
2454
2455             case GREATER:
2456                 output = parser->capture ? parser->capture : parser->output;
2457                 _Wikitext_pop_excess_elements(parser);
2458                 _Wikitext_start_para_if_necessary(parser);
2459                 str_append(output, gt_entity, sizeof(gt_entity) - 1);
2460                 break;
2461
2462             case IMG_START:
2463                 if (IN(NO_WIKI_START) || IN(PRE) || IN(PRE_START))
2464                 {
2465                     _Wikitext_emit_pending_crlf_if_necessary(parser);
2466                     str_append(parser->output, token->start, TOKEN_LEN(token));
2467                 }
2468                 else if (parser->capture)
2469                     str_append(parser->capture, token->start, TOKEN_LEN(token));
2470                 else
2471                 {
2472                     // not currently capturing: will be emitting something on success or failure, so get ready
2473                     _Wikitext_pop_excess_elements(parser);
2474                     _Wikitext_start_para_if_necessary(parser);
2475
2476                     // scan ahead consuming PATH, PRINTABLE, ALNUM and SPECIAL_URI_CHARS tokens
2477                     // will cheat here and abuse the link_target capture buffer to accumulate text
2478                     while (NEXT_TOKEN(), (type = token->type))
2479                     {
2480                         if (type == PATH || type == PRINTABLE || type == ALNUM || type == SPECIAL_URI_CHARS)
2481                             str_append(parser->link_target, token->start, TOKEN_LEN(token));
2482                         else if (type == IMG_END && parser->link_target->len > 0)
2483                         {
2484                             // success
2485                             _Wikitext_append_img(parser, parser->link_target->ptr, parser->link_target->len);
2486                             token = NULL;
2487                             break;
2488                         }
2489                         else // unexpected token or zero-length target (syntax error)
2490                         {
2491                             // rollback
2492                             str_append(parser->output, literal_img_start, sizeof(literal_img_start) - 1);
2493                             if (parser->link_target->len > 0)
2494                                 str_append(parser->output, parser->link_target->ptr, parser->link_target->len);
2495                             break;
2496                         }
2497                     }
2498
2499                     // jump to top of the loop to process token we scanned during lookahead
2500                     str_clear(parser->link_target);
2501                     continue;
2502                 }
2503                 break;
2504
2505             case CRLF:
2506                 i = parser->pending_crlf;
2507                 parser->pending_crlf = false;
2508                 _Wikitext_rollback_failed_link(parser); // if any
2509                 if (IN(NO_WIKI_START) || IN(PRE_START))
2510                 {
2511                     ary_clear(parser->line_buffer);
2512                     str_append_str(parser->output, parser->line_ending);
2513                     break;
2514                 }
2515                 else if (IN(PRE))
2516                 {
2517                     // beware when BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, that must be end of PRE block
2518                     if (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE)
2519                         // don't emit in this case
2520                         _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2521                     else
2522                     {
2523                         if (ary_entry(parser->line_buffer, -2) == PRE)
2524                         {
2525                              // only thing on line is the PRE: emit pending line ending (if we had one)
2526                              if (i)
2527                                  str_append_str(parser->output, parser->line_ending);
2528                         }
2529
2530                         // clear these _before_ calling NEXT_TOKEN (NEXT_TOKEN adds to the line_buffer)
2531                         ary_clear(parser->line);
2532                         ary_clear(parser->line_buffer);
2533
2534                         // peek ahead to see if this is definitely the end of the PRE block
2535                         NEXT_TOKEN();
2536                         type = token->type;
2537                         if (type != BLOCKQUOTE && type != PRE)
2538                             // this is definitely the end of the block, so don't emit
2539                             _Wikitext_pop_from_stack_up_to(parser, parser->output, PRE, true);
2540                         else
2541                             // potentially will emit
2542                             parser->pending_crlf = true;
2543
2544                         continue; // jump back to top of loop to handle token grabbed via lookahead
2545                     }
2546                 }
2547                 else
2548                 {
2549                     parser->pending_crlf = true;
2550
2551                     // count number of BLOCKQUOTE tokens in line buffer (can be zero) and pop back to that level
2552                     // as a side effect, this handles any open span-level elements and unclosed blocks
2553                     // (with special handling for P blocks and LI elements)
2554                     i = ary_count(parser->line, BLOCKQUOTE) + ary_count(parser->scope, BLOCKQUOTE_START);
2555                     for (j = parser->scope->count; j > i; j--)
2556                     {
2557                         if (parser->scope->count > 0 && ary_entry(parser->scope, -1) == LI)
2558                         {
2559                             parser->pending_crlf = false;
2560                             break;
2561                         }
2562
2563                         // special handling on last iteration through the loop if the top item on the scope is a P block
2564                         if ((j - i == 1) && ary_entry(parser->scope, -1) == P)
2565                         {
2566                             // if nothing or BLOCKQUOTE on line buffer (not line stack!) prior to CRLF, this must be a paragraph break
2567                             // (note that we have to make sure we're not inside a BLOCKQUOTE_START block
2568                             // because in those blocks BLOCKQUOTE tokens have no special meaning)
2569                             if (NO_ITEM(ary_entry(parser->line_buffer, -2)) ||
2570                                 (ary_entry(parser->line_buffer, -2) == BLOCKQUOTE && !IN(BLOCKQUOTE_START)))
2571                                 // paragraph break
2572                                 parser->pending_crlf = false;
2573                             else
2574                                 // not a paragraph break!
2575                                 continue;
2576                         }
2577                         _Wikitext_pop_from_stack(parser, NULL);
2578                     }
2579                 }
2580
2581                 // delete the entire contents of the line scope stack and buffer
2582                 ary_clear(parser->line);
2583                 ary_clear(parser->line_buffer);
2584                 break;
2585
2586             case SPECIAL_URI_CHARS:
2587             case PRINTABLE:
2588             case ALNUM:
2589             case IMG_END:
2590             case LEFT_CURLY:
2591             case RIGHT_CURLY:
2592                 output = parser->capture ? parser->capture : parser->output;
2593                 _Wikitext_pop_excess_elements(parser);
2594                 _Wikitext_start_para_if_necessary(parser);
2595                 str_append(output, token->start, TOKEN_LEN(token));
2596                 break;
2597
2598             case DEFAULT:
2599                 output = parser->capture ? parser->capture : parser->output;
2600                 _Wikitext_pop_excess_elements(parser);
2601                 _Wikitext_start_para_if_necessary(parser);
2602                 //str_append_string(output, _Wikitext_utf32_char_to_entity(token->code_point));    // convert to entity
2603                 // TODO: replace this with a different append function
2604                 str_grow(output, output->len + 8);
2605                 _Wikitext_append_entity_from_utf32_char(output->ptr + output->len, token->code_point);
2606                 output->len = output->len + 8;
2607                 break;
2608
2609             case END_OF_FILE:
2610                 // special case for input like " foo\n " (see pre_spec.rb)
2611                 if (IN(PRE) &&
2612                     ary_entry(parser->line_buffer, -2) == PRE &&
2613                     parser->pending_crlf)
2614                     str_append(parser->output, parser->line_ending->ptr, parser->line_ending->len);
2615
2616                 // close any open scopes on hitting EOF
2617                 _Wikitext_rollback_failed_link(parser); // if any
2618                 _Wikitext_pop_all_from_stack(parser);
2619                 goto return_output; // break not enough here (want to break out of outer while loop, not inner switch statement)
2620
2621             default:
2622                 break;
2623         }
2624
2625         // reset current token; forcing lexer to return another token at the top of the loop
2626         token = NULL;
2627     } while (1);
2628 return_output:
2629     // nasty hack to avoid re-allocating our return value
2630     str_append(parser->output, null_str, 1); // null-terminate
2631
2632     // won't work for Ruby 1.9
2633     free(RSTRING(out)->ptr);
2634     RSTRING(out)->ptr = parser->output->ptr;
2635     RSTRING(out)->len = parser->output->len - 1; // don't count null termination
2636     parser->output->ptr = NULL; // don't double-free
2637     return out;
2638 }