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

## @file\r
# process UI section generation\r
#\r
#  Copyright (c) 2007 - 2014, 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 Section\r
from Ffs import Ffs\r
import subprocess\r
import Common.LongFilePathOs as os\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
from CommonDataClass.FdfClass import UiSectionClassObject\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
\r
## generate UI section\r
#\r
#\r
class UiSection (UiSectionClassObject):\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        UiSectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   Generate UI 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 = {}):\r
        #\r
        # Prepare the parameter of GenSection\r
        #\r
        if FfsInf != None:\r
            self.Alignment = FfsInf.__ExtendMacro__(self.Alignment)\r
            self.StringData = FfsInf.__ExtendMacro__(self.StringData)\r
            self.FileName = FfsInf.__ExtendMacro__(self.FileName)\r
\r
        OutputFile = os.path.join(OutputPath, ModuleName + 'SEC' + SecNum + Ffs.SectionSuffix.get('UI'))\r
\r
        if self.StringData != None :\r
            NameString = self.StringData\r
        elif self.FileName != None:\r
            FileNameStr = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
            FileNameStr = GenFdsGlobalVariable.MacroExtend(FileNameStr, Dict)\r
            FileObj = open(FileNameStr, 'r')\r
            NameString = FileObj.read()\r
            NameString = '\"' + NameString + "\""\r
            FileObj.close()\r
        else:\r
            NameString = ''\r
\r
        GenFdsGlobalVariable.GenerateSection(OutputFile, None, 'EFI_SECTION_USER_INTERFACE', Ui=NameString)\r
\r
        OutputFileList = []\r
        OutputFileList.append(OutputFile)\r
        return OutputFileList, self.Alignment\r
Commit	Line	Data
	1	## @file\r
	2	# process UI section generation\r
	3	#\r
	4	# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
	5	#\r
	6	# This program and the accompanying materials\r
	7	# are licensed and made available under the terms and conditions of the BSD License\r
	8	# which accompanies this distribution. The full text of the license may be found at\r
	9	# http://opensource.org/licenses/bsd-license.php\r
	10	#\r
	11	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	#\r
	14	\r
	15	##\r
	16	# Import Modules\r
	17	#\r
	18	import Section\r
	19	from Ffs import Ffs\r
	20	import subprocess\r
	21	import Common.LongFilePathOs as os\r
	22	from GenFdsGlobalVariable import GenFdsGlobalVariable\r
	23	from CommonDataClass.FdfClass import UiSectionClassObject\r
	24	from Common.LongFilePathSupport import OpenLongFilePath as open\r
	25	\r
	26	## generate UI section\r
	27	#\r
	28	#\r
	29	class UiSection (UiSectionClassObject):\r
	30	\r
	31	## The constructor\r
	32	#\r
	33	# @param self The object pointer\r
	34	#\r
	35	def __init__(self):\r
	36	UiSectionClassObject.__init__(self)\r
	37	\r
	38	## GenSection() method\r
	39	#\r
	40	# Generate UI section\r
	41	#\r
	42	# @param self The object pointer\r
	43	# @param OutputPath Where to place output file\r
	44	# @param ModuleName Which module this section belongs to\r
	45	# @param SecNum Index of section\r
	46	# @param KeyStringList Filter for inputs of section generation\r
	47	# @param FfsInf FfsInfStatement object that contains this section data\r
	48	# @param Dict dictionary contains macro and its value\r
	49	# @retval tuple (Generated file name, section alignment)\r
	50	#\r
	51	def GenSection(self, OutputPath, ModuleName, SecNum, KeyStringList, FfsInf = None, Dict = {}):\r
	52	#\r
	53	# Prepare the parameter of GenSection\r
	54	#\r
	55	if FfsInf != None:\r
	56	self.Alignment = FfsInf.__ExtendMacro__(self.Alignment)\r
	57	self.StringData = FfsInf.__ExtendMacro__(self.StringData)\r
	58	self.FileName = FfsInf.__ExtendMacro__(self.FileName)\r
	59	\r
	60	OutputFile = os.path.join(OutputPath, ModuleName + 'SEC' + SecNum + Ffs.SectionSuffix.get('UI'))\r
	61	\r
	62	if self.StringData != None :\r
	63	NameString = self.StringData\r
	64	elif self.FileName != None:\r
	65	FileNameStr = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FileName)\r
	66	FileNameStr = GenFdsGlobalVariable.MacroExtend(FileNameStr, Dict)\r
	67	FileObj = open(FileNameStr, 'r')\r
	68	NameString = FileObj.read()\r
	69	NameString = '\"' + NameString + "\""\r
	70	FileObj.close()\r
	71	else:\r
	72	NameString = ''\r
	73	\r
	74	GenFdsGlobalVariable.GenerateSection(OutputFile, None, 'EFI_SECTION_USER_INTERFACE', Ui=NameString)\r
	75	\r
	76	OutputFileList = []\r
	77	OutputFileList.append(OutputFile)\r
	78	return OutputFileList, self.Alignment\r