BaseTools: Clean up source files

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

## @file\r
# This file is used to define class objects of INF file [Depex] section.\r
# It will consumed by InfParser.\r
#\r
# Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available\r
# under the terms and conditions of the BSD License which accompanies this\r
# distribution. The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
'''\r
InfDepexObject\r
'''\r
\r
from Library import DataType as DT\r
from Library import GlobalData\r
import Logger.Log as Logger\r
from Logger import ToolError\r
from Logger import StringTable as ST\r
\r
from Object.Parser.InfCommonObject import InfSectionCommonDef\r
from Library.ParserValidate import IsValidArch\r
\r
class InfDepexContentItem():\r
    def __init__(self):\r
        self.SectionType = ''\r
        self.SectionString = ''\r
\r
    def SetSectionType(self, SectionType):\r
        self.SectionType = SectionType\r
    def GetSectionType(self):\r
        return self.SectionType\r
\r
    def SetSectionString(self, SectionString):\r
        self.SectionString = SectionString\r
    def GetSectionString(self):\r
        return self.SectionString\r
\r
\r
class InfDepexItem():\r
    def __init__(self):\r
        self.DepexContent = ''\r
        self.ModuleType = ''\r
        self.SupArch = ''\r
        self.HelpString = ''\r
        self.FeatureFlagExp = ''\r
        self.InfDepexContentItemList = []\r
\r
    def SetFeatureFlagExp(self, FeatureFlagExp):\r
        self.FeatureFlagExp = FeatureFlagExp\r
    def GetFeatureFlagExp(self):\r
        return self.FeatureFlagExp\r
\r
    def SetSupArch(self, Arch):\r
        self.SupArch = Arch\r
    def GetSupArch(self):\r
        return self.SupArch\r
\r
    def SetHelpString(self, HelpString):\r
        self.HelpString = HelpString\r
    def GetHelpString(self):\r
        return self.HelpString\r
\r
    def SetModuleType(self, Type):\r
        self.ModuleType = Type\r
    def GetModuleType(self):\r
        return self.ModuleType\r
\r
    def SetDepexConent(self, Content):\r
        self.DepexContent = Content\r
    def GetDepexContent(self):\r
        return self.DepexContent\r
\r
    def SetInfDepexContentItemList(self, InfDepexContentItemList):\r
        self.InfDepexContentItemList = InfDepexContentItemList\r
    def GetInfDepexContentItemList(self):\r
        return self.InfDepexContentItemList\r
\r
## InfDepexObject\r
#\r
#\r
#\r
class InfDepexObject(InfSectionCommonDef):\r
    def __init__(self):\r
        self.Depex = []\r
        self.AllContent = ''\r
        self.SectionContent = ''\r
        InfSectionCommonDef.__init__(self)\r
\r
    def SetDepex(self, DepexContent, KeyList=None, CommentList=None):\r
        for KeyItem in KeyList:\r
            Arch = KeyItem[0]\r
            ModuleType = KeyItem[1]\r
            InfDepexItemIns = InfDepexItem()\r
\r
            #\r
            # Validate Arch\r
            #\r
            if IsValidArch(Arch.strip().upper()):\r
                InfDepexItemIns.SetSupArch(Arch)\r
            else:\r
                Logger.Error("InfParser",\r
                             ToolError.FORMAT_INVALID,\r
                             ST.ERR_INF_PARSER_DEFINE_NAME_INVALID % (Arch),\r
                             File=GlobalData.gINF_MODULE_NAME,\r
                             Line=KeyItem[2])\r
\r
            #\r
            # Validate Module Type\r
            #\r
            if ModuleType and ModuleType != 'COMMON':\r
                if ModuleType in DT.VALID_DEPEX_MODULE_TYPE_LIST:\r
                    InfDepexItemIns.SetModuleType(ModuleType)\r
                else:\r
                    Logger.Error("InfParser",\r
                                 ToolError.FORMAT_INVALID,\r
                                 ST.ERR_INF_PARSER_DEPEX_SECTION_MODULE_TYPE_ERROR % (ModuleType),\r
                                 File=GlobalData.gINF_MODULE_NAME,\r
                                 Line=KeyItem[2])\r
\r
            #\r
            # Parser content in [Depex] section.\r
            #\r
            DepexString = ''\r
            HelpString = ''\r
            #\r
            # Get Depex Expression\r
            #\r
            for Line in DepexContent:\r
                LineContent = Line[0].strip()\r
                if LineContent.find(DT.TAB_COMMENT_SPLIT) > -1:\r
                    LineContent = LineContent[:LineContent.find(DT.TAB_COMMENT_SPLIT)]\r
                if LineContent:\r
                    DepexString = DepexString + LineContent + DT.END_OF_LINE\r
                continue\r
\r
            if DepexString.endswith(DT.END_OF_LINE):\r
                DepexString = DepexString[:-1]\r
\r
            if not DepexString.strip():\r
                continue\r
\r
            #\r
            # Get Help Text\r
            #\r
            for HelpLine in CommentList:\r
                HelpString = HelpString + HelpLine + DT.END_OF_LINE\r
            if HelpString.endswith(DT.END_OF_LINE):\r
                HelpString = HelpString[:-1]\r
\r
            InfDepexItemIns.SetDepexConent(DepexString)\r
            InfDepexItemIns.SetHelpString(HelpString)\r
\r
            self.Depex.append(InfDepexItemIns)\r
\r
        return True\r
\r
    def GetDepex(self):\r
        return self.Depex\r
\r
    def GetAllContent(self):\r
        return self.AllContent\r