[mirror_edk2.git] / BaseTools / Source / Python / Common / ToolDefClassObject.py

## @file\r
# This file is used to define each component of tools_def.txt file\r
#\r
# Copyright (c) 2007 - 2016, 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
#\r
\r
##\r
# Import Modules\r
#\r
import Common.LongFilePathOs as os\r
import re\r
import EdkLogger\r
\r
from Dictionary import *\r
from BuildToolError import *\r
from TargetTxtClassObject import *\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.Misc import PathClass\r
from Common.String import NormPath\r
import Common.GlobalData as GlobalData\r
from Common import GlobalData\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
##\r
# Static variables used for pattern\r
#\r
gMacroRefPattern = re.compile('(DEF\([^\(\)]+\))')\r
gEnvRefPattern = re.compile('(ENV\([^\(\)]+\))')\r
gMacroDefPattern = re.compile("DEFINE\s+([^\s]+)")\r
gDefaultToolsDefFile = "tools_def.txt"\r
\r
## ToolDefClassObject\r
#\r
# This class defined content used in file tools_def.txt\r
#\r
# @param object:               Inherited from object class\r
# @param Filename:             Input value for full path of tools_def.txt\r
#\r
# @var ToolsDefTxtDictionary:  To store keys and values defined in target.txt\r
# @var MacroDictionary:        To store keys and values defined in DEFINE statement\r
#\r
class ToolDefClassObject(object):\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
            self.LoadToolDefFile(FileName)\r
\r
    ## LoadToolDefFile\r
    #\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
        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
\r
    ## IncludeToolDefFile\r
    #\r
    # Load target.txt file and parse it as if it's 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
                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
        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 type(IncFileTmp) is 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
                continue\r
\r
            Name = NameValuePair[0].strip()\r
            Value = NameValuePair[1].strip()\r
\r
            if Name == "IDENTIFIER":\r
                EdkLogger.debug(EdkLogger.DEBUG_8, "Line %d: Found identifier statement, skipped: %s" % ((Index + 1), Value))\r
                continue\r
\r
            MacroDefinition = gMacroDefPattern.findall(Name)\r
            if MacroDefinition != []:\r
                Done, Value = self.ExpandMacros(Value)\r
                if not Done:\r
                    EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
                                    "Macro or Environment has not been defined",\r
                                ExtraData=Value[4:-1], File=FileName, Line=Index+1)\r
\r
                MacroName = MacroDefinition[0].strip()\r
                self.MacroDictionary["DEF(%s)" % MacroName] = Value\r
                EdkLogger.debug(EdkLogger.DEBUG_8, "Line %d: Found macro: %s = %s" % ((Index + 1), MacroName, Value))\r
                continue\r
\r
            Done, Value = self.ExpandMacros(Value)\r
            if not Done:\r
                EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
                                "Macro or Environment has not been defined",\r
                                ExtraData=Value[4:-1], File=FileName, Line=Index+1)\r
\r
            List = Name.split('_')\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
                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
                    self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] += [List[0]]\r
                if List[1] != '*':\r
                    self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] += [List[1]]\r
                if List[2] != '*':\r
                    self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] += [List[2]]\r
                if List[3] != '*':\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 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] = {}\r
                        self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
                    elif List[1] not in 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 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
    ## ExpandMacros\r
    #\r
    # Replace defined macros with real value\r
    #\r
    # @param Value:   The string with unreplaced macros\r
    #\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 and Ref.upper() not in self.MacroDictionary:\r
                Value = Value.replace(Ref, "")\r
            else:\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
                return False, Ref\r
            Value = Value.replace(Ref, self.MacroDictionary[Ref])\r
\r
        return True, Value\r
\r
## ToolDefDict\r
#\r
# Load tools_def.txt in input Conf dir\r
#\r
# @param ConfDir:  Conf dir\r
#\r
# @retval ToolDef An instance of ToolDefClassObject() with loaded tools_def.txt\r
#\r
def ToolDefDict(ConfDir):\r
    Target = TargetTxtDict(ConfDir)\r
    ToolDef = ToolDefClassObject()\r
    if DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF in Target.TargetTxtDictionary:\r
        ToolsDefFile = Target.TargetTxtDictionary[DataType.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(ConfDir, gDefaultToolsDefFile)))\r
    else:\r
        ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(ConfDir, gDefaultToolsDefFile)))\r
    return ToolDef\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    ToolDef = ToolDefDict(os.getenv("WORKSPACE"))\r
    pass\r
Commit	Line	Data
30fdf114 LG	1	## @file\r
	2	# This file is used to define each component of tools_def.txt file\r
	3	#\r
18ca2fec	4	# Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>\r
40d841f6	5	# This program and the accompanying materials\r
30fdf114 LG	6	# are licensed and made available under the terms and conditions of the BSD License\r
	7	# which accompanies this distribution. The full text of the license may be found at\r
	8	# http://opensource.org/licenses/bsd-license.php\r
	9	#\r
	10	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	#\r
	13	\r
	14	##\r
	15	# Import Modules\r
	16	#\r
1be2ed90	17	import Common.LongFilePathOs as os\r
30fdf114 LG	18	import re\r
	19	import EdkLogger\r
	20	\r
	21	from Dictionary import *\r
	22	from BuildToolError import *\r
	23	from TargetTxtClassObject import *\r
1be2ed90	24	from Common.LongFilePathSupport import OpenLongFilePath as open\r
8ac46e4e MZ	25	from Common.Misc import PathClass\r
	26	from Common.String import NormPath\r
	27	import Common.GlobalData as GlobalData\r
	28	from Common import GlobalData\r
	29	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
30fdf114 LG	30	\r
30fdf114 LG	31	##\r
08dd311f	32	# Static variables used for pattern\r
30fdf114 LG	33	#\r
	34	gMacroRefPattern = re.compile('(DEF\([^\(\)]+\))')\r
	35	gEnvRefPattern = re.compile('(ENV\([^\(\)]+\))')\r
	36	gMacroDefPattern = re.compile("DEFINE\s+([^\s]+)")\r
97fa0ee9	37	gDefaultToolsDefFile = "tools_def.txt"\r
30fdf114 LG	38	\r
	39	## ToolDefClassObject\r
	40	#\r
	41	# This class defined content used in file tools_def.txt\r
	42	#\r
	43	# @param object: Inherited from object class\r
	44	# @param Filename: Input value for full path of tools_def.txt\r
	45	#\r
	46	# @var ToolsDefTxtDictionary: To store keys and values defined in target.txt\r
	47	# @var MacroDictionary: To store keys and values defined in DEFINE statement\r
	48	#\r
	49	class ToolDefClassObject(object):\r
47fea6af	50	def __init__(self, FileName=None):\r
30fdf114 LG	51	self.ToolsDefTxtDictionary = {}\r
	52	self.MacroDictionary = {}\r
	53	for Env in os.environ:\r
	54	self.MacroDictionary["ENV(%s)" % Env] = os.environ[Env]\r
	55	\r
	56	if FileName != None:\r
	57	self.LoadToolDefFile(FileName)\r
	58	\r
	59	## LoadToolDefFile\r
	60	#\r
8b14b35b	61	# Load target.txt file and parse it\r
30fdf114 LG	62	#\r
	63	# @param Filename: Input value for full path of tools_def.txt\r
	64	#\r
	65	def LoadToolDefFile(self, FileName):\r
8ac46e4e MZ	66	# set multiple workspace\r
	67	PackagesPath = os.getenv("PACKAGES_PATH")\r
	68	mws.setWs(GlobalData.gWorkspace, PackagesPath)\r
	69	\r
	70	self.ToolsDefTxtDatabase = {\r
	71	TAB_TOD_DEFINES_TARGET : [],\r
	72	TAB_TOD_DEFINES_TOOL_CHAIN_TAG : [],\r
	73	TAB_TOD_DEFINES_TARGET_ARCH : [],\r
	74	TAB_TOD_DEFINES_COMMAND_TYPE : []\r
	75	}\r
	76	\r
	77	self.IncludeToolDefFile(FileName)\r
	78	\r
6608330d MZ	79	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET]))\r
	80	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG]))\r
	81	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH]))\r
	82	\r
	83	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE] = list(set(self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE]))\r
	84	\r
	85	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET].sort()\r
	86	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG].sort()\r
	87	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH].sort()\r
	88	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE].sort()\r
	89	\r
	90	KeyList = [TAB_TOD_DEFINES_TARGET, TAB_TOD_DEFINES_TOOL_CHAIN_TAG, TAB_TOD_DEFINES_TARGET_ARCH, TAB_TOD_DEFINES_COMMAND_TYPE]\r
	91	for Index in range(3, -1, -1):\r
	92	for Key in dict(self.ToolsDefTxtDictionary):\r
	93	List = Key.split('_')\r
	94	if List[Index] == '*':\r
	95	for String in self.ToolsDefTxtDatabase[KeyList[Index]]:\r
	96	List[Index] = String\r
	97	NewKey = '%s_%s_%s_%s_%s' % tuple(List)\r
	98	if NewKey not in self.ToolsDefTxtDictionary:\r
	99	self.ToolsDefTxtDictionary[NewKey] = self.ToolsDefTxtDictionary[Key]\r
	100	continue\r
	101	del self.ToolsDefTxtDictionary[Key]\r
	102	elif List[Index] not in self.ToolsDefTxtDatabase[KeyList[Index]]:\r
	103	del self.ToolsDefTxtDictionary[Key]\r
	104	\r
8ac46e4e MZ	105	\r
	106	## IncludeToolDefFile\r
	107	#\r
	108	# Load target.txt file and parse it as if it's contents were inside the main file\r
	109	#\r
	110	# @param Filename: Input value for full path of tools_def.txt\r
	111	#\r
	112	def IncludeToolDefFile(self, FileName):\r
30fdf114 LG	113	FileContent = []\r
	114	if os.path.isfile(FileName):\r
	115	try:\r
47fea6af	116	F = open(FileName, 'r')\r
30fdf114 LG	117	FileContent = F.readlines()\r
	118	except:\r
	119	EdkLogger.error("tools_def.txt parser", FILE_OPEN_FAILURE, ExtraData=FileName)\r
	120	else:\r
	121	EdkLogger.error("tools_def.txt parser", FILE_NOT_FOUND, ExtraData=FileName)\r
	122	\r
30fdf114 LG	123	for Index in range(len(FileContent)):\r
	124	Line = FileContent[Index].strip()\r
	125	if Line == "" or Line[0] == '#':\r
	126	continue\r
8ac46e4e MZ	127	\r
	128	if Line.startswith("!include"):\r
	129	IncFile = Line[8:].strip()\r
	130	Done, IncFile = self.ExpandMacros(IncFile)\r
	131	if not Done:\r
	132	EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
	133	"Macro or Environment has not been defined",\r
	134	ExtraData=IncFile[4:-1], File=FileName, Line=Index+1)\r
	135	IncFile = NormPath(IncFile)\r
	136	\r
	137	if not os.path.isabs(IncFile):\r
	138	#\r
	139	# try WORKSPACE\r
	140	#\r
	141	IncFileTmp = PathClass(IncFile, GlobalData.gWorkspace)\r
	142	ErrorCode = IncFileTmp.Validate()[0]\r
	143	if ErrorCode != 0:\r
	144	#\r
	145	# try PACKAGES_PATH\r
	146	#\r
	147	IncFileTmp = mws.join(GlobalData.gWorkspace, IncFile)\r
	148	if not os.path.exists(IncFileTmp):\r
	149	#\r
	150	# try directory of current file\r
	151	#\r
	152	IncFileTmp = PathClass(IncFile, os.path.dirname(FileName))\r
	153	ErrorCode = IncFileTmp.Validate()[0]\r
	154	if ErrorCode != 0:\r
	155	EdkLogger.error("tools_def.txt parser", FILE_NOT_FOUND, ExtraData=IncFile)\r
	156	\r
	157	if type(IncFileTmp) is PathClass:\r
	158	IncFile = IncFileTmp.Path\r
	159	else:\r
	160	IncFile = IncFileTmp\r
	161	\r
	162	self.IncludeToolDefFile(IncFile)\r
	163	continue\r
	164	\r
30fdf114 LG	165	NameValuePair = Line.split("=", 1)\r
	166	if len(NameValuePair) != 2:\r
	167	EdkLogger.warn("tools_def.txt parser", "Line %d: not correct assignment statement, skipped" % (Index + 1))\r
	168	continue\r
	169	\r
	170	Name = NameValuePair[0].strip()\r
	171	Value = NameValuePair[1].strip()\r
	172	\r
	173	if Name == "IDENTIFIER":\r
	174	EdkLogger.debug(EdkLogger.DEBUG_8, "Line %d: Found identifier statement, skipped: %s" % ((Index + 1), Value))\r
	175	continue\r
	176	\r
	177	MacroDefinition = gMacroDefPattern.findall(Name)\r
	178	if MacroDefinition != []:\r
	179	Done, Value = self.ExpandMacros(Value)\r
	180	if not Done:\r
	181	EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
	182	"Macro or Environment has not been defined",\r
	183	ExtraData=Value[4:-1], File=FileName, Line=Index+1)\r
	184	\r
	185	MacroName = MacroDefinition[0].strip()\r
	186	self.MacroDictionary["DEF(%s)" % MacroName] = Value\r
	187	EdkLogger.debug(EdkLogger.DEBUG_8, "Line %d: Found macro: %s = %s" % ((Index + 1), MacroName, Value))\r
	188	continue\r
	189	\r
	190	Done, Value = self.ExpandMacros(Value)\r
	191	if not Done:\r
	192	EdkLogger.error("tools_def.txt parser", ATTRIBUTE_NOT_AVAILABLE,\r
	193	"Macro or Environment has not been defined",\r
	194	ExtraData=Value[4:-1], File=FileName, Line=Index+1)\r
	195	\r
	196	List = Name.split('_')\r
	197	if len(List) != 5:\r
	198	EdkLogger.verbose("Line %d: Not a valid name of definition: %s" % ((Index + 1), Name))\r
	199	continue\r
	200	elif List[4] == '*':\r
	201	EdkLogger.verbose("Line %d: '*' is not allowed in last field: %s" % ((Index + 1), Name))\r
	202	continue\r
	203	else:\r
	204	self.ToolsDefTxtDictionary[Name] = Value\r
	205	if List[0] != '*':\r
	206	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET] += [List[0]]\r
	207	if List[1] != '*':\r
	208	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TOOL_CHAIN_TAG] += [List[1]]\r
	209	if List[2] != '*':\r
	210	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_TARGET_ARCH] += [List[2]]\r
	211	if List[3] != '*':\r
	212	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_COMMAND_TYPE] += [List[3]]\r
	213	if List[4] == TAB_TOD_DEFINES_FAMILY and List[2] == '' and List[3] == '':\r
	214	if TAB_TOD_DEFINES_FAMILY not in self.ToolsDefTxtDatabase:\r
	215	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY] = {}\r
	216	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY][List[1]] = Value\r
	217	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY] = {}\r
	218	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
	219	elif List[1] not in self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY]:\r
	220	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY][List[1]] = Value\r
	221	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
	222	elif self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY][List[1]] != Value:\r
	223	EdkLogger.verbose("Line %d: No override allowed for the family of a tool chain: %s" % ((Index + 1), Name))\r
	224	if List[4] == TAB_TOD_DEFINES_BUILDRULEFAMILY and List[2] == '' and List[3] == '':\r
	225	if TAB_TOD_DEFINES_BUILDRULEFAMILY not in self.ToolsDefTxtDatabase \\r
	226	or List[1] not in self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_FAMILY]:\r
	227	EdkLogger.verbose("Line %d: The family is not specified, but BuildRuleFamily is specified for the tool chain: %s" % ((Index + 1), Name))\r
	228	self.ToolsDefTxtDatabase[TAB_TOD_DEFINES_BUILDRULEFAMILY][List[1]] = Value\r
229	\r
30fdf114 LG	230	## ExpandMacros\r
	231	#\r
	232	# Replace defined macros with real value\r
	233	#\r
	234	# @param Value: The string with unreplaced macros\r
	235	#\r
	236	# @retval Value: The string which has been replaced with real value\r
	237	#\r
	238	def ExpandMacros(self, Value):\r
18ca2fec	239	# os.environ contains all environment variables uppercase on Windows which cause the key in the self.MacroDictionary is uppercase, but Ref may not\r
30fdf114 LG	240	EnvReference = gEnvRefPattern.findall(Value)\r
30fdf114 LG	241	for Ref in EnvReference:\r
18ca2fec	242	if Ref not in self.MacroDictionary and Ref.upper() not in self.MacroDictionary:\r
da92f276 LG	243	Value = Value.replace(Ref, "")\r
da92f276 LG	244	else:\r
18ca2fec YZ	245	if Ref in self.MacroDictionary:\r
	246	Value = Value.replace(Ref, self.MacroDictionary[Ref])\r
	247	else:\r
	248	Value = Value.replace(Ref, self.MacroDictionary[Ref.upper()])\r
30fdf114 LG	249	MacroReference = gMacroRefPattern.findall(Value)\r
	250	for Ref in MacroReference:\r
	251	if Ref not in self.MacroDictionary:\r
	252	return False, Ref\r
	253	Value = Value.replace(Ref, self.MacroDictionary[Ref])\r
	254	\r
	255	return True, Value\r
	256	\r
	257	## ToolDefDict\r
	258	#\r
97fa0ee9	259	# Load tools_def.txt in input Conf dir\r
30fdf114	260	#\r
97fa0ee9	261	# @param ConfDir: Conf dir\r
30fdf114 LG	262	#\r
	263	# @retval ToolDef An instance of ToolDefClassObject() with loaded tools_def.txt\r
	264	#\r
97fa0ee9 YL	265	def ToolDefDict(ConfDir):\r
97fa0ee9 YL	266	Target = TargetTxtDict(ConfDir)\r
30fdf114 LG	267	ToolDef = ToolDefClassObject()\r
30fdf114 LG	268	if DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF in Target.TargetTxtDictionary:\r
97fa0ee9 YL	269	ToolsDefFile = Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF]\r
	270	if ToolsDefFile:\r
	271	ToolDef.LoadToolDefFile(os.path.normpath(ToolsDefFile))\r
	272	else:\r
	273	ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(ConfDir, gDefaultToolsDefFile)))\r
	274	else:\r
	275	ToolDef.LoadToolDefFile(os.path.normpath(os.path.join(ConfDir, gDefaultToolsDefFile)))\r
30fdf114 LG	276	return ToolDef\r
	277	\r
	278	##\r
	279	#\r
	280	# This acts like the main() function for the script, unless it is 'import'ed into another\r
	281	# script.\r
	282	#\r
	283	if __name__ == '__main__':\r
	284	ToolDef = ToolDefDict(os.getenv("WORKSPACE"))\r
	285	pass\r