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

Root node of a text fragment. More...

#include <src/docnode.h>

Inheritance diagram for DocText:
Collaboration diagram for DocText:

Public Member Functions

 DocText (DocParser *parser)
void parse ()
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

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 a text fragment.

Definition at line 1303 of file docnode.h.

Constructor & Destructor Documentation

◆ DocText()

DocText::DocText ( DocParser * parser)
inline

Definition at line 1306 of file docnode.h.

1306: DocCompoundNode(parser,nullptr) {}
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:98

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

Member Function Documentation

◆ isEmpty()

bool DocText::isEmpty ( ) const
inline

Definition at line 1308 of file docnode.h.

1308{ 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 DocText::parse ( )

Definition at line 6135 of file docnode.cpp.

6136{
6137 AUTO_TRACE();
6138 auto ns = AutoNodeStack(parser(),thisVariant());
6140
6141 Token tok = parser()->tokenizer.lex();
6142 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF)) // get the next token
6143 {
6144 switch(tok.value())
6145 {
6146 case TokenRetval::TK_WORD:
6148 break;
6149 case TokenRetval::TK_WHITESPACE:
6150 children().append<DocWhiteSpace>(parser(),thisVariant(),parser()->context.token->chars);
6151 break;
6152 case TokenRetval::TK_SYMBOL:
6153 {
6154 HtmlEntityMapper::SymType s = DocSymbol::decodeSymbol(parser()->context.token->name);
6156 {
6157 children().append<DocSymbol>(parser(),thisVariant(),s);
6158 }
6159 else
6160 {
6161 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found",
6162 parser()->context.token->name);
6163 }
6164 }
6165 break;
6166 case TokenRetval::TK_COMMAND_AT:
6167 // fall through
6168 case TokenRetval::TK_COMMAND_BS:
6169 switch (Mappers::cmdMapper->map(parser()->context.token->name))
6170 {
6173 break;
6176 break;
6179 break;
6182 break;
6185 break;
6188 break;
6191 break;
6194 break;
6197 break;
6201 break;
6206 break;
6209 break;
6212 break;
6215 break;
6218 break;
6221 break;
6224 break;
6227 break;
6228 default:
6229 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected command '{}' found",
6230 parser()->context.token->name);
6231 break;
6232 }
6233 break;
6234 default:
6235 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",
6236 tok.to_string());
6237 break;
6238 }
6239 tok = parser()->tokenizer.lex();
6240 }
6241
6243
6244}
DocNodeVariant * thisVariant()
Definition docnode.h:93
DocTokenizer tokenizer
DocParserContext context
void handleUnclosedStyleCommands()
static HtmlEntityMapper::SymType decodeSymbol(const QCString &symName)
Definition docnode.cpp:153
void setStateText()
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
TokenRetval value() 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
const Mapper< CommandType > * cmdMapper
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1399
TokenInfo * token
Definition docparser_p.h:92
QCString chars
QCString name

References DocNodeList::append(), AUTO_TRACE, TokenInfo::chars, DocCompoundNode::children(), CMD_AMP, CMD_AT, CMD_BSLASH, CMD_DCOLON, CMD_DOLLAR, CMD_EQUAL, CMD_EXCLAMATION, CMD_GREATER, CMD_HASH, CMD_LESS, CMD_MDASH, CMD_MINUS, CMD_NDASH, CMD_PERCENT, CMD_PLUS, CMD_PUNT, CMD_QUESTION, CMD_QUOTE, Mappers::cmdMapper, DocParser::context, DocSymbol::decodeSymbol(), DocParser::handleUnclosedStyleCommands(), Token::is_any_of(), DocTokenizer::lex(), TokenInfo::name, DocNode::parser(), DocTokenizer::setStateText(), HtmlEntityMapper::Sym_Amp, HtmlEntityMapper::Sym_At, HtmlEntityMapper::Sym_BSlash, HtmlEntityMapper::Sym_Dollar, HtmlEntityMapper::Sym_Dot, HtmlEntityMapper::Sym_DoubleColon, HtmlEntityMapper::Sym_Equal, HtmlEntityMapper::Sym_Exclam, HtmlEntityMapper::Sym_Greater, HtmlEntityMapper::Sym_Hash, HtmlEntityMapper::Sym_Less, HtmlEntityMapper::Sym_Minus, HtmlEntityMapper::Sym_Percent, HtmlEntityMapper::Sym_Plus, HtmlEntityMapper::Sym_Quest, HtmlEntityMapper::Sym_Quot, HtmlEntityMapper::Sym_Unknown, DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Token::value(), and warn_doc_error.


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