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

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

## @file GenMetaFileMisc.py\r
#\r
# This file contained the miscellaneous routines for GenMetaFile usage.\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
GenMetaFileMisc\r
'''\r
\r
from Library import DataType as DT\r
from Library import GlobalData\r
from Parser.DecParser import Dec\r
\r
# AddExternToDefineSec\r
#\r
#  @param SectionDict: string of source file path/name\r
#  @param Arch:     string of source file family field\r
#  @param ExternList:  string of source file FeatureFlag field\r
#   \r
def AddExternToDefineSec(SectionDict, Arch, ExternList):\r
    for ArchList, EntryPoint, UnloadImage, Constructor, Destructor, FFE, HelpStringList in ExternList:\r
        if Arch or ArchList:\r
            if EntryPoint:\r
                Statement = '%s = %s' % (DT.TAB_INF_DEFINES_ENTRY_POINT, EntryPoint)\r
                if FFE:\r
                    Statement += ' | %s' % FFE\r
                if len(HelpStringList) > 0:\r
                    Statement = HelpStringList[0].GetString() + '\n' + Statement\r
                if len(HelpStringList) > 1:\r
                    Statement = Statement + HelpStringList[1].GetString()\r
                SectionDict[Arch] = SectionDict[Arch] + [Statement]\r
            if UnloadImage:\r
                Statement = '%s = %s' % (DT.TAB_INF_DEFINES_UNLOAD_IMAGE, UnloadImage)\r
                if FFE:\r
                    Statement += ' | %s' % FFE\r
                \r
                if len(HelpStringList) > 0:\r
                    Statement = HelpStringList[0].GetString() + '\n' + Statement\r
                if len(HelpStringList) > 1:\r
                    Statement = Statement + HelpStringList[1].GetString()\r
                SectionDict[Arch] = SectionDict[Arch] + [Statement]\r
            if Constructor:\r
                Statement = '%s = %s' % (DT.TAB_INF_DEFINES_CONSTRUCTOR, Constructor)\r
                if FFE:\r
                    Statement += ' | %s' % FFE\r
                    \r
                if len(HelpStringList) > 0:\r
                    Statement = HelpStringList[0].GetString() + '\n' + Statement\r
                if len(HelpStringList) > 1:\r
                    Statement = Statement + HelpStringList[1].GetString()      \r
                SectionDict[Arch] = SectionDict[Arch] + [Statement]  \r
            if Destructor:\r
                Statement = '%s = %s' % (DT.TAB_INF_DEFINES_DESTRUCTOR, Destructor)\r
                if FFE:\r
                    Statement += ' | %s' % FFE\r
                    \r
                if len(HelpStringList) > 0:\r
                    Statement = HelpStringList[0].GetString() + '\n' + Statement\r
                if len(HelpStringList) > 1:\r
                    Statement = Statement + HelpStringList[1].GetString()\r
                SectionDict[Arch] = SectionDict[Arch] + [Statement]\r
                \r
## ObtainPcdName\r
#\r
# Using TokenSpaceGuidValue and Token to obtain PcdName from DEC file\r
#\r
def ObtainPcdName(Packages, TokenSpaceGuidValue, Token):\r
    for PackageDependency in Packages:\r
        #\r
        # Generate generic comment\r
        #\r
        Guid = PackageDependency.GetGuid()\r
        Version = PackageDependency.GetVersion()\r
          \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
        DecFile = Dec(Path)\r
        DecGuidsDict = DecFile.GetGuidSectionObject().ValueDict\r
        DecPcdsDict = DecFile.GetPcdSectionObject().ValueDict\r
        \r
        TokenSpaceGuidName = ''\r
        PcdCName = ''\r
        TokenSpaceGuidNameFound = False\r
        PcdCNameFound = False\r
        \r
        #\r
        # Get TokenSpaceGuidCName from Guids section \r
        #\r
        for GuidKey in DecGuidsDict:\r
            GuidList = DecGuidsDict[GuidKey]\r
            if TokenSpaceGuidNameFound:\r
                break\r
            for GuidItem in GuidList:\r
                if TokenSpaceGuidValue == GuidItem.GuidString:\r
                    TokenSpaceGuidName = GuidItem.GuidCName\r
                    TokenSpaceGuidNameFound = True\r
                    break\r
    \r
        #\r
        # Retrieve PcdCName from Pcds Section\r
        #\r
        for PcdKey in DecPcdsDict:\r
            PcdList = DecPcdsDict[PcdKey]\r
            if PcdCNameFound:\r
                break\r
            for PcdItem in PcdList:\r
                if TokenSpaceGuidName == PcdItem.TokenSpaceGuidCName and Token == PcdItem.TokenValue:\r
                    PcdCName = PcdItem.TokenCName\r
                    PcdCNameFound = True\r
                    break        \r
        \r
    return TokenSpaceGuidName, PcdCName\r
\r
## _TransferDict\r
#  transfer dict that using (Statement, SortedArch) as key, \r
#  (GenericComment, UsageComment) as value into a dict that using SortedArch as\r
#  key and NewStatement as value \r
#\r
def TransferDict(OrigDict):\r
    NewDict = {}\r
\r
    for Statement, SortedArch in OrigDict:\r
        Comment = OrigDict[Statement, SortedArch]\r
        #\r
        # apply the NComment/1Comment rule\r
        #\r
        if Comment.find('\n') != len(Comment) - 1:    \r
            NewStateMent = Comment + Statement\r
        else:\r
            NewStateMent = Statement + ' ' + Comment.rstrip('\n')\r
\r
        if SortedArch in NewDict:\r
            NewDict[SortedArch] = NewDict[SortedArch] + [NewStateMent]\r
        else:\r
            NewDict[SortedArch] = [NewStateMent]\r
\r
    return NewDict                \r