Node representing a simple section 更多...

#include <docparser.h>

类 DocSimpleSect 继承关系图:

DocSimpleSect 的协作图:

Public 类型
enum	Type { Unknown, See, Return, Author, Authors, Version, Since, Date, Note, Warning, Copyright, Pre, Post, Invar, Remark, Attention, User, Rcs }

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 成员函数
	DocSimpleSect (DocParser &parser, DocNode *parent, Type t)

virtual	~DocSimpleSect ()

Kind	kind () const override

Type	type () const

QCString	typeString () const

void	accept (DocVisitor *v) override

int	parse (bool userTitle, bool needsSeparator)

int	parseRcs ()

int	parseXml ()

void	appendLinkWord (const QCString &word)

bool	hasTitle () const

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

DocTitle *	m_title = 0

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

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

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

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

DocParser &	m_parser

详细描述

Node representing a simple section

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

成员枚举类型说明

◆ Type

enum DocSimpleSect::Type

枚举值
Unknown
See
Return
Author
Authors
Version
Since
Date
Note
Warning
Copyright
Pre
Post
Invar
Remark
Attention
User
Rcs

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

     {
        Unknown, See, Return, Author, Authors, Version, Since, Date,
        Note, Warning, Copyright, Pre, Post, Invar, Remark, Attention, User, Rcs
     };

构造及析构函数说明

◆ DocSimpleSect()

DocSimpleSect::DocSimpleSect	(	DocParser &	parser,
		DocNode *	parent,
		Type	t
	)

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

                                                                      :
      CompAccept<DocSimpleSect>(parser), m_type(t)
 {
   m_parent = parent;
   m_title=0;
 }

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

◆ ~DocSimpleSect()

DocSimpleSect::~DocSimpleSect ( )

virtual

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

 {
   delete m_title;
 }

引用了 m_title.

成员函数说明

◆ accept()

void DocSimpleSect::accept ( DocVisitor * v )

overridevirtual

Acceptor function for node visitors. Part of the visitor pattern.

参数

v	Abstract visitor.

实现了 DocNode.

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

 {
   v->visitPre(this);
   if (m_title) m_title->accept(v);
   for (const auto &n : m_children) n->accept(v);
   v->visitPost(this);
 }

引用了 CompAccept< T >::accept(), CompAccept< DocSimpleSect >::m_children, m_title, DocVisitor::visitPost() , 以及 DocVisitor::visitPre().

◆ appendLinkWord()

void DocSimpleSect::appendLinkWord ( const QCString & word )

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

 {
   DocPara *p;
   if (m_children.empty() || m_children.back()->kind()!=DocNode::Kind_Para)
   {
     p = new DocPara(m_parser,this);
     m_children.push_back(std::unique_ptr<DocPara>(p));
   }
   else
   {
     p = (DocPara *)m_children.back().get();
  
     // Comma-separate <seealso> links.
     p->injectToken(TK_WORD,",");
     p->injectToken(TK_WHITESPACE," ");
   }
  
   m_parser.context.inSeeBlock=TRUE;
   p->injectToken(TK_LNKWORD,word);
   m_parser.context.inSeeBlock=FALSE;
 }

引用了 DocParser::context, FALSE, DocPara::injectToken(), DocParserContext::inSeeBlock, DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, DocNode::m_parser, TK_LNKWORD, TK_WHITESPACE, TK_WORD , 以及 TRUE.

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

◆ hasTitle()

bool DocSimpleSect::hasTitle ( ) const

inline

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

1129 { return m_title->hasTitle(); }

引用了 DocTitle::hasTitle() , 以及 m_title.

被这些函数引用 DocbookDocVisitor::visitPost() , 以及 DocbookDocVisitor::visitPre().

◆ kind()

Kind DocSimpleSect::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

1121 { return Kind_SimpleSect; }

引用了 DocNode::Kind_SimpleSect.

◆ parse()

int DocSimpleSect::parse	(	bool	userTitle,
		bool	needsSeparator
	)

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

 {
   DBG(("DocSimpleSect::parse() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
  
   // handle case for user defined title
   if (userTitle)
   {
     m_title = new DocTitle(m_parser,this);
     m_title->parse();
   }
  
   // add new paragraph as child
   DocPara *par = new DocPara(m_parser,this);
   if (m_children.empty())
   {
     par->markFirst();
   }
   else
   {
     ASSERT(m_children.back()->kind()==DocNode::Kind_Para);
     ((DocPara *)m_children.back().get())->markLast(FALSE);
   }
   par->markLast();
   if (needsSeparator) m_children.push_back(std::make_unique<DocSimpleSectSep>(m_parser,this));
   m_children.push_back(std::unique_ptr<DocPara>(par));
  
   // parse the contents of the paragraph
   int retval = par->parse();
  
   DBG(("DocSimpleSect::parse() end retval=%d\n",retval));
   return retval; // 0==EOF, TK_NEWPARA, TK_LISTITEM, TK_ENDLIST, RetVal_SimpleSec
 }

引用了 ASSERT, DBG, FALSE, DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, DocNode::m_parser, m_title, DocPara::markFirst(), DocPara::markLast(), DocTitle::parse() , 以及 DocPara::parse().

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

◆ parseRcs()

int DocSimpleSect::parseRcs ( )

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

 {
   DBG(("DocSimpleSect::parseRcs() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
  
   m_title = new DocTitle(m_parser,this);
   m_title->parseFromString(m_parser.context.token->name);
  
   QCString text = m_parser.context.token->text;
   m_parser.pushContext(); // this will create a new parser.context.token
   m_parser.internalValidatingParseDoc(this,m_children,text);
   m_parser.popContext(); // this will restore the old parser.context.token
  
   DBG(("DocSimpleSect::parseRcs()\n"));
   return RetVal_OK;
 }

引用了 DocParser::context, DBG, DocParser::internalValidatingParseDoc(), CompAccept< DocSimpleSect >::m_children, DocNode::m_parser, m_title, TokenInfo::name, DocTitle::parseFromString(), DocParser::popContext(), DocParser::pushContext(), RetVal_OK, TokenInfo::text , 以及 DocParserContext::token.

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

◆ parseXml()

int DocSimpleSect::parseXml ( )

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

 {
   DBG(("DocSimpleSect::parse() start\n"));
   auto ns = AutoNodeStack(m_parser,this);
  
   int retval = RetVal_OK;
   for (;;)
   {
     // add new paragraph as child
     DocPara *par = new DocPara(m_parser,this);
     if (m_children.empty())
     {
       par->markFirst();
     }
     else
     {
       ASSERT(m_children.back()->kind()==DocNode::Kind_Para);
       ((DocPara *)m_children.back().get())->markLast(FALSE);
     }
     par->markLast();
     m_children.push_back(std::unique_ptr<DocPara>(par));
  
     // parse the contents of the paragraph
     retval = par->parse();
     if (retval == 0) break;
     if (retval == RetVal_CloseXml)
     {
       retval = RetVal_OK;
       break;
     }
   }
  
   DBG(("DocSimpleSect::parseXml() end retval=%d\n",retval));
   return retval;
 }

引用了 ASSERT, DBG, FALSE, DocNode::Kind_Para, CompAccept< DocSimpleSect >::m_children, DocNode::m_parser, DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), RetVal_CloseXml , 以及 RetVal_OK.

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

◆ type()

Type DocSimpleSect::type ( ) const

inline

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

1122 { return m_type; }

引用了 m_type.

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

◆ typeString()

QCString DocSimpleSect::typeString ( ) const

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

 {
   switch (m_type)
   {
     case Unknown:    break;
     case See:        return "see";
     case Return:     return "return";
     case Author:     // fall through
     case Authors:    return "author";
     case Version:    return "version";
     case Since:      return "since";
     case Date:       return "date";
     case Note:       return "note";
     case Warning:    return "warning";
     case Pre:        return "pre";
     case Post:       return "post";
     case Copyright:  return "copyright";
     case Invar:      return "invariant";
     case Remark:     return "remark";
     case Attention:  return "attention";
     case User:       return "user";
     case Rcs:        return "rcs";
   }
   return "unknown";
 }

引用了 Attention, Author, Authors, Copyright, Date, Invar, m_type, Note, Post, Pre, Rcs, Remark, Return, See, Since, Unknown, User, Version , 以及 Warning.

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

类成员变量说明

◆ m_title

DocTitle* DocSimpleSect::m_title = 0

private

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

被这些函数引用 accept(), DocSimpleSect(), hasTitle(), parse(), parseRcs() , 以及 ~DocSimpleSect().

◆ m_type

Type DocSimpleSect::m_type = Unknown