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