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