Improve the message split script to allow alternate output formats

1 files changed, 217 insertions, 14 deletions

diff --git a/utils/split-messages.pl b/utils/split-messages.pl
index 2bbe79a43..08d882210 100755..100644
--- a/utils/split-messages.pl
+++ b/utils/split-messages.pl
@@ -1,23 +1,226 @@
-#!/usr/bin/perl -w
+#!/usr/bin/perl
+#
+# Copyright 2013 Vivek Dasmohapatra <vivek@collabora.co.uk>
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+#   * The above copyright notice and this permission notice shall be included in
+#     all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+=head1
+
+Filter the NetSurf combined messages (i10n) file according to language
+and platform and generate output in a selection of formats for use
+both internally within netsurf and externally for translation
+services.
+
+=cut
 
 use strict;
 
-die "usage: split-messages <langname> <platname> < FatMessages > ThinMessages" if ($#ARGV != 1);
+use Getopt::Long ();
+use Fcntl qw( O_CREAT O_EXCL O_WRONLY O_APPEND O_RDONLY O_WRONLY );
+
+use constant GETOPT_OPTS => qw( auto_abbrev no_getopt_compat bundling );
+use constant GETOPT_SPEC =>
+  qw( output|o=s
+      input|i=s
+      lang|l=s
+      plat|platform|p=s
+      format|fmt|f=s
+      help|h|? );
+
+# default option values:
+my %opt = qw( plat any format messages );
+
+sub input_stream  ();
+sub output_stream ();
+sub formatter     ();
+sub header        ();
+sub usage         ();
+
+sub main ()
+{
+    my $input;
+    my $output;
+    my $format;
+    my $header;
+    my $opt_ok;
+
+    # option parsing:
+    Getopt::Long::Configure( GETOPT_OPTS );
+    $opt_ok = Getopt::Long::GetOptions( \%opt, GETOPT_SPEC );
+
+    # allow input and output to be specified as non-option arguments:
+    if( @ARGV ) { $opt{input } ||= shift( @ARGV ) }
+    if( @ARGV ) { $opt{output} ||= shift( @ARGV ) }
+
+    # open the appropriate streams and get the formatter and headers:
+    if( $opt_ok )
+    {
+        $input  = input_stream();
+        $output = output_stream();
+        $format = formatter();
+        $header = header();
+    }
+
+    # double check the options are sane (and we weren't asked for the help)
+    if( !$opt_ok || $opt{help} || $opt{lang} !~ /^[a-z]{2}$/ )
+    {
+        usage();
+    }
+
+    # we are good to go:
+    print( $output $header );
+
+    while (<$input>)
+    {
+        /^#/    && next;
+        /^\s*$/ && next;
+        # only parsing thinsg that look like message lines:
+        if( /^([a-z]{2}).([^.]+).([^:]+):(.*)/ )
+        {
+            my( $lang, $plat, $key, $val ) = ( $1, $2, $3, $4 );
+
+            if( $lang ne $opt{lang} ) { next };
+            if( $opt{plat} eq 'any' ||
+                $opt{plat} eq $plat ||
+                'all'      eq $plat )
+            {
+                print( $output $format->( $key, $val ), "\n" );
+            }
+        }
+        else
+        {
+            warn( "Malformed entry: $_" );
+        }
+    }
+}
+
+main();
+
+sub usage ()
+{
+    my @fmt = map { s/::$//; $_ } keys(%{$::{'msgfmt::'}});
+    print(STDERR <<TXT );
+usage:
+     $0 -l lang-code \
+           [-o output-file] [-i input-file] [-p platform] [-f format]
+
+     $0 -l lang-code ... [input-file [output-file]]
+
+     lang-code  : en fr ko ...  (no default)
+     platform   : any gtk ami   (default 'any')
+     format     : @fmt (default 'messages')
+     input-file : defaults to standard input
+     output-file: defaults to standard output
+TXT
+    exit(1);
+}
+
+sub input_stream ()
+{
+    if( $opt{input} )
+    {
+        my $ifh;
+
+        sysopen( $ifh, $opt{input}, O_RDONLY ) ||
+          die( "$0: Failed to open input file $opt{input}: $!\n" );
+
+        return $ifh;
+    }
+
+    return \*STDIN;
+}
+
+sub output_stream ()
+{
+    if( $opt{output} )
+    {
+        my $ofh;
+
+        sysopen( $ofh, $opt{output}, O_CREAT|O_EXCL|O_APPEND|O_WRONLY ) ||
+          die( "$0: Failed to open output file $opt{output}: $!\n" );
+
+        return $ofh;
+    }
 
-my $langname = $ARGV[0];
-my $platname = $ARGV[1];
+    return \*STDOUT;
+}
+
+sub formatter ()
+{
+    my $name = $opt{format};
+    my $func = "msgfmt::$name"->UNIVERSAL::can("format");
+
+    return $func || die( "No handler found for format '$name'\n" );
+}
+
+sub header ()
+{
+    my $name = $opt{format};
+    my $func = "msgfmt::$name"->UNIVERSAL::can("header");
 
-my $allprefix = $langname . ".all.";
-my $platprefix = $langname . "." . $platname . ".";
+    return $func ? $func->() : "";
+}
 
-print "# This messages file is automatically generated from FatMessages\n";
-print "# at build-time.  Please go and edit that instead of this.\n\n";
+# format implementations:
+{
+    package msgfmt::java;
 
-foreach (<STDIN>) {
-    if (not /^#/ and not /^\s*$/) {
-	if (/^$allprefix/ or /^$platprefix/) {
-	    s/^$langname\.(all|$platname)\.//;
-	    print "$_";
-	}
+    # escape characters spec says ' should be escaped here but
+    # transifex does not recognise it. hence [\\:] and not [\\:']
+    sub escape { $_[0] =~ s/([\\:])/\\$1/g; $_[0] }
+    sub format { return join(' = ', $_[0], escape( $_[1] ) ) }
+    sub header { "# autogenerated from " . ($opt{input} || '-stdin-') . "\n" }
+}
+
+{
+    package msgfmt::messages;
+
+    sub format { return join( ":", @_ ) }
+    sub header
+    {
+        my $in = $opt{input} || '-stdin-';
+        return <<TXT;
+# This messages file is automatically generated from $in
+# at build-time.  Please go and edit that instead of this.\n
+TXT
     }
 }
+
+########### YAML ###########
+#{
+#    package msgfmt::yaml;
+#    use YAML qw(Dump Bless);
+#    print Dump %data;
+#}
+
+######## android properties ########
+#{
+#    package msgfmt::android;
+#    use HTML::Entities;
+#    print "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<resources>\n";
+#    foreach my $lang (sort keys %data) {
+#	foreach my $plat (sort keys %{$data{$lang}}) {
+#	    foreach my $key (sort keys %{$data{$lang}{$plat}}) {
+#		my $val = $data{$lang}{$plat}{$key};
+#		print "<string name=\"$key\">" . encode_entities($val, '<>&"') . "</string>\n";
+#	    }		
+#	}
+#   }
+#  print "</resources>";
+#}