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

Node representing an entry in the index. More...

#include <src/docnode.h>

Inheritance diagram for DocIndexEntry:
Collaboration diagram for DocIndexEntry:

Public Member Functions

 DocIndexEntry (DocParser *parser, DocNodeVariant *parent, const Definition *scope, const MemberDef *md)
Token parse ()
const Definition * scope () const
const MemberDef * member () const
DString entry () 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

Private Attributes

DString m_entry
const Definition * m_scope = nullptr
const MemberDef * m_member = nullptr

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 an entry in the index.

Definition at line 551 of file docnode.h.

Constructor & Destructor Documentation

◆ DocIndexEntry()

DocIndexEntry::DocIndexEntry ( DocParser * parser,
DocNodeVariant * parent,
const Definition * scope,
const MemberDef * md )
inline

Definition at line 554 of file docnode.h.

555 : DocNode(parser,parent), m_scope(scope), m_member(md) {}
DocIndexEntry::m_member
const MemberDef * m_member
Definition docnode.h:564
DocIndexEntry::m_scope
const Definition * m_scope
Definition docnode.h:563
DocIndexEntry::scope
const Definition * scope() const
Definition docnode.h:557
DocNode::DocNode
DocNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:84
DocNode::parser
DocParser * parser()
Definition docnode.h:97
DocNode::parent
DocNodeVariant * parent()
Definition docnode.h:89

References DocNode::DocNode(), m_member, m_scope, DocNode::parent(), DocNode::parser(), and scope().

Member Function Documentation

◆ entry()

DString DocIndexEntry::entry ( ) const
inline

Definition at line 559 of file docnode.h.

559{ return m_entry; }
DocIndexEntry::m_entry
DString m_entry
Definition docnode.h:562

References m_entry.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), PrintDocVisitor::operator()(), RTFDocVisitor::operator()(), and XmlDocVisitor::operator()().

◆ member()

const MemberDef * DocIndexEntry::member ( ) const
inline

Definition at line 558 of file docnode.h.

558{ return m_member; }

References m_member.

Referenced by HtmlDocVisitor::operator()().

◆ parse()

Token DocIndexEntry::parse ( )

Definition at line 1694 of file docnode.cpp.

1695{
1696 AUTO_TRACE();
1697 Token retval(TokenRetval::RetVal_OK);
1698 auto ns = AutoNodeStack(parser(),thisVariant());
1699 Token tok=parser()->tokenizer.lex();
1700 if (!tok.is(TokenRetval::TK_WHITESPACE))
1701 {
1702 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"expected whitespace after \\addindex command");
1703 goto endindexentry;
1704 }
1705 parser()->tokenizer.setStateTitle();
1706 m_entry="";
1707 tok = parser()->tokenizer.lex();
1708 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))
1709 {
1710 switch (tok.value())
1711 {
1712 case TokenRetval::TK_WHITESPACE:
1713 m_entry+=" ";
1714 break;
1715 case TokenRetval::TK_WORD:
1716 case TokenRetval::TK_LNKWORD:
1717 m_entry+=parser()->context.token->name;
1718 break;
1719 case TokenRetval::TK_SYMBOL:
1720 {
1721 HtmlEntityMapper::SymType s = DocSymbol::decodeSymbol(parser()->context.token->name);
1722 switch (s)
1723 {
1724 case HtmlEntityMapper::Sym_BSlash: m_entry+='\\'; break;
1725 case HtmlEntityMapper::Sym_At: m_entry+='@'; break;
1726 case HtmlEntityMapper::Sym_Less: m_entry+='<'; break;
1727 case HtmlEntityMapper::Sym_Greater: m_entry+='>'; break;
1728 case HtmlEntityMapper::Sym_Amp: m_entry+='&'; break;
1729 case HtmlEntityMapper::Sym_Dollar: m_entry+='$'; break;
1730 case HtmlEntityMapper::Sym_Hash: m_entry+='#'; break;
1731 case HtmlEntityMapper::Sym_Percent: m_entry+='%'; break;
1732 case HtmlEntityMapper::Sym_apos: m_entry+='\''; break;
1733 case HtmlEntityMapper::Sym_Quot: m_entry+='"'; break;
1734 case HtmlEntityMapper::Sym_lsquo: m_entry+='`'; break;
1735 case HtmlEntityMapper::Sym_rsquo: m_entry+='\''; break;
1736 case HtmlEntityMapper::Sym_ldquo: m_entry+="``"; break;
1737 case HtmlEntityMapper::Sym_rdquo: m_entry+="''"; break;
1738 case HtmlEntityMapper::Sym_ndash: m_entry+="--"; break;
1739 case HtmlEntityMapper::Sym_mdash: m_entry+="---"; break;
1740 default:
1741 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected symbol '{}' found as argument of \\addindex",parser()->context.token->name);
1742 break;
1743 }
1744 }
1745 break;
1746 case TokenRetval::TK_COMMAND_AT:
1747 // fall through
1748 case TokenRetval::TK_COMMAND_BS:
1749 switch (Mappers::cmdMapper->map(parser()->context.token->name))
1750 {
1751 case CommandType::CMD_BSLASH: m_entry+='\\'; break;
1752 case CommandType::CMD_AT: m_entry+='@'; break;
1753 case CommandType::CMD_LESS: m_entry+='<'; break;
1754 case CommandType::CMD_GREATER: m_entry+='>'; break;
1755 case CommandType::CMD_AMP: m_entry+='&'; break;
1756 case CommandType::CMD_DOLLAR: m_entry+='$'; break;
1757 case CommandType::CMD_HASH: m_entry+='#'; break;
1758 case CommandType::CMD_DCOLON: m_entry+="::"; break;
1759 case CommandType::CMD_PERCENT: m_entry+='%'; break;
1760 case CommandType::CMD_NDASH: m_entry+="--"; break;
1761 case CommandType::CMD_MDASH: m_entry+="---"; break;
1762 case CommandType::CMD_QUOTE: m_entry+='"'; break;
1763 case CommandType::CMD_PUNT: m_entry+='.'; break;
1764 case CommandType::CMD_PLUS: m_entry+='+'; break;
1765 case CommandType::CMD_MINUS: m_entry+='-'; break;
1766 case CommandType::CMD_EQUAL: m_entry+='='; break;
1767 case CommandType::CMD_EXCLAMATION: m_entry+='!'; break;
1768 case CommandType::CMD_QUESTION: m_entry+='?'; break;
1769 default:
1770 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected command {} found as argument of \\addindex",
1771 parser()->context.token->name);
1772 break;
1773 }
1774 break;
1775 default:
1776 warn_doc_error(parser()->context.fileName,parser()->tokenizer.getLineNr(),"Unexpected token {}",
1777 tok.to_string());
1778 break;
1779 }
1780 tok = parser()->tokenizer.lex();
1781 }
1782 parser()->tokenizer.setStatePara();
1783 m_entry = m_entry.stripWhiteSpace();
1784endindexentry:
1785 AUTO_TRACE_EXIT("retval={}",retval.to_string());
1786 return retval;
1787}
DString::stripWhiteSpace
DString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition dstring.h:337
DocNode::thisVariant
DocNodeVariant * thisVariant()
Definition docnode.h:92
DocParser::tokenizer
DocTokenizer tokenizer
Definition docparser_p.h:153
DocParser::context
DocParserContext context
Definition docparser_p.h:152
DocSymbol::decodeSymbol
static HtmlEntityMapper::SymType decodeSymbol(const DString &symName)
Definition docnode.cpp:168
DocTokenizer::setStateTitle
void setStateTitle()
Definition doctokenizer.l:1897
DocTokenizer::setStatePara
void setStatePara()
Definition doctokenizer.l:1889
Token::is
bool is(TokenRetval rv) const
Definition doctokenizer.h:119
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::name
DString name
Definition doctokenizer.h:136
AUTO_TRACE
#define AUTO_TRACE(...)
Definition docnode.cpp:53
AUTO_TRACE_EXIT
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:55
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 AUTO_TRACE, AUTO_TRACE_EXIT, 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(), Token::is(), Token::is_any_of(), DocTokenizer::lex(), m_entry, TokenInfo::name, DocNode::parser(), DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), DString::stripWhiteSpace(), HtmlEntityMapper::Sym_Amp, HtmlEntityMapper::Sym_apos, HtmlEntityMapper::Sym_At, HtmlEntityMapper::Sym_BSlash, HtmlEntityMapper::Sym_Dollar, HtmlEntityMapper::Sym_Greater, HtmlEntityMapper::Sym_Hash, HtmlEntityMapper::Sym_ldquo, HtmlEntityMapper::Sym_Less, HtmlEntityMapper::Sym_lsquo, HtmlEntityMapper::Sym_mdash, HtmlEntityMapper::Sym_ndash, HtmlEntityMapper::Sym_Percent, HtmlEntityMapper::Sym_Quot, HtmlEntityMapper::Sym_rdquo, HtmlEntityMapper::Sym_rsquo, DocNode::thisVariant(), Token::to_string(), DocParserContext::token, DocParser::tokenizer, Token::value(), and warn_doc_error.

◆ scope()

const Definition * DocIndexEntry::scope ( ) const
inline

Definition at line 557 of file docnode.h.

557{ return m_scope; }

References m_scope.

Referenced by DocIndexEntry(), and HtmlDocVisitor::operator()().

Member Data Documentation

◆ m_entry

DString DocIndexEntry::m_entry
private

Definition at line 562 of file docnode.h.

Referenced by entry(), and parse().

◆ m_member

const MemberDef* DocIndexEntry::m_member = nullptr
private

Definition at line 564 of file docnode.h.

Referenced by DocIndexEntry(), and member().

◆ m_scope

const Definition* DocIndexEntry::m_scope = nullptr
private

Definition at line 563 of file docnode.h.

Referenced by DocIndexEntry(), and scope().

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