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

Node representing an block of paragraphs. More...

#include <src/docnode.h>

Inheritance diagram for DocParBlock:
Collaboration diagram for DocParBlock:

Public Member Functions

 DocParBlock (DocParser *parser, DocNodeVariant *parent)
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

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType {
  Unknown , Anchor , Section , Table ,
  Requirement
}
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing an block of paragraphs.

Definition at line 987 of file docnode.h.

Constructor & Destructor Documentation

◆ DocParBlock()

DocParBlock::DocParBlock ( DocParser * parser,
DocNodeVariant * parent )
inline

Definition at line 990 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98
DocNodeVariant * parent()
Definition docnode.h:90

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

Member Function Documentation

◆ parse()

Token DocParBlock::parse ( )

Definition at line 2956 of file docnode.cpp.

2957{
2958 AUTO_TRACE();
2959 Token retval = Token::make_TK_NONE();
2960 auto ns = AutoNodeStack(parser(),thisVariant());
2961
2962 // parse one or more paragraphs
2963 bool isFirst=TRUE;
2964 DocPara *par=nullptr;
2965 do
2966 {
2967 children().append<DocPara>(parser(),thisVariant());
2968 par = children().get_last<DocPara>();
2969 if (isFirst) { par->markFirst(); isFirst=FALSE; }
2970 retval=par->parse();
2971 }
2972 while (retval.is(TokenRetval::TK_NEWPARA));
2973 if (par) par->markLast();
2974
2975 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2976 return retval.is(TokenRetval::RetVal_EndBlockQuote) ? Token::make_RetVal_OK() : retval;
2977}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:93
void markLast(bool v=TRUE)
Definition docnode.h:1095
void markFirst(bool v=TRUE)
Definition docnode.h:1094
Token parse()
Definition docnode.cpp:5784
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
#define AUTO_TRACE(...)
Definition docnode.cpp:48
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:50
#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:1405
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1416

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), FALSE, DocNodeList::get_last(), Token::is(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), Token::to_string(), and TRUE.


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