BaseTools: Clean up source files

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

## @file\r
# section base class\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 CommonDataClass.FdfClass import SectionClassObject\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
import Common.LongFilePathOs as os, glob\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
from Common.DataType import *\r
\r
## section base class\r
#\r
#\r
class Section (SectionClassObject):\r
    SectionType = {\r
        'RAW'       : 'EFI_SECTION_RAW',\r
        'FREEFORM'  : 'EFI_SECTION_FREEFORM_SUBTYPE_GUID',\r
        BINARY_FILE_TYPE_PE32      : 'EFI_SECTION_PE32',\r
        BINARY_FILE_TYPE_PIC       : 'EFI_SECTION_PIC',\r
        BINARY_FILE_TYPE_TE        : 'EFI_SECTION_TE',\r
        'FV_IMAGE'  : 'EFI_SECTION_FIRMWARE_VOLUME_IMAGE',\r
        BINARY_FILE_TYPE_DXE_DEPEX : 'EFI_SECTION_DXE_DEPEX',\r
        BINARY_FILE_TYPE_PEI_DEPEX : 'EFI_SECTION_PEI_DEPEX',\r
        'GUIDED'    : 'EFI_SECTION_GUID_DEFINED',\r
        'COMPRESS'  : 'EFI_SECTION_COMPRESSION',\r
        BINARY_FILE_TYPE_UI        : 'EFI_SECTION_USER_INTERFACE',\r
        BINARY_FILE_TYPE_SMM_DEPEX : 'EFI_SECTION_SMM_DEPEX'\r
    }\r
\r
    BinFileType = {\r
        BINARY_FILE_TYPE_GUID          : '.guid',\r
        'ACPI'          : '.acpi',\r
        'ASL'           : '.asl' ,\r
        BINARY_FILE_TYPE_UEFI_APP      : '.app',\r
        BINARY_FILE_TYPE_LIB           : '.lib',\r
        BINARY_FILE_TYPE_PE32          : '.pe32',\r
        BINARY_FILE_TYPE_PIC           : '.pic',\r
        BINARY_FILE_TYPE_PEI_DEPEX     : '.depex',\r
        'SEC_PEI_DEPEX' : '.depex',\r
        BINARY_FILE_TYPE_TE            : '.te',\r
        BINARY_FILE_TYPE_UNI_VER       : '.ver',\r
        BINARY_FILE_TYPE_VER           : '.ver',\r
        BINARY_FILE_TYPE_UNI_UI        : '.ui',\r
        BINARY_FILE_TYPE_UI            : '.ui',\r
        BINARY_FILE_TYPE_BIN           : '.bin',\r
        'RAW'           : '.raw',\r
        'COMPAT16'      : '.comp16',\r
        BINARY_FILE_TYPE_FV            : '.fv'\r
    }\r
\r
    SectFileType = {\r
        'SEC_GUID'      : '.sec' ,\r
        'SEC_PE32'      : '.sec' ,\r
        'SEC_PIC'       : '.sec',\r
        'SEC_TE'        : '.sec',\r
        'SEC_VER'       : '.sec',\r
        'SEC_UI'        : '.sec',\r
        'SEC_COMPAT16'  : '.sec',\r
        'SEC_BIN'       : '.sec'\r
    }\r
\r
    ToolGuid = {\r
        '0xa31280ad-0x481e-0x41b6-0x95e8-0x127f-0x4c984779' : 'TianoCompress',\r
        '0xee4e5898-0x3914-0x4259-0x9d6e-0xdc7b-0xd79403cf' : 'LzmaCompress'\r
    }\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   virtual function\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
    #\r
    def GenSection(self, OutputPath, GuidName, SecNum, keyStringList, FfsInf = None, Dict = {}):\r
        pass\r
\r
    ## GetFileList() method\r
    #\r
    #   Generate compressed section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  FfsInf      FfsInfStatement object that contains file list\r
    #   @param  FileType    File type to get\r
    #   @param  FileExtension  File extension to get\r
    #   @param  Dict        dictionary contains macro and its value\r
    #   @retval tuple       (File list, boolean)\r
    #\r
    def GetFileList(FfsInf, FileType, FileExtension, Dict = {}, IsMakefile=False):\r
        IsSect = FileType in Section.SectFileType\r
\r
        if FileExtension is not None:\r
            Suffix = FileExtension\r
        elif IsSect :\r
            Suffix = Section.SectionType.get(FileType)\r
        else:\r
            Suffix = Section.BinFileType.get(FileType)\r
        if FfsInf is None:\r
            EdkLogger.error("GenFds", GENFDS_ERROR, 'Inf File does not exist!')\r
\r
        FileList = []\r
        if FileType is not None:\r
            for File in FfsInf.BinFileList:\r
                if File.Arch == TAB_ARCH_COMMON or FfsInf.CurrentArch == File.Arch:\r
                    if File.Type == FileType or (int(FfsInf.PiSpecVersion, 16) >= 0x0001000A \\r
                                                 and FileType == 'DXE_DPEX' and File.Type == BINARY_FILE_TYPE_SMM_DEPEX) \\r
                                                 or (FileType == BINARY_FILE_TYPE_TE and File.Type == BINARY_FILE_TYPE_PE32):\r
                        if '*' in FfsInf.TargetOverrideList or File.Target == '*' or File.Target in FfsInf.TargetOverrideList or FfsInf.TargetOverrideList == []:\r
                            FileList.append(FfsInf.PatchEfiFile(File.Path, File.Type))\r
                        else:\r
                            GenFdsGlobalVariable.InfLogger ("\nBuild Target \'%s\' of File %s is not in the Scope of %s specified by INF %s in FDF" %(File.Target, File.File, FfsInf.TargetOverrideList, FfsInf.InfFileName))\r
                    else:\r
                        GenFdsGlobalVariable.VerboseLogger ("\nFile Type \'%s\' of File %s in %s is not same with file type \'%s\' from Rule in FDF" %(File.Type, File.File, FfsInf.InfFileName, FileType))\r
                else:\r
                    GenFdsGlobalVariable.InfLogger ("\nCurrent ARCH \'%s\' of File %s is not in the Support Arch Scope of %s specified by INF %s in FDF" %(FfsInf.CurrentArch, File.File, File.Arch, FfsInf.InfFileName))\r
\r
        if (not IsMakefile and Suffix is not None and os.path.exists(FfsInf.EfiOutputPath)) or (IsMakefile and Suffix is not None):\r
            #\r
            # Get Makefile path and time stamp\r
            #\r
            MakefileDir = FfsInf.EfiOutputPath[:-len('OUTPUT')]\r
            Makefile = os.path.join(MakefileDir, 'Makefile')\r
            if not os.path.exists(Makefile):\r
                Makefile = os.path.join(MakefileDir, 'GNUmakefile')\r
            if os.path.exists(Makefile):\r
                # Update to search files with suffix in all sub-dirs.\r
                Tuple = os.walk(FfsInf.EfiOutputPath)\r
                for Dirpath, Dirnames, Filenames in Tuple:\r
                    for F in Filenames:\r
                        if os.path.splitext(F)[1] == Suffix:\r
                            FullName = os.path.join(Dirpath, F)\r
                            if os.path.getmtime(FullName) > os.path.getmtime(Makefile):\r
                                FileList.append(FullName)\r
            if not FileList:\r
                SuffixMap = FfsInf.GetFinalTargetSuffixMap()\r
                if Suffix in SuffixMap:\r
                    FileList.extend(SuffixMap[Suffix])\r
\r
        #Process the file lists is alphabetical for a same section type\r
        if len (FileList) > 1:\r
            FileList.sort()\r
\r
        return FileList, IsSect\r
    GetFileList = staticmethod(GetFileList)\r