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

## @file\r
# This file is used to define class objects of [Defines] section for INF file.\r
# It will consumed by InfParser\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
'''\r
InfDefineObject\r
'''\r
\r
import os\r
import re\r
\r
from Logger import StringTable as ST\r
from Logger import ToolError\r
from Library import GlobalData\r
from Library import DataType as DT\r
from Library.StringUtils import GetSplitValueList\r
from Library.Misc import CheckGuidRegFormat\r
from Library.Misc import Sdict\r
from Library.Misc import ConvPathFromAbsToRel\r
from Library.Misc import ValidateUNIFilePath\r
from Library.ExpressionValidate import IsValidFeatureFlagExp\r
from Library.ParserValidate import IsValidWord\r
from Library.ParserValidate import IsValidInfMoudleType\r
from Library.ParserValidate import IsValidHex\r
from Library.ParserValidate import IsValidHexVersion\r
from Library.ParserValidate import IsValidDecVersion\r
from Library.ParserValidate import IsValidCVariableName\r
from Library.ParserValidate import IsValidBoolType\r
from Library.ParserValidate import IsValidPath\r
from Library.ParserValidate import IsValidFamily\r
from Library.ParserValidate import IsValidIdentifier\r
from Library.ParserValidate import IsValidDecVersionVal\r
from Object.Parser.InfCommonObject import InfLineCommentObject\r
from Object.Parser.InfCommonObject import CurrentLine\r
from Object.Parser.InfCommonObject import InfSectionCommonDef\r
from Object.Parser.InfMisc import ErrorInInf\r
from Object.Parser.InfDefineCommonObject import InfDefineLibraryItem\r
from Object.Parser.InfDefineCommonObject import InfDefineEntryPointItem\r
from Object.Parser.InfDefineCommonObject import InfDefineUnloadImageItem\r
from Object.Parser.InfDefineCommonObject import InfDefineConstructorItem\r
from Object.Parser.InfDefineCommonObject import InfDefineDestructorItem\r
\r
class InfDefSectionOptionRomInfo():\r
    def __init__(self):\r
        self.PciVendorId                = None\r
        self.PciDeviceId                = None\r
        self.PciClassCode               = None\r
        self.PciRevision                = None\r
        self.PciCompress                = None\r
        self.CurrentLine                = ['', -1, '']\r
    def SetPciVendorId(self, PciVendorId, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PciVendorId is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_PCI_VENDOR_ID),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The PciVendorId should be hex string.\r
        #\r
        if (IsValidHex(PciVendorId)):\r
            self.PciVendorId = InfDefMember()\r
            self.PciVendorId.SetValue(PciVendorId)\r
            self.PciVendorId.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(PciVendorId),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    def GetPciVendorId(self):\r
        return self.PciVendorId\r
\r
    def SetPciDeviceId(self, PciDeviceId, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PciDeviceId is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_PCI_DEVICE_ID),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The PciDeviceId should be hex string.\r
        #\r
        if (IsValidHex(PciDeviceId)):\r
            self.PciDeviceId = InfDefMember()\r
            self.PciDeviceId.SetValue(PciDeviceId)\r
            self.PciDeviceId.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(PciDeviceId),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    def GetPciDeviceId(self):\r
        return self.PciDeviceId\r
\r
    def SetPciClassCode(self, PciClassCode, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PciClassCode is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_PCI_CLASS_CODE),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The PciClassCode should be 4 bytes hex string.\r
        #\r
        if (IsValidHex(PciClassCode)):\r
            self.PciClassCode = InfDefMember()\r
            self.PciClassCode.SetValue(PciClassCode)\r
            self.PciClassCode.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%\\r
                       (PciClassCode),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    def GetPciClassCode(self):\r
        return self.PciClassCode\r
\r
    def SetPciRevision(self, PciRevision, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PciRevision is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_PCI_REVISION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The PciRevision should be 4 bytes hex string.\r
        #\r
        if (IsValidHex(PciRevision)):\r
            self.PciRevision = InfDefMember()\r
            self.PciRevision.SetValue(PciRevision)\r
            self.PciRevision.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(PciRevision),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    def GetPciRevision(self):\r
        return self.PciRevision\r
\r
    def SetPciCompress(self, PciCompress, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PciCompress is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_PCI_COMPRESS),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
        #\r
        # The PciCompress should be 'TRUE' or 'FALSE'.\r
        #\r
        if (PciCompress == 'TRUE' or PciCompress == 'FALSE'):\r
            self.PciCompress = InfDefMember()\r
            self.PciCompress.SetValue(PciCompress)\r
            self.PciCompress.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(PciCompress),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
    def GetPciCompress(self):\r
        return self.PciCompress\r
##\r
# INF [Define] section Object\r
#\r
class InfDefSection(InfDefSectionOptionRomInfo):\r
    def __init__(self):\r
        self.BaseName                   = None\r
        self.FileGuid                   = None\r
        self.ModuleType                 = None\r
        self.ModuleUniFileName          = None\r
        self.InfVersion                 = None\r
        self.EdkReleaseVersion          = None\r
        self.UefiSpecificationVersion   = None\r
        self.PiSpecificationVersion     = None\r
        self.LibraryClass               = []\r
        self.Package                    = None\r
        self.VersionString              = None\r
        self.PcdIsDriver                = None\r
        self.EntryPoint                 = []\r
        self.UnloadImages               = []\r
        self.Constructor                = []\r
        self.Destructor                 = []\r
        self.Shadow                     = None\r
        self.CustomMakefile             = []\r
        self.Specification              = []\r
        self.UefiHiiResourceSection     = None\r
        self.DpxSource                  = []\r
        self.CurrentLine                = ['', -1, '']\r
        InfDefSectionOptionRomInfo.__init__(self)\r
\r
    ## SetHeadComment\r
    #\r
    # @param BaseName: BaseName\r
    #\r
    def SetBaseName(self, BaseName, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.BaseName is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_BASE_NAME),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if not (BaseName == '' or BaseName is None):\r
            if IsValidWord(BaseName) and not BaseName.startswith("_"):\r
                self.BaseName = InfDefMember()\r
                self.BaseName.SetValue(BaseName)\r
                self.BaseName.Comments = Comments\r
                return True\r
            else:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_NAME_INVALID%(BaseName),\r
                           LineInfo=self.CurrentLine)\r
                return False\r
\r
    ## GetBaseName\r
    #\r
    def GetBaseName(self):\r
        return self.BaseName\r
\r
    ## SetFileGuid\r
    #\r
    # @param FileGuid: FileGuid\r
    #\r
    def SetFileGuid(self, FileGuid, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.FileGuid is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_FILE_GUID),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # Do verification of GUID content/format\r
        #\r
        if (CheckGuidRegFormat(FileGuid)):\r
            self.FileGuid = InfDefMember()\r
            self.FileGuid.SetValue(FileGuid)\r
            self.FileGuid.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_GUID_INVALID%(FileGuid),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    ## GetFileGuid\r
    #\r
    def GetFileGuid(self):\r
        return self.FileGuid\r
\r
    ## SetModuleType\r
    #\r
    # @param ModuleType: ModuleType\r
    #\r
    def SetModuleType(self, ModuleType, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.ModuleType is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_MODULE_TYPE),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # Valid Module Type or not\r
        #\r
        if (IsValidInfMoudleType(ModuleType)):\r
            self.ModuleType = InfDefMember()\r
            self.ModuleType.SetValue(ModuleType)\r
            self.ModuleType.CurrentLine = CurrentLine()\r
            self.ModuleType.CurrentLine.SetLineNo(self.CurrentLine[1])\r
            self.ModuleType.CurrentLine.SetLineString(self.CurrentLine[2])\r
            self.ModuleType.CurrentLine.SetFileName(self.CurrentLine[0])\r
            self.ModuleType.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_MODULETYPE_INVALID%\\r
                       (ModuleType),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    ## GetModuleType\r
    #\r
    def GetModuleType(self):\r
        return self.ModuleType\r
\r
    ## SetModuleUniFileName\r
    #\r
    # @param ModuleUniFileName: ModuleUniFileName\r
    #\r
    def SetModuleUniFileName(self, ModuleUniFileName, Comments):\r
        if Comments:\r
            pass\r
        if self.ModuleUniFileName is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_MODULE_UNI_FILE),\r
                       LineInfo=self.CurrentLine)\r
        self.ModuleUniFileName = ModuleUniFileName\r
\r
    ## GetModuleType\r
    #\r
    def GetModuleUniFileName(self):\r
        return self.ModuleUniFileName\r
\r
    ## SetInfVersion\r
    #\r
    # @param InfVersion: InfVersion\r
    #\r
    def SetInfVersion(self, InfVersion, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.InfVersion is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_INF_VERSION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The InfVersion should be 4 bytes hex string.\r
        #\r
        if (IsValidHex(InfVersion)):\r
            if (InfVersion < '0x00010005'):\r
                ErrorInInf(ST.ERR_INF_PARSER_NOT_SUPPORT_EDKI_INF,\r
                           ErrorCode=ToolError.EDK1_INF_ERROR,\r
                           LineInfo=self.CurrentLine)\r
        elif IsValidDecVersionVal(InfVersion):\r
            if (InfVersion < 65541):\r
                ErrorInInf(ST.ERR_INF_PARSER_NOT_SUPPORT_EDKI_INF,\r
                           ErrorCode=ToolError.EDK1_INF_ERROR,\r
                           LineInfo=self.CurrentLine)\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(InfVersion),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
        self.InfVersion = InfDefMember()\r
        self.InfVersion.SetValue(InfVersion)\r
        self.InfVersion.Comments = Comments\r
        return True\r
\r
    ## GetInfVersion\r
    #\r
    def GetInfVersion(self):\r
        return self.InfVersion\r
\r
    ## SetEdkReleaseVersion\r
    #\r
    # @param EdkReleaseVersion: EdkReleaseVersion\r
    #\r
    def SetEdkReleaseVersion(self, EdkReleaseVersion, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.EdkReleaseVersion is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_EDK_RELEASE_VERSION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The EdkReleaseVersion should be 4 bytes hex string.\r
        #\r
        if IsValidHexVersion(EdkReleaseVersion) or \\r
           IsValidDecVersionVal(EdkReleaseVersion):\r
            self.EdkReleaseVersion = InfDefMember()\r
            self.EdkReleaseVersion.SetValue(EdkReleaseVersion)\r
            self.EdkReleaseVersion.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID\\r
                       %(EdkReleaseVersion),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    ## GetEdkReleaseVersion\r
    #\r
    def GetEdkReleaseVersion(self):\r
        return self.EdkReleaseVersion\r
\r
    ## SetUefiSpecificationVersion\r
    #\r
    # @param UefiSpecificationVersion: UefiSpecificationVersion\r
    #\r
    def SetUefiSpecificationVersion(self, UefiSpecificationVersion, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.UefiSpecificationVersion is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The EdkReleaseVersion should be 4 bytes hex string.\r
        #\r
        if IsValidHexVersion(UefiSpecificationVersion) or \\r
           IsValidDecVersionVal(UefiSpecificationVersion):\r
            self.UefiSpecificationVersion = InfDefMember()\r
            self.UefiSpecificationVersion.SetValue(UefiSpecificationVersion)\r
            self.UefiSpecificationVersion.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID\\r
                       %(UefiSpecificationVersion),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    ## GetUefiSpecificationVersion\r
    #\r
    def GetUefiSpecificationVersion(self):\r
        return self.UefiSpecificationVersion\r
\r
    ## SetPiSpecificationVersion\r
    #\r
    # @param PiSpecificationVersion: PiSpecificationVersion\r
    #\r
    def SetPiSpecificationVersion(self, PiSpecificationVersion, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PiSpecificationVersion is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_PI_SPECIFICATION_VERSION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        #\r
        # The EdkReleaseVersion should be 4 bytes hex string.\r
        #\r
        if IsValidHexVersion(PiSpecificationVersion) or \\r
           IsValidDecVersionVal(PiSpecificationVersion):\r
            self.PiSpecificationVersion = InfDefMember()\r
            self.PiSpecificationVersion.SetValue(PiSpecificationVersion)\r
            self.PiSpecificationVersion.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID\\r
                       %(PiSpecificationVersion),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    ## GetPiSpecificationVersion\r
    #\r
    def GetPiSpecificationVersion(self):\r
        return self.PiSpecificationVersion\r
\r
    ## SetLibraryClass\r
    #\r
    # @param LibraryClass: LibraryClass\r
    #\r
    def SetLibraryClass(self, LibraryClass, Comments):\r
        ValueList = GetSplitValueList(LibraryClass)\r
        Name = ValueList[0]\r
        if IsValidWord(Name):\r
            InfDefineLibraryItemObj = InfDefineLibraryItem()\r
            InfDefineLibraryItemObj.SetLibraryName(Name)\r
            InfDefineLibraryItemObj.Comments = Comments\r
            if len(ValueList) == 2:\r
                Type = ValueList[1]\r
                TypeList = GetSplitValueList(Type, ' ')\r
                TypeList = [Type for Type in TypeList if Type != '']\r
                for Item in TypeList:\r
                    if Item not in DT.MODULE_LIST:\r
                        ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Item),\r
                                   LineInfo=self.CurrentLine)\r
                        return False\r
                InfDefineLibraryItemObj.SetTypes(TypeList)\r
            self.LibraryClass.append(InfDefineLibraryItemObj)\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Name),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
        return True\r
\r
    def GetLibraryClass(self):\r
        return self.LibraryClass\r
\r
    def SetVersionString(self, VersionString, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.VersionString is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_VERSION_STRING),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if not IsValidDecVersion(VersionString):\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID\\r
                       %(VersionString),\r
                       LineInfo=self.CurrentLine)\r
        self.VersionString = InfDefMember()\r
        self.VersionString.SetValue(VersionString)\r
        self.VersionString.Comments = Comments\r
        return True\r
\r
\r
    def GetVersionString(self):\r
        return self.VersionString\r
\r
    def SetPcdIsDriver(self, PcdIsDriver, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.PcdIsDriver is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\\r
                       %(DT.TAB_INF_DEFINES_PCD_IS_DRIVER),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if PcdIsDriver == 'PEI_PCD_DRIVER' or PcdIsDriver == 'DXE_PCD_DRIVER':\r
            self.PcdIsDriver = InfDefMember()\r
            self.PcdIsDriver.SetValue(PcdIsDriver)\r
            self.PcdIsDriver.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(PcdIsDriver),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
\r
    def GetPcdIsDriver(self):\r
        return self.PcdIsDriver\r
\r
    #\r
    # SetEntryPoint\r
    #\r
    def SetEntryPoint(self, EntryPoint, Comments):\r
        #\r
        # It can be a list\r
        #\r
        ValueList = []\r
        TokenList = GetSplitValueList(EntryPoint, DT.TAB_VALUE_SPLIT)\r
        ValueList[0:len(TokenList)] = TokenList\r
        InfDefineEntryPointItemObj = InfDefineEntryPointItem()\r
        if not IsValidCVariableName(ValueList[0]):\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%\\r
                       (ValueList[0]),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineEntryPointItemObj.SetCName(ValueList[0])\r
        if len(ValueList) == 2:\r
            if ValueList[1].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%\\r
                           (ValueList[1]),\r
                           LineInfo=self.CurrentLine)\r
            #\r
            # Validate FFE\r
            #\r
            FeatureFlagRtv = IsValidFeatureFlagExp(ValueList[1].strip())\r
            if not FeatureFlagRtv[0]:\r
                ErrorInInf(ST.ERR_INF_PARSER_FEATURE_FLAG_EXP_SYNTAX_INVLID%\\r
                           (FeatureFlagRtv[1]),\r
                           LineInfo=self.CurrentLine)\r
            InfDefineEntryPointItemObj.SetFeatureFlagExp(ValueList[1])\r
        if len(ValueList) > 2:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(EntryPoint),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineEntryPointItemObj.Comments = Comments\r
        self.EntryPoint.append(InfDefineEntryPointItemObj)\r
\r
    def GetEntryPoint(self):\r
        return self.EntryPoint\r
\r
    #\r
    # SetUnloadImages\r
    #\r
    def SetUnloadImages(self, UnloadImages, Comments):\r
        #\r
        # It can be a list\r
        #\r
        ValueList = []\r
        TokenList = GetSplitValueList(UnloadImages, DT.TAB_VALUE_SPLIT)\r
        ValueList[0:len(TokenList)] = TokenList\r
        InfDefineUnloadImageItemObj = InfDefineUnloadImageItem()\r
        if not IsValidCVariableName(ValueList[0]):\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[0]),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineUnloadImageItemObj.SetCName(ValueList[0])\r
        if len(ValueList) == 2:\r
            if ValueList[1].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[1]),\r
                           LineInfo=self.CurrentLine)\r
            #\r
            # Validate FFE\r
            #\r
            FeatureFlagRtv = IsValidFeatureFlagExp(ValueList[1].strip())\r
            if not FeatureFlagRtv[0]:\r
                ErrorInInf(ST.ERR_INF_PARSER_FEATURE_FLAG_EXP_SYNTAX_INVLID%(FeatureFlagRtv[1]),\r
                           LineInfo=self.CurrentLine)\r
            InfDefineUnloadImageItemObj.SetFeatureFlagExp(ValueList[1])\r
\r
        if len(ValueList) > 2:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(UnloadImages),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineUnloadImageItemObj.Comments = Comments\r
        self.UnloadImages.append(InfDefineUnloadImageItemObj)\r
\r
    def GetUnloadImages(self):\r
        return self.UnloadImages\r
\r
    #\r
    # SetConstructor\r
    #\r
    def SetConstructor(self, Constructor, Comments):\r
        #\r
        # It can be a list\r
        #\r
        ValueList = []\r
        TokenList = GetSplitValueList(Constructor, DT.TAB_VALUE_SPLIT)\r
        ValueList[0:len(TokenList)] = TokenList\r
        InfDefineConstructorItemObj = InfDefineConstructorItem()\r
        if not IsValidCVariableName(ValueList[0]):\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[0]),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineConstructorItemObj.SetCName(ValueList[0])\r
        if len(ValueList) >= 2:\r
            ModList = GetSplitValueList(ValueList[1], ' ')\r
            if ValueList[1].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[1]),\r
                           LineInfo=self.CurrentLine)\r
            for ModItem in ModList:\r
                if ModItem not in DT.MODULE_LIST:\r
                    ErrorInInf(ST.ERR_INF_PARSER_DEFINE_MODULETYPE_INVALID%(ModItem),\r
                               LineInfo=self.CurrentLine)\r
            InfDefineConstructorItemObj.SetSupModList(ModList)\r
        if len(ValueList) == 3:\r
            if ValueList[2].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[2]),\r
                           LineInfo=self.CurrentLine)\r
            #\r
            # Validate FFE\r
            #\r
            FeatureFlagRtv = IsValidFeatureFlagExp(ValueList[2].strip())\r
            if not FeatureFlagRtv[0]:\r
                ErrorInInf(ST.ERR_INF_PARSER_FEATURE_FLAG_EXP_SYNTAX_INVLID%(FeatureFlagRtv[2]),\r
                           LineInfo=self.CurrentLine)\r
            InfDefineConstructorItemObj.SetFeatureFlagExp(ValueList[2])\r
\r
        if len(ValueList) > 3:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Constructor),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineConstructorItemObj.Comments = Comments\r
        self.Constructor.append(InfDefineConstructorItemObj)\r
\r
    def GetConstructor(self):\r
        return self.Constructor\r
\r
    #\r
    # SetDestructor\r
    #\r
    def SetDestructor(self, Destructor, Comments):\r
        #\r
        # It can be a list and only 1 set to TRUE\r
        #\r
        ValueList = []\r
        TokenList = GetSplitValueList(Destructor, DT.TAB_VALUE_SPLIT)\r
        ValueList[0:len(TokenList)] = TokenList\r
        InfDefineDestructorItemObj = InfDefineDestructorItem()\r
        if not IsValidCVariableName(ValueList[0]):\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[0]),\r
                       LineInfo=self.CurrentLine)\r
        InfDefineDestructorItemObj.SetCName(ValueList[0])\r
        if len(ValueList) >= 2:\r
            ModList = GetSplitValueList(ValueList[1].strip(), ' ')\r
            if ValueList[1].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[1]),\r
                           LineInfo=self.CurrentLine)\r
            for ModItem in ModList:\r
                if ModItem not in DT.MODULE_LIST:\r
                    ErrorInInf(ST.ERR_INF_PARSER_DEFINE_MODULETYPE_INVALID%(ModItem),\r
                               LineInfo=self.CurrentLine)\r
            InfDefineDestructorItemObj.SetSupModList(ModList)\r
        if len(ValueList) == 3:\r
            if ValueList[2].strip() == '':\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(ValueList[2]),\r
                           LineInfo=self.CurrentLine)\r
            #\r
            # Validate FFE\r
            #\r
            FeatureFlagRtv = IsValidFeatureFlagExp(ValueList[2].strip())\r
            if not FeatureFlagRtv[0]:\r
                ErrorInInf(ST.ERR_INF_PARSER_FEATURE_FLAG_EXP_SYNTAX_INVLID%(FeatureFlagRtv[1]),\r
                           LineInfo=self.CurrentLine)\r
            InfDefineDestructorItemObj.SetFeatureFlagExp(ValueList[2])\r
\r
        if len(ValueList) > 3:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Destructor),\r
                       LineInfo=self.CurrentLine)\r
\r
        InfDefineDestructorItemObj.Comments = Comments\r
        self.Destructor.append(InfDefineDestructorItemObj)\r
\r
    def GetDestructor(self):\r
        return self.Destructor\r
\r
    def SetShadow(self, Shadow, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.Shadow is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND%(DT.TAB_INF_DEFINES_SHADOW),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if (IsValidBoolType(Shadow)):\r
            self.Shadow = InfDefMember()\r
            self.Shadow.SetValue(Shadow)\r
            self.Shadow.Comments = Comments\r
            return True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Shadow),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
    def GetShadow(self):\r
        return self.Shadow\r
\r
    #\r
    # <Family>               ::=  {"MSFT"} {"GCC"}\r
    # <CustomMake>           ::=  [<Family> "|"] <Filename>\r
    #\r
    def SetCustomMakefile(self, CustomMakefile, Comments):\r
        if not (CustomMakefile == '' or CustomMakefile is None):\r
            ValueList = GetSplitValueList(CustomMakefile)\r
            if len(ValueList) == 1:\r
                FileName = ValueList[0]\r
                Family = ''\r
            else:\r
                Family = ValueList[0]\r
                FileName = ValueList[1]\r
            Family = Family.strip()\r
            if Family != '':\r
                if not IsValidFamily(Family):\r
                    ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Family),\r
                               LineInfo=self.CurrentLine)\r
                    return False\r
            #\r
            # The MakefileName specified file should exist\r
            #\r
            IsValidFileFlag = False\r
            ModulePath = os.path.split(self.CurrentLine[0])[0]\r
            if IsValidPath(FileName, ModulePath):\r
                IsValidFileFlag = True\r
            else:\r
                ErrorInInf(ST.ERR_INF_PARSER_FILE_NOT_EXIST_OR_NAME_INVALID%(FileName),\r
                           LineInfo=self.CurrentLine)\r
                return False\r
            if IsValidFileFlag:\r
                FileName = ConvPathFromAbsToRel(FileName, GlobalData.gINF_MODULE_DIR)\r
                self.CustomMakefile.append((Family, FileName, Comments))\r
                IsValidFileFlag = False\r
            return True\r
        else:\r
            return False\r
\r
    def GetCustomMakefile(self):\r
        return self.CustomMakefile\r
\r
    #\r
    # ["SPEC" <Spec> <EOL>]*{0,}\r
    # <Spec>                 ::=  <Word> "=" <VersionVal>\r
    # <VersionVal>           ::=  {<HexVersion>] {<DecVersion>}\r
    # <HexNumber>            ::=  "0x" [<HexDigit>]{1,}\r
    # <DecVersion>           ::=  (0-9){1,} ["." (0-9){1,2}]\r
    #\r
    def SetSpecification(self, Specification, Comments):\r
        #\r
        # Valid the value of Specification\r
        #\r
        __ValueList = []\r
        TokenList = GetSplitValueList(Specification, DT.TAB_EQUAL_SPLIT, 1)\r
        __ValueList[0:len(TokenList)] = TokenList\r
        if len(__ValueList) != 2:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_NO_NAME + ' Or ' + ST.ERR_INF_PARSER_DEFINE_ITEM_NO_VALUE,\r
                       LineInfo=self.CurrentLine)\r
        Name = __ValueList[0].strip()\r
        Version = __ValueList[1].strip()\r
        if IsValidIdentifier(Name):\r
            if IsValidDecVersion(Version):\r
                self.Specification.append((Name, Version, Comments))\r
                return True\r
            else:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Version),\r
                           LineInfo=self.CurrentLine)\r
                return False\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(Name),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        return True\r
\r
    def GetSpecification(self):\r
        return self.Specification\r
\r
    #\r
    # [<UefiHiiResource> <EOL>]{0,1}\r
    # <UefiHiiResource>      ::=  "UEFI_HII_RESOURCE_SECTION" "=" <BoolType>\r
    #\r
    def SetUefiHiiResourceSection(self, UefiHiiResourceSection, Comments):\r
        #\r
        # Value has been set before.\r
        #\r
        if self.UefiHiiResourceSection is not None:\r
            ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_MORE_THAN_ONE_FOUND\r
                       %(DT.TAB_INF_DEFINES_UEFI_HII_RESOURCE_SECTION),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if not (UefiHiiResourceSection == '' or UefiHiiResourceSection is None):\r
            if (IsValidBoolType(UefiHiiResourceSection)):\r
                self.UefiHiiResourceSection = InfDefMember()\r
                self.UefiHiiResourceSection.SetValue(UefiHiiResourceSection)\r
                self.UefiHiiResourceSection.Comments = Comments\r
                return True\r
            else:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_FROMAT_INVALID%(UefiHiiResourceSection),\r
                           LineInfo=self.CurrentLine)\r
                return False\r
        else:\r
            return False\r
\r
    def GetUefiHiiResourceSection(self):\r
        return self.UefiHiiResourceSection\r
\r
    def SetDpxSource(self, DpxSource, Comments):\r
        #\r
        # The MakefileName specified file should exist\r
        #\r
        IsValidFileFlag = False\r
        ModulePath = os.path.split(self.CurrentLine[0])[0]\r
        if IsValidPath(DpxSource, ModulePath):\r
            IsValidFileFlag = True\r
        else:\r
            ErrorInInf(ST.ERR_INF_PARSER_FILE_NOT_EXIST_OR_NAME_INVALID%(DpxSource),\r
                       LineInfo=self.CurrentLine)\r
            return False\r
        if IsValidFileFlag:\r
            DpxSource = ConvPathFromAbsToRel(DpxSource,\r
                            GlobalData.gINF_MODULE_DIR)\r
            self.DpxSource.append((DpxSource, Comments))\r
            IsValidFileFlag = False\r
        return True\r
\r
    def GetDpxSource(self):\r
        return self.DpxSource\r
\r
gFUNCTION_MAPPING_FOR_DEFINE_SECTION = {\r
    #\r
    # Required Fields\r
    #\r
    DT.TAB_INF_DEFINES_BASE_NAME                   : InfDefSection.SetBaseName,\r
    DT.TAB_INF_DEFINES_FILE_GUID                   : InfDefSection.SetFileGuid,\r
    DT.TAB_INF_DEFINES_MODULE_TYPE                 : InfDefSection.SetModuleType,\r
    #\r
    # Required by EDKII style INF file\r
    #\r
    DT.TAB_INF_DEFINES_INF_VERSION                 : InfDefSection.SetInfVersion,\r
    #\r
    # Optional Fields\r
    #\r
    DT.TAB_INF_DEFINES_MODULE_UNI_FILE             : InfDefSection.SetModuleUniFileName,\r
    DT.TAB_INF_DEFINES_EDK_RELEASE_VERSION         : InfDefSection.SetEdkReleaseVersion,\r
    DT.TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION  : InfDefSection.SetUefiSpecificationVersion,\r
    DT.TAB_INF_DEFINES_PI_SPECIFICATION_VERSION    : InfDefSection.SetPiSpecificationVersion,\r
    DT.TAB_INF_DEFINES_LIBRARY_CLASS               : InfDefSection.SetLibraryClass,\r
    DT.TAB_INF_DEFINES_VERSION_STRING              : InfDefSection.SetVersionString,\r
    DT.TAB_INF_DEFINES_PCD_IS_DRIVER               : InfDefSection.SetPcdIsDriver,\r
    DT.TAB_INF_DEFINES_ENTRY_POINT                 : InfDefSection.SetEntryPoint,\r
    DT.TAB_INF_DEFINES_UNLOAD_IMAGE                : InfDefSection.SetUnloadImages,\r
    DT.TAB_INF_DEFINES_CONSTRUCTOR                 : InfDefSection.SetConstructor,\r
    DT.TAB_INF_DEFINES_DESTRUCTOR                  : InfDefSection.SetDestructor,\r
    DT.TAB_INF_DEFINES_SHADOW                      : InfDefSection.SetShadow,\r
    DT.TAB_INF_DEFINES_PCI_VENDOR_ID               : InfDefSection.SetPciVendorId,\r
    DT.TAB_INF_DEFINES_PCI_DEVICE_ID               : InfDefSection.SetPciDeviceId,\r
    DT.TAB_INF_DEFINES_PCI_CLASS_CODE              : InfDefSection.SetPciClassCode,\r
    DT.TAB_INF_DEFINES_PCI_REVISION                : InfDefSection.SetPciRevision,\r
    DT.TAB_INF_DEFINES_PCI_COMPRESS                : InfDefSection.SetPciCompress,\r
    DT.TAB_INF_DEFINES_CUSTOM_MAKEFILE             : InfDefSection.SetCustomMakefile,\r
    DT.TAB_INF_DEFINES_SPEC                        : InfDefSection.SetSpecification,\r
    DT.TAB_INF_DEFINES_UEFI_HII_RESOURCE_SECTION   : InfDefSection.SetUefiHiiResourceSection,\r
    DT.TAB_INF_DEFINES_DPX_SOURCE                  : InfDefSection.SetDpxSource\r
}\r
\r
## InfDefMember\r
#\r
#\r
class InfDefMember():\r
    def __init__(self, Name='', Value=''):\r
        self.Comments = InfLineCommentObject()\r
        self.Name  = Name\r
        self.Value = Value\r
        self.CurrentLine = CurrentLine()\r
    def GetName(self):\r
        return self.Name\r
    def SetName(self, Name):\r
        self.Name = Name\r
    def GetValue(self):\r
        return self.Value\r
    def SetValue(self, Value):\r
        self.Value = Value\r
\r
## InfDefObject\r
#\r
#\r
class InfDefObject(InfSectionCommonDef):\r
    def __init__(self):\r
        self.Defines = Sdict()\r
        InfSectionCommonDef.__init__(self)\r
    def SetDefines(self, DefineContent, Arch = None):\r
        #\r
        # Validate Arch\r
        #\r
        HasFoundInfVersionFalg = False\r
        LineInfo = ['', -1, '']\r
        ArchListString = ' '.join(Arch)\r
        #\r
        # Parse Define items.\r
        #\r
        for InfDefMemberObj in DefineContent:\r
            ProcessFunc = None\r
            Name = InfDefMemberObj.GetName()\r
            Value = InfDefMemberObj.GetValue()\r
            if Name == DT.TAB_INF_DEFINES_MODULE_UNI_FILE:\r
                ValidateUNIFilePath(Value)\r
                Value = os.path.join(os.path.dirname(InfDefMemberObj.CurrentLine.FileName), Value)\r
                if not os.path.isfile(Value) or not os.path.exists(Value):\r
                    LineInfo[0] = InfDefMemberObj.CurrentLine.GetFileName()\r
                    LineInfo[1] = InfDefMemberObj.CurrentLine.GetLineNo()\r
                    LineInfo[2] = InfDefMemberObj.CurrentLine.GetLineString()\r
                    ErrorInInf(ST.ERR_INF_PARSER_FILE_NOT_EXIST_OR_NAME_INVALID%(Name),\r
                                   LineInfo=LineInfo)\r
            InfLineCommentObj = InfLineCommentObject()\r
            InfLineCommentObj.SetHeaderComments(InfDefMemberObj.Comments.GetHeaderComments())\r
            InfLineCommentObj.SetTailComments(InfDefMemberObj.Comments.GetTailComments())\r
            if Name == 'COMPONENT_TYPE':\r
                ErrorInInf(ST.ERR_INF_PARSER_NOT_SUPPORT_EDKI_INF,\r
                           ErrorCode=ToolError.EDK1_INF_ERROR,\r
                           RaiseError=True)\r
            if Name == DT.TAB_INF_DEFINES_INF_VERSION:\r
                HasFoundInfVersionFalg = True\r
            if not (Name == '' or Name is None):\r
                #\r
                # Process "SPEC" Keyword definition.\r
                #\r
                ReName = re.compile(r"SPEC ", re.DOTALL)\r
                if ReName.match(Name):\r
                    SpecValue = Name[Name.find("SPEC") + len("SPEC"):].strip()\r
                    Name = "SPEC"\r
                    Value = SpecValue + " = " + Value\r
                if ArchListString in self.Defines:\r
                    DefineList = self.Defines[ArchListString]\r
                    LineInfo[0] = InfDefMemberObj.CurrentLine.GetFileName()\r
                    LineInfo[1] = InfDefMemberObj.CurrentLine.GetLineNo()\r
                    LineInfo[2] = InfDefMemberObj.CurrentLine.GetLineString()\r
                    DefineList.CurrentLine = LineInfo\r
                    #\r
                    # Found the process function from mapping table.\r
                    #\r
                    if Name not in gFUNCTION_MAPPING_FOR_DEFINE_SECTION.keys():\r
                        ErrorInInf(ST.ERR_INF_PARSER_DEFINE_SECTION_KEYWORD_INVALID%(Name),\r
                                   LineInfo=LineInfo)\r
                    else:\r
                        ProcessFunc = gFUNCTION_MAPPING_FOR_DEFINE_SECTION[Name]\r
                    if (ProcessFunc is not None):\r
                        ProcessFunc(DefineList, Value, InfLineCommentObj)\r
                    self.Defines[ArchListString] = DefineList\r
                else:\r
                    DefineList = InfDefSection()\r
                    LineInfo[0] = InfDefMemberObj.CurrentLine.GetFileName()\r
                    LineInfo[1] = InfDefMemberObj.CurrentLine.GetLineNo()\r
                    LineInfo[2] = InfDefMemberObj.CurrentLine.GetLineString()\r
                    DefineList.CurrentLine = LineInfo\r
                    #\r
                    # Found the process function from mapping table.\r
                    #\r
                    if Name not in gFUNCTION_MAPPING_FOR_DEFINE_SECTION.keys():\r
                        ErrorInInf(ST.ERR_INF_PARSER_DEFINE_SECTION_KEYWORD_INVALID%(Name),\r
                                   LineInfo=LineInfo)\r
                    #\r
                    # Found the process function from mapping table.\r
                    #\r
                    else:\r
                        ProcessFunc = gFUNCTION_MAPPING_FOR_DEFINE_SECTION[Name]\r
                    if (ProcessFunc is not None):\r
                        ProcessFunc(DefineList, Value, InfLineCommentObj)\r
                    self.Defines[ArchListString] = DefineList\r
        #\r
        # After set, check whether INF_VERSION defined.\r
        #\r
        if not HasFoundInfVersionFalg:\r
            ErrorInInf(ST.ERR_INF_PARSER_NOT_SUPPORT_EDKI_INF,\r
                       ErrorCode=ToolError.EDK1_INF_ERROR,\r
                       RaiseError=True)\r
        return True\r
\r
    def GetDefines(self):\r
        return self.Defines\r
\r