3 # Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 # Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 # Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 # Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 # Copyright (C) 2006 - 2008 by Daniel Stenberg
13 # See apps/language.c (TODO: Use common include for both)
14 # Cookie and binary version for the binary lang file
15 my $LANGUAGE_COOKIE = 0x1a;
16 my $LANGUAGE_VERSION = 0x06;
17 my $LANGUAGE_FLAG_RTL = 0x01;
20 my $SUBHEADER_SIZE = 6;
22 # A note for future users and readers: The original v1 language system allowed
23 # the build to create and use a different language than english built-in. We
24 # removed that feature from our build-system, but the build scripts still had
25 # the ability. But, starting now, this ability is no longer provided since I
26 # figured it was boring and unnecessary to write support for now since we
27 # don't use it anymore.
32 Usage: genlang [options] <langv2 file>
35 Make the tool create a [prefix].c and [prefix].h file.
38 Make the tool create a binary language (.lng) file named [outfile].
39 The use of this option requires that you also use -e, -t and -i.
42 Update language file. Given the translated file and the most recent english
43 file, you\'ll get an updated version sent to stdout. Suitable action to do
44 when you intend to update a translation.
46 -e=<english lang file>
47 Point out the english (original source) file, to use that as master
48 language template. Used in combination with -b, -u or -s.
51 Sort the Update language file in the same order as the strings in the
55 Specify which target you want the translations/phrases for. Required when
58 The target can in fact be specified as numerous different strings,
59 separated with colons. This will make genlang to use all the specified
60 strings when searching for a matching phrase.
63 The target id number, needed for -b.
66 Voice mode output. Outputs all id: and voice: lines for the given target!
69 Enables verbose (debug) output.
77 # 1) scan the english file, keep the whole <phrase> for each phrase.
78 # 2) read the translated file, for each end of phrase, compare:
79 # A) all source strings, if there's any change there should be a comment about
83 # 3) output the phrase with the comments from above
84 # 4) check which phrases that the translated version didn't have, and spit out
85 # the english version of those
96 my $check = ($binary?
1:0) + ($prefix?
1:0) + ($update?
1:0) + ($voiceout?
1:0) + ($sortfile?
1:0);
99 print STDERR
"Please use only one of -p, -u, -o, -b and -s\n";
103 print STDERR
"Please use at least one of -p, -u, -o, -b and -s\n";
108 if(($binary || $update || $voiceout || $sortfile) && !$english) {
109 print STDERR
"Please use -e too when you use -b, -o, -u or -s\n";
114 if($binary && !$target_id) {
115 print STDERR
"Please specify a target id number (with -i)!\n";
120 if(!$target && !$update && !$sortfile) {
121 print STDERR
"Please specify a target (with -t)!\n";
126 my %id; # string to num hash
127 my @idnum; # num to string array
129 my %allphrases; # For sorting - an array of the <phrase> elements
130 my %source; # id string to source phrase hash
131 my %dest; # id string to dest phrase hash
132 my %voice; # id string to voice phrase hash
137 my $input = $ARGV[0];
150 my ($string, $pattern)=@_;
152 $pattern =~ s/\*/.*/g;
153 $pattern =~ s/\?/./g;
155 return ($string =~ /^$pattern\z/);
164 my ($full, $n, $v)=@_;
170 my ($full, $n, $v)=@_;
176 my ($full, $n, $v)=@_;
181 my ($debug, $strref, $full, $n, $v)=@_;
183 my @all= split(" *, *", $n);
186 # print "TEST ($debug) $target for $test\n";
187 for my $part (split(":", $target)) {
188 if(match
($part, $test)) {
190 # print "MATCH: $test => $v\n";
200 parsetarget
("src", \
$src, @_);
205 parsetarget
("dest", \
$dest, @_);
210 parsetarget
("voice", \
$voice, @_);
216 # For the cases where the english file needs to be scanned/read, we do
217 # it before we read the translated file. For -b it isn't necessary, but for
218 # -u it is convenient.
220 my @idnum = ((0)); # start with a true number
221 my @vidnum = ((0x8000)); # first voice id
222 open(ENG
, "<$english") || die "Error: can't open $english";
229 my $numusers = 1; # core is already in the users map
233 # get rid of DOS newlines
236 if($_ =~ /^ *\<phrase\>/) {
237 # this is the start of a phrase
239 elsif($_ =~ /^ *\<\/phrase\
>/) {
241 # if id is something, when we count and store this phrase
243 # voice-only entries get a difference range
244 if($id =~ /^VOICE_/) {
245 # Assign an ID number to this entry
246 $idmap[$user]{$id}=$vidnum[$user];
250 # Assign an ID number to this entry
251 $idmap[$user]{$id}=$idnum[$user];
253 # print STDERR "DEST: bumped idnum to $idnum[$user]\n";
256 # this is the end of a phrase, add it to the english hash
257 $english{$id}=join("", @phrase);
263 # gather everything related to this phrase
265 if($_ =~ /^ *\<dest\>/i) {
269 elsif($withindest && ($_ =~ /^ *\<\/dest\
>/i
)) {
272 if($update || ($deststr && ($deststr !~ /^none\z/i))) {
273 # we unconditionally always use all IDs when the "update"
276 # print "DEST: use this id $id\n";
279 # print "skip $maybeid for $name\n";
282 elsif($withindest && ($_ =~ / *([^:]+): *(.*)/)) {
283 my ($name, $val)=($1, $2);
284 $dest=""; # in case it is left untouched for when the
285 # model name isn't "our"
286 dest
($_, $name, $val);
289 # Store the current dest string. If this target matches
290 # multiple strings, it will get updated several times.
296 if($_ =~ /^ *id: ([^ \t\n]+)/i) {
298 $sortorder{$maybeid}=$numphrases++;
300 if($_ =~ /^ *user: ([^ \t\n]+)/i) {
302 if(!(defined $user)) {
311 # a function that compares the english phrase with the translated one.
312 # compare source strings and desc
314 # Then output the updated version!
316 my ($idstr, $engref, $locref)=@_;
318 my ($esource, $lsource);
321 for my $l (@
$engref) {
326 if($l =~ /^ *desc: (.*)/) {
329 elsif($l =~ / *\<source\>/i) {
333 if($l =~ / *\<\/source\
>/i
) {
344 for my $l (@
$locref) {
345 if($l =~ /^ *desc: (.*)/) {
347 if(trim
($edesc) ne trim
($ldesc)) {
348 $l = "### The 'desc' field differs from the english!\n### the previously used desc is commented below:\n### desc: $ldesc\n desc: $edesc\n";
352 elsif($l =~ / *\<source\>/i) {
357 if($l =~ / *\<\/source\
>/i
) {
360 if(trim
($esource) ne trim
($lsource)) {
361 print "### The <source> section differs from the english!\n",
362 "### the previously used one is commented below:\n";
363 for(split("\n", $lsource)) {
371 undef @show; # start over
388 my @idcount; # counter for lang ID numbers
389 my @voiceid; # counter for voice-only ID numbers
393 push @voiceid, 0x8000;
397 # Now start the scanning of the selected language string
400 open(LANG
, "<$input") || die "Error: couldn't read language file named $input\n";
409 # get rid of DOS newlines
412 if($_ =~ /^( *\#|[ \t\n\r]*\z)/) {
413 # comment or empty line - output it if it's part of the header
414 if ($header and ($update || $sortfile)) {
427 # this is an XML-lookalike tag
428 if (/^(<|[^\"<]+<)([^>]*)>/) {
430 # print "P: $part\n";
433 # this was a closing tag
435 if($part eq "/phrase") {
438 my $idstr = $phrase{'id'};
441 if($binary && !$english{$idstr}) {
442 # $idstr doesn't exist for english, skip it\n";
444 elsif($dest =~ /^none\z/i) {
445 # "none" as dest (without quotes) means that this entire
446 # phrase is to be ignored
449 $allphrases{$idstr}=join('',@phrase);
452 # we don't do the fully detailed analysis when we "update"
453 # since we don't do it for a particular target etc
455 # allow the keyword 'deprecated' to be used on dest and
456 # voice strings to mark that as deprecated. It will then
457 # be replaced with "".
459 $dest =~ s/^deprecate(|d)\z/\"\"/i;
460 $voice =~ s/^deprecate(|d)\z/\"\"/i;
462 # basic syntax error alerts, if there are no quotes we
463 # will assume an empty string was intended
465 print STDERR
"$input:$line:1: warning: dest before line lacks quotes ($dest)!\n";
469 print STDERR
"$input:$line:1: warning: source before line lacks quotes ($src)!\n";
472 if($voice !~ /^\"/ and $voice !~ /^none\z/i) {
473 print STDERR
"$input:$line:1: warning: voice before line lacks quotes ($voice)!\n";
476 if($dest eq '""' && $phrase{'desc'} !~ /deprecated/i && $idstr !~ /^VOICE/) {
477 print STDERR
"$input:$line:1: warning: empty dest before line in non-deprecated phrase!\n";
480 my $userstr = trim
($phrase{'user'});
481 my $user = $users{$userstr};
482 if ($userstr eq "") {
483 print STDERR
"$input:$line:1: warning: missing user!\n";
484 $user = $users{"core"};
486 elsif(!(defined $user)) {
488 print STDERR
"$input:$line:1: warning: user was not found in $english!\n";
489 $user = keys %users; # set to an invalid user so it won't be added
492 # we found a new user, add it to the usermap
494 $users{$userstr} = $user;
498 # Use the ID name to figure out which id number range we
499 # should use for this phrase. Voice-only strings are
502 if($idstr =~ /^VOICE/) {
503 $idnum = $voiceid[$user]++;
506 $idnum = $idcount[$user]++;
509 $id{$idstr} = $idnum;
510 $idnum[$user][$idnum]=$idstr;
512 $source{$idstr}=$src;
514 $voice{$idstr}=$voice;
517 print "id: $phrase{id} ($idnum)\n";
518 print "source: $src\n";
519 print "dest: $dest\n";
520 print "voice: $voice\n";
521 print "user: $user\n";
532 my $e = $english{$idstr};
535 # compare original english with this!
536 my @eng = split("\n", $english{$idstr});
538 compare
($idstr, \
@eng, \
@phrase);
540 $english{$idstr}=""; # clear it
543 print "### $idstr: The phrase is not used. Skipped\n";
547 elsif($part eq "/options") {
548 # closing the options
549 if ($options{'rtl'}) {
550 $langoptions |= $LANGUAGE_FLAG_RTL;
552 } # end of </options>
556 # starts with a slash, this _ends_ this section
557 $m = pop @m; # get back old value, the previous level's tag
561 # This is an opening (sub) tag
563 push @m, $m; # store old value
568 if(/^ *([^:]+): *(.*)/) {
569 my ($name, $val)=($1, $2);
570 &$m($_, $name, $val);
580 "### This phrase below was not present in the translated file\n",
589 for(sort { $sortorder{$a} <=> $sortorder{$b} } keys %allphrases) {
590 print $allphrases{$_};
595 # We create a .c and .h file
597 open(HFILE_CORE
, ">$prefix/lang.h") ||
598 die "Error: couldn't create file $prefix/lang.h\n";
599 open(CFILE_CORE
, ">$prefix/lang_core.c") ||
600 die "Error: couldn't create file $prefix/lang_core.c\n";
602 # get header file name
603 $headername = "$prefix/lang.h";
604 $headername =~ s/(.*\/)*//;
606 print HFILE_CORE
<<MOO
607 /* This file was automatically generated using genlang */
609 * The str() macro/functions is how to access strings that might be
610 * translated. Use it like str(MACRO) and expect a string to be
613 #define str(x) language_strings[x]
615 /* this is the array for holding the string pointers.
616 It will be initialized at runtime. */
617 extern unsigned char *language_strings[];
618 /* this contains the concatenation of all strings, separated by \\0 chars */
619 extern const unsigned char core_language_builtin[];
621 /* The enum below contains all available strings */
626 print CFILE_CORE
<<MOO
627 /* This file was automatically generated using genlang, the strings come
630 #include "$headername"
632 unsigned char *language_strings[LANG_LAST_INDEX_IN_ARRAY];
633 const unsigned char core_language_builtin[] =
637 # Output the ID names for the enum in the header file
639 for $i (0 .. $idcount[$users{"core"}]-1) {
640 my $name=$idnum[$users{"core"}][$i]; # get the ID name
642 $name =~ s/\"//g; # cut off the quotes
644 printf HFILE_CORE
(" %s, /* %d */\n", $name, $i);
647 # Output separation marker for last string ID and the upcoming voice IDs
649 print HFILE_CORE
<<MOO
650 LANG_LAST_INDEX_IN_ARRAY, /* this is not a string, this is a marker */
651 /* --- below this follows voice-only strings --- */
652 VOICEONLY_DELIMITER = 0x8000,
656 # Output the ID names for the enum in the header file
657 for $i (0x8000 .. ($voiceid[$users{"core"}]-1)) {
658 my $name=$idnum[$users{"core"}][$i]; # get the ID name
660 $name =~ s/\"//g; # cut off the quotes
662 printf HFILE_CORE
(" %s,\n", $name);
666 print HFILE_CORE
"\n};\n/* end of generated enum list */\n";
668 # Output the target phrases for the source file
669 for $i (0 .. $idcount[$users{"core"}]-1) {
670 my $name=$idnum[$users{"core"}][$i]; # get the ID
671 my $dest = $dest{$name}; # get the destination phrase
673 $dest =~ s
:\"$:\\0\":; # insert a \0 before the second quote
676 # this is just to be on the safe side
680 printf CFILE_CORE
(" %s\n", $dest);
683 # Output end of string chunk
684 print CFILE_CORE
<<MOO
686 /* end of generated string list */
692 } # end of the c/h file generation
694 # Creation of a binary lang file was requested
696 # We must first scan the english file to get the correct order of the id
697 # numbers used there, as that is what sets the id order for all language
698 # files. The english file is scanned before the translated file was
701 open(OUTF
, ">$binary") or die "Error: Can't create $binary";
703 printf OUTF
("%c%c%c%c", $LANGUAGE_COOKIE, $LANGUAGE_VERSION, $target_id,
704 $langoptions); # magic lang file header
706 # output the number of strings for each user
707 my $foffset = $HEADER_SIZE + $SUBHEADER_SIZE * keys(%users);
710 for $n (0 .. $idcount[$_]-1) {
711 $size += length(trim
($dest{$idnum[$_][$n]})) + 1;
713 printf OUTF
("%c%c%c%c%c%c", ($idcount[$_] >> 8), ($idcount[$_] & 0xff),
714 ($size >> 8), ($size & 0xff), ($foffset >> 8), ($foffset & 0xff));
719 # loop over the target phrases
720 for $n (0 .. $idcount[$_]-1) {
721 my $name=$idnum[$_][$n]; # get the ID
722 my $dest = $dest{$name}; # get the destination phrase
725 $dest =~ s/^\"(.*)\"\s*$/$1/g; # cut off quotes
727 # Now, make sure we get the number from the english sort order:
728 $idnum = $idmap[$_]{$name};
730 printf OUTF
("%c%c%s\x00", ($idnum>>8), ($idnum&0xff), $dest);
736 # voice output requested, display id: and voice: strings in a v1-like
741 # This loops over the strings in the translated language file order
742 my @ids = ((0 .. ($idcount[$users{"core"}]-1)));
743 push @ids, (0x8000 .. ($voiceid[$users{"core"}]-1));
750 my $name=$idnum[$users{"core"}][$i]; # get the ID
751 my $dest = $voice{$name}; # get the destination voice string
754 $dest =~ s/^\"(.*)\"\s*$/$1/g; # cut off quotes
756 # Now, make sure we get the number from the english sort order:
757 $idnum = $idmap[$users{"core"}]{$name};
762 #print "Input index $i output index $idnum\n";
765 # not used, mark it so
775 if(($o < 0) || !length($o)) {
776 print "#$i\nid: NOT_USED_$i\nvoice: \"\"\n";
780 my $name=$idnum[$users{"core"}][$o]; # get the ID
781 my $dest = $voice{$name}; # get the destination voice string
783 print "#$i ($o)\nid: $name\nvoice: $dest\n";
793 $num_str += $idcount[$_];
796 printf("%d ID strings scanned\n", $num_str);
800 printf "$_: %s\n", $head{$_};