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

Root node of documentation tree. More...

#include <src/docnode.h>

Inheritance diagram for DocRoot:
Collaboration diagram for DocRoot:

Public Member Functions

 DocRoot (DocParser *parser, bool indent, bool sl)
void parse ()
bool indent () const
bool singleLine () const
bool isEmpty () const
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
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

bool m_indent = false
bool m_singleLine = 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

Root node of documentation tree.

Definition at line 1312 of file docnode.h.

Constructor & Destructor Documentation

◆ DocRoot()

DocRoot::DocRoot ( DocParser * parser,
bool indent,
bool sl )
inline

Definition at line 1315 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
bool indent() const
Definition docnode.h:1318
bool m_singleLine
Definition docnode.h:1324
bool m_indent
Definition docnode.h:1323

References DocCompoundNode::DocCompoundNode(), indent(), m_indent, m_singleLine, and DocNode::parser().

Member Function Documentation

◆ indent()

bool DocRoot::indent ( ) const
inline

Definition at line 1318 of file docnode.h.

1318{ return m_indent; }

References m_indent.

Referenced by DocRoot(), and RTFDocVisitor::operator()().

◆ isEmpty()

bool DocRoot::isEmpty ( ) const
inline

Definition at line 1320 of file docnode.h.

1320{ return children().empty(); }
DocNodeList & children()
Definition docnode.h:143
bool empty() const
checks whether the container is empty
Definition growvector.h:140

References DocCompoundNode::children(), and GrowVector< T >::empty().

◆ parse()

void DocRoot::parse ( )

Definition at line 6303 of file docnode.cpp.

6304{
6305 AUTO_TRACE();
6306 auto ns = AutoNodeStack(parser(),thisVariant());
6308 Token retval = Token::make_TK_NONE();
6309
6310 // first parse any number of paragraphs
6311 bool isFirst=TRUE;
6312 DocPara *lastPar = nullptr;
6313 do
6314 {
6315 {
6316 children().append<DocPara>(parser(),thisVariant());
6317 DocPara *par = children().get_last<DocPara>();
6318 if (isFirst) { par->markFirst(); isFirst=FALSE; }
6319 retval=par->parse();
6320 if (par->isEmpty() && par->attribs().empty())
6321 {
6322 children().pop_back();
6323 }
6324 else
6325 {
6326 lastPar = par;
6327 }
6328 }
6329 auto checkParagraph = [this,&retval](Token t,int level,const char *sectionType,const char *parentSectionType) {
6330 if (retval == t)
6331 {
6332 if (!AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6333 {
6334 warn_doc_error(parser()->context.fileName,
6335 parser()->tokenizer.getLineNr(),
6336 "found {} command (id: '{}') outside of {} context!",
6337 sectionType,parser()->context.token->sectionId,parentSectionType);
6338 }
6339 while (retval==t)
6340 {
6341 if (!parser()->context.token->sectionId.isEmpty())
6342 {
6343 const SectionInfo *sec=SectionManager::instance().find(parser()->context.token->sectionId);
6344 if (sec)
6345 {
6346 children().append<DocSection>(parser(),thisVariant(),
6347 level,
6349 retval = children().get_last<DocSection>()->parse();
6350 }
6351 else
6352 {
6353 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Invalid {} id '{}'; ignoring {}",
6354 sectionType,parser()->context.token->sectionId,sectionType);
6355 retval = Token::make_TK_NONE();
6356 }
6357 }
6358 else
6359 {
6360 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Missing id for {}; ignoring {}",sectionType,sectionType);
6361 retval = Token::make_TK_NONE();
6362 }
6363 }
6364 }
6365 };
6366 checkParagraph(Token::make_RetVal_SubSubParagraph(), 6, "subsubparagraph", "subparagraph" );
6367 checkParagraph(Token::make_RetVal_SubParagraph(), 5, "subparagraph", "paragraph" );
6368 checkParagraph(Token::make_RetVal_Paragraph(), 4, "paragraph", "subsubsection" );
6369 checkParagraph(Token::make_RetVal_Subsubsection(), 3, "subsubsection", "subsection" );
6370 checkParagraph(Token::make_RetVal_Subsection(), 2, "subsection", "section" );
6371
6372 if (retval.is(TokenRetval::TK_LISTITEM))
6373 {
6374 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Invalid list item found");
6375 }
6376 if (retval.is(TokenRetval::RetVal_Internal))
6377 {
6378 children().append<DocInternal>(parser(),thisVariant());
6379 retval = children().get_last<DocInternal>()->parse(1);
6380 }
6381 } while (!retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF,TokenRetval::RetVal_Section));
6382 if (lastPar) lastPar->markLast();
6383
6384 //printf("DocRoot::parse() retval=%d %d\n",retval,TokenRetval::RetVal_Section);
6385 // then parse any number of level1 sections
6386 while (retval.is(TokenRetval::RetVal_Section))
6387 {
6388 if (!parser()->context.token->sectionId.isEmpty())
6389 {
6390 const SectionInfo *sec=SectionManager::instance().find(parser()->context.token->sectionId);
6391 if (sec)
6392 {
6393 children().append<DocSection>(parser(),thisVariant(),
6394 1,
6396 retval = children().get_last<DocSection>()->parse();
6397 }
6398 else
6399 {
6400 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Invalid section id '{}'; ignoring section",parser()->context.token->sectionId);
6401 retval = Token::make_TK_NONE();
6402 }
6403 }
6404 else
6405 {
6406 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Missing id for section; ignoring section");
6407 retval = Token::make_TK_NONE();
6408 }
6409 }
6410
6412}
static AnchorGenerator & instance()
Returns the singleton instance.
Definition anchor.cpp:38
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1086
DocTokenizer tokenizer
DocParserContext context
void handleUnclosedStyleCommands()
void parse()
Definition docnode.cpp:6303
void setStatePara()
void pop_back()
removes the last element
Definition growvector.h:115
const T * find(const std::string &key) const
Definition linkedmap.h:47
static SectionManager & instance()
returns a reference to the singleton
Definition section.h:178
bool is(TokenRetval rv) const
bool is_any_of(ARGS... args) const
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
#define TRUE
Definition qcstring.h:37
#define FALSE
Definition qcstring.h:34
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1410
TokenInfo * token
Definition docparser_p.h:93
QCString sectionId

References DocNodeList::append(), AUTO_TRACE, DocCompoundNode::children(), DocParser::context, FALSE, LinkedMap< T, Hash, KeyEqual, Map >::find(), DocNodeList::get_last(), DocParser::handleUnclosedStyleCommands(), AnchorGenerator::instance(), SectionManager::instance(), Token::is(), Token::is_any_of(), DocPara::markLast(), parse(), DocNode::parser(), GrowVector< T >::pop_back(), TokenInfo::sectionId, DocTokenizer::setStatePara(), DocNode::thisVariant(), DocParserContext::token, DocParser::tokenizer, TRUE, and warn_doc_error.

Referenced by parse().

◆ singleLine()

bool DocRoot::singleLine ( ) const
inline

Definition at line 1319 of file docnode.h.

1319{ return m_singleLine; }

References m_singleLine.

Referenced by RTFDocVisitor::operator()().

Member Data Documentation

◆ m_indent

bool DocRoot::m_indent = false
private

Definition at line 1323 of file docnode.h.

Referenced by DocRoot(), and indent().

◆ m_singleLine

bool DocRoot::m_singleLine = false
private

Definition at line 1324 of file docnode.h.

Referenced by DocRoot(), and singleLine().


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