7 use VerboseWarnings qw( pedantic_p error_normal warn_normal warn_pedantic );
10 ###############################################################################
14 TmplTokenizer.pm - Simple-minded wrapper class for TTParser
18 A wrapper for the functionality found in TTParser to allow an easier transition to Template Toolkit
22 ###############################################################################
25 use vars qw( $pedantic_attribute_error_in_nonpedantic_mode_p );
26 use vars qw( $pedantic_tmpl_var_use_in_nonpedantic_mode_p );
27 use vars qw( $pedantic_error_markup_in_pcdata_p );
29 ###############################################################################
32 use vars qw( $re_xsl $re_end_entity $re_tmpl_var);
34 $re_tmpl_var = q{\[%\s*[get|set|default]?\s*[\w\.]+\s*[|.*?]?\s*%\]};
35 $re_xsl = q{<\/?(?:xsl:)(?:[\s\-a-zA-Z0-9"'\/\.\[\]\@\(\):=,$]+)\/?>};
36 $re_end_entity = '(?:;|$|(?=\s))'; # semicolon or before-whitespace
38 # End of the hideous stuff
40 use vars qw( $serial );
42 ###############################################################################
44 sub FATAL_P () {'fatal-p'}
45 sub SYNTAXERROR_P () {'syntaxerror-p'}
47 sub FILENAME () {'input'}
48 #sub HANDLE () {'handle'}
50 #sub READAHEAD () {'readahead'}
51 sub LINENUM_START () {'lc_0'}
53 sub CDATA_MODE_P () {'cdata-mode-p'}
54 sub CDATA_CLOSE () {'cdata-close'}
55 #sub PCDATA_MODE_P () {'pcdata-mode-p'} # additional submode for CDATA
56 sub JS_MODE_P () {'js-mode-p'} # cdata-mode-p must also be true
58 sub ALLOW_CFORMAT_P () {'allow-cformat-p'}
63 #open my $handle,$filename or die "can't open $filename";
64 my $parser = C4::TTParser->new;
65 $parser->build_tokens( $filename );
67 filename => $filename,
74 ###############################################################################
80 return $this->{filename};
85 return $this->{+FATAL_P};
88 # work around, currently not implemented
91 # return $this->{+SYNTAXERROR_P};
97 return $this->{+JS_MODE_P};
100 sub allow_cformat_p {
102 return $this->{+ALLOW_CFORMAT_P};
109 $this->{+FATAL_P} = $_[0];
115 $this->{+JS_MODE_P} = $_[0];
119 #used in xgettext, tmpl_process3
120 sub set_allow_cformat {
122 $this->{+ALLOW_CFORMAT_P} = $_[0];
126 ###############################################################################
128 use vars qw( $js_EscapeSequence );
130 # Perl quoting is really screwed up, but this common subexp is way too long
131 $js_EscapeSequence = q{\\\\(?:['"\\\\bfnrt]|[^0-7xu]|[0-3]?[0-7]{1,2}|x[\da-fA-F]{2}|u[\da-fA-F]{4})};
133 sub parenleft () { '(' }
134 sub parenright () { ')' }
140 if ($s0 =~ /^\s+/s) { # whitespace
143 } elsif ($s0 =~ /^\/\/[^\r\n]*(?:[\r\n]|$)/s) { # C++-style comment
146 } elsif ($s0 =~ /^\/\*(?:(?!\*\/).)*\*\//s) { # C-style comment
149 # Keyword or identifier, ECMA-262 p.13 (section 7.5)
150 } elsif ($s0 =~ /^[A-Z_\$][A-Z\d_\$]*/is) { # IdentifierName
153 # Punctuator, ECMA-262 p.13 (section 7.6)
154 } elsif ($s0 =~ /^(?:[\(\){}\[\];]|>>>=|<<=|>>=|[-\+\*\/\&\|\^\%]=|>>>|<<|>>|--|\+\+|\|\||\&\&|==|<=|>=|!=|[=><,!~\?:\.\-\+\*\/\&\|\^\%])/s) {
157 # DecimalLiteral, ECMA-262 p.14 (section 7.7.3); note: bug in the spec
158 } elsif ($s0 =~ /^(?:0|[1-9]\d+(?:\.\d*(?:[eE][-\+]?\d+)?)?)/s) {
161 # HexIntegerLiteral, ECMA-262 p.15 (section 7.7.3)
162 } elsif ($s0 =~ /^0[xX][\da-fA-F]+/s) {
165 # OctalIntegerLiteral, ECMA-262 p.15 (section 7.7.3)
166 } elsif ($s0 =~ /^0[\da-fA-F]+/s) {
169 # StringLiteral, ECMA-262 p.17 (section 7.7.4)
170 # XXX SourceCharacter doesn't seem to be defined (?)
171 } elsif ($s0 =~ /^(?:"(?:(?!["\\\r\n]).|$js_EscapeSequence)*"|'(?:(?!['\\\r\n]).|$js_EscapeSequence)*')/os) {
174 } elsif ($s0 =~ /^./) { # UNKNOWN TOKEN !!!
182 sub STATE_UNDERSCORE () { 1 }
183 sub STATE_PARENLEFT () { 2 }
184 sub STATE_STRING_LITERAL () { 3 }
186 # XXX This is a crazy hack. I don't want to write an ECMAScript parser.
187 # XXX A scanner is one thing; a parser another thing.
188 sub _identify_js_translatables {
191 # We mark a JavaScript translatable string as in C, i.e., _("literal")
192 # For simplicity, we ONLY look for "_" "(" StringLiteral ")"
193 for (my $i = 0, my $state = 0, my($j, $q, $s); $i <= $#input; $i += 1) {
195 my $reset_state_p = 0;
196 push @output, [0, $input[$i]];
197 if ($input[$i] !~ /\S/s) {
199 } elsif ($state == 0) {
200 $state = STATE_UNDERSCORE if $input[$i] eq '_';
201 } elsif ($state == STATE_UNDERSCORE) {
202 $state = $input[$i] eq parenleft ? STATE_PARENLEFT : 0;
203 } elsif ($state == STATE_PARENLEFT) {
204 if ($input[$i] =~ /^(['"])(.*)\1$/s) {
205 ($state, $j, $q, $s) = (STATE_STRING_LITERAL, $#output, $1, $2);
209 } elsif ($state == STATE_STRING_LITERAL) {
210 if ($input[$i] eq parenright) {
211 $output[$j] = [1, $output[$j]->[1], $q, $s];
215 die "identify_js_translatables internal error: Unknown state $state"
219 # warn Dumper \@output;
223 ###############################################################################
227 # Fold all whitespace into single blanks
233 # safer version used internally, preserves new lines
234 sub string_canon_safe {
236 # fold tabs and spaces into single spaces
237 $s =~ s/[\ \t]+/ /gs;
248 sub _formalize_string_cformat{
250 return _quote_cformat( string_canon_safe($s) );
255 if( $t->type == C4::TmplTokenType::DIRECTIVE ){
257 } elsif( $t->type == C4::TmplTokenType::TEXT ){
258 return _formalize_string_cformat( $t->string );
259 } elsif( $t->type == C4::TmplTokenType::TAG ){
260 if( $t->string =~ m/^a\b/is ){
262 } elsif( $t->string =~ m/^input\b/is ){
263 if( lc $t->attributes->{'type'}->[1] eq 'text' ){
269 return _quote_cformat $t->string;
272 return _quote_cformat $t->string;
276 # internal parametization, used within next_token
277 # method that takes in an array of TEXT and DIRECTIVE tokens (DIRECTIVEs must be GET) and return a C4::TmplTokenType::TEXT_PARAMETRIZED
278 sub _parametrize_internal{
282 # for my $item (@parts){
283 # if( $item->type == C4::TmplTokenType::TEXT ){
284 # $s .= $item->string;
286 # #must be a variable directive
290 my $s = join( "", map { _formalize $_ } @parts );
291 # should both the string and form be $s? maybe only the later? posibly the former....
292 # used line number from first token, should suffice
293 my $t = C4::TmplToken->new( $s, C4::TmplTokenType::TEXT_PARAMETRIZED, $parts[0]->line_number, $this->filename );
294 $t->set_children(@parts);
302 # warn "in next_token";
303 # parts that make up a text_parametrized (future children of the token)
306 $next = $self->{_parser}->next_token;
309 return $self->_parametrize_internal(@parts);
315 # if cformat mode is off, dont bother parametrizing, just return them as they come
316 return $next unless $self->allow_cformat_p;
317 if( $next->type == C4::TmplTokenType::TEXT ){
320 # elsif( $next->type == C4::TmplTokenType::DIRECTIVE && $next->string =~ m/\[%\s*\w+\s*%\]/ ){
321 elsif( $next->type == C4::TmplTokenType::DIRECTIVE ){
324 elsif ( $next->type == C4::TmplTokenType::CDATA){
325 $self->_set_js_mode(1);
326 my $s0 = $next->string;
330 if ($s0 =~ /^(\s*\[%\s*)(.*)(\s%=]\s*)$/s) {
335 push @head, _split_js($s0);
336 $next->set_js_data(_identify_js_translatables(@head, @tail) );
337 return $next unless @parts;
338 $self->{_parser}->unshift_token($next);
339 return $self->_parametrize_internal(@parts);
342 # if there is nothing in parts, return this token
343 return $next unless @parts;
345 # OTHERWISE, put this token back and return the parametrized string of @parts
346 $self->{_parser}->unshift_token($next);
347 return $self->_parametrize_internal(@parts);
353 ###############################################################################
355 # function taken from old version
356 # used by tmpl_process3
358 my($fmt_0, $cformat_p, $t, $f) = @_;
361 my @params = $t->parameters_and_fields;
362 for (my $n = 0, my $fmt = $fmt_0; length $fmt;) {
363 if ($fmt =~ /^[^%]+/) {
366 } elsif ($fmt =~ /^%%/) {
369 } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?s/s) {
371 my($i, $width, $prec) = ((defined $1? $1: $n), $2, $3);
373 if (defined $width && defined $prec && !$width && !$prec) {
375 } elsif (defined $params[$i - 1]) {
376 my $param = $params[$i - 1];
377 warn_normal("$fmt_0: $&: Expected a TMPL_VAR, but found a "
378 . $param->type->to_string . "\n", undef)
379 if $param->type != C4::TmplTokenType::DIRECTIVE;
380 warn_normal("$fmt_0: $&: Unsupported "
381 . "field width or precision\n", undef)
382 if defined $width || defined $prec;
383 warn_normal("$fmt_0: $&: Parameter $i not known", undef)
384 unless defined $param;
385 $it .= defined $f? &$f( $param ): $param->string;
387 } elsif ($fmt =~ /^%(?:(\d+)\$)?(?:(\d+)(?:\.(\d+))?)?([pS])/s) {
389 my($i, $width, $prec, $conv) = ((defined $1? $1: $n), $2, $3, $4);
392 my $param = $params[$i - 1];
393 if (!defined $param) {
394 warn_normal("$fmt_0: $&: Parameter $i not known", undef);
396 if ($param->type == C4::TmplTokenType::TAG
397 && $param->string =~ /^<input\b/is) {
398 my $type = defined $param->attributes?
399 lc($param->attributes->{'type'}->[1]): undef;
401 warn_normal("$fmt_0: $&: Expected type=text, "
402 . "but found type=$type", undef)
403 unless $type eq 'text';
404 } elsif ($conv eq 'p') {
405 warn_normal("$fmt_0: $&: Expected type=radio, "
406 . "but found type=$type", undef)
407 unless $type eq 'radio';
410 warn_normal("$&: Expected an INPUT, but found a "
411 . $param->type->to_string . "\n", undef)
413 warn_normal("$fmt_0: $&: Unsupported "
414 . "field width or precision\n", undef)
415 if defined $width || defined $prec;
416 $it .= defined $f? &$f( $param ): $param->string;
418 } elsif ($fmt =~ /^%[^%a-zA-Z]*[a-zA-Z]/) {
421 die "$&: Unknown or unsupported format specification\n"; #XXX
423 die "$&: Completely confused parametrizing -- msgid: $fmt_0\n";#XXX
427 my @anchors = $t->anchors;
428 for (my $n = 0, my $fmt = $it, $it = ''; length $fmt;) {
429 if ($fmt =~ /^(?:(?!<a\d+>).)+/is) {
432 } elsif ($fmt =~ /^<a(\d+)>/is) {
436 my $anchor = $anchors[$i - 1];
437 warn_normal("$&: Anchor $1 not found for msgid \"$fmt_0\"", undef) #FIXME
438 unless defined $anchor;
439 $it .= $anchor->string;
441 die "Completely confused decoding anchors: $fmt\n";#XXX
448 # Other simple functions (These are not methods)
452 return $s =~ /^(?:\s|\ $re_end_entity|$re_tmpl_var|$re_xsl)*$/osi;
459 $s =~ s/^(\s|\ $re_end_entity)+//os; my $l1 = $l0 - length $s;
460 $s =~ s/(\s|\ $re_end_entity)+$//os; my $l2 = $l0 - $l1 - length $s;
461 return wantarray? (substr($s0, 0, $l1), $s, substr($s0, $l0 - $l2)): $s;
466 $charset = uc($charset);
467 $charset = "$1-$2" if $charset =~ /^(ISO|UTF)(\d.*)/i;
468 $charset = 'Big5' if $charset eq 'BIG5'; # "Big5" must be in mixed case
472 use vars qw( @latin1_utf8 );
474 "\302\200", "\302\201", "\302\202", "\302\203", "\302\204", "\302\205",
475 "\302\206", "\302\207", "\302\210", "\302\211", "\302\212", "\302\213",
476 "\302\214", "\302\215", undef, undef, "\302\220", "\302\221",
477 "\302\222", "\302\223", "\302\224", "\302\225", "\302\226", "\302\227",
478 "\302\230", "\302\231", "\302\232", "\302\233", "\302\234", "\302\235",
479 "\302\236", "\302\237", "\302\240", "\302\241", "\302\242", "\302\243",
480 "\302\244", "\302\245", "\302\246", "\302\247", "\302\250", "\302\251",
481 "\302\252", "\302\253", "\302\254", "\302\255", "\302\256", "\302\257",
482 "\302\260", "\302\261", "\302\262", "\302\263", "\302\264", "\302\265",
483 "\302\266", "\302\267", "\302\270", "\302\271", "\302\272", "\302\273",
484 "\302\274", "\302\275", "\302\276", "\302\277", "\303\200", "\303\201",
485 "\303\202", "\303\203", "\303\204", "\303\205", "\303\206", "\303\207",
486 "\303\210", "\303\211", "\303\212", "\303\213", "\303\214", "\303\215",
487 "\303\216", "\303\217", "\303\220", "\303\221", "\303\222", "\303\223",
488 "\303\224", "\303\225", "\303\226", "\303\227", "\303\230", "\303\231",
489 "\303\232", "\303\233", "\303\234", "\303\235", "\303\236", "\303\237",
490 "\303\240", "\303\241", "\303\242", "\303\243", "\303\244", "\303\245",
491 "\303\246", "\303\247", "\303\250", "\303\251", "\303\252", "\303\253",
492 "\303\254", "\303\255", "\303\256", "\303\257", "\303\260", "\303\261",
493 "\303\262", "\303\263", "\303\264", "\303\265", "\303\266", "\303\267",
494 "\303\270", "\303\271", "\303\272", "\303\273", "\303\274", "\303\275",
495 "\303\276", "\303\277" );
497 sub charset_convert {
498 my($s, $charset_in, $charset_out) = @_;
499 if ($s !~ /[\200-\377]/s) { # FIXME: don't worry about iso2022 for now
501 } elsif ($charset_in eq 'ISO-8859-1' && $charset_out eq 'UTF-8') {
502 $s =~ s/[\200-\377]/ $latin1_utf8[ord($&) - 128] /egs;
503 } elsif ($charset_in ne $charset_out) {
504 VerboseWarnings::warn_normal "conversion from $charset_in to $charset_out is not supported\n", undef;
509 ###############################################################################
513 In addition to the basic scanning, this class will also perform
520 Emulation of c-format strings (see below)
524 Display of warnings for certain things that affects either the
525 ability of this class to yield correct output, or things that
526 are known to cause the original template to cause trouble.
530 Automatic correction of some of the things warned about
531 (e.g., SGML "closed start tag" notation).
535 =head2 c-format strings emulation
537 Because English word order is not universal, a simple extraction
538 of translatable strings may yield some strings like "Accounts for"
539 or ambiguous strings like "in". This makes the resulting strings
540 difficult to translate, but does not affect all languages alike.
541 For example, Chinese (with a somewhat different word order) would
542 be hit harder, but French would be relatively unaffected.
544 To overcome this problem, the scanner can be configured to detect
545 patterns with <TMPL_VAR> directives (as well as certain HTML tags),
546 and try to construct a larger pattern that will appear in the PO
547 file as c-format strings with %s placeholders. This additional
548 step allows the translator to deal with cases where word order
549 is different (replacing %s with %1$s, %2$s, etc.), or when certain
550 words will require certain inflectional suffixes in sentences.
552 Because this is an incompatible change, this mode must be explicitly
553 turned on using the set_allow_cformat(1) method call.
555 =head2 The flag characters
557 The character % is followed by zero or more of the following flags:
563 The value comes from HTML <INPUT> elements.
564 This abuse of the flag character is somewhat reasonable,
565 since TMPL_VAR and INPUT are both variables, but of different kinds.
569 =head2 The field width and precision
571 An optional 0.0 can be specified for %s to specify
572 that the <TMPL_VAR> should be suppressed.
574 =head2 The conversion specifier
580 Specifies any input field that is neither text nor hidden
581 (which currently mean radio buttons).
582 The p conversion specifier is chosen because this does not
583 evoke any certain sensible data type.
587 Specifies a text input field (<INPUT TYPE=TEXT>).
588 This use of the S conversion specifier is somewhat reasonable,
589 since text input fields contain values of undeterminable type,
590 which can be treated as strings.
594 Specifies a <TMPL_VAR>.
595 This use of the o conversion specifier is somewhat reasonable,
596 since <TMPL_VAR> denotes values of undeterminable type, which
597 can be treated as strings.
603 There is no code to save the tag name anywhere in the scanned token.
605 The use of <AI<i>> to stand for the I<i>th anchor
606 is not very well thought out.
607 Some abuse of c-format specifies might have been more appropriate.
611 This tokenizer is mostly based
612 on Ambrose's hideous Perl script known as subst.pl.