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)
DocNodeList & children ()
const DocNodeList & children () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariant * parent ()
const DocNodeVariant * parent () const
DocNodeVariant * thisVariant ()
const DocNodeVariant * thisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParser * parser ()
const DocParser * parser () 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 1298 of file docnode.h.

Constructor & Destructor Documentation

◆ DocText()

DocText::DocText ( DocParser * parser)
inline

Definition at line 1301 of file docnode.h.

1301: DocCompoundNode(parser,nullptr) {}
DocCompoundNode::DocCompoundNode
DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:140
DocNode::parser
DocParser * parser()
Definition docnode.h:97

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

Member Function Documentation

◆ isEmpty()

bool DocText::isEmpty ( ) const
inline

Definition at line 1303 of file docnode.h.

1303{ return children().empty(); }
DocCompoundNode::children
DocNodeList & children()
Definition docnode.h:142
GrowVector::empty
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 5954 of file docnode.cpp.

5955{
5956 AUTO_TRACE();
5957 auto ns = AutoNodeStack(parser(),thisVariant());
5958 parser()->tokenizer.setStateText();
5959
5960 Token tok = parser()->tokenizer.lex();
5961 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF)) // get the next token
5962 {
5963 switch(tok.value())
5964 {
5965 case TokenRetval::TK_WORD:
5966 children().append<DocWord>(parser(),thisVariant(),parser()->context.token->name);
5967 break;
5968 case TokenRetval::TK_WHITESPACE:
5969 children().append<DocWhiteSpace>(parser(),thisVariant(),parser()->context.token->chars);
5970 break;
5971 case TokenRetval::TK_SYMBOL:
5972 {
5973 HtmlEntityMapper::SymType s = DocSymbol::decodeSymbol(parser()->context.token->name);
5974 if (s!=HtmlEntityMapper::Sym_Unknown)
5975 {
5976 children().append<DocSymbol>(parser(),thisVariant(),s);
5977 }
5978 else
5979 {
5980 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found",
5981 parser()->context.token->name);
5982 }
5983 }
5984 break;
5985 case TokenRetval::TK_COMMAND_AT:
5986 // fall through
5987 case TokenRetval::TK_COMMAND_BS:
5988 switch (Mappers::cmdMapper->map(parser()->context.token->name))
5989 {
5990 case CommandType::CMD_BSLASH:
5991 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_BSlash);
5992 break;
5993 case CommandType::CMD_AT:
5994 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_At);
5995 break;
5996 case CommandType::CMD_LESS:
5997 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Less);
5998 break;
5999 case CommandType::CMD_GREATER:
6000 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Greater);
6001 break;
6002 case CommandType::CMD_AMP:
6003 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Amp);
6004 break;
6005 case CommandType::CMD_DOLLAR:
6006 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Dollar);
6007 break;
6008 case CommandType::CMD_HASH:
6009 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Hash);
6010 break;
6011 case CommandType::CMD_DCOLON:
6012 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_DoubleColon);
6013 break;
6014 case CommandType::CMD_PERCENT:
6015 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Percent);
6016 break;
6017 case CommandType::CMD_NDASH:
6018 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6019 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6020 break;
6021 case CommandType::CMD_MDASH:
6022 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6023 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6024 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6025 break;
6026 case CommandType::CMD_QUOTE:
6027 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Quot);
6028 break;
6029 case CommandType::CMD_PUNT:
6030 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Dot);
6031 break;
6032 case CommandType::CMD_EXCLAMATION:
6033 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Exclam);
6034 break;
6035 case CommandType::CMD_QUESTION:
6036 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Quest);
6037 break;
6038 case CommandType::CMD_PLUS:
6039 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Plus);
6040 break;
6041 case CommandType::CMD_MINUS:
6042 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6043 break;
6044 case CommandType::CMD_EQUAL:
6045 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Equal);
6046 break;
6047 default:
6048 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected command '{}' found",
6049 parser()->context.token->name);
6050 break;
6051 }
6052 break;
6053 default:
6054 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",
6055 tok.to_string());
6056 break;
6057 }
6058 tok = parser()->tokenizer.lex();
6059 }
6060
6061 parser()->handleUnclosedStyleCommands();
6062
6063}
DocNode::thisVariant
DocNodeVariant * thisVariant()
Definition docnode.h:92
DocParser::tokenizer
DocTokenizer tokenizer
Definition docparser_p.h:141
DocParser::context
DocParserContext context
Definition docparser_p.h:140
DocParser::handleUnclosedStyleCommands
void handleUnclosedStyleCommands()
Definition docparser.cpp:753
DocSymbol::decodeSymbol
static HtmlEntityMapper::SymType decodeSymbol(const QCString &symName)
Definition docnode.cpp:153
DocTokenizer::setStateText
void setStateText()
Definition doctokenizer.l:2060
Token::to_string
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
Definition doctokenizer.h:91
Token::value
TokenRetval value() const
Definition doctokenizer.h:85
Token::is_any_of
bool is_any_of(ARGS... args) const
Definition doctokenizer.h:115
AUTO_TRACE
#define AUTO_TRACE(...)
Definition docnode.cpp:46
warn_doc_error
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
Mappers::cmdMapper
const Mapper< CommandType > * cmdMapper
Definition cmdmapper.cpp:250
DocNodeList::append
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1394
DocParserContext::token
TokenInfo * token
Definition docparser_p.h:92
TokenInfo::chars
QCString chars
Definition doctokenizer.h:168
TokenInfo::name
QCString name
Definition doctokenizer.h:136

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: