Sync EDKII BaseTools to BaseTools project r1971

[mirror_edk2.git] / BaseTools / Source / Python / msa2inf / ConvertModule.py

## @file\r
# Convert an MSA Module class object ot an INF Module class object by filling\r
# several info required by 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
from LoadMsa import LoadMsa\r
from StoreInf import StoreInf\r
from Common.MigrationUtilities import *\r
from EdkIIWorkspaceGuidsInfo import gEdkIIWorkspaceGuidsInfo\r
\r
#The default INF version number tool generates.\r
gInfVersion = "0x00010005"\r
\r
## Add required version information.\r
#\r
# Add the default INF version, EFI specificiation version and EDK release\r
# version to Module class object.\r
#\r
# @param  Module              An input Module class object.\r
#\r
def AddModuleMiscVersion(Module):\r
    Version = gInfVersion\r
    Module.Header.InfVersion = Version\r
\r
    Version = Module.Header.Specification.get("EFI_SPECIFICATION_VERSION", "")\r
    Module.Header.UefiSpecificationVersion = Version\r
    \r
    Version = Module.Header.Specification.get("EDK_RELEASE_VERSION", "")\r
    Module.Header.EdkReleaseVersion = Version\r
\r
\r
## Add Module produced library class.\r
#\r
# Add the produced library class from library class list whose usage type is\r
# always produced.\r
#\r
# @param  Module              An input Module class object.\r
#\r
def AddModuleProducedLibraryClass(Module):\r
    for LibraryClass in Module.LibraryClasses:\r
        if "ALWAYS_PRODUCED" in LibraryClass.Usage:\r
            Module.Header.LibraryClass.append(LibraryClass)\r
\r
\r
## Add Module Package Dependency path.\r
#\r
# Translate Package Dependency Guid to a file path relative to workspace.\r
#\r
# @param  Module              An input Module class object.\r
#\r
def AddModulePackageDependencyPath(Module):\r
    for PackageDependency in Module.PackageDependencies:\r
        PackageGuid = PackageDependency.PackageGuid\r
        PackageVersion = PackageDependency.PackageVersion\r
        \r
        GuidToFilePath = gEdkIIWorkspaceGuidsInfo.ResolvePackageFilePath\r
        PackageFilePath = GuidToFilePath(PackageGuid, PackageVersion)\r
        PackageDependency.FilePath = PackageFilePath\r
\r
\r
## Add Module Recommended Library Instance path.\r
#\r
# Translate Module Recommened Library Instance Guid to a file path relative to\r
# workspace.\r
#\r
# @param  Module              An input Module class object.\r
#\r
def AddModuleRecommonedLibraryInstancePath(Module):\r
    for LibraryClass in Module.LibraryClasses:\r
        if "ALWAYS_PRODUCED" in LibraryClass.Usage:\r
            continue\r
\r
        if LibraryClass.RecommendedInstanceGuid == "":\r
            continue\r
        \r
        LibraryGuid = LibraryClass.RecommendedInstanceGuid\r
        LibraryVersion = LibraryClass.RecommendedIntanceVersion\r
        \r
        GuidToFilePath = gEdkIIWorkspaceGuidsInfo.ResolveModuleFilePath\r
        LibraryInstance = GuidToFilePath(LibraryGuid, LibraryVersion)\r
        LibraryClass.RecommendedIntance = LibraryInstance\r
\r
\r
## Convert MSA Module class object to INF Module class object.\r
#\r
# Convert MSA module class ojbect to INF Module class object by filling in\r
# several information required by INF file.\r
#\r
# @param  Module              An input Module class object.\r
#\r
def ConvertMsaModuleToInfModule(Module):\r
    AddModuleMiscVersion(Module)\r
    AddModuleProducedLibraryClass(Module)\r
    AddModulePackageDependencyPath(Module)\r
    AddModuleRecommonedLibraryInstancePath(Module)\r
\r
\r
if __name__ == '__main__':\r
    pass\r