BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file contained the parser for [Sources] 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
InfSourceSectionParser\r
'''\r
##\r
# Import Modules\r
#\r
\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.Parsing import MacroParser\r
from Library.Misc import GetSplitValueList\r
from Object.Parser.InfCommonObject import InfLineCommentObject\r
from Parser.InfParserMisc import InfParserSectionRoot\r
\r
class InfSourceSectionParser(InfParserSectionRoot):\r
    ## InfSourceParser\r
    #\r
    #\r
    def InfSourceParser(self, SectionString, InfSectionObject, FileName):\r
        SectionMacros = {}\r
        ValueList     = []\r
        SourceList    = []\r
        StillCommentFalg  = False\r
        HeaderComments    = []\r
        LineComment       = None\r
        SectionContent  = ''\r
        for Line in SectionString:\r
            SrcLineContent = Line[0]\r
            SrcLineNo      = Line[1]\r
\r
            if SrcLineContent.strip() == '':\r
                continue\r
\r
            #\r
            # Found Header Comments\r
            #\r
            if SrcLineContent.strip().startswith(DT.TAB_COMMENT_SPLIT):\r
                #\r
                # Last line is comments, and this line go on.\r
                #\r
                if StillCommentFalg:\r
                    HeaderComments.append(Line)\r
                    SectionContent += SrcLineContent + DT.END_OF_LINE\r
                    continue\r
                #\r
                # First time encounter comment\r
                #\r
                else:\r
                    #\r
                    # Clear original data\r
                    #\r
                    HeaderComments = []\r
                    HeaderComments.append(Line)\r
                    StillCommentFalg = True\r
                    SectionContent += SrcLineContent + DT.END_OF_LINE\r
                    continue\r
            else:\r
                StillCommentFalg = False\r
\r
            if len(HeaderComments) >= 1:\r
                LineComment = InfLineCommentObject()\r
                LineCommentContent = ''\r
                for Item in HeaderComments:\r
                    LineCommentContent += Item[0] + DT.END_OF_LINE\r
                LineComment.SetHeaderComments(LineCommentContent)\r
\r
            #\r
            # Find Tail comment.\r
            #\r
            if SrcLineContent.find(DT.TAB_COMMENT_SPLIT) > -1:\r
                TailComments = SrcLineContent[SrcLineContent.find(DT.TAB_COMMENT_SPLIT):]\r
                SrcLineContent = SrcLineContent[:SrcLineContent.find(DT.TAB_COMMENT_SPLIT)]\r
                if LineComment is None:\r
                    LineComment = InfLineCommentObject()\r
                LineComment.SetTailComments(TailComments)\r
\r
            #\r
            # Find Macro\r
            #\r
            Name, Value = MacroParser((SrcLineContent, SrcLineNo),\r
                                      FileName,\r
                                      DT.MODEL_EFI_SOURCE_FILE,\r
                                      self.FileLocalMacros)\r
            if Name is not None:\r
                SectionMacros[Name] = Value\r
                LineComment = None\r
                HeaderComments = []\r
                continue\r
\r
            #\r
            # Replace with Local section Macro and [Defines] section Macro.\r
            #\r
            SrcLineContent = InfExpandMacro(SrcLineContent,\r
                                         (FileName, SrcLineContent, SrcLineNo),\r
                                         self.FileLocalMacros,\r
                                         SectionMacros)\r
\r
            TokenList = GetSplitValueList(SrcLineContent, DT.TAB_VALUE_SPLIT, 4)\r
            ValueList[0:len(TokenList)] = TokenList\r
\r
            #\r
            # Store section content string after MACRO replaced.\r
            #\r
            SectionContent += SrcLineContent + DT.END_OF_LINE\r
\r
            SourceList.append((ValueList, LineComment,\r
                               (SrcLineContent, SrcLineNo, FileName)))\r
            ValueList = []\r
            LineComment = None\r
            TailComments = ''\r
            HeaderComments = []\r
            continue\r
\r
        #\r
        # Current section archs\r
        #\r
        ArchList = []\r
        for Item in self.LastSectionHeaderContent:\r
            if Item[1] not in ArchList:\r
                ArchList.append(Item[1])\r
                InfSectionObject.SetSupArchList(Item[1])\r
\r
        InfSectionObject.SetAllContent(SectionContent)\r
        if not InfSectionObject.SetSources(SourceList, Arch = ArchList):\r
            Logger.Error('InfParser',\r
                         FORMAT_INVALID,\r
                         ST.ERR_INF_PARSER_MODULE_SECTION_TYPE_ERROR % ("[Sources]"),\r
                         File=FileName,\r
                         Line=Item[3])\r