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

[mirror_edk2.git] / BaseTools / Source / Python / UPT / Library / CommentGenerating.py

## @file\r
# This file is used to define comment generating interface\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
CommentGenerating\r
'''\r
\r
##\r
# Import Modules\r
#\r
from Library.String import GetSplitValueList\r
from Library.DataType import TAB_SPACE_SPLIT\r
from Library.DataType import TAB_INF_GUIDTYPE_VAR\r
from Library.DataType import USAGE_ITEM_NOTIFY\r
from Library.DataType import ITEM_UNDEFINED\r
from Library.DataType import LANGUAGE_EN_US\r
\r
## GenTailCommentLines\r
#\r
# @param TailCommentLines:  the tail comment lines that need to be generated\r
# @param LeadingSpaceNum:   the number of leading space needed for non-first \r
#                            line tail comment\r
# \r
def GenTailCommentLines (TailCommentLines, LeadingSpaceNum = 0):\r
    EndOfLine = "\n"\r
    TailCommentLines = TailCommentLines.rstrip(EndOfLine)\r
    CommentStr = "  ## " + (EndOfLine + LeadingSpaceNum * TAB_SPACE_SPLIT + \\r
                            "  ## ").join(GetSplitValueList(TailCommentLines, \\r
                                                            EndOfLine))\r
    return CommentStr\r
\r
## GenGenericComment\r
#\r
# @param CommentLines:   Generic comment Text, maybe Multiple Lines\r
# \r
def GenGenericComment (CommentLines):\r
    if not CommentLines:\r
        return ''\r
    EndOfLine = "\n"\r
    CommentLines = CommentLines.rstrip(EndOfLine)\r
    CommentStr = '## ' + (EndOfLine + '# ').join\\r
    (GetSplitValueList(CommentLines, EndOfLine)) + EndOfLine\r
    return CommentStr\r
\r
## GenGenericCommentF\r
#\r
#  similar to GenGenericComment but will remove <EOL> at end of comment once,\r
#  and for line with only <EOL>, '#\n' will be generated instead of '# \n'\r
#\r
# @param CommentLines:   Generic comment Text, maybe Multiple Lines\r
# @return CommentStr:    Generated comment line \r
# \r
def GenGenericCommentF (CommentLines, NumOfPound=1):\r
    if not CommentLines:\r
        return ''\r
    EndOfLine = "\n"\r
    #\r
    # if comment end with '\n', then remove it to prevent one extra line\r
    # generate later on\r
    #\r
    if CommentLines.endswith(EndOfLine):\r
        CommentLines = CommentLines[:-1]\r
    CommentLineList = GetSplitValueList(CommentLines, EndOfLine)\r
    CommentStr = ''\r
    for Line in CommentLineList:\r
        if Line == '':\r
            CommentStr += '#' * NumOfPound + '\n'\r
        else:\r
            CommentStr += '#' * NumOfPound + ' ' + Line + '\n'\r
     \r
    return CommentStr\r
\r
\r
## GenHeaderCommentSection\r
#\r
# Generate Header comment sections\r
#\r
# @param Abstract      One line of abstract \r
# @param Description   multiple lines of Description\r
# @param Copyright     possible multiple copyright lines\r
# @param License       possible multiple license lines\r
#\r
def GenHeaderCommentSection(Abstract, Description, Copyright, License):\r
    EndOfLine = '\n'\r
    Content = ''\r
    \r
    Content += '## @file' + EndOfLine\r
    if Abstract:\r
        Abstract = Abstract.rstrip(EndOfLine)\r
        Content += '# ' + Abstract + EndOfLine\r
        Content += '#' + EndOfLine\r
    else:\r
        Content += '#' + EndOfLine\r
\r
    if Description:\r
        Description = Description.rstrip(EndOfLine)\r
        Content += '# ' + (EndOfLine + '# ').join(GetSplitValueList\\r
                                                  (Description, '\n'))\r
        Content += EndOfLine + '#' + EndOfLine        \r
  \r
    #\r
    # There is no '#\n' line to separate multiple copyright lines in code base \r
    #\r
    if Copyright:\r
        Copyright = Copyright.rstrip(EndOfLine)\r
        Content += '# ' + (EndOfLine + '# ').join\\r
        (GetSplitValueList(Copyright, '\n'))\r
        Content += EndOfLine + '#' + EndOfLine\r
\r
    if License:\r
        License = License.rstrip(EndOfLine)\r
        Content += '# ' + (EndOfLine + '# ').join(GetSplitValueList\\r
                                                  (License, '\n'))\r
        Content += EndOfLine + '#' + EndOfLine\r
\r
    Content += '##' + EndOfLine\r
    \r
    return Content\r
\r
\r
## GenInfPcdTailComment\r
#  Generate Pcd tail comment for Inf, this would be one line comment\r
#\r
# @param Usage:            Usage type\r
# @param TailCommentText:  Comment text for tail comment\r
# \r
def GenInfPcdTailComment (Usage, TailCommentText):\r
    if (Usage == ITEM_UNDEFINED) and (not TailCommentText):\r
        return ''\r
    \r
    CommentLine = TAB_SPACE_SPLIT.join([Usage, TailCommentText])\r
    return GenTailCommentLines(CommentLine)\r
\r
## GenInfProtocolPPITailComment\r
#  Generate Protocol/PPI tail comment for Inf\r
#\r
# @param Usage:            Usage type\r
# @param TailCommentText:  Comment text for tail comment\r
# \r
def GenInfProtocolPPITailComment (Usage, Notify, TailCommentText):\r
    if (not Notify) and (Usage == ITEM_UNDEFINED) and (not TailCommentText):\r
        return ''\r
    \r
    if Notify:\r
        CommentLine = USAGE_ITEM_NOTIFY + " ## "\r
    else:\r
        CommentLine = ''\r
    \r
    CommentLine += TAB_SPACE_SPLIT.join([Usage, TailCommentText])\r
    return GenTailCommentLines(CommentLine)\r
\r
## GenInfGuidTailComment\r
#  Generate Guid tail comment for Inf\r
#\r
# @param Usage:            Usage type\r
# @param TailCommentText:  Comment text for tail comment\r
# \r
def GenInfGuidTailComment (Usage, GuidTypeList, VariableName, TailCommentText):\r
    GuidType = GuidTypeList[0]\r
    if (Usage == ITEM_UNDEFINED) and (GuidType == ITEM_UNDEFINED) and \\r
        (not TailCommentText):\r
        return ''\r
    \r
    FirstLine = Usage + " ## " + GuidType    \r
    if GuidType == TAB_INF_GUIDTYPE_VAR:\r
        FirstLine += ":" + VariableName\r
      \r
    CommentLine = TAB_SPACE_SPLIT.join([FirstLine, TailCommentText])\r
    return GenTailCommentLines(CommentLine)\r
\r
## GenDecGuidTailComment\r
#\r
# @param SupModuleList:  Supported module type list\r
# \r
def GenDecTailComment (SupModuleList):   \r
    CommentLine = TAB_SPACE_SPLIT.join(SupModuleList)\r
    return GenTailCommentLines(CommentLine)\r
\r
\r
## _GetHelpStr\r
#  get HelpString from a list of HelpTextObject, the priority refer to \r
#  related HLD\r
#\r
#  @param HelpTextObjList: List of HelpTextObject\r
# \r
#  @return HelpStr: the help text string found, '' means no help text found\r
#\r
def _GetHelpStr(HelpTextObjList):\r
    HelpStr = ''\r
\r
    for HelpObj in HelpTextObjList:\r
        if HelpObj and HelpObj.GetLang() == LANGUAGE_EN_US:\r
            HelpStr = HelpObj.GetString()\r
            return HelpStr\r
    \r
    for HelpObj in HelpTextObjList:\r
        if HelpObj and HelpObj.GetLang().startswith('en'):\r
            HelpStr = HelpObj.GetString()\r
            return HelpStr\r
\r
    for HelpObj in HelpTextObjList:\r
        if HelpObj and not HelpObj.GetLang():\r
            HelpStr = HelpObj.GetString()\r
            return HelpStr\r
    \r
    return HelpStr