DocIndexEntry类 参考

Node representing an entry in the index. 更多...

#include <docparser.h>

类 DocIndexEntry 继承关系图:

DocIndexEntry 的协作图:

Public 成员函数
	DocIndexEntry (DocParser &parser, DocNode *parent, const Definition *scope, const MemberDef *md)
Kind	kind () const override
int	parse ()
const Definition *	scope () const
const MemberDef *	member () const
QCString	entry () const
void	accept (DocVisitor *v) override
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
QCString	m_entry
const Definition *	m_scope = 0
const MemberDef *	m_member = 0

额外继承的成员函数
Public 类型 继承自 DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52, Kind_Emoji = 53, Kind_Sep = 54 }
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing an entry in the index.

在文件 docparser.h 第 682 行定义.

构造及析构函数说明

DocIndexEntry()

DocIndexEntry::DocIndexEntry ( DocParser &  parser, DocNode *  parent, const Definition *  scope, const MemberDef *  md  )

inline

在文件 docparser.h 第 685 行定义.

      : DocNode(parser), m_scope(scope), m_member(md){ m_parent = parent; }

引用了 DocNode::m_parent , 以及 DocNode::parent().

成员函数说明

accept()

void DocIndexEntry::accept ( DocVisitor *  v )

inlineoverridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数

v	Abstract visitor.

实现了 DocNode.

在文件 docparser.h 第 692 行定义.

{ v->visit(this);  }

引用了 DocVisitor::visit().

entry()

QCString DocIndexEntry::entry ( ) const

inline

在文件 docparser.h 第 691 行定义.

{ return m_entry;  }

引用了 m_entry.

被这些函数引用 HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit() , 以及 XmlDocVisitor::visit().

kind()

Kind DocIndexEntry::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 687 行定义.

{ return Kind_IndexEntry; }

引用了 DocNode::Kind_IndexEntry.

member()

const MemberDef* DocIndexEntry::member ( ) const

inline

在文件 docparser.h 第 690 行定义.

{ return m_member; }

引用了 m_member.

被这些函数引用 HtmlDocVisitor::visit().

parse()

int DocIndexEntry::parse

(

)

在文件 docparser.cpp 第 3103 行定义.

{
  int retval=RetVal_OK;
  auto ns = AutoNodeStack(m_parser,this);
  DBG(("DocIndexEntry::parse() start\n"));
  int tok=m_parser.tokenizer.lex();
  if (tok!=TK_WHITESPACE)
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\addindex command");
    goto endindexentry;
  }
  m_parser.tokenizer.setStateTitle();
  m_entry="";
  while ((tok=m_parser.tokenizer.lex()))
  {
    switch (tok)
    {
      case TK_WHITESPACE:
        m_entry+=" ";
        break;
      case TK_WORD:
      case TK_LNKWORD:
        m_entry+=m_parser.context.token->name;
        break;
      case TK_SYMBOL:
        {
          DocSymbol::SymType s = DocSymbol::decodeSymbol(m_parser.context.token->name);
          switch (s)
          {
            case DocSymbol::Sym_BSlash:  m_entry+='\\'; break;
            case DocSymbol::Sym_At:      m_entry+='@';  break;
            case DocSymbol::Sym_Less:    m_entry+='<';  break;
            case DocSymbol::Sym_Greater: m_entry+='>';  break;
            case DocSymbol::Sym_Amp:     m_entry+='&';  break;
            case DocSymbol::Sym_Dollar:  m_entry+='$';  break;
            case DocSymbol::Sym_Hash:    m_entry+='#';  break;
            case DocSymbol::Sym_Percent: m_entry+='%';  break;
            case DocSymbol::Sym_apos:    m_entry+='\''; break;
            case DocSymbol::Sym_Quot:    m_entry+='"';  break;
            case DocSymbol::Sym_lsquo:   m_entry+='`';  break;
            case DocSymbol::Sym_rsquo:   m_entry+='\'';  break;
            case DocSymbol::Sym_ldquo:   m_entry+="``";  break;
            case DocSymbol::Sym_rdquo:   m_entry+="''";  break;
            case DocSymbol::Sym_ndash:   m_entry+="--";  break;
            case DocSymbol::Sym_mdash:   m_entry+="---";  break;
            default:
              warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected symbol found as argument of \\addindex");
              break;
          }
        }
        break;
      case TK_COMMAND_AT:
        // fall through
      case TK_COMMAND_BS:
        switch (Mappers::cmdMapper->map(m_parser.context.token->name))
        {
          case CMD_BSLASH:  m_entry+='\\';  break;
          case CMD_AT:      m_entry+='@';   break;
          case CMD_LESS:    m_entry+='<';   break;
          case CMD_GREATER: m_entry+='>';   break;
          case CMD_AMP:     m_entry+='&';   break;
          case CMD_DOLLAR:  m_entry+='$';   break;
          case CMD_HASH:    m_entry+='#';   break;
          case CMD_DCOLON:  m_entry+="::";  break;
          case CMD_PERCENT: m_entry+='%';   break;
          case CMD_NDASH:   m_entry+="--";  break;
          case CMD_MDASH:   m_entry+="---"; break;
          case CMD_QUOTE:   m_entry+='"';   break;
          case CMD_PUNT:    m_entry+='.';   break;
          case CMD_PLUS:    m_entry+='+';   break;
          case CMD_MINUS:   m_entry+='-';   break;
          case CMD_EQUAL:   m_entry+='=';   break;
          default:
               warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected command %s found as argument of \\addindex",
                              qPrint(m_parser.context.token->name));
               break;
        }
      break;
      default:
        warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected token %s",
            DocTokenizer::tokToString(tok));
        break;
    }
  }
  m_parser.tokenizer.setStatePara();
  m_entry = m_entry.stripWhiteSpace();
endindexentry:
  DBG(("DocIndexEntry::parse() end retval=%s\n",DocTokenizer::retvalToString(retval)));
  return retval;
}

引用了 CMD_AMP, CMD_AT, CMD_BSLASH, CMD_DCOLON, CMD_DOLLAR, CMD_EQUAL, CMD_GREATER, CMD_HASH, CMD_LESS, CMD_MDASH, CMD_MINUS, CMD_NDASH, CMD_PERCENT, CMD_PLUS, CMD_PUNT, CMD_QUOTE, Mappers::cmdMapper, DocParser::context, DBG, DocSymbol::decodeSymbol(), DocParserContext::fileName, DocTokenizer::getLineNr(), DocTokenizer::lex(), m_entry, DocNode::m_parser, TokenInfo::name, qPrint(), RetVal_OK, DocTokenizer::retvalToString(), DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), QCString::stripWhiteSpace(), DocSymbol::Sym_Amp, DocSymbol::Sym_apos, DocSymbol::Sym_At, DocSymbol::Sym_BSlash, DocSymbol::Sym_Dollar, DocSymbol::Sym_Greater, DocSymbol::Sym_Hash, DocSymbol::Sym_ldquo, DocSymbol::Sym_Less, DocSymbol::Sym_lsquo, DocSymbol::Sym_mdash, DocSymbol::Sym_ndash, DocSymbol::Sym_Percent, DocSymbol::Sym_Quot, DocSymbol::Sym_rdquo, DocSymbol::Sym_rsquo, TK_COMMAND_AT, TK_COMMAND_BS, TK_LNKWORD, TK_SYMBOL, TK_WHITESPACE, TK_WORD, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

被这些函数引用 DocPara::handleCommand().

scope()

const Definition* DocIndexEntry::scope ( ) const

inline

在文件 docparser.h 第 689 行定义.

{ return m_scope;  }

引用了 m_scope.

被这些函数引用 HtmlDocVisitor::visit().

类成员变量说明

m_entry

QCString DocIndexEntry::m_entry

private

在文件 docparser.h 第 695 行定义.

被这些函数引用 entry() , 以及 parse().

m_member

const MemberDef* DocIndexEntry::m_member = 0

private

在文件 docparser.h 第 697 行定义.

被这些函数引用 member().

m_scope

const Definition* DocIndexEntry::m_scope = 0

private

在文件 docparser.h 第 696 行定义.

被这些函数引用 scope().

---

该类的文档由以下文件生成:

• src/docparser.h
• src/docparser.cpp