]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/BuildEngine.py
BaseTools: AutoGen - refactor function to remove extra variables
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / BuildEngine.py
index b3083d0395f3f692e27f2156302029112b605108..dd6301b01fce4dc3499b7847ae2b0a43631ae8c5 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 # The engine for building files\r
 #\r
-# Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\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
 ##\r
 # Import Modules\r
 #\r
-import os\r
+import Common.LongFilePathOs as os\r
 import re\r
 import copy\r
 import string\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
 \r
 from Common.GlobalData import *\r
 from Common.BuildToolError import *\r
@@ -46,21 +47,10 @@ def ListFileMacro(FileType):
     return "%s_LIST" % FileListMacro(FileType)\r
 \r
 class TargetDescBlock(object):\r
-    _Cache_ = {}    # {TargetFile : TargetDescBlock object}\r
-\r
-    # Factory method\r
-    def __new__(Class, Inputs, Outputs, Commands, Dependencies):\r
-        if Outputs[0] in Class._Cache_:\r
-            Tdb = Class._Cache_[Outputs[0]]\r
-            for File in Inputs:\r
-                Tdb.AddInput(File)\r
-        else:\r
-            Tdb = super(TargetDescBlock, Class).__new__(Class)\r
-            Tdb._Init(Inputs, Outputs, Commands, Dependencies)\r
-            #Class._Cache_[Outputs[0]] = Tdb\r
-        return Tdb\r
+    def __init__(self, Inputs, Outputs, Commands, Dependencies):\r
+        self.InitWorker(Inputs, Outputs, Commands, Dependencies)\r
 \r
-    def _Init(self, Inputs, Outputs, Commands, Dependencies):\r
+    def InitWorker(self, Inputs, Outputs, Commands, Dependencies):\r
         self.Inputs = Inputs\r
         self.Outputs = Outputs\r
         self.Commands = Commands\r
@@ -89,10 +79,6 @@ class TargetDescBlock(object):
     def IsMultipleInput(self):\r
         return len(self.Inputs) > 1\r
 \r
-    @staticmethod\r
-    def Renew():\r
-        TargetDescBlock._Cache_ = {}\r
-\r
 ## Class for one build rule\r
 #\r
 # This represents a build rule which can give out corresponding command list for\r
@@ -160,7 +146,7 @@ class FileBuildRule:
 \r
         # Check input files\r
         self.IsMultipleInput = False\r
-        self.SourceFileExtList = []\r
+        self.SourceFileExtList = set()\r
         for File in Input:\r
             Base, Ext = os.path.splitext(File)\r
             if Base.find("*") >= 0:\r
@@ -171,8 +157,7 @@ class FileBuildRule:
                 # There's no "*" and "?" in file name\r
                 self.ExtraSourceFileList.append(File)\r
                 continue\r
-            if Ext not in self.SourceFileExtList:\r
-                self.SourceFileExtList.append(Ext)\r
+            self.SourceFileExtList.add(Ext)\r
 \r
         # Check output files\r
         self.DestFileList = []\r
@@ -193,16 +178,6 @@ class FileBuildRule:
         CommandString = "\n\t".join(self.CommandList)\r
         return "%s : %s\n\t%s" % (DestString, SourceString, CommandString)\r
 \r
-    ## Check if given file extension is supported by this rule\r
-    #\r
-    #   @param  FileExt     The extension of a file\r
-    #\r
-    #   @retval True        If the extension is supported\r
-    #   @retval False       If the extension is not supported\r
-    #\r
-    def IsSupported(self, FileExt):\r
-        return FileExt in self.SourceFileExtList\r
-\r
     def Instantiate(self, Macros={}):\r
         NewRuleObject = copy.copy(self)\r
         NewRuleObject.BuildTargets = {}\r
@@ -219,7 +194,7 @@ class FileBuildRule:
     #\r
     #   @retval     tuple       (Source file in full path, List of individual sourcefiles, Destionation file, List of build commands)\r
     #\r
-    def Apply(self, SourceFile):\r
+    def Apply(self, SourceFile, BuildRuleOrder=None):\r
         if not self.CommandList or not self.DestFileList:\r
             return None\r
 \r
@@ -280,13 +255,20 @@ class FileBuildRule:
 \r
         if DstFile[0] in self.BuildTargets:\r
             TargetDesc = self.BuildTargets[DstFile[0]]\r
-            TargetDesc.AddInput(SourceFile)\r
+            if BuildRuleOrder and SourceFile.Ext in BuildRuleOrder:\r
+                Index = BuildRuleOrder.index(SourceFile.Ext)\r
+                for Input in TargetDesc.Inputs:\r
+                    if Input.Ext not in BuildRuleOrder or BuildRuleOrder.index(Input.Ext) > Index:\r
+                        #\r
+                        # Command line should be regenerated since some macros are different\r
+                        #\r
+                        CommandList = self._BuildCommand(BuildRulePlaceholderDict)\r
+                        TargetDesc.InitWorker([SourceFile], DstFile, CommandList, self.ExtraSourceFileList)\r
+                        break\r
+            else:\r
+                TargetDesc.AddInput(SourceFile)\r
         else:\r
-            CommandList = []\r
-            for CommandString in self.CommandList:\r
-                CommandString = string.Template(CommandString).safe_substitute(BuildRulePlaceholderDict)\r
-                CommandString = string.Template(CommandString).safe_substitute(BuildRulePlaceholderDict)\r
-                CommandList.append(CommandString)\r
+            CommandList = self._BuildCommand(BuildRulePlaceholderDict)\r
             TargetDesc = TargetDescBlock([SourceFile], DstFile, CommandList, self.ExtraSourceFileList)\r
             TargetDesc.ListFileMacro = self.ListFileMacro\r
             TargetDesc.FileListMacro = self.FileListMacro\r
@@ -297,6 +279,14 @@ class FileBuildRule:
             self.BuildTargets[DstFile[0]] = TargetDesc\r
         return TargetDesc\r
 \r
+    def _BuildCommand(self, Macros):\r
+        CommandList = []\r
+        for CommandString in self.CommandList:\r
+            CommandString = string.Template(CommandString).safe_substitute(Macros)\r
+            CommandString = string.Template(CommandString).safe_substitute(Macros)\r
+            CommandList.append(CommandString)\r
+        return CommandList\r
+\r
 ## Class for build rules\r
 #\r
 # BuildRule class parses rules defined in a file or passed by caller, and converts\r
@@ -330,12 +320,12 @@ class BuildRule:
     def __init__(self, File=None, Content=None, LineIndex=0, SupportedFamily=["MSFT", "INTEL", "GCC", "RVCT"]):\r
         self.RuleFile = File\r
         # Read build rules from file if it's not none\r
-        if File != None:\r
+        if File is not None:\r
             try:\r
                 self.RuleContent = open(File, 'r').readlines()\r
             except:\r
                 EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=File)\r
-        elif Content != None:\r
+        elif Content is not None:\r
             self.RuleContent = Content\r
         else:\r
             EdkLogger.error("build", PARAMETER_MISSING, ExtraData="No rule file or string given")\r
@@ -349,8 +339,8 @@ class BuildRule:
         self._State = ""\r
         self._RuleInfo = tdict(True, 2)     # {toolchain family : {"InputFile": {}, "OutputFile" : [], "Command" : []}}\r
         self._FileType = ''\r
-        self._BuildTypeList = []\r
-        self._ArchList = []\r
+        self._BuildTypeList = set()\r
+        self._ArchList = set()\r
         self._FamilyList = []\r
         self._TotalToolChainFamilySet = set()\r
         self._RuleObjectList = [] # FileBuildRule object list\r
@@ -359,7 +349,7 @@ class BuildRule:
         self.Parse()\r
 \r
         # some intrinsic rules\r
-        self.RuleDatabase[TAB_DEFAULT_BINARY_FILE, "COMMON", "COMMON", "COMMON"] = self._BinaryFileRule\r
+        self.RuleDatabase[TAB_DEFAULT_BINARY_FILE, TAB_COMMON, TAB_COMMON, TAB_COMMON] = self._BinaryFileRule\r
         self.FileTypeList.add(TAB_DEFAULT_BINARY_FILE)\r
 \r
     ## Parse the build rule strings\r
@@ -372,7 +362,7 @@ class BuildRule:
             \r
             # find the build_rule_version\r
             if Line and Line[0] == "#" and Line.find(TAB_BUILD_RULE_VERSION) <> -1:\r
-                if Line.find("=") <> -1 and Line.find("=") < (len(Line)-1) and (Line[(Line.find("=") + 1):]).split():\r
+                if Line.find("=") <> -1 and Line.find("=") < (len(Line) - 1) and (Line[(Line.find("=") + 1):]).split():\r
                     self._FileVersion = (Line[(Line.find("=") + 1):]).split()[0]\r
             # skip empty or comment line\r
             if Line == "" or Line[0] == "#":\r
@@ -419,8 +409,8 @@ class BuildRule:
     def EndOfSection(self):\r
         Database = self.RuleDatabase\r
         # if there's specific toochain family, 'COMMON' doesn't make sense any more\r
-        if len(self._TotalToolChainFamilySet) > 1 and 'COMMON' in self._TotalToolChainFamilySet:\r
-            self._TotalToolChainFamilySet.remove('COMMON')\r
+        if len(self._TotalToolChainFamilySet) > 1 and TAB_COMMON in self._TotalToolChainFamilySet:\r
+            self._TotalToolChainFamilySet.remove(TAB_COMMON)\r
         for Family in self._TotalToolChainFamilySet:\r
             Input = self._RuleInfo[Family, self._InputFile]\r
             Output = self._RuleInfo[Family, self._OutputFile]\r
@@ -440,30 +430,30 @@ class BuildRule:
     #\r
     def ParseSectionHeader(self, LineIndex):\r
         self._RuleInfo = tdict(True, 2)\r
-        self._BuildTypeList = []\r
-        self._ArchList = []\r
+        self._BuildTypeList = set()\r
+        self._ArchList = set()\r
         self._FamilyList = []\r
         self._TotalToolChainFamilySet = set()\r
         FileType = ''\r
         RuleNameList = self.RuleContent[LineIndex][1:-1].split(',')\r
         for RuleName in RuleNameList:\r
-            Arch = 'COMMON'\r
-            BuildType = 'COMMON'\r
+            Arch = TAB_COMMON\r
+            BuildType = TAB_COMMON\r
             TokenList = [Token.strip().upper() for Token in RuleName.split('.')]\r
             # old format: Build.File-Type\r
             if TokenList[0] == "BUILD":\r
                 if len(TokenList) == 1:\r
                     EdkLogger.error("build", FORMAT_INVALID, "Invalid rule section",\r
-                                    File=self.RuleFile, Line=LineIndex+1,\r
+                                    File=self.RuleFile, Line=LineIndex + 1,\r
                                     ExtraData=self.RuleContent[LineIndex])\r
 \r
                 FileType = TokenList[1]\r
                 if FileType == '':\r
                     EdkLogger.error("build", FORMAT_INVALID, "No file type given",\r
-                                    File=self.RuleFile, Line=LineIndex+1,\r
+                                    File=self.RuleFile, Line=LineIndex + 1,\r
                                     ExtraData=self.RuleContent[LineIndex])\r
-                if self._FileTypePattern.match(FileType) == None:\r
-                    EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex+1,\r
+                if self._FileTypePattern.match(FileType) is None:\r
+                    EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex + 1,\r
                                     ExtraData="Only character, number (non-first character), '_' and '-' are allowed in file type")\r
             # new format: File-Type.Build-Type.Arch\r
             else:\r
@@ -472,26 +462,24 @@ class BuildRule:
                 elif FileType != TokenList[0]:\r
                     EdkLogger.error("build", FORMAT_INVALID,\r
                                     "Different file types are not allowed in the same rule section",\r
-                                    File=self.RuleFile, Line=LineIndex+1,\r
+                                    File=self.RuleFile, Line=LineIndex + 1,\r
                                     ExtraData=self.RuleContent[LineIndex])\r
                 if len(TokenList) > 1:\r
                     BuildType = TokenList[1]\r
                 if len(TokenList) > 2:\r
                     Arch = TokenList[2]\r
-            if BuildType not in self._BuildTypeList:\r
-                self._BuildTypeList.append(BuildType)\r
-            if Arch not in self._ArchList:\r
-                self._ArchList.append(Arch)\r
+            self._BuildTypeList.add(BuildType)\r
+            self._ArchList.add(Arch)\r
 \r
-        if 'COMMON' in self._BuildTypeList and len(self._BuildTypeList) > 1:\r
+        if TAB_COMMON in self._BuildTypeList and len(self._BuildTypeList) > 1:\r
             EdkLogger.error("build", FORMAT_INVALID,\r
                             "Specific build types must not be mixed with common one",\r
-                            File=self.RuleFile, Line=LineIndex+1,\r
+                            File=self.RuleFile, Line=LineIndex + 1,\r
                             ExtraData=self.RuleContent[LineIndex])\r
-        if 'COMMON' in self._ArchList and len(self._ArchList) > 1:\r
+        if TAB_COMMON in self._ArchList and len(self._ArchList) > 1:\r
             EdkLogger.error("build", FORMAT_INVALID,\r
                             "Specific ARCH must not be mixed with common one",\r
-                            File=self.RuleFile, Line=LineIndex+1,\r
+                            File=self.RuleFile, Line=LineIndex + 1,\r
                             ExtraData=self.RuleContent[LineIndex])\r
 \r
         self._FileType = FileType\r
@@ -515,13 +503,13 @@ class BuildRule:
             elif SectionType != Type:\r
                 EdkLogger.error("build", FORMAT_INVALID,\r
                                 "Two different section types are not allowed in the same sub-section",\r
-                                File=self.RuleFile, Line=LineIndex+1,\r
+                                File=self.RuleFile, Line=LineIndex + 1,\r
                                 ExtraData=self.RuleContent[LineIndex])\r
 \r
             if len(TokenList) > 1:\r
                 Family = TokenList[1].strip().upper()\r
             else:\r
-                Family = "COMMON"\r
+                Family = TAB_COMMON\r
 \r
             if Family not in FamilyList:\r
                 FamilyList.append(Family)\r
@@ -529,13 +517,13 @@ class BuildRule:
         self._FamilyList = FamilyList\r
         self._TotalToolChainFamilySet.update(FamilyList)\r
         self._State = SectionType.upper()\r
-        if 'COMMON' in FamilyList and len(FamilyList) > 1:\r
+        if TAB_COMMON in FamilyList and len(FamilyList) > 1:\r
             EdkLogger.error("build", FORMAT_INVALID,\r
                             "Specific tool chain family should not be mixed with general one",\r
-                            File=self.RuleFile, Line=LineIndex+1,\r
+                            File=self.RuleFile, Line=LineIndex + 1,\r
                             ExtraData=self.RuleContent[LineIndex])\r
         if self._State not in self._StateHandler:\r
-            EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex+1,\r
+            EdkLogger.error("build", FORMAT_INVALID, File=self.RuleFile, Line=LineIndex + 1,\r
                             ExtraData="Unknown subsection: %s" % self.RuleContent[LineIndex])\r
     ## Parse <InputFile> sub-section\r
     #\r
@@ -545,7 +533,7 @@ class BuildRule:
         FileList = [File.strip() for File in self.RuleContent[LineIndex].split(",")]\r
         for ToolChainFamily in self._FamilyList:\r
             InputFiles = self._RuleInfo[ToolChainFamily, self._State]\r
-            if InputFiles == None:\r
+            if InputFiles is None:\r
                 InputFiles = []\r
                 self._RuleInfo[ToolChainFamily, self._State] = InputFiles\r
             InputFiles.extend(FileList)\r
@@ -557,7 +545,7 @@ class BuildRule:
     def ParseCommon(self, LineIndex):\r
         for ToolChainFamily in self._FamilyList:\r
             Items = self._RuleInfo[ToolChainFamily, self._State]\r
-            if Items == None:\r
+            if Items is None:\r
                 Items = []\r
                 self._RuleInfo[ToolChainFamily, self._State] = Items\r
             Items.append(self.RuleContent[LineIndex])\r
@@ -609,11 +597,11 @@ if __name__ == '__main__':
     EdkLogger.Initialize()\r
     if len(sys.argv) > 1:\r
         Br = BuildRule(sys.argv[1])\r
-        print str(Br[".c", "DXE_DRIVER", "IA32", "MSFT"][1])\r
+        print str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", "MSFT"][1])\r
         print\r
-        print str(Br[".c", "DXE_DRIVER", "IA32", "INTEL"][1])\r
+        print str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", "INTEL"][1])\r
         print\r
-        print str(Br[".c", "DXE_DRIVER", "IA32", "GCC"][1])\r
+        print str(Br[".c", SUP_MODULE_DXE_DRIVER, "IA32", "GCC"][1])\r
         print\r
         print str(Br[".ac", "ACPI_TABLE", "IA32", "MSFT"][1])\r
         print\r
@@ -621,7 +609,7 @@ if __name__ == '__main__':
         print\r
         print str(Br[".ac", "ACPI_TABLE", "IA32", "MSFT"][1])\r
         print\r
-        print str(Br[".s", "SEC", "IPF", "COMMON"][1])\r
+        print str(Br[".s", SUP_MODULE_SEC, "IPF", "COMMON"][1])\r
         print\r
-        print str(Br[".s", "SEC"][1])\r
+        print str(Br[".s", SUP_MODULE_SEC][1])\r
 \r