Node representing a parameter list. 更多...

#include <docparser.h>

类 DocParamList 继承关系图:

DocParamList 的协作图:

Public 成员函数
	DocParamList (DocParser &parser, DocNode *parent, DocParamSect::Type t, DocParamSect::Direction d)

virtual	~DocParamList ()

Kind	kind () const override

DocNodeList &	parameters ()

DocNodeList &	paramTypes ()

DocParamSect::Type	type () const

DocParamSect::Direction	direction () const

void	markFirst (bool b=TRUE)

void	markLast (bool b=TRUE)

bool	isFirst () const

bool	isLast () const

void	accept (DocVisitor *v) override

int	parse (const QCString &cmdName)

int	parseXml (const QCString &paramName)

Public 成员函数继承自 DocNode
	DocNode (DocParser &parser)

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private 属性
DocParaList	m_paragraphs

DocNodeList	m_params

DocNodeList	m_paramTypes

DocParamSect::Type	m_type = DocParamSect::Unknown

DocParamSect::Direction	m_dir = DocParamSect::Unspecified

bool	m_isFirst = false

bool	m_isLast = false

额外继承的成员函数
Public 类型继承自 DocNode
enum	Kind { Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3, Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7, Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11, Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15, Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19, Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23, Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27, Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31, Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35, Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39, Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43, Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47, Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51, Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }

Protected 类型继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }

Protected 成员函数继承自 DocNode
void	setInsidePreformatted (bool p)

Protected 属性继承自 DocNode
DocNode *	m_parent = 0

DocParser &	m_parser

详细描述

Node representing a parameter list.

在文件 docparser.h 第 1228 行定义.

构造及析构函数说明

◆ DocParamList()

DocParamList::DocParamList	(	DocParser &	parser,
		DocNode *	parent,
		DocParamSect::Type	t,
		DocParamSect::Direction	d
	)

inline

在文件 docparser.h 第 1231 行定义.

       : DocNode(parser), m_type(t), m_dir(d)
     {
       m_parent = parent;
     }

引用了 DocNode::m_parent , 以及 DocNode::parent().

◆ ~DocParamList()

virtual DocParamList::~DocParamList ( )

inlinevirtual

在文件 docparser.h 第 1236 行定义.

1236 { }

成员函数说明

◆ accept()

void DocParamList::accept ( DocVisitor * v )

inlineoverridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数

v	Abstract visitor.

实现了 DocNode.

在文件 docparser.h 第 1246 行定义.

     {
       v->visitPre(this);
       for (const auto &n : m_paragraphs) n->accept(v);
       v->visitPost(this);
     }

引用了 m_paragraphs, DocVisitor::visitPost() , 以及 DocVisitor::visitPre().

◆ direction()

DocParamSect::Direction DocParamList::direction ( ) const

inline

在文件 docparser.h 第 1241 行定义.

1241 { return m_dir; }

引用了 m_dir.

被这些函数引用 HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

◆ isFirst()

bool DocParamList::isFirst ( ) const

inline

在文件 docparser.h 第 1244 行定义.

1244 { return m_isFirst; }

引用了 m_isFirst.

◆ isLast()

bool DocParamList::isLast ( ) const

inline

在文件 docparser.h 第 1245 行定义.

1245 { return m_isLast; }

引用了 m_isLast.

被这些函数引用 ManDocVisitor::visitPost().

◆ kind()

Kind DocParamList::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 1237 行定义.

1237 { return Kind_ParamList; }

引用了 DocNode::Kind_ParamList.

◆ markFirst()

void DocParamList::markFirst ( bool b = TRUE )

inline

在文件 docparser.h 第 1242 行定义.

1242 { m_isFirst=b; }

引用了 m_isFirst.

被这些函数引用 DocParamSect::parse().

◆ markLast()

void DocParamList::markLast ( bool b = TRUE )

inline

在文件 docparser.h 第 1243 行定义.

1243 { m_isLast=b; }

引用了 m_isLast.

被这些函数引用 DocParamSect::parse().

◆ parameters()

DocNodeList& DocParamList::parameters ( )

inline

在文件 docparser.h 第 1238 行定义.

1238 { return m_params; }

引用了 m_params.

被这些函数引用 PrintDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre(), ManDocVisitor::visitPre(), XmlDocVisitor::visitPre() , 以及 PerlModDocVisitor::visitPre().

◆ paramTypes()

DocNodeList& DocParamList::paramTypes ( )

inline

在文件 docparser.h 第 1239 行定义.

1239 { return m_paramTypes; }

引用了 m_paramTypes.

被这些函数引用 HtmlDocVisitor::visitPre(), DocbookDocVisitor::visitPre(), LatexDocVisitor::visitPre(), RTFDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ parse()

int DocParamList::parse ( const QCString & cmdName )

在文件 docparser.cpp 第 4528 行定义.

 {
   int retval=RetVal_OK;
   DBG(("DocParamList::parse() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
   DocPara *par=0;
   QCString saveCmdName = cmdName;
  
   int tok=m_parser.tokenizer.lex();
   if (tok!=TK_WHITESPACE)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\%s command",
         qPrint(saveCmdName));
     retval=RetVal_EndParBlock;
     goto endparamlist;
   }
   m_parser.tokenizer.setStateParam();
   tok=m_parser.tokenizer.lex();
   while (tok==TK_WORD) /* there is a parameter name */
   {
     if (m_type==DocParamSect::Param)
     {
       int typeSeparator = m_parser.context.token->name.find('#'); // explicit type position
       if (typeSeparator!=-1)
       {
         m_parser.handleParameterType(this,m_paramTypes,m_parser.context.token->name.left(typeSeparator));
         m_parser.context.token->name = m_parser.context.token->name.mid(typeSeparator+1);
         m_parser.context.hasParamCommand=TRUE;
         m_parser.checkArgumentName();
         ((DocParamSect*)parent())->m_hasTypeSpecifier=TRUE;
       }
       else
       {
         m_parser.context.hasParamCommand=TRUE;
         m_parser.checkArgumentName();
       }
     }
     else if (m_type==DocParamSect::RetVal)
     {
       m_parser.context.hasReturnCommand=TRUE;
       m_parser.checkRetvalName();
     }
     //m_params.append(m_parser.context.token->name);
     m_parser.handleLinkedWord(this,m_params);
     tok=m_parser.tokenizer.lex();
   }
   m_parser.tokenizer.setStatePara();
   if (tok==0) /* premature end of comment block */
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment block while parsing the "
         "argument of command %s",qPrint(saveCmdName));
     retval=RetVal_EndParBlock;
     goto endparamlist;
   }
   if (tok!=TK_WHITESPACE) /* premature end of comment block */
   {
     if (tok!=TK_NEWPARA) /* empty param description */
     {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected token %s in comment block while parsing the "
           "argument of command %s",DocTokenizer::tokToString(tok),qPrint(saveCmdName));
     }
     retval=RetVal_EndParBlock;
     goto endparamlist;
   }
  
   par = new DocPara(m_parser,this);
   m_paragraphs.push_back(std::unique_ptr<DocPara>(par));
   retval = par->parse();
   par->markFirst();
   par->markLast();
  
 endparamlist:
   DBG(("DocParamList::parse() end retval=%d\n",retval));
   return retval;
 }

引用了 DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, DBG, DocParserContext::fileName, QCString::find(), DocTokenizer::getLineNr(), DocParser::handleLinkedWord(), DocParser::handleParameterType(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, QCString::left(), DocTokenizer::lex(), m_paragraphs, m_params, m_paramTypes, DocNode::m_parser, m_type, DocPara::markFirst(), DocPara::markLast(), QCString::mid(), TokenInfo::name, DocParamSect::Param, DocNode::parent(), DocPara::parse(), qPrint(), DocParamSect::RetVal, RetVal_EndParBlock, RetVal_OK, DocTokenizer::setStatePara(), DocTokenizer::setStateParam(), TK_NEWPARA, TK_WHITESPACE, TK_WORD, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString(), TRUE , 以及 warn_doc_error().

被这些函数引用 DocParamSect::parse().

◆ parseXml()

int DocParamList::parseXml ( const QCString & paramName )

在文件 docparser.cpp 第 4604 行定义.

 {
   int retval=RetVal_OK;
   DBG(("DocParamList::parseXml() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
  
   m_parser.context.token->name = paramName;
   if (m_type==DocParamSect::Param)
   {
     m_parser.context.hasParamCommand=TRUE;
     m_parser.checkArgumentName();
   }
   else if (m_type==DocParamSect::RetVal)
   {
     m_parser.context.hasReturnCommand=TRUE;
     m_parser.checkRetvalName();
   }
  
   m_parser.handleLinkedWord(this,m_params);
  
   do
   {
     DocPara *par = new DocPara(m_parser,this);
     retval = par->parse();
     if (par->isEmpty()) // avoid adding an empty paragraph for the whitespace
                         // after </para> and before </param>
     {
       delete par;
       break;
     }
     else // append the paragraph to the list
     {
       if (m_paragraphs.empty())
       {
         par->markFirst();
       }
       else
       {
         m_paragraphs.back()->markLast(FALSE);
       }
       par->markLast();
       m_paragraphs.push_back(std::unique_ptr<DocPara>(par));
     }
  
     if (retval == 0) break;
  
   } while (retval==RetVal_CloseXml &&
            Mappers::htmlTagMapper->map(m_parser.context.token->name)!=XML_PARAM &&
            Mappers::htmlTagMapper->map(m_parser.context.token->name)!=XML_TYPEPARAM &&
            Mappers::htmlTagMapper->map(m_parser.context.token->name)!=XML_EXCEPTION);
  
  
   if (retval==0) /* premature end of comment block */
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unterminated param or exception tag");
   }
   else
   {
     retval=RetVal_OK;
   }
  
  
   DBG(("DocParamList::parse() end retval=%d\n",retval));
   return retval;
 }

引用了 DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, DBG, FALSE, DocParserContext::fileName, DocTokenizer::getLineNr(), DocParser::handleLinkedWord(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, Mappers::htmlTagMapper, DocPara::isEmpty(), m_paragraphs, m_params, DocNode::m_parser, m_type, Mapper::map(), DocPara::markFirst(), DocPara::markLast(), TokenInfo::name, DocParamSect::Param, DocPara::parse(), DocParamSect::RetVal, RetVal_CloseXml, RetVal_OK, DocParserContext::token, DocParser::tokenizer, TRUE, warn_doc_error(), XML_EXCEPTION, XML_PARAM , 以及 XML_TYPEPARAM.

被这些函数引用 DocParamSect::parse().

◆ type()

DocParamSect::Type DocParamList::type ( ) const

inline

在文件 docparser.h 第 1240 行定义.

1240 { return m_type; }

引用了 m_type.

类成员变量说明

◆ m_dir

DocParamSect::Direction DocParamList::m_dir = DocParamSect::Unspecified

private

在文件 docparser.h 第 1260 行定义.

被这些函数引用 direction().

◆ m_isFirst

bool DocParamList::m_isFirst = false

private

在文件 docparser.h 第 1261 行定义.

被这些函数引用 isFirst() , 以及 markFirst().

◆ m_isLast

bool DocParamList::m_isLast = false

private

在文件 docparser.h 第 1262 行定义.

被这些函数引用 isLast() , 以及 markLast().

◆ m_paragraphs

DocParaList DocParamList::m_paragraphs

private

在文件 docparser.h 第 1256 行定义.

被这些函数引用 accept(), parse() , 以及 parseXml().

◆ m_params

DocNodeList DocParamList::m_params

private

在文件 docparser.h 第 1257 行定义.

被这些函数引用 parameters(), parse() , 以及 parseXml().

◆ m_paramTypes

DocNodeList DocParamList::m_paramTypes

private

在文件 docparser.h 第 1258 行定义.

被这些函数引用 paramTypes() , 以及 parse().

◆ m_type

DocParamSect::Type DocParamList::m_type = DocParamSect::Unknown

private

在文件 docparser.h 第 1259 行定义.

被这些函数引用 parse(), parseXml() , 以及 type().

该类的文档由以下文件生成:

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocParamList()

◆ ~DocParamList()

成员函数说明

◆ accept()

◆ direction()

◆ isFirst()

◆ isLast()

◆ kind()

◆ markFirst()

◆ markLast()

◆ parameters()

◆ paramTypes()

◆ parse()

◆ parseXml()

◆ type()

类成员变量说明

◆ m_dir

◆ m_isFirst

◆ m_isLast

◆ m_paragraphs

◆ m_params

◆ m_paramTypes

◆ m_type