Doxygen
Loading...
Searching...
No Matches
DocParamList Class Reference

Node representing a parameter list. More...

#include <src/docnode.h>

Inheritance diagram for DocParamList:
Collaboration diagram for DocParamList:

Public Member Functions

 DocParamList (DocParser *parser, DocNodeVariant *parent, DocParamSect::Type t, DocParamSect::Direction d)
const DocNodeListparameters () const
const DocNodeListparamTypes () const
const DocNodeListparagraphs () const
DocParamSect::Type type () const
DocParamSect::Direction direction () const
void markFirst (bool b=TRUE)
void markLast (bool b=TRUE)
bool isFirst () const
bool isLast () const
Token parse (const QCString &cmdName)
Token parseXml (const QCString &paramName)
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Attributes

DocNodeList 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

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing a parameter list.

Definition at line 1124 of file docnode.h.

Constructor & Destructor Documentation

◆ DocParamList()

DocParamList::DocParamList ( DocParser * parser,
DocNodeVariant * parent,
DocParamSect::Type t,
DocParamSect::Direction d )
inline

Definition at line 1127 of file docnode.h.

1128 : DocNode(parser,parent), m_type(t), m_dir(d) {}
DocNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:85
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90
DocParamSect::Direction m_dir
Definition docnode.h:1146
DocParamSect::Type m_type
Definition docnode.h:1145

References DocNode::DocNode(), m_dir, m_type, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ direction()

◆ isFirst()

bool DocParamList::isFirst ( ) const
inline

Definition at line 1136 of file docnode.h.

1136{ return m_isFirst; }
bool m_isFirst
Definition docnode.h:1147

References m_isFirst.

◆ isLast()

bool DocParamList::isLast ( ) const
inline

Definition at line 1137 of file docnode.h.

1137{ return m_isLast; }
bool m_isLast
Definition docnode.h:1148

References m_isLast.

Referenced by ManDocVisitor::operator()().

◆ markFirst()

void DocParamList::markFirst ( bool b = TRUE)
inline

Definition at line 1134 of file docnode.h.

1134{ m_isFirst=b; }

References m_isFirst, and TRUE.

Referenced by parseXml().

◆ markLast()

void DocParamList::markLast ( bool b = TRUE)
inline

Definition at line 1135 of file docnode.h.

1135{ m_isLast=b; }

References m_isLast, and TRUE.

Referenced by DocParamSect::parse(), and parseXml().

◆ paragraphs()

◆ parameters()

◆ paramTypes()

const DocNodeList & DocParamList::paramTypes ( ) const
inline

◆ parse()

Token DocParamList::parse ( const QCString & cmdName)

Definition at line 3205 of file docnode.cpp.

3206{
3207 AUTO_TRACE();
3208 Token retval = Token::make_RetVal_OK();
3209 auto ns = AutoNodeStack(parser(),thisVariant());
3210 DocPara *par=nullptr;
3211 QCString saveCmdName = cmdName;
3212
3213 Token tok=parser()->tokenizer.lex();
3214 if (!tok.is(TokenRetval::TK_WHITESPACE))
3215 {
3216 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\{} command",
3217 saveCmdName);
3218 retval = Token::make_RetVal_EndParBlock();
3219 goto endparamlist;
3220 }
3222 tok=parser()->tokenizer.lex();
3223 while (tok.is(TokenRetval::TK_WORD)) /* there is a parameter name */
3224 {
3226 {
3227 int typeSeparator = parser()->context.token->name.find('#'); // explicit type position
3228 if (typeSeparator!=-1)
3229 {
3230 parser()->handleParameterType(thisVariant(),m_paramTypes,parser()->context.token->name.left(typeSeparator));
3231 parser()->context.token->name = parser()->context.token->name.mid(typeSeparator+1);
3234 if (parent() && std::holds_alternative<DocParamSect>(*parent()))
3235 {
3236 std::get<DocParamSect>(*parent()).m_hasTypeSpecifier=true;
3237 }
3238 }
3239 else
3240 {
3243 }
3244 }
3245 else if (m_type==DocParamSect::RetVal)
3246 {
3249 }
3250 //m_params.append(parser()->context.token->name);
3252 tok=parser()->tokenizer.lex();
3253 }
3255 if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
3256 {
3257 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment block while parsing the "
3258 "argument of command {}",saveCmdName);
3259 retval = Token::make_RetVal_EndParBlock();
3260 goto endparamlist;
3261 }
3262 if (!tok.is(TokenRetval::TK_WHITESPACE)) /* premature end of comment block */
3263 {
3264 if (!tok.is(TokenRetval::TK_NEWPARA)) /* empty param description */
3265 {
3266 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} in comment block while parsing the "
3267 "argument of command {}",tok.to_string(),saveCmdName);
3268 }
3269 retval = Token::make_RetVal_EndParBlock();
3270 goto endparamlist;
3271 }
3272
3273 m_paragraphs.append<DocPara>(parser(),thisVariant());
3274 par = m_paragraphs.get_last<DocPara>();
3275 retval = par->parse();
3276 par->markFirst();
3277 par->markLast();
3278
3279endparamlist:
3280 AUTO_TRACE_EXIT("retval={}",retval.to_string());
3281 return retval;
3282}
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1086
void markFirst(bool v=TRUE)
Definition docnode.h:1085
Token parse()
Definition docnode.cpp:5707
void handleLinkedWord(DocNodeVariant *parent, DocNodeList &children, bool ignoreAutoLinkFlag=FALSE)
DocTokenizer tokenizer
void handleParameterType(DocNodeVariant *parent, DocNodeList &children, const QCString &paramTypes)
void checkRetvalName()
void checkArgumentName()
DocParserContext context
void setStateParam()
void setStatePara()
int find(char c, int index=0, bool cs=TRUE) const
Definition qcstring.cpp:43
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:241
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
bool is_any_of(ARGS... args) const
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
#define TRUE
Definition qcstring.h:37
TokenInfo * token
Definition docparser_p.h:93
QCString name

References AUTO_TRACE, AUTO_TRACE_EXIT, DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, QCString::find(), DocParser::handleLinkedWord(), DocParser::handleParameterType(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, Token::is(), Token::is_any_of(), DocTokenizer::lex(), m_paragraphs, m_params, m_paramTypes, m_type, DocPara::markFirst(), DocPara::markLast(), QCString::mid(), TokenInfo::name, DocParamSect::Param, DocNode::parent(), DocPara::parse(), DocNode::parser(), DocParamSect::RetVal, DocTokenizer::setStatePara(), DocTokenizer::setStateParam(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, TRUE, and warn_doc_error.

◆ parseXml()

Token DocParamList::parseXml ( const QCString & paramName)

Definition at line 3284 of file docnode.cpp.

3285{
3286 AUTO_TRACE();
3287 Token retval = Token::make_RetVal_OK();
3288 auto ns = AutoNodeStack(parser(),thisVariant());
3289
3290 parser()->context.token->name = paramName;
3292 {
3295 }
3296 else if (m_type==DocParamSect::RetVal)
3297 {
3300 }
3301
3303
3304 do
3305 {
3306 m_paragraphs.append<DocPara>(parser(),thisVariant());
3307 DocPara *par = m_paragraphs.get_last<DocPara>();
3308 retval = par->parse();
3309 if (par->isEmpty()) // avoid adding an empty paragraph for the whitespace
3310 // after </para> and before </param>
3311 {
3312 m_paragraphs.pop_back();
3313 break;
3314 }
3315 else // append the paragraph to the list
3316 {
3317 if (!m_paragraphs.empty())
3318 {
3319 m_paragraphs.get_last<DocPara>()->markLast(FALSE);
3320 }
3321 bool markFirst = m_paragraphs.empty();
3322 par = &std::get<DocPara>(m_paragraphs.back());
3323 if (markFirst)
3324 {
3325 par->markFirst();
3326 }
3327 par->markLast();
3328 }
3329
3330 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
3331
3332 } while (retval.is(TokenRetval::RetVal_CloseXml) &&
3333 Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_PARAM &&
3334 Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_TYPEPARAM &&
3335 Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_EXCEPTION);
3336
3337 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) /* premature end of comment block */
3338 {
3339 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unterminated param or exception tag");
3340 }
3341 else
3342 {
3343 retval = Token::make_RetVal_OK();
3344 }
3345
3346 AUTO_TRACE_EXIT("retval={}",retval.to_string());
3347 return retval;
3348}
void markFirst(bool b=TRUE)
Definition docnode.h:1134
void markLast(bool b=TRUE)
Definition docnode.h:1135
const Mapper< HtmlTagType > * htmlTagMapper
#define FALSE
Definition qcstring.h:34

References AUTO_TRACE, AUTO_TRACE_EXIT, DocParser::checkArgumentName(), DocParser::checkRetvalName(), DocParser::context, FALSE, DocParser::handleLinkedWord(), DocParserContext::hasParamCommand, DocParserContext::hasReturnCommand, Mappers::htmlTagMapper, Token::is(), Token::is_any_of(), m_paragraphs, m_params, m_type, markFirst(), markLast(), TokenInfo::name, DocParamSect::Param, DocNode::parser(), DocParamSect::RetVal, DocNode::thisVariant(), Token::to_string(), DocParserContext::token, TRUE, warn_doc_error, XML_EXCEPTION, XML_PARAM, and XML_TYPEPARAM.

◆ type()

DocParamSect::Type DocParamList::type ( ) const
inline

Definition at line 1132 of file docnode.h.

1132{ return m_type; }

References m_type.

Member Data Documentation

◆ m_dir

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

Definition at line 1146 of file docnode.h.

Referenced by direction(), and DocParamList().

◆ m_isFirst

bool DocParamList::m_isFirst = false
private

Definition at line 1147 of file docnode.h.

Referenced by isFirst(), and markFirst().

◆ m_isLast

bool DocParamList::m_isLast = false
private

Definition at line 1148 of file docnode.h.

Referenced by isLast(), and markLast().

◆ m_paragraphs

DocNodeList DocParamList::m_paragraphs
private

Definition at line 1142 of file docnode.h.

Referenced by paragraphs(), parse(), and parseXml().

◆ m_params

DocNodeList DocParamList::m_params
private

Definition at line 1143 of file docnode.h.

Referenced by parameters(), parse(), and parseXml().

◆ m_paramTypes

DocNodeList DocParamList::m_paramTypes
private

Definition at line 1144 of file docnode.h.

Referenced by paramTypes(), and parse().

◆ m_type

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

Definition at line 1145 of file docnode.h.

Referenced by DocParamList(), parse(), parseXml(), and type().


The documentation for this class was generated from the following files: