The Token Class Reference

Declaration

class Token { ... }

Included Headers

#include <src/doctokenizer.h>

Friends Index

bool	operator==
bool	operator!=

Public Constructors Index

	Token (TokenRetval tv)

Public Member Functions Index

TokenRetval	value () const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char *	to_string () const
char	command_to_char () const
template <typename... ARGS>
bool	is_any_of (ARGS... args) const
bool	is (TokenRetval rv) const

Private Member Attributes Index

TokenRetval	m_value

Public Static Functions Index

static Token	char_to_command (char c)

Definition at line 83 of file doctokenizer.h.

Friends

operator!=

friend bool const Token & t1, const Token & t2

inline

Definition at line 128 of file doctokenizer.h.

128 friend inline bool operator!=(const Token &t1,const Token &t2) { return !(operator==(t1,t2)); }

References operator== and Token.

operator==

friend bool const Token & t1, const Token & t2

inline

Definition at line 127 of file doctokenizer.h.

127 friend inline bool operator==(const Token &t1,const Token &t2) { return t1.m_value==t2.m_value; }

References m_value and Token.

Referenced by operator!=.

Public Constructors

Token()

Token::Token (TokenRetval tv)

inline explicit

Definition at line 86 of file doctokenizer.h.

86 explicit Token(TokenRetval tv) : m_value(tv) {}

Reference m_value.

Referenced by char_to_command, operator!= and operator==.

Public Member Functions

command_to_char()

char Token::command_to_char ()

inline

Definition at line 106 of file doctokenizer.h.

106 char command_to_char() const

107 {

108 return m_value==TokenRetval::TK_COMMAND_AT ? '@' : '\\';

109 }

Reference m_value.

Referenced by DocParser::errorHandleDefaultToken, DocHtmlDescTitle::parse, DocLink::parse, DocPara::parse and DocSecRefList::parse.

is()

bool Token::is (TokenRetval rv)

inline

Definition at line 122 of file doctokenizer.h.

122 bool is(TokenRetval rv) const

123 {

124 return m_value==rv;

125 }

Reference m_value.

Referenced by DocParser::defaultHandleTitleAndSize, DocParser::defaultHandleToken, DocParser::handleAnchor, DocPara::handleCite, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocPara::handleFile, DocPara::handleHtmlStartTag, DocPara::handleIFile, DocPara::handleILine, DocParser::handleImage, DocPara::handleInclude, DocPara::handleIncludeOperator, DocParser::handleInternalRef, DocPara::handleLink, DocPara::handleParamSection, DocParser::handlePrefix, DocPara::handleRef, DocPara::handleSection, DocPara::handleShowDate, DocPara::handleSimpleSection, DocParser::handleStyleArgument, DocPara::handleXRefItem, DocParser::internalValidatingParseDoc, DocAutoList::parse, DocAutoListItem::parse, DocHtmlBlockQuote::parse, DocHtmlCell::parse, DocHtmlDescData::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlList::parse, DocHtmlListItem::parse, DocHtmlRow::parse, DocHtmlTable::parse, DocIndexEntry::parse, DocInternal::parse, DocPara::parse, DocParamList::parse, DocParamSect::parse, DocParBlock::parse, DocRoot::parse, DocSecRefList::parse, DocSection::parse, DocSimpleList::parse, DocHtmlCell::parseXml, DocHtmlList::parseXml, DocHtmlListItem::parseXml, DocHtmlRow::parseXml, DocHtmlTable::parseXml, DocParamList::parseXml and DocSimpleSect::parseXml.

is_any_of()

template <typename... ARGS>

bool Token::is_any_of (ARGS... args)

inline

Definition at line 117 of file doctokenizer.h.

117 bool is_any_of(ARGS... args) const

118 {

119 return ((m_value == args) || ...);

120 }

Reference m_value.

Referenced by DocParser::defaultHandleTitleAndSize, DocParser::defaultHandleToken, DocParser::handleAnchor, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocParser::handleImage, DocPara::handleInclude, DocPara::handleIncludeOperator, DocParser::handleInternalRef, DocParser::handlePrefix, DocPara::handleSection, DocPara::handleShowDate, DocPara::handleStartCode, DocParser::handleStyleArgument, DocHRef::parse, DocHtmlBlockQuote::parse, DocHtmlCaption::parse, DocHtmlCell::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlHeader::parse, DocHtmlList::parse, DocHtmlRow::parse, DocHtmlSummary::parse, DocHtmlTable::parse, DocIndexEntry::parse, DocInternal::parse, DocInternalRef::parse, DocLink::parse, DocPara::parse, DocParamList::parse, DocRef::parse, DocRoot::parse, DocSecRefItem::parse, DocSecRefList::parse, DocSection::parse, DocText::parse, DocTitle::parse, DocVhdlFlow::parse, DocHtmlList::parseXml, DocHtmlListItem::parseXml, DocHtmlRow::parseXml, DocHtmlTable::parseXml, DocParamList::parseXml and DocSimpleSect::parseXml.

to_string()

TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * Token::to_string ()

inline

Definition at line 93 of file doctokenizer.h.

93 const char *to_string() const

94 {

95 const char *result = "ERROR";

96 switch (m_value)

97 {

98#define TKSPEC(x,y) case TokenRetval::x: result = #x; break;

99 TOKEN_SPECIFICATIONS

100 RETVAL_SPECIFICATIONS

101#undef TKSPEC

102 }

103 return result;

104 }

References m_value, RETVAL_SPECIFICATIONS and TOKEN_SPECIFICATIONS.

Referenced by DocParser::defaultHandleToken, DocParser::errorHandleDefaultToken, DocParser::handleAnchor, DocPara::handleCite, DocPara::handleCommand, DocPara::handleDoxyConfig, DocPara::handleEmoji, DocPara::handleFile, DocPara::handleHtmlEndTag, DocPara::handleHtmlStartTag, DocPara::handleIFile, DocParser::handleImage, DocPara::handleInclude, DocPara::handleIncludeOperator, DocParser::handleInternalRef, DocPara::handleLink, DocPara::handleParamSection, DocParser::handlePrefix, DocPara::handleRef, DocPara::handleSection, DocPara::handleStartCode, DocParser::handleStyleArgument, DocAutoList::parse, DocAutoListItem::parse, DocHtmlBlockQuote::parse, DocHtmlDescList::parse, DocHtmlDescTitle::parse, DocHtmlDetails::parse, DocHtmlList::parse, DocHtmlListItem::parse, DocHtmlRow::parse, DocHtmlTable::parse, DocIndexEntry::parse, DocInternal::parse, DocLink::parse, DocPara::parse, DocParamList::parse, DocParamSect::parse, DocParBlock::parse, DocSecRefList::parse, DocSection::parse, DocSimpleSect::parse, DocText::parse, DocHtmlList::parseXml, DocHtmlListItem::parseXml, DocHtmlRow::parseXml, DocParamList::parseXml and DocSimpleSect::parseXml.

value()

TokenRetval Token::value ()

inline

Definition at line 87 of file doctokenizer.h.

87 TokenRetval value() const { return m_value; }

Reference m_value.

Referenced by DocParser::defaultHandleToken, DocParser::errorHandleDefaultToken, DocParser::handleStyleArgument, DocHRef::parse, DocHtmlCaption::parse, DocHtmlDescTitle::parse, DocHtmlHeader::parse, DocHtmlSummary::parse, DocIndexEntry::parse, DocLink::parse, DocPara::parse, DocRef::parse and DocText::parse.

Private Member Attributes

m_value

TokenRetval Token::m_value

Definition at line 131 of file doctokenizer.h.

131 TokenRetval m_value;

Referenced by command_to_char, is, is_any_of, operator==, to_string, Token and value.

Public Static Functions

char_to_command()

Token Token::char_to_command (char c)

inline static

Definition at line 111 of file doctokenizer.h.

111 static Token char_to_command(char c)

112 {

113 return c=='@' ? make_TK_COMMAND_AT() : make_TK_COMMAND_BS();

114 }

Reference Token.

---

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

• doctokenizer.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.