Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
doxygen-1.8.11
src
rtfdocvisitor.h
Go to the documentation of this file.
1
/******************************************************************************
2
*
3
*
4
*
5
*
6
* Copyright (C) 1997-2015 by Dimitri van Heesch.
7
*
8
* Permission to use, copy, modify, and distribute this software and its
9
* documentation under the terms of the GNU General Public License is hereby
10
* granted. No representations are made about the suitability of this software
11
* for any purpose. It is provided "as is" without express or implied warranty.
12
* See the GNU General Public License for more details.
13
*
14
* Documents produced by Doxygen are derivative works derived from the
15
* input used in their production; they are not affected by this license.
16
*
17
*/
18
19
#ifndef _RTFDOCVISITOR_H
20
#define _RTFDOCVISITOR_H
21
22
#include "
docvisitor.h
"
23
#include <
qstack.h
>
24
#include <
qcstring.h
>
25
26
class
FTextStream
;
27
class
CodeOutputInterface
;
28
29
/*! @brief Concrete visitor implementation for RTF output. */
30
class
RTFDocVisitor
:
public
DocVisitor
31
{
32
public
:
33
RTFDocVisitor
(
FTextStream
&
t
,
CodeOutputInterface
&ci,
const
char
*langExt);
34
35
//--------------------------------------
36
// visitor functions for leaf nodes
37
//--------------------------------------
38
39
void
visit
(
DocWord
*);
40
void
visit
(
DocLinkedWord
*);
41
void
visit
(
DocWhiteSpace
*);
42
void
visit
(
DocSymbol
*);
43
void
visit
(
DocURL
*);
44
void
visit
(
DocLineBreak
*);
45
void
visit
(
DocHorRuler
*);
46
void
visit
(
DocStyleChange
*);
47
void
visit
(
DocVerbatim
*);
48
void
visit
(
DocAnchor
*);
49
void
visit
(
DocInclude
*);
50
void
visit
(
DocIncOperator
*);
51
void
visit
(
DocFormula
*);
52
void
visit
(
DocIndexEntry
*);
53
void
visit
(
DocSimpleSectSep
*);
54
void
visit
(
DocCite
*);
55
56
//--------------------------------------
57
// visitor functions for compound nodes
58
//--------------------------------------
59
60
void
visitPre
(
DocAutoList
*);
61
void
visitPost
(
DocAutoList
*);
62
void
visitPre
(
DocAutoListItem
*);
63
void
visitPost
(
DocAutoListItem
*);
64
void
visitPre
(
DocPara
*);
65
void
visitPost
(
DocPara
*);
66
void
visitPre
(
DocRoot
*);
67
void
visitPost
(
DocRoot
*);
68
void
visitPre
(
DocSimpleSect
*);
69
void
visitPost
(
DocSimpleSect
*);
70
void
visitPre
(
DocTitle
*);
71
void
visitPost
(
DocTitle
*);
72
void
visitPre
(
DocSimpleList
*);
73
void
visitPost
(
DocSimpleList
*);
74
void
visitPre
(
DocSimpleListItem
*);
75
void
visitPost
(
DocSimpleListItem
*);
76
void
visitPre
(
DocSection
*
s
);
77
void
visitPost
(
DocSection
*);
78
void
visitPre
(
DocHtmlList
*s);
79
void
visitPost
(
DocHtmlList
*s);
80
void
visitPre
(
DocHtmlListItem
*);
81
void
visitPost
(
DocHtmlListItem
*);
82
//void visitPre(DocHtmlPre *);
83
//void visitPost(DocHtmlPre *);
84
void
visitPre
(
DocHtmlDescList
*);
85
void
visitPost
(
DocHtmlDescList
*);
86
void
visitPre
(
DocHtmlDescTitle
*);
87
void
visitPost
(
DocHtmlDescTitle
*);
88
void
visitPre
(
DocHtmlDescData
*);
89
void
visitPost
(
DocHtmlDescData
*);
90
void
visitPre
(
DocHtmlTable
*t);
91
void
visitPost
(
DocHtmlTable
*t);
92
void
visitPre
(
DocHtmlCaption
*);
93
void
visitPost
(
DocHtmlCaption
*);
94
void
visitPre
(
DocHtmlRow
*);
95
void
visitPost
(
DocHtmlRow
*) ;
96
void
visitPre
(
DocHtmlCell
*);
97
void
visitPost
(
DocHtmlCell
*);
98
void
visitPre
(
DocInternal
*);
99
void
visitPost
(
DocInternal
*);
100
void
visitPre
(
DocHRef
*);
101
void
visitPost
(
DocHRef
*);
102
void
visitPre
(
DocHtmlHeader
*);
103
void
visitPost
(
DocHtmlHeader
*) ;
104
void
visitPre
(
DocImage
*);
105
void
visitPost
(
DocImage
*);
106
void
visitPre
(
DocDotFile
*);
107
void
visitPost
(
DocDotFile
*);
108
void
visitPre
(
DocMscFile
*);
109
void
visitPost
(
DocMscFile
*);
110
void
visitPre
(
DocDiaFile
*);
111
void
visitPost
(
DocDiaFile
*);
112
void
visitPre
(
DocLink
*);
113
void
visitPost
(
DocLink
*);
114
void
visitPre
(
DocRef
*ref);
115
void
visitPost
(
DocRef
*);
116
void
visitPre
(
DocSecRefItem
*);
117
void
visitPost
(
DocSecRefItem
*);
118
void
visitPre
(
DocSecRefList
*);
119
void
visitPost
(
DocSecRefList
*);
120
void
visitPre
(
DocParamSect
*);
121
void
visitPost
(
DocParamSect
*);
122
void
visitPre
(
DocParamList
*);
123
void
visitPost
(
DocParamList
*);
124
void
visitPre
(
DocXRefItem
*);
125
void
visitPost
(
DocXRefItem
*);
126
void
visitPre
(
DocInternalRef
*);
127
void
visitPost
(
DocInternalRef
*);
128
void
visitPre
(
DocCopy
*);
129
void
visitPost
(
DocCopy
*);
130
void
visitPre
(
DocText
*);
131
void
visitPost
(
DocText
*);
132
void
visitPre
(
DocHtmlBlockQuote
*);
133
void
visitPost
(
DocHtmlBlockQuote
*);
134
void
visitPre
(
DocVhdlFlow
*);
135
void
visitPost
(
DocVhdlFlow
*);
136
void
visitPre
(
DocParBlock
*);
137
void
visitPost
(
DocParBlock
*);
138
139
private
:
140
141
//--------------------------------------
142
// helper functions
143
//--------------------------------------
144
145
void
filter
(
const
char
*
str
,
bool
verbatim=
FALSE
);
146
void
startLink
(
const
QCString
&ref,
const
QCString
&
file
,
147
const
QCString
&anchor);
148
void
endLink
(
const
QCString
&ref);
149
QCString
getStyle
(
const
char
*
name
);
150
void
incIndentLevel
();
151
void
decIndentLevel
();
152
153
void
pushEnabled
();
154
void
popEnabled
();
155
void
writeDotFile
(
const
QCString
&
fileName
);
156
void
writeMscFile
(
const
QCString
&fileName);
157
void
writeDiaFile
(
const
QCString
&fileName);
158
void
writePlantUMLFile
(
const
QCString
&fileName);
159
160
//--------------------------------------
161
// state variables
162
//--------------------------------------
163
164
FTextStream
&
m_t
;
165
CodeOutputInterface
&
m_ci
;
166
bool
m_insidePre
;
167
bool
m_hide
;
168
int
m_indentLevel
;
169
QStack<bool>
m_enabled
;
170
bool
m_lastIsPara
;
171
QCString
m_langExt
;
172
};
173
174
#endif
name
static QCString name
Definition:
declinfo.cpp:673
RTFDocVisitor::m_insidePre
bool m_insidePre
Definition:
rtfdocvisitor.h:166
RTFDocVisitor::visit
void visit(DocWord *)
Definition:
rtfdocvisitor.cpp:90
DocHtmlBlockQuote
Definition:
docparser.h:1374
DocURL
Definition:
docparser.h:234
RTFDocVisitor::filter
void filter(const char *str, bool verbatim=FALSE)
Definition:
rtfdocvisitor.cpp:1563
DocWord
Definition:
docparser.h:195
RTFDocVisitor::startLink
void startLink(const QCString &ref, const QCString &file, const QCString &anchor)
Definition:
rtfdocvisitor.cpp:1609
DocWhiteSpace
Definition:
docparser.h:428
DocHRef
Definition:
docparser.h:869
DocText
Definition:
docparser.h:1389
DocHorRuler
Definition:
docparser.h:261
DocTitle
Definition:
docparser.h:651
DocRef
Definition:
docparser.h:821
DocStyleChange
Definition:
docparser.h:309
RTFDocVisitor::m_ci
CodeOutputInterface & m_ci
Definition:
rtfdocvisitor.h:165
RTFDocVisitor::m_lastIsPara
bool m_lastIsPara
Definition:
rtfdocvisitor.h:170
DocAutoList
Definition:
docparser.h:616
FALSE
const bool FALSE
Definition:
qglobal.h:370
DocCite
Definition:
docparser.h:287
QStack< bool >
DocHtmlCaption
Definition:
docparser.h:1288
DocRoot
Definition:
docparser.h:1400
DocHtmlCell
Definition:
docparser.h:1251
DocIndexEntry
Definition:
docparser.h:577
RTFDocVisitor::m_langExt
QCString m_langExt
Definition:
rtfdocvisitor.h:171
docvisitor.h
DocSimpleSect
Definition:
docparser.h:1046
FTextStream
Simplified and optimized version of QTextStream.
Definition:
ftextstream.h:11
DocPara
Definition:
docparser.h:1113
RTFDocVisitor::writePlantUMLFile
void writePlantUMLFile(const QCString &fileName)
Definition:
rtfdocvisitor.cpp:1726
RTFDocVisitor::getStyle
QCString getStyle(const char *name)
Definition:
rtfdocvisitor.cpp:67
qcstring.h
DocSymbol
Definition:
docparser.h:344
DocVisitor
Abstract visitor that participates in the visitor pattern.
Definition:
docvisitor.h:90
DocLink
Definition:
docparser.h:800
RTFDocVisitor::incIndentLevel
void incIndentLevel()
Definition:
rtfdocvisitor.cpp:76
RTFDocVisitor::writeDiaFile
void writeDiaFile(const QCString &fileName)
Definition:
rtfdocvisitor.cpp:1706
DocVhdlFlow
Definition:
docparser.h:788
DocHtmlDescList
Definition:
docparser.h:921
DocHtmlListItem
Definition:
docparser.h:1219
DocMscFile
Definition:
docparser.h:740
DocVerbatim
Definition:
docparser.h:441
RTFDocVisitor::popEnabled
void popEnabled()
Definition:
rtfdocvisitor.cpp:1657
dumpTree.fileName
fileName
Definition:
dumpTree.py:9
DocHtmlDescTitle
Definition:
docparser.h:906
DocHtmlHeader
Definition:
docparser.h:889
RTFDocVisitor::writeMscFile
void writeMscFile(const QCString &fileName)
Definition:
rtfdocvisitor.cpp:1686
DocHtmlTable
Definition:
docparser.h:1345
reco_momentum_tuples.t
t
Definition:
reco_momentum_tuples.py:25
cache_state.file
file
Definition:
cache_state.py:421
RTFDocVisitor::m_hide
bool m_hide
Definition:
rtfdocvisitor.h:167
DocDiaFile
Definition:
docparser.h:764
DocHtmlRow
Definition:
docparser.h:1308
RTFDocVisitor::m_t
FTextStream & m_t
Definition:
rtfdocvisitor.h:164
RTFDocVisitor
Concrete visitor implementation for RTF output.
Definition:
rtfdocvisitor.h:30
DocLineBreak
Definition:
docparser.h:250
DocSecRefList
Definition:
docparser.h:978
DocSecRefItem
Definition:
docparser.h:959
DocFormula
Definition:
docparser.h:557
DocParamSect
Definition:
docparser.h:1084
DocImage
Definition:
docparser.h:687
DocParamList
Definition:
docparser.h:1157
qstack.h
RTFDocVisitor::visitPre
void visitPre(DocAutoList *)
Definition:
rtfdocvisitor.cpp:521
RTFDocVisitor::RTFDocVisitor
RTFDocVisitor(FTextStream &t, CodeOutputInterface &ci, const char *langExt)
Definition:
rtfdocvisitor.cpp:60
DocSection
Definition:
docparser.h:936
DocHtmlList
Definition:
docparser.h:1027
DocInternalRef
Definition:
docparser.h:851
DocInclude
Definition:
docparser.h:483
DocParBlock
Definition:
docparser.h:1002
DocAnchor
Definition:
docparser.h:272
DocSimpleSectSep
Definition:
docparser.h:1073
DocSimpleListItem
Definition:
docparser.h:1199
RTFDocVisitor::m_enabled
QStack< bool > m_enabled
Definition:
rtfdocvisitor.h:169
RTFDocVisitor::decIndentLevel
void decIndentLevel()
Definition:
rtfdocvisitor.cpp:81
DocHtmlDescData
Definition:
docparser.h:1237
QCString
Definition:
qcstring.h:131
RTFDocVisitor::writeDotFile
void writeDotFile(const QCString &fileName)
Definition:
rtfdocvisitor.cpp:1665
CodeOutputInterface
Definition:
outputgen.h:59
DocLinkedWord
Definition:
docparser.h:209
RTFDocVisitor::m_indentLevel
int m_indentLevel
Definition:
rtfdocvisitor.h:168
DocSimpleList
Definition:
docparser.h:1015
RTFDocVisitor::endLink
void endLink(const QCString &ref)
Definition:
rtfdocvisitor.cpp:1639
DocDotFile
Definition:
docparser.h:716
DocAutoListItem
Definition:
docparser.h:634
s
static QCString * s
Definition:
config.cpp:1042
RTFDocVisitor::pushEnabled
void pushEnabled()
Definition:
rtfdocvisitor.cpp:1652
str
static QCString str
Definition:
fortrancode.cpp:27098
RTFDocVisitor::visitPost
void visitPost(DocAutoList *)
Definition:
rtfdocvisitor.cpp:531
DocInternal
Definition:
docparser.h:990
DocXRefItem
Definition:
docparser.h:664
DocIncOperator
Definition:
docparser.h:522
DocCopy
Definition:
docparser.h:598
Generated by
1.8.11