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

Node representing a normal section. More...

#include <src/docnode.h>

Inheritance diagram for DocSection:
Collaboration diagram for DocSection:

Public Member Functions

 DocSection (DocParser *parser, DocNodeVariant *parent, int level, const QCString &id)
int level () const
const DocNodeVarianttitle () const
QCString anchor () const
QCString id () const
QCString file () const
Token parse ()
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

int m_level = 0
QCString m_id
std::unique_ptr< DocNodeVariantm_title
QCString m_anchor
QCString m_file

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 normal section.

Definition at line 913 of file docnode.h.

Constructor & Destructor Documentation

◆ DocSection()

DocSection::DocSection ( DocParser * parser,
DocNodeVariant * parent,
int level,
const QCString & id )
inline

Definition at line 916 of file docnode.h.

916 :
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90
QCString m_id
Definition docnode.h:927
int level() const
Definition docnode.h:918
int m_level
Definition docnode.h:926

References DocCompoundNode::DocCompoundNode(), id(), level(), m_id, m_level, DocNode::parent(), and DocNode::parser().

Referenced by parse().

Member Function Documentation

◆ anchor()

QCString DocSection::anchor ( ) const
inline

◆ file()

QCString DocSection::file ( ) const
inline

Definition at line 922 of file docnode.h.

922{ return m_file; }
QCString m_file
Definition docnode.h:930

References m_file.

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

◆ id()

QCString DocSection::id ( ) const
inline

Definition at line 921 of file docnode.h.

921{ return m_id; }

References m_id.

Referenced by DocSection().

◆ level()

◆ parse()

Token DocSection::parse ( )

Definition at line 6012 of file docnode.cpp.

6013{
6014 AUTO_TRACE("start {} level={}", parser()->context.token->sectionId, m_level);
6015 Token retval = Token::make_RetVal_OK();
6016 auto ns = AutoNodeStack(parser(),thisVariant());
6017
6018 if (!m_id.isEmpty())
6019 {
6020 const SectionInfo *sec = SectionManager::instance().find(m_id);
6021 if (sec)
6022 {
6023 m_file = sec->fileName();
6024 m_anchor = sec->label();
6025 QCString titleStr = sec->title();
6026 if (titleStr.isEmpty()) titleStr = sec->label();
6028 DocTitle *title = &std::get<DocTitle>(*m_title);
6029 title->parseFromString(thisVariant(),titleStr);
6030 }
6031 }
6032
6033 // first parse any number of paragraphs
6034 bool isFirst=TRUE;
6035 DocPara *lastPar=nullptr;
6036 do
6037 {
6038 children().append<DocPara>(parser(),thisVariant());
6039 DocPara *par = children().get_last<DocPara>();
6040 if (isFirst) { par->markFirst(); isFirst=FALSE; }
6041 retval=par->parse();
6042 if (!par->isEmpty())
6043 {
6044 if (lastPar) lastPar->markLast(FALSE);
6045 lastPar = par;
6046 }
6047 else
6048 {
6049 children().pop_back();
6050 }
6051 if (retval.is(TokenRetval::TK_LISTITEM))
6052 {
6053 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Invalid list item found");
6054 }
6055 if (retval.is(TokenRetval::RetVal_Internal))
6056 {
6057 children().append<DocInternal>(parser(),thisVariant());
6058 retval = children().get_last<DocInternal>()->parse(m_level+1);
6059 if (retval.is(TokenRetval::RetVal_EndInternal))
6060 {
6061 retval = Token::make_RetVal_OK();
6062 }
6063 }
6064 } while (!retval.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF, TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6065 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph,
6066 TokenRetval::RetVal_SubSubParagraph, TokenRetval::RetVal_EndInternal)
6067 );
6068
6069 if (lastPar) lastPar->markLast();
6070
6071 while (true)
6072 {
6073 if (retval.is(TokenRetval::RetVal_Subsection) && m_level<=1)
6074 {
6075 // then parse any number of nested sections
6076 while (retval.is(TokenRetval::RetVal_Subsection)) // more sections follow
6077 {
6079 2,
6081 retval = children().get_last<DocSection>()->parse();
6082 }
6083 break;
6084 }
6085 else if (retval.is(TokenRetval::RetVal_Subsubsection) && m_level<=2)
6086 {
6087 if ((m_level <= 1) &&
6088 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6089 {
6090 warn_doc_error(parser()->context.fileName,
6091 parser()->tokenizer.getLineNr(),
6092 "Unexpected subsubsection command found inside {}!",
6094 }
6095 // then parse any number of nested sections
6096 while (retval.is(TokenRetval::RetVal_Subsubsection)) // more sections follow
6097 {
6099 3,
6101 retval = children().get_last<DocSection>()->parse();
6102 }
6103 if (!(m_level < 2 && retval.is(TokenRetval::RetVal_Subsection))) break;
6104 }
6105 else if (retval.is(TokenRetval::RetVal_Paragraph) && m_level<=3)
6106 {
6107 if ((m_level <= 2) &&
6108 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6109 {
6110 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6111 "Unexpected paragraph command found inside {}!",
6113 }
6114 // then parse any number of nested sections
6115 while (retval.is(TokenRetval::RetVal_Paragraph)) // more sections follow
6116 {
6118 4,
6120 retval = children().get_last<DocSection>()->parse();
6121 }
6122 if (!(m_level<3 && (retval.is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection)))) break;
6123 }
6124 else if (retval.is(TokenRetval::RetVal_SubParagraph) && m_level<=4)
6125 {
6126 if ((m_level <= 3) &&
6127 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6128 {
6129 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6130 "Unexpected subparagraph command found inside {}!",
6132 }
6133 // then parse any number of nested sections
6134 while (retval.is(TokenRetval::RetVal_SubParagraph)) // more sections follow
6135 {
6137 5,
6139 retval = children().get_last<DocSection>()->parse();
6140 }
6141 if (!(m_level<4 && (retval.is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection,TokenRetval::RetVal_Paragraph)))) break;
6142 }
6143 else if (retval.is(TokenRetval::RetVal_SubSubParagraph) && m_level<=5)
6144 {
6145 if ((m_level <= 4) &&
6146 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6147 {
6148 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6149 "Unexpected subsubparagraph command found inside {}!",
6151 }
6152 // then parse any number of nested sections
6153 while (retval.is(TokenRetval::RetVal_SubSubParagraph)) // more sections follow
6154 {
6156 6,
6158 retval = children().get_last<DocSection>()->parse();
6159 }
6160 if (!(m_level<5 && (retval.is_any_of( TokenRetval::RetVal_Subsection, TokenRetval::RetVal_Subsubsection,
6161 TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph)))) break;
6162 }
6163 else
6164 {
6165 break;
6166 }
6167 }
6168
6169 INTERNAL_ASSERT(retval.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF,
6170 TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6171 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph,
6172 TokenRetval::RetVal_SubParagraph, TokenRetval::RetVal_SubSubParagraph,
6173 TokenRetval::RetVal_Internal, TokenRetval::RetVal_EndInternal)
6174 );
6175
6176 AUTO_TRACE_EXIT("retval={}", retval.to_string());
6177 return retval;
6178}
static AnchorGenerator & instance()
Returns the singleton instance.
Definition anchor.cpp:38
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1086
DocParserContext context
std::unique_ptr< DocNodeVariant > m_title
Definition docnode.h:928
Token parse()
Definition docnode.cpp:6012
DocSection(DocParser *parser, DocNodeVariant *parent, int level, const QCString &id)
Definition docnode.h:916
const DocNodeVariant * title() const
Definition docnode.h:919
void pop_back()
removes the last element
Definition growvector.h:115
const T * find(const std::string &key) const
Definition linkedmap.h:47
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
QCString label() const
Definition section.h:68
QCString fileName() const
Definition section.h:73
QCString title() const
Definition section.h:69
static SectionManager & instance()
returns a reference to the singleton
Definition section.h:178
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
bool is_any_of(ARGS... args) const
static const char * g_sectionLevelToName[]
Definition docnode.cpp:56
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define INTERNAL_ASSERT(x)
Definition docnode.cpp:51
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
std::unique_ptr< DocNodeVariant > createDocNode(Args &&...args)
Definition docnode.h:1495
#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, AUTO_TRACE_EXIT, DocCompoundNode::children(), DocParser::context, createDocNode(), DocSection(), FALSE, SectionInfo::fileName(), LinkedMap< T, Hash, KeyEqual, Map >::find(), g_sectionLevelToName, DocNodeList::get_last(), AnchorGenerator::instance(), SectionManager::instance(), INTERNAL_ASSERT, Token::is(), Token::is_any_of(), QCString::isEmpty(), SectionInfo::label(), m_anchor, m_file, m_id, m_level, m_title, DocPara::markLast(), parse(), DocNode::parser(), GrowVector< T >::pop_back(), TokenInfo::sectionId, DocNode::thisVariant(), title(), SectionInfo::title(), Token::to_string(), DocParserContext::token, TRUE, and warn_doc_error.

Referenced by parse().

◆ title()

Member Data Documentation

◆ m_anchor

QCString DocSection::m_anchor
private

Definition at line 929 of file docnode.h.

Referenced by anchor(), and parse().

◆ m_file

QCString DocSection::m_file
private

Definition at line 930 of file docnode.h.

Referenced by file(), and parse().

◆ m_id

QCString DocSection::m_id
private

Definition at line 927 of file docnode.h.

Referenced by DocSection(), id(), and parse().

◆ m_level

int DocSection::m_level = 0
private

Definition at line 926 of file docnode.h.

Referenced by DocSection(), level(), and parse().

◆ m_title

std::unique_ptr<DocNodeVariant> DocSection::m_title
private

Definition at line 928 of file docnode.h.

Referenced by parse(), and title().


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