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
  37 ###############################################################################
  38
  39 # Hideous stuff
  40 use vars qw( $re_directive $re_tmpl_var $re_tmpl_var_escaped $re_tmpl_include );
  41 use vars qw( $re_directive_control $re_tmpl_endif_endloop );
  42 BEGIN {
  43     # $re_directive must not do any backreferences
  44     $re_directive = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:VAR|LOOP|INCLUDE|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  45     # TMPL_VAR or TMPL_INCLUDE
  46     $re_tmpl_var = q{<(?:(?i)(?:!--\s*)?TMPL_(?:VAR)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  47     $re_tmpl_include = q{<(?:(?i)(?:!--\s*)?TMPL_(?:INCLUDE)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  48     # TMPL_VAR ESCAPE=1/HTML/URL
  49     $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*(?:--)?)>};
  50     # Any control flow directive
  51     $re_directive_control = q{<(?:(?i)(?:!--\s*)?\/?TMPL_(?:LOOP|IF|ELSE|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  52     # /LOOP or /IF or /UNLESS
  53     $re_tmpl_endif_endloop = q{<(?:(?i)(?:!--\s*)?\/TMPL_(?:LOOP|IF|UNLESS)(?:\s+(?:[a-zA-Z][-a-zA-Z0-9]*=)?(?:'[^']*'|"[^"]*"|[^\s<>]+))*\s*(?:--)?)>};
  54 }
  55
  56 # Hideous stuff from subst.pl, slightly modified to use the above hideous stuff
  57 # Note: The $re_tag's set $1 (<tag), $2 (>), and $3 (rest of string)
  58 use vars qw( $re_comment $re_entity_name $re_end_entity $re_etag );
  59 use vars qw( $re_tag_strict $re_tag_compat @re_tag );
  60 sub re_tag ($) {
  61    my($compat) = @_;
  62    my $etag = $compat? '>': '<>\/';
  63    # This is no longer similar to the original regexp in subst.pl :-(
  64    # Note that we don't want <> in compat mode; Mozilla knows about <
  65    q{(<\/?(?:|(?:"(?:} . $re_directive . q{|[^"])*"|'(?:} . $re_directive . q{|[^'])*'|--(?:[^-]|-[^-])*--|(?:}
  66    . $re_directive
  67    . q{|(?!--)[^"'<>} . $etag . q{]))+))([} . $etag . q{]|(?=<))(.*)};
  68 }
  69 BEGIN {
  70     $re_comment = '(?:--(?:[^-]|-[^-])*--)';
  71     $re_entity_name = '(?:[^&%#;<>\s]+)'; # NOTE: not really correct SGML
  72     $re_end_entity = '(?:;|$|(?=\s))'; # semicolon or before-whitespace
  73     $re_etag = q{(?:<\/?(?:"[^"]*"|'[^']*'|[^"'>\/])*[>\/])}; # end-tag
  74     @re_tag = ($re_tag_strict, $re_tag_compat) = (re_tag(0), re_tag(1));
  75 }
  76
  77 # End of the hideous stuff
  78
  79 use vars qw( $serial );
  80
  81 ###############################################################################
  82
  83 sub FATAL_P             () {'fatal-p'}
  84 sub SYNTAXERROR_P       () {'syntaxerror-p'}
  85
  86 sub FILENAME            () {'input'}
  87 sub HANDLE              () {'handle'}
  88
  89 sub READAHEAD           () {'readahead'}
  90 sub LINENUM_START       () {'lc_0'}
  91 sub LINENUM             () {'lc'}
  92 sub CDATA_MODE_P        () {'cdata-mode-p'}
  93 sub CDATA_CLOSE         () {'cdata-close'}
  94
  95 sub ALLOW_CFORMAT_P     () {'allow-cformat-p'}
  96
  97 sub new {
  98     my $this = shift;
  99     my($input) = @_;
 100     my $class = ref($this) || $this;
 101     my $self = {};
 102     bless $self, $class;
 103
 104     my $handle = sprintf('TMPLTOKENIZER%d', $serial);
 105     $serial += 1;
 106
 107     no strict;
 108     open($handle, "<$input") || die "$input: $!\n";
 109     use strict;
 110     $self->{+FILENAME} = $input;
 111     $self->{+HANDLE} = $handle;
 112     $self->{+READAHEAD} = [];
 113     return $self;
 114 }
 115
 116 ###############################################################################
 117
 118 # Simple getters
 119
 120 sub filename {
 121     my $this = shift;
 122     return $this->{+FILENAME};
 123 }
 124
 125 sub _handle {
 126     my $this = shift;
 127     return $this->{+HANDLE};
 128 }
 129
 130 sub fatal_p {
 131     my $this = shift;
 132     return $this->{+FATAL_P};
 133 }
 134
 135 sub syntaxerror_p {
 136     my $this = shift;
 137     return $this->{+SYNTAXERROR_P};
 138 }
 139
 140 sub has_readahead_p {
 141     my $this = shift;
 142     return @{$this->{+READAHEAD}};
 143 }
 144
 145 sub _peek_readahead {
 146     my $this = shift;
 147     return $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}];
 148 }
 149
 150 sub line_number_start {
 151     my $this = shift;
 152     return $this->{+LINENUM_START};
 153 }
 154
 155 sub line_number {
 156     my $this = shift;
 157     return $this->{+LINENUM};
 158 }
 159
 160 sub cdata_mode_p {
 161     my $this = shift;
 162     return $this->{+CDATA_MODE_P};
 163 }
 164
 165 sub cdata_close {
 166     my $this = shift;
 167     return $this->{+CDATA_CLOSE};
 168 }
 169
 170 sub allow_cformat_p {
 171     my $this = shift;
 172     return $this->{+ALLOW_CFORMAT_P};
 173 }
 174
 175 # Simple setters
 176
 177 sub _set_fatal {
 178     my $this = shift;
 179     $this->{+FATAL_P} = $_[0];
 180     return $this;
 181 }
 182
 183 sub _set_syntaxerror {
 184     my $this = shift;
 185     $this->{+SYNTAXERROR_P} = $_[0];
 186     return $this;
 187 }
 188
 189 sub _push_readahead {
 190     my $this = shift;
 191     push @{$this->{+READAHEAD}}, $_[0];
 192     return $this;
 193 }
 194
 195 sub _pop_readahead {
 196     my $this = shift;
 197     return pop @{$this->{+READAHEAD}};
 198 }
 199
 200 sub _append_readahead {
 201     my $this = shift;
 202     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] .= $_[0];
 203     return $this;
 204 }
 205
 206 sub _set_readahead {
 207     my $this = shift;
 208     $this->{+READAHEAD}->[$#{$this->{+READAHEAD}}] = $_[0];
 209     return $this;
 210 }
 211
 212 sub _increment_line_number {
 213     my $this = shift;
 214     $this->{+LINENUM} += 1;
 215     return $this;
 216 }
 217
 218 sub _set_line_number_start {
 219     my $this = shift;
 220     $this->{+LINENUM_START} = $_[0];
 221     return $this;
 222 }
 223
 224 sub _set_cdata_mode {
 225     my $this = shift;
 226     $this->{+CDATA_MODE_P} = $_[0];
 227     return $this;
 228 }
 229
 230 sub _set_cdata_close {
 231     my $this = shift;
 232     $this->{+CDATA_CLOSE} = $_[0];
 233     return $this;
 234 }
 235
 236 sub set_allow_cformat {
 237     my $this = shift;
 238     $this->{+ALLOW_CFORMAT_P} = $_[0];
 239     return $this;
 240 }
 241
 242 ###############################################################################
 243
 244 sub _extract_attributes ($;$) {
 245     my $this = shift;
 246     my($s, $lc) = @_;
 247     my %attr;
 248     $s = $1 if $s =~ /^<\S+(.*)\/\S$/s  # XML-style self-closing tags
 249             || $s =~ /^<\S+(.*)\S$/s;   # SGML-style tags
 250
 251     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;) {
 252         my($key, $val, $val_orig, $rest)
 253                 = ($1, (defined $3? $3: defined $4? $4: $5), $2, $');
 254         $i += 1;
 255         $attr{+lc($key)} = [$key, $val, $val_orig, $i];
 256         $s = $rest;
 257         if ($val =~ /$re_tmpl_include/os) {
 258             warn_normal "TMPL_INCLUDE in attribute: $val_orig\n", $lc;
 259         } elsif ($val =~ /$re_tmpl_var/os && $val !~ /$re_tmpl_var_escaped/os) {
 260             # XXX: we probably should not warn if key is "onclick" etc
 261             # XXX: there's just no reasonable thing to suggest
 262             my $suggest = ($key =~ /^(?:action|archive|background|cite|classid|codebase|data|datasrc|for|href|longdesc|profile|src|usemap)$/i? 'URL': 'HTML');
 263             undef $suggest if $key =~ /^(?:onblur|onchange|onclick|ondblclick|onfocus|onkeydown|onkeypress|onkeyup|onload|onmousedown|onmousemove|onmouseout|onmouseover|onmouseup|onreset|onselect|onsubmit|onunload)$/i;
 264             warn_pedantic
 265                     "Suggest ESCAPE=$suggest for TMPL_VAR in attribute \"$key\""
 266                         . ": $val_orig",
 267                     $lc, \$pedantic_tmpl_var_use_in_nonpedantic_mode_p
 268                 if defined $suggest && (pedantic_p || !$pedantic_tmpl_var_use_in_nonpedantic_mode_p);
 269         } elsif ($val_orig !~ /^['"]/) {
 270             my $t = $val; $t =~ s/$re_directive_control//os;
 271             warn_pedantic
 272                 "Unquoted attribute contains character(s) that should be quoted"
 273                     . ": $val_orig",
 274                 $lc, \$pedantic_attribute_error_in_nonpedantic_mode_p
 275                 if $t =~ /[^-\.A-Za-z0-9]/s;
 276         }
 277     }
 278     my $s2 = $s; $s2 =~ s/$re_tmpl_endif_endloop//g; # for the next check
 279     if ($s2 =~ /\S/s) { # should never happen
 280         if ($s =~ /^([^\n]*)\n/s) { # this is even worse
 281             error_normal("Completely confused while extracting attributes: $1", $lc);
 282             error_normal((scalar(split(/\n/, $s)) - 1) . " more line(s) not shown.", undef);
 283             $this->_set_fatal( 1 );
 284         } else {
 285             warn_normal "Strange attribute syntax: $s\n", $lc;
 286         }
 287     }
 288     return \%attr;
 289 }
 290
 291 sub _next_token_internal {
 292     my $this = shift;
 293     my($h) = @_;
 294     my($it, $kind);
 295     my $eof_p = 0;
 296     $this->_pop_readahead if $this->has_readahead_p
 297             && !ref $this->_peek_readahead
 298             && !length $this->_peek_readahead;
 299     if (!$this->has_readahead_p) {
 300         my $next = scalar <$h>;
 301         $eof_p = !defined $next;
 302         if (!$eof_p) {
 303             $this->_increment_line_number;
 304             $this->_push_readahead( $next );
 305         }
 306     }
 307     $this->_set_line_number_start( $this->line_number ); # remember 1st line num
 308     if ($this->has_readahead_p && ref $this->_peek_readahead) { # TmplToken obj.
 309         ($it, $kind) = ($this->_pop_readahead, undef);
 310     } elsif ($eof_p && !$this->has_readahead_p) {       # nothing left to do
 311         ;
 312     } elsif ($this->_peek_readahead =~ /^\s+/s) {       # whitespace
 313         ($kind, $it) = (TmplTokenType::TEXT, $&);
 314         $this->_set_readahead( $' );
 315     # FIXME the following (the [<\s] part) is an unreliable HACK :-(
 316     } elsif ($this->_peek_readahead =~ /^(?:[^<]|<[<\s])*(?:[^<\s])/s) {        # non-space normal text
 317         ($kind, $it) = (TmplTokenType::TEXT, $&);
 318         $this->_set_readahead( $' );
 319         warn_normal "Unescaped < in $it\n", $this->line_number_start
 320                 if !$this->cdata_mode_p && $it =~ /</s;
 321     } else {                            # tag/declaration/processing instruction
 322         my $ok_p = 0;
 323         for (my $cdata_close = $this->cdata_close;;) {
 324             if ($this->cdata_mode_p) {
 325                 if ($this->_peek_readahead =~ /^$cdata_close/) {
 326                     ($kind, $it) = (TmplTokenType::TAG, $&);
 327                     $this->_set_readahead( $' );
 328                     $ok_p = 1;
 329                 } else {
 330                     ($kind, $it) = (TmplTokenType::TEXT, $this->_pop_readahead);
 331                     $ok_p = 1;
 332                 }
 333             } elsif ($this->_peek_readahead =~ /^$re_tag_compat/os) {
 334                 # If we detect a "closed start tag" but we know that the
 335                 # following token looks like a TMPL_VAR, don't stop
 336                 my($head, $tail, $post) = ($1, $2, $3);
 337                 if ($tail eq '' && $post =~ $re_tmpl_var) {
 338                     # Don't bother to show the warning if we're too confused
 339                     warn_normal "Possible SGML \"closed start tag\" notation: $head<\n", $this->line_number
 340                             if split(/\n/, $head) < 10;
 341                 } else {
 342                     ($kind, $it) = (TmplTokenType::TAG, "$head>");
 343                     $this->_set_readahead( $post );
 344                     $ok_p = 1;
 345                     warn_normal "SGML \"closed start tag\" notation: $head<\n", $this->line_number if $tail eq '';
 346                 }
 347             } elsif ($this->_peek_readahead =~ /^<!--(?:(?!-->).)*-->/s) {
 348                 ($kind, $it) = (TmplTokenType::COMMENT, $&);
 349                 $this->_set_readahead( $' );
 350                 $ok_p = 1;
 351                 warn_normal "Syntax error in comment: $&\n", $this->line_number_start;
 352                 $this->_set_syntaxerror( 1 );
 353             }
 354         last if $ok_p;
 355             my $next = scalar <$h>;
 356             $eof_p = !defined $next;
 357         last if $eof_p;
 358             $this->_increment_line_number;
 359             $this->_append_readahead( $next );
 360         }
 361         if ($kind ne TmplTokenType::TAG) {
 362             ;
 363         } elsif ($it =~ /^<!/) {
 364             $kind = TmplTokenType::DECL;
 365             $kind = TmplTokenType::COMMENT if $it =~ /^<!--(?:(?!-->).)*-->/;
 366             if ($kind == TmplTokenType::COMMENT && $it =~ /^<!--\s*#include/s) {
 367                 warn_normal "Apache #include directive found instead of HTML::Template <TMPL_INCLUDE> directive", $this->line_number_start;
 368             }
 369         } elsif ($it =~ /^<\?/) {
 370             $kind = TmplTokenType::PI;
 371         }
 372         if ($it =~ /^$re_directive/ios && !$this->cdata_mode_p) {
 373             $kind = TmplTokenType::DIRECTIVE;
 374         }
 375         if (!$ok_p && $eof_p) {
 376             ($kind, $it) = (TmplTokenType::UNKNOWN, $this->_peek_readahead);
 377             $this->_set_readahead, undef;
 378             $this->_set_syntaxerror( 1 );
 379         }
 380     }
 381     warn_normal "Unrecognizable token found: "
 382             . (split(/\n/, $it) < 10? $it: '(too confused to show details)')
 383             . "\n", $this->line_number_start
 384         if $kind == TmplTokenType::UNKNOWN;
 385     return defined $it? (ref $it? $it: TmplToken->new($it, $kind, $this->line_number, $this->filename)): undef;
 386 }
 387
 388 sub _next_token_intermediate {
 389     my $this = shift;
 390     my $h = $this->_handle;
 391     my $it;
 392     if (!$this->cdata_mode_p) {
 393         $it = $this->_next_token_internal($h);
 394         if (defined $it && $it->type == TmplTokenType::TAG) {
 395             if ($it->string =~ /^<(script|style|textarea)\b/i) {
 396                 $this->_set_cdata_mode( 1 );
 397                 $this->_set_cdata_close( "</$1\\s*>" );
 398             }
 399             $it->set_attributes( $this->_extract_attributes($it->string, $it->line_number) );
 400         }
 401     } else {
 402         for ($it = '', my $cdata_close = $this->cdata_close;;) {
 403             my $next = $this->_next_token_internal($h);
 404         last if !defined $next;
 405             if (defined $next && $next->string =~ /$cdata_close/i) {
 406                 $this->_push_readahead( $next ); # push entire TmplToken object
 407                 $this->_set_cdata_mode( 0 );
 408             }
 409         last unless $this->cdata_mode_p;
 410             $it .= $next->string;
 411         }
 412         $it = TmplToken->new( $it, TmplTokenType::CDATA, $this->line_number );
 413         $this->_set_cdata_close, undef;
 414     }
 415     return $it;
 416 }
 417
 418 sub _token_groupable_p ($) { # groupable into a TEXT_PARAMETRIZED token
 419     my($t) = @_;
 420     return $t->type == TmplTokenType::TEXT
 421         || ($t->type == TmplTokenType::DIRECTIVE
 422                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
 423         || ($t->type == TmplTokenType::TAG
 424                 && ($t->string =~ /^<\/?(?:b|em|h[123456]|i|u)\b/is
 425                 || ($t->string =~ /^<input/i
 426                     && $t->attributes->{'type'} =~ /^(?:text)$/i)))
 427 }
 428
 429 sub _quote_cformat ($) {
 430     my($s) = @_;
 431     $s =~ s/%/%%/g;
 432     return $s;
 433 }
 434
 435 sub _formalize ($) {
 436     my($t) = @_;
 437     return $t->type == TmplTokenType::DIRECTIVE? '%s': _quote_cformat($t->string);
 438 }
 439
 440 sub next_token {
 441     my $this = shift;
 442     my $h = $this->_handle;
 443     my $it;
 444     $this->{_queue} = [] unless defined $this->{_queue};
 445     if (@{$this->{_queue}}) {
 446         $it = pop @{$this->{_queue}};
 447     } else {
 448         $it = $this->_next_token_intermediate($h);
 449         if ($this->allow_cformat_p && defined $it
 450             && ($it->type == TmplTokenType::TEXT?
 451                 !blank_p( $it->string ): _token_groupable_p( $it ))) {
 452             my @structure = ( $it );
 453             my($n_trailing_spaces, $next) = (0, undef);
 454             my($nonblank_text_p, $parametrized_p, $next) = (0, 0);
 455             if ($it->type == TmplTokenType::TEXT) {
 456                 $nonblank_text_p = 1 if !blank_p( $it->string );
 457             } elsif ($it->type == TmplTokenType::DIRECTIVE) {
 458                 $parametrized_p = 1;
 459             }
 460             for (my $i = 1, $n_trailing_spaces = 0;; $i += 1) {
 461                 $next = $this->_next_token_intermediate($h);
 462                 push @structure, $next; # for consistency (with initialization)
 463             last unless defined $next && _token_groupable_p( $next );
 464                 if ($next->type == TmplTokenType::TEXT) {
 465                     if (blank_p( $next->string )) {
 466                         $n_trailing_spaces += 1;
 467                     } else {
 468                         ($n_trailing_spaces, $nonblank_text_p) = (0, 1);
 469                     }
 470                 } elsif ($next->type == TmplTokenType::DIRECTIVE) {
 471                     $n_trailing_spaces = 0;
 472                     $parametrized_p = 1;
 473                 } else {
 474                     $n_trailing_spaces = 0;
 475                 }
 476             }
 477             # Undo the last token
 478             push @{$this->{_queue}}, pop @structure;
 479             # Undo trailing blank tokens
 480             for (my $i = 0; $i < $n_trailing_spaces; $i += 1) {
 481                 push @{$this->{_queue}}, pop @structure;
 482             }
 483             if (@structure < 2) {
 484                 # Nothing to do
 485                 ;
 486             } elsif ($nonblank_text_p && $parametrized_p) {
 487                 # Create the corresponding c-format string
 488                 my $string = join('', map { $_->string } @structure);
 489                 my $form = join('', map { _formalize $_ } @structure);
 490                 $it = TmplToken->new($string, TmplTokenType::TEXT_PARAMETRIZED, $it->line_number, $it->pathname);
 491                 $it->set_form( $form );
 492                 $it->set_children( @structure );
 493             } elsif ($nonblank_text_p && $structure[0]->type == TmplTokenType::TEXT && $structure[$#structure]->type == TmplTokenType::TEXT) {
 494                 # Combine the strings
 495                 my $string = join('', map { $_->string } @structure);
 496                 $it = TmplToken->new($string, TmplTokenType::TEXT, $it->line_number, $it->pathname);;
 497             } else {
 498                 # Requeue the tokens thus seen for re-emitting
 499                 for (;;) {
 500                     push @{$this->{_queue}}, pop @structure;
 501                 last if !@structure;
 502                 }
 503                 $it = pop @{$this->{_queue}};
 504             }
 505         }
 506     }
 507     return $it;
 508 }
 509
 510 ###############################################################################
 511
 512 # Other simple functions (These are not methods)
 513
 514 sub blank_p ($) {
 515     my($s) = @_;
 516     return $s =~ /^(?:\s|\&nbsp$re_end_entity|$re_tmpl_var)*$/os;
 517 }
 518
 519 sub trim ($) {
 520     my($s0) = @_;
 521     my $l0 = length $s0;
 522     my $s = $s0;
 523     $s =~ s/^(\s|\&nbsp$re_end_entity)+//os; my $l1 = $l0 - length $s;
 524     $s =~ s/(\s|\&nbsp$re_end_entity)+$//os; my $l2 = $l0 - $l1 - length $s;
 525     return wantarray? (substr($s0, 0, $l1), $s, substr($s0, $l0 - $l2)): $s;
 526 }
 527
 528 sub quote_po ($) {
 529     my($s) = @_;
 530     # Locale::PO->quote is buggy, it doesn't quote newlines :-/
 531     $s =~ s/([\\"])/\\\1/gs;
 532     $s =~ s/\n/\\n/g;
 533     $s =~ s/[\177-\377]/ sprintf("\\%03o", ord($&)) /egs;
 534     return "\"$s\"";
 535 }
 536
 537 # Complication function that shouldn't be here
 538 sub parametrize ($@) {
 539     my($fmt, @params) = @_;
 540     my $it = '';
 541     for (my $n = 0; length $fmt;) {
 542         if ($fmt =~ /^[^%]+/) {
 543             $fmt = $';
 544             $it .= $&;
 545         } elsif ($fmt =~ /^%%/) {
 546             $fmt = $';
 547             $it .= '%';
 548         } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?s/) {
 549             $n += 1;
 550             my($i, $width, $prec) = ((defined $1? $1: $n), $2, $3);
 551             $fmt = $';
 552             if (!defined $width && !defined $prec) {
 553                 $it .= $params[$i]
 554             } elsif (defined $width && defined $prec && !$width && !$prec) {
 555                 ;
 556             } else {
 557                 die "Unsupported precision specification in format: $&\n"; #XXX
 558             }
 559         } elsif ($fmt =~ /^%[^%a-zA-Z]*[a-zA-Z]/) {
 560             $fmt = $';
 561             $it .= $&;
 562             die "Unknown or unsupported format specification: $&\n"; #XXX
 563         } else {
 564             die "Completely confused parametrizing: $fmt\n";#XXX
 565         }
 566     }
 567     return $it;
 568 }
 569
 570 ###############################################################################
 571
 572 =pod
 573
 574 In addition to the basic scanning, this class will also perform
 575 the following:
 576
 577 =over
 578
 579 =item -
 580
 581 Emulation of c-format strings (see below)
 582
 583 =item -
 584
 585 Display of warnings for certain things that affects either the
 586 ability of this class to yield correct output, or things that
 587 are known to cause the original template to cause trouble.
 588
 589 =item -
 590
 591 Automatic correction of some of the things warned about
 592 (e.g., SGML "closed start tag" notation).
 593
 594 =back
 595
 596 =head2 c-format strings emulation
 597
 598 Because English word order is not universal, a simple extraction
 599 of translatable strings may yield some strings like "Accounts for"
 600 or ambiguous strings like "in". This makes the resulting strings
 601 difficult to translate, but does not affect all languages alike.
 602 For example, Chinese (with a somewhat different word order) would
 603 be hit harder, but French would be relatively unaffected.
 604
 605 To overcome this problem, the scanner can be configured to detect
 606 patterns with <TMPL_VAR> directives (as well as certain HTML tags),
 607 and try to construct a larger pattern that will appear in the PO
 608 file as c-format strings with %s placeholders. This additional
 609 step allows the translator to deal with cases where word order
 610 is different (replacing %s with %1$s, %2$s, etc.), or when certain
 611 words will require certain inflectional suffixes in sentences.
 612
 613 Because this is an incompatible change, this mode must be explicitly
 614 turned on using the set_cformat(1) method call.
 615
 616 =head1 HISTORY
 617
 618 This tokenizer is mostly based
 619 on Ambrose's hideous Perl script known as subst.pl.
 620
 621 =cut
 622
 623 1;