]>
Commit | Line | Data |
---|---|---|
4234283c LG |
1 | ## @file\r |
2 | # This file is used to define common items of class object\r | |
3 | #\r | |
f7496d71 | 4 | # Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r |
4234283c | 5 | #\r |
f7496d71 LG |
6 | # This program and the accompanying materials are licensed and made available\r |
7 | # under the terms and conditions of the BSD License which accompanies this\r | |
8 | # distribution. The full text of the license may be found at\r | |
4234283c LG |
9 | # http://opensource.org/licenses/bsd-license.php\r |
10 | #\r | |
11 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | '''\r | |
15 | Common Object\r | |
16 | '''\r | |
421ccda3 | 17 | from Library.DataType import TAB_LANGUAGE_EN_US\r |
4234283c LG |
18 | \r |
19 | ## HelpTextObject\r | |
20 | #\r | |
21 | # @param object: Inherited from object class\r | |
22 | #\r | |
23 | class HelpTextObject(object):\r | |
24 | def __init__(self):\r | |
25 | self.HelpText = TextObject()\r | |
f7496d71 | 26 | \r |
4234283c LG |
27 | def SetHelpText(self, HelpText):\r |
28 | self.HelpText = HelpText\r | |
f7496d71 | 29 | \r |
4234283c LG |
30 | def GetHelpText(self):\r |
31 | return self.HelpText\r | |
32 | \r | |
33 | ## HelpTextListObject\r | |
34 | #\r | |
35 | # @param object: Inherited from object class\r | |
36 | #\r | |
37 | class HelpTextListObject(object):\r | |
38 | def __init__(self):\r | |
39 | self.HelpTextList = []\r | |
f7496d71 | 40 | \r |
4234283c LG |
41 | def SetHelpTextList(self, HelpTextList):\r |
42 | self.HelpTextList = HelpTextList\r | |
f7496d71 | 43 | \r |
4234283c LG |
44 | def GetHelpTextList(self):\r |
45 | return self.HelpTextList\r | |
46 | \r | |
421ccda3 HC |
47 | ## PromptListObject\r |
48 | #\r | |
49 | # @param object: Inherited from object class\r | |
50 | #\r | |
51 | class PromptListObject(object):\r | |
52 | def __init__(self):\r | |
53 | self.PromptList = []\r | |
f7496d71 | 54 | \r |
421ccda3 HC |
55 | def SetPromptList(self, PromptList):\r |
56 | self.PromptList = PromptList\r | |
f7496d71 | 57 | \r |
421ccda3 HC |
58 | def GetPromptList(self):\r |
59 | return self.PromptList\r | |
f7496d71 | 60 | \r |
4234283c LG |
61 | ## CommonPropertiesObject\r |
62 | #\r | |
63 | # This class defined common attribution used in Module/Platform/Package files\r | |
64 | #\r | |
65 | # @param object: Inherited from object class\r | |
66 | # @param Usage: Input value for Usage, default is []\r | |
67 | # @param FeatureFlag: Input value for FeatureFalg, default is ''\r | |
68 | # @param SupArchList: Input value for SupArchList, default is []\r | |
69 | # @param HelpText: Input value for HelpText, default is ''\r | |
70 | # @param HelpTextList: Input value for HelpTextList, default is []\r | |
71 | #\r | |
72 | class CommonPropertiesObject(HelpTextObject, HelpTextListObject):\r | |
73 | def __init__(self):\r | |
74 | self.Usage = []\r | |
75 | self.FeatureFlag = ''\r | |
76 | self.SupArchList = []\r | |
421ccda3 | 77 | self.GuidValue = ''\r |
4234283c LG |
78 | HelpTextObject.__init__(self)\r |
79 | HelpTextListObject.__init__(self)\r | |
f7496d71 | 80 | \r |
4234283c LG |
81 | def SetUsage(self, Usage):\r |
82 | self.Usage = Usage\r | |
83 | \r | |
84 | def GetUsage(self):\r | |
85 | return self.Usage\r | |
86 | \r | |
87 | def SetFeatureFlag(self, FeatureFlag):\r | |
88 | self.FeatureFlag = FeatureFlag\r | |
89 | \r | |
90 | def GetFeatureFlag(self):\r | |
91 | return self.FeatureFlag\r | |
92 | \r | |
93 | def SetSupArchList(self, SupArchList):\r | |
94 | self.SupArchList = SupArchList\r | |
95 | \r | |
96 | def GetSupArchList(self):\r | |
97 | return self.SupArchList\r | |
f7496d71 | 98 | \r |
421ccda3 HC |
99 | def SetGuidValue(self, GuidValue):\r |
100 | self.GuidValue = GuidValue\r | |
f7496d71 | 101 | \r |
421ccda3 HC |
102 | def GetGuidValue(self):\r |
103 | return self.GuidValue\r | |
4234283c LG |
104 | \r |
105 | ## CommonHeaderObject\r | |
106 | #\r | |
107 | # This class defined common header items used in Module/Platform/Package files\r | |
108 | #\r | |
109 | # @param object: Inherited from object class\r | |
110 | #\r | |
111 | class CommonHeaderObject(object):\r | |
112 | def __init__(self):\r | |
421ccda3 HC |
113 | self.AbstractList = []\r |
114 | self.DescriptionList = []\r | |
115 | self.CopyrightList = []\r | |
116 | self.LicenseList = []\r | |
4234283c LG |
117 | \r |
118 | def SetAbstract(self, Abstract):\r | |
421ccda3 HC |
119 | if isinstance(Abstract, list):\r |
120 | self.AbstractList = Abstract\r | |
121 | else:\r | |
122 | self.AbstractList.append(Abstract)\r | |
4234283c LG |
123 | \r |
124 | def GetAbstract(self):\r | |
421ccda3 | 125 | return self.AbstractList\r |
4234283c LG |
126 | \r |
127 | def SetDescription(self, Description):\r | |
421ccda3 HC |
128 | if isinstance(Description, list):\r |
129 | self.DescriptionList = Description\r | |
130 | else:\r | |
131 | self.DescriptionList.append(Description)\r | |
4234283c LG |
132 | \r |
133 | def GetDescription(self):\r | |
421ccda3 | 134 | return self.DescriptionList\r |
4234283c LG |
135 | \r |
136 | def SetCopyright(self, Copyright):\r | |
421ccda3 HC |
137 | if isinstance(Copyright, list):\r |
138 | self.CopyrightList = Copyright\r | |
139 | else:\r | |
140 | self.CopyrightList.append(Copyright)\r | |
4234283c LG |
141 | \r |
142 | def GetCopyright(self):\r | |
421ccda3 | 143 | return self.CopyrightList\r |
4234283c LG |
144 | \r |
145 | def SetLicense(self, License):\r | |
421ccda3 HC |
146 | if isinstance(License, list):\r |
147 | self.LicenseList = License\r | |
148 | else:\r | |
149 | self.LicenseList.append(License)\r | |
4234283c LG |
150 | \r |
151 | def GetLicense(self):\r | |
421ccda3 | 152 | return self.LicenseList\r |
4234283c | 153 | \r |
421ccda3 HC |
154 | ## BinaryHeaderObject\r |
155 | #\r | |
156 | # This class defined Binary header items used in Module/Platform/Package files\r | |
157 | #\r | |
158 | # @param object: Inherited from object class\r | |
159 | #\r | |
160 | class BinaryHeaderObject(object):\r | |
161 | def __init__(self):\r | |
162 | self.BinaryHeaderAbstractList = []\r | |
163 | self.BinaryHeaderDescriptionList = []\r | |
164 | self.BinaryHeaderCopyrightList = []\r | |
165 | self.BinaryHeaderLicenseList = []\r | |
166 | \r | |
167 | def SetBinaryHeaderAbstract(self, Abstract):\r | |
168 | if isinstance(Abstract, list) and Abstract:\r | |
169 | self.BinaryHeaderAbstractList = Abstract\r | |
170 | elif isinstance(Abstract, tuple) and Abstract[1]:\r | |
171 | self.BinaryHeaderAbstractList.append(Abstract)\r | |
172 | \r | |
173 | def GetBinaryHeaderAbstract(self):\r | |
174 | return self.BinaryHeaderAbstractList\r | |
175 | \r | |
176 | def SetBinaryHeaderDescription(self, Description):\r | |
177 | if isinstance(Description, list) and Description:\r | |
178 | self.BinaryHeaderDescriptionList = Description\r | |
179 | elif isinstance(Description, tuple) and Description[1]:\r | |
180 | self.BinaryHeaderDescriptionList.append(Description)\r | |
181 | \r | |
182 | def GetBinaryHeaderDescription(self):\r | |
183 | return self.BinaryHeaderDescriptionList\r | |
184 | \r | |
185 | def SetBinaryHeaderCopyright(self, Copyright):\r | |
186 | if isinstance(Copyright, list) and Copyright:\r | |
187 | self.BinaryHeaderCopyrightList = Copyright\r | |
188 | elif isinstance(Copyright, tuple) and Copyright[1]:\r | |
189 | self.BinaryHeaderCopyrightList.append(Copyright)\r | |
190 | \r | |
191 | def GetBinaryHeaderCopyright(self):\r | |
192 | return self.BinaryHeaderCopyrightList\r | |
193 | \r | |
194 | def SetBinaryHeaderLicense(self, License):\r | |
195 | if isinstance(License, list) and License:\r | |
196 | self.BinaryHeaderLicenseList = License\r | |
197 | elif isinstance(License, tuple) and License[1]:\r | |
198 | self.BinaryHeaderLicenseList.append(License)\r | |
199 | \r | |
200 | def GetBinaryHeaderLicense(self):\r | |
201 | return self.BinaryHeaderLicenseList\r | |
f7496d71 | 202 | \r |
4234283c LG |
203 | ## ClonedRecordObject\r |
204 | #\r | |
205 | # This class defined ClonedRecord items used in Module/Platform/Package files\r | |
f7496d71 | 206 | #\r |
4234283c LG |
207 | # @param object: Inherited from object class\r |
208 | #\r | |
209 | class ClonedRecordObject(object):\r | |
210 | def __init__(self):\r | |
211 | self.IdNum = 0\r | |
212 | self.FarGuid = ''\r | |
213 | self.PackageGuid = ''\r | |
214 | self.PackageVersion = ''\r | |
215 | self.ModuleGuid = ''\r | |
216 | self.ModuleVersion = ''\r | |
217 | \r | |
218 | def SetId(self, IdNo):\r | |
219 | self.IdNum = IdNo\r | |
220 | \r | |
221 | def GetId(self):\r | |
222 | return self.IdNum\r | |
223 | \r | |
224 | def SetFarGuid(self, FarGuid):\r | |
225 | self.FarGuid = FarGuid\r | |
226 | \r | |
227 | def GetFarGuid(self):\r | |
228 | return self.FarGuid\r | |
229 | \r | |
230 | def SetPackageGuid(self, PackageGuid):\r | |
231 | self.PackageGuid = PackageGuid\r | |
232 | \r | |
233 | def GetPackageGuid(self):\r | |
234 | return self.PackageGuid\r | |
235 | \r | |
236 | def SetPackageVersion(self, PackageVersion):\r | |
237 | self.PackageVersion = PackageVersion\r | |
238 | \r | |
239 | def GetPackageVersion(self):\r | |
240 | return self.PackageVersion\r | |
241 | \r | |
242 | def SetModuleGuid(self, ModuleGuid):\r | |
243 | self.ModuleGuid = ModuleGuid\r | |
244 | \r | |
245 | def GetModuleGuid(self):\r | |
246 | return self.ModuleGuid\r | |
247 | \r | |
248 | def SetModuleVersion(self, ModuleVersion):\r | |
249 | self.ModuleVersion = ModuleVersion\r | |
250 | \r | |
251 | def GetModuleVersion(self):\r | |
252 | return self.ModuleVersion\r | |
253 | \r | |
254 | ## TextObject\r | |
255 | #\r | |
256 | # This class defined Text item used in PKG file\r | |
257 | #\r | |
258 | # @param object: Inherited from object class\r | |
259 | #\r | |
260 | class TextObject(object):\r | |
261 | def __init__(self):\r | |
421ccda3 | 262 | self.Lang = TAB_LANGUAGE_EN_US\r |
4234283c LG |
263 | self.String = ''\r |
264 | \r | |
265 | def SetLang(self, Lang):\r | |
266 | self.Lang = Lang\r | |
267 | \r | |
268 | def GetLang(self):\r | |
269 | return self.Lang\r | |
270 | \r | |
271 | def SetString(self, String):\r | |
272 | self.String = String\r | |
273 | \r | |
274 | def GetString(self):\r | |
275 | return self.String\r | |
276 | \r | |
277 | ## FileNameObject\r | |
278 | #\r | |
279 | # This class defined File item used in module, for binary files\r | |
280 | #\r | |
281 | # @param CommonPropertiesObject: Inherited from CommonPropertiesObject class\r | |
282 | #\r | |
283 | class FileNameObject(CommonPropertiesObject):\r | |
284 | def __init__(self):\r | |
285 | self.FileType = ''\r | |
286 | self.Filename = ''\r | |
287 | CommonPropertiesObject.__init__(self)\r | |
f7496d71 | 288 | \r |
4234283c LG |
289 | def SetFileType(self, FileType):\r |
290 | self.FileType = FileType\r | |
291 | \r | |
292 | def GetFileType(self):\r | |
293 | return self.FileType\r | |
294 | \r | |
295 | def SetFilename(self, Filename):\r | |
296 | self.Filename = Filename\r | |
297 | \r | |
298 | def GetFilename(self):\r | |
299 | return self.Filename\r | |
300 | \r | |
301 | ## FileObject\r | |
302 | #\r | |
303 | # This class defined File item used in PKG file\r | |
304 | #\r | |
305 | # @param object: Inherited from object class\r | |
306 | #\r | |
307 | class FileObject(object):\r | |
308 | def __init__(self):\r | |
f7496d71 | 309 | self.Executable = ''\r |
4234283c LG |
310 | self.Uri = ''\r |
311 | self.OsType = ''\r | |
f7496d71 | 312 | \r |
4234283c LG |
313 | def SetExecutable(self, Executable):\r |
314 | self.Executable = Executable\r | |
315 | \r | |
316 | def GetExecutable(self):\r | |
317 | return self.Executable\r | |
318 | \r | |
319 | def SetURI(self, URI):\r | |
320 | self.Uri = URI\r | |
321 | \r | |
322 | def GetURI(self):\r | |
323 | return self.Uri\r | |
324 | \r | |
325 | def SetOS(self, OsType):\r | |
326 | self.OsType = OsType\r | |
327 | \r | |
328 | def GetOS(self):\r | |
329 | return self.OsType\r | |
f7496d71 LG |
330 | \r |
331 | ##\r | |
4234283c LG |
332 | # MiscFileObject is used for xml\r |
333 | #\r | |
334 | # @param CommonHeaderObject: Inherited from CommonHeaderObject class\r | |
335 | #\r | |
336 | class MiscFileObject(CommonHeaderObject):\r | |
337 | def __init__(self):\r | |
338 | self.Name = ''\r | |
f7496d71 | 339 | self.FileList = []\r |
4234283c | 340 | CommonHeaderObject.__init__(self)\r |
f7496d71 | 341 | \r |
4234283c LG |
342 | def SetName(self, Name):\r |
343 | self.Name = Name\r | |
f7496d71 | 344 | \r |
4234283c LG |
345 | def GetName(self):\r |
346 | return self.Name\r | |
f7496d71 | 347 | \r |
4234283c LG |
348 | def SetFileList(self, FileList):\r |
349 | self.FileList = FileList\r | |
f7496d71 | 350 | \r |
4234283c LG |
351 | def GetFileList(self):\r |
352 | return self.FileList\r | |
353 | \r | |
354 | ##\r | |
355 | # ToolsObject\r | |
356 | #\r | |
357 | class ToolsObject(MiscFileObject):\r | |
358 | pass\r | |
359 | \r | |
360 | ## GuidVersionObject\r | |
361 | #\r | |
362 | # This class defined GUID/Version items used in PKG file\r | |
363 | #\r | |
364 | # @param object: Inherited from object class\r | |
365 | #\r | |
366 | class GuidVersionObject(object):\r | |
367 | def __init__(self):\r | |
368 | self.Guid = ''\r | |
369 | self.Version = ''\r | |
370 | \r | |
371 | def SetGuid(self, Guid):\r | |
372 | self.Guid = Guid\r | |
373 | \r | |
374 | def GetGuid(self):\r | |
375 | return self.Guid\r | |
376 | \r | |
377 | def SetVersion(self, Version):\r | |
378 | self.Version = Version\r | |
379 | \r | |
380 | def GetVersion(self):\r | |
381 | return self.Version\r | |
382 | \r | |
383 | ## IdentificationObject\r | |
384 | #\r | |
385 | # This class defined Identification items used in Module/Platform/Package files\r | |
386 | #\r | |
387 | # @param object: Inherited from object class\r | |
388 | #\r | |
389 | class IdentificationObject(GuidVersionObject):\r | |
390 | def __init__(self):\r | |
391 | self.Name = ''\r | |
392 | self.BaseName = ''\r | |
393 | self.FileName = ''\r | |
394 | self.FullPath = ''\r | |
395 | self.RelaPath = ''\r | |
396 | self.PackagePath = ''\r | |
397 | self.ModulePath = ''\r | |
398 | self.CombinePath = ''\r | |
399 | GuidVersionObject.__init__(self)\r | |
f7496d71 | 400 | \r |
4234283c LG |
401 | def SetName(self, Name):\r |
402 | self.Name = Name\r | |
403 | \r | |
404 | def GetName(self):\r | |
405 | return self.Name\r | |
406 | \r | |
407 | def SetBaseName(self, BaseName):\r | |
408 | self.BaseName = BaseName\r | |
409 | \r | |
410 | def GetBaseName(self):\r | |
411 | return self.BaseName\r | |
412 | \r | |
413 | def SetFileName(self, FileName):\r | |
414 | self.FileName = FileName\r | |
415 | \r | |
416 | def GetFileName(self):\r | |
417 | return self.FileName\r | |
418 | \r | |
419 | def SetFullPath(self, FullPath):\r | |
420 | self.FullPath = FullPath\r | |
421 | \r | |
422 | def GetFullPath(self):\r | |
423 | return self.FullPath\r | |
424 | \r | |
425 | def SetRelaPath(self, RelaPath):\r | |
426 | self.RelaPath = RelaPath\r | |
427 | \r | |
428 | def GetRelaPath(self):\r | |
429 | return self.RelaPath\r | |
430 | \r | |
431 | def SetPackagePath(self, PackagePath):\r | |
432 | self.PackagePath = PackagePath\r | |
433 | \r | |
434 | def GetPackagePath(self):\r | |
435 | return self.PackagePath\r | |
436 | \r | |
437 | def SetModulePath(self, ModulePath):\r | |
438 | self.ModulePath = ModulePath\r | |
439 | \r | |
440 | def GetModulePath(self):\r | |
441 | return self.ModulePath\r | |
442 | \r | |
443 | def SetCombinePath(self, CombinePath):\r | |
444 | self.CombinePath = CombinePath\r | |
445 | \r | |
446 | def GetCombinePath(self):\r | |
447 | return self.CombinePath\r | |
448 | \r | |
449 | ## GuidProtocolPpiCommonObject\r | |
450 | #\r | |
f7496d71 | 451 | # This class defined Guid, Protocol and Ppi like items used in\r |
4234283c LG |
452 | # Module/Platform/Package files\r |
453 | #\r | |
454 | # @param CommonPropertiesObject: Inherited from CommonPropertiesObject class\r | |
455 | #\r | |
456 | class GuidProtocolPpiCommonObject(CommonPropertiesObject):\r | |
457 | def __init__(self):\r | |
458 | self.Name = ''\r | |
459 | self.CName = ''\r | |
460 | self.Guid = ''\r | |
461 | self.SupModuleList = []\r | |
462 | CommonPropertiesObject.__init__(self)\r | |
f7496d71 | 463 | \r |
4234283c LG |
464 | def SetName(self, Name):\r |
465 | self.Name = Name\r | |
466 | \r | |
467 | def GetName(self):\r | |
468 | return self.Name\r | |
469 | \r | |
470 | def SetCName(self, CName):\r | |
471 | self.CName = CName\r | |
472 | \r | |
473 | def GetCName(self):\r | |
474 | return self.CName\r | |
475 | \r | |
476 | def SetGuid(self, Guid):\r | |
477 | self.Guid = Guid\r | |
478 | \r | |
479 | def GetGuid(self):\r | |
480 | return self.Guid\r | |
481 | \r | |
482 | def SetSupModuleList(self, SupModuleList):\r | |
483 | self.SupModuleList = SupModuleList\r | |
484 | \r | |
485 | def GetSupModuleList(self):\r | |
486 | return self.SupModuleList\r | |
487 | \r | |
488 | ## GuidObject\r | |
489 | #\r | |
490 | # This class defined Guid item used in Module/Platform/Package files\r | |
491 | #\r | |
492 | # @param GuidProtocolPpiCommonObject: GuidProtocolPpiCommonObject\r | |
493 | #\r | |
494 | class GuidObject(GuidProtocolPpiCommonObject):\r | |
495 | def __init__(self):\r | |
496 | self.VariableName = ''\r | |
497 | self.GuidTypeList = []\r | |
498 | GuidProtocolPpiCommonObject.__init__(self)\r | |
499 | def SetVariableName(self, VariableName):\r | |
500 | self.VariableName = VariableName\r | |
501 | \r | |
502 | def GetVariableName(self):\r | |
503 | return self.VariableName\r | |
504 | \r | |
505 | def SetGuidTypeList(self, GuidTypeList):\r | |
506 | self.GuidTypeList = GuidTypeList\r | |
507 | \r | |
508 | def GetGuidTypeList(self):\r | |
509 | return self.GuidTypeList\r | |
510 | \r | |
511 | ## ProtocolObject\r | |
512 | #\r | |
513 | # This class defined Protocol item used in Module/Platform/Package files\r | |
514 | #\r | |
f7496d71 | 515 | # @param GuidProtocolPpiCommonObject: Inherited from\r |
4234283c LG |
516 | # GuidProtocolPpiCommonObject\r |
517 | #\r | |
518 | class ProtocolObject(GuidProtocolPpiCommonObject):\r | |
519 | def __init__(self):\r | |
520 | self.Notify = False\r | |
521 | GuidProtocolPpiCommonObject.__init__(self)\r | |
522 | def SetNotify(self, Notify):\r | |
523 | self.Notify = Notify\r | |
524 | \r | |
525 | def GetNotify(self):\r | |
526 | return self.Notify\r | |
527 | \r | |
528 | ## PpiObject\r | |
529 | #\r | |
530 | # This class defined Ppi item used in Module/Platform/Package files\r | |
531 | #\r | |
f7496d71 | 532 | # @param GuidProtocolPpiCommonObject: Inherited from\r |
4234283c LG |
533 | # GuidProtocolPpiCommonObject\r |
534 | #\r | |
535 | class PpiObject(GuidProtocolPpiCommonObject):\r | |
536 | def __init__(self):\r | |
537 | self.Notify = False\r | |
538 | GuidProtocolPpiCommonObject.__init__(self)\r | |
539 | def SetNotify(self, Notify):\r | |
540 | self.Notify = Notify\r | |
541 | \r | |
542 | def GetNotify(self):\r | |
543 | return self.Notify\r | |
544 | \r | |
545 | ## DefineObject\r | |
546 | #\r | |
547 | # This class defined item DEFINE used in Module/Platform/Package files\r | |
548 | #\r | |
549 | # @param object: Inherited from object class\r | |
550 | #\r | |
551 | class DefineClass(object):\r | |
552 | def __init__(self):\r | |
553 | self.Define = {}\r | |
554 | \r | |
555 | ## UserExtensionObject\r | |
556 | #\r | |
557 | # @param object: Inherited from object class\r | |
558 | #\r | |
559 | class UserExtensionObject(object):\r | |
560 | def __init__(self):\r | |
561 | self.UserID = ''\r | |
562 | self.Identifier = ''\r | |
421ccda3 HC |
563 | self.BinaryAbstractList = []\r |
564 | self.BinaryDescriptionList = []\r | |
565 | self.BinaryCopyrightList = []\r | |
566 | self.BinaryLicenseList = []\r | |
567 | self.UniLangDefsList = []\r | |
4234283c | 568 | #\r |
f7496d71 | 569 | # { Statement : Arch , ... }\r |
4234283c | 570 | #\r |
f7496d71 | 571 | self.DefinesDict = {}\r |
4234283c LG |
572 | #\r |
573 | # { Arch : Statement , ... }\r | |
574 | #\r | |
f7496d71 | 575 | self.BuildOptionDict = {}\r |
4234283c LG |
576 | self.IncludesDict = {}\r |
577 | self.SourcesDict = {}\r | |
578 | self.BinariesDict = {}\r | |
579 | #\r | |
580 | # UserExtension statement from meta-data file [UserExtension] section\r | |
581 | #\r | |
582 | self.Statement = ''\r | |
583 | self.SupArchList = []\r | |
f7496d71 | 584 | \r |
4234283c LG |
585 | def SetStatement(self, Statement):\r |
586 | self.Statement = Statement\r | |
f7496d71 | 587 | \r |
4234283c LG |
588 | def GetStatement(self):\r |
589 | return self.Statement\r | |
590 | \r | |
591 | def SetSupArchList(self, ArchList):\r | |
592 | self.SupArchList = ArchList\r | |
f7496d71 | 593 | \r |
4234283c LG |
594 | def GetSupArchList(self):\r |
595 | return self.SupArchList\r | |
f7496d71 | 596 | \r |
4234283c LG |
597 | def SetUserID(self, UserID):\r |
598 | self.UserID = UserID\r | |
f7496d71 | 599 | \r |
4234283c LG |
600 | def GetUserID(self):\r |
601 | return self.UserID\r | |
f7496d71 | 602 | \r |
4234283c LG |
603 | def SetIdentifier(self, Identifier):\r |
604 | self.Identifier = Identifier\r | |
f7496d71 | 605 | \r |
4234283c LG |
606 | def GetIdentifier(self):\r |
607 | return self.Identifier\r | |
f7496d71 | 608 | \r |
421ccda3 HC |
609 | def SetUniLangDefsList(self, UniLangDefsList):\r |
610 | self.UniLangDefsList = UniLangDefsList\r | |
f7496d71 | 611 | \r |
421ccda3 HC |
612 | def GetUniLangDefsList(self):\r |
613 | return self.UniLangDefsList\r | |
f7496d71 | 614 | \r |
421ccda3 HC |
615 | def SetBinaryAbstract(self, BinaryAbstractList):\r |
616 | self.BinaryAbstractList = BinaryAbstractList\r | |
f7496d71 | 617 | \r |
421ccda3 HC |
618 | def GetBinaryAbstract(self, Lang=None):\r |
619 | if Lang:\r | |
620 | for (Key, Value) in self.BinaryAbstractList:\r | |
621 | if Key == Lang:\r | |
622 | return Value\r | |
623 | return None\r | |
624 | else:\r | |
625 | return self.BinaryAbstractList\r | |
f7496d71 | 626 | \r |
421ccda3 HC |
627 | def SetBinaryDescription(self, BinaryDescriptionList):\r |
628 | self.BinaryDescriptionList = BinaryDescriptionList\r | |
f7496d71 | 629 | \r |
421ccda3 HC |
630 | def GetBinaryDescription(self, Lang=None):\r |
631 | if Lang:\r | |
632 | for (Key, Value) in self.BinaryDescriptionList:\r | |
633 | if Key == Lang:\r | |
634 | return Value\r | |
635 | return None\r | |
636 | else:\r | |
637 | return self.BinaryDescriptionList\r | |
f7496d71 | 638 | \r |
421ccda3 HC |
639 | def SetBinaryCopyright(self, BinaryCopyrightList):\r |
640 | self.BinaryCopyrightList = BinaryCopyrightList\r | |
f7496d71 | 641 | \r |
421ccda3 HC |
642 | def GetBinaryCopyright(self, Lang=None):\r |
643 | if Lang:\r | |
644 | for (Key, Value) in self.BinaryCopyrightList:\r | |
645 | if Key == Lang:\r | |
646 | return Value\r | |
647 | return None\r | |
648 | else:\r | |
649 | return self.BinaryCopyrightList\r | |
f7496d71 | 650 | \r |
421ccda3 HC |
651 | def SetBinaryLicense(self, BinaryLicenseList):\r |
652 | self.BinaryLicenseList = BinaryLicenseList\r | |
f7496d71 | 653 | \r |
421ccda3 HC |
654 | def GetBinaryLicense(self, Lang=None):\r |
655 | if Lang:\r | |
656 | for (Key, Value) in self.BinaryLicenseList:\r | |
657 | if Key == Lang:\r | |
658 | return Value\r | |
659 | return None\r | |
660 | else:\r | |
661 | return self.BinaryLicenseList\r | |
f7496d71 | 662 | \r |
4234283c LG |
663 | def SetDefinesDict(self, DefinesDict):\r |
664 | self.DefinesDict = DefinesDict\r | |
f7496d71 | 665 | \r |
4234283c LG |
666 | def GetDefinesDict(self):\r |
667 | return self.DefinesDict\r | |
f7496d71 | 668 | \r |
4234283c LG |
669 | def SetBuildOptionDict(self, BuildOptionDict):\r |
670 | self.BuildOptionDict = BuildOptionDict\r | |
f7496d71 | 671 | \r |
4234283c LG |
672 | def GetBuildOptionDict(self):\r |
673 | return self.BuildOptionDict\r | |
674 | \r | |
675 | def SetIncludesDict(self, IncludesDict):\r | |
676 | self.IncludesDict = IncludesDict\r | |
f7496d71 | 677 | \r |
4234283c LG |
678 | def GetIncludesDict(self):\r |
679 | return self.IncludesDict\r | |
680 | \r | |
681 | def SetSourcesDict(self, SourcesDict):\r | |
682 | self.SourcesDict = SourcesDict\r | |
f7496d71 | 683 | \r |
4234283c LG |
684 | def GetSourcesDict(self):\r |
685 | return self.SourcesDict\r | |
686 | \r | |
687 | def SetBinariesDict(self, BinariesDict):\r | |
688 | self.BinariesDict = BinariesDict\r | |
f7496d71 | 689 | \r |
4234283c LG |
690 | def GetBinariesDict(self):\r |
691 | return self.BinariesDict\r | |
692 | \r | |
693 | ## LibraryClassObject\r | |
694 | #\r | |
695 | # This class defined Library item used in Module/Platform/Package files\r | |
696 | #\r | |
697 | # @param CommonPropertiesObject: Inherited from CommonPropertiesObject class\r | |
698 | #\r | |
699 | class LibraryClassObject(CommonPropertiesObject):\r | |
700 | def __init__(self):\r | |
701 | self.LibraryClass = ''\r | |
702 | self.IncludeHeader = ''\r | |
703 | self.SupModuleList = []\r | |
704 | self.RecommendedInstance = GuidVersionObject()\r | |
705 | CommonPropertiesObject.__init__(self)\r | |
f7496d71 | 706 | \r |
4234283c LG |
707 | def SetLibraryClass(self, LibraryClass):\r |
708 | self.LibraryClass = LibraryClass\r | |
f7496d71 | 709 | \r |
4234283c LG |
710 | def GetLibraryClass(self):\r |
711 | return self.LibraryClass\r | |
f7496d71 | 712 | \r |
4234283c LG |
713 | def SetSupModuleList(self, SupModuleList):\r |
714 | self.SupModuleList = SupModuleList\r | |
f7496d71 | 715 | \r |
4234283c LG |
716 | def GetSupModuleList(self):\r |
717 | return self.SupModuleList\r | |
f7496d71 | 718 | \r |
4234283c LG |
719 | def SetIncludeHeader(self, IncludeHeader):\r |
720 | self.IncludeHeader = IncludeHeader\r | |
f7496d71 | 721 | \r |
4234283c LG |
722 | def GetIncludeHeader(self):\r |
723 | return self.IncludeHeader\r | |
f7496d71 | 724 | \r |
4234283c LG |
725 | def SetRecommendedInstance(self, RecommendedInstance):\r |
726 | self.RecommendedInstance = RecommendedInstance\r | |
f7496d71 | 727 | \r |
4234283c LG |
728 | def GetRecommendedInstance(self):\r |
729 | return self.RecommendedInstance\r | |
730 | \r | |
731 | \r | |
732 | ## PcdErrorObject\r | |
733 | #\r | |
734 | # @param object: Inherited from object class\r | |
735 | #\r | |
736 | class PcdErrorObject(object):\r | |
737 | def __init__(self):\r | |
738 | self.ValidValue = ''\r | |
739 | self.ValidValueLang = ''\r | |
740 | self.ValidValueRange = ''\r | |
741 | self.Expression = ''\r | |
742 | self.ErrorNumber = ''\r | |
743 | self.ErrorMessageList = []\r | |
421ccda3 HC |
744 | self.TokenSpaceGuidCName = ''\r |
745 | self.CName = ''\r | |
746 | self.FileLine = ''\r | |
747 | self.LineNum = 0\r | |
4234283c LG |
748 | \r |
749 | def SetValidValue(self, ValidValue):\r | |
750 | self.ValidValue = ValidValue\r | |
f7496d71 | 751 | \r |
4234283c LG |
752 | def GetValidValue(self):\r |
753 | return self.ValidValue\r | |
f7496d71 | 754 | \r |
4234283c LG |
755 | def SetValidValueLang(self, ValidValueLang):\r |
756 | self.ValidValueLang = ValidValueLang\r | |
f7496d71 | 757 | \r |
4234283c LG |
758 | def GetValidValueLang(self):\r |
759 | return self.ValidValueLang\r | |
f7496d71 | 760 | \r |
4234283c LG |
761 | def SetValidValueRange(self, ValidValueRange):\r |
762 | self.ValidValueRange = ValidValueRange\r | |
f7496d71 | 763 | \r |
4234283c LG |
764 | def GetValidValueRange(self):\r |
765 | return self.ValidValueRange\r | |
f7496d71 | 766 | \r |
4234283c LG |
767 | def SetExpression(self, Expression):\r |
768 | self.Expression = Expression\r | |
f7496d71 | 769 | \r |
4234283c LG |
770 | def GetExpression(self):\r |
771 | return self.Expression\r | |
f7496d71 | 772 | \r |
4234283c LG |
773 | def SetErrorNumber(self, ErrorNumber):\r |
774 | self.ErrorNumber = ErrorNumber\r | |
f7496d71 | 775 | \r |
4234283c LG |
776 | def GetErrorNumber(self):\r |
777 | return self.ErrorNumber\r | |
f7496d71 | 778 | \r |
4234283c LG |
779 | def SetErrorMessageList(self, ErrorMessageList):\r |
780 | self.ErrorMessageList = ErrorMessageList\r | |
f7496d71 | 781 | \r |
4234283c LG |
782 | def GetErrorMessageList(self):\r |
783 | return self.ErrorMessageList\r | |
f7496d71 | 784 | \r |
421ccda3 HC |
785 | def SetTokenSpaceGuidCName(self, TokenSpaceGuidCName):\r |
786 | self.TokenSpaceGuidCName = TokenSpaceGuidCName\r | |
f7496d71 | 787 | \r |
421ccda3 HC |
788 | def GetTokenSpaceGuidCName(self):\r |
789 | return self.TokenSpaceGuidCName\r | |
f7496d71 | 790 | \r |
421ccda3 HC |
791 | def SetCName(self, CName):\r |
792 | self.CName = CName\r | |
f7496d71 | 793 | \r |
421ccda3 HC |
794 | def GetCName(self):\r |
795 | return self.CName\r | |
f7496d71 | 796 | \r |
421ccda3 HC |
797 | def SetFileLine(self, FileLine):\r |
798 | self.FileLine = FileLine\r | |
f7496d71 | 799 | \r |
421ccda3 HC |
800 | def GetFileLine(self):\r |
801 | return self.FileLine\r | |
f7496d71 | 802 | \r |
421ccda3 HC |
803 | def SetLineNum(self, LineNum):\r |
804 | self.LineNum = LineNum\r | |
f7496d71 | 805 | \r |
421ccda3 HC |
806 | def GetLineNum(self):\r |
807 | return self.LineNum\r | |
f7496d71 LG |
808 | \r |
809 | \r | |
4234283c LG |
810 | ## IncludeObject\r |
811 | #\r | |
812 | # This class defined Include item used in Module/Platform/Package files\r | |
f7496d71 | 813 | #\r |
4234283c LG |
814 | # @param CommonPropertiesObject: Inherited from CommonPropertiesObject class\r |
815 | #\r | |
816 | class IncludeObject(CommonPropertiesObject):\r | |
817 | def __init__(self):\r | |
818 | self.FilePath = ''\r | |
819 | self.ModuleType = ''\r | |
820 | self.SupModuleList = []\r | |
821 | self.Comment = ''\r | |
822 | CommonPropertiesObject.__init__(self)\r | |
f7496d71 | 823 | \r |
4234283c LG |
824 | def SetFilePath(self, FilePath):\r |
825 | self.FilePath = FilePath\r | |
f7496d71 | 826 | \r |
4234283c LG |
827 | def GetFilePath(self):\r |
828 | return self.FilePath\r | |
f7496d71 | 829 | \r |
4234283c LG |
830 | def SetModuleType(self, ModuleType):\r |
831 | self.ModuleType = ModuleType\r | |
f7496d71 | 832 | \r |
4234283c LG |
833 | def GetModuleType(self):\r |
834 | return self.ModuleType\r | |
f7496d71 | 835 | \r |
4234283c LG |
836 | def SetSupModuleList(self, SupModuleList):\r |
837 | self.SupModuleList = SupModuleList\r | |
f7496d71 | 838 | \r |
4234283c | 839 | def GetSupModuleList(self):\r |
f7496d71 LG |
840 | return self.SupModuleList\r |
841 | \r | |
4234283c LG |
842 | def SetComment(self, Comment):\r |
843 | self.Comment = Comment\r | |
f7496d71 | 844 | \r |
4234283c | 845 | def GetComment(self):\r |
f7496d71 LG |
846 | return self.Comment\r |
847 | \r | |
4234283c LG |
848 | ## PcdObject\r |
849 | #\r | |
850 | # This class defined Pcd item used in Module/Platform/Package files\r | |
851 | #\r | |
852 | # @param CName: Input value for CName, default is ''\r | |
853 | # @param Token: Input value for Token, default is ''\r | |
854 | # @param TokenSpaceGuidCName: Input value for TokenSpaceGuidCName, default is\r | |
855 | # ''\r | |
856 | # @param DatumType: Input value for DatumType, default is ''\r | |
857 | # @param MaxDatumSize: Input value for MaxDatumSize, default is ''\r | |
858 | # @param DefaultValue: Input value for DefaultValue, default is ''\r | |
859 | # @param ItemType: Input value for ItemType, default is ''\r | |
860 | # @param ValidUsage: Input value for ValidUsage, default is []\r | |
861 | # @param SkuInfoList: Input value for SkuInfoList, default is {}\r | |
862 | # @param SupModuleList: Input value for SupModuleList, default is []\r | |
863 | #\r | |
421ccda3 | 864 | class PcdObject(CommonPropertiesObject, HelpTextListObject, PromptListObject):\r |
4234283c LG |
865 | def __init__(self):\r |
866 | self.PcdCName = ''\r | |
867 | self.CName = ''\r | |
868 | self.Token = ''\r | |
869 | self.TokenSpaceGuidCName = ''\r | |
870 | self.TokenSpaceGuidValue = ''\r | |
871 | self.DatumType = ''\r | |
872 | self.MaxDatumSize = ''\r | |
873 | self.DefaultValue = ''\r | |
874 | self.Offset = ''\r | |
875 | self.ValidUsage = ''\r | |
876 | self.ItemType = ''\r | |
f7496d71 LG |
877 | self.PcdErrorsList = []\r |
878 | self.SupModuleList = []\r | |
4234283c LG |
879 | CommonPropertiesObject.__init__(self)\r |
880 | HelpTextListObject.__init__(self)\r | |
421ccda3 | 881 | PromptListObject.__init__(self)\r |
f7496d71 | 882 | \r |
4234283c LG |
883 | def SetPcdCName(self, PcdCName):\r |
884 | self.PcdCName = PcdCName\r | |
f7496d71 | 885 | \r |
4234283c LG |
886 | def GetPcdCName(self):\r |
887 | return self.PcdCName\r | |
f7496d71 | 888 | \r |
4234283c LG |
889 | def SetCName(self, CName):\r |
890 | self.CName = CName\r | |
f7496d71 | 891 | \r |
4234283c LG |
892 | def GetCName(self):\r |
893 | return self.CName\r | |
f7496d71 | 894 | \r |
4234283c LG |
895 | def SetToken(self, Token):\r |
896 | self.Token = Token\r | |
f7496d71 | 897 | \r |
4234283c LG |
898 | def GetOffset(self):\r |
899 | return self.Offset\r | |
900 | \r | |
901 | def SetOffset(self, Offset):\r | |
902 | self.Offset = Offset\r | |
f7496d71 | 903 | \r |
4234283c LG |
904 | def GetToken(self):\r |
905 | return self.Token\r | |
f7496d71 | 906 | \r |
4234283c LG |
907 | def SetTokenSpaceGuidCName(self, TokenSpaceGuidCName):\r |
908 | self.TokenSpaceGuidCName = TokenSpaceGuidCName\r | |
f7496d71 | 909 | \r |
4234283c LG |
910 | def GetTokenSpaceGuidCName(self):\r |
911 | return self.TokenSpaceGuidCName\r | |
f7496d71 | 912 | \r |
4234283c LG |
913 | def SetTokenSpaceGuidValue(self, TokenSpaceGuidValue):\r |
914 | self.TokenSpaceGuidValue = TokenSpaceGuidValue\r | |
f7496d71 | 915 | \r |
4234283c LG |
916 | def GetTokenSpaceGuidValue(self):\r |
917 | return self.TokenSpaceGuidValue\r | |
f7496d71 | 918 | \r |
4234283c LG |
919 | def SetDatumType(self, DatumType):\r |
920 | self.DatumType = DatumType\r | |
f7496d71 | 921 | \r |
4234283c LG |
922 | def GetDatumType(self):\r |
923 | return self.DatumType\r | |
f7496d71 | 924 | \r |
4234283c LG |
925 | def SetMaxDatumSize(self, MaxDatumSize):\r |
926 | self.MaxDatumSize = MaxDatumSize\r | |
f7496d71 | 927 | \r |
4234283c LG |
928 | def GetMaxDatumSize(self):\r |
929 | return self.MaxDatumSize\r | |
930 | \r | |
931 | def SetDefaultValue(self, DefaultValue):\r | |
932 | self.DefaultValue = DefaultValue\r | |
f7496d71 | 933 | \r |
4234283c LG |
934 | def GetDefaultValue(self):\r |
935 | return self.DefaultValue\r | |
936 | \r | |
937 | def SetValidUsage(self, ValidUsage):\r | |
938 | self.ValidUsage = ValidUsage\r | |
f7496d71 | 939 | \r |
4234283c LG |
940 | def GetValidUsage(self):\r |
941 | return self.ValidUsage\r | |
f7496d71 | 942 | \r |
4234283c LG |
943 | def SetPcdErrorsList(self, PcdErrorsList):\r |
944 | self.PcdErrorsList = PcdErrorsList\r | |
f7496d71 | 945 | \r |
4234283c LG |
946 | def GetPcdErrorsList(self):\r |
947 | return self.PcdErrorsList\r | |
948 | \r | |
949 | def SetItemType(self, ItemType):\r | |
950 | self.ItemType = ItemType\r | |
f7496d71 | 951 | \r |
4234283c LG |
952 | def GetItemType(self):\r |
953 | return self.ItemType\r | |
954 | \r | |
955 | def SetSupModuleList(self, SupModuleList):\r | |
956 | self.SupModuleList = SupModuleList\r | |
f7496d71 | 957 | \r |
4234283c LG |
958 | def GetSupModuleList(self):\r |
959 | return self.SupModuleList\r |