Node representing a Html description item 更多...

#include <docparser.h>

类 DocHtmlDescTitle 继承关系图:

DocHtmlDescTitle 的协作图:

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

Kind	kind () const override

const HtmlAttribList &	attribs () const

int	parse ()

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

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

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

DocParser &	m_parser

详细描述

Node representing a Html description item

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

构造及析构函数说明

◆ DocHtmlDescTitle()

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

inline

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

976 :

977 CompAccept<DocHtmlDescTitle>(parser), m_attribs(attribs) { m_parent = parent; }

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

成员函数说明

◆ attribs()

const HtmlAttribList& DocHtmlDescTitle::attribs ( ) const

inline

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

979 { return m_attribs; }

引用了 m_attribs.

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

◆ kind()

Kind DocHtmlDescTitle::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

978 { return Kind_HtmlDescTitle; }

引用了 DocNode::Kind_HtmlDescTitle.

◆ parse()

int DocHtmlDescTitle::parse ( )

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

 {
   int retval=0;
   auto ns = AutoNodeStack(m_parser,this);
   DBG(("DocHtmlDescTitle::parse() start\n"));
  
   int tok;
   while ((tok=m_parser.tokenizer.lex()))
   {
     if (!m_parser.defaultHandleToken(this,tok,m_children))
     {
       const char *cmd_start = "\\";
       switch (tok)
       {
         case TK_COMMAND_AT:
           cmd_start = "@";
         // fall through
         case TK_COMMAND_BS:
           {
             QCString cmdName=m_parser.context.token->name;
             bool isJavaLink=FALSE;
             switch (Mappers::cmdMapper->map(cmdName))
             {
               case CMD_REF:
                 {
                   tok=m_parser.tokenizer.lex();
                   if (tok!=TK_WHITESPACE)
                   {
                     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\%s command",
                         qPrint(m_parser.context.token->name));
                   }
                   else
                   {
                     m_parser.tokenizer.setStateRef();
                     tok=m_parser.tokenizer.lex(); // get the reference id
                     if (tok!=TK_WORD)
                     {
                       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected token %s as the argument of \\%s command",
                           DocTokenizer::tokToString(tok),qPrint(cmdName));
                     }
                     else
                     {
                       DocRef *ref = new DocRef(m_parser,this,m_parser.context.token->name,m_parser.context.context);
                       m_children.push_back(std::unique_ptr<DocRef>(ref));
                       ref->parse();
                     }
                     m_parser.tokenizer.setStatePara();
                   }
                 }
                 break;
               case CMD_JAVALINK:
                 isJavaLink=TRUE;
                 // fall through
               case CMD_LINK:
                 {
                   tok=m_parser.tokenizer.lex();
                   if (tok!=TK_WHITESPACE)
                   {
                     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected whitespace after \\%s command",
                         qPrint(cmdName));
                   }
                   else
                   {
                     m_parser.tokenizer.setStateLink();
                     tok=m_parser.tokenizer.lex();
                     if (tok!=TK_WORD)
                     {
                       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected token %s as the argument of \\%s command",
                           DocTokenizer::tokToString(tok),qPrint(cmdName));
                     }
                     else
                     {
                       m_parser.tokenizer.setStatePara();
                       DocLink *lnk = new DocLink(m_parser,this,m_parser.context.token->name);
                       m_children.push_back(std::unique_ptr<DocLink>(lnk));
                       QCString leftOver = lnk->parse(isJavaLink);
                       if (!leftOver.isEmpty())
                       {
                         m_children.push_back(std::make_unique<DocWord>(m_parser,this,leftOver));
                       }
                     }
                   }
                 }
  
                 break;
               default:
                 warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Illegal command %s found as part of a <dt> tag",
                   qPrint(cmd_start + m_parser.context.token->name));
             }
           }
           break;
         case TK_SYMBOL:
           warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unsupported symbol \\%s found as part of a <dt> tag",
               qPrint(m_parser.context.token->name));
           break;
         case TK_HTMLTAG:
           {
             int tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
             if (tagId==HTML_DD && !m_parser.context.token->endTag) // found <dd> tag
             {
               retval = RetVal_DescData;
               goto endtitle;
             }
             else if (tagId==HTML_DT && m_parser.context.token->endTag)
             {
               // ignore </dt> tag.
             }
             else if (tagId==HTML_DT)
             {
               // missing <dt> tag.
               retval = RetVal_DescTitle;
               goto endtitle;
             }
             else if (tagId==HTML_DL && m_parser.context.token->endTag)
             {
               retval=RetVal_EndDesc;
               goto endtitle;
             }
             else if (tagId==HTML_A)
             {
               if (!m_parser.context.token->endTag)
               {
                 m_parser.handleAHref(this,m_children,m_parser.context.token->attribs);
               }
             }
             else
             {
               warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected html tag <%s%s> found within <dt> context",
                   m_parser.context.token->endTag?"/":"",qPrint(m_parser.context.token->name));
             }
           }
           break;
         default:
           warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected token %s found as part of a <dt> tag",
               DocTokenizer::tokToString(tok));
           break;
       }
     }
   }
   if (tok==0)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected end of comment while inside"
         " <dt> tag");
   }
 endtitle:
   m_parser.handlePendingStyleCommands(this,m_children);
   DBG(("DocHtmlDescTitle::parse() end\n"));
   return retval;
 }

引用了 TokenInfo::attribs, CMD_JAVALINK, CMD_LINK, CMD_REF, Mappers::cmdMapper, DocParserContext::context, DocParser::context, DBG, DocParser::defaultHandleToken(), TokenInfo::endTag, FALSE, DocParserContext::fileName, DocTokenizer::getLineNr(), DocParser::handleAHref(), DocParser::handlePendingStyleCommands(), HTML_A, HTML_DD, HTML_DL, HTML_DT, Mappers::htmlTagMapper, QCString::isEmpty(), DocTokenizer::lex(), CompAccept< DocHtmlDescTitle >::m_children, DocNode::m_parser, Mapper::map(), TokenInfo::name, DocLink::parse(), DocRef::parse(), qPrint(), RetVal_DescData, RetVal_DescTitle, RetVal_EndDesc, DocTokenizer::setStateLink(), DocTokenizer::setStatePara(), DocTokenizer::setStateRef(), TK_COMMAND_AT, TK_COMMAND_BS, TK_HTMLTAG, TK_SYMBOL, TK_WHITESPACE, TK_WORD, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString(), TRUE , 以及 warn_doc_error().

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

类成员变量说明

◆ m_attribs

HtmlAttribList DocHtmlDescTitle::m_attribs

private

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

被这些函数引用 attribs().

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数