]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/StrGather.py
BaseTools: StrGather remove functions no one calls
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / StrGather.py
index b84d9f90aaec59e003d65fa3adb3252622c85714..9c7dd1e40374adf45080909a6f0b34f807c8a884 100644 (file)
@@ -1,4 +1,8 @@
-# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+## @file\r
+# This file is used to parse a strings file and create or add to a string database \r
+# file.\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
@@ -7,10 +11,6 @@
 # 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 parse a strings file and create or add to a string database file.\r
-#\r
-\r
 ##\r
 # Import Modules\r
 #\r
@@ -19,7 +19,8 @@ import Common.EdkLogger as EdkLogger
 from Common.BuildToolError import *\r
 from UniClassObject import *\r
 from StringIO import StringIO\r
-from struct import pack\r
+from struct import pack, unpack\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
 \r
 ##\r
 # Static definitions\r
@@ -58,11 +59,7 @@ NOT_REFERENCED = 'not referenced'
 COMMENT_NOT_REFERENCED = ' ' + COMMENT + NOT_REFERENCED\r
 CHAR_ARRAY_DEFIN = 'unsigned char'\r
 COMMON_FILE_NAME = 'Strings'\r
-OFFSET = 'offset'\r
-STRING = 'string'\r
-TO = 'to'\r
 STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
-COMPATIBLE_STRING_TOKEN = re.compile('STRING_TOKEN *\(([A-Z0-9_]+) *\)', re.MULTILINE | re.UNICODE)\r
 \r
 EFI_HII_ARRAY_SIZE_LENGTH = 4\r
 EFI_HII_PACKAGE_HEADER_LENGTH = 4\r
@@ -97,7 +94,7 @@ PRINTABLE_LANGUAGE_NAME_STRING_NAME = '$PRINTABLE_LANGUAGE_NAME'
 # @retval:       The formatted hex string\r
 #\r
 def DecToHexStr(Dec, Digit = 8):\r
-    return eval("'0x%0" + str(Digit) + "X' % int(Dec)")\r
+    return '0x{0:0{1}X}'.format(Dec,Digit)\r
 \r
 ## Convert a dec number to a hex list\r
 #\r
@@ -112,11 +109,8 @@ def DecToHexStr(Dec, Digit = 8):
 # @retval:       A list for formatted hex string\r
 #\r
 def DecToHexList(Dec, Digit = 8):\r
-    Hex = eval("'%0" + str(Digit) + "X' % int(Dec)" )\r
-    List = []\r
-    for Bit in range(Digit - 2, -1, -2):\r
-        List.append(HexHeader + Hex[Bit:Bit + 2])\r
-    return List\r
+    Hex = '{0:0{1}X}'.format(Dec,Digit)\r
+    return ["0x" + Hex[Bit:Bit + 2] for Bit in range(Digit - 2, -1, -2)]\r
 \r
 ## Convert a acsii string to a hex list\r
 #\r
@@ -128,27 +122,7 @@ def DecToHexList(Dec, Digit = 8):
 # @retval:       A list for formatted hex string\r
 #\r
 def AscToHexList(Ascii):\r
-    List = []\r
-    for Item in Ascii:\r
-        List.append('0x%2X' % ord(Item))\r
-\r
-    return List\r
-\r
-## Create header of .h file\r
-#\r
-# Create a header of .h file\r
-#\r
-# @param BaseName: The basename of strings\r
-#\r
-# @retval Str:     A string for .h file header\r
-#\r
-def CreateHFileHeader(BaseName):\r
-    Str = ''\r
-    for Item in H_C_FILE_HEADER:\r
-        Str = WriteLine(Str, Item)\r
-    Str = WriteLine(Str, '#ifndef _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r
-    Str = WriteLine(Str, '#define _' + BaseName.upper() + '_STRINGS_DEFINE_H_')\r
-    return Str\r
+    return ['0x{0:02X}'.format(ord(Item)) for Item in Ascii]\r
 \r
 ## Create content of .h file\r
 #\r
@@ -191,7 +165,7 @@ def CreateHFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):
                     Line = COMMENT_DEFINE_STR + ' ' + Name + ' ' * (ValueStartPtr - len(DEFINE_STR + Name)) + DecToHexStr(Token, 4) + COMMENT_NOT_REFERENCED\r
                 UnusedStr = WriteLine(UnusedStr, Line)\r
 \r
-    Str = ''.join([Str,UnusedStr])\r
+    Str = ''.join([Str, UnusedStr])\r
 \r
     Str = WriteLine(Str, '')\r
     if IsCompatibleMode or UniGenCFlag:\r
@@ -214,19 +188,6 @@ def CreateHFile(BaseName, UniObjectClass, IsCompatibleMode, UniGenCFlag):
 \r
     return HFile\r
 \r
-## Create header of .c file\r
-#\r
-# Create a header of .c file\r
-#\r
-# @retval Str:     A string for .c file header\r
-#\r
-def CreateCFileHeader():\r
-    Str = ''\r
-    for Item in H_C_FILE_HEADER:\r
-        Str = WriteLine(Str, Item)\r
-\r
-    return Str\r
-\r
 ## Create a buffer to store all items in an array\r
 #\r
 # @param BinBuffer   Buffer to contain Binary data.\r
@@ -234,7 +195,7 @@ def CreateCFileHeader():
 #\r
 def CreateBinBuffer(BinBuffer, Array):\r
     for Item in Array:\r
-        BinBuffer.write(pack("B", int(Item,16)))\r
+        BinBuffer.write(pack("B", int(Item, 16)))\r
 \r
 ## Create a formatted string all items in an array\r
 #\r
@@ -257,7 +218,7 @@ def CreateArrayItem(Array, Width = 16):
             Index = Index + 1\r
         else:\r
             ArrayItem = WriteLine(ArrayItem, Line)\r
-            Line = '  ' + Item +  ',  '\r
+            Line = '  ' + Item + ',  '\r
             Index = 1\r
     ArrayItem = Write(ArrayItem, Line.rstrip())\r
 \r
@@ -319,7 +280,7 @@ def GetFilteredLanguage(UniLanguageList, LanguageFilterList):
 \r
                 if PrimaryTag == UniLanguagePrimaryTag:\r
                     if UniLanguage not in UniLanguageListFiltered:\r
-                        UniLanguageListFiltered += [UniLanguage]    \r
+                        UniLanguageListFiltered += [UniLanguage]\r
                     break\r
             else:\r
                 # Here is rule 3 for "get best language"\r
@@ -367,7 +328,7 @@ def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer,
     \r
     UniLanguageList = []\r
     for IndexI in range(len(UniObjectClass.LanguageDef)):\r
-        UniLanguageList += [UniObjectClass.LanguageDef[IndexI][0]]           \r
+        UniLanguageList += [UniObjectClass.LanguageDef[IndexI][0]]\r
 \r
     UniLanguageListFiltered = GetFilteredLanguage(UniLanguageList, LanguageFilterList)\r
  \r
@@ -449,14 +410,14 @@ def CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, UniBinBuffer,
         if UniBinBuffer:\r
             CreateBinBuffer (UniBinBuffer, List)\r
             UniBinBuffer.write (StringBuffer.getvalue())\r
-            UniBinBuffer.write (pack("B", int(EFI_HII_SIBT_END,16)))\r
+            UniBinBuffer.write (pack("B", int(EFI_HII_SIBT_END, 16)))\r
         StringBuffer.close()\r
 \r
     #\r
     # Create line for string variable name\r
     # "unsigned char $(BaseName)Strings[] = {"\r
     #\r
-    AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + BaseName + COMMON_FILE_NAME + '[] = {\n' )\r
+    AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + BaseName + COMMON_FILE_NAME + '[] = {\n')\r
 \r
     if IsCompatibleMode:\r
         #\r
@@ -503,7 +464,6 @@ def CreateCFileEnd():
 #\r
 def CreateCFile(BaseName, UniObjectClass, IsCompatibleMode, FilterInfo):\r
     CFile = ''\r
-    #CFile = WriteLine(CFile, CreateCFileHeader())\r
     CFile = WriteLine(CFile, CreateCFileContent(BaseName, UniObjectClass, IsCompatibleMode, None, FilterInfo))\r
     CFile = WriteLine(CFile, CreateCFileEnd())\r
     return CFile\r
@@ -571,11 +531,7 @@ def SearchString(UniObjectClass, FileList, IsCompatibleMode):
         if os.path.isfile(File):\r
             Lines = open(File, 'r')\r
             for Line in Lines:\r
-                if not IsCompatibleMode:\r
-                    StringTokenList = STRING_TOKEN.findall(Line)\r
-                else:\r
-                    StringTokenList = COMPATIBLE_STRING_TOKEN.findall(Line)\r
-                for StrName in StringTokenList:\r
+                for StrName in STRING_TOKEN.findall(Line):\r
                     EdkLogger.debug(EdkLogger.DEBUG_5, "Found string identifier: " + StrName)\r
                     UniObjectClass.SetStringReferenced(StrName)\r
 \r
@@ -617,13 +573,13 @@ def GetStringFiles(UniFilList, SourceFileList, IncludeList, IncludePathList, Ski
 # Write an item\r
 #\r
 def Write(Target, Item):\r
-    return ''.join([Target,Item])\r
+    return ''.join([Target, Item])\r
 \r
 #\r
 # Write an item with a break line\r
 #\r
 def WriteLine(Target, Item):\r
-    return ''.join([Target,Item,'\n'])\r
+    return ''.join([Target, Item, '\n'])\r
 \r
 # This acts like the main() function for the script, unless it is 'import'ed into another\r
 # script.\r