Fixed bug where a <textarea...>#cdata</textarea> on one line won't be
[koha.git] / 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                 my $next = $this->_pop_readahead;
326                 if ($next =~ /^$cdata_close/) {
327                     ($kind, $it) = (TmplTokenType::TAG, $&);
328                     $this->_push_readahead( $' );
329                     $ok_p = 1;
330                 } elsif ($next =~ /^((?:(?!$cdata_close).)+)($cdata_close)/) {
331                     ($kind, $it) = (TmplTokenType::TEXT, $1);
332                     $this->_push_readahead( "$2$'" );
333                     $ok_p = 1;
334                 } else {
335                     ($kind, $it) = (TmplTokenType::TEXT, $next);
336                     $ok_p = 1;
337                 }
338             } elsif ($this->_peek_readahead =~ /^$re_tag_compat/os) {
339                 # If we detect a "closed start tag" but we know that the
340                 # following token looks like a TMPL_VAR, don't stop
341                 my($head, $tail, $post) = ($1, $2, $3);
342                 if ($tail eq '' && $post =~ $re_tmpl_var) {
343                     # Don't bother to show the warning if we're too confused
344                     warn_normal "Possible SGML \"closed start tag\" notation: $head<\n", $this->line_number
345                             if split(/\n/, $head) < 10;
346                 } else {
347                     ($kind, $it) = (TmplTokenType::TAG, "$head>");
348                     $this->_set_readahead( $post );
349                     $ok_p = 1;
350                     warn_normal "SGML \"closed start tag\" notation: $head<\n", $this->line_number if $tail eq '';
351                 }
352             } elsif ($this->_peek_readahead =~ /^<!--(?:(?!-->).)*-->/s) {
353                 ($kind, $it) = (TmplTokenType::COMMENT, $&);
354                 $this->_set_readahead( $' );
355                 $ok_p = 1;
356                 warn_normal "Syntax error in comment: $&\n", $this->line_number_start;
357                 $this->_set_syntaxerror( 1 );
358             }
359         last if $ok_p;
360             my $next = scalar <$h>;
361             $eof_p = !defined $next;
362         last if $eof_p;
363             $this->_increment_line_number;
364             $this->_append_readahead( $next );
365         }
366         if ($kind ne TmplTokenType::TAG) {
367             ;
368         } elsif ($it =~ /^<!/) {
369             $kind = TmplTokenType::DECL;
370             $kind = TmplTokenType::COMMENT if $it =~ /^<!--(?:(?!-->).)*-->/;
371             if ($kind == TmplTokenType::COMMENT && $it =~ /^<!--\s*#include/s) {
372                 warn_normal "Apache #include directive found instead of HTML::Template <TMPL_INCLUDE> directive", $this->line_number_start;
373             }
374         } elsif ($it =~ /^<\?/) {
375             $kind = TmplTokenType::PI;
376         }
377         if ($it =~ /^$re_directive/ios && !$this->cdata_mode_p) {
378             $kind = TmplTokenType::DIRECTIVE;
379         }
380         if (!$ok_p && $eof_p) {
381             ($kind, $it) = (TmplTokenType::UNKNOWN, $this->_peek_readahead);
382             $this->_set_readahead, undef;
383             $this->_set_syntaxerror( 1 );
384         }
385     }
386     warn_normal "Unrecognizable token found: "
387             . (split(/\n/, $it) < 10? $it: '(too confused to show details)')
388             . "\n", $this->line_number_start
389         if $kind == TmplTokenType::UNKNOWN;
390     return defined $it? (ref $it? $it: TmplToken->new($it, $kind, $this->line_number, $this->filename)): undef;
391 }
392
393 sub _next_token_intermediate {
394     my $this = shift;
395     my $h = $this->_handle;
396     my $it;
397     if (!$this->cdata_mode_p) {
398         $it = $this->_next_token_internal($h);
399         if (defined $it && $it->type == TmplTokenType::TAG) {
400             if ($it->string =~ /^<(script|style|textarea)\b/i) {
401                 $this->_set_cdata_mode( 1 );
402                 $this->_set_cdata_close( "</$1\\s*>" );
403             }
404             $it->set_attributes( $this->_extract_attributes($it->string, $it->line_number) );
405         }
406     } else {
407         for ($it = '', my $cdata_close = $this->cdata_close;;) {
408             my $next = $this->_next_token_internal($h);
409         last if !defined $next;
410             if (defined $next && $next->string =~ /$cdata_close/i) {
411                 $this->_push_readahead( $next ); # push entire TmplToken object
412                 $this->_set_cdata_mode( 0 );
413             }
414         last unless $this->cdata_mode_p;
415             $it .= $next->string;
416         }
417         $it = TmplToken->new( $it, TmplTokenType::CDATA, $this->line_number );
418         $this->_set_cdata_close, undef;
419     }
420     return $it;
421 }
422
423 sub _token_groupable_p ($) { # groupable into a TEXT_PARAMETRIZED token
424     my($t) = @_;
425     return $t->type == TmplTokenType::TEXT
426         || ($t->type == TmplTokenType::DIRECTIVE
427                 && $t->string =~ /^(?:$re_tmpl_var)$/os)
428         || ($t->type == TmplTokenType::TAG
429                 && ($t->string =~ /^<\/?(?:b|em|h[123456]|i|u)\b/is
430                 || ($t->string =~ /^<input/i
431                     && $t->attributes->{'type'} =~ /^(?:text)$/i)))
432 }
433
434 sub _quote_cformat ($) {
435     my($s) = @_;
436     $s =~ s/%/%%/g;
437     return $s;
438 }
439
440 sub _formalize ($) {
441     my($t) = @_;
442     return $t->type == TmplTokenType::DIRECTIVE? '%s': _quote_cformat($t->string);
443 }
444
445 sub next_token {
446     my $this = shift;
447     my $h = $this->_handle;
448     my $it;
449     $this->{_queue} = [] unless defined $this->{_queue};
450     if (@{$this->{_queue}}) {
451         $it = pop @{$this->{_queue}};
452     } else {
453         $it = $this->_next_token_intermediate($h);
454         if (!$this->cdata_mode_p && $this->allow_cformat_p && defined $it
455             && ($it->type == TmplTokenType::TEXT?
456                 !blank_p( $it->string ): _token_groupable_p( $it ))) {
457             my @structure = ( $it );
458             my($n_trailing_spaces, $next) = (0, undef);
459             my($nonblank_text_p, $parametrized_p, $next) = (0, 0);
460             if ($it->type == TmplTokenType::TEXT) {
461                 $nonblank_text_p = 1 if !blank_p( $it->string );
462             } elsif ($it->type == TmplTokenType::DIRECTIVE) {
463                 $parametrized_p = 1;
464             }
465             for (my $i = 1, $n_trailing_spaces = 0;; $i += 1) {
466                 $next = $this->_next_token_intermediate($h);
467                 push @structure, $next; # for consistency (with initialization)
468             last unless defined $next && _token_groupable_p( $next );
469                 if ($next->type == TmplTokenType::TEXT) {
470                     if (blank_p( $next->string )) {
471                         $n_trailing_spaces += 1;
472                     } else {
473                         ($n_trailing_spaces, $nonblank_text_p) = (0, 1);
474                     }
475                 } elsif ($next->type == TmplTokenType::DIRECTIVE) {
476                     $n_trailing_spaces = 0;
477                     $parametrized_p = 1;
478                 } else {
479                     $n_trailing_spaces = 0;
480                 }
481             }
482             # Undo the last token
483             push @{$this->{_queue}}, pop @structure;
484             # Undo trailing blank tokens
485             for (my $i = 0; $i < $n_trailing_spaces; $i += 1) {
486                 push @{$this->{_queue}}, pop @structure;
487             }
488             if (@structure < 2) {
489                 # Nothing to do
490                 ;
491             } elsif ($nonblank_text_p && $parametrized_p) {
492                 # Create the corresponding c-format string
493                 my $string = join('', map { $_->string } @structure);
494                 my $form = join('', map { _formalize $_ } @structure);
495                 $it = TmplToken->new($string, TmplTokenType::TEXT_PARAMETRIZED, $it->line_number, $it->pathname);
496                 $it->set_form( $form );
497                 $it->set_children( @structure );
498             } elsif ($nonblank_text_p && $structure[0]->type == TmplTokenType::TEXT && $structure[$#structure]->type == TmplTokenType::TEXT) {
499                 # Combine the strings
500                 my $string = join('', map { $_->string } @structure);
501                 $it = TmplToken->new($string, TmplTokenType::TEXT, $it->line_number, $it->pathname);;
502             } else {
503                 # Requeue the tokens thus seen for re-emitting
504                 for (;;) {
505                     push @{$this->{_queue}}, pop @structure;
506                 last if !@structure;
507                 }
508                 $it = pop @{$this->{_queue}};
509             }
510         }
511     }
512     return $it;
513 }
514
515 ###############################################################################
516
517 # Other simple functions (These are not methods)
518
519 sub blank_p ($) {
520     my($s) = @_;
521     return $s =~ /^(?:\s|\&nbsp$re_end_entity|$re_tmpl_var)*$/os;
522 }
523
524 sub trim ($) {
525     my($s0) = @_;
526     my $l0 = length $s0;
527     my $s = $s0;
528     $s =~ s/^(\s|\&nbsp$re_end_entity)+//os; my $l1 = $l0 - length $s;
529     $s =~ s/(\s|\&nbsp$re_end_entity)+$//os; my $l2 = $l0 - $l1 - length $s;
530     return wantarray? (substr($s0, 0, $l1), $s, substr($s0, $l0 - $l2)): $s;
531 }
532
533 sub quote_po ($) {
534     my($s) = @_;
535     # Locale::PO->quote is buggy, it doesn't quote newlines :-/
536     $s =~ s/([\\"])/\\\1/gs;
537     $s =~ s/\n/\\n/g;
538     $s =~ s/[\177-\377]/ sprintf("\\%03o", ord($&)) /egs;
539     return "\"$s\"";
540 }
541
542 # Complication function that shouldn't be here
543 sub parametrize ($@) {
544     my($fmt, @params) = @_;
545     my $it = '';
546     for (my $n = 0; length $fmt;) {
547         if ($fmt =~ /^[^%]+/) {
548             $fmt = $';
549             $it .= $&;
550         } elsif ($fmt =~ /^%%/) {
551             $fmt = $';
552             $it .= '%';
553         } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?s/) {
554             $n += 1;
555             my($i, $width, $prec) = ((defined $1? $1: $n), $2, $3);
556             $fmt = $';
557             if (!defined $width && !defined $prec) {
558                 $it .= $params[$i]
559             } elsif (defined $width && defined $prec && !$width && !$prec) {
560                 ;
561             } else {
562                 die "Unsupported precision specification in format: $&\n"; #XXX
563             }
564         } elsif ($fmt =~ /^%[^%a-zA-Z]*[a-zA-Z]/) {
565             $fmt = $';
566             $it .= $&;
567             die "Unknown or unsupported format specification: $&\n"; #XXX
568         } else {
569             die "Completely confused parametrizing: $fmt\n";#XXX
570         }
571     }
572     return $it;
573 }
574
575 ###############################################################################
576
577 =pod
578
579 In addition to the basic scanning, this class will also perform
580 the following:
581
582 =over
583
584 =item -
585
586 Emulation of c-format strings (see below)
587
588 =item -
589
590 Display of warnings for certain things that affects either the
591 ability of this class to yield correct output, or things that
592 are known to cause the original template to cause trouble.
593
594 =item -
595
596 Automatic correction of some of the things warned about
597 (e.g., SGML "closed start tag" notation).
598
599 =back
600
601 =head2 c-format strings emulation
602
603 Because English word order is not universal, a simple extraction
604 of translatable strings may yield some strings like "Accounts for"
605 or ambiguous strings like "in". This makes the resulting strings
606 difficult to translate, but does not affect all languages alike.
607 For example, Chinese (with a somewhat different word order) would
608 be hit harder, but French would be relatively unaffected.
609
610 To overcome this problem, the scanner can be configured to detect
611 patterns with <TMPL_VAR> directives (as well as certain HTML tags),
612 and try to construct a larger pattern that will appear in the PO
613 file as c-format strings with %s placeholders. This additional
614 step allows the translator to deal with cases where word order
615 is different (replacing %s with %1$s, %2$s, etc.), or when certain
616 words will require certain inflectional suffixes in sentences.
617
618 Because this is an incompatible change, this mode must be explicitly
619 turned on using the set_cformat(1) method call.
620
621 =head1 HISTORY
622
623 This tokenizer is mostly based
624 on Ambrose's hideous Perl script known as subst.pl.
625
626 =cut
627
628 1;