CommonObject.py revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
## @file
# This file is used to define common items of class object
#
# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials are licensed and made available
# under the terms and conditions of the BSD License which accompanies this
# distribution. The full text of the license may be found at
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
'''
Common Object
'''
## HelpTextObject
#
# @param object: Inherited from object class
#
class HelpTextObject(object):
def GetHelpText(self):
## HelpTextListObject
#
# @param object: Inherited from object class
#
class HelpTextListObject(object):
self.HelpTextList = []
def GetHelpTextList(self):
return self.HelpTextList
## CommonPropertiesObject
#
#
# @param object: Inherited from object class
# @param Usage: Input value for Usage, default is []
# @param FeatureFlag: Input value for FeatureFalg, default is ''
# @param SupArchList: Input value for SupArchList, default is []
# @param HelpText: Input value for HelpText, default is ''
# @param HelpTextList: Input value for HelpTextList, default is []
#
self.SupArchList = []
def GetFeatureFlag(self):
return self.FeatureFlag
def GetSupArchList(self):
return self.SupArchList
## CommonHeaderObject
#
#
# @param object: Inherited from object class
#
class CommonHeaderObject(object):
def GetAbstract(self):
def GetDescription(self):
return self.Description
def GetCopyright(self):
def GetLicense(self):
## ClonedRecordObject
#
#
# @param object: Inherited from object class
#
class ClonedRecordObject(object):
def GetFarGuid(self):
def GetPackageGuid(self):
return self.PackageGuid
def GetPackageVersion(self):
return self.PackageVersion
def GetModuleGuid(self):
return self.ModuleGuid
def GetModuleVersion(self):
return self.ModuleVersion
## TextObject
#
# This class defined Text item used in PKG file
#
# @param object: Inherited from object class
#
class TextObject(object):
## FileNameObject
#
# This class defined File item used in module, for binary files
#
# @param CommonPropertiesObject: Inherited from CommonPropertiesObject class
#
class FileNameObject(CommonPropertiesObject):
def GetFileType(self):
def GetFilename(self):
## FileObject
#
# This class defined File item used in PKG file
#
# @param object: Inherited from object class
#
class FileObject(object):
def GetExecutable(self):
return self.Executable
##
# MiscFileObject is used for xml
#
# @param CommonHeaderObject: Inherited from CommonHeaderObject class
#
class MiscFileObject(CommonHeaderObject):
def GetFileList(self):
##
# ToolsObject
#
class ToolsObject(MiscFileObject):
pass
## GuidVersionObject
#
#
# @param object: Inherited from object class
#
class GuidVersionObject(object):
def GetVersion(self):
## IdentificationObject
#
#
# @param object: Inherited from object class
#
def GetBaseName(self):
def GetFileName(self):
def GetFullPath(self):
def GetRelaPath(self):
def GetPackagePath(self):
return self.PackagePath
def GetModulePath(self):
return self.ModulePath
def GetCombinePath(self):
return self.CombinePath
## GuidProtocolPpiCommonObject
#
# This class defined Guid, Protocol and Ppi like items used in
#
# @param CommonPropertiesObject: Inherited from CommonPropertiesObject class
#
self.SupModuleList = []
def GetSupModuleList(self):
return self.SupModuleList
## GuidObject
#
#
# @param GuidProtocolPpiCommonObject: GuidProtocolPpiCommonObject
#
self.GuidTypeList = []
def GetVariableName(self):
return self.VariableName
def GetGuidTypeList(self):
return self.GuidTypeList
## ProtocolObject
#
#
# @param GuidProtocolPpiCommonObject: Inherited from
# GuidProtocolPpiCommonObject
#
## PpiObject
#
#
# @param GuidProtocolPpiCommonObject: Inherited from
# GuidProtocolPpiCommonObject
#
class PpiObject(GuidProtocolPpiCommonObject):
## DefineObject
#
#
# @param object: Inherited from object class
#
class DefineClass(object):
## UserExtensionObject
#
# @param object: Inherited from object class
#
class UserExtensionObject(object):
#
# { Statement : Arch , ... }
#
self.DefinesDict = {}
#
# { Arch : Statement , ... }
#
self.BuildOptionDict = {}
self.IncludesDict = {}
self.SourcesDict = {}
self.BinariesDict = {}
#
# UserExtension statement from meta-data file [UserExtension] section
#
self.SupArchList = []
def GetStatement(self):
def GetSupArchList(self):
return self.SupArchList
def GetIdentifier(self):
return self.Identifier
def GetDefinesDict(self):
return self.DefinesDict
def GetBuildOptionDict(self):
return self.BuildOptionDict
def GetIncludesDict(self):
return self.IncludesDict
def GetSourcesDict(self):
return self.SourcesDict
def GetBinariesDict(self):
return self.BinariesDict
## LibraryClassObject
#
#
# @param CommonPropertiesObject: Inherited from CommonPropertiesObject class
#
self.SupModuleList = []
def GetLibraryClass(self):
return self.LibraryClass
def GetSupModuleList(self):
return self.SupModuleList
def GetIncludeHeader(self):
return self.IncludeHeader
def GetRecommendedInstance(self):
return self.RecommendedInstance
## PcdErrorObject
#
# @param object: Inherited from object class
#
class PcdErrorObject(object):
self.ErrorMessageList = []
def GetValidValue(self):
return self.ValidValue
def GetValidValueLang(self):
return self.ValidValueLang
def GetValidValueRange(self):
return self.ValidValueRange
def GetExpression(self):
return self.Expression
def GetErrorNumber(self):
return self.ErrorNumber
def GetErrorMessageList(self):
return self.ErrorMessageList
## IncludeObject
#
#
# @param CommonPropertiesObject: Inherited from CommonPropertiesObject class
#
class IncludeObject(CommonPropertiesObject):
self.SupModuleList = []
def GetFilePath(self):
def GetModuleType(self):
return self.ModuleType
def GetSupModuleList(self):
return self.SupModuleList
def GetComment(self):
## PcdObject
#
#
# @param CName: Input value for CName, default is ''
# @param Token: Input value for Token, default is ''
# @param TokenSpaceGuidCName: Input value for TokenSpaceGuidCName, default is
# ''
# @param DatumType: Input value for DatumType, default is ''
# @param MaxDatumSize: Input value for MaxDatumSize, default is ''
# @param DefaultValue: Input value for DefaultValue, default is ''
# @param ItemType: Input value for ItemType, default is ''
# @param ValidUsage: Input value for ValidUsage, default is []
# @param SkuInfoList: Input value for SkuInfoList, default is {}
# @param SupModuleList: Input value for SupModuleList, default is []
#
self.PcdErrorsList = []
self.SupModuleList = []
def GetPcdCName(self):
def GetTokenSpaceGuidCName(self):
return self.TokenSpaceGuidCName
def GetTokenSpaceGuidValue(self):
return self.TokenSpaceGuidValue
def GetDatumType(self):
def GetMaxDatumSize(self):
return self.MaxDatumSize
def GetDefaultValue(self):
return self.DefaultValue
def GetValidUsage(self):
return self.ValidUsage
def GetPcdErrorsList(self):
return self.PcdErrorsList
def GetItemType(self):
def GetSupModuleList(self):
return self.SupModuleList