[mirror_edk2.git] / BaseTools / Source / Python / Common / InfClassObjectLight.py

## @file\r
# This file is used to define each component of INF file\r
#\r
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\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 os\r
import re\r
import EdkLogger\r
\r
from CommonDataClass.ModuleClass import *\r
from CommonDataClass import CommonClass\r
from String import *\r
from DataType import *\r
from BuildToolError import *\r
from Misc import sdict\r
from Misc import GetFiles\r
from Parsing import *\r
\r
# Global variable\r
Section = {TAB_UNKNOWN.upper() : MODEL_UNKNOWN,\r
           TAB_INF_DEFINES.upper() : MODEL_META_DATA_HEADER,\r
           TAB_BUILD_OPTIONS.upper() : MODEL_META_DATA_BUILD_OPTION,\r
           TAB_INCLUDES.upper() : MODEL_EFI_INCLUDE,\r
           TAB_LIBRARIES.upper() : MODEL_EFI_LIBRARY_INSTANCE,\r
           TAB_LIBRARY_CLASSES.upper() : MODEL_EFI_LIBRARY_CLASS,\r
           TAB_PACKAGES.upper() : MODEL_META_DATA_PACKAGE,\r
           TAB_NMAKE.upper() : MODEL_META_DATA_NMAKE,\r
           TAB_INF_FIXED_PCD.upper() : MODEL_PCD_FIXED_AT_BUILD,\r
           TAB_INF_PATCH_PCD.upper() : MODEL_PCD_PATCHABLE_IN_MODULE,\r
           TAB_INF_FEATURE_PCD.upper() : MODEL_PCD_FEATURE_FLAG,\r
           TAB_INF_PCD_EX.upper() : MODEL_PCD_DYNAMIC_EX,\r
           TAB_INF_PCD.upper() : MODEL_PCD_DYNAMIC,\r
           TAB_SOURCES.upper() : MODEL_EFI_SOURCE_FILE,\r
           TAB_GUIDS.upper() : MODEL_EFI_GUID,\r
           TAB_PROTOCOLS.upper() : MODEL_EFI_PROTOCOL,\r
           TAB_PPIS.upper() : MODEL_EFI_PPI,\r
           TAB_DEPEX.upper() : MODEL_EFI_DEPEX,\r
           TAB_BINARIES.upper() : MODEL_EFI_BINARY_FILE,\r
           TAB_USER_EXTENSIONS.upper() : MODEL_META_DATA_USER_EXTENSION\r
           }\r
\r
gComponentType2ModuleType = {\r
    "LIBRARY"               :   "BASE",\r
    "SECURITY_CORE"         :   "SEC",\r
    "PEI_CORE"              :   "PEI_CORE",\r
    "COMBINED_PEIM_DRIVER"  :   "PEIM",\r
    "PIC_PEIM"              :   "PEIM",\r
    "RELOCATABLE_PEIM"      :   "PEIM",\r
    "PE32_PEIM"             :   "PEIM",\r
    "BS_DRIVER"             :   "DXE_DRIVER",\r
    "RT_DRIVER"             :   "DXE_RUNTIME_DRIVER",\r
    "SAL_RT_DRIVER"         :   "DXE_SAL_DRIVER",\r
    "APPLICATION"           :   "UEFI_APPLICATION",\r
    "LOGO"                  :   "BASE",\r
}\r
\r
class InfHeader(ModuleHeaderClass):\r
    _Mapping_ = {\r
        # Required Fields\r
        TAB_INF_DEFINES_BASE_NAME                   : "Name",\r
        TAB_INF_DEFINES_FILE_GUID                   : "Guid",\r
        TAB_INF_DEFINES_MODULE_TYPE                 : "ModuleType",\r
        TAB_INF_DEFINES_EFI_SPECIFICATION_VERSION   : "UefiSpecificationVersion",\r
        TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION  : "UefiSpecificationVersion",\r
        TAB_INF_DEFINES_EDK_RELEASE_VERSION         : "EdkReleaseVersion",\r
\r
        # Optional Fields\r
        TAB_INF_DEFINES_INF_VERSION                 : "InfVersion",\r
        TAB_INF_DEFINES_BINARY_MODULE               : "BinaryModule",\r
        TAB_INF_DEFINES_COMPONENT_TYPE              : "ComponentType",\r
        TAB_INF_DEFINES_MAKEFILE_NAME               : "MakefileName",\r
        TAB_INF_DEFINES_BUILD_NUMBER                : "BuildNumber",\r
        TAB_INF_DEFINES_BUILD_TYPE                  : "BuildType",\r
        TAB_INF_DEFINES_FFS_EXT                     : "FfsExt",\r
        TAB_INF_DEFINES_FV_EXT                      : "FvExt",\r
        TAB_INF_DEFINES_SOURCE_FV                   : "SourceFv",\r
        TAB_INF_DEFINES_VERSION_NUMBER              : "VersionNumber",\r
        TAB_INF_DEFINES_VERSION_STRING              : "VersionString",\r
        TAB_INF_DEFINES_VERSION                     : "Version",\r
        TAB_INF_DEFINES_PCD_IS_DRIVER               : "PcdIsDriver",\r
        TAB_INF_DEFINES_TIANO_EDK_FLASHMAP_H         : "TianoEdkFlashMap_h",\r
        TAB_INF_DEFINES_SHADOW                      : "Shadow",\r
    }\r
\r
    def __init__(self):\r
        ModuleHeaderClass.__init__(self)\r
        self.VersionNumber = ''\r
        self.VersionString = ''\r
        #print self.__dict__\r
    def __setitem__(self, key, value):\r
        self.__dict__[self._Mapping_[key]] = value\r
    def __getitem__(self, key):\r
        return self.__dict__[self._Mapping_[key]]\r
    ## "in" test support\r
    def __contains__(self, key):\r
        return key in self._Mapping_\r
\r
## InfObject\r
#\r
# This class defined basic Inf object which is used by inheriting\r
# \r
# @param object:       Inherited from object class\r
#\r
class InfObject(object):\r
    def __init__(self):\r
        object.__init__()\r
\r
## Inf\r
#\r
# This class defined the structure used in Inf object\r
# \r
# @param InfObject:         Inherited from InfObject class\r
# @param Ffilename:         Input value for Ffilename of Inf file, default is None\r
# @param IsMergeAllArches:  Input value for IsMergeAllArches\r
#                           True is to merge all arches\r
#                           Fales is not to merge all arches\r
#                           default is False\r
# @param IsToModule:        Input value for IsToModule\r
#                           True is to transfer to ModuleObject automatically\r
#                           False is not to transfer to ModuleObject automatically\r
#                           default is False\r
# @param WorkspaceDir:      Input value for current workspace directory, default is None\r
#\r
# @var Identification:      To store value for Identification, it is a structure as Identification\r
# @var UserExtensions:      To store value for UserExtensions\r
# @var Module:              To store value for Module, it is a structure as ModuleClass\r
# @var WorkspaceDir:        To store value for WorkspaceDir\r
# @var KeyList:             To store value for KeyList, a list for all Keys used in Inf\r
#\r
class Inf(InfObject):\r
    def __init__(self, Filename=None, IsToModule=False, WorkspaceDir=None, PackageDir=None, SupArchList=DataType.ARCH_LIST):\r
        self.Identification = IdentificationClass()\r
        self.Module = ModuleClass()\r
        self.WorkspaceDir = WorkspaceDir\r
        self.PackageDir = PackageDir\r
        self.SupArchList = SupArchList\r
\r
        self.KeyList = [\r
            TAB_SOURCES, TAB_BUILD_OPTIONS, TAB_BINARIES, TAB_INCLUDES, TAB_GUIDS,\r
            TAB_PROTOCOLS, TAB_PPIS, TAB_LIBRARY_CLASSES, TAB_PACKAGES, TAB_INF_FIXED_PCD,\r
            TAB_INF_PATCH_PCD, TAB_INF_FEATURE_PCD, TAB_INF_PCD, TAB_INF_PCD_EX,\r
            TAB_DEPEX, TAB_INF_DEFINES\r
        ]\r
        # Upper all KEYs to ignore case sensitive when parsing\r
        self.KeyList = map(lambda c: c.upper(), self.KeyList)\r
\r
        # Init RecordSet\r
        self.RecordSet = {}\r
        for Key in self.KeyList:\r
            self.RecordSet[Section[Key]] = []\r
\r
        # Init Comment\r
        self.SectionHeaderCommentDict = {}\r
\r
        # Load Inf file if filename is not None\r
        if Filename != None:\r
            self.LoadInfFile(Filename)\r
\r
        # Transfer to Module Object if IsToModule is True\r
        if IsToModule:\r
            self.InfToModule()\r
\r
    ## Module Object to INF file\r
    def ModuleToInf(self, Module):\r
        Inf = ''\r
        InfList = sdict()\r
        SectionHeaderCommentDict = {}\r
        if Module == None:\r
            return Inf\r
\r
        ModuleHeader = Module.ModuleHeader\r
        TmpList = []\r
        # Common define items\r
        if ModuleHeader.Name:\r
            TmpList.append(TAB_INF_DEFINES_BASE_NAME + ' = ' + ModuleHeader.Name)\r
        if ModuleHeader.Guid:\r
            TmpList.append(TAB_INF_DEFINES_FILE_GUID + ' = ' + ModuleHeader.Guid)\r
        if ModuleHeader.Version:\r
            TmpList.append(TAB_INF_DEFINES_VERSION_STRING + ' = ' + ModuleHeader.Version)\r
        if ModuleHeader.ModuleType:\r
            TmpList.append(TAB_INF_DEFINES_MODULE_TYPE + ' = ' + ModuleHeader.ModuleType)\r
        if ModuleHeader.PcdIsDriver:\r
            TmpList.append(TAB_INF_DEFINES_PCD_IS_DRIVER + ' = ' + ModuleHeader.PcdIsDriver)\r
        # Externs\r
        for Item in Module.Externs:\r
            if Item.EntryPoint:\r
                TmpList.append(TAB_INF_DEFINES_ENTRY_POINT + ' = ' + Item.EntryPoint)\r
            if Item.UnloadImage:\r
                TmpList.append(TAB_INF_DEFINES_UNLOAD_IMAGE + ' = ' + Item.UnloadImage)\r
            if Item.Constructor:\r
                TmpList.append(TAB_INF_DEFINES_CONSTRUCTOR + ' = ' + Item.Constructor)\r
            if Item.Destructor:\r
                TmpList.append(TAB_INF_DEFINES_DESTRUCTOR + ' = ' + Item.Destructor)\r
        # Other define items\r
        if Module.UserExtensions != None:\r
            for Item in Module.UserExtensions.Defines:\r
                TmpList.append(Item)\r
        InfList['Defines'] = TmpList\r
        if ModuleHeader.Description != '':\r
            SectionHeaderCommentDict['Defines'] = ModuleHeader.Description\r
\r
        if Module.UserExtensions != None:\r
            InfList['BuildOptions'] = Module.UserExtensions.BuildOptions\r
\r
        for Item in Module.Includes:\r
            Key = 'Includes.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            Value.append(Item.FilePath)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.LibraryClasses:\r
            Key = 'LibraryClasses.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            NewValue = Item.LibraryClass\r
            if Item.RecommendedInstance:\r
                NewValue = NewValue + '|' + Item.RecommendedInstance\r
            if Item.FeatureFlag:\r
                NewValue = NewValue + '|' + Item.FeatureFlag\r
            Value.append(NewValue)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.PackageDependencies:\r
            Key = 'Packages.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            Value.append(Item.FilePath)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.PcdCodes:\r
            Key = 'Pcds' + Item.ItemType + '.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            NewValue = Item.TokenSpaceGuidCName + '.' + Item.CName\r
            if Item.DefaultValue != '':\r
                NewValue = NewValue + '|' + Item.DefaultValue\r
            Value.append(NewValue)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.Sources:\r
            Key = 'Sources.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            NewValue = Item.SourceFile\r
            if Item.ToolChainFamily != '':\r
                NewValue = NewValue + '|' + Item.ToolChainFamily\r
            if Item.TagName != '':\r
                NewValue = NewValue + '|' + Item.TagName\r
            if Item.ToolCode != '':\r
                NewValue = NewValue + '|' + Item.ToolCode\r
            if Item.FeatureFlag != '':\r
                NewValue = NewValue + '|' + Item.FeatureFlag\r
            Value.append(NewValue)\r
            if Item.HelpText != '':\r
                SectionHeaderCommentDict[Key] = Item.HelpText\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.Guids:\r
            Key = 'Guids.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            Value.append(Item.CName)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.Protocols:\r
            Key = 'Protocols.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            Value.append(Item.CName)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.Ppis:\r
            Key = 'Ppis.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            Value.append(Item.CName)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        if Module.PeiDepex:\r
            Key = 'Depex'\r
            Value = Module.PeiDepex.Depex\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        if Module.DxeDepex:\r
            Key = 'Depex'\r
            Value = Module.DxeDepex.Depex\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        if Module.SmmDepex:\r
            Key = 'Depex'\r
            Value = Module.SmmDepex.Depex\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        for Item in Module.Binaries:\r
            Key = 'Binaries.' + GetStringOfList(Item.SupArchList)\r
            Value = GetHelpTextList(Item.HelpTextList)\r
            NewValue = Item.FileType + '|' + Item.BinaryFile + '|' + Item.Target\r
            if Item.FeatureFlag != '':\r
                NewValue = NewValue + '|' + Item.FeatureFlag\r
            Value.append(NewValue)\r
            GenMetaDatSectionItem(Key, Value, InfList)\r
\r
        # Transfer Module to Inf\r
        for Key in InfList:\r
            if Key in SectionHeaderCommentDict:\r
                List = SectionHeaderCommentDict[Key].split('\r')\r
                for Item in List:\r
                    Inf = Inf + Item + '\n'\r
            Inf = Inf + '[' + Key + ']' + '\n'\r
            for Value in InfList[Key]:\r
                if type(Value) == type([]):\r
                    for SubValue in Value:\r
                        Inf = Inf + '  ' + SubValue + '\n'\r
                else:\r
                    Inf = Inf + '  ' + Value + '\n'\r
            Inf = Inf + '\n'\r
\r
        return Inf\r
\r
\r
    ## Transfer to Module Object\r
    # \r
    # Transfer all contents of an Inf file to a standard Module Object\r
    #\r
    def InfToModule(self):\r
        # Init global information for the file\r
        ContainerFile = self.Identification.FullPath\r
\r
        # Generate Module Header\r
        self.GenModuleHeader(ContainerFile)\r
\r
        # Generate BuildOptions\r
        self.GenBuildOptions(ContainerFile)\r
\r
        # Generate Includes\r
        self.GenIncludes(ContainerFile)\r
\r
        # Generate LibraryClasses\r
        self.GenLibraryClasses(ContainerFile)\r
\r
        # Generate Packages\r
        self.GenPackages(ContainerFile)\r
\r
        # Generate Pcds\r
        self.GenPcds(ContainerFile)\r
\r
        # Generate Sources\r
        self.GenSources(ContainerFile)\r
\r
        # Generate Guids\r
        self.GenGuidProtocolPpis(DataType.TAB_GUIDS, ContainerFile)\r
\r
        # Generate Protocols\r
        self.GenGuidProtocolPpis(DataType.TAB_PROTOCOLS, ContainerFile)\r
\r
        # Generate Ppis\r
        self.GenGuidProtocolPpis(DataType.TAB_PPIS, ContainerFile)\r
\r
        # Generate Depexes\r
        self.GenDepexes(ContainerFile)\r
\r
        # Generate Binaries\r
        self.GenBinaries(ContainerFile)\r
\r
        # Init MiscFiles\r
        self.GenMiscFiles(ContainerFile)\r
\r
    ## GenMiscFiles\r
    #\r
    def GenMiscFiles(self, ContainerFile):\r
        MiscFiles = MiscFileClass()\r
        MiscFiles.Name = 'ModuleFiles'\r
        for Item in GetFiles(os.path.dirname(ContainerFile), ['CVS', '.svn'], False):\r
            File = CommonClass.FileClass()\r
            File.Filename = Item\r
            MiscFiles.Files.append(File)\r
        self.Module.MiscFiles = MiscFiles\r
\r
    ## Load Inf file\r
    #\r
    # Load the file if it exists\r
    #\r
    # @param Filename:  Input value for filename of Inf file\r
    #\r
    def LoadInfFile(self, Filename):\r
        # Insert a record for file\r
        Filename = NormPath(Filename)\r
\r
        self.Identification.FullPath = Filename\r
        (self.Identification.RelaPath, self.Identification.FileName) = os.path.split(Filename)\r
        if self.Identification.FullPath.find(self.WorkspaceDir) > -1:\r
            self.Identification.ModulePath = os.path.dirname(self.Identification.FullPath[len(self.WorkspaceDir) + 1:])\r
        if self.PackageDir:\r
            self.Identification.PackagePath = self.PackageDir\r
            if self.Identification.ModulePath.find(self.PackageDir) == 0:\r
                self.Identification.ModulePath = self.Identification.ModulePath[len(self.PackageDir) + 1:]\r
\r
        # Init common datas\r
        IfDefList, SectionItemList, CurrentSection, ArchList, ThirdList, IncludeFiles = \\r
        [], [], TAB_UNKNOWN, [], [], []\r
        LineNo = 0\r
\r
        # Parse file content\r
        IsFindBlockComment = False\r
        ReservedLine = ''\r
        Comment = ''\r
        for Line in open(Filename, 'r'):\r
            LineNo = LineNo + 1\r
            # Remove comment block\r
            if Line.find(TAB_COMMENT_EDK_START) > -1:\r
                ReservedLine = GetSplitList(Line, TAB_COMMENT_EDK_START, 1)[0]\r
                if ReservedLine.strip().startswith(TAB_COMMENT_SPLIT):\r
                    Comment = Comment + Line.strip() + '\n'\r
                    ReservedLine = ''\r
                else:\r
                    Comment = Comment + Line[len(ReservedLine):] + '\n'\r
                IsFindBlockComment = True\r
                if not ReservedLine:\r
                    continue\r
            if Line.find(TAB_COMMENT_EDK_END) > -1:\r
                Comment = Comment + Line[:Line.find(TAB_COMMENT_EDK_END) + len(TAB_COMMENT_EDK_END)] + '\n'\r
                Line = ReservedLine + GetSplitList(Line, TAB_COMMENT_EDK_END, 1)[1]\r
                ReservedLine = ''\r
                IsFindBlockComment = False\r
            if IsFindBlockComment:\r
                Comment = Comment + Line.strip() + '\n'\r
                continue\r
\r
            # Remove comments at tail and remove spaces again\r
            if Line.strip().startswith(TAB_COMMENT_SPLIT) or Line.strip().startswith('--/'):\r
                Comment = Comment + Line.strip() + '\n'\r
            Line = CleanString(Line)\r
            if Line == '':\r
                continue\r
\r
            ## Find a new section tab\r
            # First insert previous section items\r
            # And then parse the content of the new section\r
            if Line.startswith(TAB_SECTION_START) and Line.endswith(TAB_SECTION_END):\r
                if Line[1:3] == "--":\r
                    continue\r
                Model = Section[CurrentSection.upper()]\r
                # Insert items data of previous section\r
                InsertSectionItems(Model, CurrentSection, SectionItemList, ArchList, ThirdList, self.RecordSet)\r
\r
                # Parse the new section\r
                SectionItemList = []\r
                ArchList = []\r
                ThirdList = []\r
\r
                CurrentSection = ''\r
                LineList = GetSplitValueList(Line[len(TAB_SECTION_START):len(Line) - len(TAB_SECTION_END)], TAB_COMMA_SPLIT)\r
                for Item in LineList:\r
                    ItemList = GetSplitValueList(Item, TAB_SPLIT)\r
                    if CurrentSection == '':\r
                        CurrentSection = ItemList[0]\r
                    else:\r
                        if CurrentSection != ItemList[0]:\r
                            EdkLogger.error("Parser", PARSER_ERROR, "Different section names '%s' and '%s' are found in one section definition, this is not allowed." % (CurrentSection, ItemList[0]), File=Filename, Line=LineNo, RaiseError=EdkLogger.IsRaiseError)\r
                    if CurrentSection.upper() not in self.KeyList:\r
                        RaiseParserError(Line, CurrentSection, Filename, '', LineNo)\r
                    ItemList.append('')\r
                    ItemList.append('')\r
                    if len(ItemList) > 5:\r
                        RaiseParserError(Line, CurrentSection, Filename, '', LineNo)\r
                    else:\r
                        if ItemList[1] != '' and ItemList[1].upper() not in ARCH_LIST_FULL:\r
                            EdkLogger.error("Parser", PARSER_ERROR, "Invalid Arch definition '%s' found" % ItemList[1], File=Filename, Line=LineNo, RaiseError=EdkLogger.IsRaiseError)\r
                        ArchList.append(ItemList[1].upper())\r
                        ThirdList.append(ItemList[2])\r
\r
                if Comment:\r
                    if Comment.endswith('\n'):\r
                        Comment = Comment[:len(Comment) - len('\n')]\r
                    self.SectionHeaderCommentDict[Section[CurrentSection.upper()]] = Comment\r
                    Comment = ''\r
                continue\r
\r
            # Not in any defined section\r
            if CurrentSection == TAB_UNKNOWN:\r
                ErrorMsg = "%s is not in any defined section" % Line\r
                EdkLogger.error("Parser", PARSER_ERROR, ErrorMsg, File=Filename, Line=LineNo, RaiseError=EdkLogger.IsRaiseError)\r
\r
            # Add a section item\r
            SectionItemList.append([Line, LineNo, Comment])\r
            Comment = ''\r
            # End of parse\r
        #End of For\r
\r
        # Insert items data of last section\r
        Model = Section[CurrentSection.upper()]\r
        InsertSectionItems(Model, CurrentSection, SectionItemList, ArchList, ThirdList, self.RecordSet)\r
        if Comment != '':\r
            self.SectionHeaderCommentDict[Model] = Comment\r
            Comment = ''\r
\r
    ## Show detailed information of Module\r
    #\r
    # Print all members and their values of Module class\r
    #\r
    def ShowModule(self):\r
        M = self.Module\r
        print 'Filename =', M.ModuleHeader.FileName\r
        print 'FullPath =', M.ModuleHeader.FullPath\r
        print 'RelaPath =', M.ModuleHeader.RelaPath\r
        print 'PackagePath =', M.ModuleHeader.PackagePath\r
        print 'ModulePath =', M.ModuleHeader.ModulePath\r
        print 'CombinePath =', M.ModuleHeader.CombinePath\r
\r
        print 'BaseName =', M.ModuleHeader.Name\r
        print 'Guid =', M.ModuleHeader.Guid\r
        print 'Version =', M.ModuleHeader.Version\r
\r
        print '\nIncludes ='\r
        for Item in M.Includes:\r
            print Item.FilePath, Item.SupArchList\r
        print '\nLibraryClasses ='\r
        for Item in M.LibraryClasses:\r
            print Item.LibraryClass, Item.RecommendedInstance, Item.RecommendedInstanceGuid, Item.RecommendedInstanceVersion, Item.FeatureFlag, Item.SupModuleList, Item.SupArchList, Item.Define\r
        print '\nPackageDependencies ='\r
        for Item in M.PackageDependencies:\r
            print Item.FilePath, Item.SupArchList, Item.FeatureFlag\r
        print '\nPcds ='\r
        for Item in M.PcdCodes:\r
            print '\tCName=', Item.CName, 'TokenSpaceGuidCName=', Item.TokenSpaceGuidCName, 'DefaultValue=', Item.DefaultValue, 'ItemType=', Item.ItemType, Item.SupArchList\r
        print '\nSources ='\r
        for Source in M.Sources:\r
            print Source.SourceFile, 'Fam=', Source.ToolChainFamily, 'Pcd=', Source.FeatureFlag, 'Tag=', Source.TagName, 'ToolCode=', Source.ToolCode, Source.SupArchList\r
        print '\nGuids ='\r
        for Item in M.Guids:\r
            print Item.CName, Item.SupArchList, Item.FeatureFlag\r
        print '\nProtocols ='\r
        for Item in M.Protocols:\r
            print Item.CName, Item.SupArchList, Item.FeatureFlag\r
        print '\nPpis ='\r
        for Item in M.Ppis:\r
            print Item.CName, Item.SupArchList, Item.FeatureFlag\r
        print '\nDepex ='\r
        for Item in M.Depex:\r
            print Item.Depex, Item.SupArchList, Item.Define\r
        print '\nBinaries ='\r
        for Binary in M.Binaries:\r
            print 'Type=', Binary.FileType, 'Target=', Binary.Target, 'Name=', Binary.BinaryFile, 'FeatureFlag=', Binary.FeatureFlag, 'SupArchList=', Binary.SupArchList\r
        print '\n*** FileList ***'\r
        for Item in M.MiscFiles.Files:\r
            print Item.Filename\r
        print '****************\n'\r
\r
    ## Convert [Defines] section content to ModuleHeaderClass\r
    #\r
    # Convert [Defines] section content to ModuleHeaderClass\r
    #\r
    # @param Defines        The content under [Defines] section\r
    # @param ModuleHeader   An object of ModuleHeaderClass\r
    # @param Arch           The supported ARCH\r
    #\r
    def GenModuleHeader(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate ModuleHeader ...")\r
        # Update all defines item in database\r
        RecordSet = self.RecordSet[MODEL_META_DATA_HEADER]\r
\r
        ModuleHeader = ModuleHeaderClass()\r
        ModuleExtern = ModuleExternClass()\r
        OtherDefines = []\r
        for Record in RecordSet:\r
            ValueList = GetSplitValueList(Record[0], TAB_EQUAL_SPLIT)\r
            if len(ValueList) != 2:\r
                OtherDefines.append(Record[0])\r
            else:\r
                Name = ValueList[0]\r
                Value = ValueList[1]\r
                if Name == TAB_INF_DEFINES_BASE_NAME:\r
                    ModuleHeader.Name = Value\r
                    ModuleHeader.BaseName = Value\r
                elif Name == TAB_INF_DEFINES_FILE_GUID:\r
                    ModuleHeader.Guid = Value\r
                elif Name == TAB_INF_DEFINES_VERSION_STRING:\r
                    ModuleHeader.Version = Value\r
                elif Name == TAB_INF_DEFINES_PCD_IS_DRIVER:\r
                    ModuleHeader.PcdIsDriver = Value\r
                elif Name == TAB_INF_DEFINES_MODULE_TYPE:\r
                    ModuleHeader.ModuleType = Value\r
                elif Name in (TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION, TAB_INF_DEFINES_UEFI_SPECIFICATION_VERSION):\r
                    ModuleHeader.UefiSpecificationVersion = Value\r
                elif Name == TAB_INF_DEFINES_PI_SPECIFICATION_VERSION:\r
                    ModuleHeader.PiSpecificationVersion = Value\r
                elif Name == TAB_INF_DEFINES_ENTRY_POINT:\r
                    ModuleExtern.EntryPoint = Value\r
                elif Name == TAB_INF_DEFINES_UNLOAD_IMAGE:\r
                    ModuleExtern.UnloadImage = Value\r
                elif Name == TAB_INF_DEFINES_CONSTRUCTOR:\r
                    ModuleExtern.Constructor = Value\r
                elif Name == TAB_INF_DEFINES_DESTRUCTOR:\r
                    ModuleExtern.Destructor = Value\r
                else:\r
                    OtherDefines.append(Record[0])\r
        ModuleHeader.FileName = self.Identification.FileName\r
        ModuleHeader.FullPath = self.Identification.FullPath\r
        ModuleHeader.RelaPath = self.Identification.RelaPath\r
        ModuleHeader.PackagePath = self.Identification.PackagePath\r
        ModuleHeader.ModulePath = self.Identification.ModulePath\r
        ModuleHeader.CombinePath = os.path.normpath(os.path.join(ModuleHeader.PackagePath, ModuleHeader.ModulePath, ModuleHeader.FileName))\r
\r
        if MODEL_META_DATA_HEADER in self.SectionHeaderCommentDict:\r
            ModuleHeader.Description = self.SectionHeaderCommentDict[MODEL_META_DATA_HEADER]\r
        self.Module.ModuleHeader = ModuleHeader\r
        self.Module.Externs.append(ModuleExtern)\r
        UE = self.Module.UserExtensions\r
        if UE == None:\r
            UE = UserExtensionsClass()\r
        UE.Defines = OtherDefines\r
        self.Module.UserExtensions = UE\r
\r
    ## GenBuildOptions\r
    #\r
    # Gen BuildOptions of Inf\r
    # [<Family>:]<ToolFlag>=Flag\r
    #\r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenBuildOptions(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_BUILD_OPTIONS)\r
        BuildOptions = {}\r
        # Get all BuildOptions\r
        RecordSet = self.RecordSet[MODEL_META_DATA_BUILD_OPTION]\r
        UE = self.Module.UserExtensions\r
        if UE == None:\r
            UE = UserExtensionsClass()\r
        for Record in RecordSet:\r
            UE.BuildOptions.append(Record[0])\r
        self.Module.UserExtensions = UE\r
\r
    ## GenIncludes\r
    #\r
    # Gen Includes of Inf\r
    # \r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenIncludes(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_INCLUDES)\r
        Includes = sdict()\r
        # Get all Includes\r
        RecordSet = self.RecordSet[MODEL_EFI_INCLUDE]\r
        for Record in RecordSet:\r
            Include = IncludeClass()\r
            Include.FilePath = Record[0]\r
            Include.SupArchList = Record[1]\r
            if GenerateHelpText(Record[5], ''):\r
                Include.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            self.Module.Includes.append(Include)\r
            #self.Module.FileList.extend(GetFiles(os.path.normpath(os.path.join(self.Identification.FileRelativePath, Include.FilePath)), ['CVS', '.svn']))\r
\r
    ## GenLibraryClasses\r
    #\r
    # Get LibraryClass of Inf\r
    # <LibraryClassKeyWord>|<LibraryInstance>\r
    #\r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenLibraryClasses(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_LIBRARY_CLASSES)\r
        LibraryClasses = {}\r
        # Get all LibraryClasses\r
        RecordSet = self.RecordSet[MODEL_EFI_LIBRARY_CLASS]\r
        for Record in RecordSet:\r
            (LibClassName, LibClassIns, Pcd, SupModelList) = GetLibraryClassOfInf([Record[0], Record[4]], ContainerFile, self.WorkspaceDir, Record[2])\r
            LibraryClass = CommonClass.LibraryClassClass()\r
            LibraryClass.LibraryClass = LibClassName\r
            LibraryClass.RecommendedInstance = LibClassIns\r
            LibraryClass.FeatureFlag = Pcd\r
            LibraryClass.SupArchList = Record[1]\r
            LibraryClass.SupModuleList = Record[4]\r
            if GenerateHelpText(Record[5], ''):\r
                LibraryClass.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            self.Module.LibraryClasses.append(LibraryClass)\r
\r
    ## GenPackages\r
    #\r
    # Gen Packages of Inf\r
    # \r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenPackages(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_PACKAGES)\r
        Packages = {}\r
        # Get all Packages\r
        RecordSet = self.RecordSet[MODEL_META_DATA_PACKAGE]\r
        for Record in RecordSet:\r
            (PackagePath, Pcd) = GetPackage(Record[0], ContainerFile, self.WorkspaceDir, Record[2])\r
            Package = ModulePackageDependencyClass()\r
            Package.FilePath = NormPath(PackagePath)\r
            Package.SupArchList = Record[1]\r
            Package.FeatureFlag = Pcd\r
            if GenerateHelpText(Record[5], ''):\r
                Package.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            self.Module.PackageDependencies.append(Package)\r
\r
    def AddPcd(self, CName, TokenSpaceGuidCName, DefaultValue, ItemType, Arch, HelpTextList):\r
        Pcd = PcdClass()\r
        Pcd.CName = CName\r
        Pcd.TokenSpaceGuidCName = TokenSpaceGuidCName\r
        Pcd.DefaultValue = DefaultValue\r
        Pcd.ItemType = ItemType\r
        Pcd.SupArchList = Arch\r
        if GenerateHelpText(HelpTextList, ''):\r
            Pcd.HelpTextList.append(GenerateHelpText(HelpTextList, ''))\r
        self.Module.PcdCodes.append(Pcd)\r
\r
    ## GenPcds\r
    #\r
    # Gen Pcds of Inf\r
    # <TokenSpaceGuidCName>.<PcdCName>[|<Value>]\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenPcds(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_PCDS)\r
        Pcds = {}\r
        PcdToken = {}\r
\r
        # Get all Pcds\r
        RecordSet1 = self.RecordSet[MODEL_PCD_FIXED_AT_BUILD]\r
        RecordSet2 = self.RecordSet[MODEL_PCD_PATCHABLE_IN_MODULE]\r
        RecordSet3 = self.RecordSet[MODEL_PCD_FEATURE_FLAG]\r
        RecordSet4 = self.RecordSet[MODEL_PCD_DYNAMIC_EX]\r
        RecordSet5 = self.RecordSet[MODEL_PCD_DYNAMIC]\r
\r
        # Go through each arch\r
        for Record in RecordSet1:\r
            (TokenSpaceGuidCName, TokenName, Value, Type) = GetPcdOfInf(Record[0], TAB_PCDS_FIXED_AT_BUILD, ContainerFile, Record[2])\r
            self.AddPcd(TokenName, TokenSpaceGuidCName, Value, Type, Record[1], Record[5])\r
        for Record in RecordSet2:\r
            (TokenSpaceGuidCName, TokenName, Value, Type) = GetPcdOfInf(Record[0], TAB_PCDS_PATCHABLE_IN_MODULE, ContainerFile, Record[2])\r
            self.AddPcd(TokenName, TokenSpaceGuidCName, Value, Type, Record[1], Record[5])\r
        for Record in RecordSet3:\r
            (TokenSpaceGuidCName, TokenName, Value, Type) = GetPcdOfInf(Record[0], TAB_PCDS_FEATURE_FLAG, ContainerFile, Record[2])\r
            self.AddPcd(TokenName, TokenSpaceGuidCName, Value, Type, Record[1], Record[5])\r
        for Record in RecordSet4:\r
            (TokenSpaceGuidCName, TokenName, Value, Type) = GetPcdOfInf(Record[0], TAB_PCDS_DYNAMIC_EX, ContainerFile, Record[2])\r
            self.AddPcd(TokenName, TokenSpaceGuidCName, Value, Type, Record[1], Record[5])\r
        for Record in RecordSet5:\r
            (TokenSpaceGuidCName, TokenName, Value, Type) = GetPcdOfInf(Record[0], '', ContainerFile, Record[2])\r
            self.AddPcd(TokenName, TokenSpaceGuidCName, Value, Type, Record[1], Record[5])\r
\r
    ## GenSources\r
    #\r
    # Gen Sources of Inf\r
    # <Filename>[|<Family>[|<TagName>[|<ToolCode>[|<PcdFeatureFlag>]]]]\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenSources(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_SOURCES)\r
        Sources = {}\r
\r
        # Get all Sources\r
        RecordSet = self.RecordSet[MODEL_EFI_SOURCE_FILE]\r
        for Record in RecordSet:\r
            (Filename, Family, TagName, ToolCode, Pcd) = GetSource(Record[0], ContainerFile, self.Identification.RelaPath, Record[2])\r
            Source = ModuleSourceFileClass(Filename, TagName, ToolCode, Family, Pcd, Record[1])\r
            if GenerateHelpText(Record[5], ''):\r
                Source.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            if MODEL_EFI_SOURCE_FILE in self.SectionHeaderCommentDict:\r
                Source.HelpText = self.SectionHeaderCommentDict[MODEL_EFI_SOURCE_FILE]\r
            self.Module.Sources.append(Source)\r
            #self.Module.FileList.append(os.path.normpath(os.path.join(self.Identification.RelaPath, Filename)))\r
\r
    ## GenDepexes\r
    #\r
    # Gen Depex of Inf\r
    #\r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenDepexes(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_DEPEX)\r
        Depex = {}\r
        # Get all Depexes\r
        RecordSet = self.RecordSet[MODEL_EFI_DEPEX]\r
        DepexString = ''\r
        for Record in RecordSet:\r
            DepexString = DepexString + Record[0] + '\n'\r
        Dep = ModuleDepexClass()\r
        if DepexString.endswith('\n'):\r
            DepexString = DepexString[:len(DepexString) - len('\n')]\r
        Dep.Depex = DepexString\r
        if self.Module.ModuleHeader.ModuleType in ['DXE_SMM_DRIVER']:\r
            self.Module.SmmDepex = Dep\r
        elif self.Module.ModuleHeader.ModuleType in ['PEI_CORE', 'PEIM']:\r
            self.Module.PeiDepex = Dep\r
        else:\r
            self.Module.DxeDepex = Dep\r
#        for Record in RecordSet:\r
#            \r
#            Dep = ModuleDepexClass()\r
#            Dep.Depex = Record[0]\r
#            Dep.SupArchList = Record[1]\r
#            if GenerateHelpText(Record[5], ''):\r
#                Dep.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
#            DepexString = DepexString + Dep\r
#            List.append(Dep)\r
#        self.Module.Depex = List\r
#        if self.Module.ModuleHeader.ModuleType in ['DXE_SMM_DRIVER']:\r
#            self.Module.SmmDepex = List\r
#        elif self.Module.ModuleHeader.ModuleType in ['PEI_CORE', 'PEIM']:\r
#            self.Module.PeiDepex = List\r
#        else:\r
#            self.Module.DxeDepex = List\r
\r
    ## GenBinaries\r
    #\r
    # Gen Binary of Inf\r
    # <FileType>|<Filename>|<Target>[|<TokenSpaceGuidCName>.<PcdCName>]\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenBinaries(self, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % TAB_BINARIES)\r
        Binaries = {}\r
\r
        # Get all Guids\r
        RecordSet = self.RecordSet[MODEL_EFI_BINARY_FILE]\r
        for Record in RecordSet:\r
            (FileType, Filename, Target, Pcd) = GetBinary(Record[0], ContainerFile, self.Identification.RelaPath, Record[2])\r
            Binary = ModuleBinaryFileClass(Filename, FileType, Target, Pcd, Record[1])\r
            if GenerateHelpText(Record[5], ''):\r
                Binary.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            self.Module.Binaries.append(Binary)\r
            #self.Module.FileList.append(os.path.normpath(os.path.join(self.Identification.RelaPath, Filename)))\r
\r
    ## GenGuids\r
    #\r
    # Gen Guids of Inf\r
    # <CName>=<GuidValue>\r
    #\r
    # @param ContainerFile: The Inf file full path \r
    #\r
    def GenGuidProtocolPpis(self, Type, ContainerFile):\r
        EdkLogger.debug(2, "Generate %s ..." % Type)\r
        Lists = {}\r
        # Get all Items\r
        if Type == TAB_GUIDS:\r
            ListMember = self.Module.Guids\r
        elif Type == TAB_PROTOCOLS:\r
            ListMember = self.Module.Protocols\r
        elif Type == TAB_PPIS:\r
            ListMember = self.Module.Ppis\r
\r
        RecordSet = self.RecordSet[Section[Type.upper()]]\r
        for Record in RecordSet:\r
            (Name, Value) = GetGuidsProtocolsPpisOfInf(Record[0], Type, ContainerFile, Record[2])\r
            ListClass = GuidProtocolPpiCommonClass()\r
            ListClass.CName = Name\r
            ListClass.SupArchList = Record[1]\r
            ListClass.FeatureFlag = Value\r
            if GenerateHelpText(Record[5], ''):\r
                ListClass.HelpTextList.append(GenerateHelpText(Record[5], ''))\r
            ListMember.append(ListClass)\r
\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
#\r
if __name__ == '__main__':\r
    EdkLogger.Initialize()\r
    EdkLogger.SetLevel(EdkLogger.QUIET)\r
\r
    W = os.getenv('WORKSPACE')\r
    F = os.path.join(W, 'MdeModulePkg/Application/HelloWorld/HelloWorld.inf')\r
\r
    P = Inf(os.path.normpath(F), True, W, 'MdeModulePkg')\r
    P.ShowModule()\r
    print P.ModuleToInf(P.Module)\r