]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/Workspace/BuildClassObject.py
ShellPkg: Fix EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL_GUID to match UEFI Shell 2.1 spec
[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
e56468c0 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
14import os\r
15\r
16from Common.Misc import sdict\r
17from Common.Misc import RealPath2\r
18from Common.BuildToolError import *\r
19\r
20## PcdClassObject\r
21#\r
22# This Class is used for PcdObject\r
23#\r
24# @param object: Inherited from object class\r
25# @param Name: Input value for Name of Pcd, default is None\r
26# @param Guid: Input value for Guid of Pcd, default is None\r
27# @param Type: Input value for Type of Pcd, default is None\r
28# @param DatumType: Input value for DatumType of Pcd, default is None\r
29# @param Value: Input value for Value of Pcd, default is None\r
30# @param Token: Input value for Token of Pcd, default is None\r
31# @param MaxDatumSize: Input value for MaxDatumSize of Pcd, default is None\r
32# @param SkuInfoList: Input value for SkuInfoList of Pcd, default is {}\r
33# @param IsOverrided: Input value for IsOverrided of Pcd, default is False\r
e56468c0 34# @param GuidValue: Input value for TokenSpaceGuidValue of Pcd, default is None\r
30fdf114
LG
35#\r
36# @var TokenCName: To store value for TokenCName\r
37# @var TokenSpaceGuidCName: To store value for TokenSpaceGuidCName\r
38# @var Type: To store value for Type\r
39# @var DatumType: To store value for DatumType\r
40# @var TokenValue: To store value for TokenValue\r
41# @var MaxDatumSize: To store value for MaxDatumSize\r
42# @var SkuInfoList: To store value for SkuInfoList\r
43# @var IsOverrided: To store value for IsOverrided\r
44# @var Phase: To store value for Phase, default is "DXE"\r
45#\r
46class PcdClassObject(object):\r
e56468c0 47 def __init__(self, Name = None, Guid = None, Type = None, DatumType = None, Value = None, Token = None, MaxDatumSize = None, SkuInfoList = {}, IsOverrided = False, GuidValue = None):\r
30fdf114
LG
48 self.TokenCName = Name\r
49 self.TokenSpaceGuidCName = Guid\r
50 self.TokenSpaceGuidValue = GuidValue\r
51 self.Type = Type\r
52 self.DatumType = DatumType\r
53 self.DefaultValue = Value\r
54 self.TokenValue = Token\r
55 self.MaxDatumSize = MaxDatumSize\r
56 self.SkuInfoList = SkuInfoList\r
57 self.Phase = "DXE"\r
58 self.Pending = False\r
e56468c0 59 self.IsOverrided = IsOverrided\r
60 \r
30fdf114
LG
61 ## Convert the class to a string\r
62 #\r
63 # Convert each member of the class to string\r
64 # Organize to a signle line format string\r
65 #\r
66 # @retval Rtn Formatted String\r
67 #\r
68 def __str__(self):\r
69 Rtn = '\tTokenCName=' + str(self.TokenCName) + ', ' + \\r
70 'TokenSpaceGuidCName=' + str(self.TokenSpaceGuidCName) + ', ' + \\r
71 'Type=' + str(self.Type) + ', ' + \\r
72 'DatumType=' + str(self.DatumType) + ', ' + \\r
73 'DefaultValue=' + str(self.DefaultValue) + ', ' + \\r
74 'TokenValue=' + str(self.TokenValue) + ', ' + \\r
75 'MaxDatumSize=' + str(self.MaxDatumSize) + ', '\r
76 for Item in self.SkuInfoList.values():\r
77 Rtn = Rtn + 'SkuId=' + Item.SkuId + ', ' + 'SkuIdName=' + Item.SkuIdName\r
e56468c0 78 Rtn = Rtn + ', IsOverrided=' + str(self.IsOverrided)\r
30fdf114
LG
79\r
80 return Rtn\r
81\r
82 ## Override __eq__ function\r
83 #\r
84 # Check whether pcds are the same\r
85 #\r
86 # @retval False The two pcds are different\r
87 # @retval True The two pcds are the same\r
88 #\r
89 def __eq__(self, Other):\r
90 return Other and self.TokenCName == Other.TokenCName and self.TokenSpaceGuidCName == Other.TokenSpaceGuidCName\r
91\r
92 ## Override __hash__ function\r
93 #\r
94 # Use (TokenCName, TokenSpaceGuidCName) as key in hash table\r
95 #\r
96 # @retval truple() Key for hash table\r
97 #\r
98 def __hash__(self):\r
99 return hash((self.TokenCName, self.TokenSpaceGuidCName))\r
100\r
101## LibraryClassObject\r
102#\r
103# This Class defines LibraryClassObject used in BuildDatabase\r
104#\r
105# @param object: Inherited from object class\r
106# @param Name: Input value for LibraryClassName, default is None\r
107# @param SupModList: Input value for SupModList, default is []\r
108# @param Type: Input value for Type, default is None\r
109#\r
110# @var LibraryClass: To store value for LibraryClass\r
111# @var SupModList: To store value for SupModList\r
112# @var Type: To store value for Type\r
113#\r
114class LibraryClassObject(object):\r
115 def __init__(self, Name = None, SupModList = [], Type = None):\r
116 self.LibraryClass = Name\r
117 self.SupModList = SupModList\r
118 if Type != None:\r
119 self.SupModList = CleanString(Type).split(DataType.TAB_SPACE_SPLIT)\r
120\r
121## ModuleBuildClassObject\r
122#\r
123# This Class defines ModuleBuildClass\r
124#\r
125# @param object: Inherited from object class\r
126#\r
127# @var MetaFile: To store value for module meta file path\r
128# @var BaseName: To store value for BaseName\r
129# @var ModuleType: To store value for ModuleType\r
130# @var Guid: To store value for Guid\r
131# @var Version: To store value for Version\r
132# @var PcdIsDriver: To store value for PcdIsDriver\r
133# @var BinaryModule: To store value for BinaryModule\r
134# @var CustomMakefile: To store value for CustomMakefile\r
135# @var Specification: To store value for Specification\r
136# @var Shadow To store value for Shadow\r
137# @var LibraryClass: To store value for LibraryClass, it is a list structure as\r
138# [ LibraryClassObject, ...]\r
139# @var ModuleEntryPointList: To store value for ModuleEntryPointList\r
140# @var ModuleUnloadImageList: To store value for ModuleUnloadImageList\r
141# @var ConstructorList: To store value for ConstructorList\r
142# @var DestructorList: To store value for DestructorList\r
143# @var Binaries: To store value for Binaries, it is a list structure as\r
144# [ ModuleBinaryClassObject, ...]\r
145# @var Sources: To store value for Sources, it is a list structure as\r
146# [ ModuleSourceFilesClassObject, ... ]\r
147# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
148# { [LibraryClassName, ModuleType] : LibraryClassInfFile }\r
149# @var Protocols: To store value for Protocols, it is a list structure as\r
150# [ ProtocolName, ... ]\r
151# @var Ppis: To store value for Ppis, it is a list structure as\r
152# [ PpiName, ... ]\r
153# @var Guids: To store value for Guids, it is a list structure as\r
154# [ GuidName, ... ]\r
155# @var Includes: To store value for Includes, it is a list structure as\r
156# [ IncludePath, ... ]\r
157# @var Packages: To store value for Packages, it is a list structure as\r
158# [ DecFileName, ... ]\r
159# @var Pcds: To store value for Pcds, it is a set structure as\r
160# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
161# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
162# { [BuildOptionKey] : BuildOptionValue}\r
163# @var Depex: To store value for Depex\r
164#\r
165class ModuleBuildClassObject(object):\r
166 def __init__(self):\r
167 self.AutoGenVersion = 0\r
168 self.MetaFile = ''\r
169 self.BaseName = ''\r
170 self.ModuleType = ''\r
171 self.Guid = ''\r
172 self.Version = ''\r
173 self.PcdIsDriver = ''\r
174 self.BinaryModule = ''\r
175 self.Shadow = ''\r
176 self.SourceOverridePath = ''\r
177 self.CustomMakefile = {}\r
178 self.Specification = {}\r
179 self.LibraryClass = []\r
180 self.ModuleEntryPointList = []\r
181 self.ModuleUnloadImageList = []\r
182 self.ConstructorList = []\r
183 self.DestructorList = []\r
184\r
185 self.Binaries = []\r
186 self.Sources = []\r
187 self.LibraryClasses = sdict()\r
188 self.Libraries = []\r
189 self.Protocols = []\r
190 self.Ppis = []\r
191 self.Guids = []\r
192 self.Includes = []\r
193 self.Packages = []\r
194 self.Pcds = {}\r
195 self.BuildOptions = {}\r
196 self.Depex = {}\r
197\r
198 ## Convert the class to a string\r
199 #\r
200 # Convert member MetaFile of the class to a string\r
201 #\r
202 # @retval string Formatted String\r
203 #\r
204 def __str__(self):\r
205 return str(self.MetaFile)\r
206\r
207 ## Override __eq__ function\r
208 #\r
209 # Check whether ModuleBuildClassObjects are the same\r
210 #\r
211 # @retval False The two ModuleBuildClassObjects are different\r
212 # @retval True The two ModuleBuildClassObjects are the same\r
213 #\r
214 def __eq__(self, Other):\r
215 return self.MetaFile == Other\r
216\r
217 ## Override __hash__ function\r
218 #\r
219 # Use MetaFile as key in hash table\r
220 #\r
221 # @retval string Key for hash table\r
222 #\r
223 def __hash__(self):\r
224 return hash(self.MetaFile)\r
225\r
226## PackageBuildClassObject\r
227#\r
228# This Class defines PackageBuildClass\r
229#\r
230# @param object: Inherited from object class\r
231#\r
232# @var MetaFile: To store value for package meta file path\r
233# @var PackageName: To store value for PackageName\r
234# @var Guid: To store value for Guid\r
235# @var Version: To store value for Version\r
236# @var Protocols: To store value for Protocols, it is a set structure as\r
237# { [ProtocolName] : Protocol Guid, ... }\r
238# @var Ppis: To store value for Ppis, it is a set structure as\r
239# { [PpiName] : Ppi Guid, ... }\r
240# @var Guids: To store value for Guids, it is a set structure as\r
241# { [GuidName] : Guid, ... }\r
242# @var Includes: To store value for Includes, it is a list structure as\r
243# [ IncludePath, ... ]\r
244# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
245# { [LibraryClassName] : LibraryClassInfFile }\r
246# @var Pcds: To store value for Pcds, it is a set structure as\r
247# { [(PcdCName, PcdGuidCName)] : PcdClassObject}\r
248#\r
249class PackageBuildClassObject(object):\r
250 def __init__(self):\r
251 self.MetaFile = ''\r
252 self.PackageName = ''\r
253 self.Guid = ''\r
254 self.Version = ''\r
255\r
256 self.Protocols = {}\r
257 self.Ppis = {}\r
258 self.Guids = {}\r
259 self.Includes = []\r
260 self.LibraryClasses = {}\r
261 self.Pcds = {}\r
262\r
263 ## Convert the class to a string\r
264 #\r
265 # Convert member MetaFile of the class to a string\r
266 #\r
267 # @retval string Formatted String\r
268 #\r
269 def __str__(self):\r
270 return str(self.MetaFile)\r
271\r
272 ## Override __eq__ function\r
273 #\r
274 # Check whether PackageBuildClassObjects are the same\r
275 #\r
276 # @retval False The two PackageBuildClassObjects are different\r
277 # @retval True The two PackageBuildClassObjects are the same\r
278 #\r
279 def __eq__(self, Other):\r
280 return self.MetaFile == Other\r
281\r
282 ## Override __hash__ function\r
283 #\r
284 # Use MetaFile as key in hash table\r
285 #\r
286 # @retval string Key for hash table\r
287 #\r
288 def __hash__(self):\r
289 return hash(self.MetaFile)\r
290\r
291## PlatformBuildClassObject\r
292#\r
293# This Class defines PlatformBuildClass\r
294#\r
295# @param object: Inherited from object class\r
296#\r
297# @var MetaFile: To store value for platform meta-file path\r
298# @var PlatformName: To store value for PlatformName\r
299# @var Guid: To store value for Guid\r
300# @var Version: To store value for Version\r
301# @var DscSpecification: To store value for DscSpecification\r
302# @var OutputDirectory: To store value for OutputDirectory\r
303# @var FlashDefinition: To store value for FlashDefinition\r
304# @var BuildNumber: To store value for BuildNumber\r
305# @var MakefileName: To store value for MakefileName\r
306# @var SkuIds: To store value for SkuIds, it is a set structure as\r
307# { 'SkuName' : SkuId, '!include' : includefilename, ...}\r
308# @var Modules: To store value for Modules, it is a list structure as\r
309# [ InfFileName, ... ]\r
310# @var Libraries: To store value for Libraries, it is a list structure as\r
311# [ InfFileName, ... ]\r
312# @var LibraryClasses: To store value for LibraryClasses, it is a set structure as\r
313# { (LibraryClassName, ModuleType) : LibraryClassInfFile }\r
314# @var Pcds: To store value for Pcds, it is a set structure as\r
315# { [(PcdCName, PcdGuidCName)] : PcdClassObject }\r
316# @var BuildOptions: To store value for BuildOptions, it is a set structure as\r
317# { [BuildOptionKey] : BuildOptionValue }\r
318#\r
319class PlatformBuildClassObject(object):\r
320 def __init__(self):\r
321 self.MetaFile = ''\r
322 self.PlatformName = ''\r
323 self.Guid = ''\r
324 self.Version = ''\r
325 self.DscSpecification = ''\r
326 self.OutputDirectory = ''\r
327 self.FlashDefinition = ''\r
328 self.BuildNumber = ''\r
329 self.MakefileName = ''\r
330\r
331 self.SkuIds = {}\r
332 self.Modules = []\r
333 self.LibraryInstances = []\r
334 self.LibraryClasses = {}\r
335 self.Libraries = {}\r
336 self.Pcds = {}\r
337 self.BuildOptions = {}\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 PlatformBuildClassObjects are the same\r
351 #\r
352 # @retval False The two PlatformBuildClassObjects are different\r
353 # @retval True The two PlatformBuildClassObjects 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