BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file is used to define a class object to describe a module\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
'''\r
ModuleObject\r
'''\r
\r
##\r
# Import Modules\r
#\r
from Object.POM.CommonObject import CommonPropertiesObject\r
from Object.POM.CommonObject import IdentificationObject\r
from Object.POM.CommonObject import CommonHeaderObject\r
from Object.POM.CommonObject import BinaryHeaderObject\r
from Object.POM.CommonObject import HelpTextListObject\r
from Object.POM.CommonObject import GuidVersionObject\r
\r
\r
##\r
# BootModeObject\r
#\r
class BootModeObject(CommonPropertiesObject, HelpTextListObject):\r
    def __init__(self):\r
        self.SupportedBootModes = ''\r
        CommonPropertiesObject.__init__(self)\r
        HelpTextListObject.__init__(self)\r
\r
    def SetSupportedBootModes(self, SupportedBootModes):\r
        self.SupportedBootModes = SupportedBootModes\r
\r
    def GetSupportedBootModes(self):\r
        return self.SupportedBootModes\r
\r
##\r
# EventObject\r
#\r
class EventObject(CommonPropertiesObject, HelpTextListObject):\r
    def __init__(self):\r
        self.EventType = ''\r
        CommonPropertiesObject.__init__(self)\r
        HelpTextListObject.__init__(self)\r
\r
    def SetEventType(self, EventType):\r
        self.EventType = EventType\r
\r
    def GetEventType(self):\r
        return self.EventType\r
\r
##\r
# HobObject\r
#\r
class HobObject(CommonPropertiesObject, HelpTextListObject):\r
    def __init__(self):\r
        self.HobType = ''\r
        CommonPropertiesObject.__init__(self)\r
        HelpTextListObject.__init__(self)\r
\r
    def SetHobType(self, HobType):\r
        self.HobType = HobType\r
\r
    def GetHobType(self):\r
        return self.HobType\r
\r
##\r
# SpecObject\r
#\r
class SpecObject(object):\r
    def __init__(self):\r
        self.Spec = ''\r
        self.Version = ''\r
\r
    def SetSpec(self, Spec):\r
        self.Spec = Spec\r
\r
    def GetSpec(self):\r
        return self.Spec\r
\r
    def SetVersion(self, Version):\r
        self.Version = Version\r
\r
    def GetVersion(self):\r
        return self.Version\r
\r
## ModuleHeaderObject\r
#\r
# This class defined header items used in Module file\r
#\r
class ModuleHeaderObject(IdentificationObject, CommonHeaderObject, BinaryHeaderObject):\r
    def __init__(self):\r
        self.IsLibrary = False\r
        self.IsLibraryModList = []\r
        self.ModuleType = ''\r
        self.BinaryModule = False\r
        self.PcdIsDriver = ''\r
        self.PiSpecificationVersion = ''\r
        self.UefiSpecificationVersion = ''\r
        self.UNIFlag = False\r
        self.ModuleUniFile = ''\r
        #\r
        # SpecObject\r
        #\r
        self.SpecList = []\r
        #\r
        # BootModeObject\r
        #\r
        self.BootModeList = []\r
        #\r
        # EventObject\r
        #\r
        self.EventList = []\r
        #\r
        # HobObject\r
        #\r
        self.HobList = []\r
        #\r
        # LibraryClassObject\r
        #\r
        self.LibraryClassList = []\r
        self.SupArchList = []\r
        IdentificationObject.__init__(self)\r
        CommonHeaderObject.__init__(self)\r
        BinaryHeaderObject.__init__(self)\r
\r
    def SetIsLibrary(self, IsLibrary):\r
        self.IsLibrary = IsLibrary\r
\r
    def GetIsLibrary(self):\r
        return self.IsLibrary\r
\r
    def SetIsLibraryModList(self, IsLibraryModList):\r
        self.IsLibraryModList = IsLibraryModList\r
\r
    def GetIsLibraryModList(self):\r
        return self.IsLibraryModList\r
\r
    def SetModuleType(self, ModuleType):\r
        self.ModuleType = ModuleType\r
\r
    def GetModuleType(self):\r
        return self.ModuleType\r
\r
    def SetBinaryModule(self, BinaryModule):\r
        self.BinaryModule = BinaryModule\r
\r
    def GetBinaryModule(self):\r
        return self.BinaryModule\r
\r
    def SetPcdIsDriver(self, PcdIsDriver):\r
        self.PcdIsDriver = PcdIsDriver\r
\r
    def GetPcdIsDriver(self):\r
        return self.PcdIsDriver\r
\r
    def SetPiSpecificationVersion(self, PiSpecificationVersion):\r
        self.PiSpecificationVersion = PiSpecificationVersion\r
\r
    def GetPiSpecificationVersion(self):\r
        return self.PiSpecificationVersion\r
\r
    def SetUefiSpecificationVersion(self, UefiSpecificationVersion):\r
        self.UefiSpecificationVersion = UefiSpecificationVersion\r
\r
    def GetUefiSpecificationVersion(self):\r
        return self.UefiSpecificationVersion\r
\r
    def SetSpecList(self, SpecList):\r
        self.SpecList = SpecList\r
\r
    def GetSpecList(self):\r
        return self.SpecList\r
\r
    def SetBootModeList(self, BootModeList):\r
        self.BootModeList = BootModeList\r
\r
    def GetBootModeList(self):\r
        return self.BootModeList\r
\r
    def SetEventList(self, EventList):\r
        self.EventList = EventList\r
\r
    def GetEventList(self):\r
        return self.EventList\r
\r
    def SetHobList(self, HobList):\r
        self.HobList = HobList\r
\r
    def GetHobList(self):\r
        return self.HobList\r
\r
    def SetLibraryClassList(self, LibraryClassList):\r
        self.LibraryClassList = LibraryClassList\r
\r
    def GetLibraryClassList(self):\r
        return self.LibraryClassList\r
\r
    def SetSupArchList(self, SupArchList):\r
        self.SupArchList = SupArchList\r
\r
    def GetSupArchList(self):\r
        return self.SupArchList\r
\r
    def SetModuleUniFile(self, ModuleUniFile):\r
        self.ModuleUniFile = ModuleUniFile\r
\r
    def GetModuleUniFile(self):\r
        return self.ModuleUniFile\r
##\r
# SourceFileObject\r
#\r
class SourceFileObject(CommonPropertiesObject):\r
    def __init__(self):\r
        CommonPropertiesObject.__init__(self)\r
        self.SourceFile = ''\r
        self.TagName = ''\r
        self.ToolCode = ''\r
        self.Family = ''\r
        self.FileType = ''\r
\r
    def SetSourceFile(self, SourceFile):\r
        self.SourceFile = SourceFile\r
\r
    def GetSourceFile(self):\r
        return  self.SourceFile\r
\r
    def SetTagName(self, TagName):\r
        self.TagName = TagName\r
\r
    def GetTagName(self):\r
        return self.TagName\r
\r
    def SetToolCode(self, ToolCode):\r
        self.ToolCode = ToolCode\r
\r
    def GetToolCode(self):\r
        return self.ToolCode\r
\r
    def SetFamily(self, Family):\r
        self.Family = Family\r
\r
    def GetFamily(self):\r
        return self.Family\r
\r
    def SetFileType(self, FileType):\r
        self.FileType = FileType\r
\r
    def GetFileType(self):\r
        return self.FileType\r
\r
\r
##\r
# BinaryFileObject\r
#\r
class BinaryFileObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.FileNamList = []\r
        self.AsBuiltList = []\r
        CommonPropertiesObject.__init__(self)\r
\r
    def SetFileNameList(self, FileNamList):\r
        self.FileNamList = FileNamList\r
\r
    def GetFileNameList(self):\r
        return self.FileNamList\r
\r
    def SetAsBuiltList(self, AsBuiltList):\r
        self.AsBuiltList = AsBuiltList\r
\r
    def GetAsBuiltList(self):\r
        return self.AsBuiltList\r
\r
\r
##\r
# AsBuildLibraryClassObject\r
#\r
class AsBuildLibraryClassObject(object):\r
    def __init__(self):\r
        self.LibGuid = ''\r
        self.LibVersion = ''\r
        self.SupArchList = []\r
\r
    def SetLibGuid(self, LibGuid):\r
        self.LibGuid = LibGuid\r
    def GetLibGuid(self):\r
        return self.LibGuid\r
\r
    def SetLibVersion(self, LibVersion):\r
        self.LibVersion = LibVersion\r
    def GetLibVersion(self):\r
        return self.LibVersion\r
\r
    def SetSupArchList(self, SupArchList):\r
        self.SupArchList = SupArchList\r
    def GetSupArchList(self):\r
        return self.SupArchList\r
\r
##\r
# AsBuiltObject\r
#\r
class AsBuiltObject(object):\r
    def __init__(self):\r
        #\r
        # list of PcdObject\r
        #\r
        self.PatchPcdList = []\r
        #\r
        # list of PcdObject\r
        #\r
        self.PcdExValueList = []\r
        #\r
        # list of GuidVersionObject\r
        #\r
        self.LibraryInstancesList = []\r
        #\r
        # List of BinaryBuildFlag object\r
        #\r
        self.BinaryBuildFlagList = []\r
\r
    def SetPatchPcdList(self, PatchPcdList):\r
        self.PatchPcdList = PatchPcdList\r
\r
    def GetPatchPcdList(self):\r
        return self.PatchPcdList\r
\r
    def SetPcdExList(self, PcdExValueList):\r
        self.PcdExValueList = PcdExValueList\r
\r
    def GetPcdExList(self):\r
        return self.PcdExValueList\r
\r
    def SetLibraryInstancesList(self, LibraryInstancesList):\r
        self.LibraryInstancesList = LibraryInstancesList\r
\r
    def GetLibraryInstancesList(self):\r
        return self.LibraryInstancesList\r
\r
    def SetBuildFlagsList(self, BinaryBuildFlagList):\r
        self.BinaryBuildFlagList = BinaryBuildFlagList\r
\r
    def GetBuildFlagsList(self):\r
        return self.BinaryBuildFlagList\r
\r
##\r
# BinaryBuildFlag, this object will include those fields that are not\r
# covered by the UPT Spec BinaryFile field\r
#\r
class BinaryBuildFlagObject(object):\r
    def __init__(self):\r
        self.Target = ''\r
        self.TagName = ''\r
        self.Family = ''\r
        self.AsBuiltOptionFlags = ''\r
\r
    def SetTarget(self, Target):\r
        self.Target = Target\r
\r
    def GetTarget(self):\r
        return self.Target\r
\r
    def SetTagName(self, TagName):\r
        self.TagName = TagName\r
\r
    def GetTagName(self):\r
        return self.TagName\r
\r
    def SetFamily(self, Family):\r
        self.Family = Family\r
\r
    def GetFamily(self):\r
        return self.Family\r
\r
    def SetAsBuiltOptionFlags(self, AsBuiltOptionFlags):\r
        self.AsBuiltOptionFlags = AsBuiltOptionFlags\r
    def GetAsBuiltOptionFlags(self):\r
        return self.AsBuiltOptionFlags\r
\r
##\r
# ExternObject\r
#\r
class ExternObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.EntryPoint = ''\r
        self.UnloadImage = ''\r
        self.Constructor = ''\r
        self.Destructor = ''\r
        self.SupModList = []\r
        CommonPropertiesObject.__init__(self)\r
\r
    def SetEntryPoint(self, EntryPoint):\r
        self.EntryPoint = EntryPoint\r
\r
    def GetEntryPoint(self):\r
        return self.EntryPoint\r
\r
    def SetUnloadImage(self, UnloadImage):\r
        self.UnloadImage = UnloadImage\r
\r
    def GetUnloadImage(self):\r
        return self.UnloadImage\r
\r
    def SetConstructor(self, Constructor):\r
        self.Constructor = Constructor\r
\r
    def GetConstructor(self):\r
        return self.Constructor\r
\r
    def SetDestructor(self, Destructor):\r
        self.Destructor = Destructor\r
\r
    def GetDestructor(self):\r
        return self.Destructor\r
\r
    def SetSupModList(self, SupModList):\r
        self.SupModList = SupModList\r
    def GetSupModList(self):\r
        return self.SupModList\r
\r
##\r
# DepexObject\r
#\r
class DepexObject(CommonPropertiesObject):\r
    def __init__(self):\r
        self.Depex = ''\r
        self.ModuelType = ''\r
        CommonPropertiesObject.__init__(self)\r
\r
    def SetDepex(self, Depex):\r
        self.Depex = Depex\r
\r
    def GetDepex(self):\r
        return self.Depex\r
\r
    def SetModuleType(self, ModuleType):\r
        self.ModuelType = ModuleType\r
\r
    def GetModuleType(self):\r
        return self.ModuelType\r
\r
##\r
# PackageDependencyObject\r
#\r
class PackageDependencyObject(GuidVersionObject, CommonPropertiesObject):\r
    def __init__(self):\r
        self.Package = ''\r
        self.PackageFilePath = ''\r
        GuidVersionObject.__init__(self)\r
        CommonPropertiesObject.__init__(self)\r
\r
    def SetPackageFilePath(self, PackageFilePath):\r
        self.PackageFilePath = PackageFilePath\r
\r
    def GetPackageFilePath(self):\r
        return self.PackageFilePath\r
\r
    def SetPackage(self, Package):\r
        self.Package = Package\r
\r
    def GetPackage(self):\r
        return self.Package\r
\r
##\r
# BuildOptionObject\r
#\r
class BuildOptionObject(CommonPropertiesObject):\r
    def __init__(self):\r
        CommonPropertiesObject.__init__(self)\r
        self.BuildOption = ''\r
\r
    def SetBuildOption(self, BuildOption):\r
        self.BuildOption = BuildOption\r
\r
    def GetBuildOption(self):\r
        return self.BuildOption\r
\r
##\r
# ModuleObject\r
#\r
class ModuleObject(ModuleHeaderObject):\r
    def __init__(self):\r
        #\r
        # {Arch : ModuleHeaderObject}\r
        #\r
        self.HeaderDict = {}\r
        #\r
        # LibraryClassObject\r
        #\r
        self.LibraryClassList = []\r
        #\r
        # SourceFileObject\r
        #\r
        self.SourceFileList = []\r
        #\r
        # BinaryFileObject\r
        #\r
        self.BinaryFileList = []\r
        #\r
        # PackageDependencyObject\r
        #\r
        self.PackageDependencyList = []\r
        #\r
        # DepexObject\r
        #\r
        self.PeiDepex = []\r
        #\r
        # DepexObject\r
        #\r
        self.DxeDepex = []\r
        #\r
        # DepexObject\r
        #\r
        self.SmmDepex = []\r
        #\r
        # ProtocolObject\r
        #\r
        self.ProtocolList = []\r
        #\r
        # PpiObject\r
        #\r
        self.PpiList = []\r
        #\r
        # GuidObject\r
        #\r
        self.GuidList = []\r
        #\r
        # PcdObject\r
        #\r
        self.PcdList = []\r
        #\r
        # ExternObject\r
        #\r
        self.ExternList = []\r
        #\r
        # BuildOptionObject\r
        #\r
        self.BuildOptionList = []\r
        #\r
        # UserExtensionObject\r
        #\r
        self.UserExtensionList = []\r
        #\r
        # MiscFileObject\r
        #\r
        self.MiscFileList = []\r
        #\r
        # ClonedFromObject\r
        #\r
        self.ClonedFrom = None\r
\r
        ModuleHeaderObject.__init__(self)\r
\r
    def SetHeaderDict(self, HeaderDict):\r
        self.HeaderDict = HeaderDict\r
\r
    def GetHeaderDict(self):\r
        return self.HeaderDict\r
\r
    def SetLibraryClassList(self, LibraryClassList):\r
        self.LibraryClassList = LibraryClassList\r
\r
    def GetLibraryClassList(self):\r
        return self.LibraryClassList\r
\r
    def SetSourceFileList(self, SourceFileList):\r
        self.SourceFileList = SourceFileList\r
\r
    def GetSourceFileList(self):\r
        return self.SourceFileList\r
\r
    def SetBinaryFileList(self, BinaryFileList):\r
        self.BinaryFileList = BinaryFileList\r
\r
    def GetBinaryFileList(self):\r
        return self.BinaryFileList\r
\r
    def SetPackageDependencyList(self, PackageDependencyList):\r
        self.PackageDependencyList = PackageDependencyList\r
\r
    def GetPackageDependencyList(self):\r
        return self.PackageDependencyList\r
\r
    def SetPeiDepex(self, PeiDepex):\r
        self.PeiDepex = PeiDepex\r
\r
    def GetPeiDepex(self):\r
        return self.PeiDepex\r
\r
    def SetDxeDepex(self, DxeDepex):\r
        self.DxeDepex = DxeDepex\r
\r
    def GetDxeDepex(self):\r
        return self.DxeDepex\r
\r
    def SetSmmDepex(self, SmmDepex):\r
        self.SmmDepex = SmmDepex\r
\r
    def GetSmmDepex(self):\r
        return self.SmmDepex\r
\r
    def SetPpiList(self, PpiList):\r
        self.PpiList = PpiList\r
\r
    def GetPpiList(self):\r
        return self.PpiList\r
\r
    def SetProtocolList(self, ProtocolList):\r
        self.ProtocolList = ProtocolList\r
\r
    def GetProtocolList(self):\r
        return self.ProtocolList\r
\r
    def SetPcdList(self, PcdList):\r
        self.PcdList = PcdList\r
\r
    def GetPcdList(self):\r
        return self.PcdList\r
\r
    def SetGuidList(self, GuidList):\r
        self.GuidList = GuidList\r
\r
    def GetGuidList(self):\r
        return self.GuidList\r
\r
    def SetExternList(self, ExternList):\r
        self.ExternList = ExternList\r
\r
    def GetExternList(self):\r
        return self.ExternList\r
\r
    def SetBuildOptionList(self, BuildOptionList):\r
        self.BuildOptionList = BuildOptionList\r
\r
    def GetBuildOptionList(self):\r
        return self.BuildOptionList\r
\r
    def SetUserExtensionList(self, UserExtensionList):\r
        self.UserExtensionList = UserExtensionList\r
\r
    def GetUserExtensionList(self):\r
        return self.UserExtensionList\r
\r
    def SetMiscFileList(self, MiscFileList):\r
        self.MiscFileList = MiscFileList\r
\r
    def GetMiscFileList(self):\r
        return self.MiscFileList\r
\r
    def SetClonedFrom(self, ClonedFrom):\r
        self.ClonedFrom = ClonedFrom\r
\r
    def GetClonedFrom(self):\r
        return self.ClonedFrom\r