]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/BuildClassObject.py
Revert BaseTools: PYTHON3 migration
[mirror_edk2.git] / BaseTools / Source / Python / Workspace / BuildClassObject.py
CommitLineData
30fdf114
LG
1## @file\r
2# This file is used to define each component of the build database\r
3#\r
c33081c9 4# Copyright (c) 2007 - 2018, 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
b0a26451 14from collections import OrderedDict, namedtuple\r
8518bf0b 15from Common.DataType import *\r
57ee97c0
B
16import collections\r
17import re\r
18from collections import OrderedDict\r
19StructPattern = re.compile(r'[_a-zA-Z][0-9A-Za-z_\[\]]*$')\r
20ArrayIndex = re.compile("\[\s*\d{0,1}\s*\]")\r
30fdf114
LG
21## PcdClassObject\r
22#\r
23# This Class is used for PcdObject\r
24#\r
25# @param object: Inherited from object class\r
26# @param Name: Input value for Name of Pcd, default is None\r
27# @param Guid: Input value for Guid of Pcd, default is None\r
28# @param Type: Input value for Type of Pcd, default is None\r
29# @param DatumType: Input value for DatumType of Pcd, default is None\r
30# @param Value: Input value for Value of Pcd, default is None\r
31# @param Token: Input value for Token of Pcd, default is None\r
32# @param MaxDatumSize: Input value for MaxDatumSize of Pcd, default is None\r
33# @param SkuInfoList: Input value for SkuInfoList of Pcd, default is {}\r
34# @param IsOverrided: Input value for IsOverrided of Pcd, default is False\r
e56468c0 35# @param GuidValue: Input value for TokenSpaceGuidValue of Pcd, default is None\r
30fdf114
LG
36#\r
37# @var TokenCName: To store value for TokenCName\r
38# @var TokenSpaceGuidCName: To store value for TokenSpaceGuidCName\r
39# @var Type: To store value for Type\r
40# @var DatumType: To store value for DatumType\r
41# @var TokenValue: To store value for TokenValue\r
42# @var MaxDatumSize: To store value for MaxDatumSize\r
43# @var SkuInfoList: To store value for SkuInfoList\r
44# @var IsOverrided: To store value for IsOverrided\r
45# @var Phase: To store value for Phase, default is "DXE"\r
46#\r
47class PcdClassObject(object):\r
57ee97c0 48 def __init__(self, Name = None, Guid = None, Type = None, DatumType = None, Value = None, Token = None, MaxDatumSize = None, SkuInfoList = None, IsOverrided = False, GuidValue = None, validateranges = None, validlists = None, expressions = None, IsDsc = False, UserDefinedDefaultStoresFlag = False):\r
30fdf114
LG
49 self.TokenCName = Name\r
50 self.TokenSpaceGuidCName = Guid\r
51 self.TokenSpaceGuidValue = GuidValue\r
52 self.Type = Type\r
53 self.DatumType = DatumType\r
54 self.DefaultValue = Value\r
55 self.TokenValue = Token\r
56 self.MaxDatumSize = MaxDatumSize\r
c33081c9 57 self.MaxSizeUserSet = None\r
57ee97c0 58 self.SkuInfoList = SkuInfoList if SkuInfoList is not None else OrderedDict()\r
30fdf114
LG
59 self.Phase = "DXE"\r
60 self.Pending = False\r
e56468c0 61 self.IsOverrided = IsOverrided\r
a0a2cd1e
FB
62 self.IsFromBinaryInf = False\r
63 self.IsFromDsc = False\r
57ee97c0
B
64 self.validateranges = validateranges if validateranges is not None else []\r
65 self.validlists = validlists if validlists is not None else []\r
66 self.expressions = expressions if expressions is not None else []\r
cc71d8b7 67 self.DscDefaultValue = None\r
71127ce8 68 self.DscRawValue = {}\r
cc71d8b7
YZ
69 if IsDsc:\r
70 self.DscDefaultValue = Value\r
0f228f19 71 self.PcdValueFromComm = ""\r
543f5ac3 72 self.PcdValueFromFdf = ""\r
6a147d6d 73 self.CustomAttribute = {}\r
ced86858 74 self.UserDefinedDefaultStoresFlag = UserDefinedDefaultStoresFlag\r
9904222d 75\r
cfed8a37
FB
76 @staticmethod\r
77 def GetPcdMaxSizeWorker(PcdString, MaxSize):\r
78 if PcdString.startswith("{") and PcdString.endswith("}"):\r
79 return max([len(PcdString.split(",")),MaxSize])\r
80\r
81 if PcdString.startswith("\"") or PcdString.startswith("\'"):\r
82 return max([len(PcdString)-2+1,MaxSize])\r
83\r
84 if PcdString.startswith("L\""):\r
85 return max([2*(len(PcdString)-3+1),MaxSize])\r
86\r
87 return max([len(PcdString),MaxSize])\r
88\r
5565a8c4
CJ
89 ## Get the maximum number of bytes\r
90 def GetPcdMaxSize(self):\r
91 if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
92 return MAX_SIZE_TYPE[self.DatumType]\r
93\r
ccaa7754 94 MaxSize = int(self.MaxDatumSize, 10) if self.MaxDatumSize else 0\r
543f5ac3 95 if self.PcdValueFromFdf:\r
cfed8a37 96 MaxSize = self.GetPcdMaxSizeWorker(self.PcdValueFromFdf,MaxSize)\r
5565a8c4 97 if self.PcdValueFromComm:\r
cfed8a37
FB
98 MaxSize = self.GetPcdMaxSizeWorker(self.PcdValueFromComm,MaxSize)\r
99 if hasattr(self, "DefaultValueFromDec"):\r
100 MaxSize = self.GetPcdMaxSizeWorker(self.DefaultValueFromDec,MaxSize)\r
5565a8c4
CJ
101 return MaxSize\r
102\r
103 ## Get the number of bytes\r
104 def GetPcdSize(self):\r
105 if self.DatumType in TAB_PCD_NUMERIC_TYPES:\r
106 return MAX_SIZE_TYPE[self.DatumType]\r
107 if not self.DefaultValue:\r
108 return 1\r
109 elif self.DefaultValue[0] == 'L':\r
110 return (len(self.DefaultValue) - 2) * 2\r
111 elif self.DefaultValue[0] == '{':\r
112 return len(self.DefaultValue.split(','))\r
113 else:\r
114 return len(self.DefaultValue) - 1\r
115\r
116\r
30fdf114
LG
117 ## Convert the class to a string\r
118 #\r
119 # Convert each member of the class to string\r
120 # Organize to a signle line format string\r
121 #\r
122 # @retval Rtn Formatted String\r
123 #\r
124 def __str__(self):\r
125 Rtn = '\tTokenCName=' + str(self.TokenCName) + ', ' + \\r
126 'TokenSpaceGuidCName=' + str(self.TokenSpaceGuidCName) + ', ' + \\r
127 'Type=' + str(self.Type) + ', ' + \\r
128 'DatumType=' + str(self.DatumType) + ', ' + \\r
129 'DefaultValue=' + str(self.DefaultValue) + ', ' + \\r
130 'TokenValue=' + str(self.TokenValue) + ', ' + \\r
131 'MaxDatumSize=' + str(self.MaxDatumSize) + ', '\r
132 for Item in self.SkuInfoList.values():\r
133 Rtn = Rtn + 'SkuId=' + Item.SkuId + ', ' + 'SkuIdName=' + Item.SkuIdName\r
e56468c0 134 Rtn = Rtn + ', IsOverrided=' + str(self.IsOverrided)\r
30fdf114
LG
135\r
136 return Rtn\r
137\r
138 ## Override __eq__ function\r
139 #\r
140 # Check whether pcds are the same\r
141 #\r
142 # @retval False The two pcds are different\r
143 # @retval True The two pcds are the same\r
144 #\r
145 def __eq__(self, Other):\r
146 return Other and self.TokenCName == Other.TokenCName and self.TokenSpaceGuidCName == Other.TokenSpaceGuidCName\r
147\r
148 ## Override __hash__ function\r
149 #\r
150 # Use (TokenCName, TokenSpaceGuidCName) as key in hash table\r
151 #\r
152 # @retval truple() Key for hash table\r
153 #\r
154 def __hash__(self):\r
155 return hash((self.TokenCName, self.TokenSpaceGuidCName))\r
156\r
ae7b6df8 157class StructurePcd(PcdClassObject):\r
9904222d 158 def __init__(self, StructuredPcdIncludeFile=None, Packages=None, Name=None, Guid=None, Type=None, DatumType=None, Value=None, Token=None, MaxDatumSize=None, SkuInfoList=None, IsOverrided=False, GuidValue=None, validateranges=None, validlists=None, expressions=None,default_store = TAB_DEFAULT_STORES_DEFAULT):\r
8ac64c5b
CJ
159 if SkuInfoList is None:\r
160 SkuInfoList = {}\r
161 if validateranges is None:\r
162 validateranges = []\r
163 if validlists is None:\r
164 validlists = []\r
165 if expressions is None:\r
166 expressions = []\r
167 if Packages is None:\r
168 Packages = []\r
1ccc4d89 169 super(StructurePcd, self).__init__(Name, Guid, Type, DatumType, Value, Token, MaxDatumSize, SkuInfoList, IsOverrided, GuidValue, validateranges, validlists, expressions)\r
81add864 170 self.StructuredPcdIncludeFile = [] if StructuredPcdIncludeFile is None else StructuredPcdIncludeFile\r
ae7b6df8 171 self.PackageDecs = Packages\r
8518bf0b 172 self.DefaultStoreName = [default_store]\r
b0a26451 173 self.DefaultValues = OrderedDict()\r
ae7b6df8 174 self.PcdMode = None\r
b0a26451 175 self.SkuOverrideValues = OrderedDict()\r
e651d06c 176 self.StructName = None\r
6a103440
FB
177 self.PcdDefineLineNo = 0\r
178 self.PkgPath = ""\r
06140766 179 self.DefaultValueFromDec = ""\r
88252a90 180 self.ValueChain = set()\r
b0a26451
CJ
181 self.PcdFieldValueFromComm = OrderedDict()\r
182 self.PcdFieldValueFromFdf = OrderedDict()\r
ae7b6df8
LG
183 def __repr__(self):\r
184 return self.TypeName\r
185\r
186 def AddDefaultValue (self, FieldName, Value, FileName="", LineNo=0):\r
34952f49
LG
187 if FieldName in self.DefaultValues:\r
188 del self.DefaultValues[FieldName]\r
ae7b6df8
LG
189 self.DefaultValues[FieldName] = [Value.strip(), FileName, LineNo]\r
190 return self.DefaultValues[FieldName]\r
191\r
ccaa7754 192 def SetDecDefaultValue(self, DefaultValue):\r
06140766 193 self.DefaultValueFromDec = DefaultValue\r
8518bf0b 194 def AddOverrideValue (self, FieldName, Value, SkuName, DefaultStoreName, FileName="", LineNo=0):\r
ae7b6df8 195 if SkuName not in self.SkuOverrideValues:\r
b0a26451 196 self.SkuOverrideValues[SkuName] = OrderedDict()\r
8518bf0b 197 if DefaultStoreName not in self.SkuOverrideValues[SkuName]:\r
b0a26451 198 self.SkuOverrideValues[SkuName][DefaultStoreName] = OrderedDict()\r
8518bf0b
LG
199 if FieldName in self.SkuOverrideValues[SkuName][DefaultStoreName]:\r
200 del self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName]\r
201 self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName] = [Value.strip(), FileName, LineNo]\r
202 return self.SkuOverrideValues[SkuName][DefaultStoreName][FieldName]\r
ae7b6df8
LG
203\r
204 def SetPcdMode (self, PcdMode):\r
205 self.PcdMode = PcdMode\r
206\r
ae7b6df8
LG
207 def copy(self, PcdObject):\r
208 self.TokenCName = PcdObject.TokenCName if PcdObject.TokenCName else self.TokenCName\r
209 self.TokenSpaceGuidCName = PcdObject.TokenSpaceGuidCName if PcdObject.TokenSpaceGuidCName else PcdObject.TokenSpaceGuidCName\r
210 self.TokenSpaceGuidValue = PcdObject.TokenSpaceGuidValue if PcdObject.TokenSpaceGuidValue else self.TokenSpaceGuidValue\r
211 self.Type = PcdObject.Type if PcdObject.Type else self.Type\r
212 self.DatumType = PcdObject.DatumType if PcdObject.DatumType else self.DatumType\r
213 self.DefaultValue = PcdObject.DefaultValue if PcdObject.DefaultValue else self.DefaultValue\r
214 self.TokenValue = PcdObject.TokenValue if PcdObject.TokenValue else self.TokenValue\r
215 self.MaxDatumSize = PcdObject.MaxDatumSize if PcdObject.MaxDatumSize else self.MaxDatumSize\r
216 self.SkuInfoList = PcdObject.SkuInfoList if PcdObject.SkuInfoList else self.SkuInfoList\r
217 self.Phase = PcdObject.Phase if PcdObject.Phase else self.Phase\r
218 self.Pending = PcdObject.Pending if PcdObject.Pending else self.Pending\r
219 self.IsOverrided = PcdObject.IsOverrided if PcdObject.IsOverrided else self.IsOverrided\r
220 self.IsFromBinaryInf = PcdObject.IsFromBinaryInf if PcdObject.IsFromBinaryInf else self.IsFromBinaryInf\r
221 self.IsFromDsc = PcdObject.IsFromDsc if PcdObject.IsFromDsc else self.IsFromDsc\r
222 self.validateranges = PcdObject.validateranges if PcdObject.validateranges else self.validateranges\r
223 self.validlists = PcdObject.validlists if PcdObject.validlists else self.validlists\r
224 self.expressions = PcdObject.expressions if PcdObject.expressions else self.expressions\r
f3b31433 225 self.DscRawValue = PcdObject.DscRawValue if PcdObject.DscRawValue else self.DscRawValue\r
0f228f19 226 self.PcdValueFromComm = PcdObject.PcdValueFromComm if PcdObject.PcdValueFromComm else self.PcdValueFromComm\r
543f5ac3 227 self.PcdValueFromFdf = PcdObject.PcdValueFromFdf if PcdObject.PcdValueFromFdf else self.PcdValueFromFdf\r
6a147d6d 228 self.CustomAttribute = PcdObject.CustomAttribute if PcdObject.CustomAttribute else self.CustomAttribute\r
ced86858 229 self.UserDefinedDefaultStoresFlag = PcdObject.UserDefinedDefaultStoresFlag if PcdObject.UserDefinedDefaultStoresFlag else self.UserDefinedDefaultStoresFlag\r
0d1f5b2b 230 if isinstance(PcdObject, StructurePcd):\r
ae7b6df8
LG
231 self.StructuredPcdIncludeFile = PcdObject.StructuredPcdIncludeFile if PcdObject.StructuredPcdIncludeFile else self.StructuredPcdIncludeFile\r
232 self.PackageDecs = PcdObject.PackageDecs if PcdObject.PackageDecs else self.PackageDecs\r
233 self.DefaultValues = PcdObject.DefaultValues if PcdObject.DefaultValues else self.DefaultValues\r
234 self.PcdMode = PcdObject.PcdMode if PcdObject.PcdMode else self.PcdMode\r
235 self.DefaultFromDSC=None\r
06140766 236 self.DefaultValueFromDec = PcdObject.DefaultValueFromDec if PcdObject.DefaultValueFromDec else self.DefaultValueFromDec\r
65eff519 237 self.SkuOverrideValues = PcdObject.SkuOverrideValues if PcdObject.SkuOverrideValues else self.SkuOverrideValues\r
e651d06c 238 self.StructName = PcdObject.DatumType if PcdObject.DatumType else self.StructName\r
6a103440
FB
239 self.PcdDefineLineNo = PcdObject.PcdDefineLineNo if PcdObject.PcdDefineLineNo else self.PcdDefineLineNo\r
240 self.PkgPath = PcdObject.PkgPath if PcdObject.PkgPath else self.PkgPath\r
f3b31433 241 self.ValueChain = PcdObject.ValueChain if PcdObject.ValueChain else self.ValueChain\r
b854e2bf 242 self.PcdFieldValueFromComm = PcdObject.PcdFieldValueFromComm if PcdObject.PcdFieldValueFromComm else self.PcdFieldValueFromComm\r
543f5ac3 243 self.PcdFieldValueFromFdf = PcdObject.PcdFieldValueFromFdf if PcdObject.PcdFieldValueFromFdf else self.PcdFieldValueFromFdf\r
ae7b6df8 244\r
1ccc4d89 245LibraryClassObject = namedtuple('LibraryClassObject', ['LibraryClass','SupModList'], verbose=False)\r
30fdf114
LG
246\r
247## ModuleBuildClassObject\r
248#\r
249# This Class defines ModuleBuildClass\r
250#\r
251# @param object: Inherited from object class\r
252#\r
253# @var MetaFile: To store value for module meta file path\r
254# @var BaseName: To store value for BaseName\r
255# @var ModuleType: To store value for ModuleType\r
256# @var Guid: To store value for Guid\r
257# @var Version: To store value for Version\r
258# @var PcdIsDriver: To store value for PcdIsDriver\r
259# @var BinaryModule: To store value for BinaryModule\r
260# @var CustomMakefile: To store value for CustomMakefile\r
261# @var Specification: To store value for Specification\r
262# @var Shadow To store value for Shadow\r
263# @var LibraryClass: To store value for LibraryClass, it is a list structure as\r
264# [ LibraryClassObject, ...]\r
265# @var ModuleEntryPointList: To store value for ModuleEntryPointList\r
266# @var ModuleUnloadImageList: To store value for ModuleUnloadImageList\r
267# @var ConstructorList: To store value for ConstructorList\r
268# @var DestructorList: To store value for DestructorList\r
269# @var Binaries: To store value for Binaries, it is a list structure as\r
270# [ ModuleBinaryClassObject, ...]\r
271# @var Sources: To store value for Sources, it is a list structure as\r
272# [ ModuleSourceFilesClassObject, ... ]\r
273# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
274# { [LibraryClassName, ModuleType] : LibraryClassInfFile }\r
275# @var Protocols: To store value for Protocols, it is a list structure as\r
276# [ ProtocolName, ... ]\r
277# @var Ppis: To store value for Ppis, it is a list structure as\r
278# [ PpiName, ... ]\r
279# @var Guids: To store value for Guids, it is a list structure as\r
280# [ GuidName, ... ]\r
281# @var Includes: To store value for Includes, it is a list structure as\r
282# [ IncludePath, ... ]\r
283# @var Packages: To store value for Packages, it is a list structure as\r
284# [ DecFileName, ... ]\r
285# @var Pcds: To store value for Pcds, it is a set structure as\r
286# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
287# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
288# { [BuildOptionKey] : BuildOptionValue}\r
289# @var Depex: To store value for Depex\r
290#\r
291class ModuleBuildClassObject(object):\r
292 def __init__(self):\r
293 self.AutoGenVersion = 0\r
294 self.MetaFile = ''\r
295 self.BaseName = ''\r
296 self.ModuleType = ''\r
297 self.Guid = ''\r
298 self.Version = ''\r
299 self.PcdIsDriver = ''\r
300 self.BinaryModule = ''\r
301 self.Shadow = ''\r
302 self.SourceOverridePath = ''\r
303 self.CustomMakefile = {}\r
304 self.Specification = {}\r
305 self.LibraryClass = []\r
306 self.ModuleEntryPointList = []\r
307 self.ModuleUnloadImageList = []\r
308 self.ConstructorList = []\r
309 self.DestructorList = []\r
310\r
311 self.Binaries = []\r
312 self.Sources = []\r
b0a26451 313 self.LibraryClasses = OrderedDict()\r
30fdf114
LG
314 self.Libraries = []\r
315 self.Protocols = []\r
316 self.Ppis = []\r
317 self.Guids = []\r
318 self.Includes = []\r
319 self.Packages = []\r
320 self.Pcds = {}\r
321 self.BuildOptions = {}\r
322 self.Depex = {}\r
323\r
324 ## Convert the class to a string\r
325 #\r
326 # Convert member MetaFile of the class to a string\r
327 #\r
328 # @retval string Formatted String\r
329 #\r
330 def __str__(self):\r
331 return str(self.MetaFile)\r
332\r
333 ## Override __eq__ function\r
334 #\r
335 # Check whether ModuleBuildClassObjects are the same\r
336 #\r
337 # @retval False The two ModuleBuildClassObjects are different\r
338 # @retval True The two ModuleBuildClassObjects are the same\r
339 #\r
340 def __eq__(self, Other):\r
341 return self.MetaFile == Other\r
342\r
343 ## Override __hash__ function\r
344 #\r
345 # Use MetaFile as key in hash table\r
346 #\r
347 # @retval string Key for hash table\r
348 #\r
349 def __hash__(self):\r
350 return hash(self.MetaFile)\r
351\r
352## PackageBuildClassObject\r
353#\r
354# This Class defines PackageBuildClass\r
355#\r
356# @param object: Inherited from object class\r
357#\r
358# @var MetaFile: To store value for package meta file path\r
359# @var PackageName: To store value for PackageName\r
360# @var Guid: To store value for Guid\r
361# @var Version: To store value for Version\r
362# @var Protocols: To store value for Protocols, it is a set structure as\r
363# { [ProtocolName] : Protocol Guid, ... }\r
364# @var Ppis: To store value for Ppis, it is a set structure as\r
365# { [PpiName] : Ppi Guid, ... }\r
366# @var Guids: To store value for Guids, it is a set structure as\r
367# { [GuidName] : Guid, ... }\r
368# @var Includes: To store value for Includes, it is a list structure as\r
369# [ IncludePath, ... ]\r
370# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
371# { [LibraryClassName] : LibraryClassInfFile }\r
372# @var Pcds: To store value for Pcds, it is a set structure as\r
373# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
374#\r
375class PackageBuildClassObject(object):\r
376 def __init__(self):\r
377 self.MetaFile = ''\r
378 self.PackageName = ''\r
379 self.Guid = ''\r
380 self.Version = ''\r
381\r
382 self.Protocols = {}\r
383 self.Ppis = {}\r
384 self.Guids = {}\r
385 self.Includes = []\r
386 self.LibraryClasses = {}\r
387 self.Pcds = {}\r
388\r
389 ## Convert the class to a string\r
390 #\r
391 # Convert member MetaFile of the class to a string\r
392 #\r
393 # @retval string Formatted String\r
394 #\r
395 def __str__(self):\r
396 return str(self.MetaFile)\r
397\r
398 ## Override __eq__ function\r
399 #\r
400 # Check whether PackageBuildClassObjects are the same\r
401 #\r
402 # @retval False The two PackageBuildClassObjects are different\r
403 # @retval True The two PackageBuildClassObjects are the same\r
404 #\r
405 def __eq__(self, Other):\r
406 return self.MetaFile == Other\r
407\r
408 ## Override __hash__ function\r
409 #\r
410 # Use MetaFile as key in hash table\r
411 #\r
412 # @retval string Key for hash table\r
413 #\r
414 def __hash__(self):\r
415 return hash(self.MetaFile)\r
416\r
417## PlatformBuildClassObject\r
418#\r
419# This Class defines PlatformBuildClass\r
420#\r
421# @param object: Inherited from object class\r
422#\r
423# @var MetaFile: To store value for platform meta-file path\r
424# @var PlatformName: To store value for PlatformName\r
425# @var Guid: To store value for Guid\r
426# @var Version: To store value for Version\r
427# @var DscSpecification: To store value for DscSpecification\r
428# @var OutputDirectory: To store value for OutputDirectory\r
429# @var FlashDefinition: To store value for FlashDefinition\r
430# @var BuildNumber: To store value for BuildNumber\r
431# @var MakefileName: To store value for MakefileName\r
432# @var SkuIds: To store value for SkuIds, it is a set structure as\r
433# { 'SkuName' : SkuId, '!include' : includefilename, ...}\r
434# @var Modules: To store value for Modules, it is a list structure as\r
435# [ InfFileName, ... ]\r
436# @var Libraries: To store value for Libraries, it is a list structure as\r
437# [ InfFileName, ... ]\r
438# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
439# { (LibraryClassName, ModuleType) : LibraryClassInfFile }\r
440# @var Pcds: To store value for Pcds, it is a set structure as\r
441# { [(PcdCName, PcdGuidCName)] : PcdClassObject }\r
442# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
443# { [BuildOptionKey] : BuildOptionValue }\r
444#\r
445class PlatformBuildClassObject(object):\r
446 def __init__(self):\r
447 self.MetaFile = ''\r
448 self.PlatformName = ''\r
449 self.Guid = ''\r
450 self.Version = ''\r
451 self.DscSpecification = ''\r
452 self.OutputDirectory = ''\r
453 self.FlashDefinition = ''\r
454 self.BuildNumber = ''\r
455 self.MakefileName = ''\r
456\r
457 self.SkuIds = {}\r
458 self.Modules = []\r
459 self.LibraryInstances = []\r
460 self.LibraryClasses = {}\r
461 self.Libraries = {}\r
462 self.Pcds = {}\r
463 self.BuildOptions = {}\r
464\r
465 ## Convert the class to a string\r
466 #\r
467 # Convert member MetaFile of the class to a string\r
468 #\r
469 # @retval string Formatted String\r
470 #\r
471 def __str__(self):\r
472 return str(self.MetaFile)\r
473\r
474 ## Override __eq__ function\r
475 #\r
476 # Check whether PlatformBuildClassObjects are the same\r
477 #\r
478 # @retval False The two PlatformBuildClassObjects are different\r
479 # @retval True The two PlatformBuildClassObjects are the same\r
480 #\r
481 def __eq__(self, Other):\r
482 return self.MetaFile == Other\r
483\r
484 ## Override __hash__ function\r
485 #\r
486 # Use MetaFile as key in hash table\r
487 #\r
488 # @retval string Key for hash table\r
489 #\r
490 def __hash__(self):\r
491 return hash(self.MetaFile)\r