BaseTools: Replace BSD License with BSD+Patent License

[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 - 2018, Intel Corporation. All rights reserved.<BR>\r
#\r
# SPDX-License-Identifier: BSD-2-Clause-Patent\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
    LeftOffset = 31\r
    for ArchList, EntryPoint, UnloadImage, Constructor, Destructor, FFE, HelpStringList in ExternList:\r
        if Arch or ArchList:\r
            if EntryPoint:\r
                Statement = (u'%s ' % DT.TAB_INF_DEFINES_ENTRY_POINT).ljust(LeftOffset) + u'= %s' % 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
\r
            if UnloadImage:\r
                Statement = (u'%s ' % DT.TAB_INF_DEFINES_UNLOAD_IMAGE).ljust(LeftOffset) + u'= %s' % 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
\r
            if Constructor:\r
                Statement = (u'%s ' % DT.TAB_INF_DEFINES_CONSTRUCTOR).ljust(LeftOffset) + u'= %s' % 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
\r
            if Destructor:\r
                Statement = (u'%s ' % DT.TAB_INF_DEFINES_DESTRUCTOR).ljust(LeftOffset) + u'= %s' % 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
    TokenSpaceGuidName = ''\r
    PcdCName = ''\r
    TokenSpaceGuidNameFound = False\r
\r
    for PackageDependency in Packages:\r
        #\r
        # Generate generic comment\r
        #\r
        Guid = PackageDependency.GetGuid()\r
        Version = PackageDependency.GetVersion()\r
\r
        Path = None\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
        # The dependency package in workspace\r
        if Path:\r
            DecFile = None\r
            if Path not in GlobalData.gPackageDict:\r
                DecFile = Dec(Path)\r
                GlobalData.gPackageDict[Path] = DecFile\r
            else:\r
                DecFile = GlobalData.gPackageDict[Path]\r
\r
            DecGuidsDict = DecFile.GetGuidSectionObject().ValueDict\r
            DecPcdsDict = DecFile.GetPcdSectionObject().ValueDict\r
\r
            TokenSpaceGuidName = ''\r
            PcdCName = ''\r
            TokenSpaceGuidNameFound = False\r
\r
            #\r
            # Get TokenSpaceGuidCName from Guids section\r
            #\r
            for GuidKey in DecGuidsDict:\r
                GuidList = DecGuidsDict[GuidKey]\r
                for GuidItem in GuidList:\r
                    if TokenSpaceGuidValue.upper() == GuidItem.GuidString.upper():\r
                        TokenSpaceGuidName = GuidItem.GuidCName\r
                        TokenSpaceGuidNameFound = True\r
                        break\r
                if TokenSpaceGuidNameFound:\r
                    break\r
            #\r
            # Retrieve PcdCName from Pcds Section\r
            #\r
            for PcdKey in DecPcdsDict:\r
                PcdList = DecPcdsDict[PcdKey]\r
                for PcdItem in PcdList:\r
                    if TokenSpaceGuidName == PcdItem.TokenSpaceGuidCName and Token == PcdItem.TokenValue:\r
                        PcdCName = PcdItem.TokenCName\r
                        return TokenSpaceGuidName, PcdCName\r
\r
        # The dependency package in ToBeInstalledDist\r
        else:\r
            for Dist in GlobalData.gTO_BE_INSTALLED_DIST_LIST:\r
                for Package in Dist.PackageSurfaceArea.values():\r
                    if Guid == Package.Guid:\r
                        for GuidItem in Package.GuidList:\r
                            if TokenSpaceGuidValue.upper() == GuidItem.Guid.upper():\r
                                TokenSpaceGuidName = GuidItem.CName\r
                                TokenSpaceGuidNameFound = True\r
                                break\r
                        for PcdItem in Package.PcdList:\r
                            if TokenSpaceGuidName == PcdItem.TokenSpaceGuidCName and Token == PcdItem.Token:\r
                                PcdCName = PcdItem.CName\r
                                return TokenSpaceGuidName, PcdCName\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, Type=None):\r
    NewDict = {}\r
    LeftOffset = 0\r
    if Type in ['INF_GUID', 'INF_PPI_PROTOCOL']:\r
        LeftOffset = 45\r
    if Type in ['INF_PCD']:\r
        LeftOffset = 75\r
    if LeftOffset > 0:\r
        for Statement, SortedArch in OrigDict:\r
            if len(Statement) > LeftOffset:\r
                LeftOffset = len(Statement)\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
            if LeftOffset:\r
                NewStateMent = Statement.ljust(LeftOffset) + ' ' + Comment.rstrip('\n')\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
\r