BaseTools: Clean up source files

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

## @file\r
# This file is used to define class objects of INF file miscellaneous.\r
# Include BootMode/HOB/Event and others. 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
InfMisc\r
'''\r
\r
import Logger.Log as Logger\r
from Logger import ToolError\r
\r
from Library import DataType as DT\r
from Object.Parser.InfCommonObject import InfSectionCommonDef\r
from Library.Misc import Sdict\r
\r
##\r
# BootModeObject\r
#\r
class InfBootModeObject():\r
    def __init__(self):\r
        self.SupportedBootModes = ''\r
        self.HelpString = ''\r
        self.Usage = ''\r
\r
    def SetSupportedBootModes(self, SupportedBootModes):\r
        self.SupportedBootModes = SupportedBootModes\r
    def GetSupportedBootModes(self):\r
        return self.SupportedBootModes\r
\r
    def SetHelpString(self, HelpString):\r
        self.HelpString = HelpString\r
    def GetHelpString(self):\r
        return self.HelpString\r
\r
    def SetUsage(self, Usage):\r
        self.Usage = Usage\r
    def GetUsage(self):\r
        return self.Usage\r
##\r
# EventObject\r
#\r
class InfEventObject():\r
    def __init__(self):\r
        self.EventType = ''\r
        self.HelpString = ''\r
        self.Usage = ''\r
\r
    def SetEventType(self, EventType):\r
        self.EventType = EventType\r
\r
    def GetEventType(self):\r
        return self.EventType\r
\r
    def SetHelpString(self, HelpString):\r
        self.HelpString = HelpString\r
    def GetHelpString(self):\r
        return self.HelpString\r
\r
    def SetUsage(self, Usage):\r
        self.Usage = Usage\r
    def GetUsage(self):\r
        return self.Usage\r
##\r
# HobObject\r
#\r
class InfHobObject():\r
    def __init__(self):\r
        self.HobType = ''\r
        self.Usage = ''\r
        self.SupArchList = []\r
        self.HelpString = ''\r
\r
    def SetHobType(self, HobType):\r
        self.HobType = HobType\r
\r
    def GetHobType(self):\r
        return self.HobType\r
\r
    def SetUsage(self, Usage):\r
        self.Usage = Usage\r
    def GetUsage(self):\r
        return self.Usage\r
\r
    def SetSupArchList(self, ArchList):\r
        self.SupArchList = ArchList\r
    def GetSupArchList(self):\r
        return self.SupArchList\r
\r
    def SetHelpString(self, HelpString):\r
        self.HelpString = HelpString\r
    def GetHelpString(self):\r
        return self.HelpString\r
\r
##\r
# InfSpecialCommentObject\r
#\r
class InfSpecialCommentObject(InfSectionCommonDef):\r
    def __init__(self):\r
        self.SpecialComments = Sdict()\r
        InfSectionCommonDef.__init__(self)\r
\r
    def SetSpecialComments(self, SepcialSectionList = None, Type = ''):\r
        if Type == DT.TYPE_HOB_SECTION or \\r
           Type == DT.TYPE_EVENT_SECTION or \\r
           Type == DT.TYPE_BOOTMODE_SECTION:\r
            for Item in SepcialSectionList:\r
                if Type in self.SpecialComments:\r
                    ObjList = self.SpecialComments[Type]\r
                    ObjList.append(Item)\r
                    self.SpecialComments[Type] = ObjList\r
                else:\r
                    ObjList = []\r
                    ObjList.append(Item)\r
                    self.SpecialComments[Type] = ObjList\r
\r
        return True\r
\r
    def GetSpecialComments(self):\r
        return self.SpecialComments\r
\r
\r
\r
## ErrorInInf\r
#\r
# An encapsulate of Error for INF parser.\r
#\r
def ErrorInInf(Message=None, ErrorCode=None, LineInfo=None, RaiseError=True):\r
    if ErrorCode is None:\r
        ErrorCode = ToolError.FORMAT_INVALID\r
    if LineInfo is None:\r
        LineInfo = ['', -1, '']\r
    Logger.Error("InfParser",\r
                 ErrorCode,\r
                 Message=Message,\r
                 File=LineInfo[0],\r
                 Line=LineInfo[1],\r
                 ExtraData=LineInfo[2],\r
                 RaiseError=RaiseError)\r