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

#include <docparser.h>

类 DocLink 继承关系图:

DocLink 的协作图:

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

QCString	parse (bool, bool isXmlLink=FALSE)

Kind	kind () const override

QCString	file () const

QCString	relPath () const

QCString	ref () const

QCString	anchor () const

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

QCString	m_relPath

QCString	m_ref

QCString	m_anchor

QCString	m_refText

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

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

DocParser &	m_parser

详细描述

Node representing a link to some item

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

构造及析构函数说明

◆ DocLink()

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

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

                                                                          : CompAccept<DocLink>(parser)
 {
   m_parent = parent;
   const Definition *compound = 0;
   QCString anchor;
   m_refText = target;
   m_relPath = parser.context.relPath;
   if (!m_refText.isEmpty() && m_refText.at(0)=='#')
   {
     m_refText = m_refText.right(m_refText.length()-1);
   }
   if (resolveLink(parser.context.context,stripKnownExtensions(target),parser.context.inSeeBlock,&compound,anchor))
   {
     m_anchor = anchor;
     if (compound && compound->isLinkable())
     {
       m_file = compound->getOutputFileBase();
       m_ref  = compound->getReference();
     }
     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;
   }
  
   // bogus link target
   warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"unable to resolve link to '%s' for \\link command",
          qPrint(target));
 }

引用了 anchor(), QCString::at(), DocParserContext::context, DocParser::context, Definition::definitionType(), DocParserContext::fileName, DocTokenizer::getLineNr(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceFileBase(), DocParserContext::inSeeBlock, QCString::isEmpty(), Definition::isLinkable(), QCString::length(), m_anchor, m_file, DocNode::m_parent, m_ref, m_refText, m_relPath, DocNode::parent(), qPrint(), DocParserContext::relPath, resolveLink(), QCString::right(), stripKnownExtensions(), toFileDef(), DocParser::tokenizer, Definition::TypeFile , 以及 warn_doc_error().

成员函数说明

◆ anchor()

QCString DocLink::anchor ( ) const

inline

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

880 { return m_anchor; }

引用了 m_anchor.

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

◆ file()

QCString DocLink::file ( ) const

inline

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

877 { return m_file; }

引用了 m_file.

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

◆ kind()

Kind DocLink::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

876 { return Kind_Link; }

引用了 DocNode::Kind_Link.

◆ parse()

QCString DocLink::parse	(	bool	isJavaLink,
		bool	isXmlLink = `FALSE`
	)

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

 {
   QCString result;
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocLink::parse() start\n"));
  
   int tok;
   while ((tok=m_parser.tokenizer.lex()))
   {
     if (!m_parser.defaultHandleToken(this,tok,m_children,FALSE))
     {
       const char *cmd_start = "\\";
       switch (tok)
       {
         case TK_COMMAND_AT:
           cmd_start = "@";
         // fall through
         case TK_COMMAND_BS:
           switch (Mappers::cmdMapper->map(m_parser.context.token->name))
           {
             case CMD_ENDLINK:
               if (isJavaLink)
               {
                 warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"{@link.. ended with @endlink command");
               }
               goto endlink;
             default:
               warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Illegal command %s as part of a \\link",
                   qPrint(cmd_start + m_parser.context.token->name));
               break;
           }
           break;
         case TK_SYMBOL:
           warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unsupported symbol %s found as part of a \\link",
               qPrint(m_parser.context.token->name));
           break;
         case TK_HTMLTAG:
           if (m_parser.context.token->name!="see" || !isXmlLink)
           {
             warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected xml/html command %s found as part of a \\link",
                 qPrint(m_parser.context.token->name));
           }
           goto endlink;
         case TK_LNKWORD:
         case TK_WORD:
           if (isJavaLink) // special case to detect closing }
           {
             QCString w = m_parser.context.token->name;
             int p;
             if (w=="}")
             {
               goto endlink;
             }
             else if ((p=w.find('}'))!=-1)
             {
               uint l=w.length();
               m_children.push_back(std::make_unique<DocWord>(m_parser,this,w.left(p)));
               if ((uint)p<l-1) // something left after the } (for instance a .)
               {
                 result=w.right((int)l-p-1);
               }
               goto endlink;
             }
           }
           m_children.push_back(std::make_unique<DocWord>(m_parser,this,m_parser.context.token->name));
           break;
         default:
           warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected token %s",
              DocTokenizer::tokToString(tok));
         break;
       }
     }
   }
   if (tok==0)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected end of comment while inside"
            " link command\n");
   }
 endlink:
  
   if (m_children.empty()) // no link text
   {
     m_children.push_back(std::make_unique<DocWord>(m_parser,this,m_refText));
   }
  
   m_parser.handlePendingStyleCommands(this,m_children);
   DBG(("DocLink::parse() end\n"));
   return result;
 }

引用了 CMD_ENDLINK, Mappers::cmdMapper, DocParser::context, DBG, DocParser::defaultHandleToken(), FALSE, DocParserContext::fileName, QCString::find(), DocTokenizer::getLineNr(), DocParser::handlePendingStyleCommands(), QCString::left(), QCString::length(), DocTokenizer::lex(), CompAccept< DocLink >::m_children, DocNode::m_parser, m_refText, TokenInfo::name, qPrint(), QCString::right(), TK_COMMAND_AT, TK_COMMAND_BS, TK_HTMLTAG, TK_LNKWORD, TK_SYMBOL, TK_WORD, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

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

◆ ref()

QCString DocLink::ref ( ) const

inline

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

879 { return m_ref; }

引用了 m_ref.

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

◆ relPath()

QCString DocLink::relPath ( ) const

inline

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

878 { return m_relPath; }

引用了 m_relPath.

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

类成员变量说明

◆ m_anchor

QCString DocLink::m_anchor

private

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

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

◆ m_file

QCString DocLink::m_file

private

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

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

◆ m_ref

QCString DocLink::m_ref

private

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

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

◆ m_refText

QCString DocLink::m_refText

private

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

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

◆ m_relPath

QCString DocLink::m_relPath

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocLink()

成员函数说明

◆ anchor()

◆ file()

◆ kind()

◆ parse()

◆ ref()

◆ relPath()

类成员变量说明

◆ m_anchor

◆ m_file

◆ m_ref

◆ m_refText

◆ m_relPath