## @file\r
# This file is used to define each component of tools_def.txt file\r
#\r
-# Copyright (c) 2007, 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
-# http://opensource.org/licenses/bsd-license.php\r
-#\r
-# 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
+# Copyright (c) 2007 - 2021, Intel Corporation. All rights reserved.<BR>\r
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
-import os\r
+from __future__ import absolute_import\r
+import Common.LongFilePathOs as os\r
import re\r
-import EdkLogger\r
+from . import EdkLogger\r
+\r
+from .BuildToolError import *\r
+from Common.TargetTxtClassObject import TargetTxtDict\r
+from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Common.Misc import PathClass\r
+from Common.StringUtils import NormPath\r
+import Common.GlobalData as GlobalData\r
+from Common import GlobalData\r
+from Common.MultipleWorkspace import MultipleWorkspace as mws\r
+from .DataType import TAB_TOD_DEFINES_TARGET, TAB_TOD_DEFINES_TOOL_CHAIN_TAG,\\r
+ TAB_TOD_DEFINES_TARGET_ARCH, TAB_TOD_DEFINES_COMMAND_TYPE\\r
+ , TAB_TOD_DEFINES_FAMILY, TAB_TOD_DEFINES_BUILDRULEFAMILY,\\r
+ TAB_STAR, TAB_TAT_DEFINES_TOOL_CHAIN_CONF\r
\r
-from Dictionary import *\r
-from BuildToolError import *\r
-from TargetTxtClassObject import *\r
\r
##\r
# Static variables used for pattern\r
gMacroRefPattern = re.compile('(DEF\([^\(\)]+\))')\r
gEnvRefPattern = re.compile('(ENV\([^\(\)]+\))')\r
gMacroDefPattern = re.compile("DEFINE\s+([^\s]+)")\r
-gDefaultToolsDefFile = "Conf/tools_def.txt"\r
+gDefaultToolsDefFile = "tools_def.txt"\r
\r
## ToolDefClassObject\r
#\r
# @var MacroDictionary: To store keys and values defined in DEFINE statement\r
#\r
class ToolDefClassObject(object):\r
- def __init__(self, FileName = None):\r
+ def __init__(self, FileName=None):\r
self.ToolsDefTxtDictionary = {}\r
self.MacroDictionary = {}\r
for Env in os.environ:\r
self.MacroDictionary["ENV(%s)" % Env] = os.environ[Env]\r
\r
- if FileName != None:\r
+ if FileName is not None:\r
self.LoadToolDefFile(FileName)\r
\r
## LoadToolDefFile\r
#\r
- # Load target.txt file and parse it, return a set structure to store keys and values\r
+ # Load target.txt file and parse it\r
#\r
# @param Filename: Input value for full path of tools_def.txt\r
#\r
def LoadToolDefFile(self, FileName):\r
+ # set multiple workspace\r
+ PackagesPath = os.getenv("PACKAGES_PATH")\r
+ mws.setWs(GlobalData.gWorkspace, PackagesPath)\r
+\r
+ self.ToolsDefTxtDatabase = {\r
+ TAB_TOD_DEFINES_TARGET : [],\r
+ TAB_TOD_DEFINES_TOOL_CHAIN_TAG : [],\r
+ TAB_TOD_DEFINES_TARGET_ARCH : [],\r
+ TAB_TOD_DEFINES_COMMAND_TYPE : []\r
+ }\r
+\r
+ self.IncludeToolDefFile(FileName)\r
+\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET]))\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG]))\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH]))\r
+\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE]))\r
+\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET].sort()\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG].sort()\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH].sort()\r
+ self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE].sort()\r
+\r
+ ## IncludeToolDefFile\r
+ #\r
+ # Load target.txt file and parse it as if its contents were inside the main file\r
+ #\r
+ # @param Filename: Input value for full path of tools_def.txt\r
+ #\r
+ def IncludeToolDefFile(self, FileName):\r
FileContent = []\r
if os.path.isfile(FileName):\r
try:\r
- F = open(FileName,'r')\r
+ F = open(FileName, 'r')\r
FileContent = F.readlines()\r
except:\r
EdkLogger.error("tools_def.txt parser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
else:\r
EdkLogger.error("tools_def.txt parser", FILE_NOT_FOUND, ExtraData=FileName)\r
\r
- self.ToolsDefTxtDatabase = {\r
- TAB_TOD_DEFINES_TARGET : [],\r
- TAB_TOD_DEFINES_TOOL_CHAIN_TAG : [],\r
- TAB_TOD_DEFINES_TARGET_ARCH : [],\r
- TAB_TOD_DEFINES_COMMAND_TYPE : []\r
- }\r
-\r
for Index in range(len(FileContent)):\r
Line = FileContent[Index].strip()\r
if Line == "" or Line[0] == '#':\r
continue\r
+\r
+ if Line.startswith("!include"):\r
+ IncFile = Line[8:].strip()\r
+ Done, IncFile = self.ExpandMacros(IncFile)\r
+ if not Done:\r
+ EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
+ "Macro or Environment has not been defined",\r
+ ExtraData=IncFile[4:-1], File=FileName, Line=Index+1)\r
+ IncFile = NormPath(IncFile)\r
+\r
+ if not os.path.isabs(IncFile):\r
+ #\r
+ # try WORKSPACE\r
+ #\r
+ IncFileTmp = PathClass(IncFile, GlobalData.gWorkspace)\r
+ ErrorCode = IncFileTmp.Validate()[0]\r
+ if ErrorCode != 0:\r
+ #\r
+ # try PACKAGES_PATH\r
+ #\r
+ IncFileTmp = mws.join(GlobalData.gWorkspace, IncFile)\r
+ if not os.path.exists(IncFileTmp):\r
+ #\r
+ # try directory of current file\r
+ #\r
+ IncFileTmp = PathClass(IncFile, os.path.dirname(FileName))\r
+ ErrorCode = IncFileTmp.Validate()[0]\r
+ if ErrorCode != 0:\r
+ EdkLogger.error("tools_def.txt parser", FILE_NOT_FOUND, ExtraData=IncFile)\r
+\r
+ if isinstance(IncFileTmp, PathClass):\r
+ IncFile = IncFileTmp.Path\r
+ else:\r
+ IncFile = IncFileTmp\r
+\r
+ self.IncludeToolDefFile(IncFile)\r
+ continue\r
+\r
NameValuePair = Line.split("=", 1)\r
if len(NameValuePair) != 2:\r
EdkLogger.warn("tools_def.txt parser", "Line %d: not correct assignment statement, skipped" % (Index + 1))\r
if len(List) != 5:\r
EdkLogger.verbose("Line %d: Not a valid name of definition: %s" % ((Index + 1), Name))\r
continue\r
- elif List[4] == '*':\r
+ elif List[4] == TAB_STAR:\r
EdkLogger.verbose("Line %d: '*' is not allowed in last field: %s" % ((Index + 1), Name))\r
continue\r
else:\r
self.ToolsDefTxtDictionary[Name] = Value\r
- if List[0] != '*':\r
+ if List[0] != TAB_STAR:\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] += [List[0]]\r
- if List[1] != '*':\r
+ if List[1] != TAB_STAR:\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] += [List[1]]\r
- if List[2] != '*':\r
+ if List[2] != TAB_STAR:\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] += [List[2]]\r
- if List[3] != '*':\r
+ if List[3] != TAB_STAR:\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE] += [List[3]]\r
- if List[4] == TAB_TOD_DEFINES_FAMILY and List[2] == '*' and List[3] == '*':\r
+ if List[4] == TAB_TOD_DEFINES_FAMILY and List[2] == TAB_STAR and List[3] == TAB_STAR:\r
if TAB_TOD_DEFINES_FAMILY not in self.ToolsDefTxtDatabase:\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY] = {}\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY][List[1]] = Value\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
elif self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY][List[1]] != Value:\r
EdkLogger.verbose("Line %d: No override allowed for the family of a tool chain: %s" % ((Index + 1), Name))\r
- if List[4] == TAB_TOD_DEFINES_BUILDRULEFAMILY and List[2] == '*' and List[3] == '*':\r
+ if List[4] == TAB_TOD_DEFINES_BUILDRULEFAMILY and List[2] == TAB_STAR and List[3] == TAB_STAR:\r
if TAB_TOD_DEFINES_BUILDRULEFAMILY not in self.ToolsDefTxtDatabase \\r
or List[1] not in self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY]:\r
EdkLogger.verbose("Line %d: The family is not specified, but BuildRuleFamily is specified for the tool chain: %s" % ((Index + 1), Name))\r
self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET]))\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG]))\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH]))\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE]))\r
-\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET].sort()\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG].sort()\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH].sort()\r
- self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE].sort()\r
-\r
- KeyList = [TAB_TOD_DEFINES_TARGET, TAB_TOD_DEFINES_TOOL_CHAIN_TAG, TAB_TOD_DEFINES_TARGET_ARCH, TAB_TOD_DEFINES_COMMAND_TYPE]\r
- for Index in range(3,-1,-1):\r
- for Key in dict(self.ToolsDefTxtDictionary):\r
- List = Key.split('_')\r
- if List[Index] == '*':\r
- for String in self.ToolsDefTxtDatabase[KeyList[Index]]:\r
- List[Index] = String\r
- NewKey = '%s_%s_%s_%s_%s' % tuple(List)\r
- if NewKey not in self.ToolsDefTxtDictionary:\r
- self.ToolsDefTxtDictionary[NewKey] = self.ToolsDefTxtDictionary[Key]\r
- continue\r
- del self.ToolsDefTxtDictionary[Key]\r
- elif List[Index] not in self.ToolsDefTxtDatabase[KeyList[Index]]:\r
- del self.ToolsDefTxtDictionary[Key]\r
-\r
## ExpandMacros\r
#\r
# Replace defined macros with real value\r
# @retval Value: The string which has been replaced with real value\r
#\r
def ExpandMacros(self, Value):\r
+ # os.environ contains all environment variables uppercase on Windows which cause the key in the self.MacroDictionary is uppercase, but Ref may not\r
EnvReference = gEnvRefPattern.findall(Value)\r
for Ref in EnvReference:\r
- if Ref not in self.MacroDictionary:\r
+ if Ref not in self.MacroDictionary and Ref.upper() not in self.MacroDictionary:\r
Value = Value.replace(Ref, "")\r
else:\r
- Value = Value.replace(Ref, self.MacroDictionary[Ref])\r
- \r
-\r
+ if Ref in self.MacroDictionary:\r
+ Value = Value.replace(Ref, self.MacroDictionary[Ref])\r
+ else:\r
+ Value = Value.replace(Ref, self.MacroDictionary[Ref.upper()])\r
MacroReference = gMacroRefPattern.findall(Value)\r
for Ref in MacroReference:\r
if Ref not in self.MacroDictionary:\r
\r
## ToolDefDict\r
#\r
-# Load tools_def.txt in input workspace dir\r
+# Load tools_def.txt in input Conf dir\r
#\r
-# @param WorkSpace: Workspace dir\r
+# @param ConfDir: Conf dir\r
#\r
# @retval ToolDef An instance of ToolDefClassObject() with loaded tools_def.txt\r
#\r
-def ToolDefDict(WorkSpace):\r
- Target = TargetTxtDict(WorkSpace)\r
- ToolDef = ToolDefClassObject()\r
- if DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF in Target.TargetTxtDictionary:\r
- gDefaultToolsDefFile = Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF]\r
- ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(WorkSpace, gDefaultToolsDefFile)))\r
- return ToolDef\r
+\r
+\r
+class ToolDefDict():\r
+\r
+ def __new__(cls, ConfDir, *args, **kw):\r
+ if not hasattr(cls, '_instance'):\r
+ orig = super(ToolDefDict, cls)\r
+ cls._instance = orig.__new__(cls, *args, **kw)\r
+ return cls._instance\r
+\r
+ def __init__(self, ConfDir):\r
+ self.ConfDir = ConfDir\r
+ if not hasattr(self, 'ToolDef'):\r
+ self._ToolDef = None\r
+\r
+ @property\r
+ def ToolDef(self):\r
+ if not self._ToolDef:\r
+ self._GetToolDef()\r
+ return self._ToolDef\r
+\r
+ def _GetToolDef(self):\r
+ TargetObj = TargetTxtDict()\r
+ Target = TargetObj.Target\r
+ ToolDef = ToolDefClassObject()\r
+ if TAB_TAT_DEFINES_TOOL_CHAIN_CONF in Target.TargetTxtDictionary:\r
+ ToolsDefFile = Target.TargetTxtDictionary[TAB_TAT_DEFINES_TOOL_CHAIN_CONF]\r
+ if ToolsDefFile:\r
+ ToolDef.LoadToolDefFile(os.path.normpath(ToolsDefFile))\r
+ else:\r
+ ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(self.ConfDir, gDefaultToolsDefFile)))\r
+ else:\r
+ ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(self.ConfDir, gDefaultToolsDefFile)))\r
+ self._ToolDef = ToolDef\r
\r
##\r
#\r
projects / mirror_edk2.git / blobdiff