misc/translator/TmplTokenizer.pm

   1 package TmplTokenizer;
   2
   3 use strict;
   4 use TmplTokenType;
   5 use TmplToken;
   6 use VerboseWarnings qw( pedantic_p error_normal warn_normal warn_pedantic );
   7 require Exporter;
   8
   9 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  10
  11 ###############################################################################
  12
  13 =head1 NAME
  14
  15 TmplTokenizer.pm - Simple-minded tokenizer class for HTML::Template .tmpl files
  16
  17 =head1 DESCRIPTION
  18
  19 Because .tmpl files contains HTML::Template directives
  20 that tend to confuse real parsers (e.g., HTML::Parse),
  21 it might be better to create a customized scanner
  22 to scan the template files for tokens.
  23 This module is a simple-minded attempt at such a scanner.
  24
  25 =cut
  26
  27 ###############################################################################
  28
  29 $VERSION = 0.02;
  30
  31 @ISA = qw(Exporter);
  32 @EXPORT_OK = qw();
  33
  34 use vars qw( $pedantic_attribute_error_in_nonpedantic_mode_p );
  35 use vars qw( $pedantic_tmpl_var_use_in_nonpedantic_mode_p );
  36 use vars qw( $pedantic_error_markup_in_pcdata_p );
  37
  38 ###############################################################################
  39
  40 # Hideous stuff
  41 use vars qw( $re_directive $re_tmpl_var $re_tmpl_var_escaped $re_tmpl_include );
  42 use vars qw( $re_directive_control $re_tmpl_endif_endloop );
  43 BEGIN {
  44     # $re_directive must not do any backreferences
  45     $re_directive = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:VAR|LOOP|INCLUDE|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  46     # TMPL_VAR or TMPL_INCLUDE
  47     $re_tmpl_var = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  48     $re_tmpl_include = q{<(?:(?i)(?:!--\s*)?TMPL_(?:INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  49     # TMPL_VAR ESCAPE=1/HTML/URL
  50     $re_tmpl_var_escaped = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR|INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))\s+ESCAPE=(?:1|HTML|URL)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  51     # Any control flow directive
  52     $re_directive_control = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:LOOP|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  53     # /LOOP or /IF or /UNLESS
  54     $re_tmpl_endif_endloop = q{<(?:(?i)(?:!--\s*)?\/TMPL_(?:LOOP|IF|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  55 }
  56
  57 # Hideous stuff from subst.pl, slightly modified to use the above hideous stuff
  58 # Note: The $re_tag's set $1 (<tag), $2 (>), and $3 (rest of string)
  59 use vars qw( $re_comment $re_entity_name $re_end_entity $re_etag );
  60 use vars qw( $re_tag_strict $re_tag_compat @re_tag );
  61 sub re_tag ($) {
  62    my($compat) = @_;
  63    my $etag = $compat? '>': '<>\/';
  64    # This is no longer similar to the original regexp in subst.pl :-(
  65    # Note that we don't want <> in compat mode; Mozilla knows about <
  66    q{(<\/?(?:|(?:"(?:} . $re_directive . q{|[^"])*"|'(?:} . $re_directive . q{|[^'])*'|--(?:(?!--)(?:$re_directive)*.)*--|(?:}
  67    . $re_directive
  68    . q{|(?!--)[^"'<>} . $etag . q{]))+))([} . $etag . q{]|(?=<))(.*)};
  69 }
  70 BEGIN {
  71     $re_comment = '(?:--(?:[^-]|-[^-])*--)';
  72     $re_entity_name = '(?:[^&%#;<>\s]+)'; # NOTE: not really correct SGML
  73     $re_end_entity = '(?:;|$|(?=\s))'; # semicolon or before-whitespace
  74     $re_etag = q{(?:<\/?(?:"[^"]*"|'[^']*'|[^"'>\/])*[>\/])}; # end-tag
  75     @re_tag = ($re_tag_strict, $re_tag_compat) = (re_tag(0), re_tag(1));
  76 }
  77
  78 # End of the hideous stuff
  79
  80 use vars qw( $serial );
  81
  82 ###############################################################################
  83
  84 sub FATAL_P             () {'fatal-p'}
  85 sub SYNTAXERROR_P       () {'syntaxerror-p'}
  86
  87 sub FILENAME            () {'input'}
  88 sub HANDLE              () {'handle'}
  89
  90 sub READAHEAD           () {'readahead'}
  91 sub LINENUM_START       () {'lc_0'}
  92 sub LINENUM             () {'lc'}
  93 sub CDATA_MODE_P        () {'cdata-mode-p'}
  94 sub CDATA_CLOSE         () {'cdata-close'}
  95 sub PCDATA_MODE_P       () {'pcdata-mode-p'}    # additional submode for CDATA
  96
  97 sub ALLOW_CFORMAT_P     () {'allow-cformat-p'}
  98
  99 sub new {
 100     my $this = shift;
 101     my($input) = @_;
 102     my $class = ref($this) || $this;
 103     my $self = {};
 104     bless $self, $class;
 105
 106     my $handle = sprintf('TMPLTOKENIZER%d', $serial);
 107     $serial += 1;
 108
 109     no strict;
 110     open($handle, "<$input") || die "$input: $!\n";
 111     use strict;
 112     $self->{+FILENAME} = $input;
 113     $self->{+HANDLE} = $handle;
 114     $self->{+READAHEAD} = [];
 115     return $self;
 116 }
 117
 118 ###############################################################################
 119
 120 # Simple getters
 121
 122 sub filename {
 123     my $this = shift;
 124     return $this->{+FILENAME};
 125 }
 126
 127 sub _handle {
 128     my $this = shift;
 129     return $this->{+HANDLE};
 130 }
 131
 132 sub fatal_p {
 133     my $this = shift;
 134     return $this->{+FATAL_P};
 135 }
 136
 137 sub syntaxerror_p {
 138     my $this = shift;
 139     return $this->{+SYNTAXERROR_P};
 140 }
 141
 142 sub has_readahead_p {
 143     my $this = shift;
 144     return @{$this->{+READAHEAD}};
 145 }
 146
 147 sub _peek_readahead {
 148     my $this = shift;
 149     return $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}];
 150 }
 151
 152 sub line_number_start {
 153     my $this = shift;
 154     return $this->{+LINENUM_START};
 155 }
 156
 157 sub line_number {
 158     my $this = shift;
 159     return $this->{+LINENUM};
 160 }
 161
 162 sub cdata_mode_p {
 163     my $this = shift;
 164     return $this->{+CDATA_MODE_P};
 165 }
 166
 167 sub pcdata_mode_p {
 168     my $this = shift;
 169     return $this->{+PCDATA_MODE_P};
 170 }
 171
 172 sub cdata_close {
 173     my $this = shift;
 174     return $this->{+CDATA_CLOSE};
 175 }
 176
 177 sub allow_cformat_p {
 178     my $this = shift;
 179     return $this->{+ALLOW_CFORMAT_P};
 180 }
 181
 182 # Simple setters
 183
 184 sub _set_fatal {
 185     my $this = shift;
 186     $this->{+FATAL_P} = $_[0];
 187     return $this;
 188 }
 189
 190 sub _set_syntaxerror {
 191     my $this = shift;
 192     $this->{+SYNTAXERROR_P} = $_[0];
 193     return $this;
 194 }
 195
 196 sub _push_readahead {
 197     my $this = shift;
 198     push @{$this->{+READAHEAD}}, $_[0];
 199     return $this;
 200 }
 201
 202 sub _pop_readahead {
 203     my $this = shift;
 204     return pop @{$this->{+READAHEAD}};
 205 }
 206
 207 sub _append_readahead {
 208     my $this = shift;
 209     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] .= $_[0];
 210     return $this;
 211 }
 212
 213 sub _set_readahead {
 214     my $this = shift;
 215     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] = $_[0];
 216     return $this;
 217 }
 218
 219 sub _increment_line_number {
 220     my $this = shift;
 221     $this->{+LINENUM} += 1;
 222     return $this;
 223 }
 224
 225 sub _set_line_number_start {
 226     my $this = shift;
 227     $this->{+LINENUM_START} = $_[0];
 228     return $this;
 229 }
 230
 231 sub _set_cdata_mode {
 232     my $this = shift;
 233     $this->{+CDATA_MODE_P} = $_[0];
 234     return $this;
 235 }
 236
 237 sub _set_pcdata_mode {
 238     my $this = shift;
 239     $this->{+PCDATA_MODE_P} = $_[0];
 240     return $this;
 241 }
 242
 243 sub _set_cdata_close {
 244     my $this = shift;
 245     $this->{+CDATA_CLOSE} = $_[0];
 246     return $this;
 247 }
 248
 249 sub set_allow_cformat {
 250     my $this = shift;
 251     $this->{+ALLOW_CFORMAT_P} = $_[0];
 252     return $this;
 253 }
 254
 255 ###############################################################################
 256
 257 sub _extract_attributes ($;$) {
 258     my $this = shift;
 259     my($s, $lc) = @_;
 260     my %attr;
 261     $s = $1 if $s =~ /^<\S+(.*)\/\S$/s  # XML-style self-closing tags
 262             || $s =~ /^<\S+(.*)\S$/s;   # SGML-style tags
 263
 264     for (my $i = 0; $s =~ /^(?:$re_directive_control)?\s+(?:$re_directive_control)?(?:([a-zA-Z][-a-zA-Z0-9]*)\s*=\s*)?('((?:$re_directive|[^'])*)'|"((?:$re_directive|[^"])*)"|((?:$re_directive|[^\s<>])+))/os;) {
 265         my($key, $val, $val_orig, $rest)
 266                 = ($1, (defined $3? $3: defined $4? $4: $5), $2, $');
 267         $i += 1;
 268         $attr{+lc($key)} = [$key, $val, $val_orig, $i];
 269         $s = $rest;
 270         if ($val =~ /$re_tmpl_include/os) {
 271             warn_normal "TMPL_INCLUDE in attribute: $val_orig\n", $lc;
 272         } elsif ($val =~ /$re_tmpl_var/os && $val !~ /$re_tmpl_var_escaped/os) {
 273             # XXX: we probably should not warn if key is "onclick" etc
 274             # XXX: there's just no reasonable thing to suggest
 275             my $suggest = ($key =~ /^(?:action|archive|background|cite|classid|codebase|data|datasrc|for|href|longdesc|profile|src|usemap)$/i? 'URL': 'HTML');
 276             undef $suggest if $key =~ /^(?:onblur|onchange|onclick|ondblclick|onfocus|onkeydown|onkeypress|onkeyup|onload|onmousedown|onmousemove|onmouseout|onmouseover|onmouseup|onreset|onselect|onsubmit|onunload)$/i;
 277             warn_pedantic
 278                     "Suggest ESCAPE=$suggest for TMPL_VAR in attribute \"$key\""
 279                         . ": $val_orig",
 280                     $lc, \$pedantic_tmpl_var_use_in_nonpedantic_mode_p
 281                 if defined $suggest && (pedantic_p || !$pedantic_tmpl_var_use_in_nonpedantic_mode_p);
 282         } elsif ($val_orig !~ /^['"]/) {
 283             my $t = $val; $t =~ s/$re_directive_control//os;
 284             warn_pedantic
 285                 "Unquoted attribute contains character(s) that should be quoted"
 286                     . ": $val_orig",
 287                 $lc, \$pedantic_attribute_error_in_nonpedantic_mode_p
 288                 if $t =~ /[^-\.A-Za-z0-9]/s;
 289         }
 290     }
 291     my $s2 = $s; $s2 =~ s/$re_tmpl_endif_endloop//g; # for the next check
 292     if ($s2 =~ /\S/s) { # should never happen
 293         if ($s =~ /^([^\n]*)\n/s) { # this is even worse
 294             error_normal("Completely confused while extracting attributes: $1", $lc);
 295             error_normal((scalar(split(/\n/, $s)) - 1) . " more line(s) not shown.", undef);
 296             $this->_set_fatal( 1 );
 297         } else {
 298             # There's something wrong with the attribute syntax.
 299             # We might be able to deduce a likely cause by looking more.
 300             if ($s =~ /^[a-z0-9]/is && "<foo $s>" =~ /^$re_tag_compat$/s) {
 301                 warn_normal "Probably missing whitespace before or missing quotation mark near: $s\n", $lc;
 302             } else {
 303                 warn_normal "Strange attribute syntax: $s\n", $lc;
 304             }
 305         }
 306     }
 307     return \%attr;
 308 }
 309
 310 sub _next_token_internal {
 311     my $this = shift;
 312     my($h) = @_;
 313     my($it, $kind);
 314     my $eof_p = 0;
 315     $this->_pop_readahead if $this->has_readahead_p
 316             && !ref $this->_peek_readahead
 317             && !length $this->_peek_readahead;
 318     if (!$this->has_readahead_p) {
 319         my $next = scalar <$h>;
 320         $eof_p = !defined $next;
 321         if (!$eof_p) {
 322             $this->_increment_line_number;
 323             $this->_push_readahead( $next );
 324         }
 325     }
 326     $this->_set_line_number_start( $this->line_number ); # remember 1st line num
 327     if ($this->has_readahead_p && ref $this->_peek_readahead) { # TmplToken obj.
 328         ($it, $kind) = ($this->_pop_readahead, undef);
 329     } elsif ($eof_p && !$this->has_readahead_p) {       # nothing left to do
 330         ;
 331     } elsif ($this->_peek_readahead =~ /^\s+/s) {       # whitespace
 332         ($kind, $it) = (TmplTokenType::TEXT, $&);
 333         $this->_set_readahead( $' );
 334     # FIXME the following (the [<\s] part) is an unreliable HACK :-(
 335     } elsif ($this->_peek_readahead =~ /^(?:[^<]|<[<\s])*(?:[^<\s])/s) {        # non-space normal text
 336         ($kind, $it) = (TmplTokenType::TEXT, $&);
 337         $this->_set_readahead( $' );
 338         warn_normal "Unescaped < in $it\n", $this->line_number_start
 339                 if !$this->cdata_mode_p && $it =~ /</s;
 340     } else {                            # tag/declaration/processing instruction
 341         my $ok_p = 0;
 342         my $bad_comment_p = 0;
 343         for (my $cdata_close = $this->cdata_close;;) {
 344             if ($this->cdata_mode_p) {
 345                 my $next = $this->_pop_readahead;
 346                 if ($next =~ /^$cdata_close/is) {
 347                     ($kind, $it) = (TmplTokenType::TAG, $&);
 348                     $this->_push_readahead( $' );
 349                     $ok_p = 1;
 350                 } elsif ($next =~ /^((?:(?!$cdata_close).)+)($cdata_close)/is) {
 351                     ($kind, $it) = (TmplTokenType::TEXT, $1);
 352                     $this->_push_readahead( "$2$'" );
 353                     $ok_p = 1;
 354                 } else {
 355                     ($kind, $it) = (TmplTokenType::TEXT, $next);
 356                     $ok_p = 1;
 357                 }
 358             } elsif ($this->_peek_readahead =~ /^$re_tag_compat/os) {
 359                 # If we detect a "closed start tag" but we know that the
 360                 # following token looks like a TMPL_VAR, don't stop
 361                 my($head, $tail, $post) = ($1, $2, $3);
 362                 if ($tail eq '' && $post =~ $re_tmpl_var) {
 363                     # Don't bother to show the warning if we're too confused
 364                     # FIXME. There's no method for _closed_start_tag_warning
 365                     if (!defined $this->{'_closed_start_tag_warning'}
 366                         || ($this->{'_closed_start_tag_warning'}->[0] eq $head
 367                         && $this->{'_closed_start_tag_warning'}->[1] != $this->line_number - 1)) {
 368                     warn_normal "Possible SGML \"closed start tag\" notation: $head<\n", $this->line_number
 369                             if split(/\n/, $head) < 10;
 370                     }
 371                     $this->{'_closed_start_tag_warning'} = [$head, $this->line_number];
 372                 } else {
 373                     ($kind, $it) = (TmplTokenType::TAG, "$head>");
 374                     $this->_set_readahead( $post );
 375                     $ok_p = 1;
 376                     warn_normal "SGML \"closed start tag\" notation: $head<\n", $this->line_number if $tail eq '';
 377                 }
 378             } elsif ($this->_peek_readahead =~ /^<!--(?:(?!-->)$re_directive*.)*-->/os) {
 379                 ($kind, $it) = (TmplTokenType::COMMENT, $&);
 380                 $this->_set_readahead( $' );
 381                 $ok_p = 1;
 382                 $bad_comment_p = 1;
 383             }
 384         last if $ok_p;
 385             my $next = scalar <$h>;
 386             $eof_p = !defined $next;
 387         last if $eof_p;
 388             $this->_increment_line_number;
 389             $this->_append_readahead( $next );
 390         }
 391         if ($kind ne TmplTokenType::TAG) {
 392             ;
 393         } elsif ($it =~ /^<!/) {
 394             $kind = TmplTokenType::DECL;
 395             $kind = TmplTokenType::COMMENT if $it =~ /^<!--(?:(?!-->).)*-->/;
 396             if ($kind == TmplTokenType::COMMENT && $it =~ /^<!--\s*#include/s) {
 397                 warn_normal "Apache #include directive found instead of HTML::Template <TMPL_INCLUDE> directive", $this->line_number_start;
 398             }
 399         } elsif ($it =~ /^<\?/) {
 400             $kind = TmplTokenType::PI;
 401         }
 402         if ($it =~ /^$re_directive/ios && !$this->cdata_mode_p) {
 403             $kind = TmplTokenType::DIRECTIVE;
 404         } elsif ($bad_comment_p) {
 405             warn_normal sprintf("Syntax error in comment: %s\n", $it),
 406                     $this->line_number_start;
 407             $this->_set_syntaxerror( 1 );
 408         }
 409         if (!$ok_p && $eof_p) {
 410             ($kind, $it) = (TmplTokenType::UNKNOWN, $this->_peek_readahead);
 411             $this->_set_readahead, undef;
 412             $this->_set_syntaxerror( 1 );
 413         }
 414     }
 415     warn_normal "Unrecognizable token found: "
 416             . (split(/\n/, $it) < 10? $it: '(too confused to show details)')
 417             . "\n", $this->line_number_start
 418         if $kind == TmplTokenType::UNKNOWN;
 419     return defined $it? (ref $it? $it: TmplToken->new($it, $kind, $this->line_number, $this->filename)): undef;
 420 }
 421
 422 sub _next_token_intermediate {
 423     my $this = shift;
 424     my $h = $this->_handle;
 425     my $it;
 426     if (!$this->cdata_mode_p) {
 427         $it = $this->_next_token_internal($h);
 428         if (defined $it && $it->type == TmplTokenType::TAG) {
 429             if ($it->string =~ /^<(script|style|textarea)\b/is) {
 430                 $this->_set_cdata_mode( 1 );
 431                 $this->_set_cdata_close( "</$1\\s*>" );
 432                 $this->_set_pcdata_mode( 0 );
 433             } elsif ($it->string =~ /^<(title)\b/is) {
 434                 $this->_set_cdata_mode( 1 );
 435                 $this->_set_cdata_close( "</$1\\s*>" );
 436                 $this->_set_pcdata_mode( 1 );
 437             }
 438             $it->set_attributes( $this->_extract_attributes($it->string, $it->line_number) );
 439         }
 440     } else {
 441         my $eof_p = 0;
 442         for ($it = '', my $cdata_close = $this->cdata_close;;) {
 443             my $next = $this->_next_token_internal($h);
 444             $eof_p = !defined $next;
 445         last if $eof_p;
 446             if (defined $next && $next->string =~ /$cdata_close/is) {
 447                 $this->_push_readahead( $next ); # push entire TmplToken object
 448                 $this->_set_cdata_mode( 0 );
 449             }
 450         last unless $this->cdata_mode_p;
 451             $it .= $next->string;
 452         }
 453         if ($eof_p) {
 454             $it = undef;
 455             error_normal "Unexpected end of file while looking for "
 456                     . $this->cdata_close
 457                     . "\n", $this->line_number_start;
 458             $this->_set_fatal( 1 );
 459             $this->_set_syntaxerror( 1 );
 460         }
 461         if ($this->pcdata_mode_p) {
 462             my $check = $it;
 463             $check =~ s/$re_directive//gos;
 464             warn_pedantic "Markup found in PCDATA\n", $this->line_number,
 465                             \$pedantic_error_markup_in_pcdata_p
 466                     if $check =~ /$re_tag_compat/s;
 467         }
 468         $it = TmplToken->new( $it, TmplTokenType::CDATA, $this->line_number )
 469                 if defined $it;
 470         $this->_set_pcdata_mode, 0;
 471         $this->_set_cdata_close, undef unless !defined $it;
 472     }
 473     return $it;
 474 }
 475
 476 sub _token_groupable1_p ($) { # as first token, groupable into TEXT_PARAMETRIZED
 477     my($t) = @_;
 478     return ($t->type == TmplTokenType::TEXT && $t->string !~ /^[,\.:\|\s]+$/is)
 479         || ($t->type == TmplTokenType::DIRECTIVE
 480                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
 481         || ($t->type == TmplTokenType::TAG
 482                 && ($t->string =~ /^<(?:b|em|h[123456]|i|u)\b/is
 483 #               || ($t->string =~ /^<input\b/is
 484 #                   && $t->attributes->{'type'}->[1] =~ /^(?:radio|text)$/is)
 485                     ))
 486 }
 487
 488 sub _token_groupable2_p ($) { # as other token, groupable into TEXT_PARAMETRIZED
 489     my($t) = @_;
 490     return ($t->type == TmplTokenType::TEXT && ($t->string =~ /^\s*$/s || $t->string !~ /^[\|\s]+$/is))
 491         || ($t->type == TmplTokenType::DIRECTIVE
 492                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
 493         || ($t->type == TmplTokenType::TAG
 494                 && ($t->string =~ /^<\/?(?:a|b|em|h[123456]|i|u)\b/is
 495                 || ($t->string =~ /^<input\b/is
 496                     && $t->attributes->{'type'} =~ /^(?:radio|text)$/is)))
 497 }
 498
 499 sub _quote_cformat ($) {
 500     my($s) = @_;
 501     $s =~ s/%/%%/g;
 502     return $s;
 503 }
 504
 505 sub string_canon ($) {
 506     my($s) = @_;
 507     if (1) { # FIXME
 508         # Fold all whitespace into single blanks
 509         $s =~ s/\s+/ /gs;
 510     }
 511     return $s;
 512 }
 513
 514 sub _formalize_string_cformat ($) {
 515     my($s) = @_;
 516     return _quote_cformat string_canon $s;
 517 }
 518
 519 sub _formalize ($) {
 520     my($t) = @_;
 521     return $t->type == TmplTokenType::DIRECTIVE? '%s':
 522            $t->type == TmplTokenType::TEXT?
 523                    _formalize_string_cformat($t->string):
 524            $t->type == TmplTokenType::TAG?
 525                    ($t->string =~ /^<a\b/is? '<a>':
 526                     $t->string =~ /^<input\b/is? '<input>':
 527                     _quote_cformat($t->string)):
 528                _quote_cformat($t->string);
 529 }
 530
 531 sub _optimize {
 532     my $this = shift;
 533     my @structure = @_;
 534     my $undo_trailing_blanks = sub {
 535                 for (my $i = $#structure; $i >= 0; $i -= 1) {
 536                 last if $structure[$i]->type != TmplTokenType::TEXT;
 537                 last if !blank_p($structure[$i]->string);
 538                     push @{$this->{_queue}}, pop @structure;
 539                 }
 540             };
 541     &$undo_trailing_blanks;
 542     # FIXME: If the last token is a close tag but there are no tags
 543     # FIXME: before it, drop the close tag back into the queue. This
 544     # FIXME: is an ugly hack to get rid of "foo %s</h1>" type mess.
 545     if (@structure >= 2
 546             && $structure[$#structure]->type == TmplTokenType::TAG
 547             && $structure[$#structure]->string =~ /^<\//s) {
 548         my $has_other_tags_p = 0;
 549         for (my $i = 0; $i < $#structure; $i += 1) {
 550             $has_other_tags_p = 1 if $structure[$i]->type == TmplTokenType::TAG;
 551         last if $has_other_tags_p;
 552         }
 553         push @{$this->{_queue}}, pop @structure unless $has_other_tags_p;
 554         &$undo_trailing_blanks;
 555     }
 556     # FIXME: Do the same ugly hack for the last token being a ( or [
 557     if (@structure >= 2
 558             && $structure[$#structure]->type == TmplTokenType::TEXT
 559             && $structure[$#structure]->string =~ /^[\(\[]$/) { # not )]
 560         push @{$this->{_queue}}, pop @structure;
 561         &$undo_trailing_blanks;
 562     }
 563     return @structure;
 564 }
 565
 566 sub looks_plausibly_like_groupable_text_p (@) {
 567     my @structure = @_;
 568     # The text would look plausibly groupable if all open tags are also closed.
 569     my @tags = ();
 570     my $error_p = 0;
 571     for (my $i = 0; $i <= $#structure; $i += 1) {
 572         if ($structure[$i]->type == TmplTokenType::TAG) {
 573             if ($structure[$i]->string =~ /^<([A-Z0-9]+)/is) {
 574                 my $tag = lc($1);
 575                 push @tags, $tag unless $tag =~ /^<(?:input)/is
 576                         || $tag =~ /\/>$/is;
 577             } elsif ($structure[$i]->string =~ /^<\/([A-Z0-9]+)/is) {
 578                 if (@tags && lc($1) eq $tags[$#tags]) {
 579                     pop @tags;
 580                 } else {
 581                     $error_p = 1;
 582                 }
 583             }
 584         } elsif ($structure[$i]->type != TmplTokenType::TEXT) {
 585             $error_p = 1;
 586         }
 587     last if $error_p;
 588     }
 589     return !$error_p && !@tags;
 590 }
 591
 592 sub next_token {
 593     my $this = shift;
 594     my $h = $this->_handle;
 595     my $it;
 596     $this->{_queue} = [] unless defined $this->{_queue};
 597
 598     # Don't reparse anything in the queue. We can put a parametrized token
 599     # there if we need to, however.
 600     if (@{$this->{_queue}}) {
 601         $it = pop @{$this->{_queue}};
 602     } else {
 603         $it = $this->_next_token_intermediate($h);
 604         if (!$this->cdata_mode_p && $this->allow_cformat_p && defined $it
 605             && ($it->type == TmplTokenType::TEXT?
 606                 !blank_p( $it->string ): _token_groupable1_p( $it ))) {
 607             my @structure = ( $it );
 608             my @tags = ();
 609             my $next = undef;
 610             my($nonblank_text_p, $parametrized_p, $with_anchor_p, $with_input_p) = (0, 0, 0, 0);
 611             if ($it->type == TmplTokenType::TEXT) {
 612                 $nonblank_text_p = 1 if !blank_p( $it->string );
 613             } elsif ($it->type == TmplTokenType::DIRECTIVE) {
 614                 $parametrized_p = 1;
 615             } elsif ($it->type == TmplTokenType::TAG && $it->string =~ /^<([A-Z0-9]+)/is) {
 616                 push @tags, lc($1);
 617                 $with_anchor_p = 1 if lc($1) eq 'a';
 618                 $with_input_p = 1 if lc($1) eq 'input';
 619             }
 620             # We hate | and || in msgid strings, so we try to avoid them
 621             for (my $i = 1, my $quit_p = 0, my $quit_next_p = ($it->type == TmplTokenType::TEXT && $it->string =~ /^\|+$/s);; $i += 1) {
 622                 $next = $this->_next_token_intermediate($h);
 623                 push @structure, $next; # for consistency (with initialization)
 624             last unless defined $next && _token_groupable2_p( $next );
 625             last if $quit_next_p;
 626                 if ($next->type == TmplTokenType::TEXT) {
 627                     $nonblank_text_p = 1 if !blank_p( $next->string );
 628                     $quit_p = 1 if $next->string =~ /^\|+$/s; # We hate | and ||
 629                 } elsif ($next->type == TmplTokenType::DIRECTIVE) {
 630                     $parametrized_p = 1;
 631                 } elsif ($next->type == TmplTokenType::TAG) {
 632                     if ($next->string =~ /^<([A-Z0-9]+)/is) {
 633                         push @tags, lc($1);
 634                         $with_anchor_p = 1 if lc($1) eq 'a';
 635                         $with_input_p = 1 if lc($1) eq 'input';
 636                     } elsif ($next->string =~ /^<\/([A-Z0-9]+)/is) {
 637                         my $close = lc($1);
 638                         $quit_p = 1 unless @tags && $close eq $tags[$#tags];
 639                         $quit_next_p = 1 if $close =~ /^h\d$/;
 640                         pop @tags;
 641                     }
 642                 }
 643             last if $quit_p;
 644             }
 645             # Undo the last token
 646             push @{$this->{_queue}}, pop @structure;
 647             # Simply it a bit more
 648             @structure = $this->_optimize( @structure );
 649             if (@structure < 2) {
 650                 # Nothing to do
 651                 ;
 652             } elsif ($nonblank_text_p && ($parametrized_p || $with_anchor_p || $with_input_p)) {
 653                 # Create the corresponding c-format string
 654                 my $string = join('', map { $_->string } @structure);
 655                 my $form = join('', map { _formalize $_ } @structure);
 656                 my($a_counter, $input_counter) = (0, 0);
 657                 $form =~ s/<a>/ $a_counter += 1, "<a$a_counter>" /egs;
 658                 $form =~ s/<input>/ $input_counter += 1, "<input$input_counter>" /egs;
 659                 $it = TmplToken->new($string, TmplTokenType::TEXT_PARAMETRIZED,
 660                         $it->line_number, $it->pathname);
 661                 $it->set_form( $form );
 662                 $it->set_children( @structure );
 663             } elsif ($nonblank_text_p
 664                     && looks_plausibly_like_groupable_text_p( @structure )
 665                     && $structure[$#structure]->type == TmplTokenType::TEXT) {
 666                 # Combine the strings
 667                 my $string = join('', map { $_->string } @structure);
 668                 $it = TmplToken->new($string, TmplTokenType::TEXT,
 669                         $it->line_number, $it->pathname);;
 670             } else {
 671                 # Requeue the tokens thus seen for re-emitting
 672                 for (;;) {
 673                     push @{$this->{_queue}}, pop @structure;
 674                 last if !@structure;
 675                 }
 676                 $it = pop @{$this->{_queue}};
 677             }
 678         }
 679     }
 680     if (defined $it && $it->type == TmplTokenType::TEXT) {
 681         my $form = string_canon $it->string;
 682         $it->set_form( $form );
 683     }
 684     return $it;
 685 }
 686
 687 ###############################################################################
 688
 689 # Other simple functions (These are not methods)
 690
 691 sub blank_p ($) {
 692     my($s) = @_;
 693     return $s =~ /^(?:\s|\&nbsp$re_end_entity|$re_tmpl_var)*$/os;
 694 }
 695
 696 sub trim ($) {
 697     my($s0) = @_;
 698     my $l0 = length $s0;
 699     my $s = $s0;
 700     $s =~ s/^(\s|\&nbsp$re_end_entity)+//os; my $l1 = $l0 - length $s;
 701     $s =~ s/(\s|\&nbsp$re_end_entity)+$//os; my $l2 = $l0 - $l1 - length $s;
 702     return wantarray? (substr($s0, 0, $l1), $s, substr($s0, $l0 - $l2)): $s;
 703 }
 704
 705 sub quote_po ($) {
 706     my($s) = @_;
 707     # Locale::PO->quote is buggy, it doesn't quote newlines :-/
 708     $s =~ s/([\\"])/\\\1/gs;
 709     $s =~ s/\n/\\n/g;
 710     #$s =~ s/[\177-\377]/ sprintf("\\%03o", ord($&)) /egs;
 711     return "\"$s\"";
 712 }
 713
 714 # Some functions that shouldn't be here... should be moved out some time
 715 sub parametrize ($$$) {
 716     my($fmt_0, $params, $anchors) = @_;
 717     my $it = '';
 718     for (my $n = 0, my $fmt = $fmt_0; length $fmt;) {
 719         if ($fmt =~ /^[^%]+/) {
 720             $fmt = $';
 721             $it .= $&;
 722         } elsif ($fmt =~ /^%%/) {
 723             $fmt = $';
 724             $it .= '%';
 725         } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?s/) {
 726             $n += 1;
 727             my($i, $width, $prec) = ((defined $1? $1: $n), $2, $3);
 728             $fmt = $';
 729             if (!defined $width && !defined $prec) {
 730                 my $param = $params->[$i - 1];
 731                 $it .= $param;
 732                 warn_normal "$&: Undefined parameter $i for msgid \"$fmt_0\"",
 733                             undef
 734                         unless defined $param;
 735             } elsif (defined $width && defined $prec && !$width && !$prec) {
 736                 ;
 737             } else {
 738                 die "Unsupported precision specification in format: $&\n"; #XXX
 739             }
 740         } elsif ($fmt =~ /^%[^%a-zA-Z]*[a-zA-Z]/) {
 741             $fmt = $';
 742             $it .= $&;
 743             die "Unknown or unsupported format specification: $&\n"; #XXX
 744         } else {
 745             die "Completely confused parametrizing: $fmt\n";#XXX
 746         }
 747     }
 748     for (my $n = 0, my $fmt = $it, $it = ''; length $fmt;) {
 749         if ($fmt =~ /^(?:(?!<a\d+>).)+/is) {
 750             $fmt = $';
 751             $it .= $&;
 752         } elsif ($fmt =~ /^<a(\d+)>/is) {
 753             $n += 1;
 754             my $i  = $1;
 755             $fmt = $';
 756             my $anchor = $anchors->[$i - 1];
 757             warn_normal "$&: Anchor $1 not found for msgid \"$fmt_0\"", undef #FIXME
 758                     unless defined $anchor;
 759             $it .= $anchor->string;
 760         } else {
 761             die "Completely confused decoding anchors: $fmt\n";#XXX
 762         }
 763     }
 764     return $it;
 765 }
 766
 767 sub charset_canon ($) {
 768     my($charset) = @_;
 769     $charset = uc($charset);
 770     $charset = "$1-$2" if $charset =~ /^(ISO|UTF)(\d.*)/i;
 771     $charset = 'Big5' if $charset eq 'BIG5'; # "Big5" must be in mixed case
 772     return $charset;
 773 }
 774
 775 use vars qw( @latin1_utf8 );
 776 @latin1_utf8 = (
 777     "\302\200", "\302\201", "\302\202", "\302\203", "\302\204", "\302\205",
 778     "\302\206", "\302\207", "\302\210", "\302\211", "\302\212", "\302\213",
 779     "\302\214", "\302\215",   undef,      undef,    "\302\220", "\302\221",
 780     "\302\222", "\302\223", "\302\224", "\302\225", "\302\226", "\302\227",
 781     "\302\230", "\302\231", "\302\232", "\302\233", "\302\234", "\302\235",
 782     "\302\236", "\302\237", "\302\240", "\302\241", "\302\242", "\302\243",
 783     "\302\244", "\302\245", "\302\246", "\302\247", "\302\250", "\302\251",
 784     "\302\252", "\302\253", "\302\254", "\302\255", "\302\256", "\302\257",
 785     "\302\260", "\302\261", "\302\262", "\302\263", "\302\264", "\302\265",
 786     "\302\266", "\302\267", "\302\270", "\302\271", "\302\272", "\302\273",
 787     "\302\274", "\302\275", "\302\276", "\302\277", "\303\200", "\303\201",
 788     "\303\202", "\303\203", "\303\204", "\303\205", "\303\206", "\303\207",
 789     "\303\210", "\303\211", "\303\212", "\303\213", "\303\214", "\303\215",
 790     "\303\216", "\303\217", "\303\220", "\303\221", "\303\222", "\303\223",
 791     "\303\224", "\303\225", "\303\226", "\303\227", "\303\230", "\303\231",
 792     "\303\232", "\303\233", "\303\234", "\303\235", "\303\236", "\303\237",
 793     "\303\240", "\303\241", "\303\242", "\303\243", "\303\244", "\303\245",
 794     "\303\246", "\303\247", "\303\250", "\303\251", "\303\252", "\303\253",
 795     "\303\254", "\303\255", "\303\256", "\303\257", "\303\260", "\303\261",
 796     "\303\262", "\303\263", "\303\264", "\303\265", "\303\266", "\303\267",
 797     "\303\270", "\303\271", "\303\272", "\303\273", "\303\274", "\303\275",
 798     "\303\276", "\303\277" );
 799
 800 sub charset_convert ($$$) {
 801     my($s, $charset_in, $charset_out) = @_;
 802     if ($s !~ /[\200-\377]/s) { # FIXME: don't worry about iso2022 for now
 803         ;
 804     } elsif ($charset_in eq 'ISO-8859-1' && $charset_out eq 'UTF-8') {
 805         $s =~ s/[\200-\377]/ $latin1_utf8[ord($&) - 128] /egs;
 806     } elsif ($charset_in ne $charset_out) {
 807         VerboseWarnings::warn_normal "conversion from $charset_in to $charset_out is not supported\n", undef;
 808     }
 809     return $s;
 810 }
 811
 812 ###############################################################################
 813
 814 =pod
 815
 816 In addition to the basic scanning, this class will also perform
 817 the following:
 818
 819 =over
 820
 821 =item -
 822
 823 Emulation of c-format strings (see below)
 824
 825 =item -
 826
 827 Display of warnings for certain things that affects either the
 828 ability of this class to yield correct output, or things that
 829 are known to cause the original template to cause trouble.
 830
 831 =item -
 832
 833 Automatic correction of some of the things warned about
 834 (e.g., SGML "closed start tag" notation).
 835
 836 =back
 837
 838 =head2 c-format strings emulation
 839
 840 Because English word order is not universal, a simple extraction
 841 of translatable strings may yield some strings like "Accounts for"
 842 or ambiguous strings like "in". This makes the resulting strings
 843 difficult to translate, but does not affect all languages alike.
 844 For example, Chinese (with a somewhat different word order) would
 845 be hit harder, but French would be relatively unaffected.
 846
 847 To overcome this problem, the scanner can be configured to detect
 848 patterns with <TMPL_VAR> directives (as well as certain HTML tags),
 849 and try to construct a larger pattern that will appear in the PO
 850 file as c-format strings with %s placeholders. This additional
 851 step allows the translator to deal with cases where word order
 852 is different (replacing %s with %1$s, %2$s, etc.), or when certain
 853 words will require certain inflectional suffixes in sentences.
 854
 855 Because this is an incompatible change, this mode must be explicitly
 856 turned on using the set_cformat(1) method call.
 857
 858 =head1 HISTORY
 859
 860 This tokenizer is mostly based
 861 on Ambrose's hideous Perl script known as subst.pl.
 862
 863 =cut
 864
 865 1;