Doxygen
DocVisitor类 参考abstract

Abstract visitor that participates in the visitor pattern. 更多...

#include <docvisitor.h>

+ 类 DocVisitor 继承关系图:

struct  Private
 

Public 成员函数

 DocVisitor (int id)
 
virtual ~DocVisitor ()
 
int id () const
 
CodeParserInterfacegetCodeParser (const QCString &langExt)
 
void pushHidden (bool hide)
 
bool popHidden ()
 
Visitor functions for leaf nodes
virtual void visit (DocWord *)=0
 
virtual void visit (DocWhiteSpace *)=0
 
virtual void visit (DocSymbol *)=0
 
virtual void visit (DocEmoji *)=0
 
virtual void visit (DocURL *)=0
 
virtual void visit (DocStyleChange *)=0
 
virtual void visit (DocVerbatim *)=0
 
virtual void visit (DocLineBreak *)=0
 
virtual void visit (DocHorRuler *)=0
 
virtual void visit (DocAnchor *)=0
 
virtual void visit (DocInclude *)=0
 
virtual void visit (DocIncOperator *)=0
 
virtual void visit (DocFormula *)=0
 
virtual void visit (DocLinkedWord *)=0
 
virtual void visit (DocIndexEntry *)=0
 
virtual void visit (DocSimpleSectSep *)=0
 
virtual void visit (DocCite *)=0
 
Visitor functions for internal nodes
virtual void visitPre (DocAutoList *)=0
 
virtual void visitPost (DocAutoList *)=0
 
virtual void visitPre (DocAutoListItem *)=0
 
virtual void visitPost (DocAutoListItem *)=0
 
virtual void visitPre (DocPara *)=0
 
virtual void visitPost (DocPara *)=0
 
virtual void visitPre (DocRoot *)=0
 
virtual void visitPost (DocRoot *)=0
 
virtual void visitPre (DocSimpleSect *)=0
 
virtual void visitPost (DocSimpleSect *)=0
 
virtual void visitPre (DocTitle *)=0
 
virtual void visitPost (DocTitle *)=0
 
virtual void visitPre (DocSimpleList *)=0
 
virtual void visitPost (DocSimpleList *)=0
 
virtual void visitPre (DocSimpleListItem *)=0
 
virtual void visitPost (DocSimpleListItem *)=0
 
virtual void visitPre (DocSection *)=0
 
virtual void visitPost (DocSection *)=0
 
virtual void visitPre (DocHtmlList *)=0
 
virtual void visitPost (DocHtmlListItem *)=0
 
virtual void visitPre (DocHtmlListItem *)=0
 
virtual void visitPost (DocHtmlList *)=0
 
virtual void visitPre (DocHtmlDescList *)=0
 
virtual void visitPost (DocHtmlDescList *)=0
 
virtual void visitPre (DocHtmlDescTitle *)=0
 
virtual void visitPost (DocHtmlDescTitle *)=0
 
virtual void visitPre (DocHtmlDescData *)=0
 
virtual void visitPost (DocHtmlDescData *)=0
 
virtual void visitPre (DocHtmlTable *)=0
 
virtual void visitPost (DocHtmlRow *)=0
 
virtual void visitPre (DocHtmlCell *)=0
 
virtual void visitPost (DocHtmlCell *)=0
 
virtual void visitPre (DocHtmlRow *)=0
 
virtual void visitPost (DocHtmlTable *)=0
 
virtual void visitPre (DocHtmlCaption *)=0
 
virtual void visitPost (DocHtmlCaption *)=0
 
virtual void visitPre (DocInternal *)=0
 
virtual void visitPost (DocInternal *)=0
 
virtual void visitPre (DocHRef *)=0
 
virtual void visitPost (DocHRef *)=0
 
virtual void visitPre (DocHtmlHeader *)=0
 
virtual void visitPost (DocHtmlHeader *)=0
 
virtual void visitPre (DocImage *)=0
 
virtual void visitPost (DocImage *)=0
 
virtual void visitPre (DocDotFile *)=0
 
virtual void visitPost (DocDotFile *)=0
 
virtual void visitPre (DocMscFile *)=0
 
virtual void visitPost (DocMscFile *)=0
 
virtual void visitPre (DocDiaFile *)=0
 
virtual void visitPost (DocDiaFile *)=0
 
virtual void visitPre (DocLink *)=0
 
virtual void visitPost (DocLink *)=0
 
virtual void visitPre (DocRef *)=0
 
virtual void visitPost (DocRef *)=0
 
virtual void visitPre (DocSecRefItem *)=0
 
virtual void visitPost (DocSecRefItem *)=0
 
virtual void visitPre (DocSecRefList *)=0
 
virtual void visitPost (DocSecRefList *)=0
 
virtual void visitPre (DocParamSect *)=0
 
virtual void visitPost (DocParamSect *)=0
 
virtual void visitPre (DocParamList *)=0
 
virtual void visitPost (DocParamList *)=0
 
virtual void visitPre (DocXRefItem *)=0
 
virtual void visitPost (DocXRefItem *)=0
 
virtual void visitPre (DocInternalRef *)=0
 
virtual void visitPost (DocInternalRef *)=0
 
virtual void visitPre (DocText *)=0
 
virtual void visitPost (DocText *)=0
 
virtual void visitPre (DocHtmlBlockQuote *)=0
 
virtual void visitPost (DocHtmlBlockQuote *)=0
 
virtual void visitPre (DocVhdlFlow *)=0
 
virtual void visitPost (DocVhdlFlow *)=0
 
virtual void visitPre (DocParBlock *)=0
 
virtual void visitPost (DocParBlock *)=0
 

Private 属性

std::unique_ptr< Privatem_p
 

详细描述

Abstract visitor that participates in the visitor pattern.

在文件 docvisitor.h92 行定义.

构造及析构函数说明

◆ DocVisitor()

DocVisitor::DocVisitor ( int  id)

在文件 docvisitor.cpp32 行定义.

32  : m_p(std::make_unique<Private>())
33 {
34  m_p->id = id;
35 }

引用了 id() , 以及 m_p.

◆ ~DocVisitor()

DocVisitor::~DocVisitor ( )
virtual

在文件 docvisitor.cpp37 行定义.

38 {
39 }

成员函数说明

◆ getCodeParser()

CodeParserInterface & DocVisitor::getCodeParser ( const QCString langExt)

在文件 docvisitor.cpp41 行定义.

42 {
43  std::string ext = extension.str();
44  // for each extension we create a code parser once per visitor, so that
45  // the context of the same parser object is reused throughout multiple passes for instance
46  // for code fragments shown via dontinclude.
47  auto it = m_p->parserFactoryMap.find(ext);
48  if (it==m_p->parserFactoryMap.end())
49  {
50  auto factory = Doxygen::parserManager->getCodeParserFactory(extension);
51  auto result = m_p->parserFactoryMap.insert(std::make_pair(ext,factory()));
52  it = result.first;
53  }
54  return *it->second.get();
55 }

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

◆ id()

int DocVisitor::id ( ) const

在文件 docvisitor.cpp57 行定义.

58 {
59  return m_p->id;
60 }

引用了 m_p.

被这些函数引用 DocVisitor() , 以及 PerlModDocVisitor::visit().

◆ popHidden()

bool DocVisitor::popHidden ( )

在文件 docvisitor.cpp67 行定义.

68 {
69  if (m_p->hidden.empty()) return false;
70  bool v = m_p->hidden.top();
71  m_p->hidden.pop();
72  return v;
73 }

引用了 m_p.

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

◆ pushHidden()

◆ visit() [1/17]

virtual void DocVisitor::visit ( DocAnchor )
pure virtual

◆ visit() [2/17]

virtual void DocVisitor::visit ( DocCite )
pure virtual

◆ visit() [3/17]

virtual void DocVisitor::visit ( DocEmoji )
pure virtual

◆ visit() [4/17]

virtual void DocVisitor::visit ( DocFormula )
pure virtual

◆ visit() [5/17]

virtual void DocVisitor::visit ( DocHorRuler )
pure virtual

◆ visit() [6/17]

virtual void DocVisitor::visit ( DocInclude )
pure virtual

◆ visit() [7/17]

virtual void DocVisitor::visit ( DocIncOperator )
pure virtual

◆ visit() [8/17]

virtual void DocVisitor::visit ( DocIndexEntry )
pure virtual

◆ visit() [9/17]

virtual void DocVisitor::visit ( DocLineBreak )
pure virtual

◆ visit() [10/17]

virtual void DocVisitor::visit ( DocLinkedWord )
pure virtual

◆ visit() [11/17]

◆ visit() [12/17]

virtual void DocVisitor::visit ( DocStyleChange )
pure virtual

◆ visit() [13/17]

virtual void DocVisitor::visit ( DocSymbol )
pure virtual

◆ visit() [14/17]

virtual void DocVisitor::visit ( DocURL )
pure virtual

◆ visit() [15/17]

virtual void DocVisitor::visit ( DocVerbatim )
pure virtual

◆ visit() [16/17]

virtual void DocVisitor::visit ( DocWhiteSpace )
pure virtual

◆ visit() [17/17]

◆ visitPost() [1/37]

◆ visitPost() [2/37]

virtual void DocVisitor::visitPost ( DocAutoListItem )
pure virtual

◆ visitPost() [3/37]

virtual void DocVisitor::visitPost ( DocDiaFile )
pure virtual

◆ visitPost() [4/37]

virtual void DocVisitor::visitPost ( DocDotFile )
pure virtual

◆ visitPost() [5/37]

virtual void DocVisitor::visitPost ( DocHRef )
pure virtual

◆ visitPost() [6/37]

virtual void DocVisitor::visitPost ( DocHtmlBlockQuote )
pure virtual

◆ visitPost() [7/37]

virtual void DocVisitor::visitPost ( DocHtmlCaption )
pure virtual

◆ visitPost() [8/37]

virtual void DocVisitor::visitPost ( DocHtmlCell )
pure virtual

◆ visitPost() [9/37]

virtual void DocVisitor::visitPost ( DocHtmlDescData )
pure virtual

◆ visitPost() [10/37]

virtual void DocVisitor::visitPost ( DocHtmlDescList )
pure virtual

◆ visitPost() [11/37]

virtual void DocVisitor::visitPost ( DocHtmlDescTitle )
pure virtual

◆ visitPost() [12/37]

virtual void DocVisitor::visitPost ( DocHtmlHeader )
pure virtual

◆ visitPost() [13/37]

virtual void DocVisitor::visitPost ( DocHtmlList )
pure virtual

◆ visitPost() [14/37]

virtual void DocVisitor::visitPost ( DocHtmlListItem )
pure virtual

◆ visitPost() [15/37]

virtual void DocVisitor::visitPost ( DocHtmlRow )
pure virtual

◆ visitPost() [16/37]

virtual void DocVisitor::visitPost ( DocHtmlTable )
pure virtual

◆ visitPost() [17/37]

virtual void DocVisitor::visitPost ( DocImage )
pure virtual

◆ visitPost() [18/37]

virtual void DocVisitor::visitPost ( DocInternal )
pure virtual

◆ visitPost() [19/37]

virtual void DocVisitor::visitPost ( DocInternalRef )
pure virtual

◆ visitPost() [20/37]

virtual void DocVisitor::visitPost ( DocLink )
pure virtual

◆ visitPost() [21/37]

virtual void DocVisitor::visitPost ( DocMscFile )
pure virtual

◆ visitPost() [22/37]

virtual void DocVisitor::visitPost ( DocPara )
pure virtual

◆ visitPost() [23/37]

virtual void DocVisitor::visitPost ( DocParamList )
pure virtual

◆ visitPost() [24/37]

virtual void DocVisitor::visitPost ( DocParamSect )
pure virtual

◆ visitPost() [25/37]

virtual void DocVisitor::visitPost ( DocParBlock )
pure virtual

◆ visitPost() [26/37]

virtual void DocVisitor::visitPost ( DocRef )
pure virtual

◆ visitPost() [27/37]

virtual void DocVisitor::visitPost ( DocRoot )
pure virtual

◆ visitPost() [28/37]

virtual void DocVisitor::visitPost ( DocSecRefItem )
pure virtual

◆ visitPost() [29/37]

virtual void DocVisitor::visitPost ( DocSecRefList )
pure virtual

◆ visitPost() [30/37]

virtual void DocVisitor::visitPost ( DocSection )
pure virtual

◆ visitPost() [31/37]

virtual void DocVisitor::visitPost ( DocSimpleList )
pure virtual

◆ visitPost() [32/37]

virtual void DocVisitor::visitPost ( DocSimpleListItem )
pure virtual

◆ visitPost() [33/37]

virtual void DocVisitor::visitPost ( DocSimpleSect )
pure virtual

◆ visitPost() [34/37]

virtual void DocVisitor::visitPost ( DocText )
pure virtual

◆ visitPost() [35/37]

virtual void DocVisitor::visitPost ( DocTitle )
pure virtual

◆ visitPost() [36/37]

virtual void DocVisitor::visitPost ( DocVhdlFlow )
pure virtual

◆ visitPost() [37/37]

virtual void DocVisitor::visitPost ( DocXRefItem )
pure virtual

◆ visitPre() [1/37]

◆ visitPre() [2/37]

virtual void DocVisitor::visitPre ( DocAutoListItem )
pure virtual

◆ visitPre() [3/37]

virtual void DocVisitor::visitPre ( DocDiaFile )
pure virtual

◆ visitPre() [4/37]

virtual void DocVisitor::visitPre ( DocDotFile )
pure virtual

◆ visitPre() [5/37]

virtual void DocVisitor::visitPre ( DocHRef )
pure virtual

◆ visitPre() [6/37]

virtual void DocVisitor::visitPre ( DocHtmlBlockQuote )
pure virtual

◆ visitPre() [7/37]

virtual void DocVisitor::visitPre ( DocHtmlCaption )
pure virtual

◆ visitPre() [8/37]

virtual void DocVisitor::visitPre ( DocHtmlCell )
pure virtual

◆ visitPre() [9/37]

virtual void DocVisitor::visitPre ( DocHtmlDescData )
pure virtual

◆ visitPre() [10/37]

virtual void DocVisitor::visitPre ( DocHtmlDescList )
pure virtual

◆ visitPre() [11/37]

virtual void DocVisitor::visitPre ( DocHtmlDescTitle )
pure virtual

◆ visitPre() [12/37]

virtual void DocVisitor::visitPre ( DocHtmlHeader )
pure virtual

◆ visitPre() [13/37]

virtual void DocVisitor::visitPre ( DocHtmlList )
pure virtual

◆ visitPre() [14/37]

virtual void DocVisitor::visitPre ( DocHtmlListItem )
pure virtual

◆ visitPre() [15/37]

virtual void DocVisitor::visitPre ( DocHtmlRow )
pure virtual

◆ visitPre() [16/37]

virtual void DocVisitor::visitPre ( DocHtmlTable )
pure virtual

◆ visitPre() [17/37]

virtual void DocVisitor::visitPre ( DocImage )
pure virtual

◆ visitPre() [18/37]

virtual void DocVisitor::visitPre ( DocInternal )
pure virtual

◆ visitPre() [19/37]

virtual void DocVisitor::visitPre ( DocInternalRef )
pure virtual

◆ visitPre() [20/37]

virtual void DocVisitor::visitPre ( DocLink )
pure virtual

◆ visitPre() [21/37]

virtual void DocVisitor::visitPre ( DocMscFile )
pure virtual

◆ visitPre() [22/37]

virtual void DocVisitor::visitPre ( DocPara )
pure virtual

◆ visitPre() [23/37]

virtual void DocVisitor::visitPre ( DocParamList )
pure virtual

◆ visitPre() [24/37]

virtual void DocVisitor::visitPre ( DocParamSect )
pure virtual

◆ visitPre() [25/37]

virtual void DocVisitor::visitPre ( DocParBlock )
pure virtual

◆ visitPre() [26/37]

virtual void DocVisitor::visitPre ( DocRef )
pure virtual

◆ visitPre() [27/37]

virtual void DocVisitor::visitPre ( DocRoot )
pure virtual

◆ visitPre() [28/37]

virtual void DocVisitor::visitPre ( DocSecRefItem )
pure virtual

◆ visitPre() [29/37]

virtual void DocVisitor::visitPre ( DocSecRefList )
pure virtual

◆ visitPre() [30/37]

virtual void DocVisitor::visitPre ( DocSection )
pure virtual

◆ visitPre() [31/37]

virtual void DocVisitor::visitPre ( DocSimpleList )
pure virtual

◆ visitPre() [32/37]

virtual void DocVisitor::visitPre ( DocSimpleListItem )
pure virtual

◆ visitPre() [33/37]

virtual void DocVisitor::visitPre ( DocSimpleSect )
pure virtual

◆ visitPre() [34/37]

virtual void DocVisitor::visitPre ( DocText )
pure virtual

◆ visitPre() [35/37]

virtual void DocVisitor::visitPre ( DocTitle )
pure virtual

◆ visitPre() [36/37]

virtual void DocVisitor::visitPre ( DocVhdlFlow )
pure virtual

◆ visitPre() [37/37]

virtual void DocVisitor::visitPre ( DocXRefItem )
pure virtual

类成员变量说明

◆ m_p

std::unique_ptr<Private> DocVisitor::m_p
private

在文件 docvisitor.h94 行定义.

被这些函数引用 DocVisitor(), id(), popHidden() , 以及 pushHidden().


该类的文档由以下文件生成:
DocVisitor::id
int id() const
Definition: docvisitor.cpp:57
DocVisitor::m_p
std::unique_ptr< Private > m_p
Definition: docvisitor.h:94
Doxygen::parserManager
static ParserManager * parserManager
Definition: doxygen.h:111
ParserManager::getCodeParserFactory
CodeParserFactory & getCodeParserFactory(const QCString &extension)
Get the factory for create code parser objects with a given extension.
Definition: parserintf.h:224