Node representing a reference to a section 更多...

#include <docparser.h>

类 DocSecRefItem 继承关系图:

DocSecRefItem 的协作图:

Public 成员函数
	DocSecRefItem (DocParser &parser, DocNode *parent, const QCString &target)

Kind	kind () const override

QCString	target () const

QCString	file () const

QCString	anchor () const

QCString	relPath () const

QCString	ref () const

bool	refToTable () const

bool	isSubPage () const

void	parse ()

Public 成员函数继承自 CompAccept< DocSecRefItem >
	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

Private 属性
QCString	m_target

RefType	m_refType = Unknown

bool	m_isSubPage = false

QCString	m_file

QCString	m_relPath

QCString	m_ref

QCString	m_anchor

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

Protected 属性继承自 DocNode
DocNode *	m_parent = 0

DocParser &	m_parser

详细描述

Node representing a reference to a section

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

构造及析构函数说明

◆ DocSecRefItem()

DocSecRefItem::DocSecRefItem	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	target
	)

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

                                                                                      :
       CompAccept<DocSecRefItem>(parser), m_target(target), m_relPath(parser.context.relPath)
 {
   m_parent = parent;
 }

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

成员函数说明

◆ anchor()

QCString DocSecRefItem::anchor ( ) const

inline

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

1030 { return m_anchor; }

引用了 m_anchor.

被这些函数引用 LatexDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), LatexDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ file()

QCString DocSecRefItem::file ( ) const

inline

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

1029 { return m_file; }

引用了 m_file.

被这些函数引用 HtmlDocVisitor::visitPost(), LatexDocVisitor::visitPost(), HtmlDocVisitor::visitPre(), LatexDocVisitor::visitPre() , 以及 XmlDocVisitor::visitPre().

◆ isSubPage()

bool DocSecRefItem::isSubPage ( ) const

inline

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

1034 { return m_isSubPage; }

引用了 m_isSubPage.

被这些函数引用 LatexDocVisitor::visitPost(), HtmlDocVisitor::visitPre() , 以及 LatexDocVisitor::visitPre().

◆ kind()

Kind DocSecRefItem::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

1027 { return Kind_SecRefItem; }

引用了 DocNode::Kind_SecRefItem.

◆ parse()

void DocSecRefItem::parse ( )

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

 {
   DBG(("DocSecRefItem::parse() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
  
   m_parser.tokenizer.setStateTitle();
   int tok;
   while ((tok=m_parser.tokenizer.lex()))
   {
     if (!m_parser.defaultHandleToken(this,tok,m_children))
     {
       m_parser.errorHandleDefaultToken(this,tok,m_children,"\\refitem");
     }
   }
   m_parser.tokenizer.setStatePara();
   m_parser.handlePendingStyleCommands(this,m_children);
  
   if (!m_target.isEmpty())
   {
     SrcLangExt lang = getLanguageFromFileName(m_target);
     const SectionInfo *sec = SectionManager::instance().find(m_target);
     if (sec==0 && lang==SrcLangExt_Markdown) // lookup as markdown file
     {
       sec = SectionManager::instance().find(markdownFileNameToId(m_target));
     }
     if (sec) // ref to section or anchor
     {
       // set defaults
       m_ref       = sec->ref();
       m_file      = stripKnownExtensions(sec->fileName());
       m_refType   = Section;
       m_anchor    = sec->label();
       m_isSubPage = false;
       // adjust if needed
       switch (sec->type())
       {
         case SectionType::Page:
           {
             PageDef *pd = Doxygen::pageLinkedMap->find(m_target);
             m_isSubPage = pd && pd->hasParentPage();
             if (!m_isSubPage)
             {
               m_anchor="";
             }
           }
           break;
         case SectionType::Anchor:
           m_refType = Anchor;
           break;
         case SectionType::Table:
           m_refType = Table;
           break;
         default:
           break;
       }
       //printf("m_ref=%s,m_file=%s,type=%d\n",
       //    qPrint(m_ref),qPrint(m_file),m_refType);
     }
     else
     {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"reference to unknown section %s",
           qPrint(m_target));
     }
   }
   else
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"reference to empty target");
   }
  
   DBG(("DocSecRefItem::parse() end\n"));
 }

引用了 Anchor, DocNode::Anchor, DocParser::context, DBG, DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), SectionInfo::fileName(), DocParserContext::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), getLanguageFromFileName(), DocTokenizer::getLineNr(), DocParser::handlePendingStyleCommands(), PageDef::hasParentPage(), SectionManager::instance(), QCString::isEmpty(), SectionInfo::label(), DocTokenizer::lex(), m_anchor, CompAccept< DocSecRefItem >::m_children, m_file, m_isSubPage, DocNode::m_parser, m_ref, m_refType, m_target, markdownFileNameToId(), Page, Doxygen::pageLinkedMap, qPrint(), SectionInfo::ref(), DocNode::Section, DocTokenizer::setStatePara(), DocTokenizer::setStateTitle(), SrcLangExt_Markdown, stripKnownExtensions(), Table, DocNode::Table, DocParser::tokenizer, SectionInfo::type() , 以及 warn_doc_error().

被这些函数引用 DocSecRefList::parse().

◆ ref()

QCString DocSecRefItem::ref ( ) const

inline

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

1032 { return m_ref; }

引用了 m_ref.

被这些函数引用 LatexDocVisitor::visitPost(), HtmlDocVisitor::visitPre() , 以及 LatexDocVisitor::visitPre().

◆ refToTable()

bool DocSecRefItem::refToTable ( ) const

inline

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

1033 { return m_refType==Table; }

引用了 m_refType , 以及 DocNode::Table.

被这些函数引用 LatexDocVisitor::visitPost() , 以及 LatexDocVisitor::visitPre().

◆ relPath()

QCString DocSecRefItem::relPath ( ) const

inline

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

1031 { return m_relPath; }

引用了 m_relPath.

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

◆ target()

QCString DocSecRefItem::target ( ) const

inline

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

1028 { return m_target; }

引用了 m_target.

被这些函数引用 PrintDocVisitor::visitPre().

类成员变量说明

◆ m_anchor

QCString DocSecRefItem::m_anchor

private

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

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

◆ m_file

QCString DocSecRefItem::m_file

private

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

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

◆ m_isSubPage

bool DocSecRefItem::m_isSubPage = false

private

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

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

◆ m_ref

QCString DocSecRefItem::m_ref

private

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

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

◆ m_refType

RefType DocSecRefItem::m_refType = Unknown

private

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

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

◆ m_relPath

QCString DocSecRefItem::m_relPath

private

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

被这些函数引用 relPath().

◆ m_target

QCString DocSecRefItem::m_target

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocSecRefItem()

成员函数说明

◆ anchor()

◆ file()

◆ isSubPage()

◆ kind()

◆ parse()

◆ ref()

◆ refToTable()

◆ relPath()

◆ target()

类成员变量说明

◆ m_anchor

◆ m_file

◆ m_isSubPage

◆ m_ref

◆ m_refType

◆ m_relPath

◆ m_target