BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file contained the parser for [Depex] sections in INF file\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
'''\r
InfDepexSectionParser\r
'''\r
##\r
# Import Modules\r
#\r
import re\r
import Logger.Log as Logger\r
from Logger import StringTable as ST\r
from Logger.ToolError import FORMAT_INVALID\r
from Parser.InfParserMisc import InfExpandMacro\r
from Library import DataType as DT\r
from Library.Misc import GetSplitValueList\r
from Parser.InfParserMisc import InfParserSectionRoot\r
\r
class InfDepexSectionParser(InfParserSectionRoot):\r
    ## InfDepexParser\r
    #\r
    # For now, only separate Depex String and comments.\r
    # Have two types of section header.\r
    # 1. [Depex.Arch.ModuleType, ...]\r
    # 2. [Depex.Arch|FFE, ...]\r
    #\r
    def InfDepexParser(self, SectionString, InfSectionObject, FileName):\r
        DepexContent = []\r
        DepexComment = []\r
        ValueList    = []\r
        #\r
        # Parse section content\r
        #\r
        for Line in SectionString:\r
            LineContent = Line[0]\r
            LineNo      = Line[1]\r
\r
            #\r
            # Found comment\r
            #\r
            if LineContent.strip().startswith(DT.TAB_COMMENT_SPLIT):\r
                DepexComment.append((LineContent, LineNo))\r
                continue\r
            #\r
            # Replace with [Defines] section Macro\r
            #\r
            LineContent = InfExpandMacro(LineContent,\r
                                         (FileName, LineContent, Line[1]),\r
                                         self.FileLocalMacros,\r
                                         None, True)\r
\r
            CommentCount = LineContent.find(DT.TAB_COMMENT_SPLIT)\r
\r
            if CommentCount > -1:\r
                DepexComment.append((LineContent[CommentCount:], LineNo))\r
                LineContent = LineContent[:CommentCount-1]\r
\r
\r
            CommentCount = -1\r
            DepexContent.append((LineContent, LineNo))\r
\r
            TokenList = GetSplitValueList(LineContent, DT.TAB_COMMENT_SPLIT)\r
            ValueList[0:len(TokenList)] = TokenList\r
\r
        #\r
        # Current section archs\r
        #\r
        KeyList = []\r
        LastItem = ''\r
        for Item in self.LastSectionHeaderContent:\r
            LastItem = Item\r
            if (Item[1], Item[2], Item[3]) not in KeyList:\r
                KeyList.append((Item[1], Item[2], Item[3]))\r
\r
        NewCommentList = []\r
        FormatCommentLn = -1\r
        ReFormatComment = re.compile(r"""#(?:\s*)\[(.*?)\](?:.*)""", re.DOTALL)\r
        for CommentItem in DepexComment:\r
            CommentContent = CommentItem[0]\r
            if ReFormatComment.match(CommentContent) is not None:\r
                FormatCommentLn = CommentItem[1] + 1\r
                continue\r
\r
            if CommentItem[1] != FormatCommentLn:\r
                NewCommentList.append(CommentContent)\r
            else:\r
                FormatCommentLn = CommentItem[1] + 1\r
\r
        if not InfSectionObject.SetDepex(DepexContent, KeyList = KeyList, CommentList = NewCommentList):\r
            Logger.Error('InfParser',\r
                         FORMAT_INVALID,\r
                         ST.ERR_INF_PARSER_MODULE_SECTION_TYPE_ERROR%("[Depex]"),\r
                         File=FileName,\r
                         Line=LastItem[3])\r