DocHRef类 参考

Node representing a Hypertext reference 更多...

#include <docparser.h>

类 DocHRef 继承关系图:

DocHRef 的协作图:

Public 成员函数
	DocHRef (DocParser &parser, DocNode *parent, const HtmlAttribList &attribs, const QCString &url, const QCString &relPath, const QCString &file)
int	parse ()
QCString	url () const
QCString	file () const
QCString	relPath () const
Kind	kind () const override
const HtmlAttribList &	attribs () const
Public 成员函数 继承自 CompAccept< DocHRef >
	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 属性
HtmlAttribList	m_attribs
QCString	m_url
QCString	m_relPath
QCString	m_file

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

详细描述

Node representing a Hypertext reference

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

构造及析构函数说明

DocHRef()

DocHRef::DocHRef ( DocParser &  parser, DocNode *  parent, const HtmlAttribList &  attribs, const QCString &  url, const QCString &  relPath, const QCString &  file  )

inline

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

                                                          :
      CompAccept<DocHRef>(parser), m_attribs(attribs), m_url(url), m_relPath(relPath), m_file(file) { m_parent = parent; }

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

成员函数说明

attribs()

const HtmlAttribList& DocHRef::attribs ( ) const

inline

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

{ return m_attribs; }

引用了 m_attribs.

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

file()

QCString DocHRef::file ( ) const

inline

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

{ return m_file; }

引用了 m_file.

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

kind()

Kind DocHRef::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_HRef; }

引用了 DocNode::Kind_HRef.

parse()

int DocHRef::parse

(

)

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

{
  int retval=RetVal_OK;
  auto ns = AutoNodeStack(m_parser,this);
  DBG(("DocHRef::parse() start\n"));
 
  int tok;
  while ((tok=m_parser.tokenizer.lex()))
  {
    if (!m_parser.defaultHandleToken(this,tok,m_children))
    {
      switch (tok)
      {
        case TK_HTMLTAG:
          {
            int tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
            if (tagId==HTML_A && m_parser.context.token->endTag) // found </a> tag
            {
              goto endhref;
            }
            else if (tagId==HTML_BR)
            {
              m_children.push_back(std::make_unique<DocLineBreak>(m_parser,this,m_parser.context.token->attribs));
            }
            else
            {
              warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected html tag <%s%s> found within <a href=...> context",
                  m_parser.context.token->endTag?"/":"",qPrint(m_parser.context.token->name));
            }
          }
          break;
        default:
          m_parser.errorHandleDefaultToken(this,tok,m_children,"<a>..</a> block");
          break;
      }
    }
  }
  if (tok==0)
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected end of comment while inside"
           " <a href=...> tag");
  }
endhref:
  m_parser.handlePendingStyleCommands(this,m_children);
  DBG(("DocHRef::parse() end\n"));
  return retval;
}

引用了 TokenInfo::attribs, DocParser::context, DBG, DocParser::defaultHandleToken(), TokenInfo::endTag, DocParser::errorHandleDefaultToken(), DocParserContext::fileName, DocTokenizer::getLineNr(), DocParser::handlePendingStyleCommands(), HTML_A, HTML_BR, Mappers::htmlTagMapper, DocTokenizer::lex(), CompAccept< DocHRef >::m_children, DocNode::m_parser, Mapper::map(), TokenInfo::name, qPrint(), RetVal_OK, TK_HTMLTAG, DocParserContext::token, DocParser::tokenizer , 以及 warn_doc_error().

被这些函数引用 DocParser::handleAHref().

relPath()

QCString DocHRef::relPath ( ) const

inline

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

{ return m_relPath; }

引用了 m_relPath.

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

url()

QCString DocHRef::url ( ) const

inline

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

{ return m_url; }

引用了 m_url.

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

类成员变量说明

m_attribs

HtmlAttribList DocHRef::m_attribs

private

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

被这些函数引用 attribs().

m_file

QCString DocHRef::m_file

private

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

被这些函数引用 file().

m_relPath

QCString DocHRef::m_relPath

private

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

被这些函数引用 relPath().

m_url

QCString DocHRef::m_url

private

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

被这些函数引用 url().

---

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

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