]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/UniClassObject.py
Sync BaseTool trunk (version r2423) into EDKII BaseTools. The change mainly includes:
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / UniClassObject.py
index 8f929a33cba93214b65df073f4fdc0a79cc45299..ea27607fce6dbb668a37881748b972b13fec4351 100644 (file)
@@ -121,7 +121,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
@@ -177,18 +177,26 @@ class StringDefClassObject(object):
                repr(self.StringValue) + ' ' + \\r
                repr(self.UseOtherLangDef)\r
 \r
+    def UpdateValue(self, Value = None):\r
+        if Value != None:\r
+            self.StringValue = Value + u'\x00'        # Add a NULL at string tail\r
+            self.StringValueByteList = UniToHexList(self.StringValue)\r
+            self.Length = len(self.StringValueByteList)\r
+\r
 ## UniFileClassObject\r
 #\r
 # A structure for .uni file definition\r
 #\r
 class UniFileClassObject(object):\r
-    def __init__(self, FileList = [], IsCompatibleMode = False):\r
+    def __init__(self, FileList = [], IsCompatibleMode = False, IncludePathList = []):\r
         self.FileList = FileList\r
         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
-\r
+        self.IncludePathList = IncludePathList\r
         if len(self.FileList) > 0:\r
             self.LoadUniFiles(FileList)\r
 \r
@@ -226,19 +234,33 @@ class UniFileClassObject(object):
         self.AddStringToList(u'$LANGUAGE_NAME', LangName, LangName, 0, True, Index=0)\r
         self.AddStringToList(u'$PRINTABLE_LANGUAGE_NAME', LangName, LangPrintName, 1, True, Index=1)\r
 \r
+        if not IsLangInDef:\r
+            #\r
+            # The found STRING tokens will be added into new language string list\r
+            # so that the unique STRING identifier is reserved for all languages in the package list. \r
+            #\r
+            FirstLangName = self.LanguageDef[0][0]\r
+            if LangName != FirstLangName:\r
+                for Index in range (2, len (self.OrderedStringList[FirstLangName])):\r
+                    Item = self.OrderedStringList[FirstLangName][Index]\r
+                    if Item.UseOtherLangDef != '':\r
+                        OtherLang = Item.UseOtherLangDef\r
+                    else:\r
+                        OtherLang = FirstLangName\r
+                    self.OrderedStringList[LangName].append (StringDefClassObject(Item.StringName, '', Item.Referenced, Item.Token, OtherLang))\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
@@ -266,7 +288,6 @@ class UniFileClassObject(object):
         if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r
             EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, ExtraData=File.Path)\r
 \r
-        Dir = File.Dir\r
         try:\r
             FileIn = codecs.open(File.Path, mode='rb', encoding='utf-16').readlines()\r
         except UnicodeError, X:\r
@@ -278,13 +299,36 @@ 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
@@ -309,7 +353,13 @@ class UniFileClassObject(object):
 \r
             IncList = gIncludePattern.findall(Line)\r
             if len(IncList) == 1:\r
-                Lines.extend(self.PreProcess(PathClass(str(IncList[0]), Dir)))\r
+                for Dir in [File.Dir] + self.IncludePathList:\r
+                    IncFile = PathClass(str(IncList[0]), Dir)\r
+                    if os.path.isfile(IncFile.Path):\r
+                        Lines.extend(self.PreProcess(IncFile))\r
+                        break\r
+                else:\r
+                    EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, Message="Cannot find include file", ExtraData=str(IncList[0]))\r
                 continue\r
 \r
             Lines.append(Line)\r
@@ -418,37 +468,68 @@ 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
-\r
-        IsAdded = False\r
-        for Item in self.OrderedStringList[Language]:\r
-            if Name == Item.StringName:\r
-                IsAdded = True\r
-                break\r
-        if not IsAdded:\r
+            self.OrderedStringDict[Language] = {}\r
+\r
+        IsAdded = True\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
+                    # so that the unique STRING identifier is reserved for all languages in the package list. \r
+                    #\r
+                    if LangName[0] != Language:\r
+                        if UseOtherLangDef != '':\r
+                            OtherLangDef = UseOtherLangDef\r
+                        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
     #\r
     def SetStringReferenced(self, Name):\r
-        for Lang in self.OrderedStringList:\r
-            for Item in self.OrderedStringList[Lang]:\r
-                if Name == Item.StringName:\r
-                    Item.Referenced = True\r
-                    break\r
+        #\r
+        # String stoken are added in the same order in all language string lists.\r
+        # So, only update the status of string stoken in first language string list.\r
+        #\r
+        Lang = self.LanguageDef[0][0]\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
@@ -467,61 +548,42 @@ class UniFileClassObject(object):
     #\r
     def ReToken(self):\r
         #\r
-        # Search each string to find if it is defined for each language\r
-        # Use secondary language value to replace if missing in any one language\r
-        #\r
-        for IndexI in range(0, len(self.LanguageDef)):\r
-            LangKey = self.LanguageDef[IndexI][0]\r
-            for Item in self.OrderedStringList[LangKey]:\r
-                Name = Item.StringName\r
-                Value = Item.StringValue[0:-1]\r
-                Referenced = Item.Referenced\r
-                Index = self.OrderedStringList[LangKey].index(Item)\r
-                for IndexJ in range(0, len(self.LanguageDef)):\r
-                    LangFind = self.LanguageDef[IndexJ][0]\r
-                    if self.FindStringValue(Name, LangFind) == None:\r
-                        EdkLogger.debug(EdkLogger.DEBUG_5, Name)\r
-                        Token = len(self.OrderedStringList[LangFind])\r
-                        self.AddStringToList(Name, LangFind, Value, Token, Referenced, LangKey, Index)\r
-        #\r
-        # Retoken\r
+        # Retoken all language strings according to the status of string stoken in the first language string.\r
         #\r
-        # First re-token the first language\r
-        LangName = self.LanguageDef[0][0]\r
-        ReferencedStringList = []\r
-        NotReferencedStringList = []\r
-        Token = 0\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
-        # Order UNI token by their String Name\r
+        # Use small token for all referred string stoken.\r
         #\r
-        StringNameList = []\r
-        for Item in self.OrderedStringList[LangName]:\r
-            StringNameList.append (Item.StringName)\r
-        StringNameList.sort()\r
-\r
-        for Name in StringNameList:\r
-            Item = self.FindStringValue (Name, LangName)\r
-            if Item.Referenced == True:\r
-                Item.Token = Token\r
-                ReferencedStringList.append(Item)\r
-                Token = Token + 1\r
-            else:\r
-                NotReferencedStringList.append(Item)\r
-        self.OrderedStringList[LangName] = ReferencedStringList\r
-        for Index in range(len(NotReferencedStringList)):\r
-            NotReferencedStringList[Index].Token = Token + Index\r
-            self.OrderedStringList[LangName].append(NotReferencedStringList[Index])\r
+        RefToken = 0\r
+        for Index in range (0, len (self.OrderedStringList[FirstLangName])):\r
+            FirstLangItem = self.OrderedStringList[FirstLangName][Index]\r
+            if FirstLangItem.Referenced == True:\r
+                for LangNameItem in self.LanguageDef:\r
+                    LangName = LangNameItem[0]\r
+                    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
-        # Adjust the orders of other languages\r
+        # Use big token for all unreferred string stoken.\r
         #\r
-        for IndexOfLanguage in range(1, len(self.LanguageDef)):\r
-            for OrderedString in self.OrderedStringList[LangName]:\r
-                for UnOrderedString in self.OrderedStringList[self.LanguageDef[IndexOfLanguage][0]]:\r
-                    if OrderedString.StringName == UnOrderedString.StringName:\r
-                        UnOrderedString.Token = OrderedString.Token\r
-                        break\r
+        UnRefToken = 0\r
+        for Index in range (0, len (self.OrderedStringList[FirstLangName])):\r
+            FirstLangItem = self.OrderedStringList[FirstLangName][Index]\r
+            if FirstLangItem.Referenced == False:\r
+                for LangNameItem in self.LanguageDef:\r
+                    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
     # Show the instance itself\r
@@ -539,6 +601,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