DocAnchor类 参考

Node representing an anchor 更多...

#include <docparser.h>

类 DocAnchor 继承关系图:

DocAnchor 的协作图:

Public 成员函数
	DocAnchor (DocParser &parser, DocNode *parent, const QCString &id, bool newAnchor)
Kind	kind () const override
QCString	anchor () const
QCString	file () const
void	accept (DocVisitor *v) override
const HtmlAttribList &	attribs () const
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
QCString	m_anchor
QCString	m_file
HtmlAttribList	m_attribs

额外继承的成员函数
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 anchor

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

构造及析构函数说明

DocAnchor()

DocAnchor::DocAnchor	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	id,
		bool	newAnchor
	)

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

                                                                                        : DocNode(parser)
{
  m_parent = parent;
  if (id.isEmpty())
  {
    warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Empty anchor label");
    return;
  }
 
  const CitationManager &ct = CitationManager::instance();
  QCString anchorPrefix = ct.anchorPrefix();
  if (id.left(anchorPrefix.length()) == anchorPrefix)
  {
    const CiteInfo *cite = ct.find(id.mid(anchorPrefix.length()));
    if (cite)
    {
      m_file = convertNameToFile(ct.fileName(),FALSE,TRUE);
      m_anchor = id;
    }
    else
    {
      warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Invalid cite anchor id '%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
  else if (newAnchor) // found <a name="label">
  {
    m_anchor = id;
  }
  else // found \anchor label
  {
    const SectionInfo *sec = SectionManager::instance().find(id);
    if (sec)
    {
      //printf("Found anchor %s\n",qPrint(id));
      m_file   = sec->fileName();
      m_anchor = sec->label();
    }
    else
    {
      warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Invalid anchor id '%s'",qPrint(id));
      m_anchor = "invalid";
      m_file = "invalid";
    }
  }
}

引用了 CitationManager::anchorPrefix(), DocParser::context, convertNameToFile(), FALSE, CitationManager::fileName(), SectionInfo::fileName(), DocParserContext::fileName, CitationManager::find(), LinkedMap< T, Hash, KeyEqual, Map >::find(), DocTokenizer::getLineNr(), CitationManager::instance(), SectionManager::instance(), SectionInfo::label(), QCString::length(), m_anchor, m_file, DocNode::m_parent, DocNode::parent(), qPrint(), DocParser::tokenizer, TRUE , 以及 warn_doc_error().

成员函数说明

accept()

void DocAnchor::accept ( DocVisitor *  v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

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

{ v->visit(this); }

引用了 DocVisitor::visit().

anchor()

QCString DocAnchor::anchor ( ) const

inline

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

{ return m_anchor; }

引用了 m_anchor.

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

attribs()

const HtmlAttribList& DocAnchor::attribs ( ) const

inline

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

{ return m_attribs; }

引用了 m_attribs.

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

file()

QCString DocAnchor::file ( ) const

inline

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

{ return m_file; }

引用了 m_file.

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

kind()

Kind DocAnchor::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_Anchor; }

引用了 DocNode::Kind_Anchor.

类成员变量说明

m_anchor

QCString DocAnchor::m_anchor

private

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

被这些函数引用 anchor() , 以及 DocAnchor().

m_attribs

HtmlAttribList DocAnchor::m_attribs

private

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

被这些函数引用 attribs().

m_file

QCString DocAnchor::m_file

private

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

被这些函数引用 DocAnchor() , 以及 file().

---

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

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