Node representing a normal section 更多...

#include <docparser.h>

类 DocSection 继承关系图:

DocSection 的协作图:

Public 成员函数
	DocSection (DocParser &parser, DocNode *parent, int level, const QCString &id)

Kind	kind () const override

int	level () const

QCString	title () const

QCString	anchor () const

QCString	id () const

QCString	file () const

int	parse ()

Public 成员函数继承自 CompAccept< DocSection >
	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_level = 0

QCString	m_id

QCString	m_title

QCString	m_anchor

QCString	m_file

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

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

DocParser &	m_parser

详细描述

Node representing a normal section

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

构造及析构函数说明

◆ DocSection()

DocSection::DocSection	(	DocParser &	parser,
		DocNode *	parent,
		int	level,
		const QCString &	id
	)

inline

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

1004 :

1005 CompAccept<DocSection>(parser), m_level(level), m_id(id) { m_parent = parent; }

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

被这些函数引用 parse().

成员函数说明

◆ anchor()

QCString DocSection::anchor ( ) const

inline

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

1009 { return m_anchor; }

引用了 m_anchor.

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

◆ file()

QCString DocSection::file ( ) const

inline

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

1011 { return m_file; }

引用了 m_file.

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

◆ id()

QCString DocSection::id ( ) const

inline

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

1010 { return m_id; }

引用了 m_id.

◆ kind()

Kind DocSection::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

1006 { return Kind_Section; }

引用了 DocNode::Kind_Section.

◆ level()

int DocSection::level ( ) const

inline

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

1007 { return m_level; }

引用了 m_level.

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

◆ parse()

int DocSection::parse ( )

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

 {
   DBG(("DocSection::parse() start %s level=%d\n",qPrint(m_parser.context.token->sectionId),m_level));
   int retval=RetVal_OK;
   auto ns = AutoNodeStack(m_parser,this);
  
   if (!m_id.isEmpty())
   {
     const SectionInfo *sec = SectionManager::instance().find(m_id);
     if (sec)
     {
       m_file   = sec->fileName();
       m_anchor = sec->label();
       m_title  = sec->title();
       if (m_title.isEmpty()) m_title = sec->label();
     }
   }
  
   // first parse any number of paragraphs
   bool isFirst=TRUE;
   DocPara *lastPar=0;
   do
   {
     DocPara *par = new DocPara(m_parser,this);
     if (isFirst) { par->markFirst(); isFirst=FALSE; }
     retval=par->parse();
     if (!par->isEmpty())
     {
       m_children.push_back(std::unique_ptr<DocPara>(par));
       lastPar=par;
     }
     else
     {
       delete par;
     }
     if (retval==TK_LISTITEM)
     {
       warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Invalid list item found");
     }
     if (retval==RetVal_Internal)
     {
       DocInternal *in = new DocInternal(m_parser,this);
       m_children.push_back(std::unique_ptr<DocInternal>(in));
       retval = in->parse(m_level+1);
       if (retval==RetVal_EndInternal)
       {
         retval=RetVal_OK;
       }
     }
   } while (retval!=0 &&
            retval!=RetVal_Section       &&
            retval!=RetVal_Subsection    &&
            retval!=RetVal_Subsubsection &&
            retval!=RetVal_Paragraph     &&
            retval!=RetVal_EndInternal
           );
  
   if (lastPar) lastPar->markLast();
  
   //printf("m_level=%d <-> %d\n",m_level,Doxygen::subpageNestingLevel);
  
   while (true)
   {
     if (retval==RetVal_Subsection && m_level<=Doxygen::subpageNestingLevel+1)
     {
       // then parse any number of nested sections
       while (retval==RetVal_Subsection) // more sections follow
       {
         DocSection *s=new DocSection(m_parser,this,
             std::min(2+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
         m_children.push_back(std::unique_ptr<DocSection>(s));
         retval = s->parse();
       }
       break;
     }
     else if (retval==RetVal_Subsubsection && m_level<=Doxygen::subpageNestingLevel+2)
     {
       if ((m_level<=1+Doxygen::subpageNestingLevel) && !m_parser.context.token->sectionId.startsWith("autotoc_md"))
           warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected subsubsection command found inside %s!",g_sectionLevelToName[m_level]);
       // then parse any number of nested sections
       while (retval==RetVal_Subsubsection) // more sections follow
       {
         DocSection *s=new DocSection(m_parser,this,
             std::min(3+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
         m_children.push_back(std::unique_ptr<DocSection>(s));
         retval = s->parse();
       }
       if (!(m_level<Doxygen::subpageNestingLevel+2 && retval == RetVal_Subsection)) break;
     }
     else if (retval==RetVal_Paragraph && m_level<=std::min(5,Doxygen::subpageNestingLevel+3))
     {
       if ((m_level<=2+Doxygen::subpageNestingLevel) && !m_parser.context.token->sectionId.startsWith("autotoc_md"))
         warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"Unexpected paragraph command found inside %s!",g_sectionLevelToName[m_level]);
       // then parse any number of nested sections
       while (retval==RetVal_Paragraph) // more sections follow
       {
         DocSection *s=new DocSection(m_parser,this,
             std::min(4+Doxygen::subpageNestingLevel,5),m_parser.context.token->sectionId);
         m_children.push_back(std::unique_ptr<DocSection>(s));
         retval = s->parse();
       }
       if (!(m_level<Doxygen::subpageNestingLevel+3 && (retval == RetVal_Subsection || retval == RetVal_Subsubsection))) break;
     }
     else
     {
       break;
     }
   }
  
   INTERNAL_ASSERT(retval==0 ||
                   retval==RetVal_Section ||
                   retval==RetVal_Subsection ||
                   retval==RetVal_Subsubsection ||
                   retval==RetVal_Paragraph ||
                   retval==RetVal_Internal ||
                   retval==RetVal_EndInternal
                  );
  
   DBG(("DocSection::parse() end: retval=%s\n",DocTokenizer::retvalToString(retval)));
   return retval;
 }

引用了 DocParser::context, DBG, DocSection(), FALSE, SectionInfo::fileName(), DocParserContext::fileName, LinkedMap< T, Hash, KeyEqual, Map >::find(), g_sectionLevelToName, DocTokenizer::getLineNr(), SectionManager::instance(), INTERNAL_ASSERT, QCString::isEmpty(), DocPara::isEmpty(), SectionInfo::label(), m_anchor, CompAccept< DocSection >::m_children, m_file, m_id, m_level, DocNode::m_parser, m_title, DocPara::markFirst(), DocPara::markLast(), parse(), DocInternal::parse(), DocPara::parse(), qPrint(), RetVal_EndInternal, RetVal_Internal, RetVal_OK, RetVal_Paragraph, RetVal_Section, RetVal_Subsection, RetVal_Subsubsection, DocTokenizer::retvalToString(), TokenInfo::sectionId, QCString::startsWith(), Doxygen::subpageNestingLevel, SectionInfo::title(), TK_LISTITEM, DocParserContext::token, DocParser::tokenizer, TRUE , 以及 warn_doc_error().

被这些函数引用 parse(), DocInternal::parse() , 以及 DocRoot::parse().

◆ title()

QCString DocSection::title ( ) const

inline

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

1008 { return m_title; }

引用了 m_title.

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

类成员变量说明

◆ m_anchor

QCString DocSection::m_anchor

private

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

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

◆ m_file

QCString DocSection::m_file

private

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

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

◆ m_id

QCString DocSection::m_id

private

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

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

◆ m_level

int DocSection::m_level = 0

private

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

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

◆ m_title

QCString DocSection::m_title

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ DocSection()

成员函数说明

◆ anchor()

◆ file()

◆ id()

◆ kind()

◆ level()

◆ parse()

◆ title()

类成员变量说明

◆ m_anchor

◆ m_file

◆ m_id

◆ m_level

◆ m_title