]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Ecc/MetaFileWorkspace/MetaFileParser.py
BaseTools: Clean up source files
[mirror_edk2.git] / BaseTools / Source / Python / Ecc / MetaFileWorkspace / MetaFileParser.py
index a41223f285fffcd39d0f1d4e9125a787ca24abcf..111a25ed92603fd988ef63895d786fda3d93ad81 100644 (file)
@@ -92,7 +92,7 @@ def ParseMacro(Parser):
         elif (Name in self._FileLocalMacros) and (self._FileLocalMacros[Name] != Value):\r
             EdkLogger.error('Parser', FORMAT_INVALID, "EDK_GLOBAL defined a macro with the same name and different value as one defined by 'DEFINE'",\r
                             ExtraData=self._CurrentLine, File=self.MetaFile, Line=self._LineIndex+1)\r
-            \r
+\r
         self._ValueList = [Type, Name, Value]\r
 \r
     return MacroParser\r
@@ -334,7 +334,7 @@ class MetaFileParser(object):
 \r
         self._ValueList = [ReplaceMacro(Value, self._Macros) for Value in self._ValueList]\r
         Name, Value = self._ValueList[1], self._ValueList[2]\r
-        # Sometimes, we need to make differences between EDK and EDK2 modules \r
+        # Sometimes, we need to make differences between EDK and EDK2 modules\r
         if Name == 'INF_VERSION':\r
             try:\r
                 self._Version = int(Value, 0)\r
@@ -354,7 +354,7 @@ class MetaFileParser(object):
             UniFile = os.path.join(os.path.dirname(self.MetaFile), Value)\r
             if os.path.exists(UniFile):\r
                 self._UniObj = UniParser(UniFile, IsExtraUni=False, IsModuleUni=False)\r
-        \r
+\r
         if isinstance(self, InfParser) and self._Version < 0x00010005:\r
             # EDK module allows using defines as macros\r
             self._FileLocalMacros[Name] = Value\r
@@ -390,7 +390,7 @@ class MetaFileParser(object):
         return Macros\r
 \r
 \r
-    ## Get section Macros that are applicable to current line, which may come from other sections \r
+    ## Get section Macros that are applicable to current line, which may come from other sections\r
     ## that share the same name while scope is wider\r
     def _GetApplicableSectionMacro(self):\r
         Macros = {}\r
@@ -473,7 +473,7 @@ class InfParser(MetaFileParser):
             self.FileID = FileID\r
         else:\r
             self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_INF)\r
-            \r
+\r
         # parse the file line by line\r
         IsFindBlockComment = False\r
 \r
@@ -591,7 +591,7 @@ class InfParser(MetaFileParser):
                             )\r
             Usage = ''\r
         if IsFindBlockComment:\r
-            EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */", \r
+            EdkLogger.error("Parser", FORMAT_INVALID, "Open block comments (starting with /*) are expected to end with */",\r
                             File=self.MetaFile)\r
         self._Done()\r
 \r
@@ -818,7 +818,7 @@ class DscParser(MetaFileParser):
         #  the owner item\r
         #\r
         self._IdMapping = {-1:-1}\r
-        \r
+\r
         self.TblFile = EccGlobalData.gDb.TblFile\r
         self.FileID = -1\r
 \r
@@ -838,8 +838,8 @@ class DscParser(MetaFileParser):
             self.FileID = FileID\r
         else:\r
             self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_DSC)\r
-        \r
-        \r
+\r
+\r
         for Index in range(0, len(Content)):\r
             Line = CleanString(Content[Index])\r
             # skip empty line\r
@@ -850,7 +850,7 @@ class DscParser(MetaFileParser):
             self._LineIndex = Index\r
             if self._InSubsection and self._Owner[-1] == -1:\r
                 self._Owner.append(self._LastItem)\r
-            \r
+\r
             # section header\r
             if Line[0] == TAB_SECTION_START and Line[-1] == TAB_SECTION_END:\r
                 self._SectionType = MODEL_META_DATA_SECTION_HEADER\r
@@ -960,7 +960,7 @@ class DscParser(MetaFileParser):
         elif self._From > 0:\r
             EdkLogger.error('Parser', FORMAT_INVALID,\r
                             "No '!include' allowed in included file",\r
-                            ExtraData=self._CurrentLine, File=self.MetaFile, \r
+                            ExtraData=self._CurrentLine, File=self.MetaFile,\r
                             Line=self._LineIndex+1)\r
 \r
         #\r
@@ -1154,7 +1154,7 @@ class DscParser(MetaFileParser):
             MODEL_META_DATA_USER_EXTENSION                  :   self._Skip,\r
             MODEL_META_DATA_CONDITIONAL_STATEMENT_ERROR     :   self._Skip,\r
         }\r
-        \r
+\r
         self._RawTable = self._Table\r
         self._Table = MetaFileStorage(self._RawTable.Cur, self.MetaFile, MODEL_FILE_DSC, True)\r
         self._DirectiveStack = []\r
@@ -1184,7 +1184,7 @@ class DscParser(MetaFileParser):
             try:\r
                 Processer[self._ItemType]()\r
             except EvaluationException as Excpt:\r
-                # \r
+                #\r
                 # Only catch expression evaluation error here. We need to report\r
                 # the precise number of line on which the error occurred\r
                 #\r
@@ -1194,11 +1194,11 @@ class DscParser(MetaFileParser):
 #                                 Line=self._LineIndex+1)\r
             except MacroException as Excpt:\r
                 EdkLogger.error('Parser', FORMAT_INVALID, str(Excpt),\r
-                                File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
+                                File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
                                 Line=self._LineIndex+1)\r
 \r
             if self._ValueList is None:\r
-                continue \r
+                continue\r
 \r
             NewOwner = self._IdMapping.get(Owner, -1)\r
             self._Enabled = int((not self._DirectiveEvalStack) or (False not in self._DirectiveEvalStack))\r
@@ -1221,7 +1221,7 @@ class DscParser(MetaFileParser):
             self._IdMapping[Id] = self._LastItem\r
 \r
         RecordList = self._Table.GetAll()\r
-        \r
+\r
         self._RawTable.Drop()\r
         self._Table.Drop()\r
         for Record in RecordList:\r
@@ -1255,7 +1255,7 @@ class DscParser(MetaFileParser):
             # Don't use PCD with different values.\r
             if Name in self._Symbols and self._Symbols[Name] != Value:\r
                 self._Symbols.pop(Name)\r
-                continue \r
+                continue\r
             self._Symbols[Name] = Value\r
 \r
         Records = self._RawTable.Query(MODEL_PCD_FIXED_AT_BUILD, BelongsToItem=-1.0)\r
@@ -1263,12 +1263,12 @@ class DscParser(MetaFileParser):
             Value, DatumType, MaxDatumSize = AnalyzePcdData(Value)\r
             # Only use PCD whose value is straitforward (no macro and PCD)\r
             if self.SymbolPattern.findall(Value):\r
-                continue \r
+                continue\r
             Name = TokenSpaceGuid+'.'+PcdName\r
             # Don't use PCD with different values.\r
             if Name in self._Symbols and self._Symbols[Name] != Value:\r
                 self._Symbols.pop(Name)\r
-                continue \r
+                continue\r
             self._Symbols[Name] = Value\r
 \r
     def __ProcessDefine(self):\r
@@ -1288,13 +1288,13 @@ class DscParser(MetaFileParser):
                 SectionLocalMacros[Name] = Value\r
         elif self._ItemType == MODEL_META_DATA_GLOBAL_DEFINE:\r
             GlobalData.gEdkGlobal[Name] = Value\r
-        \r
+\r
         #\r
         # Keyword in [Defines] section can be used as Macros\r
         #\r
         if (self._ItemType == MODEL_META_DATA_HEADER) and (self._SectionType == MODEL_META_DATA_HEADER):\r
             self._FileLocalMacros[Name] = Value\r
-            \r
+\r
         self._ValueList = [Type, Name, Value]\r
 \r
     def __ProcessDirective(self):\r
@@ -1309,12 +1309,12 @@ class DscParser(MetaFileParser):
                 EdkLogger.debug(EdkLogger.DEBUG_5, str(Exc), self._ValueList[1])\r
                 Result = False\r
             except WrnExpression as Excpt:\r
-                # \r
+                #\r
                 # Catch expression evaluation warning here. We need to report\r
                 # the precise number of line and return the evaluation result\r
                 #\r
                 EdkLogger.warn('Parser', "Suspicious expression: %s" % str(Excpt),\r
-                                File=self._FileWithError, ExtraData=' '.join(self._ValueList), \r
+                                File=self._FileWithError, ExtraData=' '.join(self._ValueList),\r
                                 Line=self._LineIndex+1)\r
                 Result = Excpt.result\r
             except BadExpression as Exc:\r
@@ -1365,14 +1365,14 @@ class DscParser(MetaFileParser):
             #\r
             elif "ECP_SOURCE" in GlobalData.gCommandLineDefines.keys():\r
                 __IncludeMacros['ECP_SOURCE'] = GlobalData.gCommandLineDefines['ECP_SOURCE']\r
-                \r
+\r
             __IncludeMacros['EFI_SOURCE'] = GlobalData.gGlobalDefines['EFI_SOURCE']\r
             __IncludeMacros['EDK_SOURCE'] = GlobalData.gGlobalDefines['EDK_SOURCE']\r
             #\r
-            # Allow using MACROs comes from [Defines] section to keep compatible. \r
+            # Allow using MACROs comes from [Defines] section to keep compatible.\r
             #\r
             __IncludeMacros.update(self._Macros)\r
-            \r
+\r
             IncludedFile = NormPath(ReplaceMacro(self._ValueList[1], __IncludeMacros, RaiseError=True))\r
             #\r
             # First search the include file under the same directory as DSC file\r
@@ -1386,14 +1386,14 @@ class DscParser(MetaFileParser):
                 IncludedFile1 = PathClass(IncludedFile, GlobalData.gWorkspace)\r
                 ErrorCode, ErrorInfo2 = IncludedFile1.Validate()\r
                 if ErrorCode != 0:\r
-                    EdkLogger.error('parser', ErrorCode, File=self._FileWithError, \r
+                    EdkLogger.error('parser', ErrorCode, File=self._FileWithError,\r
                                     Line=self._LineIndex+1, ExtraData=ErrorInfo1 + "\n"+ ErrorInfo2)\r
 \r
             self._FileWithError = IncludedFile1\r
 \r
             IncludedFileTable = MetaFileStorage(self._Table.Cur, IncludedFile1, MODEL_FILE_DSC, True)\r
             Owner = self._Content[self._ContentIndex-1][0]\r
-            Parser = DscParser(IncludedFile1, self._FileType, IncludedFileTable, \r
+            Parser = DscParser(IncludedFile1, self._FileType, IncludedFileTable,\r
                                Owner=Owner, From=Owner)\r
 \r
             # set the parser status with current status\r
@@ -1417,7 +1417,7 @@ class DscParser(MetaFileParser):
                 self._Content.pop(self._ContentIndex-1)\r
                 self._ValueList = None\r
                 self._ContentIndex -= 1\r
-                \r
+\r
     def __ProcessSkuId(self):\r
         self._ValueList = [ReplaceMacro(Value, self._Macros, RaiseError=True)\r
                            for Value in self._ValueList]\r
@@ -1434,22 +1434,22 @@ class DscParser(MetaFileParser):
         # PCD value can be an expression\r
         #\r
         if len(ValueList) > 1 and ValueList[1] == TAB_VOID:\r
-            PcdValue = ValueList[0]      \r
+            PcdValue = ValueList[0]\r
             try:\r
                 ValueList[0] = ValueExpression(PcdValue, self._Macros)(True)\r
             except WrnExpression as Value:\r
-                ValueList[0] = Value.result          \r
+                ValueList[0] = Value.result\r
         else:\r
             PcdValue = ValueList[-1]\r
             try:\r
                 ValueList[-1] = ValueExpression(PcdValue, self._Macros)(True)\r
             except WrnExpression as Value:\r
                 ValueList[-1] = Value.result\r
-            \r
+\r
             if ValueList[-1] == 'True':\r
                 ValueList[-1] = '1'\r
             if ValueList[-1] == 'False':\r
-                ValueList[-1] = '0'      \r
+                ValueList[-1] = '0'\r
 \r
         self._ValueList[2] = '|'.join(ValueList)\r
 \r
@@ -1548,7 +1548,7 @@ class DecParser(MetaFileParser):
             self.FileID = FileID\r
         else:\r
             self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_DEC)\r
-        \r
+\r
         for Index in range(0, len(Content)):\r
             Line, Comment = CleanString2(Content[Index])\r
             self._CurrentLine = Line\r
@@ -1750,19 +1750,19 @@ class DecParser(MetaFileParser):
                                       " (<TokenSpaceGuidCName>.<PcdCName>|<DefaultValue>|<DatumType>|<Token>)",\r
                             File=self.MetaFile, Line=self._LineIndex+1)\r
 \r
-        \r
+\r
         ValueRe  = re.compile(r'^\s*L?\".*\|.*\"')\r
         PtrValue = ValueRe.findall(TokenList[1])\r
-        \r
-        # Has VOID* type string, may contain "|" character in the string. \r
+\r
+        # Has VOID* type string, may contain "|" character in the string.\r
         if len(PtrValue) != 0:\r
             ptrValueList = re.sub(ValueRe, '', TokenList[1])\r
             ValueList    = GetSplitValueList(ptrValueList)\r
             ValueList[0] = PtrValue[0]\r
         else:\r
             ValueList = GetSplitValueList(TokenList[1])\r
-            \r
-        \r
+\r
+\r
         # check if there's enough datum information given\r
         if len(ValueList) != 3:\r
             EdkLogger.error('Parser', FORMAT_INVALID, "Invalid PCD Datum information given",\r
@@ -1792,7 +1792,7 @@ class DecParser(MetaFileParser):
         if not IsValid:\r
             EdkLogger.error('Parser', FORMAT_INVALID, Cause, ExtraData=self._CurrentLine,\r
                             File=self.MetaFile, Line=self._LineIndex+1)\r
-        \r
+\r
         if EccGlobalData.gConfig.UniCheckPCDInfo == '1' or EccGlobalData.gConfig.UniCheckAll == '1' or EccGlobalData.gConfig.CheckAll == '1':\r
             # check Description, Prompt information\r
             PatternDesc = re.compile('##\s*([\x21-\x7E\s]*)', re.S)\r
@@ -1903,7 +1903,7 @@ class DecParser(MetaFileParser):
 ## Fdf\r
 #\r
 # This class defined the structure used in Fdf object\r
-# \r
+#\r
 # @param Filename:      Input value for Ffilename of Fdf file, default is None\r
 # @param WorkspaceDir:  Input value for current workspace directory, default is None\r
 #\r
@@ -1911,7 +1911,7 @@ class Fdf(object):
     def __init__(self, Filename = None, IsToDatabase = False, WorkspaceDir = None, Database = None):\r
         self.WorkspaceDir = WorkspaceDir\r
         self.IsToDatabase = IsToDatabase\r
-        \r
+\r
         self.Cur = Database.Cur\r
         self.TblFile = Database.TblFile\r
         self.TblFdf = Database.TblFdf\r
@@ -1938,15 +1938,15 @@ class Fdf(object):
             self.FileList[Filename] = FileID\r
 \r
         return self.FileList[Filename]\r
-            \r
-    \r
+\r
+\r
     ## Load Fdf file\r
     #\r
     # Load the file if it exists\r
     #\r
     # @param Filename:  Input value for filename of Fdf file\r
     #\r
-    def LoadFdfFile(self, Filename):     \r
+    def LoadFdfFile(self, Filename):\r
         FileList = []\r
         #\r
         # Parse Fdf file\r
@@ -1991,7 +1991,7 @@ class UniParser(object):
         self.FileIn = None\r
         self.Missing = []\r
         self.__read()\r
-    \r
+\r
     def __read(self):\r
         try:\r
             self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_8').read()\r
@@ -2001,7 +2001,7 @@ class UniParser(object):
             self.FileIn = CodecOpenLongFilePath(self.FilePath, Mode='rb', Encoding='utf_16_le').read()\r
         except IOError:\r
             self.FileIn = ""\r
-    \r
+\r
     def Start(self):\r
         if self.IsModuleUni:\r
             if self.IsExtraUni:\r
@@ -2021,7 +2021,7 @@ class UniParser(object):
                 self.PrintLog('STR_PACKAGE_ABSTRACT', PackageAbstract)\r
                 PackageDescription = self.CheckKeyValid('STR_PACKAGE_DESCRIPTION')\r
                 self.PrintLog('STR_PACKAGE_DESCRIPTION', PackageDescription)\r
-                \r
+\r
     def CheckKeyValid(self, Key, Contents=None):\r
         if not Contents:\r
             Contents = self.FileIn\r
@@ -2029,7 +2029,7 @@ class UniParser(object):
         if KeyPattern.search(Contents):\r
             return True\r
         return False\r
-    \r
+\r
     def CheckPcdInfo(self, PcdCName):\r
         PromptKey = 'STR_%s_PROMPT' % PcdCName.replace('.', '_')\r
         PcdPrompt = self.CheckKeyValid(PromptKey)\r
@@ -2037,7 +2037,7 @@ class UniParser(object):
         HelpKey = 'STR_%s_HELP' % PcdCName.replace('.', '_')\r
         PcdHelp = self.CheckKeyValid(HelpKey)\r
         self.PrintLog(HelpKey, PcdHelp)\r
-    \r
+\r
     def PrintLog(self, Key, Value):\r
         if not Value and Key not in self.Missing:\r
             Msg = '%s is missing in the %s file.' % (Key, self.FileName)\r