]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/UniClassObject.py
BaseTools: Refactor python except statements
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / UniClassObject.py
index d28fd3a1ea6243db99ff28127c6aa88b83beb7f0..06cf3e7d5162b694f38f0a30c295706f19e05534 100644 (file)
@@ -4,7 +4,7 @@
 #\r
 # Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR>\r
 #\r
-# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2007 - 2018, 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
@@ -21,9 +21,10 @@ import distutils.util
 import Common.EdkLogger as EdkLogger\r
 import StringIO\r
 from Common.BuildToolError import *\r
-from Common.String import GetLineNo\r
+from Common.StringUtils import GetLineNo\r
 from Common.Misc import PathClass\r
 from Common.LongFilePathSupport import LongFilePath\r
+from Common.GlobalData import *\r
 ##\r
 # Static definitions\r
 #\r
@@ -117,13 +118,11 @@ LangConvTable = {'eng':'en', 'fra':'fr', \
 # @retval LangName:  Valid lanugage code in RFC 4646 format or None\r
 #\r
 def GetLanguageCode(LangName, IsCompatibleMode, File):\r
-    global LangConvTable\r
-\r
     length = len(LangName)\r
     if IsCompatibleMode:\r
         if length == 3 and LangName.isalpha():\r
             TempLangName = LangConvTable.get(LangName.lower())\r
-            if TempLangName != None:\r
+            if TempLangName is not None:\r
                 return TempLangName\r
             return LangName\r
         else:\r
@@ -135,7 +134,7 @@ def GetLanguageCode(LangName, IsCompatibleMode, File):
         if LangName.isalpha():\r
             return LangName\r
     elif length == 3:\r
-        if LangName.isalpha() and LangConvTable.get(LangName.lower()) == None:\r
+        if LangName.isalpha() and LangConvTable.get(LangName.lower()) is None:\r
             return LangName\r
     elif length == 5:\r
         if LangName[0:2].isalpha() and LangName[2] == '-':\r
@@ -143,7 +142,7 @@ def GetLanguageCode(LangName, IsCompatibleMode, File):
     elif length >= 6:\r
         if LangName[0:2].isalpha() and LangName[2] == '-':\r
             return LangName\r
-        if LangName[0:3].isalpha() and LangConvTable.get(LangName.lower()) == None and LangName[3] == '-':\r
+        if LangName[0:3].isalpha() and LangConvTable.get(LangName.lower()) is None and LangName[3] == '-':\r
             return LangName\r
 \r
     EdkLogger.error("Unicode File Parser", FORMAT_INVALID, "Invalid RFC 4646 language code : %s" % LangName, File)\r
@@ -194,14 +193,14 @@ class StringDefClassObject(object):
         self.UseOtherLangDef = UseOtherLangDef\r
         self.Length = 0\r
 \r
-        if Name != None:\r
+        if Name is not None:\r
             self.StringName = Name\r
             self.StringNameByteList = UniToHexList(Name)\r
-        if Value != None:\r
+        if Value is not 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
-        if Token != None:\r
+        if Token is not None:\r
             self.Token = Token\r
 \r
     def __str__(self):\r
@@ -212,11 +211,24 @@ class StringDefClassObject(object):
                repr(self.UseOtherLangDef)\r
 \r
     def UpdateValue(self, Value = None):\r
-        if Value != None:\r
+        if Value is not 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
+def StripComments(Line):\r
+    Comment = u'//'\r
+    CommentPos = Line.find(Comment)\r
+    while CommentPos >= 0:\r
+    # if there are non matched quotes before the comment header\r
+    # then we are in the middle of a string\r
+    # but we need to ignore the escaped quotes and backslashes.\r
+        if ((Line.count(u'"', 0, CommentPos) - Line.count(u'\\"', 0, CommentPos)) & 1) == 1:\r
+            CommentPos = Line.find (Comment, CommentPos + 1)\r
+        else:\r
+            return Line[:CommentPos].strip()\r
+    return Line.strip()\r
+\r
 ## UniFileClassObject\r
 #\r
 # A structure for .uni file definition\r
@@ -241,8 +253,8 @@ class UniFileClassObject(object):
         Lang = distutils.util.split_quoted((Line.split(u"//")[0]))\r
         if len(Lang) != 3:\r
             try:\r
-                FileIn = self.OpenUniFile(LongFilePath(File.Path))\r
-            except UnicodeError, X:\r
+                FileIn = UniFileClassObject.OpenUniFile(LongFilePath(File.Path))\r
+            except UnicodeError as X:\r
                 EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File);\r
             except:\r
                 EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File);\r
@@ -285,7 +297,8 @@ class UniFileClassObject(object):
                     self.OrderedStringDict[LangName][Item.StringName] = len(self.OrderedStringList[LangName]) - 1\r
         return True\r
 \r
-    def OpenUniFile(self, FileName):\r
+    @staticmethod\r
+    def OpenUniFile(FileName):\r
         #\r
         # Read file\r
         #\r
@@ -304,14 +317,15 @@ class UniFileClassObject(object):
             FileIn.startswith(codecs.BOM_UTF16_LE)):\r
             Encoding = 'utf-16'\r
 \r
-        self.VerifyUcs2Data(FileIn, FileName, Encoding)\r
+        UniFileClassObject.VerifyUcs2Data(FileIn, FileName, Encoding)\r
 \r
         UniFile = StringIO.StringIO(FileIn)\r
         Info = codecs.lookup(Encoding)\r
         (Reader, Writer) = (Info.streamreader, Info.streamwriter)\r
         return codecs.StreamReaderWriter(UniFile, Reader, Writer)\r
 \r
-    def VerifyUcs2Data(self, FileIn, FileName, Encoding):\r
+    @staticmethod\r
+    def VerifyUcs2Data(FileIn, FileName, Encoding):\r
         Ucs2Info = codecs.lookup('ucs-2')\r
         #\r
         # Convert to unicode\r
@@ -348,11 +362,11 @@ class UniFileClassObject(object):
         Value = ''\r
 \r
         Name = Item.split()[1]\r
-        # Check the string name is the upper character\r
+        # Check the string 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
+            MatchString = gIdentifierPattern.match(Name)\r
+            if MatchString is None:\r
+                EdkLogger.error('Unicode File Parser', FORMAT_INVALID, 'The string token name %s defined in UNI file %s contains the invalid character.' % (Name, self.File))\r
         LanguageList = Item.split(u'#language ')\r
         for IndexI in range(len(LanguageList)):\r
             if IndexI == 0:\r
@@ -370,20 +384,6 @@ class UniFileClassObject(object):
         FileName = Item[Item.find(u'#include ') + len(u'#include ') :Item.find(u' ', len(u'#include '))][1:-1]\r
         self.LoadUniFile(FileName)\r
 \r
-    def StripComments(self, Line):\r
-        Comment = u'//'\r
-        CommentPos = Line.find(Comment)\r
-        while CommentPos >= 0:\r
-        # if there are non matched quotes before the comment header\r
-        # then we are in the middle of a string\r
-        # but we need to ignore the escaped quotes and backslashes.\r
-            if ((Line.count(u'"', 0, CommentPos) - Line.count(u'\\"', 0, CommentPos)) & 1) == 1:\r
-                CommentPos = Line.find (Comment, CommentPos + 1)\r
-            else:\r
-                return Line[:CommentPos].strip()\r
-        return Line.strip()\r
-                \r
-\r
     #\r
     # Pre-process before parse .uni file\r
     #\r
@@ -392,8 +392,8 @@ class UniFileClassObject(object):
             EdkLogger.error("Unicode File Parser", FILE_NOT_FOUND, ExtraData=File.Path)\r
 \r
         try:\r
-            FileIn = self.OpenUniFile(LongFilePath(File.Path))\r
-        except UnicodeError, X:\r
+            FileIn = UniFileClassObject.OpenUniFile(LongFilePath(File.Path))\r
+        except UnicodeError as X:\r
             EdkLogger.error("build", FILE_READ_FAILURE, "File read failure: %s" % str(X), ExtraData=File.Path);\r
         except:\r
             EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File.Path);\r
@@ -405,7 +405,7 @@ class UniFileClassObject(object):
         for Line in FileIn:\r
             Line = Line.strip()\r
             Line = Line.replace(u'\\\\', BACK_SLASH_PLACEHOLDER)\r
-            Line = self.StripComments(Line)\r
+            Line = StripComments(Line)\r
 \r
             #\r
             # Ignore empty line\r
@@ -436,15 +436,15 @@ class UniFileClassObject(object):
             while (StartPos != -1):\r
                 EndPos = Line.find(u'\\', StartPos + 1, StartPos + 7)\r
                 if EndPos != -1 and EndPos - StartPos == 6 :\r
-                    if re.match('[a-fA-F0-9]{4}', Line[StartPos + 2 : EndPos], re.UNICODE):\r
+                    if g4HexChar.match(Line[StartPos + 2 : EndPos], re.UNICODE):\r
                         EndStr = Line[EndPos: ]\r
                         UniStr = ('\u' + (Line[StartPos + 2 : EndPos])).decode('unicode_escape')\r
                         if EndStr.startswith(u'\\x') and len(EndStr) >= 7:\r
-                            if EndStr[6] == u'\\' and re.match('[a-fA-F0-9]{4}', EndStr[2 : 6], re.UNICODE):\r
+                            if EndStr[6] == u'\\' and g4HexChar.match(EndStr[2 : 6], re.UNICODE):\r
                                 Line = Line[0 : StartPos] + UniStr + EndStr\r
                         else:\r
                             Line = Line[0 : StartPos] + UniStr + EndStr[1:]\r
-                StartPos = Line.find(u'\\x', StartPos)\r
+                StartPos = Line.find(u'\\x', StartPos + 1)\r
 \r
             IncList = gIncludePattern.findall(Line)\r
             if len(IncList) == 1:\r
@@ -465,7 +465,7 @@ class UniFileClassObject(object):
     # Load a .uni file\r
     #\r
     def LoadUniFile(self, File = None):\r
-        if File == None:\r
+        if File is None:\r
             EdkLogger.error("Unicode File Parser", PARSER_ERROR, 'No unicode file is given')\r
         self.File = File\r
         #\r
@@ -518,11 +518,11 @@ class UniFileClassObject(object):
                         break\r
                 # Value = Value.replace(u'\r\n', u'')\r
                 Language = GetLanguageCode(Language, self.IsCompatibleMode, self.File)\r
-                # Check the string name is the upper character\r
+                # Check the string name\r
                 if not self.IsCompatibleMode and 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
+                    MatchString = gIdentifierPattern.match(Name)\r
+                    if MatchString is None:\r
+                        EdkLogger.error('Unicode File Parser', FORMAT_INVALID, 'The string token name %s defined in UNI file %s contains the invalid character.' % (Name, self.File))\r
                 self.AddStringToList(Name, Language, Value)\r
                 continue\r
 \r
@@ -577,7 +577,7 @@ class UniFileClassObject(object):
         IsAdded = True\r
         if Name in self.OrderedStringDict[Language]:\r
             IsAdded = False\r
-            if Value != None:\r
+            if Value is not None:\r
                 ItemIndexInList = self.OrderedStringDict[Language][Name]\r
                 Item = self.OrderedStringList[Language][ItemIndexInList]\r
                 Item.UpdateValue(Value)\r