DocAutoList类 参考

Node representing an auto List 更多...

#include <docparser.h>

类 DocAutoList 继承关系图:

DocAutoList 的协作图:

Public 成员函数
	DocAutoList (DocParser &parser, DocNode *parent, int indent, bool isEnumList, int depth)
Kind	kind () const override
bool	isEnumList () const
int	indent () const
int	depth () const
int	parse ()
Public 成员函数 继承自 CompAccept< DocAutoList >
	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 属性
int	m_indent = 0
bool	m_isEnumList = false
int	m_depth = 0

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

详细描述

Node representing an auto List

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

构造及析构函数说明

DocAutoList()

DocAutoList::DocAutoList	(	DocParser &	parser,
		DocNode *	parent,
		int	indent,
		bool	isEnumList,
		int	depth
	)

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

                                    :
      CompAccept<DocAutoList>(parser), m_indent(indent), m_isEnumList(isEnumList),
      m_depth(depth)
{
  m_parent = parent;
}

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

成员函数说明

depth()

int DocAutoList::depth ( ) const

inline

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

{ return m_depth; }

引用了 m_depth.

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

indent()

int DocAutoList::indent ( ) const

inline

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

{ return m_indent; }

引用了 m_indent.

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

isEnumList()

bool DocAutoList::isEnumList ( ) const

inline

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

{ return m_isEnumList; }

引用了 m_isEnumList.

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

kind()

Kind DocAutoList::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

{ return Kind_AutoList; }

引用了 DocNode::Kind_AutoList.

parse()

int DocAutoList::parse

(

)

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

{
  int retval = RetVal_OK;
  int num=1;
  auto ns = AutoNodeStack(m_parser,this);
  m_parser.tokenizer.startAutoList();
          // first item or sub list => create new list
  do
  {
    if (m_parser.context.token->id!=-1) // explicitly numbered list
    {
      num=m_parser.context.token->id;  // override num with real number given
    }
    DocAutoListItem *li = new DocAutoListItem(m_parser,this,m_indent,num++);
    m_children.push_back(std::unique_ptr<DocAutoListItem>(li));
    retval=li->parse();
    //printf("DocAutoList::parse(): retval=0x%x m_parser.context.token->indent=%d m_indent=%d "
    //       "m_isEnumList=%d m_parser.context.token->isEnumList=%d m_parser.context.token->name=%s\n",
    //       retval,m_parser.context.token->indent,m_indent,m_isEnumList,m_parser.context.token->isEnumList,
    //       qPrint(m_parser.context.token->name));
    //printf("num=%d m_parser.context.token->id=%d\n",num,m_parser.context.token->id);
  }
  while (retval==TK_LISTITEM &&                // new list item
         m_indent==m_parser.context.token->indent &&          // at same indent level
         m_isEnumList==m_parser.context.token->isEnumList &&  // of the same kind
         (m_parser.context.token->id==-1 || m_parser.context.token->id>=num)  // increasing number (or no number)
        );
 
  m_parser.tokenizer.endAutoList();
  return retval;
}

引用了 DocParser::context, DocTokenizer::endAutoList(), TokenInfo::id, TokenInfo::indent, TokenInfo::isEnumList, CompAccept< DocAutoList >::m_children, m_indent, m_isEnumList, DocNode::m_parser, DocAutoListItem::parse(), RetVal_OK, DocTokenizer::startAutoList(), TK_LISTITEM, DocParserContext::token , 以及 DocParser::tokenizer.

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

类成员变量说明

m_depth

int DocAutoList::m_depth = 0

private

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

被这些函数引用 depth().

m_indent

int DocAutoList::m_indent = 0

private

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

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

m_isEnumList

bool DocAutoList::m_isEnumList = false

private

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

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

---

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

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