BaseTools: Rename String to StringUtils.

For case-insensitive file systems, edk2 String.py collides with the
Python string.py, which results in build errors. This,for example,
applies to building via the Windows Subsystem for Linux from a
DriveFS file system. This patch renames String to StringUtils to
prevent conflicts for case-insensitive file systems.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Marvin Haeuser <Marvin.Haeuser@outlook.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

BaseTools/Source/Python/AutoGen/AutoGen.py

@@ -33,7 +33,7 @@ from Common.LongFilePathSupport import CopyLongFilePath
 from Common.BuildToolError import *
 from Common.DataType import *
 from Common.Misc import *
-from Common.String import *
+from Common.StringUtils import *
 import Common.GlobalData as GlobalData
 from GenFds.FdfParser import *
 from CommonDataClass.CommonClass import SkuInfoClass

BaseTools/Source/Python/AutoGen/BuildEngine.py

@@ -23,7 +23,7 @@ from Common.LongFilePathSupport import OpenLongFilePath as open
 from Common.GlobalData import *
 from Common.BuildToolError import *
 from Common.Misc import tdict, PathClass
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 from Common.DataType import *
 
 import Common.EdkLogger as EdkLogger

BaseTools/Source/Python/AutoGen/GenC.py

@@ -21,7 +21,7 @@ from Common import EdkLogger
 from Common.BuildToolError import *
 from Common.DataType import *
 from Common.Misc import *
-from Common.String import StringToArray
+from Common.StringUtils import StringToArray
 from StrGather import *
 from GenPcdDb import CreatePcdDatabaseCode
 from IdfClassObject import *

BaseTools/Source/Python/AutoGen/GenMake.py

@@ -22,7 +22,7 @@ from Common.LongFilePathSupport import OpenLongFilePath as open
 from Common.MultipleWorkspace import MultipleWorkspace as mws
 from Common.BuildToolError import *
 from Common.Misc import *
-from Common.String import *
+from Common.StringUtils import *
 from BuildEngine import *
 import Common.GlobalData as GlobalData
 from collections import OrderedDict

BaseTools/Source/Python/AutoGen/GenPcdDb.py

@@ -12,7 +12,7 @@
 #
 from StringIO import StringIO
 from Common.Misc import *
-from Common.String import StringToArray
+from Common.StringUtils import StringToArray
 from struct import pack
 from ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB_CONTAINER
 from ValidCheckingInfoObject import VAR_CHECK_PCD_VARIABLE_TAB

BaseTools/Source/Python/AutoGen/IdfClassObject.py

@@ -16,7 +16,7 @@
 import Common.EdkLogger as EdkLogger
 import StringIO
 from Common.BuildToolError import *
-from Common.String import GetLineNo
+from Common.StringUtils import GetLineNo
 from Common.Misc import PathClass
 from Common.LongFilePathSupport import LongFilePath
 import re

BaseTools/Source/Python/AutoGen/UniClassObject.py

@@ -21,7 +21,7 @@ import distutils.util
 import Common.EdkLogger as EdkLogger
 import StringIO
 from Common.BuildToolError import *
-from Common.String import GetLineNo
+from Common.StringUtils import GetLineNo
 from Common.Misc import PathClass
 from Common.LongFilePathSupport import LongFilePath
 from Common.GlobalData import *

BaseTools/Source/Python/Common/Database.py

@@ -19,7 +19,7 @@ import Common.LongFilePathOs as os
 
 import EdkLogger as EdkLogger
 from CommonDataClass.DataClass import *
-from String import *
+from StringUtils import *
 from DataType import *
 
 from Table.TableDataModel import TableDataModel

BaseTools/Source/Python/Common/Parsing.py

@@ -14,7 +14,7 @@
 ##
 # Import Modules
 #
-from String import *
+from StringUtils import *
 from CommonDataClass.DataClass import *
 from DataType import *
 

BaseTools/Source/Python/Common/ToolDefClassObject.py

@@ -22,7 +22,7 @@ from BuildToolError import *
 from TargetTxtClassObject import *
 from Common.LongFilePathSupport import OpenLongFilePath as open
 from Common.Misc import PathClass
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 import Common.GlobalData as GlobalData
 from Common import GlobalData
 from Common.MultipleWorkspace import MultipleWorkspace as mws

BaseTools/Source/Python/Ecc/Configuration.py

@@ -17,7 +17,7 @@
 import Common.LongFilePathOs as os
 import Common.EdkLogger as EdkLogger
 from Common.DataType import *
-from Common.String import *
+from Common.StringUtils import *
 from Common.LongFilePathSupport import OpenLongFilePath as open
 
 _ConfigFileToInternalTranslation = {

BaseTools/Source/Python/Ecc/Ecc.py

@@ -24,7 +24,7 @@ from Configuration import Configuration
 from Check import Check
 import Common.GlobalData as GlobalData
 
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 from Common.BuildVersion import gBUILD_VERSION
 from Common import BuildToolError
 from Common.Misc import PathClass

BaseTools/Source/Python/Ecc/MetaFileWorkspace/MetaFileParser.py

@@ -26,7 +26,7 @@ import EccToolError
 
 from CommonDataClass.DataClass import *
 from Common.DataType import *
-from Common.String import *
+from Common.StringUtils import *
 from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData
 from Common.Expression import *
 from CommonDataClass.Exceptions import *

BaseTools/Source/Python/Eot/Eot.py

@@ -18,7 +18,7 @@ import Common.LongFilePathOs as os, time, glob
 import Common.EdkLogger as EdkLogger
 import EotGlobalData
 from optparse import OptionParser
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 from Common import BuildToolError
 from Common.Misc import GuidStructureStringToGuidString, sdict
 from InfParserLite import *

BaseTools/Source/Python/Eot/InfParserLite.py

@@ -19,7 +19,7 @@ import Common.EdkLogger as EdkLogger
 from Common.DataType import *
 from CommonDataClass.DataClass import *
 from Common.Identification import *
-from Common.String import *
+from Common.StringUtils import *
 from Parser import *
 import Database
 

BaseTools/Source/Python/Eot/Parser.py

@@ -19,9 +19,9 @@ import Common.LongFilePathOs as os, re
 import Common.EdkLogger as EdkLogger
 from Common.DataType import *
 from CommonDataClass.DataClass import *
-from Common.String import CleanString, GetSplitValueList, ReplaceMacro
+from Common.StringUtils import CleanString, GetSplitValueList, ReplaceMacro
 import EotGlobalData
-from Common.String import GetSplitList
+from Common.StringUtils import GetSplitList
 from Common.LongFilePathSupport import OpenLongFilePath as open
 
 ## PreProcess() method

BaseTools/Source/Python/GenFds/AprioriSection.py

@@ -21,7 +21,7 @@ import StringIO
 import FfsFileStatement
 from GenFdsGlobalVariable import GenFdsGlobalVariable
 from CommonDataClass.FdfClass import AprioriSectionClassObject
-from Common.String import *
+from Common.StringUtils import *
 from Common.Misc import SaveFileOnChange,PathClass
 from Common import EdkLogger
 from Common.BuildToolError import *

BaseTools/Source/Python/GenFds/FdfParser.py

@@ -48,12 +48,12 @@ from GenFdsGlobalVariable import GenFdsGlobalVariable
 from Common.BuildToolError import *
 from Common import EdkLogger
 from Common.Misc import PathClass
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 import Common.GlobalData as GlobalData
 from Common.Expression import *
 from Common import GlobalData
 from Common.DataType import *
-from Common.String import ReplaceMacro
+from Common.StringUtils import ReplaceMacro
 import uuid
 from Common.Misc import tdict
 from Common.MultipleWorkspace import MultipleWorkspace as mws

BaseTools/Source/Python/GenFds/FfsInfStatement.py

@@ -29,7 +29,7 @@ import RuleSimpleFile
 import RuleComplexFile
 from CommonDataClass.FdfClass import FfsInfStatementClassObject
 from Common.MultipleWorkspace import MultipleWorkspace as mws
-from Common.String import *
+from Common.StringUtils import *
 from Common.Misc import PathClass
 from Common.Misc import GuidStructureByteArrayToGuidString
 from Common.Misc import ProcessDuplicatedInf

BaseTools/Source/Python/GenFds/GenFds.py

@@ -32,7 +32,7 @@ import Common.ToolDefClassObject as ToolDefClassObject
 from Common.DataType import *
 import Common.GlobalData as GlobalData
 from Common import EdkLogger
-from Common.String import *
+from Common.StringUtils import *
 from Common.Misc import DirCache, PathClass
 from Common.Misc import SaveFileOnChange
 from Common.Misc import ClearDuplicatedInf

BaseTools/Source/Python/GenFds/OptRomInfStatement.py

@@ -22,7 +22,7 @@ import OptionRom
 import Common.GlobalData as GlobalData
 
 from Common.DataType import *
-from Common.String import *
+from Common.StringUtils import *
 from FfsInfStatement import FfsInfStatement
 from GenFdsGlobalVariable import GenFdsGlobalVariable
 

BaseTools/Source/Python/Makefile

@@ -46,7 +46,7 @@ COMMON_PYTHON=$(BASE_TOOLS_PATH)\Source\Python\Common\BuildToolError.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\LongFilePathSupport.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\Misc.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\Parsing.py \
-              $(BASE_TOOLS_PATH)\Source\Python\Common\String.py \
+              $(BASE_TOOLS_PATH)\Source\Python\Common\StringUtils.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\TargetTxtClassObject.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\ToolDefClassObject.py \
               $(BASE_TOOLS_PATH)\Source\Python\Common\VpdInfoFile.py \
@@ -167,7 +167,7 @@ CMD_UPT=$(BASE_TOOLS_PATH)\Source\Python\UPT\Core\DependencyRules.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\Misc.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\ParserValidate.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\Parsing.py \
-    $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\String.py \
+    $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\StringUtils.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\UniClassObject.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Library\Xml\XmlRoutines.py \
     $(BASE_TOOLS_PATH)\Source\Python\UPT\Logger\Log.py \

BaseTools/Source/Python/Table/TableDataModel.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import CommonDataClass.DataClass as DataClass
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableDataModel
 #

BaseTools/Source/Python/Table/TableDec.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import CommonDataClass.DataClass as DataClass
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableDec
 #

BaseTools/Source/Python/Table/TableDsc.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import CommonDataClass.DataClass as DataClass
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableDsc
 #

BaseTools/Source/Python/Table/TableEotReport.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import Common.LongFilePathOs as os, time
 from Table import Table
-from Common.String import ConvertToSqlString2
+from Common.StringUtils import ConvertToSqlString2
 import Eot.EotToolError as EotToolError
 import Eot.EotGlobalData as EotGlobalData
 

BaseTools/Source/Python/Table/TableFdf.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import CommonDataClass.DataClass as DataClass
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableFdf
 #

BaseTools/Source/Python/Table/TableFile.py

@@ -16,7 +16,7 @@
 #
 import Common.EdkLogger as EdkLogger
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 import Common.LongFilePathOs as os
 from CommonDataClass.DataClass import FileClass
 

BaseTools/Source/Python/Table/TableFunction.py

@@ -16,7 +16,7 @@
 #
 import Common.EdkLogger as EdkLogger
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableFunction
 #

BaseTools/Source/Python/Table/TableIdentifier.py

@@ -15,7 +15,7 @@
 # Import Modules
 #
 import Common.EdkLogger as EdkLogger
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 from Table import Table
 
 ## TableIdentifier

BaseTools/Source/Python/Table/TableInf.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import CommonDataClass.DataClass as DataClass
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TableInf
 #

BaseTools/Source/Python/Table/TablePcd.py

@@ -16,7 +16,7 @@
 #
 import Common.EdkLogger as EdkLogger
 from Table import Table
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 
 ## TablePcd
 #

BaseTools/Source/Python/Table/TableQuery.py

@@ -15,7 +15,7 @@
 # Import Modules
 #
 import Common.EdkLogger as EdkLogger
-from Common.String import ConvertToSqlString
+from Common.StringUtils import ConvertToSqlString
 from Table import Table
 
 ## TableQuery

BaseTools/Source/Python/Table/TableReport.py

@@ -17,7 +17,7 @@
 import Common.EdkLogger as EdkLogger
 import Common.LongFilePathOs as os, time
 from Table import Table
-from Common.String import ConvertToSqlString2
+from Common.StringUtils import ConvertToSqlString2
 import EccToolError as EccToolError
 import EccGlobalData as EccGlobalData
 from Common.LongFilePathSupport import OpenLongFilePath as open

BaseTools/Source/Python/Workspace/DecBuildData.py

@@ -11,7 +11,7 @@
 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #
-from Common.String import *
+from Common.StringUtils import *
 from Common.DataType import *
 from Common.Misc import *
 from types import *

BaseTools/Source/Python/Workspace/DscBuildData.py

@@ -17,7 +17,7 @@
 #  This class is used to retrieve information stored in database and convert them
 # into PlatformBuildClassObject form for easier use for AutoGen.
 #
-from Common.String import *
+from Common.StringUtils import *
 from Common.DataType import *
 from Common.Misc import *
 from types import *

BaseTools/Source/Python/Workspace/InfBuildData.py

@@ -12,7 +12,7 @@
 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #
 
-from Common.String import *
+from Common.StringUtils import *
 from Common.DataType import *
 from Common.Misc import *
 from types import *

BaseTools/Source/Python/Workspace/MetaFileParser.py

@@ -26,7 +26,7 @@ import Common.GlobalData as GlobalData
 
 from CommonDataClass.DataClass import *
 from Common.DataType import *
-from Common.String import *
+from Common.StringUtils import *
 from Common.Misc import GuidStructureStringToGuidString, CheckPcdDatum, PathClass, AnalyzePcdData, AnalyzeDscPcd, AnalyzePcdExpression, ParseFieldValue
 from Common.Expression import *
 from CommonDataClass.Exceptions import *

BaseTools/Source/Python/Workspace/WorkspaceDatabase.py

@@ -16,7 +16,7 @@
 # Import Modules
 #
 import sqlite3
-from Common.String import *
+from Common.StringUtils import *
 from Common.DataType import *
 from Common.Misc import *
 from types import *

BaseTools/Source/Python/build/BuildReport.py

@@ -42,7 +42,7 @@ from Common.MultipleWorkspace import MultipleWorkspace as mws
 import Common.GlobalData as GlobalData
 from AutoGen.AutoGen import ModuleAutoGen
 from Common.Misc import PathClass
-from Common.String import NormPath
+from Common.StringUtils import NormPath
 from Common.DataType import *
 import collections
 from Common.Expression import *