Doxygen
Loading...
Searching...
No Matches
PrintDocVisitor Class Reference

#include <src/printdocvisitor.h>

Public Member Functions

 PrintDocVisitor ()
void operator() (const DocWord &w)
void operator() (const DocLinkedWord &w)
void operator() (const DocWhiteSpace &w)
void operator() (const DocSymbol &s)
void operator() (const DocEmoji &s)
void operator() (const DocURL &u)
void operator() (const DocLineBreak &)
void operator() (const DocHorRuler &)
void operator() (const DocStyleChange &s)
void operator() (const DocVerbatim &s)
void operator() (const DocAnchor &a)
void operator() (const DocInclude &inc)
void operator() (const DocIncOperator &op)
void operator() (const DocFormula &f)
void operator() (const DocIndexEntry &i)
void operator() (const DocSimpleSectSep &)
void operator() (const DocCite &cite)
void operator() (const DocSeparator &)
template<class T>
void visitChildren (const T &t)
void operator() (const DocAutoList &l)
void operator() (const DocAutoListItem &li)
void operator() (const DocPara &p)
void operator() (const DocRoot &r)
void operator() (const DocSimpleSect &s)
void operator() (const DocTitle &t)
void operator() (const DocSimpleList &l)
void operator() (const DocSimpleListItem &li)
void operator() (const DocSection &s)
void operator() (const DocHtmlList &s)
void operator() (const DocHtmlListItem &li)
void operator() (const DocHtmlDescList &l)
void operator() (const DocHtmlDescTitle &dt)
void operator() (const DocHtmlDescData &dd)
void operator() (const DocHtmlTable &t)
void operator() (const DocHtmlRow &tr)
void operator() (const DocHtmlCell &c)
void operator() (const DocHtmlCaption &c)
void operator() (const DocInternal &i)
void operator() (const DocHRef &href)
void operator() (const DocHtmlSummary &summary)
void operator() (const DocHtmlDetails &details)
void operator() (const DocHtmlHeader &header)
void operator() (const DocImage &img)
void operator() (const DocDotFile &df)
void operator() (const DocMscFile &df)
void operator() (const DocDiaFile &df)
void operator() (const DocPlantUmlFile &df)
void operator() (const DocLink &lnk)
void operator() (const DocRef &ref)
void operator() (const DocSecRefItem &ref)
void operator() (const DocSecRefList &rl)
void operator() (const DocParamList &pl)
void operator() (const DocParamSect &ps)
void operator() (const DocXRefItem &x)
void operator() (const DocInternalRef &r)
void operator() (const DocText &t)
void operator() (const DocHtmlBlockQuote &q)
void operator() (const DocVhdlFlow &vf)
void operator() (const DocParBlock &pb)

Private Member Functions

void indent ()
void indent_leaf ()
void indent_pre ()
void indent_post ()

Private Attributes

int m_indent
bool m_needsEnter
bool m_insidePre

Detailed Description

Visitor implementation for pretty printing

Definition at line 27 of file printdocvisitor.h.

Constructor & Destructor Documentation

◆ PrintDocVisitor()

PrintDocVisitor::PrintDocVisitor ( )
inline

Definition at line 30 of file printdocvisitor.h.

References FALSE, m_indent, m_insidePre, and m_needsEnter.

Member Function Documentation

◆ indent()

void PrintDocVisitor::indent ( )
inlineprivate

Definition at line 740 of file printdocvisitor.h.

741 {
742 if (m_needsEnter) printf("\n");
743 for (int i=0;i<m_indent;i++) printf(".");
745 }

References FALSE, m_indent, and m_needsEnter.

Referenced by indent_leaf(), indent_post(), and indent_pre().

◆ indent_leaf()

void PrintDocVisitor::indent_leaf ( )
inlineprivate

◆ indent_post()

◆ indent_pre()

◆ operator()() [1/58]

void PrintDocVisitor::operator() ( const DocAnchor & a)
inline

Definition at line 195 of file printdocvisitor.h.

196 {
197 indent_leaf();
198 printf("<anchor name=\"%s\"/>",qPrint(a.anchor()));
199 }
QCString anchor() const
Definition docnode.h:231
const char * qPrint(const char *s)
Definition qcstring.h:672

References DocAnchor::anchor(), indent_leaf(), and qPrint().

◆ operator()() [2/58]

void PrintDocVisitor::operator() ( const DocAutoList & l)
inline

Definition at line 278 of file printdocvisitor.h.

279 {
280 indent_pre();
281 if (l.isEnumList())
282 {
283 printf("<ol>\n");
284 }
285 else
286 {
287 printf("<ul>\n");
288 }
289 visitChildren(l);
290 indent_post();
291 if (l.isEnumList())
292 {
293 printf("</ol>\n");
294 }
295 else
296 {
297 printf("</ul>\n");
298 }
299 }
bool isEnumList() const
Definition docnode.h:576
void visitChildren(const T &t)

References indent_post(), indent_pre(), DocAutoList::isEnumList(), and visitChildren().

◆ operator()() [3/58]

void PrintDocVisitor::operator() ( const DocAutoListItem & li)
inline

Definition at line 300 of file printdocvisitor.h.

301 {
302 indent_pre();
303 switch (li.itemNumber())
304 {
305 case DocAutoList::Unchecked: // unchecked
306 printf("<li class=\"unchecked\">\n");
307 break;
308 case DocAutoList::Checked_x: // checked with x
309 case DocAutoList::Checked_X: // checked with X
310 printf("<li class=\"checked\">\n");
311 break;
312 default:
313 printf("<li>\n");
314 break;
315 }
316 visitChildren(li);
317 indent_post();
318 printf("</li>\n");
319 }
int itemNumber() const
Definition docnode.h:594

References DocAutoList::Checked_X, DocAutoList::Checked_x, indent_post(), indent_pre(), DocAutoListItem::itemNumber(), DocAutoList::Unchecked, and visitChildren().

◆ operator()() [4/58]

void PrintDocVisitor::operator() ( const DocCite & cite)
inline

Definition at line 253 of file printdocvisitor.h.

254 {
255 indent_leaf();
256 printf("<cite ref=\"%s\" file=\"%s\" "
257 "anchor=\"%s\" text=\"%s\""
258 "/>\n",
259 qPrint(cite.ref()),qPrint(cite.file()),qPrint(cite.anchor()),
260 qPrint(cite.text()));
261 }
QCString text() const
Definition docnode.h:251
QCString anchor() const
Definition docnode.h:250
QCString ref() const
Definition docnode.h:249
QCString file() const
Definition docnode.h:247

References DocCite::anchor(), DocCite::file(), indent_leaf(), qPrint(), DocCite::ref(), and DocCite::text().

◆ operator()() [5/58]

void PrintDocVisitor::operator() ( const DocDiaFile & df)
inline

Definition at line 599 of file printdocvisitor.h.

600 {
601 indent_pre();
602 printf("<diafile src=\"%s\">\n",qPrint(df.name()));
603 visitChildren(df);
604 indent_post();
605 printf("</diafile>\n");
606 }
QCString name() const
Definition docnode.h:679

References indent_post(), indent_pre(), DocDiagramFileBase::name(), qPrint(), and visitChildren().

◆ operator()() [6/58]

void PrintDocVisitor::operator() ( const DocDotFile & df)
inline

Definition at line 583 of file printdocvisitor.h.

584 {
585 indent_pre();
586 printf("<dotfile src=\"%s\">\n",qPrint(df.name()));
587 visitChildren(df);
588 indent_post();
589 printf("</dotfile>\n");
590 }

References indent_post(), indent_pre(), DocDiagramFileBase::name(), qPrint(), and visitChildren().

◆ operator()() [7/58]

void PrintDocVisitor::operator() ( const DocEmoji & s)
inline

Definition at line 69 of file printdocvisitor.h.

70 {
72 const char *res = EmojiEntityMapper::instance().name(s.index());
73 if (res)
74 {
75 printf("%s",res);
76 }
77 else
78 {
79 printf("print: non supported emoji found: %s\n",qPrint(s.name()));
80 }
81 }
int index() const
Definition docnode.h:341
QCString name() const
Definition docnode.h:340
const char * name(int index) const
Access routine to the name of the Emoji entity.
Definition emoji.cpp:2026
static EmojiEntityMapper & instance()
Returns the one and only instance of the Emoji entity mapper.
Definition emoji.cpp:1978

References indent_leaf(), DocEmoji::index(), EmojiEntityMapper::instance(), DocEmoji::name(), EmojiEntityMapper::name(), and qPrint().

◆ operator()() [8/58]

void PrintDocVisitor::operator() ( const DocFormula & f)
inline

Definition at line 238 of file printdocvisitor.h.

239 {
240 indent_leaf();
241 printf("<formula name=%s text=%s/>",qPrint(f.name()),qPrint(f.text()));
242 }
QCString text() const
Definition docnode.h:529
QCString name() const
Definition docnode.h:528

References indent_leaf(), DocFormula::name(), qPrint(), and DocFormula::text().

◆ operator()() [9/58]

void PrintDocVisitor::operator() ( const DocHorRuler & )
inline

Definition at line 92 of file printdocvisitor.h.

93 {
95 printf("<hr>");
96 }

References indent_leaf().

◆ operator()() [10/58]

void PrintDocVisitor::operator() ( const DocHRef & href)
inline

Definition at line 519 of file printdocvisitor.h.

520 {
521 indent_pre();
522 printf("<a url=\"%s\">\n",qPrint(href.url()));
523 visitChildren(href);
524 indent_post();
525 printf("</a>\n");
526 }
QCString url() const
Definition docnode.h:825

References indent_post(), indent_pre(), qPrint(), DocHRef::url(), and visitChildren().

◆ operator()() [11/58]

void PrintDocVisitor::operator() ( const DocHtmlBlockQuote & q)
inline

Definition at line 713 of file printdocvisitor.h.

714 {
715 indent_pre();
716 printf("<blockquote>\n");
717 visitChildren(q);
718 indent_post();
719 printf("</blockquote>\n");
720 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [12/58]

void PrintDocVisitor::operator() ( const DocHtmlCaption & c)
inline

Definition at line 503 of file printdocvisitor.h.

504 {
505 indent_pre();
506 printf("<caption>\n");
507 visitChildren(c);
508 indent_post();
509 printf("</caption>\n");
510 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [13/58]

void PrintDocVisitor::operator() ( const DocHtmlCell & c)
inline

Definition at line 495 of file printdocvisitor.h.

496 {
497 indent_pre();
498 printf("<t%c>\n",c.isHeading()?'h':'d');
499 visitChildren(c);
500 indent_post();
501 printf("</t%c>\n",c.isHeading()?'h':'d');
502 }
bool isHeading() const
Definition docnode.h:1195

References indent_post(), indent_pre(), DocHtmlCell::isHeading(), and visitChildren().

◆ operator()() [14/58]

void PrintDocVisitor::operator() ( const DocHtmlDescData & dd)
inline

Definition at line 466 of file printdocvisitor.h.

467 {
468 indent_pre();
469 printf("<dd>\n");
470 visitChildren(dd);
471 indent_post();
472 printf("</dd>\n");
473 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [15/58]

void PrintDocVisitor::operator() ( const DocHtmlDescList & l)
inline

Definition at line 450 of file printdocvisitor.h.

451 {
452 indent_pre();
453 printf("<dl>\n");
454 visitChildren(l);
455 indent_post();
456 printf("</dl>\n");
457 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [16/58]

void PrintDocVisitor::operator() ( const DocHtmlDescTitle & dt)
inline

Definition at line 458 of file printdocvisitor.h.

459 {
460 indent_pre();
461 printf("<dt>\n");
462 visitChildren(dt);
463 indent_post();
464 printf("</dt>\n");
465 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [17/58]

void PrintDocVisitor::operator() ( const DocHtmlDetails & details)
inline

Definition at line 540 of file printdocvisitor.h.

541 {
542 indent_pre();
543 printf("<details");
544 for (const auto &opt : details.attribs())
545 {
546 printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
547 }
548 printf(">\n");
549 auto summary = details.summary();
550 if (summary)
551 {
552 std::visit(*this,*summary);
553 }
554 visitChildren(details);
555 indent_post();
556 printf("</details>\n");
557 }
const HtmlAttribList & attribs() const
Definition docnode.h:856
const DocNodeVariant * summary() const
Definition docnode.h:859

References indent_post(), indent_pre(), qPrint(), and visitChildren().

◆ operator()() [18/58]

void PrintDocVisitor::operator() ( const DocHtmlHeader & header)
inline

Definition at line 558 of file printdocvisitor.h.

559 {
560 indent_pre();
561 printf("<h%d>\n",header.level());
562 visitChildren(header);
563 indent_post();
564 printf("</h%d>\n",header.level());
565 }
int level() const
Definition docnode.h:872

References indent_post(), indent_pre(), DocHtmlHeader::level(), and visitChildren().

◆ operator()() [19/58]

void PrintDocVisitor::operator() ( const DocHtmlList & s)
inline

Definition at line 410 of file printdocvisitor.h.

411 {
412 indent_pre();
413 if (s.type()==DocHtmlList::Ordered)
414 {
415 printf("<ol");
416 for (const auto &opt : s.attribs())
417 {
418 printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
419 }
420 printf(">\n");
421 }
422 else
423 {
424 printf("<ul>\n");
425 }
426 visitChildren(s);
427 indent_post();
428 if (s.type()==DocHtmlList::Ordered)
429 {
430 printf("</ol>\n");
431 }
432 else
433 {
434 printf("</ul>\n");
435 }
436 }
const HtmlAttribList & attribs() const
Definition docnode.h:1001
Type type() const
Definition docnode.h:1000

References DocHtmlList::attribs(), indent_post(), indent_pre(), DocHtmlList::Ordered, qPrint(), DocHtmlList::type(), and visitChildren().

◆ operator()() [20/58]

void PrintDocVisitor::operator() ( const DocHtmlListItem & li)
inline

Definition at line 437 of file printdocvisitor.h.

438 {
439 indent_pre();
440 printf("<li");
441 for (const auto &opt : li.attribs())
442 {
443 printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
444 }
445 printf(">\n");
446 visitChildren(li);
447 indent_post();
448 printf("</li>\n");
449 }
const HtmlAttribList & attribs() const
Definition docnode.h:1165

References DocHtmlListItem::attribs(), indent_post(), indent_pre(), qPrint(), and visitChildren().

◆ operator()() [21/58]

void PrintDocVisitor::operator() ( const DocHtmlRow & tr)
inline

Definition at line 487 of file printdocvisitor.h.

488 {
489 indent_pre();
490 printf("<tr>\n");
491 visitChildren(tr);
492 indent_post();
493 printf("</tr>\n");
494 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [22/58]

void PrintDocVisitor::operator() ( const DocHtmlSummary & summary)
inline

Definition at line 527 of file printdocvisitor.h.

528 {
529 indent_pre();
530 printf("<summary");
531 for (const auto &opt : summary.attribs())
532 {
533 printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
534 }
535 printf(">\n");
536 visitChildren(summary);
537 indent_post();
538 printf("</summary>\n");
539 }
const HtmlAttribList & attribs() const
Definition docnode.h:843

References DocHtmlSummary::attribs(), indent_post(), indent_pre(), qPrint(), and visitChildren().

◆ operator()() [23/58]

void PrintDocVisitor::operator() ( const DocHtmlTable & t)
inline

Definition at line 474 of file printdocvisitor.h.

475 {
476 indent_pre();
477 printf("<table rows=\"%zu\" cols=\"%zu\">\n",
478 t.numRows(),t.numColumns());
479 visitChildren(t);
480 if (t.caption())
481 {
482 std::visit(*this, *t.caption());
483 }
484 indent_post();
485 printf("</table>\n");
486 }
size_t numRows() const
Definition docnode.h:1268
size_t numColumns() const
Definition docnode.h:1273
const DocNodeVariant * caption() const
Definition docnode.cpp:2044

References DocHtmlTable::caption(), indent_post(), indent_pre(), DocHtmlTable::numColumns(), DocHtmlTable::numRows(), and visitChildren().

◆ operator()() [24/58]

void PrintDocVisitor::operator() ( const DocImage & img)
inline

Definition at line 566 of file printdocvisitor.h.

567 {
568 indent_pre();
569 printf("<image src=\"%s\" type=\"",qPrint(img.name()));
570 switch(img.type())
571 {
572 case DocImage::Html: printf("html"); break;
573 case DocImage::Latex: printf("latex"); break;
574 case DocImage::Rtf: printf("rtf"); break;
575 case DocImage::DocBook: printf("docbook"); break;
576 case DocImage::Xml: printf("xml"); break;
577 }
578 printf("\" %s %s inline=\"%s\">\n",qPrint(img.width()),qPrint(img.height()),img.isInlineImage() ? "yes" : "no");
579 visitChildren(img);
580 indent_post();
581 printf("</image>\n");
582 }
QCString name() const
Definition docnode.h:643
QCString height() const
Definition docnode.h:646
Type type() const
Definition docnode.h:642
QCString width() const
Definition docnode.h:645
@ DocBook
Definition docnode.h:639
bool isInlineImage() const
Definition docnode.h:649

References DocImage::DocBook, DocImage::height(), DocImage::Html, indent_post(), indent_pre(), DocImage::isInlineImage(), DocImage::Latex, DocImage::name(), qPrint(), DocImage::Rtf, DocImage::type(), visitChildren(), DocImage::width(), and DocImage::Xml.

◆ operator()() [25/58]

void PrintDocVisitor::operator() ( const DocInclude & inc)
inline

Definition at line 200 of file printdocvisitor.h.

201 {
202 indent_leaf();
203 printf("<include file=\"%s\" type=\"",qPrint(inc.file()));
204 switch(inc.type())
205 {
206 case DocInclude::Include: printf("include"); break;
207 case DocInclude::IncWithLines: printf("incwithlines"); break;
208 case DocInclude::DontInclude: printf("dontinclude"); break;
209 case DocInclude::DontIncWithLines: printf("dontinwithlines"); break;
211 printf("htmlinclude");
212 if (inc.isBlock()) printf(" block=\"yes\"");
213 break;
214 case DocInclude::LatexInclude: printf("latexinclude"); break;
215 case DocInclude::RtfInclude: printf("rtfinclude"); break;
216 case DocInclude::DocbookInclude: printf("docbookinclude"); break;
217 case DocInclude::ManInclude: printf("maninclude"); break;
218 case DocInclude::XmlInclude: printf("xmlinclude"); break;
219 case DocInclude::VerbInclude: printf("verbinclude"); break;
220 case DocInclude::Snippet: printf("snippet"); break;
221 case DocInclude::SnippetWithLines: printf("snipwithlines"); break;
222 }
223 printf("\"/>");
224 }
bool isBlock() const
Definition docnode.h:454
@ LatexInclude
Definition docnode.h:433
@ SnippetWithLines
Definition docnode.h:434
@ DontIncWithLines
Definition docnode.h:435
@ IncWithLines
Definition docnode.h:434
@ HtmlInclude
Definition docnode.h:433
@ VerbInclude
Definition docnode.h:433
@ DontInclude
Definition docnode.h:433
@ DocbookInclude
Definition docnode.h:435
Type type() const
Definition docnode.h:447
QCString file() const
Definition docnode.h:445

References DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, DocInclude::file(), DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, indent_leaf(), DocInclude::isBlock(), DocInclude::LatexInclude, DocInclude::ManInclude, qPrint(), DocInclude::RtfInclude, DocInclude::Snippet, DocInclude::SnippetWithLines, DocInclude::type(), DocInclude::VerbInclude, and DocInclude::XmlInclude.

◆ operator()() [26/58]

void PrintDocVisitor::operator() ( const DocIncOperator & op)
inline

Definition at line 225 of file printdocvisitor.h.

226 {
227 indent_leaf();
228 printf("<incoperator pattern=\"%s\" type=\"",qPrint(op.pattern()));
229 switch(op.type())
230 {
231 case DocIncOperator::Line: printf("line"); break;
232 case DocIncOperator::Skip: printf("skip"); break;
233 case DocIncOperator::SkipLine: printf("skipline"); break;
234 case DocIncOperator::Until: printf("until"); break;
235 }
236 printf("\"/>");
237 }
Type type() const
Definition docnode.h:481
QCString pattern() const
Definition docnode.h:496

References indent_leaf(), DocIncOperator::Line, DocIncOperator::pattern(), qPrint(), DocIncOperator::Skip, DocIncOperator::SkipLine, DocIncOperator::type(), and DocIncOperator::Until.

◆ operator()() [27/58]

void PrintDocVisitor::operator() ( const DocIndexEntry & i)
inline

Definition at line 243 of file printdocvisitor.h.

244 {
245 indent_leaf();
246 printf("<indexentry>%s</indexentry\n",qPrint(i.entry()));
247 }
QCString entry() const
Definition docnode.h:555

References DocIndexEntry::entry(), indent_leaf(), and qPrint().

◆ operator()() [28/58]

void PrintDocVisitor::operator() ( const DocInternal & i)
inline

Definition at line 511 of file printdocvisitor.h.

512 {
513 indent_pre();
514 printf("<internal>\n");
515 visitChildren(i);
516 indent_post();
517 printf("</internal>\n");
518 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [29/58]

void PrintDocVisitor::operator() ( const DocInternalRef & r)
inline

Definition at line 697 of file printdocvisitor.h.

698 {
699 indent_pre();
700 printf("<internalref file=%s anchor=%s>\n",qPrint(r.file()),qPrint(r.anchor()));
701 visitChildren(r);
702 indent_post();
703 printf("</internalref>\n");
704 }
QCString file() const
Definition docnode.h:806
QCString anchor() const
Definition docnode.h:808

References DocInternalRef::anchor(), DocInternalRef::file(), indent_post(), indent_pre(), qPrint(), and visitChildren().

◆ operator()() [30/58]

void PrintDocVisitor::operator() ( const DocLineBreak & )
inline

Definition at line 87 of file printdocvisitor.h.

88 {
90 printf("<br/>");
91 }

References indent_leaf().

◆ operator()() [31/58]

void PrintDocVisitor::operator() ( const DocLink & lnk)
inline

Definition at line 615 of file printdocvisitor.h.

616 {
617 indent_pre();
618 printf("<link ref=\"%s\" file=\"%s\" anchor=\"%s\">\n",
619 qPrint(lnk.ref()),qPrint(lnk.file()),qPrint(lnk.anchor()));
620 visitChildren(lnk);
621 indent_post();
622 printf("</link>\n");
623 }

References DocLink::anchor(), DocLink::file(), indent_post(), indent_pre(), qPrint(), DocLink::ref(), and visitChildren().

◆ operator()() [32/58]

void PrintDocVisitor::operator() ( const DocLinkedWord & w)
inline

Definition at line 39 of file printdocvisitor.h.

40 {
42 printf("%s",qPrint(w.word()));
43 }
QCString word() const
Definition docnode.h:169

References indent_leaf(), qPrint(), and DocLinkedWord::word().

◆ operator()() [33/58]

void PrintDocVisitor::operator() ( const DocMscFile & df)
inline

Definition at line 591 of file printdocvisitor.h.

592 {
593 indent_pre();
594 printf("<mscfile src=\"%s\">\n",qPrint(df.name()));
595 visitChildren(df);
596 indent_post();
597 printf("</mscfile>\n");
598 }

References indent_post(), indent_pre(), DocDiagramFileBase::name(), qPrint(), and visitChildren().

◆ operator()() [34/58]

void PrintDocVisitor::operator() ( const DocPara & p)
inline

Definition at line 320 of file printdocvisitor.h.

321 {
322 indent_pre();
323 printf("<para>\n");
324 visitChildren(p);
325 indent_post();
326 printf("</para>\n");
327 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [35/58]

void PrintDocVisitor::operator() ( const DocParamList & pl)
inline

Definition at line 654 of file printdocvisitor.h.

655 {
656 indent_pre();
657 printf("<parameters>");
658 if (!pl.parameters().empty())
659 {
660 printf("<param>");
661 for (const auto &param : pl.parameters())
662 {
663 std::visit(*this,param);
664 }
665 printf("</param>");
666 }
667 printf("\n");
668 indent_post();
669 printf("</parameters>\n");
670 }
const DocNodeList & parameters() const
Definition docnode.h:1124
bool empty() const
checks whether the container is empty
Definition growvector.h:140

References GrowVector< T >::empty(), indent_post(), indent_pre(), and DocParamList::parameters().

◆ operator()() [36/58]

void PrintDocVisitor::operator() ( const DocParamSect & ps)
inline

Definition at line 671 of file printdocvisitor.h.

672 {
673 indent_pre();
674 printf("<paramsect type=");
675 switch (ps.type())
676 {
677 case DocParamSect::Param: printf("param"); break;
678 case DocParamSect::RetVal: printf("retval"); break;
679 case DocParamSect::Exception: printf("exception"); break;
680 case DocParamSect::TemplateParam: printf("templateparam"); break;
681 case DocParamSect::Unknown: printf("unknown"); break;
682 }
683 printf(">\n");
684 visitChildren(ps);
685 indent_post();
686 printf("</paramsect>\n");
687 }
Type type() const
Definition docnode.h:1063

References DocParamSect::Exception, indent_post(), indent_pre(), DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, DocParamSect::type(), DocParamSect::Unknown, and visitChildren().

◆ operator()() [37/58]

void PrintDocVisitor::operator() ( const DocParBlock & pb)
inline

Definition at line 729 of file printdocvisitor.h.

730 {
731 indent_pre();
732 printf("<parblock>\n");
733 visitChildren(pb);
734 indent_post();
735 printf("</parblock>\n");
736 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [38/58]

void PrintDocVisitor::operator() ( const DocPlantUmlFile & df)
inline

Definition at line 607 of file printdocvisitor.h.

608 {
609 indent_pre();
610 printf("<plantumlfile src=\"%s\">\n",qPrint(df.name()));
611 visitChildren(df);
612 indent_post();
613 printf("</plantumlfile>\n");
614 }

References indent_post(), indent_pre(), DocDiagramFileBase::name(), qPrint(), and visitChildren().

◆ operator()() [39/58]

void PrintDocVisitor::operator() ( const DocRef & ref)
inline

Definition at line 624 of file printdocvisitor.h.

625 {
626 indent_pre();
627 printf("<ref ref=\"%s\" file=\"%s\" "
628 "anchor=\"%s\" targetTitle=\"%s\""
629 " hasLinkText=\"%s\" refToAnchor=\"%s\" refToSection=\"%s\" refToTable=\"%s\">\n",
630 qPrint(ref.ref()),qPrint(ref.file()),qPrint(ref.anchor()),
631 qPrint(ref.targetTitle()),ref.hasLinkText()?"yes":"no",
632 ref.refToAnchor()?"yes":"no", ref.refToSection()?"yes":"no",
633 ref.refToTable()?"yes":"no");
634 visitChildren(ref);
635 indent_post();
636 printf("</ref>\n");
637 }
QCString anchor() const
Definition docnode.h:780
QCString targetTitle() const
Definition docnode.h:781
bool refToTable() const
Definition docnode.h:786
QCString file() const
Definition docnode.h:777
bool refToAnchor() const
Definition docnode.h:784
QCString ref() const
Definition docnode.h:779
bool refToSection() const
Definition docnode.h:785
bool hasLinkText() const
Definition docnode.h:783

References DocRef::anchor(), DocRef::file(), DocRef::hasLinkText(), indent_post(), indent_pre(), qPrint(), DocRef::ref(), DocRef::refToAnchor(), DocRef::refToSection(), DocRef::refToTable(), DocRef::targetTitle(), and visitChildren().

◆ operator()() [40/58]

void PrintDocVisitor::operator() ( const DocRoot & r)
inline

Definition at line 328 of file printdocvisitor.h.

329 {
330 indent_pre();
331 printf("<root>\n");
332 visitChildren(r);
333 indent_post();
334 printf("</root>\n");
335 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [41/58]

void PrintDocVisitor::operator() ( const DocSecRefItem & ref)
inline

Definition at line 638 of file printdocvisitor.h.

639 {
640 indent_pre();
641 printf("<secrefitem target=\"%s\">\n",qPrint(ref.target()));
642 visitChildren(ref);
643 indent_post();
644 printf("</secrefitem>\n");
645 }
QCString target() const
Definition docnode.h:933

References indent_post(), indent_pre(), qPrint(), DocSecRefItem::target(), and visitChildren().

◆ operator()() [42/58]

void PrintDocVisitor::operator() ( const DocSecRefList & rl)
inline

Definition at line 646 of file printdocvisitor.h.

647 {
648 indent_pre();
649 printf("<secreflist>\n");
650 visitChildren(rl);
651 indent_post();
652 printf("</secreflist>\n");
653 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [43/58]

void PrintDocVisitor::operator() ( const DocSection & s)
inline

Definition at line 398 of file printdocvisitor.h.

399 {
400 indent_pre();
401 printf("<sect%d>\n",s.level());
402 if (s.title())
403 {
404 std::visit(*this, *s.title());
405 }
406 visitChildren(s);
407 indent_post();
408 printf("</sect%d>\n",s.level());
409 }
int level() const
Definition docnode.h:913
const DocNodeVariant * title() const
Definition docnode.h:914

References indent_post(), indent_pre(), DocSection::level(), DocSection::title(), and visitChildren().

◆ operator()() [44/58]

void PrintDocVisitor::operator() ( const DocSeparator & )
inline

Definition at line 262 of file printdocvisitor.h.

263 {
264 indent_leaf();
265 printf("<sep/>");
266 }

References indent_leaf().

◆ operator()() [45/58]

void PrintDocVisitor::operator() ( const DocSimpleList & l)
inline

Definition at line 379 of file printdocvisitor.h.

380 {
381 indent_pre();
382 printf("<ul>\n");
383 visitChildren(l);
384 indent_post();
385 printf("</ul>\n");
386 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [46/58]

void PrintDocVisitor::operator() ( const DocSimpleListItem & li)
inline

Definition at line 387 of file printdocvisitor.h.

388 {
389 indent_pre();
390 printf("<li>\n");
391 if (li.paragraph())
392 {
393 visit(*this,*li.paragraph());
394 }
395 indent_post();
396 printf("</li>\n");
397 }
const DocNodeVariant * paragraph() const
Definition docnode.h:1152

References indent_post(), indent_pre(), and DocSimpleListItem::paragraph().

◆ operator()() [47/58]

void PrintDocVisitor::operator() ( const DocSimpleSect & s)
inline

Definition at line 336 of file printdocvisitor.h.

337 {
338 indent_pre();
339 printf("<simplesect type=");
340 switch(s.type())
341 {
342 case DocSimpleSect::See: printf("see"); break;
343 case DocSimpleSect::Return: printf("return"); break;
344 case DocSimpleSect::Author: printf("author"); break;
345 case DocSimpleSect::Authors: printf("authors"); break;
346 case DocSimpleSect::Version: printf("version"); break;
347 case DocSimpleSect::Since: printf("since"); break;
348 case DocSimpleSect::Date: printf("date"); break;
349 case DocSimpleSect::Note: printf("note"); break;
350 case DocSimpleSect::Warning: printf("warning"); break;
351 case DocSimpleSect::Pre: printf("pre"); break;
352 case DocSimpleSect::Post: printf("post"); break;
353 case DocSimpleSect::Copyright: printf("copyright"); break;
354 case DocSimpleSect::Invar: printf("invar"); break;
355 case DocSimpleSect::Remark: printf("remark"); break;
356 case DocSimpleSect::Attention: printf("attention"); break;
357 case DocSimpleSect::Important: printf("important"); break;
358 case DocSimpleSect::User: printf("user"); break;
359 case DocSimpleSect::Rcs: printf("rcs"); break;
360 case DocSimpleSect::Unknown: printf("unknown"); break;
361 }
362 printf(">\n");
363 if (s.title())
364 {
365 std::visit(*this, *s.title());
366 }
367 visitChildren(s);
368 indent_post();
369 printf("</simplesect>\n");
370 }
Type type() const
Definition docnode.h:1021
const DocNodeVariant * title() const
Definition docnode.h:1028

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, DocSimpleSect::Important, indent_post(), indent_pre(), DocSimpleSect::Invar, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, DocSimpleSect::title(), DocSimpleSect::type(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren(), and DocSimpleSect::Warning.

◆ operator()() [48/58]

void PrintDocVisitor::operator() ( const DocSimpleSectSep & )
inline

Definition at line 248 of file printdocvisitor.h.

249 {
250 indent_leaf();
251 printf("<simplesectsep/>");
252 }

References indent_leaf().

◆ operator()() [49/58]

void PrintDocVisitor::operator() ( const DocStyleChange & s)
inline

Definition at line 97 of file printdocvisitor.h.

98 {
100 switch (s.style())
101 {
103 if (s.enable()) printf("<bold>"); else printf("</bold>");
104 break;
106 if (s.enable()) printf("<s>"); else printf("</s>");
107 break;
109 if (s.enable()) printf("<strike>"); else printf("</strike>");
110 break;
112 if (s.enable()) printf("<del>"); else printf("</del>");
113 break;
115 if (s.enable()) printf("<underline>"); else printf("</underline>");
116 break;
118 if (s.enable()) printf("<ins>"); else printf("</ins>");
119 break;
121 if (s.enable()) printf("<italic>"); else printf("</italic>");
122 break;
124 if (s.enable()) printf("<kbd>"); else printf("</kbd>");
125 break;
127 if (s.enable()) printf("<tt>"); else printf("</tt>");
128 break;
130 if (s.enable()) printf("<code>"); else printf("</code>");
131 break;
133 if (s.enable()) printf("<sub>"); else printf("</sub>");
134 break;
136 if (s.enable()) printf("<sup>"); else printf("</sup>");
137 break;
139 if (s.enable()) printf("<center>"); else printf("</center>");
140 break;
142 if (s.enable()) printf("<small>"); else printf("</small>");
143 break;
145 if (s.enable()) printf("<cite>"); else printf("</cite>");
146 break;
148 if (s.enable()) printf("<pre>"); else printf("</pre>");
149 break;
151 if (s.enable()) printf("<div>"); else printf("</div>");
152 break;
154 if (s.enable()) printf("<span>"); else printf("</span>");
155 break;
156 }
157 }
Style style() const
Definition docnode.h:303
bool enable() const
Definition docnode.h:305

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), indent_leaf(), DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, DocStyleChange::Preformatted, DocStyleChange::S, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::Strike, DocStyleChange::style(), DocStyleChange::Subscript, DocStyleChange::Superscript, DocStyleChange::Typewriter, and DocStyleChange::Underline.

◆ operator()() [50/58]

void PrintDocVisitor::operator() ( const DocSymbol & s)
inline

Definition at line 56 of file printdocvisitor.h.

57 {
59 const char *res = HtmlEntityMapper::instance().utf8(s.symbol(),TRUE);
60 if (res)
61 {
62 printf("%s",res);
63 }
64 else
65 {
66 printf("print: non supported HTML-entity found: %s\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));
67 }
68 }
HtmlEntityMapper::SymType symbol() const
Definition docnode.h:328
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
const char * utf8(SymType symb, bool useInPrintf=FALSE) const
Access routine to the UTF8 code of the HTML entity.

References indent_leaf(), HtmlEntityMapper::instance(), DocSymbol::symbol(), TRUE, and HtmlEntityMapper::utf8().

◆ operator()() [51/58]

void PrintDocVisitor::operator() ( const DocText & t)
inline

Definition at line 705 of file printdocvisitor.h.

706 {
707 indent_pre();
708 printf("<text>\n");
709 visitChildren(t);
710 indent_post();
711 printf("</text>\n");
712 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [52/58]

void PrintDocVisitor::operator() ( const DocTitle & t)
inline

Definition at line 371 of file printdocvisitor.h.

372 {
373 indent_pre();
374 printf("<title>\n");
375 visitChildren(t);
376 indent_post();
377 printf("</title>\n");
378 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [53/58]

void PrintDocVisitor::operator() ( const DocURL & u)
inline

Definition at line 82 of file printdocvisitor.h.

83 {
85 printf("%s",qPrint(u.url()));
86 }
QCString url() const
Definition docnode.h:191

References indent_leaf(), qPrint(), and DocURL::url().

◆ operator()() [54/58]

void PrintDocVisitor::operator() ( const DocVerbatim & s)
inline

Definition at line 158 of file printdocvisitor.h.

159 {
160 indent_leaf();
161 switch(s.type())
162 {
163 case DocVerbatim::Code: printf("<code>"); break;
164 case DocVerbatim::Verbatim: printf("<verbatim>"); break;
165 case DocVerbatim::JavaDocLiteral: printf("<javadocliteral>"); break;
166 case DocVerbatim::JavaDocCode: printf("<javadoccode>"); break;
167 case DocVerbatim::HtmlOnly: printf("<htmlonly>"); break;
168 case DocVerbatim::RtfOnly: printf("<rtfonly>"); break;
169 case DocVerbatim::ManOnly: printf("<manonly>"); break;
170 case DocVerbatim::LatexOnly: printf("<latexonly>"); break;
171 case DocVerbatim::XmlOnly: printf("<xmlonly>"); break;
172 case DocVerbatim::DocbookOnly: printf("<docbookonly>"); break;
173 case DocVerbatim::Dot: printf("<dot>"); break;
174 case DocVerbatim::Msc: printf("<msc>"); break;
175 case DocVerbatim::PlantUML: printf("<plantuml>"); break;
176 }
177 printf("%s",qPrint(s.text()));
178 switch(s.type())
179 {
180 case DocVerbatim::Code: printf("</code>"); break;
181 case DocVerbatim::Verbatim: printf("</verbatim>"); break;
182 case DocVerbatim::JavaDocLiteral: printf("</javadocliteral>"); break;
183 case DocVerbatim::JavaDocCode: printf("</javadoccode>"); break;
184 case DocVerbatim::HtmlOnly: printf("</htmlonly>"); break;
185 case DocVerbatim::RtfOnly: printf("</rtfonly>"); break;
186 case DocVerbatim::ManOnly: printf("</manonly>"); break;
187 case DocVerbatim::LatexOnly: printf("</latexonly>"); break;
188 case DocVerbatim::XmlOnly: printf("</xmlonly>"); break;
189 case DocVerbatim::DocbookOnly: printf("</docbookonly>"); break;
190 case DocVerbatim::Dot: printf("</dot>"); break;
191 case DocVerbatim::Msc: printf("</msc>"); break;
192 case DocVerbatim::PlantUML: printf("</plantuml>"); break;
193 }
194 }
Type type() const
Definition docnode.h:378
QCString text() const
Definition docnode.h:379
@ JavaDocLiteral
Definition docnode.h:374

References DocVerbatim::Code, DocVerbatim::DocbookOnly, DocVerbatim::Dot, DocVerbatim::HtmlOnly, indent_leaf(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::LatexOnly, DocVerbatim::ManOnly, DocVerbatim::Msc, DocVerbatim::PlantUML, qPrint(), DocVerbatim::RtfOnly, DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, and DocVerbatim::XmlOnly.

◆ operator()() [55/58]

void PrintDocVisitor::operator() ( const DocVhdlFlow & vf)
inline

Definition at line 721 of file printdocvisitor.h.

722 {
723 indent_pre();
724 printf("<vhdlflow>\n");
725 visitChildren(vf);
726 indent_post();
727 printf("</vhdlflow>\n");
728 }

References indent_post(), indent_pre(), and visitChildren().

◆ operator()() [56/58]

void PrintDocVisitor::operator() ( const DocWhiteSpace & w)
inline

Definition at line 44 of file printdocvisitor.h.

45 {
47 if (m_insidePre)
48 {
49 printf("%s",qPrint(w.chars()));
50 }
51 else
52 {
53 printf(" ");
54 }
55 }
QCString chars() const
Definition docnode.h:354

References DocWhiteSpace::chars(), indent_leaf(), m_insidePre, and qPrint().

◆ operator()() [57/58]

void PrintDocVisitor::operator() ( const DocWord & w)
inline

Definition at line 34 of file printdocvisitor.h.

35 {
37 printf("%s",qPrint(w.word()));
38 }
QCString word() const
Definition docnode.h:155

References indent_leaf(), qPrint(), and DocWord::word().

◆ operator()() [58/58]

void PrintDocVisitor::operator() ( const DocXRefItem & x)
inline

Definition at line 688 of file printdocvisitor.h.

689 {
690 indent_pre();
691 printf("<xrefitem file=\"%s\" anchor=\"%s\" title=\"%s\">\n",
692 qPrint(x.file()),qPrint(x.anchor()),qPrint(x.title()));
693 visitChildren(x);
694 indent_post();
695 printf("</xrefitem>\n");
696 }
QCString anchor() const
Definition docnode.h:620
QCString file() const
Definition docnode.h:619
QCString title() const
Definition docnode.h:621

References DocXRefItem::anchor(), DocXRefItem::file(), indent_post(), indent_pre(), qPrint(), DocXRefItem::title(), and visitChildren().

◆ visitChildren()

Member Data Documentation

◆ m_indent

int PrintDocVisitor::m_indent
private

Definition at line 763 of file printdocvisitor.h.

Referenced by indent(), indent_post(), indent_pre(), and PrintDocVisitor().

◆ m_insidePre

bool PrintDocVisitor::m_insidePre
private

Definition at line 765 of file printdocvisitor.h.

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

◆ m_needsEnter

bool PrintDocVisitor::m_needsEnter
private

Definition at line 764 of file printdocvisitor.h.

Referenced by indent(), indent_leaf(), and PrintDocVisitor().


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