[mirror_edk2.git] / BaseTools / Source / Python / UPT / GenMetaFile / GenInfFile.py

## @file GenInfFile.py\r
#\r
# This file contained the logical of transfer package object to INF files.\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
GenInf\r
'''\r
from os import getenv\r
from Library.String import GetSplitValueList\r
from Library.Parsing import GenSection\r
from Library.Parsing import GetWorkspacePackage\r
from Library.Parsing import ConvertArchForInstall                     \r
from Library.Misc import SaveFileOnChange\r
from Library.Misc import IsAllModuleList\r
from Library.Misc import Sdict\r
from Library.Misc import ConvertPath\r
from Library.Misc import ConvertSpec\r
from Library.CommentGenerating import GenHeaderCommentSection\r
from Library.CommentGenerating import GenGenericCommentF\r
from Library.CommentGenerating import _GetHelpStr\r
from Library import GlobalData\r
from Logger import StringTable as ST\r
from Logger import ToolError\r
import Logger.Log as Logger\r
from Library import DataType as DT\r
from GenMetaFile import GenMetaFileMisc\r
\r
## Transfer Module Object to Inf files\r
#\r
# Transfer all contents of a standard Module Object to an Inf file \r
# @param ModuleObject: A Module Object  \r
#\r
def ModuleToInf(ModuleObject):\r
    if not GlobalData.gWSPKG_LIST:  \r
        GlobalData.gWSPKG_LIST = GetWorkspacePackage()\r
    \r
    #\r
    # Init global information for the file\r
    #\r
    ContainerFile = ModuleObject.GetFullPath()\r
    Content = ''\r
    #\r
    # generate header comment section\r
    #        \r
    Content += GenHeaderCommentSection(ModuleObject.GetAbstract(), \r
                                       ModuleObject.GetDescription(), \r
                                       ModuleObject.GetCopyright(), \r
                                       ModuleObject.GetLicense())\r
    \r
    #\r
    # Judge whether the INF file is an AsBuild INF.\r
    #\r
    if ModuleObject.BinaryModule:\r
        GlobalData.gIS_BINARY_INF = True\r
    else:\r
        GlobalData.gIS_BINARY_INF = False\r
    \r
    #\r
    # for each section, maintain a dict, sorted arch will be its key, \r
    # statement list will be its data\r
    # { 'Arch1 Arch2 Arch3': [statement1, statement2],\r
    #   'Arch1' : [statement1, statement3] \r
    #  }\r
    #\r
    \r
    #\r
    # Gen section contents\r
    #\r
    Content += GenDefines(ModuleObject)\r
    Content += GenBuildOptions(ModuleObject)\r
    Content += GenLibraryClasses(ModuleObject)\r
    Content += GenPackages(ModuleObject)\r
    Content += GenPcdSections(ModuleObject)\r
    Content += GenSources(ModuleObject)\r
    Content += GenProtocolPPiSections(ModuleObject.GetProtocolList(), True) \r
    Content += GenProtocolPPiSections(ModuleObject.GetPpiList(), False) \r
    Content += GenGuidSections(ModuleObject.GetGuidList())    \r
    Content += GenBinaries(ModuleObject)\r
    Content += GenDepex(ModuleObject)\r
    Content += GenUserExtensions(ModuleObject)        \r
\r
    if ModuleObject.GetEventList() or ModuleObject.GetBootModeList() or ModuleObject.GetHobList():\r
        Content += '\n\n'\r
    #\r
    # generate [Event], [BootMode], [Hob] section\r
    #\r
    Content += GenSpecialSections(ModuleObject.GetEventList(), 'Event')    \r
    Content += GenSpecialSections(ModuleObject.GetBootModeList(), 'BootMode')\r
    Content += GenSpecialSections(ModuleObject.GetHobList(), 'Hob')\r
\r
    SaveFileOnChange(ContainerFile, Content, False)\r
    return ContainerFile\r
\r
def GenDefines(ModuleObject):\r
    #\r
    # generate [Defines] section\r
    #\r
    Content = ''          \r
    NewSectionDict = {}     \r
    for UserExtension in ModuleObject.GetUserExtensionList():\r
        DefinesDict = UserExtension.GetDefinesDict()\r
        if not DefinesDict:\r
            continue\r
        \r
        for Statement in DefinesDict:\r
            SortedArch = DT.TAB_ARCH_COMMON\r
            if Statement.strip().startswith(DT.TAB_INF_DEFINES_CUSTOM_MAKEFILE):\r
                pos = Statement.find(DT.TAB_VALUE_SPLIT)\r
                if pos == -1:\r
                    pos = Statement.find(DT.TAB_EQUAL_SPLIT)\r
                Makefile = ConvertPath(Statement[pos + 1:].strip())\r
                Statement = Statement[:pos + 1] + ' ' + Makefile\r
            if SortedArch in NewSectionDict:\r
                NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [Statement]\r
            else:\r
                NewSectionDict[SortedArch] = [Statement]        \r
\r
    SpecialStatementList = []\r
    \r
    #\r
    # Add INF_VERSION statement firstly\r
    #\r
    Statement = 'INF_VERSION = 0x00010017'\r
    SpecialStatementList.append(Statement)\r
\r
    BaseName = ModuleObject.GetBaseName()\r
    if BaseName.startswith('.') or BaseName.startswith('-'):\r
        BaseName = '_' + BaseName\r
    Statement = '%s = %s' % (DT.TAB_INF_DEFINES_BASE_NAME, BaseName)\r
    SpecialStatementList.append(Statement)\r
    Statement = '%s = %s' % (DT.TAB_INF_DEFINES_FILE_GUID, ModuleObject.GetGuid())\r
    SpecialStatementList.append(Statement)\r
    Statement = '%s = %s' % (DT.TAB_INF_DEFINES_VERSION_STRING, ModuleObject.GetVersion())\r
    SpecialStatementList.append(Statement)\r
    \r
    if ModuleObject.GetModuleType():\r
        Statement = '%s = %s' % (DT.TAB_INF_DEFINES_MODULE_TYPE, ModuleObject.GetModuleType())\r
        SpecialStatementList.append(Statement)\r
    if ModuleObject.GetPcdIsDriver():\r
        Statement = '%s = %s' % (DT.TAB_INF_DEFINES_PCD_IS_DRIVER, ModuleObject.GetPcdIsDriver())\r
        SpecialStatementList.append(Statement)\r
    if ModuleObject.GetUefiSpecificationVersion():\r
        Statement = '%s = %s' % (DT.TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION, \\r
                                 ModuleObject.GetUefiSpecificationVersion())\r
        SpecialStatementList.append(Statement)\r
    if ModuleObject.GetPiSpecificationVersion():\r
        Statement = '%s = %s' % (DT.TAB_INF_DEFINES_PI_SPECIFICATION_VERSION, ModuleObject.GetPiSpecificationVersion())\r
        SpecialStatementList.append(Statement)        \r
    for LibraryClass in ModuleObject.GetLibraryClassList():\r
        if LibraryClass.GetUsage() == DT.USAGE_ITEM_PRODUCES or \\r
           LibraryClass.GetUsage() == DT.USAGE_ITEM_SOMETIMES_PRODUCES:\r
            Statement = '%s = %s' % (DT.TAB_INF_DEFINES_LIBRARY_CLASS, LibraryClass.GetLibraryClass())\r
            if LibraryClass.GetSupModuleList():\r
                Statement += '|' + DT.TAB_SPACE_SPLIT.join(l for l in LibraryClass.GetSupModuleList())\r
            SpecialStatementList.append(Statement)\r
    for SpecItem in ModuleObject.GetSpecList():\r
        Spec, Version = SpecItem\r
        Spec = ConvertSpec(Spec)\r
        Statement = '%s %s = %s' % (DT.TAB_INF_DEFINES_SPEC, Spec, Version)\r
        SpecialStatementList.append(Statement)\r
        \r
    ExternList = []\r
    for Extern in ModuleObject.GetExternList():\r
        ArchList = Extern.GetSupArchList()\r
        EntryPoint = Extern.GetEntryPoint()\r
        UnloadImage = Extern.GetUnloadImage()\r
        Constructor = Extern.GetConstructor()\r
        Destructor = Extern.GetDestructor()\r
        HelpStringList = Extern.GetHelpTextList()\r
        FFE = Extern.GetFeatureFlag()\r
        ExternList.append([ArchList, EntryPoint, UnloadImage, Constructor, Destructor, FFE, HelpStringList])\r
    \r
    #\r
    # Add VALID_ARCHITECTURES information\r
    #\r
    ValidArchStatement = None\r
    if ModuleObject.SupArchList:\r
        ValidArchStatement = '# ' + '\n'\r
        ValidArchStatement += '# The following information is for reference only and not required by the build tools.\n'\r
        ValidArchStatement += '# ' + '\n'\r
        ValidArchStatement += '# VALID_ARCHITECTURES = %s' % (' '.join(ModuleObject.SupArchList)) + '\n'\r
        ValidArchStatement += '# ' + '\n'\r
        \r
    if DT.TAB_ARCH_COMMON not in NewSectionDict:\r
        NewSectionDict[DT.TAB_ARCH_COMMON] = []\r
    NewSectionDict[DT.TAB_ARCH_COMMON] = NewSectionDict[DT.TAB_ARCH_COMMON] + SpecialStatementList\r
    GenMetaFileMisc.AddExternToDefineSec(NewSectionDict, DT.TAB_ARCH_COMMON, ExternList)\r
    if ValidArchStatement is not None:\r
        NewSectionDict[DT.TAB_ARCH_COMMON] = NewSectionDict[DT.TAB_ARCH_COMMON] + [ValidArchStatement]\r
        \r
    Content += GenSection('Defines', NewSectionDict)\r
    \r
    return Content\r
\r
def GenLibraryClasses(ModuleObject):\r
    #\r
    # generate [LibraryClasses] section\r
    #\r
    Content = ''\r
    NewSectionDict = {}\r
    if not GlobalData.gIS_BINARY_INF:\r
        for LibraryClass in ModuleObject.GetLibraryClassList():\r
            if LibraryClass.GetUsage() == DT.USAGE_ITEM_PRODUCES:\r
                continue\r
            #\r
            # Generate generic comment\r
            #\r
            HelpTextList = LibraryClass.GetHelpTextList()\r
            HelpStr = _GetHelpStr(HelpTextList)\r
            CommentStr = GenGenericCommentF(HelpStr)\r
            Statement = CommentStr\r
            Name = LibraryClass.GetLibraryClass()\r
            FFE = LibraryClass.GetFeatureFlag()\r
            Statement += Name\r
            if FFE:\r
                Statement += '|' + FFE \r
            ModuleList = LibraryClass.GetSupModuleList()\r
            ArchList = LibraryClass.GetSupArchList()\r
            for Index in xrange(0, len(ArchList)):\r
                ArchList[Index] = ConvertArchForInstall(ArchList[Index])\r
            ArchList.sort()\r
            SortedArch = ' '.join(ArchList)\r
            \r
            KeyList = []\r
            if not ModuleList or IsAllModuleList(ModuleList):\r
                KeyList = [SortedArch]        \r
            else:\r
                ModuleString = DT.TAB_VALUE_SPLIT.join(l for l in ModuleList)\r
                if not ArchList:\r
                    SortedArch = DT.TAB_ARCH_COMMON\r
                    KeyList = [SortedArch + '.' + ModuleString]\r
                else:\r
                    KeyList = [Arch + '.' + ModuleString for Arch in ArchList]\r
                                \r
            for Key in KeyList:\r
                if Key in NewSectionDict:\r
                    NewSectionDict[Key] = NewSectionDict[Key] + [Statement]\r
                else:\r
                    NewSectionDict[Key] = [Statement]\r
        Content += GenSection('LibraryClasses', NewSectionDict)\r
    else:\r
        LibraryClassDict = {}\r
        for BinaryFile in ModuleObject.GetBinaryFileList():\r
            if not BinaryFile.AsBuiltList:\r
                continue\r
            for LibraryItem in BinaryFile.AsBuiltList[0].LibraryInstancesList:\r
                Statement = '# Guid: ' +  LibraryItem.Guid + ' Version: ' + LibraryItem.Version\r
                if len(BinaryFile.SupArchList) == 0:\r
                    if LibraryClassDict.has_key('COMMON'):\r
                        LibraryClassDict['COMMON'].append(Statement)\r
                    else:\r
                        LibraryClassDict['COMMON'] = ['## @LIB_INSTANCES']\r
                        LibraryClassDict['COMMON'].append(Statement)\r
                else:\r
                    for Arch in BinaryFile.SupArchList:\r
                        if LibraryClassDict.has_key(Arch):\r
                            LibraryClassDict[Arch].append(Statement)\r
                        else:\r
                            LibraryClassDict[Arch] = ['## @LIB_INSTANCES']\r
                            LibraryClassDict[Arch].append(Statement)\r
                    \r
        Content += GenSection('LibraryClasses', LibraryClassDict)\r
    \r
    return Content\r
\r
def GenPackages(ModuleObject):\r
    Content = ''\r
    #\r
    # generate [Packages] section\r
    #\r
    NewSectionDict = Sdict()\r
    WorkspaceDir = getenv('WORKSPACE')\r
    for PackageDependency in ModuleObject.GetPackageDependencyList():\r
        #\r
        # Generate generic comment\r
        #\r
        CommentStr = ''\r
        HelpText = PackageDependency.GetHelpText()\r
        if HelpText:\r
            HelpStr = HelpText.GetString()\r
            CommentStr = GenGenericCommentF(HelpStr)   \r
        Statement = CommentStr\r
        Guid = PackageDependency.GetGuid()\r
        Version = PackageDependency.GetVersion()\r
        FFE = PackageDependency.GetFeatureFlag()\r
        #\r
        # find package path/name\r
        # \r
        for PkgInfo in GlobalData.gWSPKG_LIST:\r
            if Guid == PkgInfo[1]:\r
                if (not Version) or (Version == PkgInfo[2]):\r
                    Path = PkgInfo[3]\r
                    break\r
        #\r
        # get relative path\r
        #\r
        RelaPath = Path[Path.upper().find(WorkspaceDir.upper()) + len(WorkspaceDir) + 1:]\r
        Statement += RelaPath.replace('\\', '/')\r
        if FFE:\r
            Statement += '|' + FFE        \r
        ArchList = PackageDependency.GetSupArchList()\r
        ArchList.sort()\r
        SortedArch = ' '.join(ArchList)\r
        if SortedArch in NewSectionDict:\r
            NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [Statement]\r
        else:\r
            NewSectionDict[SortedArch] = [Statement]            \r
\r
    Content += GenSection('Packages', NewSectionDict)\r
    \r
    return Content\r
\r
def GenSources(ModuleObject):\r
    #\r
    # generate [Sources] section\r
    #\r
    Content = ''\r
    NewSectionDict = {}\r
    \r
    for Source in ModuleObject.GetSourceFileList():    \r
        SourceFile = Source.GetSourceFile()\r
        Family = Source.GetFamily()\r
        FeatureFlag = Source.GetFeatureFlag()\r
        SupArchList = Source.GetSupArchList()\r
        SupArchList.sort()\r
        SortedArch = ' '.join(SupArchList)    \r
\r
        Statement = GenSourceStatement(ConvertPath(SourceFile), Family, FeatureFlag)\r
        if SortedArch in NewSectionDict:\r
            NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [Statement]\r
        else:\r
            NewSectionDict[SortedArch] = [Statement]\r
\r
    Content += GenSection('Sources', NewSectionDict)\r
    \r
    return Content\r
\r
def GenDepex(ModuleObject):\r
    #\r
    # generate [Depex] section\r
    #\r
    NewSectionDict = Sdict()\r
    Content = ''\r
    for Depex in ModuleObject.GetPeiDepex() + ModuleObject.GetDxeDepex() + ModuleObject.GetSmmDepex():\r
        HelpTextList = Depex.GetHelpTextList()\r
        HelpStr = _GetHelpStr(HelpTextList)\r
        CommentStr = GenGenericCommentF(HelpStr)\r
        SupArchList = Depex.GetSupArchList()\r
        SupModList = Depex.GetModuleType()\r
        Expression = Depex.GetDepex()\r
        Statement = CommentStr + Expression\r
        \r
        SupArchList.sort()\r
        KeyList = []\r
        if not SupArchList:\r
            SupArchList.append(DT.TAB_ARCH_COMMON.lower())\r
        if not SupModList:\r
            KeyList = SupArchList\r
        else:\r
            for ModuleType in SupModList:\r
                for Arch in SupArchList:\r
                    KeyList.append(ConvertArchForInstall(Arch) + '.' + ModuleType)\r
                            \r
        for Key in KeyList:\r
            if Key in NewSectionDict:\r
                NewSectionDict[Key] = NewSectionDict[Key] + [Statement]\r
            else:\r
                NewSectionDict[Key] = [Statement]\r
        \r
    Content += GenSection('Depex', NewSectionDict, False)\r
    \r
    return Content\r
\r
## GenUserExtensions\r
#\r
# GenUserExtensions\r
#\r
def GenUserExtensions(ModuleObject):\r
    NewSectionDict = {}\r
    for UserExtension in ModuleObject.GetUserExtensionList():\r
        if UserExtension.GetIdentifier() == 'Depex':\r
            continue\r
        Statement = UserExtension.GetStatement()\r
        if not Statement:\r
            continue\r
        \r
        ArchList = UserExtension.GetSupArchList()\r
        for Index in xrange(0, len(ArchList)):\r
            ArchList[Index] = ConvertArchForInstall(ArchList[Index])\r
        ArchList.sort()\r
                \r
        KeyList = []\r
        CommonPreFix = ''\r
        if UserExtension.GetUserID():\r
            CommonPreFix = UserExtension.GetUserID()\r
            if CommonPreFix.find('.') > -1:\r
                CommonPreFix = '"' + CommonPreFix + '"'\r
            if UserExtension.GetIdentifier():\r
                CommonPreFix += '.' + '"' + UserExtension.GetIdentifier() + '"'\r
            if ArchList:\r
                KeyList = [CommonPreFix + '.' + Arch for Arch in ArchList]\r
            else:\r
                KeyList = [CommonPreFix]    \r
        \r
        for Key in KeyList:\r
            if Key in NewSectionDict:\r
                NewSectionDict[Key] = NewSectionDict[Key] + [Statement]\r
            else:\r
                NewSectionDict[Key] = [Statement]\r
    Content = GenSection('UserExtensions', NewSectionDict, False)\r
    \r
    return Content\r
    \r
# GenSourceStatement\r
#\r
#  @param SourceFile: string of source file path/name\r
#  @param Family:     string of source file family field\r
#  @param FeatureFlag:  string of source file FeatureFlag field\r
#  @param TagName:  string of source file TagName field\r
#  @param ToolCode:  string of source file ToolCode field\r
#  @param HelpStr:  string of source file HelpStr field\r
#\r
#  @retval Statement: The generated statement for source\r
#\r
def GenSourceStatement(SourceFile, Family, FeatureFlag, TagName=None, \r
                       ToolCode=None, HelpStr=None):\r
    Statement = ''\r
    if HelpStr:\r
        Statement += GenGenericCommentF(HelpStr)   \r
    #\r
    # format of SourceFile|Family|TagName|ToolCode|FeatureFlag\r
    #\r
    Statement += SourceFile\r
    \r
    if TagName == None:\r
        TagName = ''\r
    if ToolCode == None:\r
        ToolCode = ''\r
    if HelpStr == None:\r
        HelpStr = ''\r
    \r
    if FeatureFlag:\r
        Statement += '|' + Family + '|' + TagName + '|' + ToolCode + '|' + FeatureFlag\r
    elif ToolCode:\r
        Statement += '|' + Family + '|' + TagName + '|' + ToolCode\r
    elif TagName:\r
        Statement += '|' + Family + '|' + TagName\r
    elif Family:\r
        Statement += '|' + Family\r
    \r
    return Statement\r
\r
# GenBinaryStatement\r
#\r
#  @param Key:       (FileName, FileType, FFE, SortedArch)\r
#  @param Value:     (Target, Family, TagName, Comment)\r
#\r
#\r
def GenBinaryStatement(Key, Value):\r
    (FileName, FileType, FFE, SortedArch) = Key\r
    if SortedArch:\r
        pass\r
    if Value:\r
        (Target, Family, TagName, Comment) = Value\r
    else:\r
        Target = ''\r
        Family = ''\r
        TagName = ''\r
        Comment = ''\r
    \r
    if Comment:\r
        Statement = GenGenericCommentF(Comment)\r
    else:\r
        Statement = ''\r
    \r
    Statement += FileType + '|' + FileName\r
\r
    if FileType in DT.BINARY_FILE_TYPE_UI_LIST + DT.BINARY_FILE_TYPE_VER_LIST:\r
        if FFE:\r
            Statement += '|' + Target + '|' + FFE\r
        elif Target:\r
            Statement += '|' + Target\r
    else:\r
        if FFE:\r
            Statement += '|' + Target + '|' + Family + '|' + TagName + '|' + FFE\r
        elif TagName:\r
            Statement += '|' + Target + '|' + Family + '|' + TagName\r
        elif Family:\r
            Statement += '|' + Target + '|' + Family\r
        elif Target:\r
            Statement += '|' + Target\r
\r
    return Statement\r
\r
## GenGuidSections\r
# \r
#  @param GuidObjList: List of GuidObject\r
#  @retVal Content: The generated section contents\r
#\r
def GenGuidSections(GuidObjList):\r
    #\r
    # generate [Guids] section\r
    #\r
    Content = '' \r
    GuidDict = Sdict()\r
\r
    for Guid in GuidObjList:\r
        HelpTextList = Guid.GetHelpTextList()\r
        HelpStr = _GetHelpStr(HelpTextList)\r
\r
        CName = Guid.GetCName()\r
        FFE = Guid.GetFeatureFlag()\r
        Statement = CName\r
        if FFE:\r
            Statement += '|' + FFE\r
        \r
        Usage = Guid.GetUsage()\r
        GuidType = Guid.GetGuidTypeList()[0]\r
        VariableName = Guid.GetVariableName()\r
        \r
        #\r
        # we need to differentiate the generic comment and usage comment\r
        # as multiple generic comment need to be put at first\r
        #\r
        if Usage == DT.ITEM_UNDEFINED and GuidType == DT.ITEM_UNDEFINED:\r
            # generate list of generic comment\r
            Comment = GenGenericCommentF(HelpStr)\r
        else:\r
            # generate list of other comment\r
            Comment = HelpStr.replace('\n', ' ')\r
            Comment = Comment.strip()\r
            if Comment:\r
                Comment = ' # ' + Comment\r
            else:\r
                Comment = ''\r
            \r
            if Usage != DT.ITEM_UNDEFINED and GuidType == DT.ITEM_UNDEFINED:\r
                Comment = '## ' + Usage + Comment\r
            elif GuidType == 'Variable':\r
                Comment = '## ' + Usage + ' ## ' + GuidType + ':' + VariableName + Comment\r
            else:\r
                Comment = '## ' + Usage + ' ## ' + GuidType + Comment\r
            \r
            if Comment:\r
                Comment += '\n'\r
        \r
        #\r
        # merge duplicate items\r
        #\r
        ArchList = Guid.GetSupArchList()\r
        ArchList.sort()\r
        SortedArch = ' '.join(ArchList)\r
        if (Statement, SortedArch) in GuidDict:\r
            PreviousComment = GuidDict[Statement, SortedArch]\r
            Comment = PreviousComment +  Comment     \r
        GuidDict[Statement, SortedArch] = Comment\r
\r
    \r
    NewSectionDict = GenMetaFileMisc.TransferDict(GuidDict) \r
\r
    #\r
    # generate the section contents\r
    #\r
    if NewSectionDict:\r
        Content = GenSection('Guids', NewSectionDict)\r
    \r
    return Content\r
\r
## GenProtocolPPiSections\r
# \r
#  @param ObjList: List of ProtocolObject or Ppi Object\r
#  @retVal Content: The generated section contents\r
#\r
def GenProtocolPPiSections(ObjList, IsProtocol):\r
    Content = ''\r
    Dict = Sdict()\r
    for Object in ObjList:\r
        HelpTextList = Object.GetHelpTextList()\r
        HelpStr = _GetHelpStr(HelpTextList)\r
\r
        CName = Object.GetCName()\r
        FFE = Object.GetFeatureFlag()\r
        Statement = CName\r
        if FFE:\r
            Statement += '|' + FFE\r
        \r
        Usage = Object.GetUsage()\r
        Notify = Object.GetNotify()\r
        \r
        #\r
        # we need to differentiate the generic comment and usage comment\r
        # as consecutive generic comment need to be put together\r
        #\r
        if Usage == DT.ITEM_UNDEFINED and Notify == '':\r
            # generate list of generic comment\r
            Comment = GenGenericCommentF(HelpStr)\r
        else:\r
            # generate list of other comment\r
            Comment = HelpStr.replace('\n', ' ')\r
            Comment = Comment.strip()\r
            if Comment:\r
                Comment = ' # ' + Comment\r
            else:\r
                Comment = ''\r
            \r
            if Usage == DT.ITEM_UNDEFINED and not Comment and Notify == '':\r
                Comment = ''\r
            else:\r
                if Notify:\r
                    Comment = '## ' + Usage + ' ## ' + 'NOTIFY' + Comment\r
                else:\r
                    Comment = '## ' + Usage + Comment\r
           \r
            if Comment:\r
                Comment += '\n'\r
        \r
        #\r
        # merge duplicate items\r
        #\r
        ArchList = Object.GetSupArchList()\r
        ArchList.sort()\r
        SortedArch = ' '.join(ArchList)\r
        if (Statement, SortedArch) in Dict:\r
            PreviousComment = Dict[Statement, SortedArch]\r
            Comment = PreviousComment + Comment\r
        Dict[Statement, SortedArch] = Comment\r
    \r
    NewSectionDict = GenMetaFileMisc.TransferDict(Dict)         \r
\r
    #\r
    # generate the section contents\r
    #\r
    if NewSectionDict:\r
        if IsProtocol:\r
            Content = GenSection('Protocols', NewSectionDict)\r
        else:\r
            Content = GenSection('Ppis', NewSectionDict)\r
    \r
    return Content\r
\r
## GenPcdSections\r
#\r
#\r
def GenPcdSections(ModuleObject):\r
    Content = ''\r
    if not GlobalData.gIS_BINARY_INF:\r
        #\r
        # for each Pcd Itemtype, maintain a dict so the same type will be grouped \r
        # together\r
        #\r
        ItemTypeDict = {}\r
        for Pcd in ModuleObject.GetPcdList():\r
            HelpTextList = Pcd.GetHelpTextList()\r
            HelpStr = _GetHelpStr(HelpTextList)\r
    \r
            Statement = ''\r
            CName = Pcd.GetCName()\r
            TokenSpaceGuidCName = Pcd.GetTokenSpaceGuidCName()\r
            DefaultValue = Pcd.GetDefaultValue()\r
            ItemType = Pcd.GetItemType()\r
            if ItemType in ItemTypeDict:\r
                Dict = ItemTypeDict[ItemType]\r
            else:\r
                Dict = Sdict()\r
                ItemTypeDict[ItemType] = Dict\r
                \r
            FFE = Pcd.GetFeatureFlag()\r
            Statement += TokenSpaceGuidCName + '.' + CName\r
            if DefaultValue:\r
                Statement += '|' + DefaultValue\r
                if FFE:\r
                    Statement += '|' + FFE\r
            elif FFE:\r
                Statement += '||' + FFE\r
    \r
            #\r
            # Generate comment\r
            #\r
            Usage = Pcd.GetValidUsage()\r
            \r
            #\r
            # if FeatureFlag Pcd, then assume all Usage is CONSUMES\r
            #\r
            if ItemType == DT.TAB_INF_FEATURE_PCD:\r
                Usage = DT.USAGE_ITEM_CONSUMES\r
            if Usage == DT.ITEM_UNDEFINED or (ItemType == DT.TAB_INF_FEATURE_PCD):\r
                # generate list of generic comment\r
                Comment = GenGenericCommentF(HelpStr)\r
            else:\r
                # generate list of other comment\r
                Comment = HelpStr.replace('\n', ' ')\r
                Comment = Comment.strip()\r
                if Comment:\r
                    Comment = ' # ' + Comment\r
                else:\r
                    Comment = ''\r
    \r
                Comment = '## ' + Usage + Comment\r
               \r
                if Comment:\r
                    Comment += '\n'\r
        \r
            #\r
            # Merge duplicate entries\r
            #\r
            ArchList = Pcd.GetSupArchList()\r
            ArchList.sort()\r
            SortedArch = ' '.join(ArchList)\r
            if (Statement, SortedArch) in Dict:\r
                PreviousComment = Dict[Statement, SortedArch]\r
                Comment = PreviousComment + Comment\r
            Dict[Statement, SortedArch] = Comment             \r
                 \r
        for ItemType in ItemTypeDict:\r
            #\r
            # First we need to transfer the Dict to use SortedArch as key\r
            #\r
            Dict = ItemTypeDict[ItemType]\r
            NewSectionDict = GenMetaFileMisc.TransferDict(Dict)   \r
            \r
            if NewSectionDict:\r
                Content += GenSection(ItemType, NewSectionDict)\r
    #\r
    # For AsBuild INF files   \r
    #\r
    else:\r
        Content += GenAsBuiltPacthPcdSections(ModuleObject)\r
        Content += GenAsBuiltPcdExSections(ModuleObject)\r
    \r
    return Content\r
\r
## GenPcdSections\r
#\r
#\r
def GenAsBuiltPacthPcdSections(ModuleObject):\r
    PatchPcdDict = {}\r
    for BinaryFile in ModuleObject.GetBinaryFileList():\r
        if not BinaryFile.AsBuiltList:\r
            continue            \r
        for PatchPcd in BinaryFile.AsBuiltList[0].PatchPcdList:      \r
            TokenSpaceName = ''\r
            PcdCName = PatchPcd.CName\r
            PcdValue = PatchPcd.DefaultValue\r
            PcdOffset = PatchPcd.Offset\r
            TokenSpaceGuidValue = PatchPcd.TokenSpaceGuidValue\r
            Token = PatchPcd.Token\r
            HelpTextList = PatchPcd.HelpTextList\r
            HelpString = ''\r
            for HelpStringItem in HelpTextList:\r
                for HelpLine in GetSplitValueList(HelpStringItem.String, '\n'):\r
                    HelpString += '# ' + HelpLine + '\n'\r
                    \r
            TokenSpaceName, PcdCName = GenMetaFileMisc.ObtainPcdName(ModuleObject.PackageDependencyList, \r
                                                                     TokenSpaceGuidValue, \r
                                                                     Token)\r
            if TokenSpaceName == '' or PcdCName == '':    \r
                Logger.Error("Upt", \r
                             ToolError.RESOURCE_NOT_AVAILABLE,\r
                             ST.ERR_INSTALL_FILE_DEC_FILE_ERROR%(TokenSpaceGuidValue, Token), \r
                             File=ModuleObject.GetFullPath())                 \r
            Statement = HelpString[:-3] + TokenSpaceName + '.' + PcdCName + ' | ' + PcdValue + ' | ' + PcdOffset\r
            \r
            if len(BinaryFile.SupArchList) == 0:\r
                if PatchPcdDict.has_key('COMMON'):\r
                    PatchPcdDict['COMMON'].append(Statement)\r
                else:\r
                    PatchPcdDict['COMMON'] = [Statement]\r
            else:\r
                for Arch in BinaryFile.SupArchList:\r
                    if PatchPcdDict.has_key(Arch):\r
                        PatchPcdDict[Arch].append(Statement)\r
                    else:\r
                        PatchPcdDict[Arch] = [Statement]\r
    return GenSection('PatchPcd', PatchPcdDict)\r
\r
## GenPcdSections\r
#\r
#\r
def GenAsBuiltPcdExSections(ModuleObject):\r
    PcdExDict = {}\r
    for BinaryFile in ModuleObject.GetBinaryFileList():\r
        if not BinaryFile.AsBuiltList:\r
            continue   \r
        for PcdExItem in BinaryFile.AsBuiltList[0].PcdExValueList:\r
            TokenSpaceName = ''\r
            PcdCName = PcdExItem.CName\r
            PcdValue = PcdExItem.DefaultValue\r
            TokenSpaceGuidValue = PcdExItem.TokenSpaceGuidValue\r
            Token = PcdExItem.Token\r
            HelpTextList = PcdExItem.HelpTextList\r
            HelpString = ''\r
            for HelpStringItem in HelpTextList:\r
                for HelpLine in GetSplitValueList(HelpStringItem.String, '\n'):\r
                    HelpString += '# ' + HelpLine + '\n'            \r
            TokenSpaceName, PcdCName = GenMetaFileMisc.ObtainPcdName(ModuleObject.PackageDependencyList, \r
                                                                     TokenSpaceGuidValue, Token)\r
            \r
            if TokenSpaceName == '' or PcdCName == '':    \r
                Logger.Error("Upt",\r
                             ToolError.RESOURCE_NOT_AVAILABLE,\r
                             ST.ERR_INSTALL_FILE_DEC_FILE_ERROR%(TokenSpaceGuidValue, Token), \r
                             File=ModuleObject.GetFullPath()) \r
                                      \r
            Statement = HelpString[:-3] + TokenSpaceName + '.' + PcdCName + ' | ' + PcdValue\r
            \r
            if len(BinaryFile.SupArchList) == 0:\r
                if PcdExDict.has_key('COMMON'):\r
                    PcdExDict['COMMON'].append(Statement)\r
                else:\r
                    PcdExDict['COMMON'] = [Statement]\r
            else:\r
                for Arch in BinaryFile.SupArchList:\r
                    if PcdExDict.has_key(Arch):\r
                        PcdExDict[Arch].append(Statement)\r
                    else:\r
                        PcdExDict[Arch] = [Statement]\r
    return GenSection('PcdEx', PcdExDict)\r
               \r
## GenSpecialSections\r
#  generate special sections for Event/BootMode/Hob\r
#\r
def GenSpecialSections(ObjectList, SectionName):\r
    #\r
    # generate section\r
    #\r
    Content = ''\r
    NewSectionDict = {}\r
    for Obj in ObjectList:\r
        #\r
        # Generate comment\r
        #\r
        CommentStr = ''\r
        HelpTextList = Obj.GetHelpTextList()\r
        HelpStr = _GetHelpStr(HelpTextList)\r
        CommentStr = GenGenericCommentF(HelpStr)\r
        \r
        if SectionName == 'Hob':\r
            Type = Obj.GetHobType()\r
        elif SectionName == 'Event':\r
            Type = Obj.GetEventType()\r
        elif SectionName == 'BootMode':\r
            Type = Obj.GetSupportedBootModes()\r
        else:\r
            assert(SectionName)\r
        \r
        Usage = Obj.GetUsage()\r
        Statement = ' ' + Type + ' ## ' + Usage\r
        \r
        if CommentStr in ['#\n', '#\n#\n']:\r
            CommentStr = '#\n#\n#\n'\r
        #\r
        # the first head comment line should start with '##\n', \r
        # if it starts with '#\n', then add one '#'\r
        # else add '##\n' to meet the format defined in INF spec\r
        #\r
        if CommentStr.startswith('#\n'):\r
            CommentStr = '#' + CommentStr\r
        elif CommentStr:\r
            CommentStr = '##\n' + CommentStr\r
\r
        if CommentStr and not CommentStr.endswith('\n#\n'):\r
            CommentStr = CommentStr + '#\n' \r
        \r
        NewStateMent = CommentStr + Statement\r
        SupArch = Obj.GetSupArchList()\r
        SupArch.sort()\r
        SortedArch = ' '.join(SupArch)\r
        if SortedArch in NewSectionDict:\r
            NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [NewStateMent]\r
        else:\r
            NewSectionDict[SortedArch] = [NewStateMent]\r
    \r
    SectionContent = GenSection(SectionName, NewSectionDict)\r
    SectionContent = SectionContent.strip()\r
    if SectionContent:\r
        Content = '# ' + ('\n' + '# ').join(GetSplitValueList(SectionContent, '\n'))\r
        Content = Content.lstrip()\r
    #\r
    # add two empty line after the generated section content to differentiate \r
    # it between other possible sections\r
    #\r
    if Content: \r
        Content += '\n#\n#\n'\r
    return Content\r
\r
## GenBuildOptions\r
#\r
#\r
def GenBuildOptions(ModuleObject):\r
    Content = ''\r
    if not ModuleObject.BinaryModule:\r
        #\r
        # generate [BuildOptions] section\r
        #\r
        NewSectionDict = {}\r
        for UserExtension in ModuleObject.GetUserExtensionList():\r
            BuildOptionDict = UserExtension.GetBuildOptionDict()\r
            if not BuildOptionDict:\r
                continue\r
            for Arch in BuildOptionDict:\r
                if Arch in NewSectionDict:\r
                    NewSectionDict[Arch] = NewSectionDict[Arch] + [BuildOptionDict[Arch]]\r
                else:\r
                    NewSectionDict[Arch] = [BuildOptionDict[Arch]]\r
    \r
        Content = GenSection('BuildOptions', NewSectionDict)\r
    else:\r
        BuildOptionDict = {}\r
        for BinaryFile in ModuleObject.GetBinaryFileList():\r
            if not BinaryFile.AsBuiltList:\r
                continue\r
            for BuilOptionItem in BinaryFile.AsBuiltList[0].BinaryBuildFlagList:\r
                Statement = '#' +  BuilOptionItem.AsBuiltOptionFlags\r
                if len(BinaryFile.SupArchList) == 0:\r
                    if BuildOptionDict.has_key('COMMON'):\r
                        if Statement not in BuildOptionDict['COMMON']:\r
                            BuildOptionDict['COMMON'].append(Statement)\r
                    else:\r
                        BuildOptionDict['COMMON'] = ['## @AsBuilt']\r
                        BuildOptionDict['COMMON'].append(Statement)\r
                else:\r
                    for Arch in BinaryFile.SupArchList:\r
                        if BuildOptionDict.has_key(Arch):\r
                            if Statement not in BuildOptionDict[Arch]:\r
                                BuildOptionDict[Arch].append(Statement)\r
                        else:\r
                            BuildOptionDict[Arch] = ['## @AsBuilt']\r
                            BuildOptionDict[Arch].append(Statement)\r
                    \r
        Content = GenSection('BuildOptions', BuildOptionDict)\r
    \r
    return Content\r
\r
## GenBinaries\r
#\r
#\r
def GenBinaries(ModuleObject):\r
    NewSectionDict = {}\r
    BinariesDict = []\r
    for UserExtension in ModuleObject.GetUserExtensionList():\r
        BinariesDict = UserExtension.GetBinariesDict()\r
        if BinariesDict:\r
            break\r
        \r
    for BinaryFile in ModuleObject.GetBinaryFileList():\r
        FileNameObjList = BinaryFile.GetFileNameList()\r
        for FileNameObj in FileNameObjList:\r
            FileName = ConvertPath(FileNameObj.GetFilename())\r
            FileType = FileNameObj.GetFileType()\r
            FFE = FileNameObj.GetFeatureFlag()\r
            ArchList = FileNameObj.GetSupArchList()\r
            ArchList.sort()\r
            SortedArch = ' '.join(ArchList)      \r
            \r
            Key = (FileName, FileType, FFE, SortedArch)\r
\r
            if Key in BinariesDict:\r
                ValueList = BinariesDict[Key]\r
                for ValueItem in ValueList:\r
                    Statement = GenBinaryStatement(Key, ValueItem)\r
                    if SortedArch in NewSectionDict:\r
                        NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [Statement]\r
                    else:\r
                        NewSectionDict[SortedArch] = [Statement]\r
                #\r
                # as we already generated statement for this DictKey\r
                # here set the Valuelist to be empty to avoid generate duplicate entries \r
                # as the DictKey may have multiple entries\r
                #\r
                BinariesDict[Key] = []\r
            else:\r
                Statement = GenBinaryStatement(Key, None)\r
                if SortedArch in NewSectionDict:\r
                    NewSectionDict[SortedArch] = NewSectionDict[SortedArch] + [Statement]\r
                else:\r
                    NewSectionDict[SortedArch] = [Statement]               \r
 \r
    return GenSection('Binaries', NewSectionDict)