BaseTools: Clear build versions to sync with buildtools/BaseTools

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

## @file DecPomAlignment.py\r
# This file contained the adapter for convert INF parser object to POM Object\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
DecPomAlignment\r
'''\r
\r
##\r
# Import Modules\r
#\r
import os.path\r
from os import sep\r
import platform\r
\r
import Logger.Log as Logger\r
from Logger import StringTable as ST\r
from Logger.ToolError import UPT_MUL_DEC_ERROR\r
\r
from Library.Parsing import NormPath\r
from Library.DataType import ARCH_LIST\r
from Library.DataType import TAB_GUIDS\r
from Library.DataType import TAB_PROTOCOLS\r
from Library.DataType import TAB_PPIS\r
from Library.DataType import TAB_DEC_DEFINES_PACKAGE_NAME\r
from Library.DataType import TAB_DEC_DEFINES_PACKAGE_GUID\r
from Library.DataType import TAB_DEC_DEFINES_PACKAGE_VERSION\r
from Library.DataType import TAB_DEC_DEFINES_DEC_SPECIFICATION\r
from Library.DataType import TAB_ARCH_COMMON\r
from Library.CommentParsing import ParseHeaderCommentSection\r
from Library.DataType import TAB_INCLUDES\r
from Library.CommentParsing import ParseGenericComment\r
from Library.DataType import TAB_LIBRARY_CLASSES\r
from Library.DataType import TAB_PCDS\r
from Library.DataType import TAB_PCDS_FIXED_AT_BUILD_NULL\r
from Library.DataType import TAB_PCDS_PATCHABLE_IN_MODULE_NULL\r
from Library.DataType import TAB_PCDS_FEATURE_FLAG_NULL\r
from Library.DataType import TAB_PCDS_DYNAMIC_EX_NULL\r
from Library.DataType import TAB_PCDS_DYNAMIC_NULL\r
from Library.DataType import TAB_PTR_TYPE_PCD\r
from Library.DataType import ITEM_UNDEFINED\r
from Library.CommentParsing import ParseDecPcdGenericComment\r
from Library.CommentParsing import ParseDecPcdTailComment\r
from Library.Misc import GetFiles\r
from Library.Misc import Sdict\r
from Parser.DecParser import Dec\r
\r
from Object.POM.PackageObject import PackageObject\r
from Object.POM.CommonObject import UserExtensionObject\r
from Object.POM.CommonObject import IncludeObject\r
from Object.POM.CommonObject import GuidObject\r
from Object.POM.CommonObject import ProtocolObject\r
from Object.POM.CommonObject import PpiObject\r
from Object.POM.CommonObject import LibraryClassObject\r
from Object.POM.CommonObject import PcdObject\r
from Object.POM.CommonObject import TextObject\r
\r
\r
## DecPomAlignment\r
#\r
# Inherited from PackageObject\r
#\r
class DecPomAlignment(PackageObject):\r
    def __init__(self, Filename, WorkspaceDir = None, CheckMulDec = False):\r
        PackageObject.__init__(self)\r
        self.UserExtensions = ''\r
        self.WorkspaceDir = WorkspaceDir\r
        self.SupArchList = ARCH_LIST\r
        self.CheckMulDec = CheckMulDec\r
        self.DecParser = None\r
        \r
        #\r
        # Load Dec file\r
        #\r
        self.LoadDecFile(Filename)\r
        \r
        #\r
        # Transfer to Package Object if IsToPackage is True\r
        #\r
        self.DecToPackage()\r
    \r
    ## Load Dec file\r
    #\r
    # Load the file if it exists\r
    #\r
    # @param Filename:  Input value for filename of Dec file\r
    #\r
    def LoadDecFile(self, Filename):\r
        #\r
        # Insert a record for file\r
        #\r
        Filename = NormPath(Filename)\r
        (Path, Name) = os.path.split(Filename)\r
        self.SetFullPath(Filename)\r
        self.SetRelaPath(Path)\r
        self.SetFileName(Name)\r
        self.SetPackagePath(Path[Path.upper().find(self.WorkspaceDir.upper()) + len(self.WorkspaceDir) + 1:])\r
        self.SetCombinePath(Filename[Filename.upper().find(self.WorkspaceDir.upper()) + len(self.WorkspaceDir) + 1:])\r
        \r
        self.DecParser = Dec(Filename)\r
    \r
    ## Transfer to Package Object\r
    # \r
    # Transfer all contents of a Dec file to a standard Package Object\r
    #\r
    def DecToPackage(self):\r
        #\r
        # Init global information for the file\r
        #\r
        ContainerFile = self.GetFullPath()\r
        \r
        #\r
        # Generate Package Header\r
        #\r
        self.GenPackageHeader(ContainerFile)\r
        \r
        #\r
        # Generate Includes\r
        #\r
        self.GenIncludes(ContainerFile)\r
\r
        #\r
        # Generate Guids\r
        #\r
        self.GenGuidProtocolPpis(TAB_GUIDS, ContainerFile)\r
\r
        #\r
        # Generate Protocols\r
        #\r
        self.GenGuidProtocolPpis(TAB_PROTOCOLS, ContainerFile)\r
\r
        #\r
        # Generate Ppis\r
        #\r
        self.GenGuidProtocolPpis(TAB_PPIS, ContainerFile)\r
        \r
        #\r
        # Generate LibraryClasses\r
        #\r
        self.GenLibraryClasses(ContainerFile)\r
        \r
        #\r
        # Generate Pcds\r
        #\r
        self.GenPcds(ContainerFile)\r
        \r
        #\r
        # Generate Module File list, will be used later on to generate \r
        # distribution\r
        #\r
        self.GenModuleFileList(ContainerFile)\r
        \r
        #\r
        # Generate user extensions\r
        #\r
        self.GenUserExtensions()\r
    \r
    ## Generate user extention\r
    #\r
    #\r
    def GenUserExtensions(self):\r
        UEObj = self.DecParser.GetUserExtensionSectionObject()\r
        UEList = UEObj.GetAllUserExtensions()\r
        for Item in UEList:\r
            if not Item.UserString:\r
                continue\r
            UserExtension = UserExtensionObject()\r
            UserId = Item.UserId\r
            if UserId.startswith('"') and UserId.endswith('"'):\r
                UserId = UserId[1:-1]\r
            UserExtension.SetUserID(UserId)\r
            Identifier = Item.IdString\r
            if Identifier.startswith('"') and Identifier.endswith('"'):\r
                Identifier = Identifier[1:-1]\r
            UserExtension.SetIdentifier(Identifier)\r
            UserExtension.SetStatement(Item.UserString)\r
            UserExtension.SetSupArchList(\r
                Item.ArchAndModuleType\r
            )\r
            self.SetUserExtensionList(\r
                self.GetUserExtensionList() + [UserExtension]\r
            )\r
    \r
    ## Generate Package Header\r
    #\r
    # Gen Package Header of Dec as <Key> = <Value>\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenPackageHeader(self, ContainerFile):\r
        Logger.Debug(2, "Generate PackageHeader ...")\r
        DefinesDict = {}\r
        \r
        #\r
        # Update all defines item in database\r
        #\r
        DefObj = self.DecParser.GetDefineSectionObject()\r
        for Item in DefObj.GetDefines():\r
            #\r
            # put items into Dict except for PackageName, Guid, Version, DEC_SPECIFICATION\r
            #\r
            SkipItemList = [TAB_DEC_DEFINES_PACKAGE_NAME, \\r
                TAB_DEC_DEFINES_PACKAGE_GUID, TAB_DEC_DEFINES_PACKAGE_VERSION, TAB_DEC_DEFINES_DEC_SPECIFICATION]\r
            if Item.Key in SkipItemList:\r
                continue\r
            DefinesDict['%s = %s' % (Item.Key, Item.Value)] = TAB_ARCH_COMMON\r
\r
        self.SetBaseName(DefObj.GetPackageName())\r
        self.SetVersion(DefObj.GetPackageVersion())\r
#        self.SetName(DefObj.GetPackageName() + ' Version ' + \\r
#                     DefObj.GetPackageVersion())\r
        self.SetName(os.path.splitext(self.GetFileName())[0])\r
        self.SetGuid(DefObj.GetPackageGuid())\r
     \r
        if DefinesDict:\r
            UserExtension = UserExtensionObject()\r
            UserExtension.SetDefinesDict(DefinesDict)\r
            UserExtension.SetIdentifier('DefineModifiers')\r
            UserExtension.SetUserID('EDK2')  \r
            self.SetUserExtensionList(\r
                self.GetUserExtensionList() + [UserExtension]\r
            )\r
\r
        #\r
        # Get All header comment section information\r
        #\r
        Abstract, Description, Copyright, License = \\r
            ParseHeaderCommentSection(self.DecParser.GetHeadComment(),\r
                                      ContainerFile)\r
        self.SetAbstract(Abstract)\r
        self.SetDescription(Description)\r
        self.SetCopyright(Copyright)\r
        self.SetLicense(License)\r
    \r
    ## GenIncludes\r
    #\r
    # Gen Includes of Dec\r
    # \r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenIncludes(self, ContainerFile):\r
        if ContainerFile:\r
            pass\r
        Logger.Debug(2, "Generate %s ..." % TAB_INCLUDES)\r
        IncludesDict = Sdict()\r
\r
        IncObj = self.DecParser.GetIncludeSectionObject()\r
        for Item in IncObj.GetAllIncludes():\r
            IncludePath = os.path.normpath(Item.File)\r
            if platform.system() != 'Windows':\r
                IncludePath = IncludePath.replace('\\', '/')\r
            if IncludePath in IncludesDict:\r
                if Item.GetArchList() == [TAB_ARCH_COMMON] or IncludesDict[IncludePath] == [TAB_ARCH_COMMON]:\r
                    IncludesDict[IncludePath] = [TAB_ARCH_COMMON]\r
                else:\r
                    IncludesDict[IncludePath] = IncludesDict[IncludePath] + Item.GetArchList()\r
            else:\r
                IncludesDict[IncludePath] = Item.GetArchList()\r
                        \r
        # \r
        # get the  standardIncludeFileList(industry), packageIncludeFileList\r
        # (others) for PackageObject  \r
        # \r
        PackagePath = os.path.split(self.GetFullPath())[0]\r
        IncludePathList = \\r
            [os.path.normpath(Path) + sep for Path in IncludesDict.keys()]\r
        IncludePathList.sort()\r
        \r
        #\r
        # get a non-overlap set of include path, IncludePathList should be \r
        # sorted, and path should be end with path seperator '\'\r
        #\r
        NonOverLapList = []\r
        for Path1 in IncludePathList:\r
            for Path2 in NonOverLapList:\r
                if Path1.startswith(Path2):\r
                    break\r
            else:\r
                NonOverLapList.append(Path1)\r
        #\r
        # revert the list so the longest path shown first in list, also need\r
        # to remove the extra path seperator '\'\r
        # as this list is used to search the supported Arch info\r
        #\r
        for IndexN in range (0, len(IncludePathList)):\r
            IncludePathList[IndexN] = os.path.normpath(IncludePathList[IndexN])\r
        IncludePathList.sort()            \r
        IncludePathList.reverse()\r
        #\r
        # save the include path list for later usage\r
        #\r
        self.SetIncludePathList(IncludePathList)\r
        StandardIncludeFileList = []\r
        PackageIncludeFileList = []\r
        \r
        IncludeFileList = []\r
        for Path in NonOverLapList:\r
            FileList = GetFiles(os.path.join(PackagePath, Path), ['CVS', '.svn'], False)\r
            IncludeFileList += [os.path.normpath(os.path.join(Path, File)) for File in FileList]\r
        for Includefile in IncludeFileList:\r
            ExtName = os.path.splitext(Includefile)[1]\r
            if ExtName.upper() == '.DEC' and self.CheckMulDec:\r
                Logger.Error('MkPkg', \r
                             UPT_MUL_DEC_ERROR,\r
                             ST.ERR_MUL_DEC_ERROR%(os.path.dirname(ContainerFile), \r
                                                   os.path.basename(ContainerFile),\r
                                                   Includefile))\r
\r
            FileCombinePath = os.path.dirname(Includefile)\r
            Include = IncludeObject()\r
            for Path in IncludePathList:\r
                if FileCombinePath.startswith(Path):\r
                    SupArchList = IncludesDict[Path]\r
                    break\r
            Include.SetFilePath(Includefile)\r
            Include.SetSupArchList(SupArchList)\r
            if Includefile.find('IndustryStandard') != -1:\r
                StandardIncludeFileList.append(Include)\r
            else:\r
                PackageIncludeFileList.append(Include)            \r
    \r
        self.SetStandardIncludeFileList(StandardIncludeFileList)\r
\r
        #\r
        # put include path into the PackageIncludeFileList\r
        #\r
        PackagePathList = []\r
        IncObj = self.DecParser.GetIncludeSectionObject()        \r
        for Item in IncObj.GetAllIncludes():\r
            IncludePath = Item.File\r
            Include = IncludeObject()\r
            Include.SetFilePath(IncludePath)\r
            Include.SetSupArchList(Item.GetArchList())\r
            PackagePathList.append(Include)\r
        self.SetPackageIncludeFileList(PackagePathList + PackageIncludeFileList)\r
    \r
    ## GenPpis\r
    #\r
    # Gen Ppis of Dec\r
    # <CName>=<GuidValue>\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenGuidProtocolPpis(self, Type, ContainerFile):\r
        if ContainerFile:\r
            pass\r
        Logger.Debug(2, "Generate %s ..." % Type)\r
\r
        Obj = None\r
        Factory = None\r
        if Type == TAB_GUIDS:\r
            Obj = self.DecParser.GetGuidSectionObject()\r
            def CreateGuidObject():\r
                Object = GuidObject()\r
                Object.SetGuidTypeList([])\r
                Object.SetUsage(None)\r
                Object.SetName(None)\r
                return Object\r
            Factory = CreateGuidObject\r
        elif Type == TAB_PROTOCOLS:\r
            Obj = self.DecParser.GetProtocolSectionObject()\r
            \r
            def CreateProtocolObject():\r
                return ProtocolObject()\r
            Factory = CreateProtocolObject\r
        elif Type == TAB_PPIS:\r
            Obj = self.DecParser.GetPpiSectionObject()\r
\r
            def CreatePpiObject():\r
                return PpiObject()\r
            Factory = CreatePpiObject\r
        else:\r
            #\r
            # Should not be here\r
            #\r
            return\r
        \r
        DeclarationsList = []\r
        \r
        #\r
        # Go through each arch\r
        #\r
        for Item in Obj.GetGuidStyleAllItems():\r
            Name = Item.GuidCName\r
            Value = Item.GuidString\r
            HelpTxt = ParseGenericComment(Item.GetHeadComment() + \\r
                                          Item.GetTailComment())\r
            \r
            ListObject = Factory()\r
            ListObject.SetCName(Name)\r
            ListObject.SetGuid(Value)\r
            ListObject.SetSupArchList(Item.GetArchList())\r
            if HelpTxt:\r
                ListObject.SetHelpTextList([HelpTxt])\r
            \r
            DeclarationsList.append(ListObject)\r
\r
        #    \r
        #GuidTypeList is abstracted from help\r
        #\r
        if Type == TAB_GUIDS:\r
            self.SetGuidList(self.GetGuidList() + DeclarationsList)\r
        elif Type == TAB_PROTOCOLS:\r
            self.SetProtocolList(self.GetProtocolList() + DeclarationsList)\r
        elif Type == TAB_PPIS:\r
            self.SetPpiList(self.GetPpiList() + DeclarationsList)\r
    \r
    ## GenLibraryClasses\r
    #\r
    # Gen LibraryClasses of Dec\r
    # <CName>=<GuidValue>\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenLibraryClasses(self, ContainerFile):\r
        if ContainerFile:\r
            pass\r
        Logger.Debug(2, "Generate %s ..." % TAB_LIBRARY_CLASSES)\r
        LibraryClassDeclarations = []\r
        \r
        LibObj = self.DecParser.GetLibraryClassSectionObject()\r
        for Item in LibObj.GetAllLibraryclasses():\r
            LibraryClass = LibraryClassObject()\r
            LibraryClass.SetLibraryClass(Item.Libraryclass)\r
            LibraryClass.SetSupArchList(Item.GetArchList())\r
            LibraryClass.SetIncludeHeader(Item.File)\r
            HelpTxt = ParseGenericComment(Item.GetHeadComment() + \\r
                                          Item.GetTailComment(), None, '@libraryclass')\r
            if HelpTxt:\r
                LibraryClass.SetHelpTextList([HelpTxt])\r
            LibraryClassDeclarations.append(LibraryClass)\r
        \r
        self.SetLibraryClassList(self.GetLibraryClassList() + \\r
                                 LibraryClassDeclarations)\r
    \r
    ## GenPcds\r
    #\r
    # Gen Pcds of Dec\r
    # <TokenSpcCName>.<TokenCName>|<Value>|<DatumType>|<Token>\r
    #\r
    # @param ContainerFile: The Dec file full path \r
    #\r
    def GenPcds(self, ContainerFile):\r
        Logger.Debug(2, "Generate %s ..." % TAB_PCDS)\r
        \r
        PcdObj = self.DecParser.GetPcdSectionObject()\r
        #\r
        # Get all Pcds\r
        #        \r
        PcdDeclarations = []\r
        IterList = [\r
            (TAB_PCDS_FIXED_AT_BUILD_NULL,      'FixedPcd'),\r
            (TAB_PCDS_PATCHABLE_IN_MODULE_NULL, 'PatchPcd'), \r
            (TAB_PCDS_FEATURE_FLAG_NULL,        'FeaturePcd'),\r
            (TAB_PCDS_DYNAMIC_EX_NULL,          'PcdEx'), \r
            (TAB_PCDS_DYNAMIC_NULL,             'Pcd')]\r
        #\r
        # For each PCD type\r
        #\r
        for PcdType, Type in IterList:\r
            #\r
            # Go through all archs\r
            #\r
            # for Arch in self.SupArchList + [TAB_ARCH_COMMON]:\r
            #\r
            for Item in PcdObj.GetPcdsByType(PcdType.upper()):\r
                PcdDeclaration = GenPcdDeclaration(\r
                        ContainerFile,\r
                        (Item.TokenSpaceGuidCName, Item.TokenCName,\r
                        Item.DefaultValue, Item.DatumType, Item.TokenValue,\r
                        Type, Item.GetHeadComment(), Item.GetTailComment(),\r
                        '')\r
                    )\r
                PcdDeclaration.SetSupArchList(Item.GetArchListOfType(PcdType))\r
                PcdDeclarations.append(PcdDeclaration)\r
  \r
        self.SetPcdList(self.GetPcdList() + PcdDeclarations)\r
\r
    \r
    ## GenModuleFileList\r
    #\r
    def GenModuleFileList(self, ContainerFile):        \r
        ModuleFileList = []\r
        ContainerFileName = os.path.basename(ContainerFile)\r
        ContainerFilePath = os.path.dirname(ContainerFile)\r
        for Item in GetFiles(ContainerFilePath, \r
                        ['CVS', '.svn'] + self.GetIncludePathList(), False):\r
            ExtName = os.path.splitext(Item)[1]\r
            if ExtName.lower() == '.inf':\r
                ModuleFileList.append(Item)\r
            elif ExtName.upper() == '.DEC' and self.CheckMulDec:\r
                if Item == ContainerFileName:\r
                    continue\r
                Logger.Error('MkPkg', \r
                             UPT_MUL_DEC_ERROR,\r
                             ST.ERR_MUL_DEC_ERROR%(ContainerFilePath, \r
                                                   ContainerFileName, \r
                                                   Item))\r
                \r
        self.SetModuleFileList(ModuleFileList)\r
    \r
    ## Show detailed information of Package\r
    #\r
    # Print all members and their values of Package class\r
    #\r
    def ShowPackage(self):\r
        print '\nName =', self.GetName()\r
        print '\nBaseName =', self.GetBaseName()\r
        print '\nVersion =', self.GetVersion() \r
        print '\nGuid =', self.GetGuid()\r
        \r
        print '\nStandardIncludes = %d ' \\r
            % len(self.GetStandardIncludeFileList()),\r
        for Item in self.GetStandardIncludeFileList():\r
            print Item.GetFilePath(), '  ', Item.GetSupArchList()\r
        print '\nPackageIncludes = %d \n' \\r
            % len(self.GetPackageIncludeFileList()),\r
        for Item in self.GetPackageIncludeFileList():\r
            print Item.GetFilePath(), '  ', Item.GetSupArchList()\r
             \r
        print '\nGuids =', self.GetGuidList()\r
        for Item in self.GetGuidList():\r
            print Item.GetCName(), Item.GetGuid(), Item.GetSupArchList()\r
        print '\nProtocols =', self.GetProtocolList()\r
        for Item in self.GetProtocolList():\r
            print Item.GetCName(), Item.GetGuid(), Item.GetSupArchList()\r
        print '\nPpis =', self.GetPpiList()\r
        for Item in self.GetPpiList():\r
            print Item.GetCName(), Item.GetGuid(), Item.GetSupArchList()\r
        print '\nLibraryClasses =', self.GetLibraryClassList()\r
        for Item in self.GetLibraryClassList():\r
            print Item.GetLibraryClass(), Item.GetRecommendedInstance(), \\r
            Item.GetSupArchList()\r
        print '\nPcds =', self.GetPcdList()\r
        for Item in self.GetPcdList():\r
            print 'CName=', Item.GetCName(), 'TokenSpaceGuidCName=', \\r
                Item.GetTokenSpaceGuidCName(), \\r
                'DefaultValue=', Item.GetDefaultValue(), \\r
                'ValidUsage=', Item.GetValidUsage(), \\r
                'SupArchList', Item.GetSupArchList(), \\r
                'Token=', Item.GetToken(), 'DatumType=', Item.GetDatumType()\r
 \r
        for Item in self.GetMiscFileList():\r
            print Item.GetName()\r
            for FileObjectItem in Item.GetFileList():\r
                print FileObjectItem.GetURI()\r
        print '****************\n'\r
\r
## GenPcdDeclaration\r
#\r
# @param ContainerFile:   File name of the DEC file\r
# @param PcdInfo:         Pcd information, of format (TokenGuidCName, \r
#                         TokenName, Value, DatumType, Token, Type, \r
#                         GenericComment, TailComment, Arch)\r
# \r
def GenPcdDeclaration(ContainerFile, PcdInfo):\r
    HelpStr = ''\r
    TailHelpStr = ''\r
    TokenGuidCName, TokenName, Value, DatumType, Token, Type, \\r
        GenericComment, TailComment, Arch = PcdInfo\r
    Pcd = PcdObject()\r
    Pcd.SetCName(TokenName)\r
    Pcd.SetToken(Token)\r
    Pcd.SetTokenSpaceGuidCName(TokenGuidCName)\r
    Pcd.SetDatumType(DatumType)\r
    Pcd.SetDefaultValue(Value)\r
    Pcd.SetValidUsage(Type)\r
    #\r
    #  MaxDatumSize is required field for 'VOID*' PCD\r
    #\r
    if DatumType == TAB_PTR_TYPE_PCD:\r
        Pcd.SetMaxDatumSize(ITEM_UNDEFINED)\r
\r
    SupArchList = [Arch]\r
    Pcd.SetSupArchList(SupArchList)\r
    \r
    if GenericComment:\r
        HelpStr, PcdErr = ParseDecPcdGenericComment(GenericComment, \r
                                                    ContainerFile)\r
        if PcdErr:\r
            Pcd.SetPcdErrorsList([PcdErr])\r
\r
    if TailComment:\r
        SupModuleList, TailHelpStr = ParseDecPcdTailComment(TailComment, \r
                                                        ContainerFile)\r
        if SupModuleList:\r
            Pcd.SetSupModuleList(SupModuleList)\r
    \r
    if HelpStr and (not HelpStr.endswith('\n')) and TailHelpStr:\r
        HelpStr += '\n'\r
    HelpStr += TailHelpStr\r
    if HelpStr:\r
        HelpTxtObj = TextObject()   \r
        HelpTxtObj.SetString(HelpStr)\r
        Pcd.SetHelpTextList([HelpTxtObj])\r
\r
    return Pcd\r