[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
# 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
'''\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
Commit	Line	Data
4234283c LG	1	## @file\r
	2	# This file is used to parse a Package file of .PKG file\r
	3	#\r
64285f15	4	# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
4234283c	5	#\r
f7496d71 LG	6	# This program and the accompanying materials are licensed and made available\r
	7	# under the terms and conditions of the BSD License which accompanies this\r
	8	# distribution. The full text of the license may be found at\r
4234283c LG	9	# http://opensource.org/licenses/bsd-license.php\r
	10	#\r
	11	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	#\r
	14	\r
	15	'''\r
	16	PackageSurfaceAreaXml\r
	17	'''\r
	18	from xml.dom import minidom\r
	19	\r
64285f15	20	from Library.StringUtils import GetStringOfList\r
4234283c LG	21	from Library.Xml.XmlRoutines import XmlElement\r
	22	from Library.Xml.XmlRoutines import XmlNode\r
	23	from Library.Xml.XmlRoutines import XmlList\r
	24	from Library.Xml.XmlRoutines import CreateXmlElement\r
	25	from Object.POM.CommonObject import IncludeObject\r
	26	from Object.POM.CommonObject import TextObject\r
	27	from Object.POM.PackageObject import PackageObject\r
	28	from Xml.CommonXml import ClonedFromXml\r
	29	from Xml.CommonXml import PackageHeaderXml\r
	30	from Xml.CommonXml import HelpTextXml\r
	31	from Xml.CommonXml import CommonDefinesXml\r
	32	from Xml.CommonXml import LibraryClassXml\r
	33	from Xml.CommonXml import UserExtensionsXml\r
	34	from Xml.CommonXml import MiscellaneousFileXml\r
	35	from Xml.GuidProtocolPpiXml import GuidXml\r
	36	from Xml.GuidProtocolPpiXml import ProtocolXml\r
	37	from Xml.GuidProtocolPpiXml import PpiXml\r
	38	from Xml.ModuleSurfaceAreaXml import ModuleSurfaceAreaXml\r
	39	from Xml.PcdXml import PcdEntryXml\r
	40	\r
	41	##\r
	42	# IndustryStandardHeaderXml\r
	43	#\r
	44	class IndustryStandardHeaderXml(object):\r
	45	def __init__(self):\r
	46	self.HeaderFile = ''\r
	47	self.HelpText = []\r
	48	\r
	49	def FromXml(self, Item, Key):\r
	50	self.HeaderFile = XmlElement(Item, '%s/HeaderFile' % Key)\r
	51	for HelpTextItem in XmlList(Item, '%s/HelpText' % Key):\r
	52	HelpTextObj = HelpTextXml()\r
	53	HelpTextObj.FromXml(HelpTextItem, '%s/HelpText' % Key)\r
	54	self.HelpText.append(HelpTextObj)\r
	55	\r
	56	Include = IncludeObject()\r
	57	Include.SetFilePath(self.HeaderFile)\r
	58	HelpTxt = TextObject()\r
	59	HelpTxt.SetString(self.HelpText)\r
	60	Include.SetHelpText(HelpTxt)\r
	61	\r
	62	return Include\r
	63	\r
	64	def ToXml(self, IndustryStandardHeader, Key):\r
	65	if self.HeaderFile:\r
	66	pass\r
	67	AttributeList = []\r
	68	NodeList = [['HeaderFile', IndustryStandardHeader.GetFilePath()]]\r
	69	Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
	70	\r
	71	return Root\r
	72	\r
	73	def __str__(self):\r
	74	Str = "HeaderFile = %s" % (self.HeaderFile)\r
	75	for Item in self.HelpText:\r
	76	Str = Str + "\n\t" + str(Item)\r
	77	return Str\r
	78	##\r
	79	# PackageIncludeHeaderXml\r
	80	#\r
	81	class PackageIncludeHeaderXml(object):\r
	82	def __init__(self):\r
	83	self.HeaderFile = ''\r
	84	self.CommonDefines = CommonDefinesXml()\r
85	self.HelpText = []\r
86	\r
87	def FromXml(self, Item, Key):\r
88	self.HeaderFile = XmlElement(Item, '%s/HeaderFile' % Key)\r
89	self.CommonDefines.FromXml(XmlNode(Item, '%s/HeaderFile' % Key), 'HeaderFile')\r
90	for HelpTextItem in XmlList(Item, '%s/HelpText' % Key):\r
91	HelpTextObj = HelpTextXml()\r
92	HelpTextObj.FromXml(HelpTextItem, '%s/HelpText' % Key)\r
93	self.HelpText.append(HelpTextObj)\r
94	\r
95	Include = IncludeObject()\r
96	Include.SetFilePath(self.HeaderFile)\r
97	Include.SetSupArchList(self.CommonDefines.SupArchList)\r
98	HelpTxt = TextObject()\r
99	HelpTxt.SetString(self.HelpText)\r
100	Include.SetHelpText(HelpTxt)\r
101	\r
102	return Include\r
103	\r
104	def ToXml(self, PackageIncludeHeader, Key):\r
105	if self.HeaderFile:\r
106	pass\r
107	AttributeList = [['SupArchList', GetStringOfList(PackageIncludeHeader.GetSupArchList())], \\r
108	['SupModList', GetStringOfList(PackageIncludeHeader.GetSupModuleList())], ]\r
109	\r
110	HeaderFileNode = CreateXmlElement('HeaderFile', PackageIncludeHeader.FilePath, [], AttributeList)\r
111	\r
112	NodeList = [HeaderFileNode]\r
113	for Item in PackageIncludeHeader.GetHelpTextList():\r
114	Tmp = HelpTextXml()\r
115	NodeList.append(Tmp.ToXml(Item))\r
116	\r
117	Root = CreateXmlElement('%s' % Key, '', NodeList, [])\r
118	\r
119	return Root\r
120	\r
121	def __str__(self):\r
122	Str = "HeaderFile = %s\n\t%s" % (self.HeaderFile, self.CommonDefines)\r
123	for Item in self.HelpText:\r
124	Str = Str + "\n\t" + str(Item)\r
125	return Str\r
126	\r
127	##\r
128	# PcdCheckXml\r
129	#\r
130	class PcdCheckXml(object):\r
131	def __init__(self):\r
132	self.PcdCheck = ''\r
133	\r
134	def FromXml(self, Item, Key):\r
135	if Key:\r
136	pass\r
137	self.PcdCheck = XmlElement(Item, 'PcdCheck')\r
138	\r
139	return self.PcdCheck\r
140	\r
141	def ToXml(self, PcdCheck, Key):\r
142	if self.PcdCheck:\r
143	pass\r
144	Root = CreateXmlElement('%s' % Key, PcdCheck, [], [])\r
145	return Root\r
146	\r
147	def __str__(self):\r
148	return "PcdCheck = %s" % (self.PcdCheck)\r
149	\r
150	##\r
151	# PackageSurfaceAreaXml\r
152	#\r
153	class PackageSurfaceAreaXml(object):\r
154	def __init__(self):\r
155	self.Package = None\r
156	\r
157	def FromXml(self, Item, Key):\r
158	if Key:\r
159	pass\r
160	#\r
161	# Create a package object\r
162	#\r
163	Package = PackageObject()\r
164	#\r
165	# Header\r
166	#\r
167	Tmp = PackageHeaderXml()\r
168	Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/Header'), 'Header', Package)\r
169	#\r
170	# ClonedFrom\r
171	#\r
172	Tmp = ClonedFromXml()\r
173	if XmlNode(Item, '/PackageSurfaceArea/ClonedFrom'):\r
174	ClonedFrom = Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/ClonedFrom'), 'ClonedFrom')\r
175	Package.SetClonedFromList([ClonedFrom])\r
f7496d71	176	#\r
4234283c LG	177	# LibraryClass\r
	178	#\r
	179	\r
	180	for SubItem in XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass'):\r
	181	Tmp = LibraryClassXml()\r
	182	LibraryClass = Tmp.FromXml(SubItem, 'LibraryClass')\r
	183	Package.SetLibraryClassList(Package.GetLibraryClassList() + [LibraryClass])\r
	184	\r
	185	if XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations') and \\r
	186	not XmlList(Item, '/PackageSurfaceArea/LibraryClassDeclarations/LibraryClass'):\r
	187	Package.SetLibraryClassList([None])\r
	188	\r
	189	#\r
	190	# IndustryStandardHeader\r
	191	#\r
	192	for SubItem in XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes/IndustryStandardHeader'):\r
	193	Tmp = IndustryStandardHeaderXml()\r
	194	Include = Tmp.FromXml(SubItem, 'IndustryStandardHeader')\r
	195	Package.SetStandardIncludeFileList(Package.GetStandardIncludeFileList() + [Include])\r
	196	\r
	197	if XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes') and \\r
	198	not XmlList(Item, '/PackageSurfaceArea/IndustryStandardIncludes/IndustryStandardHeader'):\r
	199	Package.SetStandardIncludeFileList([None])\r
	200	\r
	201	\r
	202	#\r
	203	# PackageHeader\r
	204	#\r
	205	for SubItem in XmlList(Item, '/PackageSurfaceArea/PackageIncludes/PackageHeader'):\r
	206	Tmp = PackageIncludeHeaderXml()\r
	207	Include = Tmp.FromXml(SubItem, 'PackageHeader')\r
	208	Package.SetPackageIncludeFileList(Package.GetPackageIncludeFileList() + [Include])\r
	209	\r
	210	if XmlList(Item, '/PackageSurfaceArea/PackageIncludes') and not \\r
	211	XmlList(Item, '/PackageSurfaceArea/PackageIncludes/PackageHeader'):\r
	212	Package.SetPackageIncludeFileList([None])\r
	213	\r
	214	#\r
	215	# Guid\r
	216	#\r
	217	for SubItem in XmlList(Item, '/PackageSurfaceArea/GuidDeclarations/Entry'):\r
	218	Tmp = GuidXml('Package')\r
	219	GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
	220	Package.SetGuidList(Package.GetGuidList() + [GuidProtocolPpi])\r
	221	\r
	222	if XmlList(Item, '/PackageSurfaceArea/GuidDeclarations') and not \\r
	223	XmlList(Item, '/PackageSurfaceArea/GuidDeclarations/Entry'):\r
	224	Package.SetGuidList([None])\r
	225	\r
	226	#\r
	227	# Protocol\r
	228	#\r
	229	for SubItem in XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations/Entry'):\r
	230	Tmp = ProtocolXml('Package')\r
	231	GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
	232	Package.SetProtocolList(Package.GetProtocolList() + [GuidProtocolPpi])\r
	233	\r
	234	if XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations') and not \\r
	235	XmlList(Item, '/PackageSurfaceArea/ProtocolDeclarations/Entry'):\r
	236	Package.SetProtocolList([None])\r
	237	\r
	238	#\r
	239	# Ppi\r
	240	#\r
241	for SubItem in XmlList(Item, '/PackageSurfaceArea/PpiDeclarations/Entry'):\r
242	Tmp = PpiXml('Package')\r
243	GuidProtocolPpi = Tmp.FromXml(SubItem, 'Entry')\r
244	Package.SetPpiList(Package.GetPpiList() + [GuidProtocolPpi])\r
245	\r
246	if XmlList(Item, '/PackageSurfaceArea/PpiDeclarations') and not \\r
247	XmlList(Item, '/PackageSurfaceArea/PpiDeclarations/Entry'):\r
248	Package.SetPpiList([None])\r
249	\r
250	#\r
251	# PcdEntry\r
252	#\r
253	for SubItem in XmlList(Item, '/PackageSurfaceArea/PcdDeclarations/PcdEntry'):\r
254	Tmp = PcdEntryXml()\r
255	PcdEntry = Tmp.FromXml2(SubItem, 'PcdEntry')\r
256	Package.SetPcdList(Package.GetPcdList() + [PcdEntry])\r
f7496d71	257	\r
421ccda3 HC	258	#\r
	259	# Get PcdErrorCommentDict from PcdError in PcdEntry Node\r
	260	#\r
	261	for PcdErrorObj in PcdEntry.GetPcdErrorsList():\r
	262	PcdErrorMessageList = PcdErrorObj.GetErrorMessageList()\r
	263	if PcdErrorMessageList:\r
	264	Package.PcdErrorCommentDict[(PcdEntry.GetTokenSpaceGuidCName(), PcdErrorObj.GetErrorNumber())] = \\r
	265	PcdErrorMessageList\r
f7496d71	266	\r
4234283c LG	267	\r
	268	if XmlList(Item, '/PackageSurfaceArea/PcdDeclarations') and not \\r
	269	XmlList(Item, '/PackageSurfaceArea/PcdDeclarations/PcdEntry'):\r
	270	Package.SetPcdList([None])\r
	271	\r
	272	#\r
	273	# PcdCheck\r
	274	#\r
	275	for SubItem in XmlList(Item, '/PackageSurfaceArea/PcdRelationshipChecks/PcdCheck'):\r
	276	Tmp = PcdCheckXml()\r
	277	PcdCheck = Tmp.FromXml(SubItem, 'PcdCheck')\r
	278	Package.PcdChecks.append(PcdCheck)\r
	279	\r
	280	#\r
	281	# Modules\r
	282	#\r
	283	for SubItem in XmlList(Item, '/PackageSurfaceArea/Modules/ModuleSurfaceArea'):\r
	284	Tmp = ModuleSurfaceAreaXml()\r
	285	Module = Tmp.FromXml(SubItem, 'ModuleSurfaceArea')\r
d0acc87a LG	286	ModuleDictKey = (Module.GetGuid(), Module.GetVersion(), Module.GetName(), Module.GetModulePath())\r
d0acc87a LG	287	Package.ModuleDict[ModuleDictKey] = Module\r
f7496d71	288	#\r
4234283c LG	289	# MiscellaneousFile\r
	290	#\r
	291	Tmp = MiscellaneousFileXml()\r
	292	MiscFileList = Tmp.FromXml(XmlNode(Item, '/PackageSurfaceArea/MiscellaneousFiles'), 'MiscellaneousFiles')\r
	293	if MiscFileList:\r
	294	Package.SetMiscFileList([MiscFileList])\r
	295	else:\r
	296	Package.SetMiscFileList([])\r
	297	\r
f7496d71	298	#\r
4234283c LG	299	# UserExtensions\r
	300	#\r
	301	for Item in XmlList(Item, '/PackageSurfaceArea/UserExtensions'):\r
	302	Tmp = UserExtensionsXml()\r
	303	UserExtension = Tmp.FromXml(Item, 'UserExtensions')\r
	304	Package.UserExtensionList.append(UserExtension)\r
	305	\r
	306	self.Package = Package\r
	307	return self.Package\r
	308	\r
	309	def ToXml(self, Package):\r
	310	if self.Package:\r
	311	pass\r
	312	#\r
	313	# Create PackageSurfaceArea node\r
	314	#\r
	315	DomPackage = minidom.Document().createElement('PackageSurfaceArea')\r
	316	#\r
	317	# Header\r
	318	#\r
	319	Tmp = PackageHeaderXml()\r
	320	DomPackage.appendChild(Tmp.ToXml(Package, 'Header'))\r
	321	#\r
	322	# ClonedFrom\r
	323	#\r
	324	Tmp = ClonedFromXml()\r
	325	if Package.GetClonedFromList() != []:\r
	326	DomPackage.appendChild(Tmp.ToXml(Package.GetClonedFromList[0], 'ClonedFrom'))\r
	327	#\r
	328	# LibraryClass\r
	329	#\r
	330	LibraryClassNode = CreateXmlElement('LibraryClassDeclarations', '', [], [])\r
	331	for LibraryClass in Package.GetLibraryClassList():\r
	332	Tmp = LibraryClassXml()\r
	333	LibraryClassNode.appendChild(Tmp.ToXml(LibraryClass, 'LibraryClass'))\r
	334	DomPackage.appendChild(LibraryClassNode)\r
	335	#\r
	336	# IndustryStandardHeader\r
	337	#\r
	338	IndustryStandardHeaderNode = CreateXmlElement('IndustryStandardIncludes', '', [], [])\r
	339	for Include in Package.GetStandardIncludeFileList():\r
	340	Tmp = IndustryStandardHeaderXml()\r
	341	IndustryStandardHeaderNode.appendChild(Tmp.ToXml(Include, 'IndustryStandardHeader'))\r
	342	DomPackage.appendChild(IndustryStandardHeaderNode)\r
	343	#\r
	344	# PackageHeader\r
	345	#\r
	346	PackageIncludeHeaderNode = CreateXmlElement('PackageIncludes', '', [], [])\r
	347	for Include in Package.GetPackageIncludeFileList():\r
	348	Tmp = PackageIncludeHeaderXml()\r
	349	PackageIncludeHeaderNode.appendChild(Tmp.ToXml(Include, 'PackageHeader'))\r
	350	DomPackage.appendChild(PackageIncludeHeaderNode)\r
	351	ModuleNode = CreateXmlElement('Modules', '', [], [])\r
	352	for Module in Package.GetModuleDict().values():\r
	353	Tmp = ModuleSurfaceAreaXml()\r
	354	ModuleNode.appendChild(Tmp.ToXml(Module))\r
	355	DomPackage.appendChild(ModuleNode)\r
	356	#\r
	357	# Guid\r
	358	#\r
	359	GuidProtocolPpiNode = CreateXmlElement('GuidDeclarations', '', [], [])\r
	360	for GuidProtocolPpi in Package.GetGuidList():\r
	361	Tmp = GuidXml('Package')\r
	362	GuidProtocolPpiNode.appendChild(Tmp.ToXml\\r
363	(GuidProtocolPpi, 'Entry'))\r
364	DomPackage.appendChild(GuidProtocolPpiNode)\r
365	#\r
366	# Protocol\r
367	#\r
368	GuidProtocolPpiNode = \\r
369	CreateXmlElement('ProtocolDeclarations', '', [], [])\r
370	for GuidProtocolPpi in Package.GetProtocolList():\r
371	Tmp = ProtocolXml('Package')\r
372	GuidProtocolPpiNode.appendChild\\r
373	(Tmp.ToXml(GuidProtocolPpi, 'Entry'))\r
374	DomPackage.appendChild(GuidProtocolPpiNode)\r
f7496d71	375	#\r
4234283c LG	376	# Ppi\r
	377	#\r
	378	GuidProtocolPpiNode = CreateXmlElement('PpiDeclarations', '', [], [])\r
	379	for GuidProtocolPpi in Package.GetPpiList():\r
	380	Tmp = PpiXml('Package')\r
	381	GuidProtocolPpiNode.appendChild\\r
	382	(Tmp.ToXml(GuidProtocolPpi, 'Entry'))\r
	383	DomPackage.appendChild(GuidProtocolPpiNode)\r
	384	#\r
	385	# PcdEntry\r
	386	#\r
	387	PcdEntryNode = CreateXmlElement('PcdDeclarations', '', [], [])\r
	388	for PcdEntry in Package.GetPcdList():\r
	389	Tmp = PcdEntryXml()\r
	390	PcdEntryNode.appendChild(Tmp.ToXml2(PcdEntry, 'PcdEntry'))\r
	391	DomPackage.appendChild(PcdEntryNode)\r
	392	\r
	393	#\r
	394	# MiscellaneousFile\r
	395	#\r
	396	Tmp = MiscellaneousFileXml()\r
	397	if Package.GetMiscFileList():\r
	398	DomPackage.appendChild(Tmp.ToXml(Package.GetMiscFileList()[0], 'MiscellaneousFiles'))\r
	399	\r
	400	#\r
	401	# UserExtensions\r
	402	#\r
	403	if Package.GetUserExtensionList():\r
	404	for UserExtension in Package.GetUserExtensionList():\r
	405	Tmp = UserExtensionsXml()\r
	406	DomPackage.appendChild(Tmp.ToXml(UserExtension, 'UserExtensions'))\r
	407	\r
	408	return DomPackage\r