edk2: Replace BSD License with BSD+Patent License

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

## @file\r
# process Version section generation\r
#\r
#  Copyright (c) 2007 - 2018, 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
from __future__ import absolute_import\r
from .Ffs import SectionSuffix\r
import Common.LongFilePathOs as os\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
from CommonDataClass.FdfClass import VerSectionClassObject\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.DataType import SUP_MODULE_SEC\r
\r
## generate version section\r
#\r
#\r
class VerSection (VerSectionClassObject):\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        VerSectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   Generate version section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  OutputPath  Where to place output file\r
    #   @param  ModuleName  Which module this section belongs to\r
    #   @param  SecNum      Index of section\r
    #   @param  KeyStringList  Filter for inputs of section generation\r
    #   @param  FfsInf      FfsInfStatement object that contains this section data\r
    #   @param  Dict        dictionary contains macro and its value\r
    #   @retval tuple       (Generated file name, section alignment)\r
    #\r
    def GenSection(self, OutputPath, ModuleName, SecNum, KeyStringList, FfsInf=None, Dict={}, IsMakefile = False):\r
        #\r
        # Prepare the parameter of GenSection\r
        #\r
        if FfsInf:\r
            self.Alignment = FfsInf.__ExtendMacro__(self.Alignment)\r
            self.BuildNum = FfsInf.__ExtendMacro__(self.BuildNum)\r
            self.StringData = FfsInf.__ExtendMacro__(self.StringData)\r
            self.FileName = FfsInf.__ExtendMacro__(self.FileName)\r
\r
        OutputFile = os.path.join(OutputPath,\r
                                  ModuleName + SUP_MODULE_SEC + SecNum + SectionSuffix.get('VERSION'))\r
        OutputFile = os.path.normpath(OutputFile)\r
\r
        # Get String Data\r
        StringData = ''\r
        if self.StringData:\r
            StringData = self.StringData\r
        elif self.FileName:\r
            FileNameStr = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
            FileNameStr = GenFdsGlobalVariable.MacroExtend(FileNameStr, Dict)\r
            FileObj = open(FileNameStr, 'r')\r
            StringData = FileObj.read()\r
            StringData = '"' + StringData + '"'\r
            FileObj.close()\r
        GenFdsGlobalVariable.GenerateSection(OutputFile, [], 'EFI_SECTION_VERSION',\r
                                             Ver=StringData, BuildNumber=self.BuildNum, IsMakefile=IsMakefile)\r
        OutputFileList = []\r
        OutputFileList.append(OutputFile)\r
        return OutputFileList, self.Alignment\r