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

Node representing a simple section. More...

#include <src/docnode.h>

Inheritance diagram for DocSimpleSect:
Collaboration diagram for DocSimpleSect:

Public Types

enum  Type {
  Unknown , See , Return , Author ,
  Authors , Version , Since , Date ,
  Note , Warning , Copyright , Pre ,
  Post , Invar , Remark , Attention ,
  Important , User , Rcs
}

Public Member Functions

 DocSimpleSect (DocParser *parser, DocNodeVariant *parent, Type t)
Type type () const
QCString typeString () const
Token parse (bool userTitle, bool needsSeparator)
Token parseRcs ()
Token parseXml ()
void appendLinkWord (const QCString &word)
bool hasTitle () const
const DocNodeVarianttitle () 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

Type m_type = Unknown
std::unique_ptr< DocNodeVariantm_title

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

Definition at line 1016 of file docnode.h.

Member Enumeration Documentation

◆ Type

Enumerator
Unknown 
See 
Return 
Author 
Authors 
Version 
Since 
Date 
Note 
Warning 
Copyright 
Pre 
Post 
Invar 
Remark 
Attention 
Important 
User 
Rcs 

Definition at line 1019 of file docnode.h.

Constructor & Destructor Documentation

◆ DocSimpleSect()

DocSimpleSect::DocSimpleSect ( DocParser * parser,
DocNodeVariant * parent,
Type t )

Definition at line 3051 of file docnode.cpp.

3051 :
3053{
3054}
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

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

Member Function Documentation

◆ appendLinkWord()

void DocSimpleSect::appendLinkWord ( const QCString & word)

Definition at line 3151 of file docnode.cpp.

3152{
3153 DocPara *p=nullptr;
3154 if (children().empty() || (p=std::get_if<DocPara>(&children().back()))==nullptr)
3155 {
3156 children().append<DocPara>(parser(),thisVariant());
3157 p = children().get_last<DocPara>();
3158 }
3159 else
3160 {
3161 // Comma-separate <seealso> links.
3162 p->injectToken(Token::make_TK_WORD(),",");
3163 p->injectToken(Token::make_TK_WHITESPACE()," ");
3164 }
3165
3167 p->injectToken(Token::make_TK_LNKWORD(),word);
3169}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
bool injectToken(Token tok, const QCString &tokText)
Definition docnode.cpp:4126
DocParserContext context
#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

References DocNodeList::append(), DocCompoundNode::children(), DocParser::context, FALSE, DocNodeList::get_last(), DocPara::injectToken(), DocParserContext::inSeeBlock, DocNode::parser(), DocNode::thisVariant(), and TRUE.

◆ hasTitle()

bool DocSimpleSect::hasTitle ( ) const

Definition at line 3056 of file docnode.cpp.

3057{
3058 return m_title && std::get<DocTitle>(*m_title).hasTitle();
3059}
std::unique_ptr< DocNodeVariant > m_title
Definition docnode.h:1037

References m_title.

Referenced by DocbookDocVisitor::operator()().

◆ parse()

Token DocSimpleSect::parse ( bool userTitle,
bool needsSeparator )

Definition at line 3061 of file docnode.cpp.

3062{
3063 AUTO_TRACE();
3064 auto ns = AutoNodeStack(parser(),thisVariant());
3065
3066 // handle case for user defined title
3067 if (userTitle)
3068 {
3070 std::get_if<DocTitle>(m_title.get())->parse();
3071 }
3072
3073 // add new paragraph as child
3074 if (!children().empty() && std::holds_alternative<DocPara>(children().back()))
3075 {
3076 std::get<DocPara>(children().back()).markLast(FALSE);
3077 }
3078 bool markFirst = children().empty();
3079 if (needsSeparator)
3080 {
3081 children().append<DocSimpleSectSep>(parser(),thisVariant());
3082 }
3083 children().append<DocPara>(parser(),thisVariant());
3084 DocPara *par = children().get_last<DocPara>();
3085 if (markFirst)
3086 {
3087 par->markFirst();
3088 }
3089 par->markLast();
3090
3091 // parse the contents of the paragraph
3092 Token retval = par->parse();
3093
3094 AUTO_TRACE_EXIT("retval={}",retval.to_string());
3095 return retval; // 0==EOF, TokenRetval::TK_NEWPARA, TokenRetval::TK_LISTITEM, TokenRetval::TK_ENDLIST, TokenRetval::RetVal_SimpleSec
3096}
bool empty() const
checks whether the container is empty
Definition growvector.h:140
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
#define AUTO_TRACE(...)
Definition docnode.cpp:46
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:48
std::unique_ptr< DocNodeVariant > createDocNode(Args &&...args)
Definition docnode.h:1495

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), createDocNode(), GrowVector< T >::empty(), FALSE, DocNodeList::get_last(), m_title, DocPara::markLast(), DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

Referenced by DocPara::handleSimpleSection().

◆ parseRcs()

Token DocSimpleSect::parseRcs ( )

Definition at line 3098 of file docnode.cpp.

3099{
3100 AUTO_TRACE();
3101 auto ns = AutoNodeStack(parser(),thisVariant());
3102
3104 DocTitle *title = &std::get<DocTitle>(*m_title);
3105 title->parseFromString(thisVariant(),parser()->context.token->name);
3106
3107 QCString text = parser()->context.token->text;
3108 parser()->pushContext(); // this will create a new parser->context.token
3110 parser()->popContext(); // this will restore the old parser->context.token
3111
3112 return Token::make_RetVal_OK();
3113}
Token internalValidatingParseDoc(DocNodeVariant *parent, DocNodeList &children, const QCString &doc)
void popContext()
Definition docparser.cpp:74
void pushContext()
Definition docparser.cpp:60
const DocNodeVariant * title() const
Definition docnode.h:1033
TokenInfo * token
Definition docparser_p.h:93
QCString text

References AUTO_TRACE, DocCompoundNode::children(), DocParser::context, createDocNode(), DocParser::internalValidatingParseDoc(), m_title, DocNode::parser(), DocParser::popContext(), DocParser::pushContext(), TokenInfo::text, DocNode::thisVariant(), title(), and DocParserContext::token.

◆ parseXml()

Token DocSimpleSect::parseXml ( )

Definition at line 3115 of file docnode.cpp.

3116{
3117 AUTO_TRACE();
3118 auto ns = AutoNodeStack(parser(),thisVariant());
3119
3120 Token retval = Token::make_RetVal_OK();
3121 for (;;)
3122 {
3123 // add new paragraph as child
3124 if (!children().empty() && std::holds_alternative<DocPara>(children().back()))
3125 {
3126 std::get<DocPara>(children().back()).markLast(false);
3127 }
3128 bool markFirst = children().empty();
3129 children().append<DocPara>(parser(),thisVariant());
3130 DocPara *par = children().get_last<DocPara>();
3131 if (markFirst)
3132 {
3133 par->markFirst();
3134 }
3135 par->markLast();
3136
3137 // parse the contents of the paragraph
3138 retval = par->parse();
3139 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
3140 if (retval.is(TokenRetval::RetVal_CloseXml))
3141 {
3142 retval = Token::make_RetVal_OK();
3143 break;
3144 }
3145 }
3146
3147 AUTO_TRACE_EXIT("retval={}",retval.to_string());
3148 return retval;
3149}
bool is(TokenRetval rv) const
bool is_any_of(ARGS... args) const

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), GrowVector< T >::empty(), DocNodeList::get_last(), Token::is(), Token::is_any_of(), DocPara::markLast(), DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

Referenced by DocPara::handleSimpleSection().

◆ title()

◆ type()

◆ typeString()

QCString DocSimpleSect::typeString ( ) const

Definition at line 3171 of file docnode.cpp.

3172{
3173 switch (m_type)
3174 {
3175 case Unknown: break;
3176 case See: return "see";
3177 case Return: return "return";
3178 case Author: // fall through
3179 case Authors: return "author";
3180 case Version: return "version";
3181 case Since: return "since";
3182 case Date: return "date";
3183 case Note: return "note";
3184 case Warning: return "warning";
3185 case Pre: return "pre";
3186 case Post: return "post";
3187 case Copyright: return "copyright";
3188 case Invar: return "invariant";
3189 case Remark: return "remark";
3190 case Attention: return "attention";
3191 case Important: return "important";
3192 case User: return "user";
3193 case Rcs: return "rcs";
3194 }
3195 return "unknown";
3196}

References Attention, Author, Authors, Copyright, Date, Important, Invar, m_type, Note, Post, Pre, Rcs, Remark, Return, See, Since, Unknown, User, Version, and Warning.

Referenced by HtmlDocVisitor::operator()().

Member Data Documentation

◆ m_title

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

Definition at line 1037 of file docnode.h.

Referenced by hasTitle(), parse(), parseRcs(), and title().

◆ m_type

Type DocSimpleSect::m_type = Unknown
private

Definition at line 1036 of file docnode.h.

Referenced by DocSimpleSect(), type(), and typeString().


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