[mirror_edk2.git] / BaseTools / Source / Python / msa2inf / LoadMsa.py

## @file\r
# Open an MSA file and load all its contents to a ModuleClass object.\r
#\r
# Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this 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
##\r
# Import Modules\r
#\r
import os\r
from CommonDataClass.ModuleClass import *\r
from Common.XmlRoutines import *\r
from Common.MigrationUtilities import *\r
\r
\r
## Load a list of Module Cloned Records.\r
#\r
# Read an input Module XML DOM object and return a list of Cloned Records\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel ClonedRecords        A list of Cloned Records loaded from XmlMsa.\r
#\r
def LoadModuleClonedRecords(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/ModuleDefinitions/ClonedFrom/Cloned"\r
    return map(LoadClonedRecord, XmlList(XmlMsa, XmlTag))\r
\r
## Load Module Header.\r
#\r
# Read an input Module XML DOM object and return Module Header class object\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
# @param  MsaFileName          The file path of MSA File.\r
#\r
# @retvel ModuleHeader         A new Module Header object loaded from XmlMsa.\r
#\r
def LoadModuleHeader(XmlMsa, MsaFileName):\r
    ModuleHeader = ModuleHeaderClass()\r
    \r
    XmlTag = "ModuleSurfaceArea/MsaHeader"\r
    MsaHeader = XmlNode(XmlMsa, XmlTag)\r
    \r
    SetIdentification(ModuleHeader, MsaHeader, "ModuleName", MsaFileName)\r
    SetCommonHeader(ModuleHeader, MsaHeader)\r
\r
    XmlTag = "ModuleSurfaceArea/ModuleDefinitions/SupportedArchitectures"\r
    ModuleHeader.SupArchList = XmlElement(XmlMsa, XmlTag).split()\r
\r
    XmlTag = "ModuleSurfaceArea/ModuleDefinitions/BinaryModule"\r
    if XmlElement(XmlMsa, XmlTag).lower() == "true":\r
        ModuleHeader.BinaryModule = True\r
\r
    XmlTag = "ModuleSurfaceArea/ModuleDefinitions/OutputFileBasename"\r
    ModuleHeader.OutputFileBasename = XmlElement(XmlMsa, XmlTag)\r
    \r
    XmlTag = "ModuleSurfaceArea/ModuleDefinitions/ClonedForm"\r
    ModuleHeader.ClonedFrom = LoadModuleClonedRecords(XmlMsa)\r
\r
    XmlTag = "ModuleSurfaceArea/Externs/PcdDriverTypes"\r
    ModuleHeader.PcdIsDriver = XmlElement(XmlMsa, XmlTag)\r
    \r
    XmlTag = "ModuleSurfaceArea/Externs/TianoEdkFlashMap_h"\r
    if XmlElement(XmlMsa, XmlTag).lower() == "true":\r
        ModuleHeader.TianoEdkFlashMap_h = True\r
\r
    XmlTag = "ModuleSurfaceArea/Externs/Specification"\r
    for Specification in XmlElementList(XmlMsa, XmlTag):\r
        AddToSpecificationDict(ModuleHeader.Specification, Specification)\r
        \r
    return ModuleHeader\r
\r
\r
## Load a list of Module Library Classes.\r
#\r
# Read an input Module XML DOM object and return a list of Library Classes\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel LibraryClasses       A list of Library Classes loaded from XmlMsa.\r
#\r
def LoadModuleLibraryClasses(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/LibraryClassDefinitions/LibraryClass"\r
    return map(LoadLibraryClass, XmlList(XmlMsa, XmlTag))\r
    \r
\r
## Load a new Module Source class object.\r
#\r
# Read an input XML Source DOM object and return an object of Source\r
# contained in the DOM object.\r
#\r
# @param  XmlFilename          A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleSource         A new Source object created by XmlFilename.\r
#\r
def LoadModuleSource(XmlFilename):\r
    ModuleSource = ModuleSourceFileClass()\r
    \r
    ModuleSource.SourceFile = XmlElementData(XmlFilename)\r
\r
    XmlTag = "TagName"\r
    ModuleSource.TagName = XmlAttribute(XmlFilename, XmlTag)\r
    \r
    XmlTag = "ToolCode"\r
    ModuleSource.ToolCode = XmlAttribute(XmlFilename, XmlTag)\r
    \r
    XmlTag = "ToolChainFamily"\r
    ModuleSource.ToolChainFamily = XmlAttribute(XmlFilename, XmlTag)\r
    \r
    SetCommon(ModuleSource, XmlFilename)\r
    \r
    return ModuleSource\r
\r
\r
## Load a list of Module Sources.\r
#\r
# Read an input Module XML DOM object and return a list of Sources\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Sources              A list of Sources loaded from XmlMsa.\r
#\r
def LoadModuleSources(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/SourceFiles/Filename"\r
    return map(LoadModuleSource, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module Binary class object.\r
#\r
# Read an input XML Binary DOM object and return an object of Binary\r
# contained in the DOM object.\r
#\r
# @param  XmlFilename          A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleBinary         A new Binary object created by XmlFilename.\r
#\r
def LoadModuleBinary(XmlFilename):\r
    ModuleBinary = ModuleBinaryFileClass()\r
    \r
    ModuleBinary.BinaryFile = XmlElementData(XmlFilename)\r
    \r
    XmlTag = "FileType"\r
    ModuleBinary.FileType = XmlElementAttribute(XmlFilename, XmlTag)\r
    \r
    SetCommon(ModuleBinary, XmlFilename)\r
    \r
\r
## Load a list of Module Binaries.\r
#\r
# Read an input Module XML DOM object and return a list of Binaries\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Binaries             A list of Binaries loaded from XmlMsa.\r
#\r
def LoadModuleBinaries(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/BinaryFiles/Filename"\r
    return map(LoadModuleBinary, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module Non Processed Files.\r
#\r
# Read an input Module XML DOM object and return a list of Non Processed Files\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel NonProcessedFiles    A list of Non Processed Files loaded from XmlMsa.\r
#\r
def LoadModuleNonProcessedFiles(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/NonProcessedFiles/Filename"\r
    return XmlElementList(XmlMsa, XmlTag)\r
\r
\r
## Load a new Module Package Dependency class object.\r
#\r
# Read an input XML PackageDependency DOM object and return an object of Package Dependency\r
# contained in the DOM object.\r
#\r
# @param  XmlPackage              A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModulePackageDependency A new Package Dependency object created by XmlPackage.\r
#\r
def LoadModulePackageDependency(XmlPackage):\r
    ModulePackageDependency = ModulePackageDependencyClass()\r
\r
    XmlTag = "PackageGuid"\r
    PackageKey = XmlAttribute(XmlPackage, XmlTag)\r
    \r
    #\r
    #TODO: Add resolution for Package name, package Version\r
    #\r
    ModulePackageDependency.PackageGuid = PackageKey\r
    SetCommon(ModulePackageDependency, XmlPackage)\r
\r
    return ModulePackageDependency\r
    \r
\r
## Load a list of Module Package Dependencies.\r
#\r
# Read an input Module XML DOM object and return a list of Package Dependencies\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel PackageDependencies  A list of Package Dependencies loaded from XmlMsa.\r
#\r
def LoadModulePackageDependencies(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/PackageDependencies/Package"\r
    return map(LoadModulePackageDependency, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module Protocols.\r
#\r
# Read an input Module XML DOM object and return a list of Protocols\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Protocols            A list of Protocols loaded from XmlMsa.\r
#\r
def LoadModuleProtocols(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/Protocols/Protocol"\r
    XmlProtocolList = XmlList(XmlMsa, XmlTag)\r
\r
    XmlTag = "ModuleSurfaceArea/Protocols/ProtocolNotify"\r
    XmlProtocolList += XmlList(XmlMsa, XmlTag)\r
\r
    return map(LoadGuidProtocolPpiCommon, XmlProtocolList)\r
\r
\r
## Load a list of Module Ppis.\r
#\r
# Read an input Module XML DOM object and return a list of Ppis\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Ppis                 A list of Ppis loaded from XmlMsa.\r
#\r
def LoadModulePpis(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/PPIs/Ppi"\r
    XmlPpiList = XmlList(XmlMsa, XmlTag)\r
    \r
    XmlTag = "ModuleSurfaceArea/PPIs/PpiNotify"\r
    XmlPpiList += XmlList(XmlMsa, XmlTag)\r
    \r
    return map(LoadGuidProtocolPpiCommon, XmlPpiList)\r
\r
\r
## Load a new Module Event class object.\r
#\r
# Read an input XML Event DOM object and return an object of Event\r
# contained in the DOM object.\r
#\r
# @param  XmlEvent             A child XML DOM object in Module XML DOM.\r
# @param  Type                 Specify the event type: SIGNAL_EVENT or CREATE_EVENT.\r
#\r
# @retvel ModuleEvent          A new Event object created by XmlEvent.\r
#\r
def LoadModuleEvent(XmlEvent, Type):\r
    ModuleEvent = ModuleEventClass()\r
    \r
    XmlTag = "EventTypes/EventType"\r
    ModuleEvent.CName = XmlElement(XmlEvent, XmlTag)\r
    \r
    XmlTag = "EventGuidCName"\r
    ModuleEvent.GuidCName = XmlAttribute(XmlEvent, XmlTag)\r
    \r
    ModuleEvent.Type = Type\r
    \r
    SetCommon(ModuleEvent, XmlEvent)\r
    \r
    return ModuleEvent\r
    \r
\r
## Load a list of Module Events.\r
#\r
# Read an input Module XML DOM object and return a list of Events\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Events               A list of Events loaded from XmlMsa.\r
#\r
def LoadModuleEvents(XmlMsa):\r
    ModuleEvents = []\r
    \r
    XmlTag = "ModuleSurfaceArea/Events/CreateEvents/EventTypes"\r
    for XmlCreateEvent in XmlList(XmlMsa, XmlTag):\r
        ModuleEvent = LoadModuleEvent(XmlCreateEvent, "CREATE_EVENT")\r
        ModuleEvents.append(ModuleEvent)\r
\r
    XmlTag = "ModuleSurfaceArea/Events/SignalEvents/EventTypes"\r
    for XmlCreateEvent in XmlList(XmlMsa, XmlTag):\r
        ModuleEvent = LoadModuleEvent(XmlCreateEvent, "SIGNAL_EVENT")\r
        ModuleEvents.append(ModuleEvent)\r
\r
    return ModuleEvents\r
\r
\r
## Load a new Module Hob class object.\r
#\r
# Read an input XML Hob DOM object and return an object of Hob\r
# contained in the DOM object.\r
#\r
# @param  XmlHob               A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleHob            A new Hob object created by XmlHob.\r
#\r
def LoadModuleHob(XmlHob):\r
    ModuleHob = ModuleHobClass()\r
    \r
    XmlTag = "HobTypes/HobType"\r
    ModuleHob.Type = XmlElement(XmlHob, XmlTag)\r
    \r
    XmlTag = "HobGuidCName"\r
    ModuleHob.GuidCName = XmlAttribute(XmlHob, XmlTag)\r
    \r
    SetCommon(ModuleHob, XmlHob)\r
    \r
    return ModuleHob\r
\r
\r
## Load a list of Module Hobs.\r
#\r
# Read an input Module XML DOM object and return a list of Hobs\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Hobs                 A list of Hobs loaded from XmlMsa.\r
#\r
def LoadModuleHobs(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/Hobs/HobTypes"\r
    return map(LoadModuleHob, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module Variable class object.\r
#\r
# Read an input XML Variable DOM object and return an object of Variable\r
# contained in the DOM object.\r
#\r
# @param  XmlVariable          A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleVariable       A new Variable object created by XmlVariable.\r
#\r
def LoadModuleVariable(XmlVariable):\r
    ModuleVariable = ModuleVariableClass()\r
    \r
    XmlTag = "Variable/VariableName"\r
    HexWordArray = XmlElement(XmlVariable, XmlTag).split()\r
    try:\r
        ModuleVariable.Name = "".join([unichr(int(a, 16)) for a in HexWordArray])\r
    except:\r
        ModuleVariable.Name = ""\r
        \r
    XmlTag = "Variable/GuidC_Name"\r
    ModuleVariable.GuidCName = XmlElement(XmlVariable, XmlTag)\r
    \r
    SetCommon(ModuleVariable, XmlVariable)\r
    \r
    return ModuleVariable\r
\r
\r
## Load a list of Module Variables.\r
#\r
# Read an input Module XML DOM object and return a list of Variables\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Variables            A list of Variables loaded from XmlMsa.\r
#\r
def LoadModuleVariables(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/Variables/Variable"\r
    return map(LoadModuleVariable, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module Boot Mode class object.\r
#\r
# Read an input XML BootMode DOM object and return an object of Boot Mode\r
# contained in the DOM object.\r
#\r
# @param  XmlBootMode          A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleBootMode       A new Boot Mode object created by XmlBootMode.\r
#\r
def LoadModuleBootMode(XmlBootMode):\r
    ModuleBootMode = ModuleBootModeClass()\r
    \r
    XmlTag = "BootModeName"\r
    ModuleBootMode.Name = XmlAttribute(XmlBootMode, XmlTag)\r
    \r
    SetCommon(ModuleBootMode, XmlBootMode)\r
    \r
    return ModuleBootMode\r
\r
\r
## Load a list of Module Boot Modes.\r
#\r
# Read an input Module XML DOM object and return a list of Boot Modes\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel BootModes            A list of Boot Modes loaded from XmlMsa.\r
#\r
def LoadModuleBootModes(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/BootModes/BootMode"\r
    return map(LoadModuleBootMode, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module System Table class object.\r
#\r
# Read an input XML SystemTable DOM object and return an object of System Table\r
# contained in the DOM object.\r
#\r
# @param  XmlSystemTable       A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleSystemTable    A new System Table object created by XmlSystemTable.\r
#\r
def LoadModuleSystemTable(XmlSystemTable):\r
    ModuleSystemTable = ModuleSystemTableClass()\r
    \r
    XmlTag = "SystemTable/SystemTableCName"\r
    ModuleSystemTable.CName = XmlElement(XmlSystemTable, XmlTag)\r
    \r
    SetCommon(ModuleSystemTable, XmlSystemTable)\r
    \r
    return ModuleSystemTable\r
    \r
\r
## Load a list of Module System Tables.\r
#\r
# Read an input Module XML DOM object and return a list of System Tables\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel SystemTables         A list of System Tables loaded from XmlMsa.\r
#\r
def LoadModuleSystemTables(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/SystemTables/SystemTableCNames"\r
    return map(LoadModuleSystemTable, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module Data Hub class object.\r
#\r
# Read an input XML DataHub DOM object and return an object of Data Hub\r
# contained in the DOM object.\r
#\r
# @param  XmlDataHub           A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleDataHub        A new Data Hub object created by XmlDataHub.\r
#\r
def LoadModuleDataHub(XmlDataHub):\r
    ModuleDataHub = ModuleDataHubClass()\r
    \r
    XmlTag = "DataHub/DataHubCName"\r
    ModuleDataHub.CName = XmlElement(XmlDataHub, "DataHubCName")\r
    \r
    SetCommon(ModuleDataHub, XmlDataHub)\r
\r
    return ModuleDataHub\r
\r
\r
## Load a list of Module Data Hubs.\r
#\r
# Read an input Module XML DOM object and return a list of Data Hubs\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel DataHubs             A list of Data Hubs loaded from XmlMsa.\r
#\r
def LoadModuleDataHubs(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/DataHubs/DataHubRecord"\r
    return map(LoadModuleDataHub, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a new Module Hii Package class object.\r
#\r
# Read an input XML HiiPackage DOM object and return an object of Hii Package\r
# contained in the DOM object.\r
#\r
# @param  XmlHiiPackage        A child XML DOM object in Module XML DOM.\r
#\r
# @retvel ModuleHiiPackage     A new Hii Package object created by XmlHiiPackage.\r
#\r
def LoadModuleHiiPackage(XmlHiiPackage):\r
    ModuleHiiPackage = ModuleHiiPackageClass()\r
\r
    XmlTag = "HiiPackage/HiiPackageCName"\r
    ModuleHiiPackage.CName = XmlElement(XmlHiiPackage, "HiiCName")\r
\r
    SetCommon(ModuleHiiPackage, XmlHiiPackage)\r
\r
    return ModuleHiiPackage\r
\r
\r
## Load a list of Module Hii Packages.\r
#\r
# Read an input Module XML DOM object and return a list of Hii Packages\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel HiiPackages          A list of Hii Packages loaded from XmlMsa.\r
#\r
def LoadModuleHiiPackages(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/HiiPackages/HiiPackage"\r
    return map(LoadModuleHiiPackage, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module Guids.\r
#\r
# Read an input Module XML DOM object and return a list of Guids\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel Guids                A list of Guids loaded from XmlMsa.\r
#\r
def LoadModuleGuids(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/Guids/GuidCNames"\r
    return map(LoadGuidProtocolPpiCommon, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module Pcd Codes.\r
#\r
# Read an input Module XML DOM object and return a list of Pcd Codes\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel PcdCodes             A list of Pcd Codes loaded from XmlMsa.\r
#\r
def LoadModulePcdCodes(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/PcdCoded/PcdEntry"\r
    return map(LoadPcd, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module Extern Images.\r
#\r
# Read an input Module XML DOM object and return a list of Extern Images\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel ExternImages         A list of Extern Images loaded from XmlMsa.\r
#\r
def LoadModuleExternImages(XmlMsa):\r
    ModuleExternImages = []\r
    \r
    XmlTag = "ModuleSurfaceArea/Externs/Extern"\r
    for XmlExtern in XmlList(XmlMsa, XmlTag):\r
        XmlTag = "Extern/ModuleEntryPoint"\r
        ModuleEntryPoint = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/ModuleUnloadImage"\r
        ModuleUnloadImage = XmlElement(XmlExtern, XmlTag)\r
        if ModuleEntryPoint == "" and ModuleUnloadImage == "":\r
            continue\r
\r
        ModuleExtern = ModuleExternImageClass()\r
        ModuleExtern.ModuleEntryPoint = ModuleEntryPoint\r
        ModuleExtern.ModuleUnloadImage = ModuleUnloadImage\r
        ModuleExternImages.append(ModuleExtern)\r
\r
    return ModuleExternImages\r
\r
\r
## Load a list of Module Extern Libraries.\r
#\r
# Read an input Module XML DOM object and return a list of Extern Libraries\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel ExternLibraries      A list of Extern Libraries loaded from XmlMsa.\r
#\r
def LoadModuleExternLibraries(XmlMsa):\r
    ModuleExternLibraries = []\r
    \r
    XmlTag = "ModuleSurfaceArea/Externs/Extern"\r
    for XmlExtern in XmlList(XmlMsa, XmlTag):\r
        XmlTag = "Extern/Constructor"\r
        Constructor = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/Destructor"\r
        Destructor = XmlElement(XmlExtern, XmlTag)\r
        if Constructor == "" and Destructor == "":\r
            continue\r
        \r
        ModuleExtern = ModuleExternLibraryClass()\r
        ModuleExtern.Constructor = Constructor\r
        ModuleExtern.Destructor = Destructor\r
        ModuleExternLibraries.append(ModuleExtern)\r
\r
    return ModuleExternLibraries\r
\r
\r
## Load a list of Module Extern Drivers.\r
#\r
# Read an input Module XML DOM object and return a list of Extern Drivers\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel ExternDrivers        A list of Extern Drivers loaded from XmlMsa.\r
#\r
def LoadModuleExternDrivers(XmlMsa):\r
    ModuleExternDrivers = []\r
    \r
    XmlTag = "ModuleSurfaceArea/Externs/Extern"\r
    for XmlExtern in XmlList(XmlMsa, XmlTag):\r
        XmlTag = "Extern/DriverBinding"\r
        DriverBinding = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/ComponentName"\r
        ComponentName = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/DriverConfig"\r
        DriverConfig = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/DriverDiag"\r
        DriverDiag = XmlElement(XmlExtern, XmlTag)\r
        if DriverBinding == "":\r
            continue\r
        \r
        ModuleExtern = ModuleExternDriverClass()\r
        ModuleExtern.DriverBinding = DriverBinding\r
        ModuleExtern.ComponentName = ComponentName\r
        ModuleExtern.DriverConfig = DriverConfig\r
        ModuleExtern.DriverDiag = DriverDiag\r
        ModuleExternDrivers.append(ModuleExtern)\r
\r
    return ModuleExternDrivers\r
\r
\r
## Load a list of Module Extern Call Backs.\r
#\r
# Read an input Module XML DOM object and return a list of Extern Call Backs\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel ExternCallBacks      A list of Extern Call Backs loaded from XmlMsa.\r
#\r
def LoadModuleExternCallBacks(XmlMsa):\r
    ModuleExternCallBacks = []\r
    \r
    XmlTag = "ModuleSurfaceArea/Externs/Extern"\r
    for XmlExtern in XmlList(XmlMsa, XmlTag):\r
        XmlTag = "Extern/SetVirtualAddressMapCallBack"\r
        SetVirtualAddressMap = XmlElement(XmlExtern, XmlTag)\r
        XmlTag = "Extern/ExitBootServicesCallBack"\r
        ExitBootServices = XmlElement(XmlExtern, XmlTag)\r
        if SetVirtualAddressMap == "" and ExitBootServices == "":\r
            continue\r
        \r
        ModuleExtern = ModuleExternCallBackClass()\r
        ModuleExtern.ExitBootServicesCallBack = ExitBootServices\r
        ModuleExtern.SetVirtualAddressMapCallBack = SetVirtualAddressMap\r
        ModuleExternCallBacks.append(ModuleExtern)\r
\r
    return ModuleExternCallBacks\r
\r
\r
## Load a list of Module Build Options.\r
#\r
# Read an input Module XML DOM object and return a list of Build Options\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel BuildOptions         A list of Build Options loaded from XmlMsa.\r
#\r
def LoadModuleBuildOptions(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/ModuleBuildOptions/Options/Option"\r
    return map(LoadBuildOption, XmlList(XmlMsa, XmlTag))\r
\r
\r
## Load a list of Module User Extensions.\r
#\r
# Read an input Module XML DOM object and return a list of User Extensions\r
# contained in the DOM object.\r
#\r
# @param  XmlMsa               An XML DOM object read from MSA file.\r
#\r
# @retvel UserExtensions       A list of User Extensions loaded from XmlMsa.\r
#\r
def LoadModuleUserExtensions(XmlMsa):\r
    XmlTag = "ModuleSurfaceArea/UserExtensions"\r
    return map(LoadUserExtensions, XmlList(XmlMsa, XmlTag))\r
\r
## Load a new Module class object.\r
#\r
# Read an input MSA File and return a new Module class Object.\r
#\r
# @param  MsaFileName          An XML DOM object read from MSA file.\r
#\r
# @retvel Module               A new Module class object loaded from MSA File.\r
#\r
def LoadMsa(MsaFileName):\r
    XmlMsa = XmlParseFile(MsaFileName)\r
    EdkLogger.verbose("Load MSA File: %s" % MsaFileName)\r
    \r
    Module = ModuleClass()\r
    Module.Header = LoadModuleHeader(XmlMsa, MsaFileName)\r
    Module.LibraryClasses = LoadModuleLibraryClasses(XmlMsa)\r
    Module.Sources = LoadModuleSources(XmlMsa)\r
    Module.BinaryFiles = LoadModuleBinaries(XmlMsa)\r
    Module.NonProcessedFiles = LoadModuleNonProcessedFiles(XmlMsa)\r
    Module.PackageDependencies = LoadModulePackageDependencies(XmlMsa)\r
    Module.Protocols = LoadModuleProtocols(XmlMsa)\r
    Module.Ppis = LoadModulePpis(XmlMsa)\r
    Module.Events = LoadModuleEvents(XmlMsa)\r
    Module.Hobs = LoadModuleHobs(XmlMsa)\r
    Module.Variables = LoadModuleVariables(XmlMsa)\r
    Module.BootModes = LoadModuleBootModes(XmlMsa)\r
    Module.SystemTables = LoadModuleSystemTables(XmlMsa)\r
    Module.DataHubs = LoadModuleDataHubs(XmlMsa)\r
    Module.HiiPackages = LoadModuleHiiPackages(XmlMsa)\r
    Module.Guids = LoadModuleGuids(XmlMsa)\r
    Module.PcdCodes = LoadModulePcdCodes(XmlMsa)\r
    Module.ExternImages = LoadModuleExternImages(XmlMsa)\r
    Module.ExternLibraries = LoadModuleExternLibraries(XmlMsa)\r
    Module.ExternDrivers = LoadModuleExternDrivers(XmlMsa)\r
    Module.ExternCallBacks = LoadModuleExternCallBacks(XmlMsa)\r
    Module.BuildOptions = LoadModuleBuildOptions(XmlMsa)\r
    Module.UserExtensions = LoadModuleUserExtensions(XmlMsa)\r
    \r
    return Module\r
\r
\r
# This acts like the main() function for the script, unless it is 'import'ed\r
# into another script.\r
if __name__ == '__main__':\r
    pass