DocSecRefList类 参考

Node representing a list of section references 更多...

#include <docparser.h>

类 DocSecRefList 继承关系图:

DocSecRefList 的协作图:

Public 成员函数
	DocSecRefList (DocParser &parser, DocNode *parent)
void	parse ()
Kind	kind () const override
Public 成员函数 继承自 CompAccept< DocSecRefList >
	CompAccept (DocParser &parser)
void	accept (DocVisitor *v) override
const DocNodeList &	children () const
DocNodeList &	children ()
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

额外继承的成员函数
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 属性 继承自 CompAccept< DocSecRefList >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a list of section references

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

构造及析构函数说明

DocSecRefList()

DocSecRefList::DocSecRefList ( DocParser &  parser, DocNode *  parent  )

inline

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

: CompAccept<DocSecRefList>(parser) { m_parent = parent; }

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

成员函数说明

kind()

Kind DocSecRefList::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_SecRefList; }

引用了 DocNode::Kind_SecRefList.

parse()

void DocSecRefList::parse

(

)

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

{
  DBG(("DocSecRefList::parse() start\n"));
  auto ns = AutoNodeStack(m_parser,this);
 
  int tok=m_parser.tokenizer.lex();
  // skip white space
  while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=m_parser.tokenizer.lex();
  // handle items
  while (tok)
  {
    if (tok==TK_COMMAND_AT || tok == TK_COMMAND_BS)
    {
      const char *cmd_start = (tok==TK_COMMAND_AT ? "@" : "\\");
      switch (Mappers::cmdMapper->map(m_parser.context.token->name))
      {
        case CMD_SECREFITEM:
          {
            tok=m_parser.tokenizer.lex();
            if (tok!=TK_WHITESPACE)
            {
              warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\refitem command");
              break;
            }
            tok=m_parser.tokenizer.lex();
            if (tok!=TK_WORD && tok!=TK_LNKWORD)
            {
              warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected token %s as the argument of \\refitem",
                  DocTokenizer::tokToString(tok));
              break;
            }
 
            DocSecRefItem *item = new DocSecRefItem(m_parser,this,m_parser.context.token->name);
            m_children.push_back(std::unique_ptr<DocSecRefItem>(item));
            item->parse();
          }
          break;
        case CMD_ENDSECREFLIST:
          goto endsecreflist;
        default:
          warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Illegal command %s as part of a \\secreflist",
              qPrint(cmd_start + m_parser.context.token->name));
          goto endsecreflist;
      }
    }
    else if (tok==TK_WHITESPACE)
    {
      // ignore whitespace
    }
    else
    {
      warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected token %s inside section reference list",
          DocTokenizer::tokToString(tok));
      goto endsecreflist;
    }
    tok=m_parser.tokenizer.lex();
  }
 
endsecreflist:
  DBG(("DocSecRefList::parse() end\n"));
}

引用了 CMD_ENDSECREFLIST, CMD_SECREFITEM, Mappers::cmdMapper, DocParser::context, DBG, DocParserContext::fileName, DocTokenizer::getLineNr(), DocTokenizer::lex(), CompAccept< DocSecRefList >::m_children, DocNode::m_parser, TokenInfo::name, DocSecRefItem::parse(), qPrint(), TK_COMMAND_AT, TK_COMMAND_BS, TK_LNKWORD, TK_NEWPARA, TK_WHITESPACE, TK_WORD, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

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

---

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

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