Refine file header format to follow coding style.

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Object / POM / CommonObject.py

## @file\r
# This file is used to define common items of class object\r
#\r
# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available \r
# under the terms and conditions of the BSD License which accompanies this \r
# distribution. The full text of the license may be found at \r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
'''\r
Common Object\r
'''\r
from Library.DataType import LANGUAGE_EN_US\r
\r
## HelpTextObject\r
#\r
# @param object:       Inherited from object class\r
#\r
class HelpTextObject(object):\r
    def __init__(self):\r
        self.HelpText = TextObject()\r
    \r
    def SetHelpText(self, HelpText):\r
        self.HelpText = HelpText\r
    \r
    def GetHelpText(self):\r
        return self.HelpText\r
\r
## HelpTextListObject\r
#\r
# @param object:       Inherited from object class\r
#\r
class HelpTextListObject(object):\r
    def __init__(self):\r
        self.HelpTextList = []\r
    \r
    def SetHelpTextList(self, HelpTextList):\r
        self.HelpTextList = HelpTextList\r
    \r
    def GetHelpTextList(self):\r
        return self.HelpTextList\r
\r
## CommonPropertiesObject\r
#\r
# This class defined common attribution used in Module/Platform/Package files\r
#\r
# @param object:       Inherited from object class\r
# @param Usage:        Input value for Usage, default is []\r
# @param FeatureFlag:  Input value for FeatureFalg, default is ''\r
# @param SupArchList:  Input value for SupArchList, default is []\r
# @param HelpText:     Input value for HelpText, default is ''\r
# @param HelpTextList: Input value for HelpTextList, default is []\r
#\r
class CommonPropertiesObject(HelpTextObject, HelpTextListObject):\r
    def __init__(self):\r
        self.Usage = []\r
        self.FeatureFlag = ''\r
        self.SupArchList = []\r
        HelpTextObject.__init__(self)\r
        HelpTextListObject.__init__(self)\r
        \r
    def SetUsage(self, Usage):\r
        self.Usage = Usage\r
\r
    def GetUsage(self):\r
        return self.Usage\r
\r
    def SetFeatureFlag(self, FeatureFlag):\r
        self.FeatureFlag = FeatureFlag\r
\r
    def GetFeatureFlag(self):\r
        return self.FeatureFlag\r
\r
    def SetSupArchList(self, SupArchList):\r
        self.SupArchList = SupArchList\r
\r
    def GetSupArchList(self):\r
        return self.SupArchList\r
\r
## CommonHeaderObject\r
#\r
# This class defined common header items used in Module/Platform/Package files\r
#\r
# @param object:          Inherited from object class\r
#\r
class CommonHeaderObject(object):\r
    def __init__(self):\r
        self.Abstract = ''\r
        self.Description = ''\r
        self.Copyright = ''\r
        self.License = ''\r
\r
    def SetAbstract(self, Abstract):\r
        self.Abstract = Abstract\r
\r
    def GetAbstract(self):\r
        return self.Abstract\r
\r
    def SetDescription(self, Description):\r
        self.Description = Description\r
\r
    def GetDescription(self):\r
        return self.Description\r
\r
    def SetCopyright(self, Copyright):\r
        self.Copyright = Copyright\r
\r
    def GetCopyright(self):\r
        return self.Copyright\r
\r
    def SetLicense(self, License):\r
        self.License = License\r
\r
    def GetLicense(self):\r
        return self.License\r
\r
## ClonedRecordObject\r
#\r
# This class defined ClonedRecord items used in Module/Platform/Package files\r
# \r
# @param object:        Inherited from object class\r
#\r
class ClonedRecordObject(object):\r
    def __init__(self):\r
        self.IdNum = 0\r
        self.FarGuid = ''\r
        self.PackageGuid = ''\r
        self.PackageVersion = ''\r
        self.ModuleGuid = ''\r
        self.ModuleVersion = ''\r
\r
    def SetId(self, IdNo):\r
        self.IdNum = IdNo\r
\r
    def GetId(self):\r
        return self.IdNum\r
\r
    def SetFarGuid(self, FarGuid):\r
        self.FarGuid = FarGuid\r
\r
    def GetFarGuid(self):\r
        return self.FarGuid\r
\r
    def SetPackageGuid(self, PackageGuid):\r
        self.PackageGuid = PackageGuid\r
\r
    def GetPackageGuid(self):\r
        return self.PackageGuid\r
\r
    def SetPackageVersion(self, PackageVersion):\r
        self.PackageVersion = PackageVersion\r
\r
    def GetPackageVersion(self):\r
        return self.PackageVersion\r
\r
    def SetModuleGuid(self, ModuleGuid):\r
        self.ModuleGuid = ModuleGuid\r
\r
    def GetModuleGuid(self):\r
        return self.ModuleGuid\r
\r
    def SetModuleVersion(self, ModuleVersion):\r
        self.ModuleVersion = ModuleVersion\r
\r
    def GetModuleVersion(self):\r
        return self.ModuleVersion\r
\r
## TextObject\r
#\r
# This class defined Text item used in PKG file\r
#\r
# @param object:     Inherited from object class\r
#\r
class TextObject(object):\r
    def __init__(self):\r
        self.Lang = LANGUAGE_EN_US\r
        self.String = ''\r
\r
    def SetLang(self, Lang):\r
        self.Lang = Lang\r
\r
    def GetLang(self):\r
        return self.Lang\r
\r
    def SetString(self, String):\r
        self.String = String\r
\r
    def GetString(self):\r
        return self.String\r
\r
## FileNameObject\r
#\r
# This class defined File item used in module, for binary files\r
#\r
# @param CommonPropertiesObject:   Inherited from CommonPropertiesObject class\r
#\r
class FileNameObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.FileType = ''\r
        self.Filename = ''\r
        CommonPropertiesObject.__init__(self)\r
        \r
    def SetFileType(self, FileType):\r
        self.FileType = FileType\r
\r
    def GetFileType(self):\r
        return self.FileType\r
\r
    def SetFilename(self, Filename):\r
        self.Filename = Filename\r
\r
    def GetFilename(self):\r
        return self.Filename\r
\r
## FileObject\r
#\r
# This class defined File item used in PKG file\r
#\r
# @param object:   Inherited from object class\r
#\r
class FileObject(object):\r
    def __init__(self):\r
        self.Executable = ''\r
        self.Uri = ''\r
        self.OsType = ''\r
\r
    def SetExecutable(self, Executable):\r
        self.Executable = Executable\r
\r
    def GetExecutable(self):\r
        return self.Executable\r
\r
    def SetURI(self, URI):\r
        self.Uri = URI\r
\r
    def GetURI(self):\r
        return self.Uri\r
\r
    def SetOS(self, OsType):\r
        self.OsType = OsType\r
\r
    def GetOS(self):\r
        return self.OsType\r
    \r
## \r
# MiscFileObject is used for xml\r
#\r
# @param CommonHeaderObject:   Inherited from CommonHeaderObject class\r
#\r
class MiscFileObject(CommonHeaderObject):\r
    def __init__(self):\r
        self.Name = ''\r
        self.FileList = [] \r
        CommonHeaderObject.__init__(self)\r
        \r
    def SetName(self, Name):\r
        self.Name = Name\r
    \r
    def GetName(self):\r
        return self.Name\r
    \r
    def SetFileList(self, FileList):\r
        self.FileList = FileList\r
        \r
    def GetFileList(self):\r
        return self.FileList\r
\r
##\r
# ToolsObject\r
#\r
class ToolsObject(MiscFileObject):\r
    pass\r
\r
## GuidVersionObject\r
#\r
# This class defined GUID/Version items used in PKG file\r
#\r
# @param object:     Inherited from object class\r
#\r
class GuidVersionObject(object):\r
    def __init__(self):\r
        self.Guid = ''\r
        self.Version = ''\r
\r
    def SetGuid(self, Guid):\r
        self.Guid = Guid\r
\r
    def GetGuid(self):\r
        return self.Guid\r
\r
    def SetVersion(self, Version):\r
        self.Version = Version\r
\r
    def GetVersion(self):\r
        return self.Version\r
\r
## IdentificationObject\r
#\r
# This class defined Identification items used in Module/Platform/Package files\r
#\r
# @param object:    Inherited from object class\r
#\r
class IdentificationObject(GuidVersionObject):\r
    def __init__(self):\r
        self.Name = ''\r
        self.BaseName = ''\r
        self.FileName = ''\r
        self.FullPath = ''\r
        self.RelaPath = ''\r
        self.PackagePath = ''\r
        self.ModulePath = ''\r
        self.CombinePath = ''\r
        GuidVersionObject.__init__(self)\r
        \r
    def SetName(self, Name):\r
        self.Name = Name\r
\r
    def GetName(self):\r
        return self.Name\r
\r
    def SetBaseName(self, BaseName):\r
        self.BaseName = BaseName\r
\r
    def GetBaseName(self):\r
        return self.BaseName\r
\r
    def SetFileName(self, FileName):\r
        self.FileName = FileName\r
\r
    def GetFileName(self):\r
        return self.FileName\r
\r
    def SetFullPath(self, FullPath):\r
        self.FullPath = FullPath\r
\r
    def GetFullPath(self):\r
        return self.FullPath\r
\r
    def SetRelaPath(self, RelaPath):\r
        self.RelaPath = RelaPath\r
\r
    def GetRelaPath(self):\r
        return self.RelaPath\r
\r
    def SetPackagePath(self, PackagePath):\r
        self.PackagePath = PackagePath\r
\r
    def GetPackagePath(self):\r
        return self.PackagePath\r
\r
    def SetModulePath(self, ModulePath):\r
        self.ModulePath = ModulePath\r
\r
    def GetModulePath(self):\r
        return self.ModulePath\r
\r
    def SetCombinePath(self, CombinePath):\r
        self.CombinePath = CombinePath\r
\r
    def GetCombinePath(self):\r
        return self.CombinePath\r
\r
## GuidProtocolPpiCommonObject\r
#\r
# This class defined Guid, Protocol and Ppi like items used in \r
# Module/Platform/Package files\r
#\r
# @param CommonPropertiesObject:    Inherited from CommonPropertiesObject class\r
#\r
class GuidProtocolPpiCommonObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.Name = ''\r
        self.CName = ''\r
        self.Guid = ''\r
        self.SupModuleList = []\r
        CommonPropertiesObject.__init__(self)\r
        \r
    def SetName(self, Name):\r
        self.Name = Name\r
\r
    def GetName(self):\r
        return self.Name\r
\r
    def SetCName(self, CName):\r
        self.CName = CName\r
\r
    def GetCName(self):\r
        return self.CName\r
\r
    def SetGuid(self, Guid):\r
        self.Guid = Guid\r
\r
    def GetGuid(self):\r
        return self.Guid\r
\r
    def SetSupModuleList(self, SupModuleList):\r
        self.SupModuleList = SupModuleList\r
\r
    def GetSupModuleList(self):\r
        return self.SupModuleList\r
\r
## GuidObject\r
#\r
# This class defined Guid item used in Module/Platform/Package files\r
#\r
# @param GuidProtocolPpiCommonObject:  GuidProtocolPpiCommonObject\r
#\r
class GuidObject(GuidProtocolPpiCommonObject):\r
    def __init__(self):\r
        self.VariableName = ''\r
        self.GuidTypeList = []\r
        GuidProtocolPpiCommonObject.__init__(self)\r
    def SetVariableName(self, VariableName):\r
        self.VariableName = VariableName\r
\r
    def GetVariableName(self):\r
        return self.VariableName\r
\r
    def SetGuidTypeList(self, GuidTypeList):\r
        self.GuidTypeList = GuidTypeList\r
\r
    def GetGuidTypeList(self):\r
        return self.GuidTypeList\r
\r
## ProtocolObject\r
#\r
# This class defined Protocol item used in Module/Platform/Package files\r
#\r
# @param GuidProtocolPpiCommonObject:  Inherited from \r
#                                      GuidProtocolPpiCommonObject\r
#\r
class ProtocolObject(GuidProtocolPpiCommonObject):\r
    def __init__(self):\r
        self.Notify = False\r
        GuidProtocolPpiCommonObject.__init__(self)\r
    def SetNotify(self, Notify):\r
        self.Notify = Notify\r
\r
    def GetNotify(self):\r
        return self.Notify\r
\r
## PpiObject\r
#\r
# This class defined Ppi item used in Module/Platform/Package files\r
#\r
# @param GuidProtocolPpiCommonObject:  Inherited from \r
#                                      GuidProtocolPpiCommonObject\r
#\r
class PpiObject(GuidProtocolPpiCommonObject):\r
    def __init__(self):\r
        self.Notify = False\r
        GuidProtocolPpiCommonObject.__init__(self)\r
    def SetNotify(self, Notify):\r
        self.Notify = Notify\r
\r
    def GetNotify(self):\r
        return self.Notify\r
\r
## DefineObject\r
#\r
# This class defined item DEFINE used in Module/Platform/Package files\r
#\r
# @param object:  Inherited from object class\r
#\r
class DefineClass(object):\r
    def __init__(self):\r
        self.Define = {}\r
\r
## UserExtensionObject\r
#\r
# @param object:  Inherited from object class\r
#\r
class UserExtensionObject(object):\r
    def __init__(self):\r
        self.UserID = ''\r
        self.Identifier = ''\r
        #\r
        # { Statement : Arch , ... }    \r
        #\r
        self.DefinesDict = {} \r
        #\r
        # { Arch : Statement , ... }\r
        #\r
        self.BuildOptionDict = {} \r
        self.IncludesDict = {}\r
        self.SourcesDict = {}\r
        self.BinariesDict = {}\r
        #\r
        # UserExtension statement from meta-data file [UserExtension] section\r
        #\r
        self.Statement = ''\r
        self.SupArchList = []\r
        \r
    def SetStatement(self, Statement):\r
        self.Statement = Statement\r
    \r
    def GetStatement(self):\r
        return self.Statement\r
\r
    def SetSupArchList(self, ArchList):\r
        self.SupArchList = ArchList\r
    \r
    def GetSupArchList(self):\r
        return self.SupArchList\r
        \r
    def SetUserID(self, UserID):\r
        self.UserID = UserID\r
    \r
    def GetUserID(self):\r
        return self.UserID\r
    \r
    def SetIdentifier(self, Identifier):\r
        self.Identifier = Identifier\r
        \r
    def GetIdentifier(self):\r
        return self.Identifier\r
    \r
    def SetDefinesDict(self, DefinesDict):\r
        self.DefinesDict = DefinesDict\r
    \r
    def GetDefinesDict(self):\r
        return self.DefinesDict\r
    \r
    def SetBuildOptionDict(self, BuildOptionDict):\r
        self.BuildOptionDict = BuildOptionDict\r
        \r
    def GetBuildOptionDict(self):\r
        return self.BuildOptionDict\r
\r
    def SetIncludesDict(self, IncludesDict):\r
        self.IncludesDict = IncludesDict\r
        \r
    def GetIncludesDict(self):\r
        return self.IncludesDict\r
\r
    def SetSourcesDict(self, SourcesDict):\r
        self.SourcesDict = SourcesDict\r
        \r
    def GetSourcesDict(self):\r
        return self.SourcesDict\r
\r
    def SetBinariesDict(self, BinariesDict):\r
        self.BinariesDict = BinariesDict\r
        \r
    def GetBinariesDict(self):\r
        return self.BinariesDict\r
\r
## LibraryClassObject\r
#\r
# This class defined Library item used in Module/Platform/Package files\r
#\r
# @param CommonPropertiesObject:  Inherited from CommonPropertiesObject class\r
#\r
class LibraryClassObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.LibraryClass = ''\r
        self.IncludeHeader = ''\r
        self.SupModuleList = []\r
        self.RecommendedInstance = GuidVersionObject()\r
        CommonPropertiesObject.__init__(self)\r
        \r
    def SetLibraryClass(self, LibraryClass):\r
        self.LibraryClass = LibraryClass\r
    \r
    def GetLibraryClass(self):\r
        return self.LibraryClass\r
    \r
    def SetSupModuleList(self, SupModuleList):\r
        self.SupModuleList = SupModuleList\r
    \r
    def GetSupModuleList(self):\r
        return self.SupModuleList\r
    \r
    def SetIncludeHeader(self, IncludeHeader):\r
        self.IncludeHeader = IncludeHeader\r
        \r
    def GetIncludeHeader(self):\r
        return self.IncludeHeader\r
    \r
    def SetRecommendedInstance(self, RecommendedInstance):\r
        self.RecommendedInstance = RecommendedInstance\r
    \r
    def GetRecommendedInstance(self):\r
        return self.RecommendedInstance\r
\r
\r
## PcdErrorObject\r
#\r
# @param object:  Inherited from object class\r
#\r
class PcdErrorObject(object):\r
    def __init__(self):\r
        self.ValidValue = ''\r
        self.ValidValueLang = ''\r
        self.ValidValueRange = ''\r
        self.Expression = ''\r
        self.ErrorNumber = ''\r
        self.ErrorMessageList = []\r
\r
    def SetValidValue(self, ValidValue):\r
        self.ValidValue = ValidValue\r
    \r
    def GetValidValue(self):\r
        return self.ValidValue\r
    \r
    def SetValidValueLang(self, ValidValueLang):\r
        self.ValidValueLang = ValidValueLang\r
        \r
    def GetValidValueLang(self):\r
        return self.ValidValueLang\r
    \r
    def SetValidValueRange(self, ValidValueRange):\r
        self.ValidValueRange = ValidValueRange\r
        \r
    def GetValidValueRange(self):\r
        return self.ValidValueRange\r
    \r
    def SetExpression(self, Expression):\r
        self.Expression = Expression\r
    \r
    def GetExpression(self):\r
        return self.Expression\r
    \r
    def SetErrorNumber(self, ErrorNumber):\r
        self.ErrorNumber = ErrorNumber\r
        \r
    def GetErrorNumber(self):\r
        return self.ErrorNumber\r
    \r
    def SetErrorMessageList(self, ErrorMessageList):\r
        self.ErrorMessageList = ErrorMessageList\r
        \r
    def GetErrorMessageList(self):\r
        return self.ErrorMessageList\r
    \r
\r
## IncludeObject\r
#\r
# This class defined Include item used in Module/Platform/Package files\r
# \r
# @param CommonPropertiesObject:  Inherited from CommonPropertiesObject class\r
#\r
class IncludeObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.FilePath = ''\r
        self.ModuleType = ''\r
        self.SupModuleList = []\r
        self.Comment = ''\r
        CommonPropertiesObject.__init__(self)\r
    \r
    def SetFilePath(self, FilePath):\r
        self.FilePath = FilePath\r
    \r
    def GetFilePath(self):\r
        return self.FilePath\r
    \r
    def SetModuleType(self, ModuleType):\r
        self.ModuleType = ModuleType\r
    \r
    def GetModuleType(self):\r
        return self.ModuleType\r
    \r
    def SetSupModuleList(self, SupModuleList):\r
        self.SupModuleList = SupModuleList\r
 \r
    def GetSupModuleList(self):\r
        return self.SupModuleList              \r
               \r
    def SetComment(self, Comment):\r
        self.Comment = Comment\r
 \r
    def GetComment(self):\r
        return self.Comment \r
    \r
## PcdObject\r
#\r
# This class defined Pcd item used in Module/Platform/Package files\r
#\r
# @param CName:                Input value for CName, default is ''\r
# @param Token:                Input value for Token, default is ''\r
# @param TokenSpaceGuidCName:  Input value for TokenSpaceGuidCName, default is\r
#                              ''\r
# @param DatumType:            Input value for DatumType, default is ''\r
# @param MaxDatumSize:         Input value for MaxDatumSize, default is ''\r
# @param DefaultValue:         Input value for DefaultValue, default is ''\r
# @param ItemType:             Input value for ItemType, default is ''\r
# @param ValidUsage:           Input value for ValidUsage, default is []\r
# @param SkuInfoList:          Input value for SkuInfoList, default is {}\r
# @param SupModuleList:        Input value for SupModuleList, default is []\r
#\r
class PcdObject(CommonPropertiesObject, HelpTextListObject):\r
    def __init__(self):\r
        self.PcdCName = ''\r
        self.CName = ''\r
        self.Token = ''\r
        self.TokenSpaceGuidCName = ''\r
        self.TokenSpaceGuidValue = ''\r
        self.DatumType = ''\r
        self.MaxDatumSize = ''\r
        self.DefaultValue = ''\r
        self.Offset = ''\r
        self.ValidUsage = ''\r
        self.ItemType = ''\r
        self.PcdErrorsList = [] \r
        self.SupModuleList = []        \r
        CommonPropertiesObject.__init__(self)\r
        HelpTextListObject.__init__(self)\r
    \r
    def SetPcdCName(self, PcdCName):\r
        self.PcdCName = PcdCName\r
        \r
    def GetPcdCName(self):\r
        return self.PcdCName\r
    \r
    def SetCName(self, CName):\r
        self.CName = CName\r
    \r
    def GetCName(self):\r
        return self.CName\r
    \r
    def SetToken(self, Token):\r
        self.Token = Token\r
    \r
    def GetOffset(self):\r
        return self.Offset\r
\r
    def SetOffset(self, Offset):\r
        self.Offset = Offset\r
    \r
    def GetToken(self):\r
        return self.Token\r
    \r
    def SetTokenSpaceGuidCName(self, TokenSpaceGuidCName):\r
        self.TokenSpaceGuidCName = TokenSpaceGuidCName\r
    \r
    def GetTokenSpaceGuidCName(self):\r
        return self.TokenSpaceGuidCName\r
    \r
    def SetTokenSpaceGuidValue(self, TokenSpaceGuidValue):\r
        self.TokenSpaceGuidValue = TokenSpaceGuidValue\r
    \r
    def GetTokenSpaceGuidValue(self):\r
        return self.TokenSpaceGuidValue\r
    \r
    def SetDatumType(self, DatumType):\r
        self.DatumType = DatumType\r
        \r
    def GetDatumType(self):\r
        return self.DatumType\r
    \r
    def SetMaxDatumSize(self, MaxDatumSize):\r
        self.MaxDatumSize = MaxDatumSize\r
    \r
    def GetMaxDatumSize(self):\r
        return self.MaxDatumSize\r
\r
    def SetDefaultValue(self, DefaultValue):\r
        self.DefaultValue = DefaultValue\r
        \r
    def GetDefaultValue(self):\r
        return self.DefaultValue\r
\r
    def SetValidUsage(self, ValidUsage):\r
        self.ValidUsage = ValidUsage\r
    \r
    def GetValidUsage(self):\r
        return self.ValidUsage\r
    \r
    def SetPcdErrorsList(self, PcdErrorsList):\r
        self.PcdErrorsList = PcdErrorsList\r
    \r
    def GetPcdErrorsList(self):\r
        return self.PcdErrorsList\r
\r
    def SetItemType(self, ItemType):\r
        self.ItemType = ItemType\r
        \r
    def GetItemType(self):\r
        return self.ItemType\r
\r
    def SetSupModuleList(self, SupModuleList):\r
        self.SupModuleList = SupModuleList\r
        \r
    def GetSupModuleList(self):\r
        return self.SupModuleList\r