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

6020{
6021 AUTO_TRACE("start {} level={}", parser()->context.token->sectionId, m_level);
6022 Token retval = Token::make_RetVal_OK();
6023 auto ns = AutoNodeStack(parser(),thisVariant());
6024
6025 if (!m_id.isEmpty())
6026 {
6027 const SectionInfo *sec = SectionManager::instance().find(m_id);
6028 if (sec)
6029 {
6030 m_file = sec->fileName();
6031 m_anchor = sec->label();
6032 QCString titleStr = sec->title();
6033 if (titleStr.isEmpty()) titleStr = sec->label();
6035 DocTitle *title = &std::get<DocTitle>(*m_title);
6036 title->parseFromString(thisVariant(),titleStr);
6037 }
6038 }
6039
6040 // first parse any number of paragraphs
6041 bool isFirst=TRUE;
6042 DocPara *lastPar=nullptr;
6043 do
6044 {
6045 children().append<DocPara>(parser(),thisVariant());
6046 DocPara *par = children().get_last<DocPara>();
6047 if (isFirst) { par->markFirst(); isFirst=FALSE; }
6048 retval=par->parse();
6049 if (!par->isEmpty())
6050 {
6051 if (lastPar) lastPar->markLast(FALSE);
6052 lastPar = par;
6053 }
6054 else
6055 {
6056 children().pop_back();
6057 }
6058 if (retval.is(TokenRetval::TK_LISTITEM))
6059 {
6060 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Invalid list item found");
6061 }
6062 if (retval.is(TokenRetval::RetVal_Internal))
6063 {
6064 children().append<DocInternal>(parser(),thisVariant());
6065 retval = children().get_last<DocInternal>()->parse(m_level+1);
6066 if (retval.is(TokenRetval::RetVal_EndInternal))
6067 {
6068 retval = Token::make_RetVal_OK();
6069 }
6070 }
6071 } while (!retval.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF, TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6072 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph,
6073 TokenRetval::RetVal_SubSubParagraph, TokenRetval::RetVal_EndInternal)
6074 );
6075
6076 if (lastPar) lastPar->markLast();
6077
6078 while (true)
6079 {
6080 if (retval.is(TokenRetval::RetVal_Subsection) && m_level<=1)
6081 {
6082 // then parse any number of nested sections
6083 while (retval.is(TokenRetval::RetVal_Subsection)) // more sections follow
6084 {
6086 2,
6088 retval = children().get_last<DocSection>()->parse();
6089 }
6090 break;
6091 }
6092 else if (retval.is(TokenRetval::RetVal_Subsubsection) && m_level<=2)
6093 {
6094 if ((m_level <= 1) &&
6095 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6096 {
6097 warn_doc_error(parser()->context.fileName,
6098 parser()->tokenizer.getLineNr(),
6099 "Unexpected subsubsection command found inside {}!",
6101 }
6102 // then parse any number of nested sections
6103 while (retval.is(TokenRetval::RetVal_Subsubsection)) // more sections follow
6104 {
6106 3,
6108 retval = children().get_last<DocSection>()->parse();
6109 }
6110 if (!(m_level < 2 && retval.is(TokenRetval::RetVal_Subsection))) break;
6111 }
6112 else if (retval.is(TokenRetval::RetVal_Paragraph) && m_level<=3)
6113 {
6114 if ((m_level <= 2) &&
6115 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6116 {
6117 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6118 "Unexpected paragraph command found inside {}!",
6120 }
6121 // then parse any number of nested sections
6122 while (retval.is(TokenRetval::RetVal_Paragraph)) // more sections follow
6123 {
6125 4,
6127 retval = children().get_last<DocSection>()->parse();
6128 }
6129 if (!(m_level<3 && (retval.is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection)))) break;
6130 }
6131 else if (retval.is(TokenRetval::RetVal_SubParagraph) && m_level<=4)
6132 {
6133 if ((m_level <= 3) &&
6134 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6135 {
6136 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6137 "Unexpected subparagraph command found inside {}!",
6139 }
6140 // then parse any number of nested sections
6141 while (retval.is(TokenRetval::RetVal_SubParagraph)) // more sections follow
6142 {
6144 5,
6146 retval = children().get_last<DocSection>()->parse();
6147 }
6148 if (!(m_level<4 && (retval.is_any_of(TokenRetval::RetVal_Subsection,TokenRetval::RetVal_Subsubsection,TokenRetval::RetVal_Paragraph)))) break;
6149 }
6150 else if (retval.is(TokenRetval::RetVal_SubSubParagraph) && m_level<=5)
6151 {
6152 if ((m_level <= 4) &&
6153 !AnchorGenerator::instance().isGenerated(parser()->context.token->sectionId.str()))
6154 {
6155 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),
6156 "Unexpected subsubparagraph command found inside {}!",
6158 }
6159 // then parse any number of nested sections
6160 while (retval.is(TokenRetval::RetVal_SubSubParagraph)) // more sections follow
6161 {
6163 6,
6165 retval = children().get_last<DocSection>()->parse();
6166 }
6167 if (!(m_level<5 && (retval.is_any_of( TokenRetval::RetVal_Subsection, TokenRetval::RetVal_Subsubsection,
6168 TokenRetval::RetVal_Paragraph, TokenRetval::RetVal_SubParagraph)))) break;
6169 }
6170 else
6171 {
6172 break;
6173 }
6174 }
6175
6176 INTERNAL_ASSERT(retval.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF,
6177 TokenRetval::RetVal_Section, TokenRetval::RetVal_Subsection,
6178 TokenRetval::RetVal_Subsubsection, TokenRetval::RetVal_Paragraph,
6179 TokenRetval::RetVal_SubParagraph, TokenRetval::RetVal_SubSubParagraph,
6180 TokenRetval::RetVal_Internal, TokenRetval::RetVal_EndInternal)
6181 );
6182
6183 AUTO_TRACE_EXIT("retval={}", retval.to_string());
6184 return retval;
6185}
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:6019
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: