20 #include "outputgen.h" 22 #define LATEX_STYLE_EXTENSION ".sty" 34 OutputType type()
const {
return OutputType::Latex; }
37 void writeCodeLink(CodeSymbolType type,
49 void startCodeLine(
int);
51 void startFontClass(
const QCString &);
53 void writeCodeAnchor(
const QCString &) {}
54 void startCodeFragment(
const QCString &style);
55 void endCodeFragment(
const QCString &style);
60 void incUsedTableLevel() { m_usedTableLevel++; }
61 void decUsedTableLevel() { m_usedTableLevel--; }
62 int usedTableLevel()
const {
return m_usedTableLevel; }
64 void setRelativePath(
const QCString &path);
65 void setSourceFileName(
const QCString &sourceFileName);
66 void setInsideTabbing(
bool b) { m_insideTabbing=b; }
67 bool insideTabbing()
const {
return m_insideTabbing; }
70 void _writeCodeLink(
const QCString &className,
75 bool m_streamSet =
false;
80 bool m_doxyCodeLineOpen =
false;
81 int m_usedTableLevel = 0;
82 bool m_insideTabbing =
false;
95 OutputType type()
const {
return OutputType::Latex; }
99 static void writeStyleSheetFile(
TextStream &t);
106 void writeSearchInfo() {}
107 void writeFooter(
const QCString &) {}
111 void startPageDoc(
const QCString &) {}
113 void startIndexSection(IndexSection);
114 void endIndexSection(IndexSection);
115 void writePageLink(
const QCString &,
bool);
116 void startProjectNumber();
117 void endProjectNumber() {}
118 void writeStyleInfo(
int part);
119 void startTitleHead(
const QCString &);
122 void startParagraph(
const QCString &classDef);
124 void writeString(
const QCString &text);
125 void startIndexListItem() {}
126 void endIndexListItem() {}
127 void startIndexList() { m_t <<
"\\begin{DoxyCompactList}\n"; }
128 void endIndexList() { m_t <<
"\\end{DoxyCompactList}\n"; }
129 void startIndexKey();
131 void startIndexValue(
bool);
132 void endIndexValue(
const QCString &,
bool);
133 void startItemList() { m_t <<
"\\begin{DoxyCompactItemize}\n"; }
134 void endItemList() { m_t <<
"\\end{DoxyCompactItemize}\n"; }
143 void startTypewriter() { m_t <<
"{\\ttfamily "; }
144 void endTypewriter() { m_t <<
"}"; }
145 void startGroupHeader(
int);
146 void endGroupHeader(
int);
147 void startItemListItem() { m_t <<
"\\item \n"; }
148 void endItemListItem() {}
150 void startMemberSections() {}
151 void endMemberSections() {}
152 void startHeaderSection() {}
153 void endHeaderSection() {}
154 void startMemberHeader(
const QCString &,
int);
155 void endMemberHeader();
156 void startMemberSubtitle() {}
157 void endMemberSubtitle() {}
158 void startMemberDocList() {}
159 void endMemberDocList() {}
160 void startMemberList();
161 void endMemberList();
162 void startInlineHeader();
163 void endInlineHeader();
164 void startAnonTypeScope(
int);
165 void endAnonTypeScope(
int);
167 void endMemberItem(MemberItemType);
168 void startMemberTemplateParams();
170 void startCompoundTemplateParams() { m_t <<
"\\subsubsection*{";}
171 void endCompoundTemplateParams() { m_t <<
"}\n"; }
173 void startMemberGroupHeader(
bool);
174 void endMemberGroupHeader();
175 void startMemberGroupDocs();
176 void endMemberGroupDocs();
177 void startMemberGroup();
178 void endMemberGroup(
bool);
180 void insertMemberAlign(
bool) {}
181 void insertMemberAlignLeft(MemberItemType,
bool){}
183 void writeRuler() { m_t <<
"\n\n"; }
185 void startEmphasis() { m_t <<
"{\\em "; }
186 void endEmphasis() { m_t <<
"}"; }
187 void startBold() { m_t <<
"{\\bfseries "; }
188 void endBold() { m_t <<
"}"; }
191 void endMemberDoc(
bool);
195 void writeChar(
char c);
196 void writeLatexSpacing() { m_t <<
"\\hspace{0.3cm}"; }
199 void startCenter() { m_t <<
"\\begin{center}\n"; }
200 void endCenter() { m_t <<
"\\end{center}\n"; }
201 void startSmall() { m_t <<
"\\footnotesize "; }
202 void endSmall() { m_t <<
"\\normalsize "; }
204 void endMemberDescription();
205 void startMemberDeclaration() {}
209 void startExamples();
211 void startDescForItem() { m_t <<
"\\par\n"; }
212 void endDescForItem() {}
216 void startIndent() {}
218 void writeSynopsis() {}
219 void startClassDiagram();
223 void startQuickIndices() {}
224 void endQuickIndices() {}
225 void writeSplitBar(
const QCString &) {}
226 void writeNavigationPath(
const QCString &) {}
228 void writeQuickLinks(HighlightedItem,
const QCString &) {}
230 void startContents() {}
231 void endContents() {}
232 void writeNonBreakableSpace(
int);
234 void startDescTable(
const QCString &title);
236 void startDescTableRow();
237 void endDescTableRow();
238 void startDescTableTitle();
239 void endDescTableTitle();
240 void startDescTableData();
241 void endDescTableData();
242 void lastIndexPage();
244 void startDotGraph();
246 void startInclDepGraph();
248 void startCallGraph();
249 void startGroupCollaboration();
252 void startDirDepGraph();
256 void startTextBlock(
bool) {}
257 void endTextBlock(
bool) {}
259 void startMemberDocPrefixItem() {}
260 void endMemberDocPrefixItem() { m_t <<
"\\\\\n"; }
261 void startMemberDocName(
bool) {}
262 void endMemberDocName() {}
263 void startParameterType(
bool,
const QCString &);
264 void endParameterType();
265 void startParameterName(
bool);
266 void endParameterName();
267 void startParameterExtra();
268 void endParameterExtra(
bool last,
bool one,
bool bracket);
269 void startParameterDefVal(
const char *s) { docify(s); startTypewriter(); }
270 void endParameterDefVal() { endTypewriter(); }
271 void startParameterList(
bool);
272 void endParameterList();
273 void exceptionEntry(
const QCString &,
bool);
275 void startConstraintList(
const QCString &);
276 void startConstraintParam();
277 void endConstraintParam();
278 void startConstraintType();
279 void endConstraintType();
280 void startConstraintDocs();
281 void endConstraintDocs();
282 void endConstraintList();
284 void startMemberDocSimple(
bool);
285 void endMemberDocSimple(
bool);
286 void startInlineMemberType();
287 void endInlineMemberType();
288 void startInlineMemberName();
289 void endInlineMemberName();
290 void startInlineMemberDoc();
291 void endInlineMemberDoc();
294 void writeLabel(
const QCString &l,
bool isLast);
300 void addWord(
const QCString &,
bool) {}
306 void endTitle() { m_t <<
"}"; }
308 bool m_firstDescItem =
true;
309 bool m_disableLinks =
false;
312 bool m_templateMemberItem =
false;
313 std::unique_ptr<OutputCodeList> m_codeList;
315 bool m_insideTableEnv =
false;
316 int m_hierarchyLevel = 0;
320 void writeLatexSpecialFormulaChars(
TextStream &t);
321 QCString convertToLaTeX(
const QCString &s,
bool insideTabbing,
bool keepSpaces=FALSE);
329 const bool retainNewline =
false);
The common base class of all entity definitions found in the sources.
Definition: definition.h:74
A model of a class/file/namespace member symbol.
Definition: memberdef.h:47
Text streaming class that buffers data.
Definition: textstream.h:34
class that represents a list of constant references to sections.
Definition: section.h:104
Represents a graphical class hierarchy.
Definition: dotgfxhierarchytable.h:31
Representation of a group collaboration graph.
Definition: dotgroupcollaboration.h:28
opaque representation of the abstract syntax tree (AST)
Definition: docparser.h:46
Generator for LaTeX code fragments.
Definition: latexgen.h:27
Class representing a list of different code generators.
Definition: outputlist.h:199
Class representing a built-in class diagram.
Definition: diagram.h:29
Representation of an call graph.
Definition: dotcallgraph.h:26
Representation of a class inheritance or dependency graph.
Definition: dotclassgraph.h:28
Generator for LaTeX output.
Definition: latexgen.h:86
Base class for specific output generators.
Definition: outputgen.h:64
Representation of an include dependency graph.
Definition: dotincldepgraph.h:30
Representation of an directory dependency graph.
Definition: dotdirdeps.h:25
This is an alternative implementation of QCString.
Definition: qcstring.h:93
Definition: outputgen.h:49
Definition: outputgen.h:41