]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/UniClassObject.py
BaseTools: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / UniClassObject.py
index 242402dfaeeb511f7bbf4420cbd7feafc8fe4d6f..9f6a2715668c0d590e5cd36211aac14aa6721f23 100644 (file)
@@ -5,23 +5,18 @@
 # Copyright (c) 2014 Hewlett-Packard Development Company, L.P.<BR>\r
 #\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
-# http://opensource.org/licenses/bsd-license.php\r
-#\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
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 ##\r
 # Import Modules\r
 #\r
+from __future__ import print_function\r
 import Common.LongFilePathOs as os, codecs, re\r
 import distutils.util\r
 import Common.EdkLogger as EdkLogger\r
-import StringIO\r
+from io import BytesIO\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
@@ -45,18 +40,6 @@ BACK_SLASH_PLACEHOLDER = u'\u0006'
 \r
 gIncludePattern = re.compile("^#include +[\"<]+([^\"< >]+)[>\"]+$", re.MULTILINE | re.UNICODE)\r
 \r
-## Convert a python unicode string to a normal string\r
-#\r
-# Convert a python unicode string to a normal string\r
-# UniToStr(u'I am a string') is 'I am a string'\r
-#\r
-# @param Uni:  The python unicode string\r
-#\r
-# @retval:     The formatted normal string\r
-#\r
-def UniToStr(Uni):\r
-    return repr(Uni)[2:-1]\r
-\r
 ## Convert a unicode string to a Hex list\r
 #\r
 # Convert a unicode string to a Hex list\r
@@ -110,16 +93,14 @@ LangConvTable = {'eng':'en', 'fra':'fr', \
 ## GetLanguageCode\r
 #\r
 # Check the language code read from .UNI file and convert ISO 639-2 codes to RFC 4646 codes if appropriate\r
-# ISO 639-2 language codes supported in compatiblity mode\r
+# ISO 639-2 language codes supported in compatibility mode\r
 # RFC 4646 language codes supported in native mode\r
 #\r
 # @param LangName:   Language codes read from .UNI file\r
 #\r
-# @retval LangName:  Valid lanugage code in RFC 4646 format or None\r
+# @retval LangName:  Valid language 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
@@ -218,6 +199,19 @@ class StringDefClassObject(object):
             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
@@ -242,8 +236,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
@@ -272,7 +266,7 @@ class UniFileClassObject(object):
         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
+            # 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
@@ -286,7 +280,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
@@ -305,14 +300,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
+        UniFile = BytesIO(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
@@ -321,7 +317,7 @@ class UniFileClassObject(object):
             FileDecoded = codecs.decode(FileIn, Encoding)\r
             Ucs2Info.encode(FileDecoded)\r
         except:\r
-            UniFile = StringIO.StringIO(FileIn)\r
+            UniFile = BytesIO(FileIn)\r
             Info = codecs.lookup(Encoding)\r
             (Reader, Writer) = (Info.streamreader, Info.streamwriter)\r
             File = codecs.StreamReaderWriter(UniFile, Reader, Writer)\r
@@ -351,8 +347,8 @@ class UniFileClassObject(object):
         Name = Item.split()[1]\r
         # Check the string name\r
         if Name != '':\r
-            MatchString = re.match('^[a-zA-Z][a-zA-Z0-9_]*$', Name, re.UNICODE)\r
-            if MatchString is None or MatchString.end(0) != len(Name):\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
@@ -371,20 +367,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
@@ -393,8 +375,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
@@ -406,15 +388,15 @@ 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
             #\r
-            if len(Line) == 0: \r
-                continue \r
-            \r
-                             \r
+            if len(Line) == 0:\r
+                continue\r
+\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
@@ -429,8 +411,8 @@ class UniFileClassObject(object):
             Line = Line.replace(u'\\r', CR)\r
             Line = Line.replace(u'\\t', u' ')\r
             Line = Line.replace(u'\t', u' ')\r
-            Line = Line.replace(u'\\"', u'"') \r
-            Line = Line.replace(u"\\'", u"'") \r
+            Line = Line.replace(u'\\"', u'"')\r
+            Line = Line.replace(u"\\'", u"'")\r
             Line = Line.replace(BACK_SLASH_PLACEHOLDER, u'\\')\r
 \r
             StartPos = Line.find(u'\\x')\r
@@ -439,7 +421,7 @@ class UniFileClassObject(object):
                 if EndPos != -1 and EndPos - StartPos == 6 :\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
+                        UniStr = Line[StartPos + 2: EndPos]\r
                         if EndStr.startswith(u'\\x') and len(EndStr) >= 7:\r
                             if EndStr[6] == u'\\' and g4HexChar.match(EndStr[2 : 6], re.UNICODE):\r
                                 Line = Line[0 : StartPos] + UniStr + EndStr\r
@@ -521,8 +503,8 @@ class UniFileClassObject(object):
                 Language = GetLanguageCode(Language, self.IsCompatibleMode, self.File)\r
                 # Check the string name\r
                 if not self.IsCompatibleMode and Name != '':\r
-                    MatchString = re.match('^[a-zA-Z][a-zA-Z0-9_]*$', Name, re.UNICODE)\r
-                    if MatchString is None or MatchString.end(0) != len(Name):\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
@@ -570,7 +552,7 @@ class UniFileClassObject(object):
         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
+\r
         if Language not in self.OrderedStringList:\r
             self.OrderedStringList[Language] = []\r
             self.OrderedStringDict[Language] = {}\r
@@ -592,7 +574,7 @@ class UniFileClassObject(object):
                 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
+                    # 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
@@ -685,12 +667,12 @@ class UniFileClassObject(object):
     # Show the instance itself\r
     #\r
     def ShowMe(self):\r
-        print self.LanguageDef\r
+        print(self.LanguageDef)\r
         #print self.OrderedStringList\r
         for Item in self.OrderedStringList:\r
-            print Item\r
+            print(Item)\r
             for Member in self.OrderedStringList[Item]:\r
-                print str(Member)\r
+                print(str(Member))\r
 \r
 # This acts like the main() function for the script, unless it is 'import'ed into another\r
 # script.\r