BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / Python / Eot / InfParserLite.py

## @file\r
# This file is used to parse INF file of EDK project\r
#\r
# Copyright (c) 2008 - 2018, Intel Corporation. All rights reserved.<BR>\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
##\r
# Import Modules\r
#\r
from __future__ import print_function\r
from __future__ import absolute_import\r
\r
import Common.LongFilePathOs as os\r
import Common.EdkLogger as EdkLogger\r
from Common.DataType import *\r
from CommonDataClass.DataClass import *\r
from Eot.Identification import Identification\r
from Common.StringUtils import *\r
from Eot.Parser import *\r
from Eot import Database\r
from Eot import EotGlobalData\r
\r
## EdkInfParser() class\r
#\r
# This class defined basic INF object which is used by inheriting\r
#\r
# @param object:       Inherited from object class\r
#\r
class EdkInfParser(object):\r
    ## The constructor\r
    #\r
    #  @param  self: The object pointer\r
    #  @param  Filename: INF file name\r
    #  @param  Database: Eot database\r
    #  @param  SourceFileList: A list for all source file belonging this INF file\r
    #\r
    def __init__(self, Filename = None, Database = None, SourceFileList = None):\r
        self.Identification = Identification()\r
        self.Sources = []\r
        self.Macros = {}\r
\r
        self.Cur = Database.Cur\r
        self.TblFile = Database.TblFile\r
        self.TblInf = Database.TblInf\r
        self.FileID = -1\r
\r
        # Load Inf file if filename is not None\r
        if Filename is not None:\r
            self.LoadInfFile(Filename)\r
\r
        if SourceFileList:\r
            for Item in SourceFileList:\r
                self.TblInf.Insert(MODEL_EFI_SOURCE_FILE, Item, '', '', '', '', 'COMMON', -1, self.FileID, -1, -1, -1, -1, 0)\r
\r
\r
    ## LoadInffile() method\r
    #\r
    #  Load INF file and insert a record in database\r
    #\r
    #  @param  self: The object pointer\r
    #  @param Filename:  Input value for filename of Inf file\r
    #\r
    def LoadInfFile(self, Filename = None):\r
        # Insert a record for file\r
        Filename = NormPath(Filename)\r
        self.Identification.FileFullPath = Filename\r
        (self.Identification.FileRelativePath, self.Identification.FileName) = os.path.split(Filename)\r
\r
        self.FileID = self.TblFile.InsertFile(Filename, MODEL_FILE_INF)\r
\r
        self.ParseInf(PreProcess(Filename, False), self.Identification.FileRelativePath, Filename)\r
\r
    ## ParserSource() method\r
    #\r
    #  Parse Source section and insert records in database\r
    #\r
    #  @param self: The object pointer\r
    #  @param CurrentSection: current section name\r
    #  @param SectionItemList: the item belonging current section\r
    #  @param ArchList: A list for arch for this section\r
    #  @param ThirdList: A list for third item for this section\r
    #\r
    def ParserSource(self, CurrentSection, SectionItemList, ArchList, ThirdList):\r
        for Index in range(0, len(ArchList)):\r
            Arch = ArchList[Index]\r
            Third = ThirdList[Index]\r
            if Arch == '':\r
                Arch = TAB_ARCH_COMMON\r
\r
            for Item in SectionItemList:\r
                if CurrentSection.upper() == 'defines'.upper():\r
                    (Name, Value) = AddToSelfMacro(self.Macros, Item[0])\r
                    self.TblInf.Insert(MODEL_META_DATA_HEADER, Name, Value, Third, '', '', Arch, -1, self.FileID, Item[1], -1, Item[1], -1, 0)\r
\r
    ## ParseInf() method\r
    #\r
    #  Parse INF file and get sections information\r
    #\r
    #  @param self: The object pointer\r
    #  @param Lines: contents of INF file\r
    #  @param FileRelativePath: relative path of the file\r
    #  @param Filename: file name of INF file\r
    #\r
    def ParseInf(self, Lines = [], FileRelativePath = '', Filename = ''):\r
        IfDefList, SectionItemList, CurrentSection, ArchList, ThirdList, IncludeFiles = \\r
        [], [], TAB_UNKNOWN, [], [], []\r
        LineNo = 0\r
\r
        for Line in Lines:\r
            LineNo = LineNo + 1\r
            if Line == '':\r
                continue\r
            if Line.startswith(TAB_SECTION_START) and Line.endswith(TAB_SECTION_END):\r
                self.ParserSource(CurrentSection, SectionItemList, ArchList, ThirdList)\r
\r
                # Parse the new section\r
                SectionItemList = []\r
                ArchList = []\r
                ThirdList = []\r
                # Parse section name\r
                CurrentSection = ''\r
                LineList = GetSplitValueList(Line[len(TAB_SECTION_START):len(Line) - len(TAB_SECTION_END)], TAB_COMMA_SPLIT)\r
                for Item in LineList:\r
                    ItemList = GetSplitValueList(Item, TAB_SPLIT)\r
                    if CurrentSection == '':\r
                        CurrentSection = ItemList[0]\r
                    else:\r
                        if CurrentSection != ItemList[0]:\r
                            EdkLogger.error("Parser", PARSER_ERROR, "Different section names '%s' and '%s' are found in one section definition, this is not allowed." % (CurrentSection, ItemList[0]), File=Filename, Line=LineNo)\r
                    ItemList.append('')\r
                    ItemList.append('')\r
                    if len(ItemList) > 5:\r
                        RaiseParserError(Line, CurrentSection, Filename, '', LineNo)\r
                    else:\r
                        ArchList.append(ItemList[1].upper())\r
                        ThirdList.append(ItemList[2])\r
\r
                continue\r
\r
            # Add a section item\r
            SectionItemList.append([Line, LineNo])\r
            # End of parse\r
\r
        self.ParserSource(CurrentSection, SectionItemList, ArchList, ThirdList)\r
        #End of For\r
\r
\r