Changeset 6945 for trunk/gsdl/perllib/gsprintf.pm

Timestamp:

2004-03-07T15:18:16+13:00 (20 years ago)

Author:

mdewsnip

Message:

Updated the resource bundle handling code some more. Strings are first looked for in a language specific resource bundle (if specified). If not found there, the default resource bundle is checked. If still not found, the English resource bundle is checked. These resource bundles are loaded on an as-needed basis.

File:

• trunk/gsdl/perllib/gsprintf.pm (modified) (3 diffs)

trunk/gsdl/perllib/gsprintf.pm

@@ -32 +32 @@
 
 
-my $loadedlanguage = "<none>";
-my %loadedresourcebundle = ();
-my $outputencoding;
+# Language-specific resource bundle
+my %specialresourcebundle = ();
+my $specialoutputencoding;
+
+# Default resource bundle
+my %defaultresourcebundle;
+my $defaultoutputencoding;
+
+# English resource bundle
+my %englishresourcebundle;
+my $englishoutputencoding;
+
+# Ignore the OutputEncoding strings in the resource bundles and output all text in UTF-8
+my $outputstringsinUTF8 = 0;
 
 
@@ -56 +67 @@
     my ($stringkey) = @_;
 
-    # Load the default resource bundle if one isn't already loaded
-    if ($loadedlanguage eq "<none>") {
-    &load_resource_bundle("");
-    }
-
-    # Return just the key if there is no string matching the key
-    return $stringkey if (!defined($loadedresourcebundle{$stringkey}));
-
-    # Otherwise return the string matching the key
-    my $utf8_string = $loadedresourcebundle{$stringkey};
-    return $utf8_string if (!defined($outputencoding) || $outputencoding eq "UTF-8");
+    # Try the language-specific resource bundle first
+    my $utf8string = $specialresourcebundle{$stringkey};
+    my $outputencoding = $specialoutputencoding;
+
+    # Try the default resource bundle next
+    if (!defined($utf8string)) {
+    # Load the default resource bundle if it is not already loaded
+    &load_default_resource_bundle() if (!%defaultresourcebundle);
+
+    $utf8string = $defaultresourcebundle{$stringkey};
+    $outputencoding = $defaultoutputencoding;
+    }
+
+    # Try the English resource bundle last
+    if (!defined($utf8string)) {
+    # Load the English resource bundle if it is not already loaded
+    &load_english_resource_bundle() if (!%englishresourcebundle);
+
+    $utf8string = $englishresourcebundle{$stringkey};
+    $outputencoding = $englishoutputencoding;
+    }
+
+    # No matching string was found, so just return the key
+    if (!defined($utf8string)) {
+    return $stringkey;
+    }
+
+    # Return the string matching the key
+    return $utf8string if (!defined($outputencoding) || $outputstringsinUTF8);
 
     # If an 8-bit output encoding has been defined, encode the string appropriately
-    return &unicode::unicode2singlebyte(&unicode::utf82unicode($utf8_string), $outputencoding);
-}
-
-
-sub load_resource_bundle
+    return &unicode::unicode2singlebyte(&unicode::utf82unicode($utf8string), $outputencoding);
+}
+
+
+sub load_language_specific_resource_bundle
 {
     my $language = shift(@_);
 
-    # If the desired resource bundle is the one already loaded, no action is necessary
-    if ($language eq $loadedlanguage) {
-    return;
-    }
-
-    # Open the appropriate resource bundle
+    # Read the specified resource bundle
     my $resourcebundlehome = &util::filename_cat("$ENV{'GSDLHOME'}", "perllib");
     my $resourcebundlename = "strings_" . $language . ".rb";
     my $resourcebundlefile = &util::filename_cat($resourcebundlehome, $resourcebundlename);
 
-    # If the specific resource bundle cannot be opened, use the generic (English) one
-    if (!open(RESOURCE_BUNDLE, "<$resourcebundlefile")) {
-    $resourcebundlename = "strings.rb";
-    $resourcebundlefile = &util::filename_cat($resourcebundlehome, $resourcebundlename);
-    open(RESOURCE_BUNDLE, "<$resourcebundlefile")
-        or die "Error: Could not open generic resource bundle $resourcebundlefile.\n";
-    }
-
+    %specialresourcebundle = &read_resource_bundle($resourcebundlefile);
+    return if (!%specialresourcebundle);
+
+    # Read the output encoding to use from the resource bundle
+    if ($ENV{'GSDLOS'} =~ /windows/) {
+    $specialoutputencoding = $specialresourcebundle{"{OutputEncoding.windows}"};
+    }
+    else {
+    $specialoutputencoding = $specialresourcebundle{"{OutputEncoding.unix}"};
+    }
+}
+
+
+sub load_default_resource_bundle
+{
+    # Read the default resource bundle
+    my $resourcebundlehome = &util::filename_cat("$ENV{'GSDLHOME'}", "perllib");
+    my $resourcebundlename = "strings.rb";
+    my $resourcebundlefile = &util::filename_cat($resourcebundlehome, $resourcebundlename);
+
+    %defaultresourcebundle = &read_resource_bundle($resourcebundlefile);
+    return if (!%defaultresourcebundle);
+
+    # Read the output encoding to use from the resource bundle
+    if ($ENV{'GSDLOS'} =~ /windows/) {
+    $defaultoutputencoding = $defaultresourcebundle{"{OutputEncoding.windows}"};
+    }
+    else {
+    $defaultoutputencoding = $defaultresourcebundle{"{OutputEncoding.unix}"};
+    }
+}
+
+
+sub load_english_resource_bundle
+{
+    # Ensure the English resource bundle hasn't already been loaded
+    if ($specialresourcebundle{"{Language.code}"} eq "en") {
+    $englishresourcebundle = $specialresourcebundle;
+    $englishoutputencoding = $specialoutputencoding;
+    }
+    if ($defaultresourcebundle{"{Language.code}"} eq "en") {
+    $englishresourcebundle = $defaultresourcebundle;
+    $englishoutputencoding = $defaultoutputencoding;
+    }
+
+    # Read the English resource bundle
+    my $resourcebundlehome = &util::filename_cat("$ENV{'GSDLHOME'}", "perllib");
+    my $resourcebundlename = "strings_en.rb";
+    my $resourcebundlefile = &util::filename_cat($resourcebundlehome, $resourcebundlename);
+
+    %englishresourcebundle = &read_resource_bundle($resourcebundlefile);
+    return if (!%englishresourcebundle);
+
+    # Read the output encoding to use from the resource bundle
+    if ($ENV{'GSDLOS'} =~ /windows/) {
+    $englishoutputencoding = $englishresourcebundle{"{OutputEncoding.windows}"};
+    }
+    else {
+    $englishoutputencoding = $englishresourcebundle{"{OutputEncoding.unix}"};
+    }
+}
+
+
+sub read_resource_bundle
+{
+    my ($resourcebundlefilepath) = shift(@_);
+
+    # Return an empty hash if the specified resource bundle could not be read
+    return () if (!open(RESOURCE_BUNDLE, "<$resourcebundlefilepath"));
+
+    # Load this resource bundle
     my @resourcebundlelines = <RESOURCE_BUNDLE>;
     close(RESOURCE_BUNDLE);
 
-    # Load this resource bundle
-    $loadedlanguage = $language;
-    %loadedresourcebundle = ();
+    # Parse the resource bundle
+    my %resourcebundle = ();
     foreach $line (@resourcebundlelines) {
     # Remove any trailing whitespace
@@ -113 +199 @@
 
         # Map key to text
-        $loadedresourcebundle{$linekey} = $linetext;
+        $resourcebundle{$linekey} = $linetext;
     }
     }
 
-    # Read the output encoding to use from the resource bundle
-    if ($ENV{'GSDLOS'} =~ /windows/) {
-    $outputencoding = $loadedresourcebundle{"{OutputEncoding.windows}"};
-    }
-    else {
-    $outputencoding = $loadedresourcebundle{"{OutputEncoding.unix}"};
-    }
-}
-
-
-sub get_output_encoding
-{
-    return $outputencoding;
-}
-
-
-sub set_output_encoding
-{
-    $outputencoding = shift(@_);
+    return %resourcebundle;
+}
+
+
+sub output_strings_in_UTF8
+{
+    $outputstringsinUTF8 = 1;
 }