]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Common/TargetTxtClassObject.py
Sync EDKII BaseTools to BaseTools project r2065.
[mirror_edk2.git] / BaseTools / Source / Python / Common / TargetTxtClassObject.py
CommitLineData
30fdf114
LG
1## @file\r
2# This file is used to define each component of Target.txt file\r
3#\r
08dd311f 4# Copyright (c) 2007 - 2010, 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
17import os\r
18import EdkLogger\r
19import DataType\r
20from BuildToolError import *\r
21import GlobalData\r
22\r
23gDefaultTargetTxtFile = "Conf/target.txt"\r
24\r
25## TargetTxtClassObject\r
26#\r
27# This class defined content used in file target.txt\r
28#\r
29# @param object: Inherited from object class\r
30# @param Filename: Input value for full path of target.txt\r
31#\r
32# @var TargetTxtDictionary: To store keys and values defined in target.txt\r
33#\r
34class TargetTxtClassObject(object):\r
35 def __init__(self, Filename = None):\r
36 self.TargetTxtDictionary = {\r
37 DataType.TAB_TAT_DEFINES_ACTIVE_PLATFORM : '',\r
38 DataType.TAB_TAT_DEFINES_ACTIVE_MODULE : '',\r
39 DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF : '',\r
30fdf114
LG
40 DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER : '',\r
41 DataType.TAB_TAT_DEFINES_TARGET : [],\r
42 DataType.TAB_TAT_DEFINES_TOOL_CHAIN_TAG : [],\r
43 DataType.TAB_TAT_DEFINES_TARGET_ARCH : [],\r
44 DataType.TAB_TAT_DEFINES_BUILD_RULE_CONF : '',\r
45 }\r
46 if Filename != None:\r
47 self.LoadTargetTxtFile(Filename)\r
48\r
49 ## LoadTargetTxtFile\r
50 #\r
51 # Load target.txt file and parse it, return a set structure to store keys and values\r
52 #\r
53 # @param Filename: Input value for full path of target.txt\r
54 #\r
55 # @retval set() A set structure to store keys and values\r
56 # @retval 1 Error happenes in parsing\r
57 #\r
58 def LoadTargetTxtFile(self, Filename):\r
59 if os.path.exists(Filename) and os.path.isfile(Filename):\r
60 return self.ConvertTextFileToDict(Filename, '#', '=')\r
61 else:\r
62 EdkLogger.error("Target.txt Parser", FILE_NOT_FOUND, ExtraData=Filename)\r
63 return 1\r
64\r
65 ## ConvertTextFileToDict\r
66 #\r
67 # Convert a text file to a dictionary of (name:value) pairs.\r
68 # The data is saved to self.TargetTxtDictionary\r
69 #\r
70 # @param FileName: Text filename\r
71 # @param CommentCharacter: Comment char, be used to ignore comment content\r
72 # @param KeySplitCharacter: Key split char, between key name and key value. Key1 = Value1, '=' is the key split char\r
73 #\r
74 # @retval 0 Convert successfully\r
75 # @retval 1 Open file failed\r
76 #\r
77 def ConvertTextFileToDict(self, FileName, CommentCharacter, KeySplitCharacter):\r
78 F = None\r
79 try:\r
80 F = open(FileName,'r')\r
81 except:\r
82 EdkLogger.error("build", FILE_OPEN_FAILURE, ExtraData=FileName)\r
83 if F != None:\r
84 F.close()\r
85\r
86 for Line in F:\r
87 Line = Line.strip()\r
88 if Line.startswith(CommentCharacter) or Line == '':\r
89 continue\r
90\r
91 LineList = Line.split(KeySplitCharacter, 1)\r
92 Key = LineList[0].strip()\r
93 if len(LineList) == 2:\r
94 Value = LineList[1].strip()\r
95 else:\r
96 Value = ""\r
97\r
98 if Key in [DataType.TAB_TAT_DEFINES_ACTIVE_PLATFORM, DataType.TAB_TAT_DEFINES_TOOL_CHAIN_CONF, \\r
99 DataType.TAB_TAT_DEFINES_ACTIVE_MODULE, DataType.TAB_TAT_DEFINES_BUILD_RULE_CONF]:\r
100 self.TargetTxtDictionary[Key] = Value.replace('\\', '/')\r
101 elif Key in [DataType.TAB_TAT_DEFINES_TARGET, DataType.TAB_TAT_DEFINES_TARGET_ARCH, \\r
102 DataType.TAB_TAT_DEFINES_TOOL_CHAIN_TAG]:\r
103 self.TargetTxtDictionary[Key] = Value.split()\r
30fdf114
LG
104 elif Key == DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER:\r
105 try:\r
106 V = int(Value, 0)\r
107 except:\r
108 EdkLogger.error("build", FORMAT_INVALID, "Invalid number of [%s]: %s." % (Key, Value),\r
109 File=FileName)\r
110 self.TargetTxtDictionary[Key] = Value\r
111 #elif Key not in GlobalData.gGlobalDefines:\r
112 # GlobalData.gGlobalDefines[Key] = Value\r
113\r
114 F.close()\r
115 return 0\r
116\r
117 ## Print the dictionary\r
118 #\r
119 # Print all items of dictionary one by one\r
120 #\r
121 # @param Dict: The dictionary to be printed\r
122 #\r
123 def printDict(Dict):\r
124 if Dict != None:\r
125 KeyList = Dict.keys()\r
126 for Key in KeyList:\r
127 if Dict[Key] != '':\r
128 print Key + ' = ' + str(Dict[Key])\r
129\r
130 ## Print the dictionary\r
131 #\r
132 # Print the items of dictionary which matched with input key\r
133 #\r
134 # @param list: The dictionary to be printed\r
135 # @param key: The key of the item to be printed\r
136 #\r
137 def printList(Key, List):\r
138 if type(List) == type([]):\r
139 if len(List) > 0:\r
140 if Key.find(TAB_SPLIT) != -1:\r
141 print "\n" + Key\r
142 for Item in List:\r
143 print Item\r
144## TargetTxtDict\r
145#\r
146# Load target.txt in input workspace dir\r
147#\r
148# @param WorkSpace: Workspace dir\r
149#\r
150# @retval Target An instance of TargetTxtClassObject() with loaded target.txt\r
151#\r
152def TargetTxtDict(WorkSpace):\r
153 Target = TargetTxtClassObject()\r
154 Target.LoadTargetTxtFile(os.path.normpath(os.path.join(WorkSpace, gDefaultTargetTxtFile)))\r
155 return Target\r
156\r
157##\r
158#\r
159# This acts like the main() function for the script, unless it is 'import'ed into another\r
160# script.\r
161#\r
162if __name__ == '__main__':\r
163 pass\r
164 Target = TargetTxtDict(os.getenv("WORKSPACE"))\r
165 print Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_MAX_CONCURRENT_THREAD_NUMBER]\r
166 print Target.TargetTxtDictionary[DataType.TAB_TAT_DEFINES_TARGET]\r
167 print Target.TargetTxtDictionary\r