This patch is going to:

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Library / Parsing.py

diff --git a/BaseTools/Source/Python/UPT/Library/Parsing.py b/BaseTools/Source/Python/UPT/Library/Parsing.py
index 95c51406b22a1c2a7dfabeb48c95974103ad1cd3..db0fec3a73cc04eab10f3b52d5dddd6577a2c235 100644 (file)
--- a/BaseTools/Source/Python/UPT/Library/Parsing.py
+++ b/BaseTools/Source/Python/UPT/Library/Parsing.py
@@ -2,7 +2,7 @@
 # This file is used to define common parsing related functions used in parsing \r
 # INF/DEC/DSC process\r
 #\r
-# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>\r
 #\r
 # This program and the accompanying materials are licensed and made available \r
 # under the terms and conditions of the BSD License which accompanies this \r
@@ -42,6 +42,7 @@ from Logger import StringTable as ST
 import Logger.Log as Logger\r
 \r
 from Parser.DecParser import Dec\r
+import GlobalData\r
 \r
 gPKG_INFO_DICT = {}\r
 \r
@@ -53,7 +54,7 @@ gPKG_INFO_DICT = {}
 # @param String:  String with BuildOption statement\r
 # @param File:    The file which defines build option, used in error report\r
 #\r
-def GetBuildOption(String, File, LineNo=-1):\r
+def GetBuildOption(String, File, LineNo= -1):\r
     (Family, ToolChain, Flag) = ('', '', '')\r
     if String.find(DataType.TAB_EQUAL_SPLIT) < 0:\r
         RaiseParserError(String, 'BuildOptions', File, \\r
@@ -76,7 +77,7 @@ def GetBuildOption(String, File, LineNo=-1):
 # @param ContainerFile:  The file which describes the library class, used for \r
 #                        error report\r
 #\r
-def GetLibraryClass(Item, ContainerFile, WorkspaceDir, LineNo=-1):\r
+def GetLibraryClass(Item, ContainerFile, WorkspaceDir, LineNo= -1):\r
     List = GetSplitValueList(Item[0])\r
     SupMod = DataType.SUP_MODULE_LIST_STRING\r
     if len(List) != 2:\r
@@ -101,7 +102,7 @@ def GetLibraryClass(Item, ContainerFile, WorkspaceDir, LineNo=-1):
 # @param ContainerFile:  The file which describes the library class, used for \r
 #                        error report\r
 #\r
-def GetLibraryClassOfInf(Item, ContainerFile, WorkspaceDir, LineNo = -1):\r
+def GetLibraryClassOfInf(Item, ContainerFile, WorkspaceDir, LineNo= -1):\r
     ItemList = GetSplitValueList((Item[0] + DataType.TAB_VALUE_SPLIT * 2))\r
     SupMod = DataType.SUP_MODULE_LIST_STRING\r
 \r
@@ -131,7 +132,7 @@ def GetLibraryClassOfInf(Item, ContainerFile, WorkspaceDir, LineNo = -1):
 # @param Section:          Used for error report\r
 # @param File:             Used for error report\r
 #\r
-def CheckPcdTokenInfo(TokenInfoString, Section, File, LineNo=-1):\r
+def CheckPcdTokenInfo(TokenInfoString, Section, File, LineNo= -1):\r
     Format = '<TokenSpaceGuidCName>.<PcdCName>'\r
     if TokenInfoString != '' and TokenInfoString != None:\r
         TokenInfoList = GetSplitValueList(TokenInfoString, DataType.TAB_SPLIT)\r
@@ -151,7 +152,7 @@ def CheckPcdTokenInfo(TokenInfoString, Section, File, LineNo=-1):
 #                        report\r
 \r
 #\r
-def GetPcd(Item, Type, ContainerFile, LineNo=-1):\r
+def GetPcd(Item, Type, ContainerFile, LineNo= -1):\r
     TokenGuid, TokenName, Value, MaximumDatumSize, Token = '', '', '', '', ''\r
     List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)\r
 \r
@@ -178,7 +179,7 @@ def GetPcd(Item, Type, ContainerFile, LineNo=-1):
 # @param ContainerFile:  The file which describes the pcd, used for error \r
 #                        report\r
 #\r
-def GetFeatureFlagPcd(Item, Type, ContainerFile, LineNo=-1):\r
+def GetFeatureFlagPcd(Item, Type, ContainerFile, LineNo= -1):\r
     TokenGuid, TokenName, Value = '', '', ''\r
     List = GetSplitValueList(Item)\r
     if len(List) != 2:\r
@@ -202,7 +203,7 @@ def GetFeatureFlagPcd(Item, Type, ContainerFile, LineNo=-1):
 # @param ContainerFile:  The file which describes the pcd, used for error \r
 #                        report\r
 #\r
-def GetDynamicDefaultPcd(Item, Type, ContainerFile, LineNo=-1):\r
+def GetDynamicDefaultPcd(Item, Type, ContainerFile, LineNo= -1):\r
     TokenGuid, TokenName, Value, DatumTyp, MaxDatumSize = '', '', '', '', ''\r
     List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)\r
     if len(List) < 4 or len(List) > 8:\r
@@ -228,7 +229,7 @@ def GetDynamicDefaultPcd(Item, Type, ContainerFile, LineNo=-1):
 # @param ContainerFile:  The file which describes the pcd, used for error \r
 #                        report\r
 #\r
-def GetDynamicHiiPcd(Item, Type, ContainerFile, LineNo = -1):\r
+def GetDynamicHiiPcd(Item, Type, ContainerFile, LineNo= -1):\r
     TokenGuid, TokenName, List1, List2, List3, List4, List5 = \\r
     '', '', '', '', '', '', ''\r
     List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT * 2)\r
@@ -255,7 +256,7 @@ def GetDynamicHiiPcd(Item, Type, ContainerFile, LineNo = -1):
 # @param ContainerFile:  The file which describes the pcd, used for error \r
 #                        report\r
 #\r
-def GetDynamicVpdPcd(Item, Type, ContainerFile, LineNo=-1):\r
+def GetDynamicVpdPcd(Item, Type, ContainerFile, LineNo= -1):\r
     TokenGuid, TokenName, List1, List2 = '', '', '', ''\r
     List = GetSplitValueList(Item + DataType.TAB_VALUE_SPLIT)\r
     if len(List) < 3 or len(List) > 4:\r
@@ -533,7 +534,7 @@ def GetComponents(Lines, KeyValues, CommentCharacter):
 # @param ContainerFile:  The file which describes the library class, used \r
 #                        for error report\r
 #\r
-def GetSource(Item, ContainerFile, FileRelativePath, LineNo=-1):\r
+def GetSource(Item, ContainerFile, FileRelativePath, LineNo= -1):\r
     ItemNew = Item + DataType.TAB_VALUE_SPLIT * 4\r
     List = GetSplitValueList(ItemNew)\r
     if len(List) < 5 or len(List) > 9:\r
@@ -558,7 +559,7 @@ def GetSource(Item, ContainerFile, FileRelativePath, LineNo=-1):
 # @param ContainerFile:  The file which describes the library class, \r
 #                        used for error report\r
 #\r
-def GetBinary(Item, ContainerFile, LineNo=-1):\r
+def GetBinary(Item, ContainerFile, LineNo= -1):\r
     ItemNew = Item + DataType.TAB_VALUE_SPLIT\r
     List = GetSplitValueList(ItemNew)\r
     if len(List) < 3 or len(List) > 5:\r
@@ -596,7 +597,7 @@ def GetGuidsProtocolsPpisOfInf(Item):
 # @param ContainerFile:  The file which describes the library class, \r
 # used for error report\r
 #\r
-def GetGuidsProtocolsPpisOfDec(Item, Type, ContainerFile, LineNo=-1):\r
+def GetGuidsProtocolsPpisOfDec(Item, Type, ContainerFile, LineNo= -1):\r
     List = GetSplitValueList(Item, DataType.TAB_EQUAL_SPLIT)\r
     if len(List) != 2:\r
         RaiseParserError(Item, Type, ContainerFile, '<CName>=<GuidValue>', \\r
@@ -614,7 +615,7 @@ def GetGuidsProtocolsPpisOfDec(Item, Type, ContainerFile, LineNo=-1):
             RegisterFormatGuid = List[1]\r
         else:\r
             RaiseParserError(Item, Type, ContainerFile, \\r
-                             'CFormat or RegisterFormat', LineNo) \r
+                             'CFormat or RegisterFormat', LineNo)\r
 \r
     return (List[0], RegisterFormatGuid)\r
 \r
@@ -627,7 +628,7 @@ def GetGuidsProtocolsPpisOfDec(Item, Type, ContainerFile, LineNo=-1):
 # @param ContainerFile:  The file which describes the library class, \r
 #                        used for error report\r
 #\r
-def GetPackage(Item, ContainerFile, FileRelativePath, LineNo=-1):\r
+def GetPackage(Item, ContainerFile, FileRelativePath, LineNo= -1):\r
     ItemNew = Item + DataType.TAB_VALUE_SPLIT\r
     List = GetSplitValueList(ItemNew)\r
     CheckFileType(List[0], '.Dec', ContainerFile, 'package', List[0], LineNo)\r
@@ -683,7 +684,7 @@ def GetPcdOfInf(Item, Type, File, LineNo):
 # @param File:  Dec file\r
 # @param LineNo:  Line number\r
 #\r
-def GetPcdOfDec(Item, Type, File, LineNo=-1):\r
+def GetPcdOfDec(Item, Type, File, LineNo= -1):\r
     Format = '<TokenSpaceGuidCName>.<PcdCName>|<Value>|<DatumType>|<Token>'\r
     TokenGuid, TokenName, Value, DatumType, Token = '', '', '', '', ''\r
     List = GetSplitValueList(Item)\r
@@ -756,7 +757,7 @@ def InsertSectionItems(Model, SectionItemList, ArchList, \
             LineValue, StartLine, Comment = SectionItem[0], \\r
             SectionItem[1], SectionItem[2]\r
 \r
-            Logger.Debug(4, ST.MSG_PARSING %LineValue)\r
+            Logger.Debug(4, ST.MSG_PARSING % LineValue)\r
             #\r
             # And then parse DEFINE statement\r
             #\r
@@ -782,7 +783,7 @@ def GenMetaDatSectionItem(Key, Value, List):
         List[Key] = [Value]\r
     else:\r
         List[Key].append(Value)\r
-        \r
+\r
 ## GetPkgInfoFromDec\r
 #\r
 # get package name, guid, version info from dec files\r
@@ -793,17 +794,23 @@ def GetPkgInfoFromDec(Path):
     PkgName = None\r
     PkgGuid = None\r
     PkgVersion = None\r
-    \r
+\r
     Path = Path.replace('\\', '/')\r
-    \r
+\r
     if not os.path.exists(Path):\r
-        Logger.Error("\nUPT", FILE_NOT_FOUND, File = Path)  \r
+        Logger.Error("\nUPT", FILE_NOT_FOUND, File=Path)\r
 \r
     if Path in gPKG_INFO_DICT:\r
         return gPKG_INFO_DICT[Path]\r
 \r
     try:\r
-        DecParser = Dec(Path)\r
+        DecParser = None\r
+        if Path not in GlobalData.gPackageDict:\r
+            DecParser = Dec(Path)\r
+            GlobalData.gPackageDict[Path] = DecParser\r
+        else:\r
+            DecParser = GlobalData.gPackageDict[Path]\r
+\r
         PkgName = DecParser.GetPackageName()\r
         PkgGuid = DecParser.GetPackageGuid()\r
         PkgVersion = DecParser.GetPackageVersion()\r
@@ -819,7 +826,7 @@ def GetPkgInfoFromDec(Path):
 #\r
 def GetWorkspacePackage():\r
     DecFileList = []\r
-    WorkspaceDir = os.environ["WORKSPACE"]\r
+    WorkspaceDir = GlobalData.gWORKSPACE\r
     for Root, Dirs, Files in os.walk(WorkspaceDir):\r
         if 'CVS' in Dirs:\r
             Dirs.remove('CVS')\r
@@ -843,7 +850,7 @@ def GetWorkspacePackage():
         (PkgName, PkgGuid, PkgVersion) = GetPkgInfoFromDec(DecFile)\r
         if PkgName and PkgGuid and PkgVersion:\r
             PkgList.append((PkgName, PkgGuid, PkgVersion, DecFile))\r
-    \r
+\r
     return PkgList\r
 \r
 ## GetWorkspaceModule\r
@@ -852,7 +859,7 @@ def GetWorkspacePackage():
 #\r
 def GetWorkspaceModule():\r
     InfFileList = []\r
-    WorkspaceDir = os.environ["WORKSPACE"]\r
+    WorkspaceDir = GlobalData.gWORKSPACE\r
     for Root, Dirs, Files in os.walk(WorkspaceDir):\r
         if 'CVS' in Dirs:\r
             Dirs.remove('CVS')\r
@@ -870,7 +877,7 @@ def GetWorkspaceModule():
             if Ext.lower() in ['.inf']:\r
                 InfFileList.append\\r
                 (os.path.normpath(os.path.join(Root, FileSp)))\r
-    \r
+\r
     return InfFileList\r
 \r
 ## MacroParser used to parse macro definition\r
@@ -890,7 +897,7 @@ def MacroParser(Line, FileName, SectionType, FileLocalMacros):
         # Not 'DEFINE/EDK_GLOBAL' statement, call decorated method\r
         #\r
         return None, None\r
-    \r
+\r
     TokenList = GetSplitValueList(LineContent[Match.end(1):], \\r
                                   DataType.TAB_EQUAL_SPLIT, 1)\r
     #\r
@@ -910,16 +917,16 @@ def MacroParser(Line, FileName, SectionType, FileLocalMacros):
     #\r
     if SectionType == DataType.MODEL_META_DATA_HEADER:\r
         FileLocalMacros[Name] = Value\r
-    \r
+\r
     ReIsValidMacroName = re.compile(r"^[A-Z][A-Z0-9_]*$", re.DOTALL)\r
     if ReIsValidMacroName.match(Name) == None:\r
-        Logger.Error('Parser', \r
-                     FORMAT_INVALID, \r
-                     ST.ERR_MACRONAME_INVALID%(Name),\r
-                     ExtraData=LineContent, \r
-                     File=FileName, \r
+        Logger.Error('Parser',\r
+                     FORMAT_INVALID,\r
+                     ST.ERR_MACRONAME_INVALID % (Name),\r
+                     ExtraData=LineContent,\r
+                     File=FileName,\r
                      Line=LineNo)\r
-        \r
+\r
     # Validate MACRO Value\r
     #\r
     # <MacroDefinition> ::=  [<Comments>]{0,}\r
@@ -932,13 +939,13 @@ def MacroParser(Line, FileName, SectionType, FileLocalMacros):
     #\r
     ReIsValidMacroValue = re.compile(r"^[\x20-\x7e]*$", re.DOTALL)\r
     if ReIsValidMacroValue.match(Value) == None:\r
-        Logger.Error('Parser', \r
-                     FORMAT_INVALID, \r
-                     ST.ERR_MACROVALUE_INVALID%(Value),\r
-                     ExtraData=LineContent, \r
-                     File=FileName, \r
+        Logger.Error('Parser',\r
+                     FORMAT_INVALID,\r
+                     ST.ERR_MACROVALUE_INVALID % (Value),\r
+                     ExtraData=LineContent,\r
+                     File=FileName,\r
                      Line=LineNo)\r
-        \r
+\r
     return Name, Value\r
 \r
 ## GenSection \r
@@ -952,7 +959,7 @@ def MacroParser(Line, FileName, SectionType, FileLocalMacros):
 #                       seperated by space, \r
 #                       value is statement\r
 #\r
-def GenSection(SectionName, SectionDict, SplitArch=True):\r
+def GenSection(SectionName, SectionDict, SplitArch=True, NeedBlankLine=False):\r
     Content = ''\r
     for SectionAttrs in SectionDict:\r
         StatementList = SectionDict[SectionAttrs]\r
@@ -969,11 +976,29 @@ def GenSection(SectionName, SectionDict, SplitArch=True):
             Section = '[' + SectionName + '.' + (', ' + SectionName + '.').join(ArchList) + ']'\r
         else:\r
             Section = '[' + SectionName + ']'\r
-        Content += '\n\n' + Section + '\n'\r
+        Content += '\n' + Section + '\n'\r
         if StatementList != None:\r
             for Statement in StatementList:\r
-                Content += Statement + '\n'\r
+                LineList = Statement.split('\n')\r
+                NewStatement = ""\r
+                for Line in LineList:\r
+                    # ignore blank comment\r
+                    if not Line.replace("#", '').strip() and SectionName != 'Defines':\r
+                        continue\r
+                    # add two space before non-comments line except the comments in Defines section\r
+                    if Line.strip().startswith('#') and SectionName == 'Defines':\r
+                        NewStatement += "%s\n" % Line\r
+                        continue\r
+                    NewStatement += "  %s\n" % Line\r
+                if NeedBlankLine:\r
+                    Content += NewStatement + '\n'\r
+                else:\r
+                    Content += NewStatement\r
 \r
+        if NeedBlankLine:\r
+            Content = Content[:-1]\r
+    if not Content.replace('\\n', '').strip():\r
+        return ''\r
     return Content\r
 \r
 ## ConvertArchForInstall\r
@@ -984,10 +1009,10 @@ def GenSection(SectionName, SectionDict, SplitArch=True):
 # @return: the arch string that get converted\r
 #\r
 def ConvertArchForInstall(Arch):\r
-    if Arch.upper() in [DataType.TAB_ARCH_IA32, DataType.TAB_ARCH_X64, \r
+    if Arch.upper() in [DataType.TAB_ARCH_IA32, DataType.TAB_ARCH_X64,\r
                                    DataType.TAB_ARCH_IPF, DataType.TAB_ARCH_EBC]:\r
         Arch = Arch.upper()\r
     elif Arch.upper() == DataType.TAB_ARCH_COMMON:\r
         Arch = Arch.lower()\r
-    \r
+\r
     return Arch\r