Sync BaseTools Branch (version r2271) to EDKII main trunk.

[mirror_edk2.git] / BaseTools / Source / Python / UPT / PomAdapter / InfPomAlignmentMisc.py

## @file InfPomAlignmentMisc.py\r
# This file contained the routines for InfPomAlignment\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
'''\r
InfPomAlignmentMisc\r
'''\r
\r
##\r
# Import modules\r
#\r
import Logger.Log as Logger\r
from Library import DataType as DT\r
from Library.Misc import ConvertArchList\r
from Object.POM.ModuleObject import BinaryFileObject\r
from Object.POM import CommonObject\r
\r
## GenModuleHeaderUserExt\r
#\r
#\r
def GenModuleHeaderUserExt(DefineObj, ArchString):\r
    DefinesDictNew = {}\r
    EdkReleaseVersion = DefineObj.GetEdkReleaseVersion()\r
    Shadow = DefineObj.GetShadow()\r
    DpxSource = DefineObj.GetDpxSource()\r
    PciVendorId = DefineObj.GetPciVendorId()\r
    PciDeviceId = DefineObj.GetPciDeviceId()\r
    PciClassCode = DefineObj.GetPciClassCode()\r
    PciRevision = DefineObj.GetPciRevision()\r
    PciCompress = DefineObj.GetPciCompress()\r
    CustomMakefile = DefineObj.GetCustomMakefile()\r
    UefiHiiResourceSection = DefineObj.GetUefiHiiResourceSection()\r
\r
    if EdkReleaseVersion != None:\r
        Name = DT.TAB_INF_DEFINES_EDK_RELEASE_VERSION\r
        Value = EdkReleaseVersion.GetValue()\r
        Statement = _GenInfDefineStateMent(EdkReleaseVersion.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           EdkReleaseVersion.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if Shadow != None:\r
        Name = DT.TAB_INF_DEFINES_SHADOW\r
        Value = Shadow.GetValue()\r
        Statement = _GenInfDefineStateMent(Shadow.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           Shadow.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if DpxSource != None:\r
        Name = DT.TAB_INF_DEFINES_DPX_SOURCE\r
        for DpxSourceItem in DpxSource:\r
            Value = DpxSourceItem[0]\r
            Statement = _GenInfDefineStateMent(DpxSourceItem[1].GetHeaderComments(),\r
                                               Name,\r
                                               Value,\r
                                               DpxSourceItem[1].GetTailComments())\r
            DefinesDictNew[Statement] = ArchString\r
\r
    if PciVendorId != None:\r
        Name = DT.TAB_INF_DEFINES_PCI_VENDOR_ID\r
        Value = PciVendorId.GetValue()\r
        Statement = _GenInfDefineStateMent(PciVendorId.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           PciVendorId.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if PciDeviceId != None:\r
        Name = DT.TAB_INF_DEFINES_PCI_DEVICE_ID\r
        Value = PciDeviceId.GetValue()\r
        Statement = _GenInfDefineStateMent(PciDeviceId.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           PciDeviceId.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if PciClassCode != None:\r
        Name = DT.TAB_INF_DEFINES_PCI_CLASS_CODE\r
        Value = PciClassCode.GetValue()\r
        Statement = _GenInfDefineStateMent(PciClassCode.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           PciClassCode.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if PciRevision != None:\r
        Name = DT.TAB_INF_DEFINES_PCI_REVISION\r
        Value = PciRevision.GetValue()\r
        Statement = _GenInfDefineStateMent(PciRevision.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           PciRevision.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if PciCompress != None:\r
        Name = DT.TAB_INF_DEFINES_PCI_COMPRESS\r
        Value = PciCompress.GetValue()\r
        Statement = _GenInfDefineStateMent(PciCompress.Comments.GetHeaderComments(),\r
                                           Name,\r
                                           Value,\r
                                           PciCompress.Comments.GetTailComments())\r
        DefinesDictNew[Statement] = ArchString\r
\r
    if len(CustomMakefile) >= 1:\r
        for CustomMakefileItem in CustomMakefile:\r
            Name = DT.TAB_INF_DEFINES_CUSTOM_MAKEFILE\r
            #\r
            # Not with Feature Flag Expression\r
            #\r
            if len(CustomMakefileItem) == 3:\r
                if CustomMakefileItem[0] != '':\r
                    Value = CustomMakefileItem[0] + ' | ' + CustomMakefileItem[1]\r
                else:\r
                    Value = CustomMakefileItem[1]\r
\r
                Comments = CustomMakefileItem[2]\r
                Statement = _GenInfDefineStateMent(Comments.GetHeaderComments(),\r
                                                   Name,\r
                                                   Value,\r
                                                   Comments.GetTailComments())\r
\r
            DefinesDictNew[Statement] = ArchString\r
\r
    if UefiHiiResourceSection != None:\r
        Name = DT.TAB_INF_DEFINES_UEFI_HII_RESOURCE_SECTION\r
        Value = UefiHiiResourceSection.GetValue()\r
        HeaderComment = UefiHiiResourceSection.Comments.GetHeaderComments()\r
        TailComment = UefiHiiResourceSection.Comments.GetTailComments()\r
        Statement = _GenInfDefineStateMent(HeaderComment,\r
                                           Name,\r
                                           Value,\r
                                           TailComment)\r
        DefinesDictNew[Statement] = ""\r
\r
    return DefinesDictNew\r
\r
\r
## Generate the define statement that will be put into userextension\r
#  Not support comments.\r
#\r
# @param HeaderComment: the original header comment (# not remvoed)\r
# @param Name: the definition keyword, should not be empty or none\r
# @param Value: the definition keyword value\r
# @param TailComment: the original Tail comment (# not remvoed)\r
#\r
# @return: the regenerated define statement\r
#\r
def _GenInfDefineStateMent(HeaderComment, Name, Value, TailComment):\r
    Logger.Debug(5, HeaderComment + TailComment)\r
    Statement = '%s = %s' % (Name, Value)\r
\r
    return Statement\r
\r
## GenBinaryData\r
#\r
#\r
def GenBinaryData(BinaryData, BinaryObj, BinariesDict, AsBuildIns, BinaryFileObjectList, SupArchList, BinaryModule):\r
    if BinaryModule:\r
        pass\r
    OriSupArchList = SupArchList\r
    for Item in BinaryData:\r
        ItemObj = BinaryObj[Item][0][0]\r
        if ItemObj.GetType() not in DT.BINARY_FILE_TYPE_UI_LIST + DT.BINARY_FILE_TYPE_VER_LIST:\r
            TagName = ItemObj.GetTagName()\r
            Family = ItemObj.GetFamily()\r
        else:\r
            TagName = ''\r
            Family = ''\r
        FFE = ItemObj.GetFeatureFlagExp()\r
\r
        #\r
        # If have architecturie specified, then use the specified architecturie;\r
        # If the section tag does not have an architecture modifier or the modifier is "common" (case in-sensitive),\r
        # and the VALID_ARCHITECTURES comment exists, the list from the VALID_ARCHITECTURES comment \r
        # can be used for the attribute.\r
        # If both not have VALID_ARCHITECTURE comment and no architecturie specified, then keep it empty.\r
        #        \r
        SupArchList = ConvertArchList(ItemObj.GetSupArchList())\r
        SupArchList.sort()\r
        if len(SupArchList) == 1 and SupArchList[0] == 'COMMON':\r
            if not (len(OriSupArchList) == 1 or OriSupArchList[0] == 'COMMON'):\r
                SupArchList = OriSupArchList\r
            else:\r
                SupArchList = ['COMMON']\r
\r
        FileNameObj = CommonObject.FileNameObject()\r
        FileNameObj.SetFileType(ItemObj.GetType())\r
        FileNameObj.SetFilename(ItemObj.GetFileName())\r
        FileNameObj.SetFeatureFlag(FFE)\r
        FileNameObj.SetSupArchList(SupArchList)\r
        FileNameList = [FileNameObj]\r
\r
        BinaryFile = BinaryFileObject()\r
        BinaryFile.SetFileNameList(FileNameList)\r
        BinaryFile.SetAsBuiltList(AsBuildIns)\r
        BinaryFileObjectList.append(BinaryFile)\r
\r
        SupArchStr = ' '.join(SupArchList)\r
        Key = (ItemObj.GetFileName(), ItemObj.GetType(), FFE, SupArchStr)\r
        ValueItem = (ItemObj.GetTarget(), Family, TagName, '')\r
        if Key in BinariesDict:\r
            ValueList = BinariesDict[Key]\r
            ValueList.append(ValueItem)\r
            BinariesDict[Key] = ValueList\r
        else:\r
            BinariesDict[Key] = [ValueItem]\r
\r
    return BinariesDict, AsBuildIns, BinaryFileObjectList\r