BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Xml / PackageSurfaceAreaXml.py

## @file\r
# This file is used to parse a Package file of .PKG file\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
'''\r
PackageSurfaceAreaXml\r
'''\r
from xml.dom import minidom\r
\r
from Library.StringUtils import GetStringOfList\r
from Library.Xml.XmlRoutines import XmlElement\r
from Library.Xml.XmlRoutines import XmlNode\r
from Library.Xml.XmlRoutines import XmlList\r
from Library.Xml.XmlRoutines import CreateXmlElement\r
from Object.POM.CommonObject import IncludeObject\r
from Object.POM.CommonObject import TextObject\r
from Object.POM.PackageObject import PackageObject\r
from Xml.CommonXml import ClonedFromXml\r
from Xml.CommonXml import PackageHeaderXml\r
from Xml.CommonXml import HelpTextXml\r
from Xml.CommonXml import CommonDefinesXml\r
from Xml.CommonXml import LibraryClassXml\r
from Xml.CommonXml import UserExtensionsXml\r
from Xml.CommonXml import MiscellaneousFileXml\r
from Xml.GuidProtocolPpiXml import GuidXml\r
from Xml.GuidProtocolPpiXml import ProtocolXml\r
from Xml.GuidProtocolPpiXml import PpiXml\r
from Xml.ModuleSurfaceAreaXml import ModuleSurfaceAreaXml\r
from Xml.PcdXml import PcdEntryXml\r
\r
##\r
# IndustryStandardHeaderXml\r
#\r
class IndustryStandardHeaderXml(object):\r
    def __init__(self):\r
        self.HeaderFile = ''\r
        self.HelpText = []\r
\r
    def FromXml(self, Item, Key):\r
        self.HeaderFile = XmlElement(Item, '%s/HeaderFile' % Key)\r
        for HelpTextItem in XmlList(Item, '%s/HelpText' % Key):\r
            HelpTextObj = HelpTextXml()\r
            HelpTextObj.FromXml(HelpTextItem, '%s/HelpText' % Key)\r
            self.HelpText.append(HelpTextObj)\r
\r
        Include = IncludeObject()\r
        Include.SetFilePath(self.HeaderFile)\r
        HelpTxt = TextObject()\r
        HelpTxt.SetString(self.HelpText)\r
        Include.SetHelpText(HelpTxt)\r
\r
        return Include\r
\r
    def ToXml(self, IndustryStandardHeader, Key):\r
        if self.HeaderFile:\r
            pass\r
        AttributeList = []\r
        NodeList = [['HeaderFile', IndustryStandardHeader.GetFilePath()]]\r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
\r
        return Root\r
\r
    def __str__(self):\r
        Str = "HeaderFile = %s" % (self.HeaderFile)\r
        for Item in self.HelpText:\r
            Str = Str + "\n\t" + str(Item)\r
        return Str\r
##\r
# PackageIncludeHeaderXml\r
#\r
class PackageIncludeHeaderXml(object):\r
    def __init__(self):\r
        self.HeaderFile = ''\r
        self.CommonDefines = CommonDefinesXml()\r
        self.HelpText = []\r
\r
    def FromXml(self, Item, Key):\r
        self.HeaderFile = XmlElement(Item, '%s/HeaderFile' % Key)\r
        self.CommonDefines.FromXml(XmlNode(Item, '%s/HeaderFile' % Key), 'HeaderFile')\r
        for HelpTextItem in XmlList(Item, '%s/HelpText' % Key):\r
            HelpTextObj = HelpTextXml()\r
            HelpTextObj.FromXml(HelpTextItem, '%s/HelpText' % Key)\r
            self.HelpText.append(HelpTextObj)\r
\r
        Include = IncludeObject()\r
        Include.SetFilePath(self.HeaderFile)\r
        Include.SetSupArchList(self.CommonDefines.SupArchList)\r
        HelpTxt = TextObject()\r
        HelpTxt.SetString(self.HelpText)\r
        Include.SetHelpText(HelpTxt)\r
\r
        return Include\r
\r
    def ToXml(self, PackageIncludeHeader, Key):\r
        if self.HeaderFile:\r
            pass\r
        AttributeList = [['SupArchList', GetStringOfList(PackageIncludeHeader.GetSupArchList())], \\r
                         ['SupModList', GetStringOfList(PackageIncludeHeader.GetSupModuleList())], ]\r
\r
        HeaderFileNode = CreateXmlElement('HeaderFile', PackageIncludeHeader.FilePath, [], AttributeList)\r
\r
        NodeList = [HeaderFileNode]\r
        for Item in PackageIncludeHeader.GetHelpTextList():\r
            Tmp = HelpTextXml()\r
            NodeList.append(Tmp.ToXml(Item))\r
\r
        Root = CreateXmlElement('%s' % Key, '', NodeList, [])\r
\r
        return Root\r
\r
    def __str__(self):\r
        Str = "HeaderFile = %s\n\t%s" % (self.HeaderFile, self.CommonDefines)\r
        for Item in self.HelpText:\r
            Str = Str + "\n\t" + str(Item)\r
        return Str\r
\r
##\r
# PcdCheckXml\r
#\r
class PcdCheckXml(object):\r
    def __init__(self):\r
        self.PcdCheck = ''\r
\r
    def FromXml(self, Item, Key):\r
        if Key:\r
            pass\r
        self.PcdCheck = XmlElement(Item, 'PcdCheck')\r
\r
        return self.PcdCheck\r
\r
    def ToXml(self, PcdCheck, Key):\r
        if self.PcdCheck:\r
            pass\r
        Root = CreateXmlElement('%s' % Key, PcdCheck, [], [])\r
        return Root\r
\r
    def __str__(self):\r
        return "PcdCheck = %s" % (self.PcdCheck)\r
\r
##\r
# PackageSurfaceAreaXml\r
#\r
class PackageSurfaceAreaXml(object):\r
    def __init__(self):\r
        self.Package = None\r
\r
    def FromXml(self, Item, Key):\r
        if Key:\r
            pass\r
        #\r
        # Create a package object\r
        #\r
        Package = PackageObject()\r
        #\r
        # Header\r
        #\r
        Tmp = PackageHeaderXml()\r
        Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/Header'), 'Header', Package)\r
        #\r
        # ClonedFrom\r
        #\r
        Tmp = ClonedFromXml()\r
        if XmlNode(Item, '/PackageSurfaceArea/ClonedFrom'):\r
            ClonedFrom = Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/ClonedFrom'), 'ClonedFrom')\r
            Package.SetClonedFromList([ClonedFrom])\r
        #\r
        # LibraryClass\r
        #\r
\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass'):\r
            Tmp = LibraryClassXml()\r
            LibraryClass = Tmp.FromXml(SubItem, 'LibraryClass')\r
            Package.SetLibraryClassList(Package.GetLibraryClassList() + [LibraryClass])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations') and \\r
           not XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass'):\r
            Package.SetLibraryClassList([None])\r
\r
        #\r
        # IndustryStandardHeader\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes/IndustryStandardHeader'):\r
            Tmp = IndustryStandardHeaderXml()\r
            Include = Tmp.FromXml(SubItem, 'IndustryStandardHeader')\r
            Package.SetStandardIncludeFileList(Package.GetStandardIncludeFileList() + [Include])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes') and \\r
        not XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes/IndustryStandardHeader'):\r
            Package.SetStandardIncludeFileList([None])\r
\r
\r
        #\r
        # PackageHeader\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/PackageIncludes/PackageHeader'):\r
            Tmp = PackageIncludeHeaderXml()\r
            Include = Tmp.FromXml(SubItem, 'PackageHeader')\r
            Package.SetPackageIncludeFileList(Package.GetPackageIncludeFileList() + [Include])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/PackageIncludes') and not \\r
           XmlList(Item, '/PackageSurfaceArea/PackageIncludes/PackageHeader'):\r
            Package.SetPackageIncludeFileList([None])\r
\r
        #\r
        # Guid\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/GuidDeclarations/Entry'):\r
            Tmp = GuidXml('Package')\r
            GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
            Package.SetGuidList(Package.GetGuidList() + [GuidProtocolPpi])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/GuidDeclarations') and not \\r
           XmlList(Item, '/PackageSurfaceArea/GuidDeclarations/Entry'):\r
            Package.SetGuidList([None])\r
\r
        #\r
        # Protocol\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations/Entry'):\r
            Tmp = ProtocolXml('Package')\r
            GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
            Package.SetProtocolList(Package.GetProtocolList() + [GuidProtocolPpi])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations') and not \\r
           XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations/Entry'):\r
            Package.SetProtocolList([None])\r
\r
        #\r
        # Ppi\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/PpiDeclarations/Entry'):\r
            Tmp = PpiXml('Package')\r
            GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
            Package.SetPpiList(Package.GetPpiList() + [GuidProtocolPpi])\r
\r
        if XmlList(Item, '/PackageSurfaceArea/PpiDeclarations') and not \\r
           XmlList(Item, '/PackageSurfaceArea/PpiDeclarations/Entry'):\r
            Package.SetPpiList([None])\r
\r
        #\r
        # PcdEntry\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/PcdDeclarations/PcdEntry'):\r
            Tmp = PcdEntryXml()\r
            PcdEntry = Tmp.FromXml2(SubItem, 'PcdEntry')\r
            Package.SetPcdList(Package.GetPcdList() + [PcdEntry])\r
\r
            #\r
            # Get PcdErrorCommentDict from PcdError in PcdEntry Node\r
            #\r
            for PcdErrorObj in PcdEntry.GetPcdErrorsList():\r
                PcdErrorMessageList = PcdErrorObj.GetErrorMessageList()\r
                if PcdErrorMessageList:\r
                    Package.PcdErrorCommentDict[(PcdEntry.GetTokenSpaceGuidCName(), PcdErrorObj.GetErrorNumber())] = \\r
                    PcdErrorMessageList\r
\r
\r
        if XmlList(Item, '/PackageSurfaceArea/PcdDeclarations') and not \\r
           XmlList(Item, '/PackageSurfaceArea/PcdDeclarations/PcdEntry'):\r
            Package.SetPcdList([None])\r
\r
        #\r
        # PcdCheck\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/PcdRelationshipChecks/PcdCheck'):\r
            Tmp = PcdCheckXml()\r
            PcdCheck = Tmp.FromXml(SubItem, 'PcdCheck')\r
            Package.PcdChecks.append(PcdCheck)\r
\r
        #\r
        # Modules\r
        #\r
        for SubItem in XmlList(Item, '/PackageSurfaceArea/Modules/ModuleSurfaceArea'):\r
            Tmp = ModuleSurfaceAreaXml()\r
            Module = Tmp.FromXml(SubItem, 'ModuleSurfaceArea')\r
            ModuleDictKey = (Module.GetGuid(), Module.GetVersion(), Module.GetName(), Module.GetModulePath())\r
            Package.ModuleDict[ModuleDictKey] = Module\r
        #\r
        # MiscellaneousFile\r
        #\r
        Tmp = MiscellaneousFileXml()\r
        MiscFileList = Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/MiscellaneousFiles'), 'MiscellaneousFiles')\r
        if MiscFileList:\r
            Package.SetMiscFileList([MiscFileList])\r
        else:\r
            Package.SetMiscFileList([])\r
\r
        #\r
        # UserExtensions\r
        #\r
        for Item in XmlList(Item, '/PackageSurfaceArea/UserExtensions'):\r
            Tmp = UserExtensionsXml()\r
            UserExtension = Tmp.FromXml(Item, 'UserExtensions')\r
            Package.UserExtensionList.append(UserExtension)\r
\r
        self.Package = Package\r
        return self.Package\r
\r
    def ToXml(self, Package):\r
        if self.Package:\r
            pass\r
        #\r
        # Create PackageSurfaceArea node\r
        #\r
        DomPackage = minidom.Document().createElement('PackageSurfaceArea')\r
        #\r
        # Header\r
        #\r
        Tmp = PackageHeaderXml()\r
        DomPackage.appendChild(Tmp.ToXml(Package, 'Header'))\r
        #\r
        # ClonedFrom\r
        #\r
        Tmp = ClonedFromXml()\r
        if Package.GetClonedFromList() != []:\r
            DomPackage.appendChild(Tmp.ToXml(Package.GetClonedFromList[0], 'ClonedFrom'))\r
        #\r
        # LibraryClass\r
        #\r
        LibraryClassNode = CreateXmlElement('LibraryClassDeclarations', '', [], [])\r
        for LibraryClass in Package.GetLibraryClassList():\r
            Tmp = LibraryClassXml()\r
            LibraryClassNode.appendChild(Tmp.ToXml(LibraryClass, 'LibraryClass'))\r
        DomPackage.appendChild(LibraryClassNode)\r
        #\r
        # IndustryStandardHeader\r
        #\r
        IndustryStandardHeaderNode = CreateXmlElement('IndustryStandardIncludes', '', [], [])\r
        for Include in Package.GetStandardIncludeFileList():\r
            Tmp = IndustryStandardHeaderXml()\r
            IndustryStandardHeaderNode.appendChild(Tmp.ToXml(Include, 'IndustryStandardHeader'))\r
        DomPackage.appendChild(IndustryStandardHeaderNode)\r
        #\r
        # PackageHeader\r
        #\r
        PackageIncludeHeaderNode = CreateXmlElement('PackageIncludes', '', [], [])\r
        for Include in Package.GetPackageIncludeFileList():\r
            Tmp = PackageIncludeHeaderXml()\r
            PackageIncludeHeaderNode.appendChild(Tmp.ToXml(Include, 'PackageHeader'))\r
        DomPackage.appendChild(PackageIncludeHeaderNode)\r
        ModuleNode = CreateXmlElement('Modules', '', [], [])\r
        for Module in Package.GetModuleDict().values():\r
            Tmp = ModuleSurfaceAreaXml()\r
            ModuleNode.appendChild(Tmp.ToXml(Module))\r
        DomPackage.appendChild(ModuleNode)\r
        #\r
        # Guid\r
        #\r
        GuidProtocolPpiNode = CreateXmlElement('GuidDeclarations', '', [], [])\r
        for GuidProtocolPpi in Package.GetGuidList():\r
            Tmp = GuidXml('Package')\r
            GuidProtocolPpiNode.appendChild(Tmp.ToXml\\r
                                            (GuidProtocolPpi, 'Entry'))\r
        DomPackage.appendChild(GuidProtocolPpiNode)\r
        #\r
        # Protocol\r
        #\r
        GuidProtocolPpiNode = \\r
        CreateXmlElement('ProtocolDeclarations', '', [], [])\r
        for GuidProtocolPpi in Package.GetProtocolList():\r
            Tmp = ProtocolXml('Package')\r
            GuidProtocolPpiNode.appendChild\\r
            (Tmp.ToXml(GuidProtocolPpi, 'Entry'))\r
        DomPackage.appendChild(GuidProtocolPpiNode)\r
        #\r
        # Ppi\r
        #\r
        GuidProtocolPpiNode = CreateXmlElement('PpiDeclarations', '', [], [])\r
        for GuidProtocolPpi in Package.GetPpiList():\r
            Tmp = PpiXml('Package')\r
            GuidProtocolPpiNode.appendChild\\r
            (Tmp.ToXml(GuidProtocolPpi, 'Entry'))\r
        DomPackage.appendChild(GuidProtocolPpiNode)\r
        #\r
        # PcdEntry\r
        #\r
        PcdEntryNode = CreateXmlElement('PcdDeclarations', '', [], [])\r
        for PcdEntry in Package.GetPcdList():\r
            Tmp = PcdEntryXml()\r
            PcdEntryNode.appendChild(Tmp.ToXml2(PcdEntry, 'PcdEntry'))\r
        DomPackage.appendChild(PcdEntryNode)\r
\r
        #\r
        # MiscellaneousFile\r
        #\r
        Tmp = MiscellaneousFileXml()\r
        if Package.GetMiscFileList():\r
            DomPackage.appendChild(Tmp.ToXml(Package.GetMiscFileList()[0], 'MiscellaneousFiles'))\r
\r
        #\r
        # UserExtensions\r
        #\r
        if Package.GetUserExtensionList():\r
            for UserExtension in Package.GetUserExtensionList():\r
                Tmp = UserExtensionsXml()\r
                DomPackage.appendChild(Tmp.ToXml(UserExtension, 'UserExtensions'))\r
\r
        return DomPackage\r