Node representing an included text block from file 更多...

#include <docparser.h>

类 DocInclude 继承关系图:

DocInclude 的协作图:

Public 类型
enum	Type { Include, DontInclude, VerbInclude, HtmlInclude, LatexInclude, IncWithLines, Snippet, IncludeDoc, SnippetDoc, SnipWithLines, DontIncWithLines, RtfInclude, ManInclude, DocbookInclude, XmlInclude }

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 成员函数
	DocInclude (DocParser &parser, DocNode *parent, const QCString &file, const QCString &context, Type t, bool isExample, const QCString &exampleFile, const QCString &blockId, bool isBlock)

Kind	kind () const override

QCString	file () const

QCString	extension () const

Type	type () const

QCString	text () const

QCString	context () const

QCString	blockId () const

bool	isExample () const

QCString	exampleFile () const

bool	isBlock () const

void	accept (DocVisitor *v) override

void	parse ()

Public 成员函数继承自 DocNode
	DocNode (DocParser &parser)

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private 属性
QCString	m_file

QCString	m_context

QCString	m_text

Type	m_type

bool	m_isExample

bool	m_isBlock

QCString	m_exampleFile

QCString	m_blockId

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

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

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

DocParser &	m_parser

详细描述

Node representing an included text block from file

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

成员枚举类型说明

◆ Type

enum DocInclude::Type

枚举值
Include
DontInclude
VerbInclude
HtmlInclude
LatexInclude
IncWithLines
Snippet
IncludeDoc
SnippetDoc
SnipWithLines
DontIncWithLines
RtfInclude
ManInclude
DocbookInclude
XmlInclude

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

             { Include, DontInclude, VerbInclude, HtmlInclude, LatexInclude,
               IncWithLines, Snippet , IncludeDoc, SnippetDoc, SnipWithLines,
               DontIncWithLines, RtfInclude, ManInclude, DocbookInclude, XmlInclude};

构造及析构函数说明

◆ DocInclude()

DocInclude::DocInclude	(	DocParser &	parser,
		DocNode *	parent,
		const QCString &	file,
		const QCString &	context,
		Type	t,
		bool	isExample,
		const QCString &	exampleFile,
		const QCString &	blockId,
		bool	isBlock
	)

inline

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

                                                       :
       DocNode(parser), m_file(file), m_context(context), m_type(t),
       m_isExample(isExample), m_isBlock(isBlock),
       m_exampleFile(exampleFile), m_blockId(blockId) { m_parent = parent; }

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

成员函数说明

◆ accept()

void DocInclude::accept ( DocVisitor * v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

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

591 { v->visit(this); }

引用了 DocVisitor::visit().

◆ blockId()

QCString DocInclude::blockId ( ) const

inline

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

587 { return m_blockId; }

引用了 m_blockId.

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

◆ context()

QCString DocInclude::context ( ) const

inline

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

586 { return m_context; }

引用了 m_context.

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

◆ exampleFile()

QCString DocInclude::exampleFile ( ) const

inline

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

589 { return m_exampleFile; }

引用了 m_exampleFile.

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

◆ extension()

QCString DocInclude::extension ( ) const

inline

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

                                  { int i=m_file.findRev('.');
                                    if (i!=-1)
                                      return m_file.right(m_file.length()-(uint)i);
                                    else
                                      return QCString();
                                  }

引用了 QCString::findRev(), QCString::length(), m_file , 以及 QCString::right().

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

◆ file()

QCString DocInclude::file ( ) const

inline

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

577 { return m_file; }

引用了 m_file.

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

◆ isBlock()

bool DocInclude::isBlock ( ) const

inline

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

590 { return m_isBlock; }

引用了 m_isBlock.

被这些函数引用 HtmlDocVisitor::visit() , 以及 XmlDocVisitor::visit().

◆ isExample()

bool DocInclude::isExample ( ) const

inline

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

588 { return m_isExample; }

引用了 m_isExample.

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

◆ kind()

Kind DocInclude::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

576 { return Kind_Include; }

引用了 DocNode::Kind_Include.

被这些函数引用 isInvisibleNode().

◆ parse()

void DocInclude::parse ( )

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

 {
   DBG(("DocInclude::parse(file=%s,text=%s)\n",qPrint(m_file),qPrint(m_text)));
   switch(m_type)
   {
     case DontIncWithLines:
       // fall through
     case IncWithLines:
       // fall through
     case Include:
       // fall through
     case DontInclude:
       m_parser.readTextFileByName(m_file,m_text);
       m_parser.context.includeFileName   = m_file;
       m_parser.context.includeFileText   = m_text;
       m_parser.context.includeFileOffset = 0;
       m_parser.context.includeFileLength = m_text.length();
       m_parser.context.includeFileLine   = 0;
       m_parser.context.includeFileShowLineNo = (m_type == DontIncWithLines || m_type == IncWithLines);
       //printf("parser.context.includeFile=<<%s>>\n",qPrint(parser.context.includeFileText));
       break;
     case VerbInclude:
       // fall through
     case HtmlInclude:
     case LatexInclude:
     case DocInclude::RtfInclude:
     case DocInclude::ManInclude:
     case DocInclude::XmlInclude:
     case DocInclude::DocbookInclude:
       m_parser.readTextFileByName(m_file,m_text);
       break;
     case Snippet:
     case SnipWithLines:
       m_parser.readTextFileByName(m_file,m_text);
       // check here for the existence of the blockId inside the file, so we
       // only generate the warning once.
       int count;
       if (!m_blockId.isEmpty() && (count=m_text.contains(m_blockId.data()))!=2)
       {
         warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),"block marked with %s for \\snippet should appear twice in file %s, found it %d times\n",
             qPrint(m_blockId),qPrint(m_file),count);
       }
       break;
     case DocInclude::SnippetDoc:
     case DocInclude::IncludeDoc:
       err("Internal inconsistency: found switch SnippetDoc / IncludeDoc in file: %s"
           "Please create a bug report\n",__FILE__);
       break;
   }
 }

引用了 QCString::contains(), DocParser::context, QCString::data(), DBG, DocbookInclude, DontInclude, DontIncWithLines, err(), DocParserContext::fileName, DocTokenizer::getLineNr(), HtmlInclude, Include, IncludeDoc, DocParserContext::includeFileLength, DocParserContext::includeFileLine, DocParserContext::includeFileName, DocParserContext::includeFileOffset, DocParserContext::includeFileShowLineNo, DocParserContext::includeFileText, IncWithLines, QCString::isEmpty(), LatexInclude, QCString::length(), m_blockId, m_file, DocNode::m_parser, m_text, m_type, ManInclude, qPrint(), DocParser::readTextFileByName(), RtfInclude, Snippet, SnippetDoc, SnipWithLines, DocParser::tokenizer, VerbInclude, warn_doc_error() , 以及 XmlInclude.

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

◆ text()

QCString DocInclude::text ( ) const

inline

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

585 { return m_text; }

引用了 m_text.

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

◆ type()

Type DocInclude::type ( ) const

inline

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

584 { return m_type; }

引用了 m_type.

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

类成员变量说明

◆ m_blockId

QCString DocInclude::m_blockId

private

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

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

◆ m_context

QCString DocInclude::m_context

private

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

被这些函数引用 context().

◆ m_exampleFile

QCString DocInclude::m_exampleFile

private

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

被这些函数引用 exampleFile().

◆ m_file

QCString DocInclude::m_file

private

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

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

◆ m_isBlock

bool DocInclude::m_isBlock

private

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

被这些函数引用 isBlock().

◆ m_isExample

bool DocInclude::m_isExample

private

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

被这些函数引用 isExample().

◆ m_text

QCString DocInclude::m_text

private

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

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

◆ m_type

Type DocInclude::m_type

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 类型

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Type

构造及析构函数说明

◆ DocInclude()

成员函数说明

◆ accept()

◆ blockId()

◆ context()

◆ exampleFile()

◆ extension()

◆ file()

◆ isBlock()

◆ isExample()

◆ kind()

◆ parse()

◆ text()

◆ type()

类成员变量说明

◆ m_blockId

◆ m_context

◆ m_exampleFile

◆ m_file

◆ m_isBlock

◆ m_isExample

◆ m_text

◆ m_type