BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# This file contained the parser for define 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
'''\r
InfDefineSectionParser\r
'''\r
##\r
# Import Modules\r
#\r
import re\r
\r
from Library import DataType as DT\r
from Library import GlobalData\r
from Library.Parsing import MacroParser\r
from Library.Misc import GetSplitValueList\r
from Library.ParserValidate import IsValidArch\r
from Object.Parser.InfCommonObject import InfLineCommentObject\r
from Object.Parser.InfDefineObject import InfDefMember\r
from Parser.InfParserMisc import InfExpandMacro\r
from Object.Parser.InfMisc import ErrorInInf\r
from Logger import StringTable as ST\r
from Parser.InfParserMisc import InfParserSectionRoot\r
\r
## __GetValidateArchList\r
#\r
#\r
def GetValidateArchList(LineContent):\r
\r
    TempArch = ''\r
    ArchList = []\r
    ValidateAcrhPatten = re.compile(r"^\s*#\s*VALID_ARCHITECTURES\s*=\s*.*$", re.DOTALL)\r
\r
    if ValidateAcrhPatten.match(LineContent):\r
        TempArch = GetSplitValueList(LineContent, DT.TAB_EQUAL_SPLIT, 1)[1]\r
\r
        TempArch = GetSplitValueList(TempArch, '(', 1)[0]\r
\r
        ArchList = re.split('\s+', TempArch)\r
        NewArchList = []\r
        for Arch in ArchList:\r
            if IsValidArch(Arch):\r
                NewArchList.append(Arch)\r
\r
        ArchList = NewArchList\r
\r
    return ArchList\r
\r
class InfDefinSectionParser(InfParserSectionRoot):\r
    def InfDefineParser(self, SectionString, InfSectionObject, FileName, SectionComment):\r
\r
        if SectionComment:\r
            pass\r
        #\r
        # Parser Defines section content and fill self._ContentList dict.\r
        #\r
        StillCommentFalg  = False\r
        HeaderComments = []\r
        SectionContent = ''\r
        ArchList       = []\r
        _ContentList   = []\r
        _ValueList     = []\r
        #\r
        # Add WORKSPACE to global Marco dict.\r
        #\r
        self.FileLocalMacros['WORKSPACE'] = GlobalData.gWORKSPACE\r
\r
        for Line in SectionString:\r
            LineContent = Line[0]\r
            LineNo      = Line[1]\r
            TailComments   = ''\r
            LineComment    = None\r
\r
            LineInfo       = ['', -1, '']\r
            LineInfo[0]    = FileName\r
            LineInfo[1]    = LineNo\r
            LineInfo[2]    = LineContent\r
\r
            if LineContent.strip() == '':\r
                continue\r
            #\r
            # The first time encountered VALIDATE_ARCHITECHERS will be considered as support arch list.\r
            #\r
            if not ArchList:\r
                ArchList = GetValidateArchList(LineContent)\r
\r
            #\r
            # Parser Comment\r
            #\r
            if LineContent.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 += LineContent + 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 += LineContent + 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 LineContent.find(DT.TAB_COMMENT_SPLIT) > -1:\r
                TailComments = LineContent[LineContent.find(DT.TAB_COMMENT_SPLIT):]\r
                LineContent = LineContent[:LineContent.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((LineContent, LineNo),\r
                                      FileName,\r
                                      DT.MODEL_META_DATA_HEADER,\r
                                      self.FileLocalMacros)\r
            if Name is not None:\r
                self.FileLocalMacros[Name] = Value\r
                continue\r
\r
            #\r
            # Replace with [Defines] section Macro\r
            #\r
            LineContent = InfExpandMacro(LineContent,\r
                                         (FileName, LineContent, LineNo),\r
                                         self.FileLocalMacros,\r
                                         None, True)\r
\r
            SectionContent += LineContent + DT.END_OF_LINE\r
\r
            TokenList = GetSplitValueList(LineContent, DT.TAB_EQUAL_SPLIT, 1)\r
            if len(TokenList) < 2:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_NO_VALUE,\r
                           LineInfo=LineInfo)\r
            _ValueList[0:len(TokenList)] = TokenList\r
            if not _ValueList[0]:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_NO_NAME,\r
                           LineInfo=LineInfo)\r
            if not _ValueList[1]:\r
                ErrorInInf(ST.ERR_INF_PARSER_DEFINE_ITEM_NO_VALUE,\r
                           LineInfo=LineInfo)\r
\r
            Name, Value = _ValueList[0], _ValueList[1]\r
\r
            InfDefMemberObj = InfDefMember(Name, Value)\r
            if (LineComment is not None):\r
                InfDefMemberObj.Comments.SetHeaderComments(LineComment.GetHeaderComments())\r
                InfDefMemberObj.Comments.SetTailComments(LineComment.GetTailComments())\r
\r
            InfDefMemberObj.CurrentLine.SetFileName(self.FullPath)\r
            InfDefMemberObj.CurrentLine.SetLineString(LineContent)\r
            InfDefMemberObj.CurrentLine.SetLineNo(LineNo)\r
\r
            _ContentList.append(InfDefMemberObj)\r
            HeaderComments = []\r
            TailComments = ''\r
\r
        #\r
        # Current Define section archs\r
        #\r
        if not ArchList:\r
            ArchList = ['COMMON']\r
\r
        InfSectionObject.SetAllContent(SectionContent)\r
\r
        InfSectionObject.SetDefines(_ContentList, Arch=ArchList)\r
\r