Skip to main content

The ManDocVisitor Class Reference

Concrete visitor implementation for LaTeX output. More...

Declaration​

class ManDocVisitor { ... }

Included Headers​

#include <src/mandocvisitor.h>

Base class​

classDocVisitor

Helper base class for functionality shared by all visitors. More...

Public Constructors Index​

ManDocVisitor (TextStream &t, OutputCodeList &ci, const QCString &langExt)

Public Operators Index​

voidoperator() (const DocWord &)
voidoperator() (const DocLinkedWord &)
voidoperator() (const DocWhiteSpace &)
voidoperator() (const DocSymbol &)
voidoperator() (const DocEmoji &)
voidoperator() (const DocURL &)
voidoperator() (const DocLineBreak &)
voidoperator() (const DocHorRuler &)
voidoperator() (const DocStyleChange &)
voidoperator() (const DocVerbatim &)
voidoperator() (const DocAnchor &)
voidoperator() (const DocInclude &)
voidoperator() (const DocIncOperator &)
voidoperator() (const DocFormula &)
voidoperator() (const DocIndexEntry &)
voidoperator() (const DocSimpleSectSep &)
voidoperator() (const DocCite &)
voidoperator() (const DocSeparator &)
voidoperator() (const DocAutoList &)
voidoperator() (const DocAutoListItem &)
voidoperator() (const DocPara &)
voidoperator() (const DocRoot &)
voidoperator() (const DocSimpleSect &)
voidoperator() (const DocTitle &)
voidoperator() (const DocSimpleList &)
voidoperator() (const DocSimpleListItem &)
voidoperator() (const DocSection &s)
voidoperator() (const DocHtmlList &s)
voidoperator() (const DocHtmlListItem &)
voidoperator() (const DocHtmlDescList &)
voidoperator() (const DocHtmlDescTitle &)
voidoperator() (const DocHtmlDescData &)
voidoperator() (const DocHtmlTable &t)
voidoperator() (const DocHtmlCaption &)
voidoperator() (const DocHtmlRow &)
voidoperator() (const DocHtmlCell &)
voidoperator() (const DocInternal &)
voidoperator() (const DocHRef &)
voidoperator() (const DocHtmlSummary &)
voidoperator() (const DocHtmlDetails &)
voidoperator() (const DocHtmlHeader &)
voidoperator() (const DocImage &)
voidoperator() (const DocDotFile &)
voidoperator() (const DocMscFile &)
voidoperator() (const DocDiaFile &)
voidoperator() (const DocPlantUmlFile &)
voidoperator() (const DocLink &lnk)
voidoperator() (const DocRef &ref)
voidoperator() (const DocSecRefItem &)
voidoperator() (const DocSecRefList &)
voidoperator() (const DocParamSect &)
voidoperator() (const DocParamList &)
voidoperator() (const DocXRefItem &)
voidoperator() (const DocInternalRef &)
voidoperator() (const DocText &)
voidoperator() (const DocHtmlBlockQuote &)
voidoperator() (const DocVhdlFlow &)
voidoperator() (const DocParBlock &)

Private Member Functions Index​

template <class T>
voidvisitChildren (const T &t)
voidfilter (const QCString &str, const bool retainNewline=false)

Private Member Attributes Index​

TextStream &m_t
OutputCodeList &m_ci
boolm_insidePre
boolm_hide
boolm_firstCol
intm_indent
QCStringm_langExt
std::array< ManListItemInfo, maxIndentLevels >m_listItemInfo

Private Static Attributes Index​

static const intmaxIndentLevels = 13

Description​

Concrete visitor implementation for LaTeX output.

Definition at line 33 of file mandocvisitor.h.

Public Constructors​

ManDocVisitor()​

ManDocVisitor::ManDocVisitor (TextStream & t, OutputCodeList & ci, const QCString & langExt)

Declaration at line 36 of file mandocvisitor.h, definition at line 33 of file mandocvisitor.cpp.

33ManDocVisitor::ManDocVisitor(TextStream &t,OutputCodeList &ci,
34 const QCString &langExt)
35 : m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE), m_firstCol(FALSE),
36 m_indent(0), m_langExt(langExt)
37{
38}

References FALSE, m_ci, m_firstCol, m_hide, m_indent, m_insidePre, m_langExt and m_t.

Public Operators​

operator()()​

void ManDocVisitor::operator() (const DocWord & w)

Declaration at line 42 of file mandocvisitor.h, definition at line 44 of file mandocvisitor.cpp.

44void ManDocVisitor::operator()(const DocWord &w)
45{
46 if (m_hide) return;
47 filter(w.word());
48 m_firstCol=FALSE;
49}

References FALSE, filter, m_firstCol, m_hide and DocWord::word.

operator()()​

void ManDocVisitor::operator() (const DocLinkedWord & w)

Declaration at line 43 of file mandocvisitor.h, definition at line 51 of file mandocvisitor.cpp.

51void ManDocVisitor::operator()(const DocLinkedWord &w)
52{
53 if (m_hide) return;
54 m_t << "\\fB";
55 filter(w.word());
56 m_t << "\\fP";
57 m_firstCol=FALSE;
58}

References FALSE, filter, m_firstCol, m_hide, m_t and DocLinkedWord::word.

operator()()​

void ManDocVisitor::operator() (const DocWhiteSpace & w)

Declaration at line 44 of file mandocvisitor.h, definition at line 60 of file mandocvisitor.cpp.

60void ManDocVisitor::operator()(const DocWhiteSpace &w)
61{
62 if (m_hide) return;
63 if (m_insidePre)
64 {
65 m_t << w.chars();
66 m_firstCol=w.chars().at(w.chars().length()-1)=='\n';
67 }
68 else
69 {
70 m_t << " ";
71 m_firstCol=FALSE;
72 }
73}

References QCString::at, DocWhiteSpace::chars, FALSE, QCString::length, m_firstCol, m_hide, m_insidePre and m_t.

operator()()​

void ManDocVisitor::operator() (const DocSymbol & s)

Declaration at line 45 of file mandocvisitor.h, definition at line 75 of file mandocvisitor.cpp.

75void ManDocVisitor::operator()(const DocSymbol &s)
76{
77 if (m_hide) return;
78 const char *res = HtmlEntityMapper::instance().man(s.symbol());
79 if (res)
80 {
81 m_t << res;
82 }
83 else
84 {
85 // no error or warning to be supplied
86 // err("man: non supported HTML-entity found: &{};\n",get_symbol_item(s->symbol()));
87 }
88 m_firstCol=FALSE;
89}

References FALSE, HtmlEntityMapper::instance, m_firstCol, m_hide, m_t, HtmlEntityMapper::man and DocSymbol::symbol.

operator()()​

void ManDocVisitor::operator() (const DocEmoji & s)

Declaration at line 46 of file mandocvisitor.h, definition at line 91 of file mandocvisitor.cpp.

91void ManDocVisitor::operator()(const DocEmoji &s)
92{
93 if (m_hide) return;
94 const char *res = EmojiEntityMapper::instance().name(s.index());
95 if (res)
96 {
97 m_t << res;
98 }
99 else
100 {
101 m_t << s.name();
102 }
103 m_firstCol=FALSE;
104}

References FALSE, DocEmoji::index, EmojiEntityMapper::instance, m_firstCol, m_hide, m_t, DocEmoji::name and EmojiEntityMapper::name.

operator()()​

void ManDocVisitor::operator() (const DocURL & u)

Declaration at line 47 of file mandocvisitor.h, definition at line 106 of file mandocvisitor.cpp.

106void ManDocVisitor::operator()(const DocURL &u)
107{
108 if (m_hide) return;
109 m_t << u.url();
110 m_firstCol=FALSE;
111}

References FALSE, m_firstCol, m_hide, m_t and DocURL::url.

operator()()​

void ManDocVisitor::operator() (const DocLineBreak &)

Declaration at line 48 of file mandocvisitor.h, definition at line 113 of file mandocvisitor.cpp.

113void ManDocVisitor::operator()(const DocLineBreak &)
114{
115 if (m_hide) return;
116 m_t << "\n.br\n";
117 m_firstCol=TRUE;
118}

References m_firstCol, m_hide, m_t and TRUE.

operator()()​

void ManDocVisitor::operator() (const DocHorRuler &)

Declaration at line 49 of file mandocvisitor.h, definition at line 120 of file mandocvisitor.cpp.

120void ManDocVisitor::operator()(const DocHorRuler &)
121{
122 if (m_hide) return;
123 if (!m_firstCol) m_t << "\n";
124 m_t << ".PP\n";
125 m_firstCol=TRUE;
126}

References m_firstCol, m_hide, m_t and TRUE.

operator()()​

void ManDocVisitor::operator() (const DocStyleChange & s)

Declaration at line 50 of file mandocvisitor.h, definition at line 128 of file mandocvisitor.cpp.

128void ManDocVisitor::operator()(const DocStyleChange &s)
129{
130 if (m_hide) return;
131 switch (s.style())
132 {
133 case DocStyleChange::Bold:
134 if (s.enable()) m_t << "\\fB"; else m_t << "\\fP";
135 m_firstCol=FALSE;
136 break;
137 case DocStyleChange::S:
138 case DocStyleChange::Strike:
139 case DocStyleChange::Del:
140 /* not supported */
141 break;
142 case DocStyleChange::Underline: //underline is shown as emphasis
143 case DocStyleChange::Ins:
144 if (s.enable()) m_t << "\\fI"; else m_t << "\\fP";
145 m_firstCol=FALSE;
146 break;
147 case DocStyleChange::Italic:
148 if (s.enable()) m_t << "\\fI"; else m_t << "\\fP";
149 m_firstCol=FALSE;
150 break;
151 case DocStyleChange::Kbd:
152 case DocStyleChange::Typewriter:
153 case DocStyleChange::Code:
154 if (s.enable()) m_t << "\\fR"; else m_t << "\\fP";
155 m_firstCol=FALSE;
156 break;
157 case DocStyleChange::Subscript:
158 if (s.enable()) m_t << "\\*<"; else m_t << "\\*> ";
159 m_firstCol=FALSE;
160 break;
161 case DocStyleChange::Superscript:
162 if (s.enable()) m_t << "\\*{"; else m_t << "\\*} ";
163 m_firstCol=FALSE;
164 break;
165 case DocStyleChange::Center:
166 /* not supported */
167 break;
168 case DocStyleChange::Small:
169 /* not supported */
170 break;
171 case DocStyleChange::Cite:
172 /* not supported */
173 break;
174 case DocStyleChange::Preformatted:
175 if (s.enable())
176 {
177 if (!m_firstCol) m_t << "\n";
178 m_t << ".PP\n";
179 m_t << ".nf\n";
180 m_insidePre=TRUE;
181 }
182 else
183 {
184 m_insidePre=FALSE;
185 if (!m_firstCol) m_t << "\n";
186 m_t << ".fi\n";
187 m_t << ".PP\n";
188 m_firstCol=TRUE;
189 }
190 break;
191 case DocStyleChange::Div: /* HTML only */ break;
192 case DocStyleChange::Span: /* HTML only */ break;
193 }
194}

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable, FALSE, DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, m_firstCol, m_hide, m_insidePre, m_t, DocStyleChange::Preformatted, DocStyleChange::S, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::Strike, DocStyleChange::style, DocStyleChange::Subscript, DocStyleChange::Superscript, TRUE, DocStyleChange::Typewriter and DocStyleChange::Underline.

operator()()​

void ManDocVisitor::operator() (const DocVerbatim & s)

Declaration at line 51 of file mandocvisitor.h, definition at line 196 of file mandocvisitor.cpp.

196void ManDocVisitor::operator()(const DocVerbatim &s)
197{
198 if (m_hide) return;
199 QCString lang = m_langExt;
200 if (!s.language().isEmpty()) // explicit language setting
201 {
202 lang = s.language();
203 }
204 SrcLangExt langExt = getLanguageFromCodeLang(lang);
205 switch (s.type())
206 {
207 case DocVerbatim::Code:
208 if (!m_firstCol) m_t << "\n";
209 m_t << ".PP\n";
210 m_t << ".nf\n";
211 getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),
212 langExt,
213 Config_getBool(STRIP_CODE_COMMENTS),
214 s.isExample(),s.exampleFile());
215 if (!m_firstCol) m_t << "\n";
216 m_t << ".fi\n";
217 m_t << ".PP\n";
218 m_firstCol=TRUE;
219 break;
220 case DocVerbatim::JavaDocLiteral:
221 filter(s.text(),true);
222 break;
223 case DocVerbatim::JavaDocCode:
224 m_t << "\\fR\n";
225 filter(s.text(),true);
226 m_t << "\\fP\n";
227 break;
228 case DocVerbatim::Verbatim:
229 if (!m_firstCol) m_t << "\n";
230 m_t << ".PP\n";
231 m_t << ".nf\n";
232 filter(s.text(),true);
233 if (!m_firstCol) m_t << "\n";
234 m_t << ".fi\n";
235 m_t << ".PP\n";
236 m_firstCol=TRUE;
237 break;
238 case DocVerbatim::ManOnly:
239 m_t << s.text();
240 break;
241 case DocVerbatim::HtmlOnly:
242 case DocVerbatim::XmlOnly:
243 case DocVerbatim::LatexOnly:
244 case DocVerbatim::RtfOnly:
245 case DocVerbatim::DocbookOnly:
246 case DocVerbatim::Dot:
247 case DocVerbatim::Msc:
248 case DocVerbatim::PlantUML:
249 /* nothing */
250 break;
251 }
252}

References DocVerbatim::Code, Config_getBool, DocVerbatim::context, DocVerbatim::DocbookOnly, DocVerbatim::Dot, DocVerbatim::exampleFile, filter, DocVisitor::getCodeParser, getLanguageFromCodeLang, DocVerbatim::HtmlOnly, QCString::isEmpty, DocVerbatim::isExample, DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language, DocVerbatim::LatexOnly, m_ci, m_firstCol, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Msc, CodeParserInterface::parseCode, DocVerbatim::PlantUML, DocVerbatim::RtfOnly, DocVerbatim::text, TRUE, DocVerbatim::type, DocVerbatim::Verbatim and DocVerbatim::XmlOnly.

operator()()​

void ManDocVisitor::operator() (const DocAnchor &)

Declaration at line 52 of file mandocvisitor.h, definition at line 254 of file mandocvisitor.cpp.

254void ManDocVisitor::operator()(const DocAnchor &)
255{
256 /* no support for anchors in man pages */
257}

operator()()​

void ManDocVisitor::operator() (const DocInclude & inc)

Declaration at line 53 of file mandocvisitor.h, definition at line 259 of file mandocvisitor.cpp.

259void ManDocVisitor::operator()(const DocInclude &inc)
260{
261 if (m_hide) return;
262 SrcLangExt langExt = getLanguageFromFileName(inc.extension());
263 switch(inc.type())
264 {
265 case DocInclude::IncWithLines:
266 {
267 if (!m_firstCol) m_t << "\n";
268 m_t << ".PP\n";
269 m_t << ".nf\n";
270 FileInfo cfi( inc.file().str() );
271 auto fd = createFileDef( cfi.dirPath(), cfi.fileName() );
272 getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
273 inc.text(),
274 langExt,
275 inc.stripCodeComments(),
276 inc.isExample(),
277 inc.exampleFile(),
278 fd.get(), // fileDef,
279 -1, // start line
280 -1, // end line
281 FALSE, // inline fragment
282 nullptr, // memberDef
283 TRUE
284 );
285 m_t << ".fi\n";
286 m_t << ".PP\n";
287 m_firstCol=TRUE;
288 }
289 break;
290 case DocInclude::Include:
291 if (!m_firstCol) m_t << "\n";
292 m_t << ".PP\n";
293 m_t << ".nf\n";
294 getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
295 inc.text(),
296 langExt,
297 inc.stripCodeComments(),
298 inc.isExample(),
299 inc.exampleFile(),
300 nullptr, // fileDef
301 -1, // startLine
302 -1, // endLine
303 TRUE, // inlineFragment
304 nullptr, // memberDef
305 FALSE
306 );
307 m_t << ".fi\n";
308 m_t << ".PP\n";
309 m_firstCol=TRUE;
310 break;
311 case DocInclude::DontInclude:
312 case DocInclude::DontIncWithLines:
313 case DocInclude::HtmlInclude:
314 case DocInclude::LatexInclude:
315 case DocInclude::RtfInclude:
316 case DocInclude::XmlInclude:
317 case DocInclude::DocbookInclude:
318 break;
319 case DocInclude::ManInclude:
320 m_t << inc.text();
321 break;
322 case DocInclude::VerbInclude:
323 if (!m_firstCol) m_t << "\n";
324 m_t << ".PP\n";
325 m_t << ".nf\n";
326 m_t << inc.text();
327 if (!m_firstCol) m_t << "\n";
328 m_t << ".fi\n";
329 m_t << ".PP\n";
330 m_firstCol=TRUE;
331 break;
332 case DocInclude::Snippet:
333 case DocInclude::SnippetWithLines:
334 if (!m_firstCol) m_t << "\n";
335 m_t << ".PP\n";
336 m_t << ".nf\n";
337 CodeFragmentManager::instance().parseCodeFragment(m_ci,
338 inc.file(),
339 inc.blockId(),
340 inc.context(),
341 inc.type()==DocInclude::SnippetWithLines,
342 inc.trimLeft(),
343 inc.stripCodeComments()
344 );
345 m_t << ".fi\n";
346 m_t << ".PP\n";
347 m_firstCol=TRUE;
348 break;
349 }
350}

References DocInclude::blockId, DocInclude::context, createFileDef, FileInfo::dirPath, DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, DocInclude::exampleFile, DocInclude::extension, FALSE, DocInclude::file, FileInfo::fileName, DocVisitor::getCodeParser, getLanguageFromFileName, DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, CodeFragmentManager::instance, DocInclude::isExample, DocInclude::LatexInclude, m_ci, m_firstCol, m_hide, m_t, DocInclude::ManInclude, CodeParserInterface::parseCode, CodeFragmentManager::parseCodeFragment, DocInclude::RtfInclude, DocInclude::Snippet, DocInclude::SnippetWithLines, QCString::str, DocInclude::stripCodeComments, DocInclude::text, DocInclude::trimLeft, TRUE, DocInclude::type, DocInclude::VerbInclude and DocInclude::XmlInclude.

operator()()​

void ManDocVisitor::operator() (const DocIncOperator & op)

Declaration at line 54 of file mandocvisitor.h, definition at line 352 of file mandocvisitor.cpp.

352void ManDocVisitor::operator()(const DocIncOperator &op)
353{
354 QCString locLangExt = getFileNameExtension(op.includeFileName());
355 if (locLangExt.isEmpty()) locLangExt = m_langExt;
356 SrcLangExt langExt = getLanguageFromFileName(locLangExt);
357 //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
358 // op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
359 if (op.isFirst())
360 {
361 if (!m_hide)
362 {
363 if (!m_firstCol) m_t << "\n";
364 m_t << ".PP\n";
365 m_t << ".nf\n";
366 }
367 pushHidden(m_hide);
368 m_hide = TRUE;
369 }
370 if (op.type()!=DocIncOperator::Skip)
371 {
372 m_hide = popHidden();
373 if (!m_hide)
374 {
375 std::unique_ptr<FileDef> fd;
376 if (!op.includeFileName().isEmpty())
377 {
378 FileInfo cfi( op.includeFileName().str() );
379 fd = createFileDef( cfi.dirPath(), cfi.fileName() );
380 }
381
382 getCodeParser(locLangExt).parseCode(m_ci,op.context(),op.text(),langExt,
383 op.stripCodeComments(),
384 op.isExample(),op.exampleFile(),
385 fd.get(), // fileDef
386 op.line(), // startLine
387 -1, // endLine
388 FALSE, // inline fragment
389 nullptr, // memberDef
390 op.showLineNo() // show line numbers
391 );
392 }
393 pushHidden(m_hide);
394 m_hide=TRUE;
395 }
396 if (op.isLast())
397 {
398 m_hide = popHidden();
399 if (!m_hide)
400 {
401 if (!m_firstCol) m_t << "\n";
402 m_t << ".fi\n";
403 m_t << ".PP\n";
404 m_firstCol=TRUE;
405 }
406 }
407 else
408 {
409 if (!m_hide) m_t << "\n";
410 }
411}

References DocIncOperator::context, createFileDef, FileInfo::dirPath, DocIncOperator::exampleFile, FALSE, FileInfo::fileName, DocVisitor::getCodeParser, getFileNameExtension, getLanguageFromFileName, DocIncOperator::includeFileName, QCString::isEmpty, DocIncOperator::isExample, DocIncOperator::isFirst, DocIncOperator::isLast, DocIncOperator::line, m_ci, m_firstCol, m_hide, m_langExt, m_t, CodeParserInterface::parseCode, DocVisitor::popHidden, DocVisitor::pushHidden, DocIncOperator::showLineNo, DocIncOperator::Skip, QCString::str, DocIncOperator::stripCodeComments, DocIncOperator::text, TRUE and DocIncOperator::type.

operator()()​

void ManDocVisitor::operator() (const DocFormula & f)

Declaration at line 55 of file mandocvisitor.h, definition at line 413 of file mandocvisitor.cpp.

413void ManDocVisitor::operator()(const DocFormula &f)
414{
415 if (m_hide) return;
416 m_t << f.text();
417}

References m_hide, m_t and DocFormula::text.

operator()()​

void ManDocVisitor::operator() (const DocIndexEntry &)

Declaration at line 56 of file mandocvisitor.h, definition at line 419 of file mandocvisitor.cpp.

419void ManDocVisitor::operator()(const DocIndexEntry &)
420{
421}

operator()()​

void ManDocVisitor::operator() (const DocSimpleSectSep &)

Declaration at line 57 of file mandocvisitor.h, definition at line 423 of file mandocvisitor.cpp.

423void ManDocVisitor::operator()(const DocSimpleSectSep &)
424{
425}

operator()()​

void ManDocVisitor::operator() (const DocCite & cite)

Declaration at line 58 of file mandocvisitor.h, definition at line 427 of file mandocvisitor.cpp.

427void ManDocVisitor::operator()(const DocCite &cite)
428{
429 if (m_hide) return;
430 m_t << "\\fB";
431 auto opt = cite.option();
432 QCString txt;
433 if (!cite.file().isEmpty())
434 {
435 txt = cite.getText();
436 }
437 else
438 {
439 if (!opt.noPar()) txt += "[";
440 txt += cite.target();
441 if (!opt.noPar()) txt += "]";
442 }
443 filter(txt);
444 m_t << "\\fP";
445}

References DocCite::file, filter, DocCite::getText, QCString::isEmpty, m_hide, m_t, DocCite::option and DocCite::target.

operator()()​

void ManDocVisitor::operator() (const DocSeparator & s)

Declaration at line 59 of file mandocvisitor.h, definition at line 447 of file mandocvisitor.cpp.

447void ManDocVisitor::operator()(const DocSeparator &s)
448{
449 if (m_hide) return;
450 m_t << s.chars();
451}

References DocSeparator::chars, m_hide and m_t.

operator()()​

void ManDocVisitor::operator() (const DocAutoList & l)

Declaration at line 65 of file mandocvisitor.h, definition at line 458 of file mandocvisitor.cpp.

458void ManDocVisitor::operator()(const DocAutoList &l)
459{
460 if (m_hide) return;
461 m_indent++;
462 visitChildren(l);
463 m_indent--;
464 m_t << ".PP\n";
465}

References m_hide, m_indent, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocAutoListItem & li)

Declaration at line 66 of file mandocvisitor.h, definition at line 467 of file mandocvisitor.cpp.

467void ManDocVisitor::operator()(const DocAutoListItem &li)
468{
469 if (m_hide) return;
470 QCString ws;
471 if (m_indent>0) ws.fill(' ',2*(m_indent-1));
472 if (!m_firstCol) m_t << "\n";
473 m_t << ".IP \"" << ws;
474 const DocAutoList *list = std::get_if<DocAutoList>(li.parent());
475 if (list && list->isEnumList())
476 {
477 m_t << li.itemNumber() << ".\" " << (2*(m_indent+1));
478 }
479 else // bullet list
480 {
481 switch (li.itemNumber())
482 {
483 case DocAutoList::Unchecked: // unchecked
484 m_t << "[ ]\" " << (2*m_indent) + 2;
485 break;
486 case DocAutoList::Checked_x: // checked with x
487 m_t << "[x]\" " << (2*m_indent) + 2;
488 break;
489 case DocAutoList::Checked_X: // checked with X
490 m_t << "[X]\" " << (2*m_indent) + 2;
491 break;
492 default:
493 m_t << "\\(bu\" " << (2*m_indent);
494 break;
495 }
496 }
497 m_t << "\n";
498 m_firstCol=TRUE;
499 visitChildren(li);
500 m_t << "\n";
501 m_firstCol=TRUE;
502}

References DocAutoList::Checked_X, DocAutoList::Checked_x, QCString::fill, DocAutoList::isEnumList, DocAutoListItem::itemNumber, m_firstCol, m_hide, m_indent, m_t, DocNode::parent, TRUE, DocAutoList::Unchecked and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocPara & p)

Declaration at line 67 of file mandocvisitor.h, definition at line 504 of file mandocvisitor.cpp.

504void ManDocVisitor::operator()(const DocPara &p)
505{
506 if (m_hide) return;
507 visitChildren(p);
508 if (!p.isLast() && // omit <p> for last paragraph
509 !(p.parent() && // and for parameter sections
510 std::get_if<DocParamSect>(p.parent())
511 )
512 )
513 {
514 if (!m_firstCol) m_t << "\n";
515 m_t << "\n.PP\n";
516 m_firstCol=TRUE;
517 }
518}

References DocPara::isLast, m_firstCol, m_hide, m_t, DocNode::parent, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocRoot & r)

Declaration at line 68 of file mandocvisitor.h, definition at line 520 of file mandocvisitor.cpp.

520void ManDocVisitor::operator()(const DocRoot &r)
521{
522 visitChildren(r);
523}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocSimpleSect & s)

Declaration at line 69 of file mandocvisitor.h, definition at line 525 of file mandocvisitor.cpp.

525void ManDocVisitor::operator()(const DocSimpleSect &s)
526{
527 if (m_hide) return;
528 if (!m_firstCol)
529 {
530 m_t << "\n";
531 m_t << ".PP\n";
532 }
533 m_t << "\\fB";
534 switch(s.type())
535 {
536 case DocSimpleSect::See:
537 m_t << theTranslator->trSeeAlso(); break;
538 case DocSimpleSect::Return:
539 m_t << theTranslator->trReturns(); break;
540 case DocSimpleSect::Author:
541 m_t << theTranslator->trAuthor(TRUE,TRUE); break;
542 case DocSimpleSect::Authors:
543 m_t << theTranslator->trAuthor(TRUE,FALSE); break;
544 case DocSimpleSect::Version:
545 m_t << theTranslator->trVersion(); break;
546 case DocSimpleSect::Since:
547 m_t << theTranslator->trSince(); break;
548 case DocSimpleSect::Date:
549 m_t << theTranslator->trDate(); break;
550 case DocSimpleSect::Note:
551 m_t << theTranslator->trNote(); break;
552 case DocSimpleSect::Warning:
553 m_t << theTranslator->trWarning(); break;
554 case DocSimpleSect::Pre:
555 m_t << theTranslator->trPrecondition(); break;
556 case DocSimpleSect::Post:
557 m_t << theTranslator->trPostcondition(); break;
558 case DocSimpleSect::Copyright:
559 m_t << theTranslator->trCopyright(); break;
560 case DocSimpleSect::Invar:
561 m_t << theTranslator->trInvariant(); break;
562 case DocSimpleSect::Remark:
563 m_t << theTranslator->trRemarks(); break;
564 case DocSimpleSect::Attention:
565 m_t << theTranslator->trAttention(); break;
566 case DocSimpleSect::Important:
567 m_t << theTranslator->trImportant(); break;
568 case DocSimpleSect::User: break;
569 case DocSimpleSect::Rcs: break;
570 case DocSimpleSect::Unknown: break;
571 }
572
573 // special case 1: user defined title
574 if (s.title())
575 {
576 std::visit(*this,*s.title());
577 }
578 m_t << "\\fP\n";
579 m_t << ".RS 4\n";
580 visitChildren(s);
581 if (!m_firstCol) m_t << "\n";
582 m_t << ".RE\n";
583 m_t << ".PP\n";
584 m_firstCol=TRUE;
585}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, FALSE, DocSimpleSect::Important, DocSimpleSect::Invar, m_firstCol, m_hide, m_t, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, theTranslator, DocSimpleSect::title, TRUE, DocSimpleSect::type, DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren and DocSimpleSect::Warning.

operator()()​

void ManDocVisitor::operator() (const DocTitle & t)

Declaration at line 70 of file mandocvisitor.h, definition at line 587 of file mandocvisitor.cpp.

587void ManDocVisitor::operator()(const DocTitle &t)
588{
589 if (m_hide) return;
590 visitChildren(t);
591}

References m_hide and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocSimpleList & l)

Declaration at line 71 of file mandocvisitor.h, definition at line 593 of file mandocvisitor.cpp.

593void ManDocVisitor::operator()(const DocSimpleList &l)
594{
595 if (m_hide) return;
596 m_indent++;
597 if (!m_firstCol) m_t << "\n";
598 m_t << ".PD 0\n";
599 m_firstCol=true;
600 visitChildren(l);
601 m_indent--;
602 m_t << ".PP\n";
603}

References m_firstCol, m_hide, m_indent, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocSimpleListItem & li)

Declaration at line 72 of file mandocvisitor.h, definition at line 605 of file mandocvisitor.cpp.

605void ManDocVisitor::operator()(const DocSimpleListItem &li)
606{
607 if (m_hide) return;
608 QCString ws;
609 if (m_indent>0) ws.fill(' ',2*(m_indent-1));
610 if (!m_firstCol) m_t << "\n";
611 m_t << ".IP \"" << ws << "\\(bu\" " << m_indent << "\n";
612 m_firstCol=TRUE;
613 if (li.paragraph())
614 {
615 visit(*this,*li.paragraph());
616 }
617 m_t << "\n";
618 m_firstCol=TRUE;
619}

References QCString::fill, m_firstCol, m_hide, m_indent, m_t, DocSimpleListItem::paragraph and TRUE.

operator()()​

void ManDocVisitor::operator() (const DocSection & s)

Declaration at line 73 of file mandocvisitor.h, definition at line 621 of file mandocvisitor.cpp.

621void ManDocVisitor::operator()(const DocSection &s)
622{
623 if (m_hide) return;
624 if (!m_firstCol) m_t << "\n";
625 if (s.level()==1) m_t << ".SH"; else m_t << ".SS";
626 m_t << " \"";
627 if (s.title())
628 {
629 std::visit(*this,*s.title());
630 }
631 m_t << "\"\n";
632 if (s.level()==1) m_t << ".PP\n";
633 m_firstCol=TRUE;
634 visitChildren(s);
635}

References DocSection::level, m_firstCol, m_hide, m_t, DocSection::title, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlList & s)

Declaration at line 74 of file mandocvisitor.h, definition at line 637 of file mandocvisitor.cpp.

637void ManDocVisitor::operator()(const DocHtmlList &l)
638{
639 if (m_hide) return;
640 m_indent++;
641 if (!m_firstCol) m_t << "\n";
642 m_t << ".PD 0\n";
643 m_firstCol=true;
644 int indent = std::min(m_indent,maxIndentLevels-1);
645 m_listItemInfo[indent].number = 1;
646 m_listItemInfo[indent].type = '1';
647 for (const auto &opt : l.attribs())
648 {
649 if (opt.name=="type")
650 {
651 m_listItemInfo[indent].type = opt.value[0];
652 }
653 if (opt.name=="start")
654 {
655 bool ok = false;
656 int val = opt.value.toInt(&ok);
657 if (ok) m_listItemInfo[indent].number = val;
658 }
659 }
660 visitChildren(l);
661 m_indent--;
662 if (!m_firstCol) m_t << "\n";
663 m_t << ".PP\n";
664}

References DocHtmlList::attribs, m_firstCol, m_hide, m_indent, m_listItemInfo, m_t, maxIndentLevels and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlListItem & li)

Declaration at line 75 of file mandocvisitor.h, definition at line 666 of file mandocvisitor.cpp.

666void ManDocVisitor::operator()(const DocHtmlListItem &li)
667{
668 if (m_hide) return;
669 QCString ws;
670 if (m_indent>0) ws.fill(' ',2*(m_indent-1));
671 if (!m_firstCol) m_t << "\n";
672 m_t << ".IP \"" << ws;
673 const DocHtmlList *list = std::get_if<DocHtmlList>(li.parent());
674 if (list && list->type()==DocHtmlList::Ordered)
675 {
676 int indent = std::min(m_indent,maxIndentLevels-1);
677 for (const auto &opt : li.attribs())
678 {
679 if (opt.name=="value")
680 {
681 bool ok = false;
682 int val = opt.value.toInt(&ok);
683 if (ok) m_listItemInfo[indent].number = val;
684 }
685 }
686 switch (m_listItemInfo[indent].type)
687 {
688 case '1':
689 m_t << m_listItemInfo[indent].number;
690 break;
691 case 'a':
692 m_t << integerToAlpha(m_listItemInfo[indent].number,false);
693 break;
694 case 'A':
695 m_t << integerToAlpha(m_listItemInfo[indent].number);
696 break;
697 case 'i':
698 m_t << integerToRoman(m_listItemInfo[indent].number,false);
699 break;
700 case 'I':
701 m_t << integerToRoman(m_listItemInfo[indent].number);
702 break;
703 default:
704 m_t << m_listItemInfo[indent].number;
705 break;
706 }
707 m_t << ".\" " << ((m_indent+1)*2);
708 m_listItemInfo[indent].number++;
709 }
710 else // bullet list
711 {
712 m_t << "\\(bu\" " << (m_indent*2);
713 }
714 m_t << "\n";
715 m_firstCol=TRUE;
716 visitChildren(li);
717 m_t << "\n";
718 m_firstCol=TRUE;
719}

References DocHtmlListItem::attribs, QCString::fill, integerToAlpha, integerToRoman, m_firstCol, m_hide, m_indent, m_listItemInfo, m_t, maxIndentLevels, DocHtmlList::Ordered, DocNode::parent, TRUE, DocHtmlList::type and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlDescList & dl)

Declaration at line 76 of file mandocvisitor.h, definition at line 721 of file mandocvisitor.cpp.

721void ManDocVisitor::operator()(const DocHtmlDescList &dl)
722{
723 if (m_hide) return;
724 m_indent+=2;
725 visitChildren(dl);
726 m_indent-=2;
727 if (!m_firstCol) m_t << "\n";
728 m_t << "\n.PP\n";
729 m_firstCol=TRUE;
730}

References m_firstCol, m_hide, m_indent, m_t, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlDescTitle & dt)

Declaration at line 77 of file mandocvisitor.h, definition at line 732 of file mandocvisitor.cpp.

732void ManDocVisitor::operator()(const DocHtmlDescTitle &dt)
733{
734 if (m_hide) return;
735 if (!m_firstCol) m_t << "\n";
736 m_t << "\n.PP";
737 m_t << "\n.IP \"\\fB";
738 m_firstCol=FALSE;
739 visitChildren(dt);
740}

References FALSE, m_firstCol, m_hide, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlDescData & dd)

Declaration at line 78 of file mandocvisitor.h, definition at line 742 of file mandocvisitor.cpp.

742void ManDocVisitor::operator()(const DocHtmlDescData &dd)
743{
744 if (!m_firstCol) m_t << "\n";
745 m_t << ".IP \"\" 1c\n";
746 m_firstCol=TRUE;
747 visitChildren(dd);
748}

References m_firstCol, m_t, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlTable & t)

Declaration at line 79 of file mandocvisitor.h, definition at line 750 of file mandocvisitor.cpp.

750void ManDocVisitor::operator()(const DocHtmlTable &t)
751{
752 visitChildren(t);
753}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlCaption & c)

Declaration at line 80 of file mandocvisitor.h, definition at line 755 of file mandocvisitor.cpp.

755void ManDocVisitor::operator()(const DocHtmlCaption &c)
756{
757 visitChildren(c);
758}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlRow & r)

Declaration at line 81 of file mandocvisitor.h, definition at line 760 of file mandocvisitor.cpp.

760void ManDocVisitor::operator()(const DocHtmlRow &r)
761{
762 visitChildren(r);
763}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlCell & c)

Declaration at line 82 of file mandocvisitor.h, definition at line 765 of file mandocvisitor.cpp.

765void ManDocVisitor::operator()(const DocHtmlCell &c)
766{
767 visitChildren(c);
768}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocInternal & i)

Declaration at line 83 of file mandocvisitor.h, definition at line 770 of file mandocvisitor.cpp.

770void ManDocVisitor::operator()(const DocInternal &i)
771{
772 visitChildren(i);
773}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHRef & href)

Declaration at line 84 of file mandocvisitor.h, definition at line 775 of file mandocvisitor.cpp.

775void ManDocVisitor::operator()(const DocHRef &href)
776{
777 if (m_hide) return;
778 m_t << "\\fR";
779 visitChildren(href);
780 m_t << "\\fP";
781}

References m_hide, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlSummary & s)

Declaration at line 85 of file mandocvisitor.h, definition at line 783 of file mandocvisitor.cpp.

783void ManDocVisitor::operator()(const DocHtmlSummary &s)
784{
785 m_t << "\\fB";
786 visitChildren(s);
787 m_t << "\\fP\n.PP\n";
788}

References m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlDetails & d)

Declaration at line 86 of file mandocvisitor.h, definition at line 790 of file mandocvisitor.cpp.

790void ManDocVisitor::operator()(const DocHtmlDetails &d)
791{
792 if (m_hide) return;
793 if (!m_firstCol)
794 {
795 m_t << "\n";
796 m_t << ".PP\n";
797 }
798 auto summary = d.summary();
799 if (summary)
800 {
801 std::visit(*this,*summary);
802 m_t << ".PP\n";
803 m_t << ".RS 4\n";
804 }
805 visitChildren(d);
806 if (!m_firstCol) m_t << "\n";
807 if (summary)
808 {
809 m_t << ".RE\n";
810 }
811 m_t << ".PP\n";
812 m_firstCol=TRUE;
813}

References m_firstCol, m_hide, m_t, DocHtmlDetails::summary, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlHeader & header)

Declaration at line 87 of file mandocvisitor.h, definition at line 815 of file mandocvisitor.cpp.

815void ManDocVisitor::operator()(const DocHtmlHeader &header)
816{
817 if (m_hide) return;
818 if (!m_firstCol) m_t << "\n";
819 if (header.level()==1) m_t << ".SH"; else m_t << ".SS";
820 m_t << " \"";
821 visitChildren(header);
822 m_t << "\"\n";
823 if (header.level()==1) m_t << ".PP\n";
824 m_firstCol=TRUE;
825}

References DocHtmlHeader::level, m_firstCol, m_hide, m_t, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocImage &)

Declaration at line 88 of file mandocvisitor.h, definition at line 827 of file mandocvisitor.cpp.

827void ManDocVisitor::operator()(const DocImage &)
828{
829}

operator()()​

void ManDocVisitor::operator() (const DocDotFile &)

Declaration at line 89 of file mandocvisitor.h, definition at line 831 of file mandocvisitor.cpp.

831void ManDocVisitor::operator()(const DocDotFile &)
832{
833}

operator()()​

void ManDocVisitor::operator() (const DocMscFile &)

Declaration at line 90 of file mandocvisitor.h, definition at line 835 of file mandocvisitor.cpp.

835void ManDocVisitor::operator()(const DocMscFile &)
836{
837}

operator()()​

void ManDocVisitor::operator() (const DocDiaFile &)

Declaration at line 91 of file mandocvisitor.h, definition at line 839 of file mandocvisitor.cpp.

839void ManDocVisitor::operator()(const DocDiaFile &)
840{
841}

operator()()​

void ManDocVisitor::operator() (const DocPlantUmlFile &)

Declaration at line 92 of file mandocvisitor.h, definition at line 843 of file mandocvisitor.cpp.

843void ManDocVisitor::operator()(const DocPlantUmlFile &)
844{
845}

operator()()​

void ManDocVisitor::operator() (const DocLink & lnk)

Declaration at line 93 of file mandocvisitor.h, definition at line 847 of file mandocvisitor.cpp.

847void ManDocVisitor::operator()(const DocLink &dl)
848{
849 if (m_hide) return;
850 m_t << "\\fB";
851 visitChildren(dl);
852 m_t << "\\fP";
853}

References m_hide, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocRef & ref)

Declaration at line 94 of file mandocvisitor.h, definition at line 855 of file mandocvisitor.cpp.

855void ManDocVisitor::operator()(const DocRef &ref)
856{
857 if (m_hide) return;
858 m_t << "\\fB";
859 if (!ref.hasLinkText()) filter(ref.targetTitle());
860 visitChildren(ref);
861 m_t << "\\fP";
862}

References filter, DocRef::hasLinkText, m_hide, m_t, DocRef::targetTitle and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocSecRefItem & ref)

Declaration at line 95 of file mandocvisitor.h, definition at line 864 of file mandocvisitor.cpp.

864void ManDocVisitor::operator()(const DocSecRefItem &ref)
865{
866 if (m_hide) return;
867 QCString ws;
868 if (m_indent>0) ws.fill(' ',2*(m_indent-1));
869 if (!m_firstCol) m_t << "\n";
870 m_t << ".IP \"" << ws << "\\(bu\" " << (2*m_indent) << "\n";
871 m_firstCol=TRUE;
872 visitChildren(ref);
873 m_t << "\n";
874 m_firstCol=TRUE;
875}

References QCString::fill, m_firstCol, m_hide, m_indent, m_t, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocSecRefList & l)

Declaration at line 96 of file mandocvisitor.h, definition at line 877 of file mandocvisitor.cpp.

877void ManDocVisitor::operator()(const DocSecRefList &l)
878{
879 if (m_hide) return;
880 m_indent++;
881 visitChildren(l);
882 m_indent--;
883 if (!m_firstCol) m_t << "\n";
884 m_t << ".PP\n";
885}

References m_firstCol, m_hide, m_indent, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocParamSect & s)

Declaration at line 97 of file mandocvisitor.h, definition at line 887 of file mandocvisitor.cpp.

887void ManDocVisitor::operator()(const DocParamSect &s)
888{
889 if (m_hide) return;
890 if (!m_firstCol)
891 {
892 m_t << "\n";
893 m_t << ".PP\n";
894 }
895 m_t << "\\fB";
896 switch(s.type())
897 {
898 case DocParamSect::Param:
899 m_t << theTranslator->trParameters(); break;
900 case DocParamSect::RetVal:
901 m_t << theTranslator->trReturnValues(); break;
902 case DocParamSect::Exception:
903 m_t << theTranslator->trExceptions(); break;
904 case DocParamSect::TemplateParam:
905 m_t << theTranslator->trTemplateParameters(); break;
906 default:
907 ASSERT(0);
908 }
909 m_t << "\\fP\n";
910 m_t << ".RS 4\n";
911 visitChildren(s);
912 if (!m_firstCol) m_t << "\n";
913 m_t << ".RE\n";
914 m_t << ".PP\n";
915 m_firstCol=TRUE;
916}

References ASSERT, DocParamSect::Exception, m_firstCol, m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, theTranslator, TRUE, DocParamSect::type and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocParamList & pl)

Declaration at line 98 of file mandocvisitor.h, definition at line 918 of file mandocvisitor.cpp.

918void ManDocVisitor::operator()(const DocParamList &pl)
919{
920 if (m_hide) return;
921 m_t << "\\fI";
922 bool first=TRUE;
923 for (const auto &param : pl.parameters())
924 {
925 if (!first) m_t << ","; else first=FALSE;
926 std::visit(*this,param);
927 }
928 m_t << "\\fP ";
929 for (const auto &par : pl.paragraphs())
930 {
931 std::visit(*this,par);
932 }
933 if (!pl.isLast())
934 {
935 if (!m_firstCol) m_t << "\n";
936 m_t << ".br\n";
937 }
938}

References FALSE, DocParamList::isLast, m_firstCol, m_hide, m_t, DocParamList::paragraphs, DocParamList::parameters and TRUE.

operator()()​

void ManDocVisitor::operator() (const DocXRefItem & x)

Declaration at line 99 of file mandocvisitor.h, definition at line 940 of file mandocvisitor.cpp.

940void ManDocVisitor::operator()(const DocXRefItem &x)
941{
942 if (m_hide) return;
943 if (x.title().isEmpty()) return;
944 if (!m_firstCol)
945 {
946 m_t << "\n";
947 m_t << ".PP\n";
948 }
949 m_t << "\\fB";
950 filter(x.title());
951 m_t << "\\fP\n";
952 m_t << ".RS 4\n";
953 visitChildren(x);
954 if (x.title().isEmpty()) return;
955 if (!m_firstCol) m_t << "\n";
956 m_t << ".RE\n";
957 m_t << ".PP\n";
958 m_firstCol=TRUE;
959}

References filter, QCString::isEmpty, m_firstCol, m_hide, m_t, DocXRefItem::title, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocInternalRef & ref)

Declaration at line 100 of file mandocvisitor.h, definition at line 961 of file mandocvisitor.cpp.

961void ManDocVisitor::operator()(const DocInternalRef &ref)
962{
963 if (m_hide) return;
964 m_t << "\\fB";
965 visitChildren(ref);
966 m_t << "\\fP";
967}

References m_hide, m_t and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocText & t)

Declaration at line 101 of file mandocvisitor.h, definition at line 969 of file mandocvisitor.cpp.

969void ManDocVisitor::operator()(const DocText &t)
970{
971 visitChildren(t);
972}

Reference visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocHtmlBlockQuote & q)

Declaration at line 102 of file mandocvisitor.h, definition at line 974 of file mandocvisitor.cpp.

974void ManDocVisitor::operator()(const DocHtmlBlockQuote &q)
975{
976 if (m_hide) return;
977 if (!m_firstCol)
978 {
979 m_t << "\n";
980 m_t << ".PP\n";
981 }
982 m_t << ".RS 4\n"; // TODO: add support for nested block quotes
983 visitChildren(q);
984 if (!m_firstCol) m_t << "\n";
985 m_t << ".RE\n";
986 m_t << ".PP\n";
987 m_firstCol=TRUE;
988}

References m_firstCol, m_hide, m_t, TRUE and visitChildren.

operator()()​

void ManDocVisitor::operator() (const DocVhdlFlow &)

Declaration at line 103 of file mandocvisitor.h, definition at line 990 of file mandocvisitor.cpp.

990void ManDocVisitor::operator()(const DocVhdlFlow &)
991{
992}

operator()()​

void ManDocVisitor::operator() (const DocParBlock & pb)

Declaration at line 104 of file mandocvisitor.h, definition at line 994 of file mandocvisitor.cpp.

994void ManDocVisitor::operator()(const DocParBlock &pb)
995{
996 visitChildren(pb);
997}

Reference visitChildren.

Private Member Functions​

filter()​

void ManDocVisitor::filter (const QCString & str, const bool retainNewline=false)

Declaration at line 120 of file mandocvisitor.h, definition at line 999 of file mandocvisitor.cpp.

999void ManDocVisitor::filter(const QCString &str, const bool retainNewline)
1000{
1001 if (!str.isEmpty())
1002 {
1003 const char *p=str.data();
1004 char c=0;
1005 bool insideDoubleQuote = false;
1006 while ((c=*p++))
1007 {
1008 switch(c)
1009 {
1010 case '.': m_t << "\\&."; break; // see bug652277
1011 case '\\': m_t << "\\\\"; break;
1012 case '\"': m_t << "\""; insideDoubleQuote = !insideDoubleQuote; break;
1013 case '\n': if (retainNewline || !insideDoubleQuote) m_t << c; break;
1014 default: m_t << c; break;
1015 }
1016 }
1017 }
1018}

References QCString::data, QCString::isEmpty and m_t.

Referenced by operator(), operator(), operator(), operator(), operator() and operator().

visitChildren()​

template <class T>
void ManDocVisitor::visitChildren (const T & t)
 inline

Definition at line 108 of file mandocvisitor.h.

108 void visitChildren(const T &t)
109 {
110 for (const auto &child : t.children())
111 {
112 std::visit(*this, child);
113 }
114 }

Referenced by operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator() and operator().

Private Member Attributes​

m_ci​

OutputCodeList& ManDocVisitor::m_ci

Definition at line 127 of file mandocvisitor.h.

127 OutputCodeList &m_ci;

Referenced by ManDocVisitor, operator(), operator() and operator().

m_firstCol​

bool ManDocVisitor::m_firstCol

Definition at line 130 of file mandocvisitor.h.

130 bool m_firstCol;

Referenced by ManDocVisitor, operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator() and operator().

m_hide​

bool ManDocVisitor::m_hide

Definition at line 129 of file mandocvisitor.h.

129 bool m_hide;

Referenced by ManDocVisitor, operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator() and operator().

m_indent​

int ManDocVisitor::m_indent

Definition at line 131 of file mandocvisitor.h.

131 int m_indent;

Referenced by ManDocVisitor, operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator() and operator().

m_insidePre​

bool ManDocVisitor::m_insidePre

Definition at line 128 of file mandocvisitor.h.

128 bool m_insidePre;

Referenced by ManDocVisitor, operator() and operator().

m_langExt​

QCString ManDocVisitor::m_langExt

Definition at line 132 of file mandocvisitor.h.

132 QCString m_langExt;

Referenced by ManDocVisitor, operator() and operator().

m_listItemInfo​

std::array<ManListItemInfo,maxIndentLevels> ManDocVisitor::m_listItemInfo

Definition at line 141 of file mandocvisitor.h.

141 std::array<ManListItemInfo,maxIndentLevels> m_listItemInfo;

Referenced by operator() and operator().

m_t​

TextStream& ManDocVisitor::m_t

Definition at line 126 of file mandocvisitor.h.

126 TextStream &m_t;

Referenced by filter, ManDocVisitor, operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator(), operator() and operator().

Private Static Attributes​

maxIndentLevels​

const int ManDocVisitor::maxIndentLevels = 13
 static

Definition at line 139 of file mandocvisitor.h.

139 static const int maxIndentLevels = 13;

Referenced by operator() and operator().

The documentation for this class was generated from the following files:

Generated via doxygen2docusaurus by Doxygen 1.14.0.