Node representing a HTML table caption 更多...

#include <docparser.h>

类 DocHtmlCaption 继承关系图:

DocHtmlCaption 的协作图:

Public 成员函数
	DocHtmlCaption (DocParser &parser, DocNode *parent, const HtmlAttribList &attribs)

Kind	kind () const override

const HtmlAttribList &	attribs () const

int	parse ()

bool	hasCaptionId () const

QCString	file () const

QCString	anchor () const

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

bool	m_hasCaptionId = false

QCString	m_file

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< DocHtmlCaption >
DocNodeList	m_children

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

DocParser &	m_parser

详细描述

Node representing a HTML table caption

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

构造及析构函数说明

◆ DocHtmlCaption()

DocHtmlCaption::DocHtmlCaption	(	DocParser &	parser,
		DocNode *	parent,
		const HtmlAttribList &	attribs
	)

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

   : CompAccept<DocHtmlCaption>(parser)
 {
   m_hasCaptionId = FALSE;
   for (const auto &opt : attribs)
   {
     if (opt.name=="id" && !opt.value.isEmpty()) // interpret id attribute as an anchor
     {
       const SectionInfo *sec = SectionManager::instance().find(opt.value);
       if (sec)
       {
         //printf("Found anchor %s\n",qPrint(id));
         m_file   = sec->fileName();
         m_anchor = sec->label();
         m_hasCaptionId = TRUE;
       }
       else
       {
         warn_doc_error(parser.context.fileName,parser.tokenizer.getLineNr(),"Invalid caption id '%s'",qPrint(opt.value));
       }
     }
     else // copy attribute
     {
       m_attribs.push_back(opt);
     }
   }
   m_parent = parent;
 }

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

成员函数说明

◆ anchor()

QCString DocHtmlCaption::anchor ( ) const

inline

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

1361 { return m_anchor; }

引用了 m_anchor.

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

◆ attribs()

const HtmlAttribList& DocHtmlCaption::attribs ( ) const

inline

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

1357 { return m_attribs; }

引用了 m_attribs.

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

◆ file()

QCString DocHtmlCaption::file ( ) const

inline

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

1360 { return m_file; }

引用了 m_file.

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

◆ hasCaptionId()

bool DocHtmlCaption::hasCaptionId ( ) const

inline

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

1359 { return m_hasCaptionId; }

引用了 m_hasCaptionId.

◆ kind()

Kind DocHtmlCaption::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

1356 { return Kind_HtmlCaption; }

引用了 DocNode::Kind_HtmlCaption.

◆ parse()

int DocHtmlCaption::parse ( )

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

 {
   int retval=0;
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocHtmlCaption::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_CAPTION && m_parser.context.token->endTag) // found </caption> tag
             {
               retval = RetVal_OK;
               goto endcaption;
             }
             else
             {
               warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected html tag <%s%s> found within <caption> context",
                   m_parser.context.token->endTag?"/":"",qPrint(m_parser.context.token->name));
             }
           }
           break;
         default:
           m_parser.errorHandleDefaultToken(this,tok,m_children,"<caption> tag");
           break;
       }
     }
   }
   if (tok==0)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected end of comment while inside"
            " <caption> tag");
   }
 endcaption:
   m_parser.handlePendingStyleCommands(this,m_children);
   DBG(("DocHtmlCaption::parse() end\n"));
   return retval;
 }

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

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

类成员变量说明

◆ m_anchor

QCString DocHtmlCaption::m_anchor

private

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

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

◆ m_attribs

HtmlAttribList DocHtmlCaption::m_attribs

private

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

被这些函数引用 attribs() , 以及 DocHtmlCaption().

◆ m_file

QCString DocHtmlCaption::m_file

private

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

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

◆ m_hasCaptionId

bool DocHtmlCaption::m_hasCaptionId = false

private

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

被这些函数引用 DocHtmlCaption() , 以及 hasCaptionId().

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocHtmlCaption()

成员函数说明

◆ anchor()

◆ attribs()

◆ file()

◆ hasCaptionId()

◆ kind()

◆ parse()

类成员变量说明

◆ m_anchor

◆ m_attribs

◆ m_file

◆ m_hasCaptionId