BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Object / Parser / DecObject.py

## @file\r
# This file is used to define class objects for DEC file. It will consumed by\r
#DecParser\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
'''\r
DecObject\r
'''\r
\r
## Import modules\r
#\r
import os.path\r
\r
from Library.Misc import Sdict\r
from Library.DataType import TAB_GUIDS\r
from Library.DataType import TAB_PPIS\r
from Library.DataType import TAB_PROTOCOLS\r
from Library.DataType import TAB_DEC_DEFINES\r
from Library.DataType import TAB_INCLUDES\r
from Library.DataType import TAB_LIBRARY_CLASSES\r
from Library.DataType import TAB_USER_EXTENSIONS\r
from Library.DataType import TAB_PCDS\r
from Library.DataType import TAB_ARCH_COMMON\r
\r
## _DecComments\r
#\r
# Base class for all data objects which have head and tail comments\r
#\r
class _DecComments:\r
\r
    ##constructor\r
    #\r
    def __init__(self):\r
        self._HeadComment = []\r
        self._TailComment = []\r
\r
    ## GetComments\r
    #\r
    def GetComments(self):\r
        return self._HeadComment, self._TailComment\r
\r
    ## GetHeadComment\r
    #\r
    def GetHeadComment(self):\r
        return self._HeadComment\r
\r
    ## SetHeadComment\r
    #\r
    # @param Comment: comment content\r
    #\r
    def SetHeadComment(self, Comment):\r
        self._HeadComment = Comment\r
\r
    ## GetTailComment\r
    #\r
    def GetTailComment(self):\r
        return self._TailComment\r
\r
    ## SetTailComment\r
    #\r
    # @param Comment: comment content\r
    #\r
    def SetTailComment(self, Comment):\r
        self._TailComment = Comment\r
\r
## _DecBaseObject\r
#\r
# Base class that hold common info\r
#\r
class _DecBaseObject(_DecComments):\r
    def __init__(self, PkgFullName):\r
        _DecComments.__init__(self)\r
        #\r
        # Key is combined with (Arch, SectionType)\r
        # Default is common\r
        #\r
        self.ValueDict = Sdict()\r
        self._PkgFullName = PkgFullName\r
        self._PackagePath, self._FileName = os.path.split(PkgFullName)\r
        self._SecName = ''\r
\r
    ## GetSectionName\r
    #\r
    def GetSectionName(self):\r
        return self._SecName\r
\r
    ## GetPackagePath\r
    #\r
    def GetPackagePath(self):\r
        return self._PackagePath\r
\r
    ## GetPackageFile\r
    #\r
    def GetPackageFile(self):\r
        return self._FileName\r
\r
    ## GetPackageFullName\r
    #\r
    def GetPackageFullName(self):\r
        return self._PkgFullName\r
\r
    ## AddItem\r
    # Add sub-item to current object, sub-class should override it if needed\r
    #\r
    # @param Item: Sub-item to be added\r
    # @param Scope: A list store section name and arch info\r
    #\r
    def AddItem(self, Item, Scope):\r
        if not Scope:\r
            return\r
        if not Item:\r
            return\r
        ArchModule = []\r
        for Ele in Scope:\r
            if Ele[1] in self.ValueDict:\r
                self.ValueDict[Ele[1]].append(Item)\r
            else:\r
                self.ValueDict[Ele[1]] = [Item]\r
            ArchModule.append(Ele[1])\r
        Item.ArchAndModuleType = ArchModule\r
\r
    ## _GetItemByArch\r
    # Helper class used by sub-class\r
    # @param Arch:  arch\r
    #\r
    def _GetItemByArch(self, Arch):\r
        Arch = Arch.upper()\r
        if Arch not in self.ValueDict:\r
            return []\r
        return self.ValueDict[Arch]\r
\r
    ## _GetAllItems\r
    # Get all items, union all arches, items in returned list are unique\r
    #\r
    def _GetAllItems(self):\r
        Retlst = []\r
        for Arch in self.ValueDict:\r
            for Item in self.ValueDict[Arch]:\r
                if Item not in Retlst:\r
                    Retlst.append(Item)\r
        return Retlst\r
\r
## _DecItemBaseObject\r
#\r
# Module type and arch the item belongs to\r
#\r
class _DecItemBaseObject(_DecComments):\r
    def __init__(self):\r
        _DecComments.__init__(self)\r
        #\r
        # Item's arch, if PCD, also include PCD type\r
        #\r
        self.ArchAndModuleType = []\r
\r
    ## GetArchList\r
    #\r
    def GetArchList(self):\r
        ArchSet = set()\r
        for Arch in self.ArchAndModuleType:\r
            ArchSet.add(Arch)\r
        return list(ArchSet)\r
\r
## DecDefineObject\r
#\r
# Class to hold define section information\r
#\r
class DecDefineObject(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
        self._SecName = TAB_DEC_DEFINES.upper()\r
        self._DecSpec = ''\r
        self._PkgName = ''\r
        self._PkgGuid = ''\r
        self._PkgVersion = ''\r
        self._PkgUniFile = ''\r
\r
    ## GetPackageSpecification\r
    #\r
    def GetPackageSpecification(self):\r
        return self._DecSpec\r
\r
    def SetPackageSpecification(self, DecSpec):\r
        self._DecSpec = DecSpec\r
\r
    ## GetPackageName\r
    #\r
    def GetPackageName(self):\r
        return self._PkgName\r
\r
    def SetPackageName(self, PkgName):\r
        self._PkgName = PkgName\r
\r
    ## GetPackageGuid\r
    #\r
    def GetPackageGuid(self):\r
        return self._PkgGuid\r
\r
    def SetPackageGuid(self, PkgGuid):\r
        self._PkgGuid = PkgGuid\r
\r
    ## GetPackageVersion\r
    #\r
    def GetPackageVersion(self):\r
        return self._PkgVersion\r
\r
    def SetPackageVersion(self, PkgVersion):\r
        self._PkgVersion = PkgVersion\r
\r
    ## GetPackageUniFile\r
    #\r
    def GetPackageUniFile(self):\r
        return self._PkgUniFile\r
\r
    def SetPackageUniFile(self, PkgUniFile):\r
        self._PkgUniFile = PkgUniFile\r
\r
    ## GetDefines\r
    #\r
    def GetDefines(self):\r
        return self._GetItemByArch(TAB_ARCH_COMMON)\r
\r
    ## GetAllDefines\r
    #\r
    def GetAllDefines(self):\r
        return self._GetAllItems()\r
\r
## DecDefineItemObject\r
#\r
# Each item of define section\r
#\r
class DecDefineItemObject(_DecItemBaseObject):\r
    def __init__(self):\r
        _DecItemBaseObject.__init__(self)\r
        self.Key = ''\r
        self.Value = ''\r
\r
    ## __hash__\r
    #\r
    def __hash__(self):\r
        return hash(self.Key + self.Value)\r
\r
    ## __eq__\r
    #\r
    def __eq__(self, Other):\r
        return id(self) == id(Other)\r
\r
    ## __str__\r
    #\r
    def __str__(self):\r
        return str(self.ArchAndModuleType) + '\n' + self.Key + \\r
            ' = ' + self.Value\r
\r
## DecIncludeObject\r
#\r
# Class to hold include section info\r
#\r
class DecIncludeObject(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
        self._SecName = TAB_INCLUDES.upper()\r
\r
    ## GetIncludes\r
    #\r
    def GetIncludes(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetAllIncludes\r
    #\r
    def GetAllIncludes(self):\r
        return self._GetAllItems()\r
\r
## DecIncludeItemObject\r
#\r
# Item of include section\r
#\r
class DecIncludeItemObject(_DecItemBaseObject):\r
    def __init__(self, File, Root):\r
        self.File = File\r
        self.Root = Root\r
        _DecItemBaseObject.__init__(self)\r
\r
    ## __hash__\r
    #\r
    def __hash__(self):\r
        return hash(self.File)\r
\r
    ## __eq__\r
    #\r
    def __eq__(self, Other):\r
        return id(self) == id(Other)\r
\r
    ## __str__\r
    #\r
    def __str__(self):\r
        return self.File\r
\r
## DecLibraryclassObject\r
#\r
# Class to hold library class section info\r
#\r
class DecLibraryclassObject(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
        self._PackagePath, self._FileName = os.path.split(PkgFullName)\r
        self._SecName = TAB_LIBRARY_CLASSES.upper()\r
\r
    ## GetLibraryclasses\r
    #\r
    def GetLibraryclasses(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetAllLibraryclasses\r
    #\r
    def GetAllLibraryclasses(self):\r
        return self._GetAllItems()\r
\r
## DecLibraryclassItemObject\r
# Item of library class section\r
#\r
class DecLibraryclassItemObject(_DecItemBaseObject):\r
    def __init__(self, Libraryclass, File, Root):\r
        _DecItemBaseObject.__init__(self)\r
        self.File = File\r
        self.Root = Root\r
        self.Libraryclass = Libraryclass\r
\r
    ## __hash__\r
    #\r
    def __hash__(self):\r
        return hash(self.Libraryclass + self.File)\r
\r
    ## __eq__\r
    #\r
    def __eq__(self, Other):\r
        return id(self) == id(Other)\r
\r
    ## __str__\r
    #\r
    def __str__(self):\r
        return self.Libraryclass + '|' + self.File\r
\r
## DecPcdObject\r
# Class to hold PCD section\r
#\r
class DecPcdObject(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
        self._SecName = TAB_PCDS.upper()\r
\r
    ## AddItem\r
    #\r
    # Diff from base class\r
    #\r
    # @param Item: Item\r
    # @param Scope: Scope\r
    #\r
    def AddItem(self, Item, Scope):\r
        if not Scope:\r
            return\r
        if not Item:\r
            return\r
        ArchModule = []\r
        for Type, Arch in Scope:\r
            if (Type, Arch) in self.ValueDict:\r
                self.ValueDict[Type, Arch].append(Item)\r
            else:\r
                self.ValueDict[Type, Arch] = [Item]\r
            ArchModule.append([Type, Arch])\r
        Item.ArchAndModuleType = ArchModule\r
\r
    ## GetPcds\r
    #\r
    # @param PcdType: PcdType\r
    # @param Arch: Arch\r
    #\r
    def GetPcds(self, PcdType, Arch=TAB_ARCH_COMMON):\r
        PcdType = PcdType.upper()\r
        Arch = Arch.upper()\r
        if (PcdType, Arch) not in self.ValueDict:\r
            return []\r
        return self.ValueDict[PcdType, Arch]\r
\r
    ## GetPcdsByType\r
    #\r
    # @param PcdType: PcdType\r
    #\r
    def GetPcdsByType(self, PcdType):\r
        PcdType = PcdType.upper()\r
        Retlst = []\r
        for TypeInDict, Arch in self.ValueDict:\r
            if TypeInDict != PcdType:\r
                continue\r
            for Item in self.ValueDict[PcdType, Arch]:\r
                if Item not in Retlst:\r
                    Retlst.append(Item)\r
        return Retlst\r
\r
## DecPcdItemObject\r
#\r
# Item of PCD section\r
#\r
# @param _DecItemBaseObject: _DecItemBaseObject object\r
#\r
class DecPcdItemObject(_DecItemBaseObject):\r
    def __init__(self, Guid, Name, Value, DatumType,\r
                 Token, MaxDatumSize=''):\r
        _DecItemBaseObject.__init__(self)\r
        self.TokenCName = Name\r
        self.TokenSpaceGuidCName = Guid\r
        self.DatumType = DatumType\r
        self.DefaultValue = Value\r
        self.TokenValue = Token\r
        self.MaxDatumSize = MaxDatumSize\r
\r
    ## __hash__\r
    #\r
    def __hash__(self):\r
        return hash(self.TokenSpaceGuidCName + self.TokenCName)\r
\r
    ## __eq__\r
    #\r
    def __eq__(self, Other):\r
        return id(self) == id(Other)\r
\r
    ## GetArchListOfType\r
    #\r
    # @param PcdType: PcdType\r
    #\r
    def GetArchListOfType(self, PcdType):\r
        ItemSet = set()\r
        PcdType = PcdType.upper()\r
        for Type, Arch in self.ArchAndModuleType:\r
            if Type != PcdType:\r
                continue\r
            ItemSet.add(Arch)\r
        return list(ItemSet)\r
\r
## DecGuidObjectBase\r
#\r
# Base class for PPI, Protocol, and GUID.\r
# Hold same data but has different method for clarification in sub-class\r
#\r
# @param _DecBaseObject: Dec Base Object\r
#\r
class DecGuidObjectBase(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
\r
    ## GetGuidStyleItems\r
    #\r
    # @param Arch: Arch\r
    #\r
    def GetGuidStyleItems(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetGuidStyleAllItems\r
    #\r
    def GetGuidStyleAllItems(self):\r
        return self._GetAllItems()\r
\r
## DecGuidItemObject\r
#\r
# Item of GUID, PPI and Protocol section\r
#\r
# @param _DecItemBaseObject: Dec Item Base Object\r
#\r
class DecGuidItemObject(_DecItemBaseObject):\r
    def __init__(self, CName, GuidCValue, GuidString):\r
        _DecItemBaseObject.__init__(self)\r
        self.GuidCName = CName\r
        self.GuidCValue = GuidCValue\r
        self.GuidString = GuidString\r
\r
    ## __hash__\r
    #\r
    def __hash__(self):\r
        return hash(self.GuidCName)\r
\r
    ## __eq__\r
    #\r
    def __eq__(self, Other):\r
        return id(self) == id(Other)\r
\r
    ## __str__\r
    #\r
    def __str__(self):\r
        return self.GuidCName + ' = ' + self.GuidCValue\r
\r
## DecGuidObject\r
#\r
# Class for GUID section\r
#\r
# @param DecGuidObjectBase: Dec Guid Object Base\r
#\r
class DecGuidObject(DecGuidObjectBase):\r
    def __init__(self, PkgFullName):\r
        DecGuidObjectBase.__init__(self, PkgFullName)\r
        self._SecName = TAB_GUIDS.upper()\r
\r
    ## GetGuids\r
    #\r
    # @param Arch: Arch\r
    #\r
    def GetGuids(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetAllGuids\r
    #\r
    def GetAllGuids(self):\r
        return self._GetAllItems()\r
\r
## DecPpiObject\r
#\r
# Class for PPI section\r
#\r
# @param DecGuidObjectBase: Dec Guid Object Base\r
#\r
class DecPpiObject(DecGuidObjectBase):\r
    def __init__(self, PkgFullName):\r
        DecGuidObjectBase.__init__(self, PkgFullName)\r
        self._SecName = TAB_PPIS.upper()\r
\r
    ## GetPpis\r
    #\r
    # @param Arch: Arch\r
    #\r
    def GetPpis(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetAllPpis\r
    #\r
    def GetAllPpis(self):\r
        return self._GetAllItems()\r
\r
## DecProtocolObject\r
#\r
# Class for protocol section\r
#\r
# @param DecGuidObjectBase: Dec Guid Object Base\r
#\r
class DecProtocolObject(DecGuidObjectBase):\r
    def __init__(self, PkgFullName):\r
        DecGuidObjectBase.__init__(self, PkgFullName)\r
        self._SecName = TAB_PROTOCOLS.upper()\r
\r
    ## GetProtocols\r
    #\r
    # @param Arch: Arch\r
    #\r
    def GetProtocols(self, Arch=TAB_ARCH_COMMON):\r
        return self._GetItemByArch(Arch)\r
\r
    ## GetAllProtocols\r
    #\r
    def GetAllProtocols(self):\r
        return self._GetAllItems()\r
\r
## DecUserExtensionObject\r
#\r
# Class for user extension section\r
#\r
# @param _DecBaseObject: Dec Guid Object Base\r
#\r
class DecUserExtensionObject(_DecBaseObject):\r
    def __init__(self, PkgFullName):\r
        _DecBaseObject.__init__(self, PkgFullName)\r
        self._SecName = TAB_USER_EXTENSIONS.upper()\r
        self.ItemList = []\r
\r
    ## GetProtocols\r
    #\r
    # @param Item: Item\r
    # @param Scope: Scope\r
    #\r
    def AddItem(self, Item, Scope):\r
        if not Scope:\r
            pass\r
        if not Item:\r
            return\r
        self.ItemList.append(Item)\r
\r
    ## GetAllUserExtensions\r
    #\r
    def GetAllUserExtensions(self):\r
        return self.ItemList\r
\r
\r
## DecUserExtensionItemObject\r
# Item for user extension section\r
#\r
# @param _DecItemBaseObject: Dec Item Base Object\r
#\r
class DecUserExtensionItemObject(_DecItemBaseObject):\r
    def __init__(self):\r
        _DecItemBaseObject.__init__(self)\r
        self.UserString = ''\r
        self.UserId = ''\r
        self.IdString = ''\r
\r
\r
\r
\r