Node representing a reference to some item 更多...

#include <docparser.h>

类 DocRef 继承关系图:

DocRef 的协作图:

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

void	parse ()

Kind	kind () const override

QCString	file () const

QCString	relPath () const

QCString	ref () const

QCString	anchor () const

QCString	targetTitle () const

bool	hasLinkText () const

bool	refToAnchor () const

bool	refToSection () const

bool	refToTable () const

bool	isSubPage () const

Public 成员函数继承自 CompAccept< DocRef >
	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 属性
RefType	m_refType = Unknown

bool	m_isSubPage = false

QCString	m_file

QCString	m_relPath

QCString	m_ref

QCString	m_anchor

QCString	m_text

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

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

DocParser &	m_parser

详细描述

Node representing a reference to some item

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

构造及析构函数说明

◆ DocRef()

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

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

                                                                                                :
    CompAccept<DocRef>(parser), m_refType(Unknown), m_isSubPage(FALSE)
 {
   m_parent = parent;
   const Definition  *compound = 0;
   QCString     anchor;
   //printf("DocRef::DocRef(target=%s,context=%s)\n",qPrint(target),qPrint(context));
   ASSERT(!target.isEmpty());
   SrcLangExt lang = getLanguageFromFileName(target);
   m_relPath = parser.context.relPath;
   const SectionInfo *sec = SectionManager::instance().find(target);
   if (sec==0 && lang==SrcLangExt_Markdown) // lookup as markdown file
   {
     sec = SectionManager::instance().find(markdownFileNameToId(target));
   }
   if (sec) // ref to section or anchor
   {
     PageDef *pd = 0;
     if (sec->type()==SectionType::Page)
     {
       pd = Doxygen::pageLinkedMap->find(target);
     }
     m_text         = sec->title();
     if (m_text.isEmpty()) m_text = sec->label();
  
     m_ref          = sec->ref();
     m_file         = stripKnownExtensions(sec->fileName());
     if (sec->type()==SectionType::Anchor)
     {
       m_refType = Anchor;
     }
     else if (sec->type()==SectionType::Table)
     {
       m_refType = Table;
     }
     else
     {
       m_refType = Section;
     }
     m_isSubPage    = pd && pd->hasParentPage();
     if (sec->type()!=SectionType::Page || m_isSubPage) m_anchor = sec->label();
     //printf("m_text=%s,m_ref=%s,m_file=%s,type=%d\n",
     //    qPrint(m_text),qPrint(m_ref),qPrint(m_file),m_refType);
     return;
   }
   else if (resolveLink(context,target,TRUE,&compound,anchor))
   {
     bool isFile = compound ?
                  (compound->definitionType()==Definition::TypeFile ||
                   compound->definitionType()==Definition::TypePage ? TRUE : FALSE) :
                  FALSE;
     m_text = linkToText(compound?compound->getLanguage():SrcLangExt_Unknown,target,isFile);
     m_anchor = anchor;
     if (compound && compound->isLinkable()) // ref to compound
     {
       if (anchor.isEmpty() &&                                  /* compound link */
           compound->definitionType()==Definition::TypeGroup && /* is group */
           !toGroupDef(compound)->groupTitle().isEmpty()        /* with title */
          )
       {
         m_text=(toGroupDef(compound))->groupTitle(); // use group's title as link
       }
       else if (compound->definitionType()==Definition::TypeMember &&
           toMemberDef(compound)->isObjCMethod())
       {
         // Objective C Method
         const MemberDef *member = toMemberDef(compound);
         bool localLink = parser.context.memberDef ? member->getClassDef()==parser.context.memberDef->getClassDef() : FALSE;
         m_text = member->objCMethodName(localLink,parser.context.inSeeBlock);
       }
  
       m_file = compound->getOutputFileBase();
       m_ref  = compound->getReference();
       //printf("isFile=%d compound=%s (%d)\n",isFile,qPrint(compound->name()),
       //    compound->definitionType());
       return;
     }
     else if (compound && compound->definitionType()==Definition::TypeFile &&
              toFileDef(compound)->generateSourceFile()
             ) // undocumented file that has source code we can link to
     {
       m_file = compound->getSourceFileBase();
       m_ref  = compound->getReference();
       return;
     }
   }
   m_text = target;
   warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"unable to resolve reference to '%s' for \\ref command",
            qPrint(target));
 }

引用了 Anchor, DocNode::Anchor, anchor(), ASSERT, DocParser::context, Definition::definitionType(), FALSE, SectionInfo::fileName(), DocParserContext::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), MemberDef::getClassDef(), Definition::getLanguage(), getLanguageFromFileName(), DocTokenizer::getLineNr(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), PageDef::hasParentPage(), DocParserContext::inSeeBlock, SectionManager::instance(), QCString::isEmpty(), Definition::isLinkable(), MemberDef::isObjCMethod(), SectionInfo::label(), linkToText(), m_anchor, m_file, m_isSubPage, DocNode::m_parent, m_ref, m_refType, m_relPath, m_text, markdownFileNameToId(), DocParserContext::memberDef, MemberDef::objCMethodName(), Page, Doxygen::pageLinkedMap, DocNode::parent(), qPrint(), SectionInfo::ref(), DocParserContext::relPath, resolveLink(), DocNode::Section, SrcLangExt_Markdown, SrcLangExt_Unknown, stripKnownExtensions(), Table, DocNode::Table, SectionInfo::title(), toFileDef(), toGroupDef(), DocParser::tokenizer, toMemberDef(), TRUE, SectionInfo::type(), Definition::TypeFile, Definition::TypeGroup, Definition::TypeMember, Definition::TypePage , 以及 warn_doc_error().

成员函数说明

◆ anchor()

QCString DocRef::anchor ( ) const

inline

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

900 { return m_anchor; }

引用了 m_anchor.

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

◆ file()

QCString DocRef::file ( ) const

inline

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

897 { return m_file; }

引用了 m_file.

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

◆ hasLinkText()

bool DocRef::hasLinkText ( ) const

inline

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

902 { return !m_children.empty(); }

引用了 CompAccept< DocRef >::m_children.

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

◆ isSubPage()

bool DocRef::isSubPage ( ) const

inline

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

906 { return m_isSubPage; }

引用了 m_isSubPage.

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

◆ kind()

Kind DocRef::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

896 { return Kind_Ref; }

引用了 DocNode::Kind_Ref.

◆ parse()

void DocRef::parse ( )

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

 {
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocRef::parse() start\n"));
  
   int tok;
   while ((tok=m_parser.tokenizer.lex()))
   {
     if (!m_parser.defaultHandleToken(this,tok,m_children))
     {
       switch (tok)
       {
         case TK_HTMLTAG:
           break;
         default:
           m_parser.errorHandleDefaultToken(this,tok,m_children,"\\ref");
           break;
       }
     }
   }
  
   if (m_children.empty() && !m_text.isEmpty())
   {
     m_parser.context.insideHtmlLink=TRUE;
     m_parser.pushContext();
     m_parser.internalValidatingParseDoc(this,m_children,m_text);
     m_parser.popContext();
     m_parser.context.insideHtmlLink=FALSE;
     flattenParagraphs(this,m_children);
   }
  
   m_parser.handlePendingStyleCommands(this,m_children);
 }

引用了 DocParser::context, DBG, DocParser::defaultHandleToken(), DocParser::errorHandleDefaultToken(), FALSE, flattenParagraphs(), DocParser::handlePendingStyleCommands(), DocParserContext::insideHtmlLink, DocParser::internalValidatingParseDoc(), QCString::isEmpty(), DocTokenizer::lex(), CompAccept< DocRef >::m_children, DocNode::m_parser, m_text, DocParser::popContext(), DocParser::pushContext(), TK_HTMLTAG, DocParser::tokenizer , 以及 TRUE.

被这些函数引用 DocPara::handleRef() , 以及 DocHtmlDescTitle::parse().

◆ ref()

QCString DocRef::ref ( ) const

inline

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

899 { return m_ref; }

引用了 m_ref.

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

◆ refToAnchor()

bool DocRef::refToAnchor ( ) const

inline

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

903 { return m_refType==Anchor; }

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

◆ refToSection()

bool DocRef::refToSection ( ) const

inline

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

904 { return m_refType==Section; }

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

◆ refToTable()

bool DocRef::refToTable ( ) const

inline

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

905 { return m_refType==Table; }

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

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

◆ relPath()

QCString DocRef::relPath ( ) const

inline

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

898 { return m_relPath; }

引用了 m_relPath.

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

◆ targetTitle()

QCString DocRef::targetTitle ( ) const

inline

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

901 { return m_text; }

引用了 m_text.

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

类成员变量说明

◆ m_anchor

QCString DocRef::m_anchor

private

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

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

◆ m_file

QCString DocRef::m_file

private

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

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

◆ m_isSubPage

bool DocRef::m_isSubPage = false

private

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

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

◆ m_ref

QCString DocRef::m_ref

private

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

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

◆ m_refType

RefType DocRef::m_refType = Unknown

private

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

被这些函数引用 DocRef(), refToAnchor(), refToSection() , 以及 refToTable().

◆ m_relPath

QCString DocRef::m_relPath

private

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

被这些函数引用 DocRef() , 以及 relPath().

◆ m_text

QCString DocRef::m_text

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocRef()

成员函数说明

◆ anchor()

◆ file()

◆ hasLinkText()

◆ isSubPage()

◆ kind()

◆ parse()

◆ ref()

◆ refToAnchor()

◆ refToSection()

◆ refToTable()

◆ relPath()

◆ targetTitle()

类成员变量说明

◆ m_anchor

◆ m_file

◆ m_isSubPage

◆ m_ref

◆ m_refType

◆ m_relPath

◆ m_text