Node representing a Html list 更多...

#include <docparser.h>

类 DocHtmlList 继承关系图:

DocHtmlList 的协作图:

Public 类型
enum	Type { Unordered, Ordered }

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 }

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

Kind	kind () const override

Type	type () const

const HtmlAttribList &	attribs () const

int	parse ()

int	parseXml ()

Public 成员函数继承自 CompAccept< DocHtmlList >
	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 属性
Type	m_type = Unordered

HtmlAttribList	m_attribs

额外继承的成员函数
Protected 类型继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }

Protected 成员函数继承自 DocNode
void	setInsidePreformatted (bool p)

Protected 属性继承自 CompAccept< DocHtmlList >
DocNodeList	m_children

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

DocParser &	m_parser

详细描述

Node representing a Html list

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

成员枚举类型说明

◆ Type

enum DocHtmlList::Type

枚举值
Unordered
Ordered

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

1096 { Unordered, Ordered };

构造及析构函数说明

◆ DocHtmlList()

DocHtmlList::DocHtmlList	(	DocParser &	parser,
		DocNode *	parent,
		const HtmlAttribList &	attribs,
		Type	t
	)

inline

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

1097 :

1098 CompAccept<DocHtmlList>(parser), m_type(t), m_attribs(attribs) { m_parent = parent; }

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

成员函数说明

◆ attribs()

const HtmlAttribList& DocHtmlList::attribs ( ) const

inline

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

1101 { return m_attribs; }

引用了 m_attribs.

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

◆ kind()

Kind DocHtmlList::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

1099 { return Kind_HtmlList; }

引用了 DocNode::Kind_HtmlList.

◆ parse()

int DocHtmlList::parse ( )

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

 {
   DBG(("DocHtmlList::parse() start\n"));
   int retval=RetVal_OK;
   int num=1;
   auto ns = AutoNodeStack(m_parser,this);
  
   // get next token
   int tok=m_parser.tokenizer.lex();
   // skip whitespace and paragraph breaks
   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_LI && !m_parser.context.token->endTag) // found <li> tag
     {
       // ok, we can go on.
     }
     else if (((m_type==Unordered && tagId==HTML_UL) ||
               (m_type==Ordered   && tagId==HTML_OL)
              ) && m_parser.context.token->endTag
             ) // found empty list
     {
       // add dummy item to obtain valid HTML
       m_children.push_back(std::make_unique<DocHtmlListItem>(m_parser,this,HtmlAttribList(),1));
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"empty list!");
       retval = RetVal_EndList;
       goto endlist;
     }
     else // found some other tag
     {
       // add dummy item to obtain valid HTML
       m_children.push_back(std::make_unique<DocHtmlListItem>(m_parser,this,HtmlAttribList(),1));
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <li> tag but "
           "found <%s%s> instead!",m_parser.context.token->endTag?"/":"",qPrint(m_parser.context.token->name));
       m_parser.tokenizer.pushBackHtmlTag(m_parser.context.token->name);
       goto endlist;
     }
   }
   else if (tok==0) // premature end of comment
   {
     // add dummy item to obtain valid HTML
     m_children.push_back(std::make_unique<DocHtmlListItem>(m_parser,this,HtmlAttribList(),1));
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while looking"
         " for a html list item");
     goto endlist;
   }
   else // token other than html token
   {
     // add dummy item to obtain valid HTML
     m_children.push_back(std::make_unique<DocHtmlListItem>(m_parser,this,HtmlAttribList(),1));
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <li> tag but found %s token instead!",
         DocTokenizer::tokToString(tok));
     goto endlist;
   }
  
   do
   {
     DocHtmlListItem *li=new DocHtmlListItem(m_parser,this,m_parser.context.token->attribs,num++);
     m_children.push_back(std::unique_ptr<DocHtmlListItem>(li));
     retval=li->parse();
   } while (retval==RetVal_ListItem);
  
   if (retval==0)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while inside <%cl> block",
         m_type==Unordered ? 'u' : 'o');
   }
  
 endlist:
   DBG(("DocHtmlList::parse() end retval=%s\n",DocTokenizer::retvalToString(retval)));
   return retval==RetVal_EndList ? RetVal_OK : retval;
 }

引用了 TokenInfo::attribs, DocParser::context, DBG, TokenInfo::endTag, DocParserContext::fileName, DocTokenizer::getLineNr(), HTML_LI, HTML_OL, HTML_UL, Mappers::htmlTagMapper, DocTokenizer::lex(), CompAccept< DocHtmlList >::m_children, DocNode::m_parser, m_type, Mapper::map(), TokenInfo::name, Ordered, DocHtmlListItem::parse(), DocTokenizer::pushBackHtmlTag(), qPrint(), RetVal_EndList, RetVal_ListItem, RetVal_OK, DocTokenizer::retvalToString(), TK_HTMLTAG, TK_NEWPARA, TK_WHITESPACE, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString(), Unordered , 以及 warn_doc_error().

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

◆ parseXml()

int DocHtmlList::parseXml ( )

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

 {
   DBG(("DocHtmlList::parseXml() start\n"));
   int retval=RetVal_OK;
   int num=1;
   auto ns = AutoNodeStack(m_parser,this);
  
   // get next token
   int tok=m_parser.tokenizer.lex();
   // skip whitespace and paragraph breaks
   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);
     //printf("m_parser.context.token->name=%s m_parser.context.token->endTag=%d\n",qPrint(m_parser.context.token->name),m_parser.context.token->endTag);
     if (tagId==XML_ITEM && !m_parser.context.token->endTag) // found <item> tag
     {
       // ok, we can go on.
     }
     else // found some other tag
     {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <item> tag but "
           "found <%s> instead!",qPrint(m_parser.context.token->name));
       m_parser.tokenizer.pushBackHtmlTag(m_parser.context.token->name);
       goto endlist;
     }
   }
   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 list item");
     goto endlist;
   }
   else // token other than html token
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"expected <item> tag but found %s token instead!",
         DocTokenizer::tokToString(tok));
     goto endlist;
   }
  
   do
   {
     DocHtmlListItem *li=new DocHtmlListItem(m_parser,this,m_parser.context.token->attribs,num++);
     m_children.push_back(std::unique_ptr<DocHtmlListItem>(li));
     retval=li->parseXml();
     if (retval==0) break;
     //printf("retval=%x m_parser.context.token->name=%s\n",retval,qPrint(m_parser.context.token->name));
   } while (retval==RetVal_ListItem);
  
   if (retval==0)
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"unexpected end of comment while inside <list type=\"%s\"> block",
         m_type==Unordered ? "bullet" : "number");
   }
  
 endlist:
   DBG(("DocHtmlList::parseXml() end retval=%s\n",DocTokenizer::retvalToString(retval)));
   return retval==RetVal_EndList ||
          (retval==RetVal_CloseXml || m_parser.context.token->name=="list") ?
          RetVal_OK : retval;
 }

引用了 TokenInfo::attribs, DocParser::context, DBG, TokenInfo::endTag, DocParserContext::fileName, DocTokenizer::getLineNr(), Mappers::htmlTagMapper, DocTokenizer::lex(), CompAccept< DocHtmlList >::m_children, DocNode::m_parser, m_type, Mapper::map(), TokenInfo::name, DocHtmlListItem::parseXml(), DocTokenizer::pushBackHtmlTag(), qPrint(), RetVal_CloseXml, RetVal_EndList, RetVal_ListItem, RetVal_OK, DocTokenizer::retvalToString(), TK_HTMLTAG, TK_NEWPARA, TK_WHITESPACE, DocParserContext::token, DocParser::tokenizer, DocTokenizer::tokToString(), Unordered, warn_doc_error() , 以及 XML_ITEM.

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

◆ type()

Type DocHtmlList::type ( ) const

inline

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

1100 { return m_type; }

引用了 m_type.

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

类成员变量说明

◆ m_attribs

HtmlAttribList DocHtmlList::m_attribs

private

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

被这些函数引用 attribs().

◆ m_type

Type DocHtmlList::m_type = Unordered

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 类型

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Type

构造及析构函数说明

◆ DocHtmlList()

成员函数说明

◆ attribs()

◆ kind()

◆ parse()

◆ parseXml()

◆ type()

类成员变量说明

◆ m_attribs

◆ m_type