Sync BaseTools Branch (version r2271) to EDKII main trunk.

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

## @file\r
# This file is used to define common class objects for INF file. \r
# It will consumed by InfParser\r
#\r
# Copyright (c) 2011, 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
InfCommonObject\r
'''\r
\r
## InfLineCommentObject\r
#  \r
#  Comment Object for any line in the INF file \r
#   \r
#  #\r
#  # HeaderComment\r
#  #\r
#  Line # TailComment\r
#\r
class InfLineCommentObject():\r
    def __init__(self):\r
        self.HeaderComments = ''\r
        self.TailComments = ''\r
    \r
    def SetHeaderComments(self, HeaderComments):\r
        self.HeaderComments = HeaderComments\r
    \r
    def GetHeaderComments(self):\r
        return self.HeaderComments\r
    \r
    def SetTailComments(self, TailComments):\r
        self.TailComments = TailComments\r
\r
    def GetTailComments(self):\r
        return self.TailComments   \r
       \r
## CurrentLine\r
#    \r
class CurrentLine():\r
    def __init__(self):\r
        self.LineNo = ''\r
        self.LineString = ''\r
        self.FileName = ''\r
\r
    ## SetLineNo\r
    #     \r
    # @param LineNo: LineNo \r
    #     \r
    def SetLineNo(self, LineNo):\r
        self.LineNo = LineNo\r
        \r
    ## GetLineNo\r
    #         \r
    def GetLineNo(self):\r
        return self.LineNo\r
\r
    ## SetLineString\r
    #     \r
    # @param LineString: Line String content \r
    #     \r
    def SetLineString(self, LineString):\r
        self.LineString = LineString\r
        \r
    ## GetLineString\r
    #         \r
    def GetLineString(self):\r
        return self.LineString\r
\r
    ## SetFileName\r
    #     \r
    # @param FileName: File Name\r
    #       \r
    def SetFileName(self, FileName):\r
        self.FileName = FileName\r
        \r
    ## GetFileName\r
    #  \r
    def GetFileName(self):\r
        return self.FileName\r
    \r
## \r
# Inf Section common data\r
#\r
class InfSectionCommonDef():\r
    def __init__(self):\r
        #\r
        # # \r
        # # HeaderComments at here\r
        # #\r
        # [xxSection] TailComments at here\r
        # data\r
        #\r
        self.HeaderComments = ''\r
        self.TailComments   = ''\r
        #\r
        # The support arch list of this section\r
        #\r
        self.SupArchList  = []\r
        \r
        #\r
        # Store all section content\r
        # Key is supported Arch\r
        #\r
        self.AllContent   = {}\r
\r
    ## SetHeaderComments\r
    #     \r
    # @param HeaderComments: HeaderComments\r
    #        \r
    def SetHeaderComments(self, HeaderComments):\r
        self.HeaderComments = HeaderComments\r
\r
    ## GetHeaderComments\r
    #        \r
    def GetHeaderComments(self):\r
        return self.HeaderComments\r
\r
    ## SetTailComments\r
    #     \r
    # @param TailComments: TailComments\r
    #            \r
    def SetTailComments(self, TailComments):\r
        self.TailComments = TailComments\r
\r
    ## GetTailComments\r
    #   \r
    def GetTailComments(self):\r
        return self.TailComments\r
\r
    ## SetSupArchList\r
    #     \r
    # @param Arch: Arch\r
    #         \r
    def SetSupArchList(self, Arch):\r
        if Arch not in self.SupArchList:\r
            self.SupArchList.append(Arch)\r
\r
    ## GetSupArchList\r
    #      \r
    def GetSupArchList(self):\r
        return self.SupArchList\r
\r
    ## SetAllContent\r
    #     \r
    # @param ArchList: ArchList\r
    # @param Content: Content\r
    #     \r
    def SetAllContent(self, Content):\r
        self.AllContent = Content\r
        \r
    ## GetAllContent\r
    #     \r
    def GetAllContent(self):\r
        return self.AllContent\r