BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file contained the miscellaneous functions for INF parser\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
'''\r
InfParserMisc\r
'''\r
\r
##\r
# Import Modules\r
#\r
import re\r
\r
\r
from Library import DataType as DT\r
\r
\r
from Library.StringUtils import gMACRO_PATTERN\r
from Library.StringUtils import ReplaceMacro\r
from Object.Parser.InfMisc import ErrorInInf\r
from Logger.StringTable import ERR_MARCO_DEFINITION_MISS_ERROR\r
\r
#\r
# Global variable\r
#\r
\r
#\r
# Sections can exist in INF file\r
#\r
gINF_SECTION_DEF = {\r
       DT.TAB_UNKNOWN.upper()          : DT.MODEL_UNKNOWN,\r
       DT.TAB_HEADER.upper()           : DT.MODEL_META_DATA_FILE_HEADER,\r
       DT.TAB_INF_DEFINES.upper()      : DT.MODEL_META_DATA_DEFINE,\r
       DT.TAB_BUILD_OPTIONS.upper()    : DT.MODEL_META_DATA_BUILD_OPTION,\r
       DT.TAB_LIBRARY_CLASSES.upper()  : DT.MODEL_EFI_LIBRARY_CLASS,\r
       DT.TAB_PACKAGES.upper()         : DT.MODEL_META_DATA_PACKAGE,\r
       DT.TAB_INF_FIXED_PCD.upper()    : DT.MODEL_PCD_FIXED_AT_BUILD,\r
       DT.TAB_INF_PATCH_PCD.upper()    : DT.MODEL_PCD_PATCHABLE_IN_MODULE,\r
       DT.TAB_INF_FEATURE_PCD.upper()  : DT.MODEL_PCD_FEATURE_FLAG,\r
       DT.TAB_INF_PCD_EX.upper()       : DT.MODEL_PCD_DYNAMIC_EX,\r
       DT.TAB_INF_PCD.upper()          : DT.MODEL_PCD_DYNAMIC,\r
       DT.TAB_SOURCES.upper()          : DT.MODEL_EFI_SOURCE_FILE,\r
       DT.TAB_GUIDS.upper()            : DT.MODEL_EFI_GUID,\r
       DT.TAB_PROTOCOLS.upper()        : DT.MODEL_EFI_PROTOCOL,\r
       DT.TAB_PPIS.upper()             : DT.MODEL_EFI_PPI,\r
       DT.TAB_DEPEX.upper()            : DT.MODEL_EFI_DEPEX,\r
       DT.TAB_BINARIES.upper()         : DT.MODEL_EFI_BINARY_FILE,\r
       DT.TAB_USER_EXTENSIONS.upper()  : DT.MODEL_META_DATA_USER_EXTENSION\r
       #\r
       # EDK1 section\r
       # TAB_NMAKE.upper()            : MODEL_META_DATA_NMAKE\r
       #\r
       }\r
\r
## InfExpandMacro\r
#\r
# Expand MACRO definition with MACROs defined in [Defines] section and specific section.\r
# The MACROs defined in specific section has high priority and will be expanded firstly.\r
#\r
# @param LineInfo      Contain information of FileName, LineContent, LineNo\r
# @param GlobalMacros  MACROs defined in INF [Defines] section\r
# @param SectionMacros MACROs defined in INF specific section\r
# @param Flag          If the flag set to True, need to skip macros in a quoted string\r
#\r
def InfExpandMacro(Content, LineInfo, GlobalMacros=None, SectionMacros=None, Flag=False):\r
    if GlobalMacros is None:\r
        GlobalMacros = {}\r
    if SectionMacros is None:\r
        SectionMacros = {}\r
\r
    FileName = LineInfo[0]\r
    LineContent = LineInfo[1]\r
    LineNo = LineInfo[2]\r
\r
    # Don't expand macros in comments\r
    if LineContent.strip().startswith("#"):\r
        return Content\r
\r
    NewLineInfo = (FileName, LineNo, LineContent)\r
\r
    #\r
    # First, replace MARCOs with value defined in specific section\r
    #\r
    Content = ReplaceMacro (Content,\r
                            SectionMacros,\r
                            False,\r
                            (LineContent, LineNo),\r
                            FileName,\r
                            Flag)\r
    #\r
    # Then replace MARCOs with value defined in [Defines] section\r
    #\r
    Content = ReplaceMacro (Content,\r
                            GlobalMacros,\r
                            False,\r
                            (LineContent, LineNo),\r
                            FileName,\r
                            Flag)\r
\r
    MacroUsed = gMACRO_PATTERN.findall(Content)\r
    #\r
    # no macro found in String, stop replacing\r
    #\r
    if len(MacroUsed) == 0:\r
        return Content\r
    else:\r
        for Macro in MacroUsed:\r
            gQuotedMacro = re.compile(".*\".*\$\(%s\).*\".*"%(Macro))\r
            if not gQuotedMacro.match(Content):\r
                #\r
                # Still have MACROs can't be expanded.\r
                #\r
                ErrorInInf (ERR_MARCO_DEFINITION_MISS_ERROR,\r
                            LineInfo=NewLineInfo)\r
\r
    return Content\r
\r
\r
## IsBinaryInf\r
#\r
# Judge whether the INF file is Binary INF or Common INF\r
#\r
# @param FileLineList     A list contain all INF file content.\r
#\r
def IsBinaryInf(FileLineList):\r
    if not FileLineList:\r
        return False\r
\r
    ReIsSourcesSection = re.compile("^\s*\[Sources.*\]\s.*$", re.IGNORECASE)\r
    ReIsBinarySection = re.compile("^\s*\[Binaries.*\]\s.*$", re.IGNORECASE)\r
    BinarySectionFoundFlag = False\r
\r
    for Line in FileLineList:\r
        if ReIsSourcesSection.match(Line):\r
            return False\r
        if ReIsBinarySection.match(Line):\r
            BinarySectionFoundFlag = True\r
\r
    if BinarySectionFoundFlag:\r
        return True\r
\r
    return False\r
\r
\r
## IsLibInstanceInfo\r
#\r
# Judge whether the string contain the information of ## @LIB_INSTANCES.\r
#\r
# @param  String\r
#\r
# @return Flag\r
#\r
def IsLibInstanceInfo(String):\r
    ReIsLibInstance = re.compile("^\s*##\s*@LIB_INSTANCES\s*$")\r
    if ReIsLibInstance.match(String):\r
        return True\r
    else:\r
        return False\r
\r
\r
## IsAsBuildOptionInfo\r
#\r
# Judge whether the string contain the information of ## @ASBUILD.\r
#\r
# @param  String\r
#\r
# @return Flag\r
#\r
def IsAsBuildOptionInfo(String):\r
    ReIsAsBuildInstance = re.compile("^\s*##\s*@AsBuilt\s*$")\r
    if ReIsAsBuildInstance.match(String):\r
        return True\r
    else:\r
        return False\r
\r
\r
class InfParserSectionRoot(object):\r
    def __init__(self):\r
        #\r
        # Macros defined in [Define] section are file scope global\r
        #\r
        self.FileLocalMacros = {}\r
\r
        #\r
        # Current Section Header content.\r
        #\r
        self.SectionHeaderContent = []\r
\r
        #\r
        # Last time Section Header content.\r
        #\r
        self.LastSectionHeaderContent = []\r
\r
        self.FullPath = ''\r
\r
        self.InfDefSection              = None\r
        self.InfBuildOptionSection      = None\r
        self.InfLibraryClassSection     = None\r
        self.InfPackageSection          = None\r
        self.InfPcdSection              = None\r
        self.InfSourcesSection          = None\r
        self.InfUserExtensionSection    = None\r
        self.InfProtocolSection         = None\r
        self.InfPpiSection              = None\r
        self.InfGuidSection             = None\r
        self.InfDepexSection            = None\r
        self.InfPeiDepexSection         = None\r
        self.InfDxeDepexSection         = None\r
        self.InfSmmDepexSection         = None\r
        self.InfBinariesSection         = None\r
        self.InfHeader                  = None\r
        self.InfSpecialCommentSection   = None\r