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

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 empty () 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 ,
  Requirement
}
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Root node of a text fragment.

Definition at line 1308 of file docnode.h.

Constructor & Destructor Documentation

◆ DocText()

DocText::DocText ( DocParser * parser)
inline

Definition at line 1311 of file docnode.h.

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

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

Member Function Documentation

◆ empty()

bool DocText::empty ( ) const
inline

Definition at line 1313 of file docnode.h.

1313{ return children().empty(); }
DocCompoundNode::children
DocNodeList & children()
Definition docnode.h:143
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 6254 of file docnode.cpp.

6255{
6256 AUTO_TRACE();
6257 auto ns = AutoNodeStack(parser(),thisVariant());
6258 parser()->tokenizer.setStateText();
6259
6260 Token tok = parser()->tokenizer.lex();
6261 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF)) // get the next token
6262 {
6263 switch(tok.value())
6264 {
6265 case TokenRetval::TK_WORD:
6266 children().append<DocWord>(parser(),thisVariant(),parser()->context.token->name);
6267 break;
6268 case TokenRetval::TK_WHITESPACE:
6269 children().append<DocWhiteSpace>(parser(),thisVariant(),parser()->context.token->chars);
6270 break;
6271 case TokenRetval::TK_SYMBOL:
6272 {
6273 HtmlEntityMapper::SymType s = DocSymbol::decodeSymbol(parser()->context.token->name);
6274 if (s!=HtmlEntityMapper::Sym_Unknown)
6275 {
6276 children().append<DocSymbol>(parser(),thisVariant(),s);
6277 }
6278 else
6279 {
6280 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unsupported symbol '{}' found",
6281 parser()->context.token->name);
6282 }
6283 }
6284 break;
6285 case TokenRetval::TK_COMMAND_AT:
6286 // fall through
6287 case TokenRetval::TK_COMMAND_BS:
6288 switch (Mappers::cmdMapper->map(parser()->context.token->name))
6289 {
6290 case CommandType::CMD_BSLASH:
6291 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_BSlash);
6292 break;
6293 case CommandType::CMD_AT:
6294 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_At);
6295 break;
6296 case CommandType::CMD_LESS:
6297 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Less);
6298 break;
6299 case CommandType::CMD_GREATER:
6300 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Greater);
6301 break;
6302 case CommandType::CMD_AMP:
6303 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Amp);
6304 break;
6305 case CommandType::CMD_DOLLAR:
6306 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Dollar);
6307 break;
6308 case CommandType::CMD_HASH:
6309 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Hash);
6310 break;
6311 case CommandType::CMD_DCOLON:
6312 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_DoubleColon);
6313 break;
6314 case CommandType::CMD_PERCENT:
6315 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Percent);
6316 break;
6317 case CommandType::CMD_NDASH:
6318 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6319 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6320 break;
6321 case CommandType::CMD_MDASH:
6322 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6323 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6324 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6325 break;
6326 case CommandType::CMD_QUOTE:
6327 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Quot);
6328 break;
6329 case CommandType::CMD_PUNT:
6330 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Dot);
6331 break;
6332 case CommandType::CMD_EXCLAMATION:
6333 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Exclam);
6334 break;
6335 case CommandType::CMD_QUESTION:
6336 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Quest);
6337 break;
6338 case CommandType::CMD_PLUS:
6339 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Plus);
6340 break;
6341 case CommandType::CMD_MINUS:
6342 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Minus);
6343 break;
6344 case CommandType::CMD_EQUAL:
6345 children().append<DocSymbol>(parser(),thisVariant(),HtmlEntityMapper::Sym_Equal);
6346 break;
6347 default:
6348 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected command '{}' found",
6349 parser()->context.token->name);
6350 break;
6351 }
6352 break;
6353 default:
6354 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",
6355 tok.to_string());
6356 break;
6357 }
6358 tok = parser()->tokenizer.lex();
6359 }
6360
6361 parser()->handleUnclosedStyleCommands();
6362
6363}
DocNode::thisVariant
DocNodeVariant * thisVariant()
Definition docnode.h:92
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:1404
DocParser::tokenizer
DocTokenizer tokenizer
Definition docparser_p.h:153
DocParser::context
DocParserContext context
Definition docparser_p.h:152
DocParser::handleUnclosedStyleCommands
void handleUnclosedStyleCommands()
Definition docparser.cpp:833
DocSymbol::decodeSymbol
static HtmlEntityMapper::SymType decodeSymbol(const DString &symName)
Definition docnode.cpp:168
DocTokenizer::setStateText
void setStateText()
Definition doctokenizer.l:2151
Token::to_string
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
Definition doctokenizer.h:90
Token::value
TokenRetval value() const
Definition doctokenizer.h:84
Token::is_any_of
bool is_any_of(ARGS... args) const
Definition doctokenizer.h:114
TokenInfo::chars
DString chars
Definition doctokenizer.h:168
TokenInfo::name
DString name
Definition doctokenizer.h:136
AUTO_TRACE
#define AUTO_TRACE(...)
Definition docnode.cpp:53
warn_doc_error
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
Mappers::cmdMapper
const Mapper< CommandType > * cmdMapper
Definition cmdmapper.cpp:254
DocParserContext::token
TokenInfo * token
Definition docparser_p.h:94

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: