Node representing a include/dontinclude operator block 更多...

#include <docparser.h>

类 DocIncOperator 继承关系图:

DocIncOperator 的协作图:

Public 类型
enum	Type { Line, SkipLine, Skip, Until }

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

Kind	kind () const override

Type	type () const

const char *	typeAsString () const

int	line () const

bool	showLineNo () const

QCString	text () const

QCString	pattern () const

QCString	context () const

void	accept (DocVisitor *v) override

bool	isFirst () const

bool	isLast () const

void	markFirst (bool v=TRUE)

void	markLast (bool v=TRUE)

bool	isExample () const

QCString	exampleFile () const

QCString	includeFileName () const

void	parse ()

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

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private 属性
Type	m_type = Line

int	m_line = 0

bool	m_showLineNo = false

QCString	m_text

QCString	m_pattern

QCString	m_context

bool	m_isFirst = false

bool	m_isLast = false

bool	m_isExample = false

QCString	m_exampleFile

QCString	m_includeFileName

额外继承的成员函数
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 a include/dontinclude operator block

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

成员枚举类型说明

◆ Type

enum DocIncOperator::Type

枚举值
Line
SkipLine
Skip
Until

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

609 { Line, SkipLine, Skip, Until };

构造及析构函数说明

◆ DocIncOperator()

DocIncOperator::DocIncOperator	(	DocParser &	parser,
		DocNode *	parent,
		Type	t,
		const QCString &	pat,
		const QCString &	context,
		bool	isExample,
		const QCString &	exampleFile
	)

inline

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

                                                                                        :
       DocNode(parser), m_type(t), m_pattern(pat), m_context(context),
       m_isFirst(FALSE), m_isLast(FALSE),
       m_isExample(isExample), m_exampleFile(exampleFile) { m_parent = parent; }

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

成员函数说明

◆ accept()

void DocIncOperator::accept ( DocVisitor * v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

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

633 { v->visit(this); }

引用了 DocVisitor::visit().

◆ context()

QCString DocIncOperator::context ( ) const

inline

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

632 { return m_context; }

引用了 m_context.

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

◆ exampleFile()

QCString DocIncOperator::exampleFile ( ) const

inline

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

639 { return m_exampleFile; }

引用了 m_exampleFile.

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

◆ includeFileName()

QCString DocIncOperator::includeFileName ( ) const

inline

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

640 { return m_includeFileName; }

引用了 m_includeFileName.

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

◆ isExample()

bool DocIncOperator::isExample ( ) const

inline

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

638 { return m_isExample; }

引用了 m_isExample.

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

◆ isFirst()

bool DocIncOperator::isFirst ( ) const

inline

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

634 { return m_isFirst; }

引用了 m_isFirst.

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

◆ isLast()

bool DocIncOperator::isLast ( ) const

inline

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

635 { return m_isLast; }

引用了 m_isLast.

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

◆ kind()

Kind DocIncOperator::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

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

615 { return Kind_IncOperator; }

引用了 DocNode::Kind_IncOperator.

◆ line()

int DocIncOperator::line ( ) const

inline

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

628 { return m_line; }

引用了 m_line.

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

◆ markFirst()

void DocIncOperator::markFirst ( bool v = TRUE )

inline

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

636 { m_isFirst = v; }

引用了 m_isFirst.

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

◆ markLast()

void DocIncOperator::markLast ( bool v = TRUE )

inline

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

637 { m_isLast = v; }

引用了 m_isLast.

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

◆ parse()

void DocIncOperator::parse ( )

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

 {
   if (m_parser.context.includeFileName.isEmpty())
   {
     warn_doc_error(m_parser.context.fileName,m_parser.tokenizer.getLineNr(),
                    "No previous '\\include' or '\\dontinclude' command for '\\%s' present",
                    typeAsString());
   }
  
   m_includeFileName = m_parser.context.includeFileName;
   const char *p = m_parser.context.includeFileText.data();
   uint l = m_parser.context.includeFileLength;
   uint o = m_parser.context.includeFileOffset;
   int il = m_parser.context.includeFileLine;
   DBG(("DocIncOperator::parse() text=%s off=%d len=%d\n",p,o,l));
   uint so = o,bo;
   bool nonEmpty = FALSE;
   switch(type())
   {
     case Line:
       while (o<l)
       {
         char c = p[o];
         if (c=='\n')
         {
           m_parser.context.includeFileLine++;
           if (nonEmpty) break; // we have a pattern to match
           so=o+1; // no pattern, skip empty line
         }
         else if (!isspace((uchar)c)) // no white space char
         {
           nonEmpty=TRUE;
         }
         o++;
       }
       if (m_parser.context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)
       {
         m_line  = il;
         m_text = m_parser.context.includeFileText.mid(so,o-so);
         DBG(("DocIncOperator::parse() Line: %s\n",qPrint(m_text)));
       }
       m_parser.context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line
       m_showLineNo = m_parser.context.includeFileShowLineNo;
       break;
     case SkipLine:
       while (o<l)
       {
         so=o;
         while (o<l)
         {
           char c = p[o];
           if (c=='\n')
           {
             m_parser.context.includeFileLine++;
             if (nonEmpty) break; // we have a pattern to match
             so=o+1; // no pattern, skip empty line
           }
           else if (!isspace((uchar)c)) // no white space char
           {
             nonEmpty=TRUE;
           }
           o++;
         }
         if (m_parser.context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)
         {
           m_line  = il;
           m_text = m_parser.context.includeFileText.mid(so,o-so);
           DBG(("DocIncOperator::parse() SkipLine: %s\n",qPrint(m_text)));
           break;
         }
         o++; // skip new line
       }
       m_parser.context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line
       m_showLineNo = m_parser.context.includeFileShowLineNo;
       break;
     case Skip:
       while (o<l)
       {
         so=o;
         while (o<l)
         {
           char c = p[o];
           if (c=='\n')
           {
             m_parser.context.includeFileLine++;
             if (nonEmpty) break; // we have a pattern to match
             so=o+1; // no pattern, skip empty line
           }
           else if (!isspace((uchar)c)) // no white space char
           {
             nonEmpty=TRUE;
           }
           o++;
         }
         if (m_parser.context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)
         {
           break;
         }
         o++; // skip new line
       }
       m_parser.context.includeFileOffset = so; // set pointer to start of new line
       m_showLineNo = m_parser.context.includeFileShowLineNo;
       break;
     case Until:
       bo=o;
       while (o<l)
       {
         so=o;
         while (o<l)
         {
           char c = p[o];
           if (c=='\n')
           {
             m_parser.context.includeFileLine++;
             if (nonEmpty) break; // we have a pattern to match
             so=o+1; // no pattern, skip empty line
           }
           else if (!isspace((uchar)c)) // no white space char
           {
             nonEmpty=TRUE;
           }
           o++;
         }
         if (m_parser.context.includeFileText.mid(so,o-so).find(m_pattern)!=-1)
         {
           m_line  = il;
           m_text = m_parser.context.includeFileText.mid(bo,o-bo);
           DBG(("DocIncOperator::parse() Until: %s\n",qPrint(m_text)));
           break;
         }
         o++; // skip new line
       }
       m_parser.context.includeFileOffset = std::min(l,o+1); // set pointer to start of new line
       m_showLineNo = m_parser.context.includeFileShowLineNo;
       break;
   }
 }

引用了 DocParser::context, QCString::data(), DBG, FALSE, DocParserContext::fileName, QCString::find(), DocTokenizer::getLineNr(), DocParserContext::includeFileLength, DocParserContext::includeFileLine, DocParserContext::includeFileName, DocParserContext::includeFileOffset, DocParserContext::includeFileShowLineNo, DocParserContext::includeFileText, QCString::isEmpty(), reg::isspace(), Line, m_includeFileName, m_line, DocNode::m_parser, m_pattern, m_showLineNo, m_text, QCString::mid(), qPrint(), Skip, SkipLine, DocParser::tokenizer, TRUE, type(), typeAsString(), Until , 以及 warn_doc_error().

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

◆ pattern()

QCString DocIncOperator::pattern ( ) const

inline

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

631 { return m_pattern; }

引用了 m_pattern.

◆ showLineNo()

bool DocIncOperator::showLineNo ( ) const

inline

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

629 { return m_showLineNo; }

引用了 m_showLineNo.

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

◆ text()

QCString DocIncOperator::text ( ) const

inline

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

630 { return m_text; }

引用了 m_text.

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

◆ type()

Type DocIncOperator::type ( ) const

inline

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

616 { return m_type; }

引用了 m_type.

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

◆ typeAsString()

const char* DocIncOperator::typeAsString ( ) const

inline

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

     {
       switch(m_type)
       {
         case Line:     return "line";
         case SkipLine: return "skipline";
         case Skip:     return "skip";
         case Until:    return "until";
       }
       return "";
     }

引用了 Line, m_type, Skip, SkipLine , 以及 Until.

被这些函数引用 parse().

类成员变量说明

◆ m_context

QCString DocIncOperator::m_context

private

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

被这些函数引用 context().

◆ m_exampleFile

QCString DocIncOperator::m_exampleFile

private

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

被这些函数引用 exampleFile().

◆ m_includeFileName

QCString DocIncOperator::m_includeFileName

private

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

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

◆ m_isExample

bool DocIncOperator::m_isExample = false

private

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

被这些函数引用 isExample().

◆ m_isFirst

bool DocIncOperator::m_isFirst = false

private

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

被这些函数引用 isFirst() , 以及 markFirst().

◆ m_isLast

bool DocIncOperator::m_isLast = false

private

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

被这些函数引用 isLast() , 以及 markLast().

◆ m_line

int DocIncOperator::m_line = 0

private

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

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

◆ m_pattern

QCString DocIncOperator::m_pattern

private

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

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

◆ m_showLineNo

bool DocIncOperator::m_showLineNo = false

private

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

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

◆ m_text

QCString DocIncOperator::m_text

private

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

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

◆ m_type

Type DocIncOperator::m_type = Line

private

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

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

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

src/docparser.h
src/docparser.cpp

Public 类型

Public 成员函数

Private 属性

额外继承的成员函数

详细描述

成员枚举类型说明

◆ Type

构造及析构函数说明

◆ DocIncOperator()

成员函数说明

◆ accept()

◆ context()

◆ exampleFile()

◆ includeFileName()

◆ isExample()

◆ isFirst()

◆ isLast()

◆ kind()

◆ line()

◆ markFirst()

◆ markLast()

◆ parse()

◆ pattern()

◆ showLineNo()

◆ text()

◆ type()

◆ typeAsString()

类成员变量说明

◆ m_context

◆ m_exampleFile

◆ m_includeFileName

◆ m_isExample

◆ m_isFirst

◆ m_isLast

◆ m_line

◆ m_pattern

◆ m_showLineNo

◆ m_text

◆ m_type