DocHtmlDescList类 参考

Node representing a Html description list 更多...

#include <docparser.h>

类 DocHtmlDescList 继承关系图:

DocHtmlDescList 的协作图:

Public 成员函数
	DocHtmlDescList (DocParser &parser, DocNode *parent, const HtmlAttribList &attribs)
Kind	kind () const override
const HtmlAttribList &	attribs () const
int	parse ()
Public 成员函数 继承自 CompAccept< DocHtmlDescList >
	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< DocHtmlDescList >
DocNodeList	m_children
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a Html description list

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

构造及析构函数说明

DocHtmlDescList()

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

inline

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

                                                                                     :
      CompAccept<DocHtmlDescList>(parser), m_attribs(attribs) { m_parent = parent; }

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

成员函数说明

attribs()

const HtmlAttribList& DocHtmlDescList::attribs ( ) const

inline

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

{ return m_attribs; }

引用了 m_attribs.

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

kind()

Kind DocHtmlDescList::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_HtmlDescList; }

引用了 DocNode::Kind_HtmlDescList.

parse()

int DocHtmlDescList::parse

(

)

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

{
  int retval=RetVal_OK;
  auto ns = AutoNodeStack(m_parser,this);
  DBG(("DocHtmlDescList::parse() start\n"));
 
  // get next token
  int tok=m_parser.tokenizer.lex();
  // skip whitespace
  while (tok==TK_WHITESPACE || tok==TK_NEWPARA) tok=m_parser.tokenizer.lex();
  // should find a html tag now
  if (tok==TK_HTMLTAG)
  {
    int tagId=Mappers::htmlTagMapper->map(m_parser.context.token->name);
    if (tagId==HTML_DT && !m_parser.context.token->endTag) // found <dt> tag
    {
      // continue
    }
    else // found some other tag
    {
      warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <dt> tag but "
          "found <%s> instead!",qPrint(m_parser.context.token->name));
      m_parser.tokenizer.pushBackHtmlTag(m_parser.context.token->name);
      goto enddesclist;
    }
  }
  else if (tok==0) // premature end of comment
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while looking"
        " for a html description title");
    goto enddesclist;
  }
  else // token other than html token
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <dt> tag but found %s token instead!",
        DocTokenizer::tokToString(tok));
    goto enddesclist;
  }
 
  do
  {
    DocHtmlDescTitle *dt=new DocHtmlDescTitle(m_parser,this,m_parser.context.token->attribs);
    m_children.push_back(std::unique_ptr<DocHtmlDescTitle>(dt));
    DocHtmlDescData *dd=new DocHtmlDescData(m_parser,this);
    m_children.push_back(std::unique_ptr<DocHtmlDescData>(dd));
    retval=dt->parse();
    if (retval==RetVal_DescData)
    {
      retval=dd->parse();
    }
    else if (retval!=RetVal_DescTitle)
    {
      // error
      break;
    }
  } while (retval==RetVal_DescTitle);
 
  if (retval==0)
  {
    warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while inside <dl> block");
  }
 
enddesclist:
 
  DBG(("DocHtmlDescList::parse() end\n"));
  return retval==RetVal_EndDesc ? RetVal_OK : retval;
}

引用了 TokenInfo::attribs, DocParser::context, DBG, TokenInfo::endTag, DocParserContext::fileName, DocTokenizer::getLineNr(), HTML_DT, Mappers::htmlTagMapper, DocTokenizer::lex(), CompAccept< DocHtmlDescList >::m_children, DocNode::m_parser, Mapper::map(), TokenInfo::name, DocHtmlDescTitle::parse(), DocHtmlDescData::parse(), DocTokenizer::pushBackHtmlTag(), qPrint(), RetVal_DescData, RetVal_DescTitle, RetVal_EndDesc, RetVal_OK, TK_HTMLTAG, TK_NEWPARA, TK_WHITESPACE, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString() , 以及 warn_doc_error().

被这些函数引用 DocPara::handleHtmlStartTag().

类成员变量说明

m_attribs

HtmlAttribList DocHtmlDescList::m_attribs

private

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

被这些函数引用 attribs().

---

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

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