]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/UniClassObject.py
License header updated to match correct format.
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / UniClassObject.py
index 76a0549a751c8d574d297ae54637895c0571a406..58f865ed8bd4ce99e8e049e5789bcf3018741343 100644 (file)
@@ -1,4 +1,7 @@
-# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+## @file\r
+# This file is used to collect all defined strings in multiple uni files\r
+#\r
+# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
 # This program and the accompanying materials\r
 # are licensed and made available under the terms and conditions of the BSD License\r
 # which accompanies this distribution.  The full text of the license may be found at\r
 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-#\r
-#This file is used to collect all defined strings in multiple uni files\r
-#\r
-\r
 ##\r
 # Import Modules\r
 #\r
-import os, codecs, re\r
+import Common.LongFilePathOs as os, codecs, re\r
 import distutils.util\r
 import Common.EdkLogger as EdkLogger\r
 from Common.BuildToolError import *\r
 from Common.String import GetLineNo\r
 from Common.Misc import PathClass\r
-\r
+from Common.LongFilePathSupport import LongFilePath\r
 ##\r
 # Static definitions\r
 #\r
@@ -38,6 +37,9 @@ LF = u'\u000A'
 NULL = u'\u0000'\r
 TAB = u'\t'\r
 BACK_SPLASH = u'\\'\r
+DOBULE_QUOTED_SPLASH = u'\\"'\r
+SIGLE_QUOTED_SPLASH = u"\\'"\r
+TAB_BACK_SLASH = u"\\/"\r
 \r
 gIncludePattern = re.compile("^#include +[\"<]+([^\"< >]+)[>\"]+$", re.MULTILINE | re.UNICODE)\r
 \r
@@ -121,7 +123,7 @@ def GetLanguageCode(LangName, IsCompatibleMode, File):
         if length == 3 and LangName.isalpha():\r
             TempLangName = LangConvTable.get(LangName.lower())\r
             if TempLangName != None:\r
-               return TempLangName\r
+                return TempLangName\r
             return LangName\r
         else:\r
             EdkLogger.error("Unicode File Parser", FORMAT_INVALID, "Invalid ISO 639-2 language code : %s" % LangName, File)\r
@@ -193,6 +195,8 @@ class UniFileClassObject(object):
         self.Token = 2\r
         self.LanguageDef = []                   #[ [u'LanguageIdentifier', u'PrintableName'], ... ]\r
         self.OrderedStringList = {}             #{ u'LanguageIdentifier' : [StringDefClassObject]  }\r
+        self.OrderedStringDict = {}             #{ u'LanguageIdentifier' : {StringName:(IndexInList)}  }\r
+        self.OrderedStringListByToken = {}      #{ u'LanguageIdentifier' : {Token: StringDefClassObject} }\r
         self.IsCompatibleMode = IsCompatibleMode\r
         self.IncludePathList = IncludePathList\r
         if len(self.FileList) > 0:\r
@@ -205,7 +209,7 @@ class UniFileClassObject(object):
         Lang = distutils.util.split_quoted((Line.split(u"//")[0]))\r
         if len(Lang) != 3:\r
             try:\r
-                FileIn = codecs.open(File.Path, mode='rb', encoding='utf-16').read()\r
+                FileIn = codecs.open(LongFilePath(File.Path), mode='rb', encoding='utf-16').read()\r
             except UnicodeError, X:\r
                 EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File);\r
             except:\r
@@ -246,20 +250,19 @@ class UniFileClassObject(object):
                     else:\r
                         OtherLang = FirstLangName\r
                     self.OrderedStringList[LangName].append (StringDefClassObject(Item.StringName, '', Item.Referenced, Item.Token, OtherLang))\r
-\r
+                    self.OrderedStringDict[LangName][Item.StringName] = len(self.OrderedStringList[LangName]) - 1\r
         return True\r
 \r
     #\r
     # Get String name and value\r
     #\r
     def GetStringObject(self, Item):\r
-        Name = ''\r
         Language = ''\r
         Value = ''\r
 \r
         Name = Item.split()[1]\r
         # Check the string name is the upper character\r
-        if not self.IsCompatibleMode and Name != '':\r
+        if Name != '':\r
             MatchString = re.match('[A-Z0-9_]+', Name, re.UNICODE)\r
             if MatchString == None or MatchString.end(0) != len(Name):\r
                 EdkLogger.error('Unicode File Parser', FORMAT_INVALID, 'The string token name %s defined in UNI file %s contains the invalid lower case character.' %(Name, self.File))\r
@@ -288,7 +291,7 @@ class UniFileClassObject(object):
             EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, ExtraData=File.Path)\r
 \r
         try:\r
-            FileIn = codecs.open(File.Path, mode='rb', encoding='utf-16').readlines()\r
+            FileIn = codecs.open(LongFilePath(File.Path), mode='rb', encoding='utf-16').readlines()\r
         except UnicodeError, X:\r
             EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File.Path);\r
         except:\r
@@ -298,23 +301,46 @@ class UniFileClassObject(object):
         #\r
         # Use unique identifier\r
         #\r
+        FindFlag = -1\r
+        LineCount = 0\r
         for Line in FileIn:\r
+            Line = FileIn[LineCount]\r
+            LineCount += 1\r
             Line = Line.strip()\r
             #\r
             # Ignore comment line and empty line\r
             #\r
             if Line == u'' or Line.startswith(u'//'):\r
                 continue\r
+            \r
+            #\r
+            # Process comment embeded in string define lines\r
+            #\r
+            FindFlag = Line.find(u'//')\r
+            if FindFlag != -1:\r
+                Line = Line.replace(Line[FindFlag:], u' ')\r
+                if FileIn[LineCount].strip().startswith('#language'):\r
+                    Line = Line + FileIn[LineCount]\r
+                    FileIn[LineCount-1] = Line\r
+                    FileIn[LineCount] = os.linesep\r
+                    LineCount -= 1\r
+                    for Index in xrange (LineCount + 1, len (FileIn) - 1):\r
+                        if (Index == len(FileIn) -1):\r
+                            FileIn[Index] = os.linesep\r
+                        else:\r
+                            FileIn[Index] = FileIn[Index + 1]\r
+                    continue\r
+                              \r
             Line = Line.replace(u'/langdef', u'#langdef')\r
             Line = Line.replace(u'/string', u'#string')\r
             Line = Line.replace(u'/language', u'#language')\r
             Line = Line.replace(u'/include', u'#include')\r
 \r
+            Line = Line.replace(u'\\\\', u'\u0006')\r
             Line = Line.replace(UNICODE_WIDE_CHAR, WIDE_CHAR)\r
             Line = Line.replace(UNICODE_NARROW_CHAR, NARROW_CHAR)\r
             Line = Line.replace(UNICODE_NON_BREAKING_CHAR, NON_BREAKING_CHAR)\r
 \r
-            Line = Line.replace(u'\\\\', u'\u0006')\r
             Line = Line.replace(u'\\r\\n', CR + LF)\r
             Line = Line.replace(u'\\n', CR + LF)\r
             Line = Line.replace(u'\\r', CR)\r
@@ -322,7 +348,10 @@ class UniFileClassObject(object):
             Line = Line.replace(u'''\"''', u'''"''')\r
             Line = Line.replace(u'\t', u' ')\r
             Line = Line.replace(u'\u0006', u'\\')\r
-            \r
+            Line = Line.replace(DOBULE_QUOTED_SPLASH, u'"')\r
+            Line = Line.replace(SIGLE_QUOTED_SPLASH, u"'")\r
+            Line = Line.replace(TAB_BACK_SLASH, u"/")\r
+\r
 #           if Line.find(u'\\x'):\r
 #               hex = Line[Line.find(u'\\x') + 2 : Line.find(u'\\x') + 6]\r
 #               hex = "u'\\u" + hex + "'"\r
@@ -444,22 +473,31 @@ class UniFileClassObject(object):
     # Add a string to list\r
     #\r
     def AddStringToList(self, Name, Language, Value, Token = None, Referenced = False, UseOtherLangDef = '', Index = -1):\r
+        for LangNameItem in self.LanguageDef:\r
+            if Language == LangNameItem[0]:\r
+                break\r
+        else:\r
+            EdkLogger.error('Unicode File Parser', FORMAT_NOT_SUPPORTED, "The language '%s' for %s is not defined in Unicode file %s." \\r
+                            % (Language, Name, self.File))\r
+            \r
         if Language not in self.OrderedStringList:\r
             self.OrderedStringList[Language] = []\r
+            self.OrderedStringDict[Language] = {}\r
 \r
         IsAdded = True\r
-        for Item in self.OrderedStringList[Language]:\r
-            if Name == Item.StringName:\r
-                IsAdded = False\r
-                if Value != None:\r
-                    Item.UpdateValue(Value)\r
-                    Item.UseOtherLangDef = ''\r
-                break\r
+        if Name in self.OrderedStringDict[Language]:\r
+            IsAdded = False\r
+            if Value != None:\r
+                ItemIndexInList = self.OrderedStringDict[Language][Name]\r
+                Item = self.OrderedStringList[Language][ItemIndexInList]\r
+                Item.UpdateValue(Value)\r
+                Item.UseOtherLangDef = ''   \r
 \r
         if IsAdded:\r
             Token = len(self.OrderedStringList[Language])\r
             if Index == -1:\r
                 self.OrderedStringList[Language].append(StringDefClassObject(Name, Value, Referenced, Token, UseOtherLangDef))\r
+                self.OrderedStringDict[Language][Name] = Token\r
                 for LangName in self.LanguageDef:\r
                     #\r
                     # New STRING token will be added into all language string lists.\r
@@ -471,8 +509,10 @@ class UniFileClassObject(object):
                         else:\r
                             OtherLangDef = Language\r
                         self.OrderedStringList[LangName[0]].append(StringDefClassObject(Name, '', Referenced, Token, OtherLangDef))\r
+                        self.OrderedStringDict[LangName[0]][Name] = len(self.OrderedStringList[LangName[0]]) - 1\r
             else:\r
                 self.OrderedStringList[Language].insert(Index, StringDefClassObject(Name, Value, Referenced, Token, UseOtherLangDef))\r
+                self.OrderedStringDict[Language][Name] = Index\r
 \r
     #\r
     # Set the string as referenced\r
@@ -483,17 +523,18 @@ class UniFileClassObject(object):
         # So, only update the status of string stoken in first language string list.\r
         #\r
         Lang = self.LanguageDef[0][0]\r
-        for Item in self.OrderedStringList[Lang]:\r
-            if Name == Item.StringName:\r
-                Item.Referenced = True\r
-                break\r
+        if Name in self.OrderedStringDict[Lang]:\r
+            ItemIndexInList = self.OrderedStringDict[Lang][Name]\r
+            Item = self.OrderedStringList[Lang][ItemIndexInList]\r
+            Item.Referenced = True\r
+\r
     #\r
     # Search the string in language definition by Name\r
     #\r
     def FindStringValue(self, Name, Lang):\r
-        for Item in self.OrderedStringList[Lang]:\r
-            if Item.StringName == Name:\r
-                return Item\r
+        if Name in self.OrderedStringDict[Lang]:\r
+            ItemIndexInList = self.OrderedStringDict[Lang][Name]\r
+            return self.OrderedStringList[Lang][ItemIndexInList]\r
 \r
         return None\r
 \r
@@ -516,6 +557,10 @@ class UniFileClassObject(object):
         #\r
         FirstLangName = self.LanguageDef[0][0]\r
 \r
+        # Convert the OrderedStringList to be OrderedStringListByToken in order to faciliate future search by token\r
+        for LangNameItem in self.LanguageDef:\r
+            self.OrderedStringListByToken[LangNameItem[0]] = {}\r
+\r
         #\r
         # Use small token for all referred string stoken.\r
         #\r
@@ -528,6 +573,7 @@ class UniFileClassObject(object):
                     OtherLangItem = self.OrderedStringList[LangName][Index]\r
                     OtherLangItem.Referenced = True\r
                     OtherLangItem.Token = RefToken\r
+                    self.OrderedStringListByToken[LangName][OtherLangItem.Token] = OtherLangItem\r
                 RefToken = RefToken + 1\r
 \r
         #\r
@@ -541,6 +587,7 @@ class UniFileClassObject(object):
                     LangName = LangNameItem[0]\r
                     OtherLangItem = self.OrderedStringList[LangName][Index]\r
                     OtherLangItem.Token = RefToken + UnRefToken\r
+                    self.OrderedStringListByToken[LangName][OtherLangItem.Token] = OtherLangItem\r
                 UnRefToken = UnRefToken + 1\r
 \r
     #\r
@@ -559,6 +606,6 @@ class UniFileClassObject(object):
 if __name__ == '__main__':\r
     EdkLogger.Initialize()\r
     EdkLogger.SetLevel(EdkLogger.DEBUG_0)\r
-    a = UniFileClassObject(['C:\\Edk\\Strings.uni', 'C:\\Edk\\Strings2.uni'])\r
+    a = UniFileClassObject([PathClass("C:\\Edk\\Strings.uni"), PathClass("C:\\Edk\\Strings2.uni")])\r
     a.ReToken()\r
     a.ShowMe()\r