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