BaseTools: Clear build versions to sync with buildtools/BaseTools

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

## @file\r
# This file is used to parse a PCD file of .PKG file\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
'''\r
PcdXml\r
'''\r
\r
##\r
# Import Modules\r
#\r
\r
from Library.Xml.XmlRoutines import XmlElement\r
from Library.Xml.XmlRoutines import XmlAttribute\r
from Library.Xml.XmlRoutines import XmlNode\r
from Library.Xml.XmlRoutines import CreateXmlElement\r
from Library.Xml.XmlRoutines import XmlList\r
from Library.String import GetStringOfList\r
from Library.String import ConvertNEToNOTEQ\r
from Library.String import ConvertNOTEQToNE\r
from Library import GlobalData\r
from Object.POM.CommonObject import PcdObject\r
from Object.POM.CommonObject import PcdErrorObject\r
from Xml.CommonXml import HelpTextXml\r
from Xml.CommonXml import CommonDefinesXml\r
from Xml.XmlParserMisc import GetHelpTextList\r
\r
##\r
# PcdErrorXml\r
#\r
class PcdErrorXml(object):\r
    def __init__(self):\r
        self.ValidValueList = ''\r
        self.ValidValueListLang = ''\r
        self.ValidValueRange = ''\r
        self.Expression = ''\r
        self.ErrorNumber = ''\r
        self.ErrorMessage = []\r
        \r
    def FromXml(self, Item, Key):\r
        self.ValidValueList = XmlElement(Item, '%s/ValidValueList' % Key)\r
        self.ValidValueListLang = \\r
        XmlAttribute(XmlNode(Item, '%s/ValidValueList' % Key), 'Lang')\r
        self.ValidValueRange = XmlElement(Item, '%s/ValidValueRange' % Key)\r
        self.Expression = XmlElement(Item, '%s/Expression' % Key)\r
        self.ErrorNumber = XmlElement(Item, '%s/ErrorNumber' % Key)\r
        for ErrMsg in XmlList(Item, '%s/ErrorMessage' % Key):\r
            ErrorMessageString = XmlElement(ErrMsg, 'ErrorMessage')\r
            ErrorMessageLang = \\r
            XmlAttribute(XmlNode(ErrMsg, 'ErrorMessage'), 'Lang')\r
            self.ErrorMessage.append((ErrorMessageLang, ErrorMessageString))\r
        \r
        Error = PcdErrorObject()\r
        Error.SetValidValue(self.ValidValueList)\r
        Error.SetValidValueLang(self.ValidValueListLang)\r
        Error.SetValidValueRange(self.ValidValueRange)\r
        Error.SetExpression(self.Expression)\r
        Error.SetErrorNumber(self.ErrorNumber)\r
        Error.SetErrorMessageList(self.ErrorMessage)\r
        \r
        return Error\r
\r
    def ToXml(self, PcdError, Key):\r
        if self.Expression:\r
            pass\r
        AttributeList = []\r
        NodeList = []\r
        if PcdError.GetValidValue():\r
            Element1 = \\r
            CreateXmlElement('ValidValueList', PcdError.GetValidValue(), [], \\r
                             [['Lang', PcdError.GetValidValueLang()]])\r
            NodeList.append(Element1)\r
        if PcdError.GetValidValueRange():\r
            Element1 = \\r
            CreateXmlElement('ValidValueRange', \\r
                             PcdError.GetValidValueRange(), [], [])\r
            NodeList.append(Element1)\r
        if PcdError.GetExpression():\r
            NodeList.append(['Expression', PcdError.GetExpression()])\r
        if PcdError.GetErrorNumber():\r
            NodeList.append(['ErrorNumber', PcdError.GetErrorNumber()])\r
        for Item in PcdError.GetErrorMessageList():\r
            Element = \\r
            CreateXmlElement('ErrorMessage', Item[1], [], [['Lang', Item[0]]])\r
            NodeList.append(Element)\r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
        \r
        return Root\r
\r
    def __str__(self):\r
        return "ValidValueList = %s ValidValueListLang = %s ValidValueRange \\r
        = %s Expression = %s ErrorNumber = %s %s" % \\r
        (self.ValidValueList, self.ValidValueListLang, self.ValidValueRange, \\r
         self.Expression, self.ErrorNumber, self.ErrorMessage)\r
\r
##\r
# PcdEntryXml\r
#\r
class PcdEntryXml(object):\r
    def __init__(self):\r
        self.PcdItemType = ''\r
        self.PcdUsage = ''\r
        self.TokenSpaceGuidCName = ''\r
        self.TokenSpaceGuidValue = ''\r
        self.Token = ''\r
        self.CName = ''\r
        self.PcdCName = ''\r
        self.DatumType = ''\r
        self.ValidUsage = ''\r
        self.DefaultValue = ''\r
        self.MaxDatumSize = ''\r
        self.Value = ''\r
        self.Offset = ''\r
        self.CommonDefines = CommonDefinesXml()\r
        self.HelpText = []\r
        self.PcdError = []\r
\r
    ##\r
    # AsBuilt will use FromXml\r
    #         \r
    def FromXml(self, Item, Key):\r
        self.PcdItemType = \\r
        XmlAttribute(XmlNode(Item, '%s' % Key), 'PcdItemType')\r
        self.PcdUsage = XmlAttribute(XmlNode(Item, '%s' % Key), 'PcdUsage')\r
        self.TokenSpaceGuidCName = \\r
        XmlElement(Item, '%s/TokenSpaceGuidCname' % Key)\r
        self.TokenSpaceGuidValue = \\r
        XmlElement(Item, '%s/TokenSpaceGuidValue' % Key)\r
        self.Token = XmlElement(Item, '%s/Token' % Key)\r
        self.CName = XmlElement(Item, '%s/CName' % Key)\r
        self.PcdCName = XmlElement(Item, '%s/PcdCName' % Key)\r
        self.DatumType = XmlElement(Item, '%s/DatumType' % Key)\r
        self.ValidUsage = XmlElement(Item, '%s/ValidUsage' % Key)\r
        if not GlobalData.gIS_BINARY_INF:\r
            self.DefaultValue = XmlElement(Item, '%s/DefaultValue' % Key)\r
        else:\r
            self.DefaultValue = XmlElement(Item, '%s/Value' % Key)\r
        self.MaxDatumSize = XmlElement(Item, '%s/MaxDatumSize' % Key)\r
        self.Value = XmlElement(Item, '%s/Value' % Key)\r
        self.Offset = XmlElement(Item, '%s/Offset' % Key)\r
        self.CommonDefines.FromXml(XmlNode(Item, '%s' % Key), 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
        for PcdErrorItem in XmlList(Item, '%s/PcdError' % Key):\r
            PcdErrorObjXml = PcdErrorXml()\r
            PcdErrorObj = PcdErrorObjXml.FromXml(PcdErrorItem, 'PcdError')\r
            self.PcdError.append(PcdErrorObj)\r
        \r
        self.DefaultValue = ConvertNOTEQToNE(self.DefaultValue)\r
        \r
        PcdEntry = PcdObject()\r
        PcdEntry.SetSupArchList(self.CommonDefines.SupArchList)\r
        PcdEntry.SetTokenSpaceGuidCName(self.TokenSpaceGuidCName)\r
        PcdEntry.SetTokenSpaceGuidValue(self.TokenSpaceGuidValue)\r
        PcdEntry.SetToken(self.Token)\r
        PcdEntry.SetOffset(self.Offset)\r
        PcdEntry.SetCName(self.CName)\r
        PcdEntry.SetPcdCName(self.PcdCName)\r
        PcdEntry.SetDatumType(self.DatumType)\r
        PcdEntry.SetValidUsage(self.ValidUsage)\r
        PcdEntry.SetDefaultValue(self.DefaultValue)\r
        PcdEntry.SetMaxDatumSize(self.MaxDatumSize)\r
        PcdEntry.SetFeatureFlag(ConvertNOTEQToNE(self.CommonDefines.FeatureFlag))\r
        PcdEntry.SetItemType(self.PcdItemType)\r
\r
        PcdEntry.SetHelpTextList(GetHelpTextList(self.HelpText))\r
        PcdEntry.SetPcdErrorsList(self.PcdError)\r
        \r
        return PcdEntry\r
    ##\r
    # Package will use FromXml2\r
    # \r
    def FromXml2(self, Item, Key):\r
        self.TokenSpaceGuidCName = \\r
        XmlElement(Item, '%s/TokenSpaceGuidCname' % Key)\r
        self.Token = XmlElement(Item, '%s/Token' % Key)\r
        self.CName = XmlElement(Item, '%s/CName' % Key)\r
        self.DatumType = XmlElement(Item, '%s/DatumType' % Key)\r
        self.ValidUsage = XmlElement(Item, '%s/ValidUsage' % Key)\r
        self.DefaultValue = XmlElement(Item, '%s/DefaultValue' % Key)\r
        self.MaxDatumSize = XmlElement(Item, '%s/MaxDatumSize' % Key)\r
        self.CommonDefines.FromXml(XmlNode(Item, '%s' % Key), 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
        for PcdErrorItem in XmlList(Item, '%s/PcdError' % Key):\r
            PcdErrorObjXml = PcdErrorXml()\r
            PcdErrorObj = PcdErrorObjXml.FromXml(PcdErrorItem, 'PcdError')\r
            self.PcdError.append(PcdErrorObj)\r
        \r
        self.DefaultValue = ConvertNOTEQToNE(self.DefaultValue)\r
        \r
        PcdEntry = PcdObject()\r
        PcdEntry.SetSupArchList(self.CommonDefines.SupArchList)\r
        PcdEntry.SetSupModuleList(self.CommonDefines.SupModList)\r
        PcdEntry.SetTokenSpaceGuidCName(self.TokenSpaceGuidCName)\r
        PcdEntry.SetToken(self.Token)\r
        PcdEntry.SetCName(self.CName)\r
        PcdEntry.SetDatumType(self.DatumType)\r
        PcdEntry.SetValidUsage(self.ValidUsage)\r
        PcdEntry.SetDefaultValue(self.DefaultValue)\r
        PcdEntry.SetMaxDatumSize(self.MaxDatumSize)\r
        PcdEntry.SetFeatureFlag(ConvertNOTEQToNE(self.CommonDefines.FeatureFlag))\r
\r
        PcdEntry.SetHelpTextList(GetHelpTextList(self.HelpText))\r
        PcdEntry.SetPcdErrorsList(self.PcdError)\r
        \r
        return PcdEntry\r
\r
    ##\r
    # Module will use FromXml3\r
    #\r
    def FromXml3(self, Item, Key):\r
        self.PcdItemType = \\r
        XmlAttribute(XmlNode(Item, '%s' % Key), 'PcdItemType')\r
        self.PcdUsage = XmlAttribute(XmlNode(Item, '%s' % Key), 'PcdUsage')\r
        self.TokenSpaceGuidCName = \\r
        XmlElement(Item, '%s/TokenSpaceGuidCName' % Key)\r
        self.CName = XmlElement(Item, '%s/CName' % Key)\r
        self.DefaultValue = XmlElement(Item, '%s/DefaultValue' % Key)\r
        self.CommonDefines.FromXml(XmlNode(Item, '%s' % Key), 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
        for PcdErrorItem in XmlList(Item, '%s/PcdError' % Key):\r
            PcdErrorObj = PcdErrorXml()\r
            PcdErrorObj.FromXml(PcdErrorItem, 'PcdError')\r
            self.PcdError.append(PcdErrorObj)\r
        \r
        self.DefaultValue = ConvertNOTEQToNE(self.DefaultValue)\r
        \r
        PcdEntry = PcdObject()\r
        PcdEntry.SetSupArchList(self.CommonDefines.SupArchList)\r
        PcdEntry.SetTokenSpaceGuidCName(self.TokenSpaceGuidCName)\r
        PcdEntry.SetCName(self.CName)\r
        PcdEntry.SetValidUsage(self.PcdUsage)\r
        PcdEntry.SetDefaultValue(self.DefaultValue)\r
        PcdEntry.SetFeatureFlag(ConvertNOTEQToNE(self.CommonDefines.FeatureFlag))\r
        PcdEntry.SetItemType(self.PcdItemType)\r
\r
        PcdEntry.SetHelpTextList(GetHelpTextList(self.HelpText))\r
        PcdEntry.SetPcdErrorsList(self.PcdError)\r
        \r
        return PcdEntry\r
         \r
    def ToXml(self, PcdEntry, Key):\r
        if self.PcdCName:\r
            pass\r
        \r
        DefaultValue = ConvertNEToNOTEQ(PcdEntry.GetDefaultValue())\r
        \r
        AttributeList = \\r
        [['SupArchList', GetStringOfList(PcdEntry.GetSupArchList())], \\r
         ['PcdUsage', PcdEntry.GetValidUsage()], \\r
         ['PcdItemType', PcdEntry.GetItemType()], \\r
         ['FeatureFlag', PcdEntry.GetFeatureFlag()],\r
        ]\r
        NodeList = [['TokenSpaceGuidCname', PcdEntry.GetTokenSpaceGuidCName()],\r
                    ['TokenSpaceGuidValue', PcdEntry.GetTokenSpaceGuidValue()],\r
                    ['Token', PcdEntry.GetToken()], \r
                    ['CName', PcdEntry.GetCName()],\r
                    ['DatumType', PcdEntry.GetDatumType()],\r
                    ['ValidUsage', GetStringOfList(PcdEntry.GetValidUsage())],\r
                    ['DefaultValue', DefaultValue],\r
                    ['MaxDatumSize', PcdEntry.GetMaxDatumSize()],\r
                    ['Offset', PcdEntry.GetOffset()],\r
                   ]\r
        \r
        for Item in PcdEntry.GetHelpTextList():\r
            Tmp = HelpTextXml()\r
            NodeList.append(Tmp.ToXml(Item))\r
        for Item in PcdEntry.GetPcdErrorsList():\r
            Tmp = PcdErrorXml()\r
            NodeList.append(Tmp.ToXml(Item, 'PcdError'))\r
        \r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
        \r
        return Root\r
    ##\r
    # Package will use ToXml2\r
    #    \r
    def ToXml2(self, PcdEntry, Key):\r
        if self.PcdCName:\r
            pass\r
        \r
        DefaultValue = ConvertNEToNOTEQ(PcdEntry.GetDefaultValue())\r
        \r
        AttributeList = \\r
        [['SupArchList', GetStringOfList(PcdEntry.GetSupArchList())], \\r
         ['SupModList', GetStringOfList(PcdEntry.GetSupModuleList())]\r
        ]\r
        NodeList = [['TokenSpaceGuidCname', PcdEntry.GetTokenSpaceGuidCName()],\r
                    ['Token', PcdEntry.GetToken()],\r
                    ['CName', PcdEntry.GetCName()],\r
                    ['DatumType', PcdEntry.GetDatumType()],\r
                    ['ValidUsage', GetStringOfList(PcdEntry.GetValidUsage())],\r
                    ['DefaultValue', DefaultValue],\r
                    ['MaxDatumSize', PcdEntry.GetMaxDatumSize()],\r
                   ]\r
        for Item in PcdEntry.GetHelpTextList():\r
            Tmp = HelpTextXml()\r
            NodeList.append(Tmp.ToXml(Item))\r
\r
        for Item in PcdEntry.GetPcdErrorsList():\r
            Tmp = PcdErrorXml()\r
            NodeList.append(Tmp.ToXml(Item, 'PcdError'))\r
        \r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
        \r
        return Root\r
    ##\r
    # Module will use ToXml3\r
    #\r
    def ToXml3(self, PcdEntry, Key):\r
        if self.PcdCName:\r
            pass\r
        \r
        DefaultValue = ConvertNEToNOTEQ(PcdEntry.GetDefaultValue())\r
        \r
        AttributeList = \\r
        [['SupArchList', GetStringOfList(PcdEntry.GetSupArchList())], \\r
         ['PcdUsage', PcdEntry.GetValidUsage()], \\r
         ['PcdItemType', PcdEntry.GetItemType()], \\r
         ['FeatureFlag', ConvertNEToNOTEQ(PcdEntry.GetFeatureFlag())],\r
        ]\r
        NodeList = [['CName', PcdEntry.GetCName()],\r
                    ['TokenSpaceGuidCName', PcdEntry.GetTokenSpaceGuidCName()],\r
                    ['DefaultValue', DefaultValue],\r
                   ]\r
        \r
        for Item in PcdEntry.GetHelpTextList():\r
            Tmp = HelpTextXml()\r
            NodeList.append(Tmp.ToXml(Item))\r
        for Item in PcdEntry.GetPcdErrorsList():\r
            Tmp = PcdErrorXml()\r
            NodeList.append(Tmp.ToXml(Item, 'PcdError'))\r
        \r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
        \r
        return Root\r
    \r
    ##\r
    # AsBuild Module will use ToXml4\r
    #\r
    def ToXml4(self, PcdEntry, Key):\r
        if self.PcdCName:\r
            pass\r
        \r
        DefaultValue = ConvertNEToNOTEQ(PcdEntry.GetDefaultValue())\r
        \r
        AttributeList = []\r
        \r
        NodeList = [\r
                    ['TokenSpaceGuidValue', PcdEntry.GetTokenSpaceGuidValue()],\r
                    ['PcdCName', PcdEntry.GetCName()],\r
                    ['Token', PcdEntry.GetToken()],\r
                    ['DatumType', PcdEntry.GetDatumType()],\r
                    ['MaxDatumSize', PcdEntry.GetMaxDatumSize()],\r
                    ['Value', DefaultValue],\r
                    ['Offset', PcdEntry.GetOffset()]\r
                   ]\r
        \r
        for Item in PcdEntry.GetHelpTextList():\r
            Tmp = HelpTextXml()\r
            NodeList.append(Tmp.ToXml(Item))\r
        for Item in PcdEntry.GetPcdErrorsList():\r
            Tmp = PcdErrorXml()\r
            NodeList.append(Tmp.ToXml(Item, 'PcdError'))\r
        \r
        Root = CreateXmlElement('%s' % Key, '', NodeList, AttributeList)\r
        \r
        return Root\r
        \r
\r
    def __str__(self):\r
        Str = \\r
        ('PcdItemType = %s PcdUsage = %s TokenSpaceGuidCName = %s \\r
        TokenSpaceGuidValue = %s Token = %s CName = %s PcdCName = %s \\r
        DatumType = %s ValidUsage = %s DefaultValue = %s MaxDatumSize = %s \\r
        Value = %s Offset = %s %s') % \\r
        (self.PcdItemType, self.PcdUsage, self.TokenSpaceGuidCName, \\r
         self.TokenSpaceGuidValue, self.Token, self.CName, self.PcdCName, \\r
         self.DatumType, self.ValidUsage, self.DefaultValue, \\r
         self.MaxDatumSize, self.Value, self.Offset, self.CommonDefines)\r
        for Item in self.HelpText:\r
            Str = Str + "\n\t" + str(Item)\r
        for Item in self.PcdError:\r
            Str = Str + "\n\tPcdError:" + str(Item)\r
        return Str