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

[mirror_edk2.git] / BaseTools / Source / Python / GenFds / CapsuleData.py

## @file\r
# generate capsule\r
#\r
#  Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
#\r
#  This program and the accompanying materials\r
#  are licensed and made available under the terms and conditions of the BSD License\r
#  which accompanies this 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
##\r
# Import Modules\r
#\r
import Ffs\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
import StringIO\r
\r
## base class for capsule data\r
#\r
#\r
class CapsuleData:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    def __init__(self):\r
        pass\r
    \r
    ## generate capsule data\r
    #\r
    #   @param  self        The object pointer\r
    def GenCapsuleSubItem(self):\r
        pass\r
        \r
## FFS class for capsule data\r
#\r
#\r
class CapsuleFfs (CapsuleData):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self) :\r
        self.Ffs = None\r
        self.FvName = None\r
\r
    ## generate FFS capsule data\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      Generated file name\r
    #\r
    def GenCapsuleSubItem(self):\r
        FfsFile = self.Ffs.GenFfs()\r
        return FfsFile\r
\r
## FV class for capsule data\r
#\r
#\r
class CapsuleFv (CapsuleData):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self) :\r
        self.Ffs = None\r
        self.FvName = None\r
        self.CapsuleName = None\r
\r
    ## generate FV capsule data\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      Generated file name\r
    #\r
    def GenCapsuleSubItem(self):\r
        if self.FvName.find('.fv') == -1:\r
            if self.FvName.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
                FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName.upper())\r
                FdBuffer = StringIO.StringIO('')\r
                FvObj.CapsuleName = self.CapsuleName\r
                FvFile = FvObj.AddToBuffer(FdBuffer)\r
                FvObj.CapsuleName = None\r
                FdBuffer.close()\r
                return FvFile\r
        else:\r
            FvFile = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FvName)\r
            return FvFile\r
\r
## FD class for capsule data\r
#\r
#\r
class CapsuleFd (CapsuleData):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self) :\r
        self.Ffs = None\r
        self.FdName = None\r
        self.CapsuleName = None\r
\r
    ## generate FD capsule data\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      Generated file name\r
    #\r
    def GenCapsuleSubItem(self):\r
        if self.FdName.find('.fd') == -1:\r
            if self.FdName.upper() in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():\r
                FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict.get(self.FdName.upper())\r
                FdFile = FdObj.GenFd()\r
                return FdFile\r
        else:\r
            FdFile = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FdName)\r
            return FdFile\r
        \r
## AnyFile class for capsule data\r
#\r
#\r
class CapsuleAnyFile (CapsuleData):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self) :\r
        self.Ffs = None\r
        self.FileName = None\r
\r
    ## generate AnyFile capsule data\r
    #\r
    #   @param  self        The object pointer\r
    #   @retval string      Generated file name\r
    #\r
    def GenCapsuleSubItem(self):\r
        return self.FileName