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 DocNodeList &	parameters () const
const DocNodeList &	paramTypes () const
const DocNodeList &	paragraphs () 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
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () 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 1118 of file docnode.h.

Constructor & Destructor Documentation

DocParamList()

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

inline

Definition at line 1121 of file docnode.h.

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

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

Member Function Documentation

direction()

DocParamSect::Direction DocParamList::direction ( ) const

inline

Definition at line 1127 of file docnode.h.

{ return m_dir; }

References m_dir.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

isFirst()

bool DocParamList::isFirst ( ) const

inline

Definition at line 1130 of file docnode.h.

{ return m_isFirst; }

References m_isFirst.

isLast()

bool DocParamList::isLast ( ) const

inline

Definition at line 1131 of file docnode.h.

{ return m_isLast; }

References m_isLast.

Referenced by ManDocVisitor::operator()().

markFirst()

void DocParamList::markFirst ( bool b = TRUE )

inline

Definition at line 1128 of file docnode.h.

{ m_isFirst=b; }

References m_isFirst, and TRUE.

Referenced by parseXml().

markLast()

void DocParamList::markLast ( bool b = TRUE )

inline

Definition at line 1129 of file docnode.h.

{ m_isLast=b; }

References m_isLast, and TRUE.

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

paragraphs()

const DocNodeList & DocParamList::paragraphs ( ) const

inline

Definition at line 1125 of file docnode.h.

{ return m_paragraphs; }

References m_paragraphs.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

parameters()

const DocNodeList & DocParamList::parameters ( ) const

inline

Definition at line 1123 of file docnode.h.

{ return m_params; }

References m_params.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), ManDocVisitor::operator()(), PerlModDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

paramTypes()

const DocNodeList & DocParamList::paramTypes ( ) const

inline

Definition at line 1124 of file docnode.h.

{ return m_paramTypes; }

References m_paramTypes.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

parse()

Token DocParamList::parse

(

const QCString &

cmdName

)

Definition at line 3046 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
  DocPara *par=nullptr;
  QCString saveCmdName = cmdName;
 
  Token tok=parser()->tokenizer.lex();
  if (!tok.is(TokenRetval::TK_WHITESPACE))
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\{} command",
        saveCmdName);
    retval = Token::make_RetVal_EndParBlock();
    goto endparamlist;
  }
  parser()->tokenizer.setStateParam();
  tok=parser()->tokenizer.lex();
  while (tok.is(TokenRetval::TK_WORD)) /* there is a parameter name */
  {
    if (m_type==DocParamSect::Param)
    {
      int typeSeparator = parser()->context.token->name.find('#'); // explicit type position
      if (typeSeparator!=-1)
      {
        parser()->handleParameterType(thisVariant(),m_paramTypes,parser()->context.token->name.left(typeSeparator));
        parser()->context.token->name = parser()->context.token->name.mid(typeSeparator+1);
        parser()->context.hasParamCommand=TRUE;
        parser()->checkArgumentName();
        if (parent() && std::holds_alternative<DocParamSect>(*parent()))
        {
          std::get<DocParamSect>(*parent()).m_hasTypeSpecifier=true;
        }
      }
      else
      {
        parser()->context.hasParamCommand=TRUE;
        parser()->checkArgumentName();
      }
    }
    else if (m_type==DocParamSect::RetVal)
    {
      parser()->context.hasReturnCommand=TRUE;
      parser()->checkRetvalName();
    }
    //m_params.append(parser()->context.token->name);
    parser()->handleLinkedWord(thisVariant(),m_params);
    tok=parser()->tokenizer.lex();
  }
  parser()->tokenizer.setStatePara();
  if (tok.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) // premature end of comment
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected end of comment block while parsing the "
        "argument of command {}",saveCmdName);
    retval = Token::make_RetVal_EndParBlock();
    goto endparamlist;
  }
  if (!tok.is(TokenRetval::TK_WHITESPACE)) /* premature end of comment block */
  {
    if (!tok.is(TokenRetval::TK_NEWPARA)) /* empty param description */
    {
      warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} in comment block while parsing the "
          "argument of command {}",tok.to_string(),saveCmdName);
    }
    retval = Token::make_RetVal_EndParBlock();
    goto endparamlist;
  }
 
  m_paragraphs.append<DocPara>(parser(),thisVariant());
  par = m_paragraphs.get_last<DocPara>();
  retval = par->parse();
  par->markFirst();
  par->markLast();
 
endparamlist:
  AUTO_TRACE_EXIT("retval={}",retval.to_string());
  return retval;
}

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 3125 of file docnode.cpp.

{
  AUTO_TRACE();
  Token retval = Token::make_RetVal_OK();
  auto ns = AutoNodeStack(parser(),thisVariant());
 
  parser()->context.token->name = paramName;
  if (m_type==DocParamSect::Param)
  {
    parser()->context.hasParamCommand=TRUE;
    parser()->checkArgumentName();
  }
  else if (m_type==DocParamSect::RetVal)
  {
    parser()->context.hasReturnCommand=TRUE;
    parser()->checkRetvalName();
  }
 
  parser()->handleLinkedWord(thisVariant(),m_params);
 
  do
  {
    m_paragraphs.append<DocPara>(parser(),thisVariant());
    DocPara *par =  m_paragraphs.get_last<DocPara>();
    retval = par->parse();
    if (par->isEmpty()) // avoid adding an empty paragraph for the whitespace
                        // after </para> and before </param>
    {
      m_paragraphs.pop_back();
      break;
    }
    else // append the paragraph to the list
    {
      if (!m_paragraphs.empty())
      {
        m_paragraphs.get_last<DocPara>()->markLast(FALSE);
      }
      bool markFirst = m_paragraphs.empty();
      par = &std::get<DocPara>(m_paragraphs.back());
      if (markFirst)
      {
        par->markFirst();
      }
      par->markLast();
    }
 
    if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
 
  } while (retval.is(TokenRetval::RetVal_CloseXml) &&
           Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_PARAM &&
           Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_TYPEPARAM &&
           Mappers::htmlTagMapper->map(parser()->context.token->name)!=HtmlTagType::XML_EXCEPTION);
 
  if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) /* premature end of comment block */
  {
    warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unterminated param or exception tag");
  }
  else
  {
    retval = Token::make_RetVal_OK();
  }
 
  AUTO_TRACE_EXIT("retval={}",retval.to_string());
  return retval;
}

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 1126 of file docnode.h.

{ return m_type; }

References m_type.

Member Data Documentation

m_dir

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

private

Definition at line 1140 of file docnode.h.

Referenced by direction(), and DocParamList().

m_isFirst

bool DocParamList::m_isFirst = false

private

Definition at line 1141 of file docnode.h.

Referenced by isFirst(), and markFirst().

m_isLast

bool DocParamList::m_isLast = false

private

Definition at line 1142 of file docnode.h.

Referenced by isLast(), and markLast().

m_paragraphs

DocNodeList DocParamList::m_paragraphs

private

Definition at line 1136 of file docnode.h.

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

m_params

DocNodeList DocParamList::m_params

private

Definition at line 1137 of file docnode.h.

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

m_paramTypes

DocNodeList DocParamList::m_paramTypes

private

Definition at line 1138 of file docnode.h.

Referenced by paramTypes(), and parse().

m_type

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

private

Definition at line 1139 of file docnode.h.

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

---

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

• src/docnode.h
• src/docnode.cpp