- string replaced with UTF8String (although it's just a typedef) to mark UTF8 strings.

- misc. unicode compatibility fixes

git-svn-id: svn://svn.code.sf.net/p/ultrastardx/svn/branches/experimental@1509 b956fd51-792f-4845-bead-9b4dfca2ff2c

1 files changed, 102 insertions, 74 deletions

diff --git a/unicode/src/base/ULanguage.pas b/unicode/src/base/ULanguage.pas
index 31840f5f..a89ded2d 100644
--- a/unicode/src/base/ULanguage.pas
+++ b/unicode/src/base/ULanguage.pas
@@ -35,31 +35,36 @@ interface
 
 type
   TLanguageEntry = record
-    ID:     string;
-    Text:   string;
+    ID:     AnsiString;  //**< identifier (ASCII)
+    Text:   UTF8String;  //**< translation (UTF-8)
   end;
 
   TLanguageList = record
-    Name:     string;
-    {FileName: string; }
+    Name:     AnsiString;  //**< language name (ASCII)
   end;
 
+  TLanguageEntryArray = array of TLanguageEntry;
+
   TLanguage = class
-    public
-      Entry:  array of TLanguageEntry; //Entrys of Chosen Language
-      SEntry: array of TLanguageEntry; //Entrys of Standard Language
-      CEntry: array of TLanguageEntry; //Constant Entrys e.g. Version
-      Implode_Glue1, Implode_Glue2: String;
-    public
+    private
       List:   array of TLanguageList;
 
-      constructor Create;
+      Entry:  TLanguageEntryArray; //**< Entrys of Chosen Language
+      SEntry: TLanguageEntryArray; //**< Entrys of Standard Language
+      CEntry: TLanguageEntryArray; //**< Constant Entrys e.g. Version
+
+      Implode_Glue1, Implode_Glue2: UTF8String;
+
       procedure LoadList;
-      function Translate(Text: String): String;
-      procedure ChangeLanguage(Language: String);
-      procedure AddConst(ID, Text: String);
-      procedure ChangeConst(ID, Text: String);
-      function Implode(Pieces: Array of String): String;
+      function FindID(const ID: AnsiString; const EntryList: TLanguageEntryArray): integer;
+
+    public
+      constructor Create;
+      function Translate(const Text: UTF8String): UTF8String;
+      procedure ChangeLanguage(const Language: AnsiString);
+      procedure AddConst(const ID: AnsiString; const Text: UTF8String);
+      procedure ChangeConst(const ID: AnsiString; const Text: UTF8String);
+      function Implode(const Pieces: array of UTF8String): UTF8String;
   end;
 
 var
@@ -69,19 +74,15 @@ implementation
 
 uses
   UMain,
-  // UFiles,
   UIni,
   IniFiles,
   Classes,
   SysUtils,
-  {$IFDEF win32}
-    windows,
-  {$ENDIF}
   ULog;
 
-//----------
-//Create - Construct Class then LoadList + Standard Language + Set Standard Implode Glues
-//----------
+{**
+ * LoadList, set default language, set standard implode glues
+ *}
 constructor TLanguage.Create;
 var
   I, J: Integer;
@@ -107,7 +108,7 @@ begin
       ChangeLanguage('English');
 
       SetLength(SEntry, Length(Entry));
-      for J := low(Entry) to high(Entry) do
+      for J := 0 to high(Entry) do
         SEntry[J] := Entry[J];
 
       SetLength(Entry, 0);
@@ -122,9 +123,9 @@ begin
   
 end;
 
-//----------
-//LoadList - Parse the Language Dir searching Translations
-//----------
+{**
+ * Parse the Language Dir searching Translations
+ *}
 procedure TLanguage.LoadList;
 var
   SR:     TSearchRec;   // for parsing directory
@@ -132,7 +133,8 @@ begin
   SetLength(List, 0);
   SetLength(ILanguage, 0);
 
-  if FindFirst(LanguagesPath + '*.ini', 0, SR) = 0 then begin
+  if FindFirst(LanguagesPath + '*.ini', 0, SR) = 0 then
+  begin
     repeat
       SetLength(List, Length(List)+1);
       SetLength(ILanguage, Length(ILanguage)+1);
@@ -140,16 +142,15 @@ begin
 
       List[High(List)].Name := SR.Name;
       ILanguage[High(ILanguage)] := SR.Name;
-
-    until FindNext(SR) <> 0;
-  SysUtils.FindClose(SR);
+    until (FindNext(SR) <> 0);
+    SysUtils.FindClose(SR);
   end; // if FindFirst
 end;
 
-//----------
-//ChangeLanguage - Load the specified LanguageFile
-//----------
-procedure TLanguage.ChangeLanguage(Language: String);
+{**
+ * Load the specified LanguageFile
+ *}
+procedure TLanguage.ChangeLanguage(const Language: AnsiString);
 var
   IniFile:    TIniFile;
   E:          integer; // entry
@@ -176,57 +177,84 @@ begin
   IniFile.Free;
 end;
 
-//----------
-//Translate - Translate the Text
-//----------
-Function TLanguage.Translate(Text: String): String;
+{**
+ * Find the index of ID an array of language entries.
+ * @returns the index on success, -1 otherwise.
+ *}
+function TLanguage.FindID(const ID: AnsiString; const EntryList: TLanguageEntryArray): integer;
 var
-  E:    integer; // entry
+  Index: integer;
 begin
+  for Index := 0 to High(EntryList) do
+  begin
+    if ID = EntryList[Index].ID then
+    begin
+      Result := Index;
+      Exit;
+    end;
+  end;
+  Result := -1;
+end;
+
+{**
+ * Translate the Text.
+ * If Text is an ID, text will be translated according to the current language
+ * setting. If Text is not a known ID, it will be returned as is. 
+ * @param Text either an ID or an UTF-8 encoded string 
+ *}
+function TLanguage.Translate(const Text: UTF8String): UTF8String;
+var
+  E:  integer; // entry
+  ID: AnsiString;
+  EntryIndex: integer;
+begin
+  // fallback result in case Text is not a known ID
   Result := Text;
-  Text := Uppercase(Result);
+
+  // normalize ID case
+  ID := UpperCase(Text);
+
+  // Check if ID exists
 
   //Const Mod
-  for E := 0 to high(CEntry) do
-    if Text = CEntry[E].ID then
-    begin
-     Result := CEntry[E].Text;
-     exit;
-    end;
-  //Const Mod End
+  EntryIndex := FindID(ID, CEntry);
+  if (EntryIndex >= 0) then
+  begin
+    Result := CEntry[EntryIndex].Text;
+    Exit;
+  end;
 
-  for E := 0 to high(Entry) do
-    if Text = Entry[E].ID then
-    begin
-     Result := Entry[E].Text;
-     exit;
-    end;
+  EntryIndex := FindID(ID, Entry);
+  if (EntryIndex >= 0) then
+  begin
+    Result := Entry[EntryIndex].Text;
+    Exit;
+  end;
 
   //Standard Language (If a Language File is Incomplete)
   //Then use Standard Language
-    for E := low(SEntry) to high(SEntry) do
-      if Text = SEntry[E].ID then
-      begin
-        Result := SEntry[E].Text;
-        Break;
-      end;
-  //Standard Language END
+  EntryIndex := FindID(ID, SEntry);
+  if (EntryIndex >= 0) then
+  begin
+    Result := SEntry[EntryIndex].Text;
+    Exit;
+  end;
 end;
 
-//----------
-//AddConst - Add a Constant ID that will be Translated but not Loaded from the LanguageFile
-//----------
-procedure TLanguage.AddConst (ID, Text: String);
+{**
+ * Add a Constant ID that will be Translated but not Loaded from the LanguageFile
+ *}
+procedure TLanguage.AddConst(const ID: AnsiString; const Text: UTF8String);
 begin
   SetLength (CEntry, Length(CEntry) + 1);
   CEntry[high(CEntry)].ID := ID;
   CEntry[high(CEntry)].Text := Text;
 end;
 
-//----------
-//ChangeConst - Change a Constant Value by ID
-//----------
-procedure TLanguage.ChangeConst(ID, Text: String);
+{**
+ * Change a Constant Value by ID
+ *}
+procedure TLanguage.ChangeConst(const ID: AnsiString; const Text: UTF8String);
 var
   I: Integer;
 begin
@@ -240,16 +268,16 @@ begin
   end;
 end;
 
-//----------
-//Implode - Connect an Array of Strings with ' and ' or ', ' to one String
-//----------
-function TLanguage.Implode(Pieces: Array of String): String;
+{**
+ * Connect an array of strings with ' and ' or ', ' to one string
+ *}
+function TLanguage.Implode(const Pieces: array of UTF8String): UTF8String;
 var
   I: Integer;
 begin
   Result := '';
   //Go through Pieces
-  for I := low(Pieces) to high(Pieces) do
+  for I := 0 to high(Pieces) do
   begin
     //Add Value
     Result := Result + Pieces[I];