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

Node representing a list of section references. More...

#include <src/docnode.h>

Inheritance diagram for DocSecRefList:
Collaboration diagram for DocSecRefList:

Public Member Functions

 DocSecRefList (DocParser *parser, DocNodeVariant *parent)
void 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 a list of section references.

Definition at line 967 of file docnode.h.

Constructor & Destructor Documentation

◆ DocSecRefList()

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

Definition at line 970 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

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

Member Function Documentation

◆ parse()

void DocSecRefList::parse ( )

Definition at line 617 of file docnode.cpp.

618{
619 AUTO_TRACE();
620 auto ns = AutoNodeStack(parser(),thisVariant());
621
622 Token tok=parser()->tokenizer.lex();
623 // skip white space
624 while (tok.is_any_of(TokenRetval::TK_WHITESPACE, TokenRetval::TK_NEWPARA)) tok=parser()->tokenizer.lex();
625 // handle items
626 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
627 {
628 if (tok.is_any_of(TokenRetval::TK_COMMAND_AT, TokenRetval::TK_COMMAND_BS))
629 {
630 switch (Mappers::cmdMapper->map(parser()->context.token->name))
631 {
633 {
634 tok=parser()->tokenizer.lex();
635 if (!tok.is(TokenRetval::TK_WHITESPACE))
636 {
637 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\refitem command");
638 break;
639 }
640 tok=parser()->tokenizer.lex();
641 if (!tok.is_any_of(TokenRetval::TK_WORD,TokenRetval::TK_LNKWORD))
642 {
643 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"unexpected token {} as the argument of \\refitem",
644 tok.to_string());
645 break;
646 }
647
648 children().append<DocSecRefItem>(parser(),thisVariant(),parser()->context.token->name);
649 children().get_last<DocSecRefItem>()->parse();
650 }
651 break;
653 return;
654 default:
655 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Illegal command '{:c}{}' as part of a \\secreflist",
656 tok.command_to_char(),qPrint(parser()->context.token->name));
657 return;
658 }
659 }
660 else if (tok.is(TokenRetval::TK_WHITESPACE))
661 {
662 // ignore whitespace
663 }
664 else
665 {
666 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {} inside section reference list",
667 tok.to_string());
668 return;
669 }
670 tok=parser()->tokenizer.lex();
671 }
672
673}
AutoNodeStack(DocParser *parser, DocNodeVariant *node)
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:92
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1404
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1415
DocTokenizer tokenizer
DocParserContext context
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
bool is_any_of(ARGS... args) const
char command_to_char() const
DString name
@ CMD_ENDSECREFLIST
Definition cmdmapper.h:54
#define AUTO_TRACE(...)
Definition docnode.cpp:51
const char * qPrint(const char *s)
Definition dstring.h:787
#define warn_doc_error(file, line, fmt,...)
Definition message.h:112
const Mapper< CommandType > * cmdMapper
TokenInfo * token
Definition docparser_p.h:94

References DocNodeList::append(), AUTO_TRACE, AutoNodeStack::AutoNodeStack(), DocCompoundNode::children(), CMD_ENDSECREFLIST, CMD_SECREFITEM, Mappers::cmdMapper, Token::command_to_char(), DocParser::context, DocNodeList::get_last(), Token::is(), Token::is_any_of(), DocTokenizer::lex(), TokenInfo::name, parse(), DocNode::parser(), qPrint(), DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, and warn_doc_error.

Referenced by parse().


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