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 DocMermaidFile &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 28 of file printdocvisitor.h.

Constructor & Destructor Documentation

PrintDocVisitor()

PrintDocVisitor::PrintDocVisitor ( )

inline

Definition at line 31 of file printdocvisitor.h.

: m_indent(0), m_needsEnter(FALSE), m_insidePre(FALSE) {}

References FALSE, m_indent, m_insidePre, and m_needsEnter.

Member Function Documentation

indent()

void PrintDocVisitor::indent ( )

inlineprivate

Definition at line 763 of file printdocvisitor.h.

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

References FALSE, m_indent, and m_needsEnter.

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

indent_leaf()

void PrintDocVisitor::indent_leaf ( )

inlineprivate

Definition at line 769 of file printdocvisitor.h.

    {
      if (!m_needsEnter) indent();
      m_needsEnter=TRUE;
    }

References indent(), m_needsEnter, and TRUE.

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

indent_post()

void PrintDocVisitor::indent_post ( )

inlineprivate

Definition at line 779 of file printdocvisitor.h.

    {
      m_indent--;
      indent();
    }

References indent(), and m_indent.

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()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), and operator()().

indent_pre()

void PrintDocVisitor::indent_pre ( )

inlineprivate

Definition at line 774 of file printdocvisitor.h.

    {
      indent();
      m_indent++;
    }

References indent(), and m_indent.

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()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), and operator()().

operator()() [1/59]

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

inline

Definition at line 198 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<anchor name=\"%s\"/>",qPrint(a.anchor()));
    }

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

operator()() [2/59]

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

inline

Definition at line 293 of file printdocvisitor.h.

    {
      indent_pre();
      if (l.isEnumList())
      {
        printf("<ol>\n");
      }
      else
      {
        printf("<ul>\n");
      }
      visitChildren(l);
      indent_post();
      if (l.isEnumList())
      {
        printf("</ol>\n");
      }
      else
      {
        printf("</ul>\n");
      }
    }

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

operator()() [3/59]

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

inline

Definition at line 315 of file printdocvisitor.h.

    {
      indent_pre();
      switch (li.itemNumber())
      {
        case DocAutoList::Unchecked: // unchecked
          printf("<li class=\"unchecked\">\n");
          break;
        case DocAutoList::Checked_x: // checked with x
        case DocAutoList::Checked_X: // checked with X
          printf("<li class=\"checked\">\n");
          break;
        default:
          printf("<li>\n");
          break;
      }
      visitChildren(li);
      indent_post();
      printf("</li>\n");
    }

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

operator()() [4/59]

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

inline

Definition at line 256 of file printdocvisitor.h.

    {
      indent_leaf();
      auto opt = cite.option();
      QCString txt;
      if (!cite.file().isEmpty())
      {
        txt = cite.getText();
      }
      else
      {
        if (!opt.noPar()) txt += "[";
        txt += cite.target();
        if (!opt.noPar()) txt += "]";
      }
      printf("<cite ref=\"%s\" file=\"%s\" "
             "anchor=\"%s\" text=\"%s\""
             "/>\n",
             qPrint(cite.ref()),qPrint(cite.file()),qPrint(cite.anchor()),
             qPrint(txt));
    }

References DocCite::anchor(), DocCite::file(), DocCite::getText(), indent_leaf(), QCString::isEmpty(), DocCite::option(), qPrint(), DocCite::ref(), and DocCite::target().

operator()() [5/59]

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

inline

Definition at line 614 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<diafile src=\"%s\">\n",qPrint(df.name()));
      visitChildren(df);
      indent_post();
      printf("</diafile>\n");
    }

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

operator()() [6/59]

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

inline

Definition at line 598 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<dotfile src=\"%s\">\n",qPrint(df.name()));
      visitChildren(df);
      indent_post();
      printf("</dotfile>\n");
    }

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

operator()() [7/59]

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

inline

Definition at line 70 of file printdocvisitor.h.

    {
      indent_leaf();
      const char *res = EmojiEntityMapper::instance().name(s.index());
      if (res)
      {
        printf("%s",res);
      }
      else
      {
        printf("print: non supported emoji found: %s\n",qPrint(s.name()));
      }
    }

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

operator()() [8/59]

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

inline

Definition at line 241 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<formula name=%s text=%s/>",qPrint(f.name()),qPrint(f.text()));
    }

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

operator()() [9/59]

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

inline

Definition at line 93 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<hr>");
    }

References indent_leaf().

operator()() [10/59]

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

inline

Definition at line 534 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<a url=\"%s\">\n",qPrint(href.url()));
      visitChildren(href);
      indent_post();
      printf("</a>\n");
    }

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

operator()() [11/59]

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

inline

Definition at line 736 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<blockquote>\n");
      visitChildren(q);
      indent_post();
      printf("</blockquote>\n");
    }

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

operator()() [12/59]

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

inline

Definition at line 518 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<caption>\n");
      visitChildren(c);
      indent_post();
      printf("</caption>\n");
    }

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

operator()() [13/59]

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

inline

Definition at line 510 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<t%c>\n",c.isHeading()?'h':'d');
      visitChildren(c);
      indent_post();
      printf("</t%c>\n",c.isHeading()?'h':'d');
    }

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

operator()() [14/59]

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

inline

Definition at line 481 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<dd>\n");
      visitChildren(dd);
      indent_post();
      printf("</dd>\n");
    }

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

operator()() [15/59]

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

inline

Definition at line 465 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<dl>\n");
      visitChildren(l);
      indent_post();
      printf("</dl>\n");
    }

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

operator()() [16/59]

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

inline

Definition at line 473 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<dt>\n");
      visitChildren(dt);
      indent_post();
      printf("</dt>\n");
    }

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

operator()() [17/59]

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

inline

Definition at line 555 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<details");
      for (const auto &opt : details.attribs())
      {
        printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
      }
      printf(">\n");
      auto summary = details.summary();
      if (summary)
      {
        std::visit(*this,*summary);
      }
      visitChildren(details);
      indent_post();
      printf("</details>\n");
    }

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

operator()() [18/59]

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

inline

Definition at line 573 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<h%d>\n",header.level());
      visitChildren(header);
      indent_post();
      printf("</h%d>\n",header.level());
    }

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

operator()() [19/59]

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

inline

Definition at line 425 of file printdocvisitor.h.

    {
      indent_pre();
      if (s.type()==DocHtmlList::Ordered)
      {
        printf("<ol");
        for (const auto &opt : s.attribs())
        {
          printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
        }
        printf(">\n");
      }
      else
      {
        printf("<ul>\n");
      }
      visitChildren(s);
      indent_post();
      if (s.type()==DocHtmlList::Ordered)
      {
        printf("</ol>\n");
      }
      else
      {
        printf("</ul>\n");
      }
    }

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

operator()() [20/59]

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

inline

Definition at line 452 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<li");
      for (const auto &opt : li.attribs())
      {
        printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
      }
      printf(">\n");
      visitChildren(li);
      indent_post();
      printf("</li>\n");
    }

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

operator()() [21/59]

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

inline

Definition at line 502 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<tr>\n");
      visitChildren(tr);
      indent_post();
      printf("</tr>\n");
    }

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

operator()() [22/59]

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

inline

Definition at line 542 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<summary");
      for (const auto &opt : summary.attribs())
      {
        printf(" %s=\"%s\"",qPrint(opt.name),qPrint(opt.value));
      }
      printf(">\n");
      visitChildren(summary);
      indent_post();
      printf("</summary>\n");
    }

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

operator()() [23/59]

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

inline

Definition at line 489 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<table rows=\"%zu\" cols=\"%zu\">\n",
          t.numRows(),t.numColumns());
      visitChildren(t);
      if (t.caption())
      {
        std::visit(*this, *t.caption());
      }
      indent_post();
      printf("</table>\n");
    }

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

operator()() [24/59]

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

inline

Definition at line 581 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<image src=\"%s\" type=\"",qPrint(img.name()));
      switch(img.type())
      {
        case DocImage::Html:    printf("html"); break;
        case DocImage::Latex:   printf("latex"); break;
        case DocImage::Rtf:     printf("rtf"); break;
        case DocImage::DocBook: printf("docbook"); break;
        case DocImage::Xml:     printf("xml"); break;
      }
      printf("\" %s %s inline=\"%s\">\n",qPrint(img.width()),qPrint(img.height()),img.isInlineImage() ? "yes" : "no");
      visitChildren(img);
      indent_post();
      printf("</image>\n");
    }

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/59]

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

inline

Definition at line 203 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<include file=\"%s\" type=\"",qPrint(inc.file()));
      switch(inc.type())
      {
        case DocInclude::Include: printf("include"); break;
        case DocInclude::IncWithLines: printf("incwithlines"); break;
        case DocInclude::DontInclude: printf("dontinclude"); break;
        case DocInclude::DontIncWithLines: printf("dontinwithlines"); break;
        case DocInclude::HtmlInclude:
               printf("htmlinclude");
               if (inc.isBlock()) printf(" block=\"yes\"");
               break;
        case DocInclude::LatexInclude: printf("latexinclude"); break;
        case DocInclude::RtfInclude: printf("rtfinclude"); break;
        case DocInclude::DocbookInclude: printf("docbookinclude"); break;
        case DocInclude::ManInclude: printf("maninclude"); break;
        case DocInclude::XmlInclude: printf("xmlinclude"); break;
        case DocInclude::VerbInclude: printf("verbinclude"); break;
        case DocInclude::Snippet: printf("snippet"); break;
        case DocInclude::SnippetWithLines: printf("snipwithlines"); break;
      }
      printf("\"/>");
    }

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/59]

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

inline

Definition at line 228 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<incoperator pattern=\"%s\" type=\"",qPrint(op.pattern()));
      switch(op.type())
      {
        case DocIncOperator::Line:     printf("line");     break;
        case DocIncOperator::Skip:     printf("skip");     break;
        case DocIncOperator::SkipLine: printf("skipline"); break;
        case DocIncOperator::Until:    printf("until");    break;
      }
      printf("\"/>");
    }

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

operator()() [27/59]

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

inline

Definition at line 246 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<indexentry>%s</indexentry\n",qPrint(i.entry()));
    }

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

operator()() [28/59]

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

inline

Definition at line 526 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<internal>\n");
      visitChildren(i);
      indent_post();
      printf("</internal>\n");
    }

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

operator()() [29/59]

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

inline

Definition at line 720 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<internalref file=%s anchor=%s>\n",qPrint(r.file()),qPrint(r.anchor()));
      visitChildren(r);
      indent_post();
      printf("</internalref>\n");
    }

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

operator()() [30/59]

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

inline

Definition at line 88 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<br/>");
    }

References indent_leaf().

operator()() [31/59]

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

inline

Definition at line 638 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<link ref=\"%s\" file=\"%s\" anchor=\"%s\">\n",
          qPrint(lnk.ref()),qPrint(lnk.file()),qPrint(lnk.anchor()));
      visitChildren(lnk);
      indent_post();
      printf("</link>\n");
    }

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

operator()() [32/59]

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

inline

Definition at line 40 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("%s",qPrint(w.word()));
    }

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

operator()() [33/59]

void PrintDocVisitor::operator() ( const DocMermaidFile & df )

inline

Definition at line 630 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<mermaidfile src=\"%s\">\n",qPrint(df.name()));
      visitChildren(df);
      indent_post();
      printf("</mermaidfile>\n");
    }

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

operator()() [34/59]

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

inline

Definition at line 606 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<mscfile src=\"%s\">\n",qPrint(df.name()));
      visitChildren(df);
      indent_post();
      printf("</mscfile>\n");
    }

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

operator()() [35/59]

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

inline

Definition at line 335 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<para>\n");
      visitChildren(p);
      indent_post();
      printf("</para>\n");
    }

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

operator()() [36/59]

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

inline

Definition at line 677 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<parameters>");
      if (!pl.parameters().empty())
      {
        printf("<param>");
        for (const auto &param : pl.parameters())
        {
          std::visit(*this,param);
        }
        printf("</param>");
      }
      printf("\n");
      indent_post();
      printf("</parameters>\n");
    }

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

operator()() [37/59]

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

inline

Definition at line 694 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<paramsect type=");
      switch (ps.type())
      {
        case DocParamSect::Param: printf("param"); break;
        case DocParamSect::RetVal: printf("retval"); break;
        case DocParamSect::Exception: printf("exception"); break;
        case DocParamSect::TemplateParam: printf("templateparam"); break;
        case DocParamSect::Unknown: printf("unknown"); break;
      }
      printf(">\n");
      visitChildren(ps);
      indent_post();
      printf("</paramsect>\n");
    }

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

operator()() [38/59]

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

inline

Definition at line 752 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<parblock>\n");
      visitChildren(pb);
      indent_post();
      printf("</parblock>\n");
    }

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

operator()() [39/59]

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

inline

Definition at line 622 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<plantumlfile src=\"%s\">\n",qPrint(df.name()));
      visitChildren(df);
      indent_post();
      printf("</plantumlfile>\n");
    }

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

operator()() [40/59]

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

inline

Definition at line 647 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<ref ref=\"%s\" file=\"%s\" "
             "anchor=\"%s\" targetTitle=\"%s\""
             " hasLinkText=\"%s\" refToAnchor=\"%s\" refToSection=\"%s\" refToTable=\"%s\">\n",
             qPrint(ref.ref()),qPrint(ref.file()),qPrint(ref.anchor()),
             qPrint(ref.targetTitle()),ref.hasLinkText()?"yes":"no",
             ref.refToAnchor()?"yes":"no", ref.refToSection()?"yes":"no",
             ref.refToTable()?"yes":"no");
      visitChildren(ref);
      indent_post();
      printf("</ref>\n");
    }

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()() [41/59]

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

inline

Definition at line 343 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<root>\n");
      visitChildren(r);
      indent_post();
      printf("</root>\n");
    }

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

operator()() [42/59]

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

inline

Definition at line 661 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<secrefitem target=\"%s\">\n",qPrint(ref.target()));
      visitChildren(ref);
      indent_post();
      printf("</secrefitem>\n");
    }

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

operator()() [43/59]

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

inline

Definition at line 669 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<secreflist>\n");
      visitChildren(rl);
      indent_post();
      printf("</secreflist>\n");
    }

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

operator()() [44/59]

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

inline

Definition at line 413 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<sect%d>\n",s.level());
      if (s.title())
      {
        std::visit(*this, *s.title());
      }
      visitChildren(s);
      indent_post();
      printf("</sect%d>\n",s.level());
    }

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

operator()() [45/59]

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

inline

Definition at line 277 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<sep/>");
    }

References indent_leaf().

operator()() [46/59]

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

inline

Definition at line 394 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<ul>\n");
      visitChildren(l);
      indent_post();
      printf("</ul>\n");
    }

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

operator()() [47/59]

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

inline

Definition at line 402 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<li>\n");
      if (li.paragraph())
      {
        visit(*this,*li.paragraph());
      }
      indent_post();
      printf("</li>\n");
    }

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

operator()() [48/59]

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

inline

Definition at line 351 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<simplesect type=");
      switch(s.type())
      {
        case DocSimpleSect::See: printf("see"); break;
        case DocSimpleSect::Return: printf("return"); break;
        case DocSimpleSect::Author: printf("author"); break;
        case DocSimpleSect::Authors: printf("authors"); break;
        case DocSimpleSect::Version: printf("version"); break;
        case DocSimpleSect::Since: printf("since"); break;
        case DocSimpleSect::Date: printf("date"); break;
        case DocSimpleSect::Note: printf("note"); break;
        case DocSimpleSect::Warning: printf("warning"); break;
        case DocSimpleSect::Pre: printf("pre"); break;
        case DocSimpleSect::Post: printf("post"); break;
        case DocSimpleSect::Copyright: printf("copyright"); break;
        case DocSimpleSect::Invar: printf("invar"); break;
        case DocSimpleSect::Remark: printf("remark"); break;
        case DocSimpleSect::Attention: printf("attention"); break;
        case DocSimpleSect::Important: printf("important"); break;
        case DocSimpleSect::User: printf("user"); break;
        case DocSimpleSect::Rcs: printf("rcs"); break;
        case DocSimpleSect::Unknown: printf("unknown"); break;
      }
      printf(">\n");
      if (s.title())
      {
        std::visit(*this, *s.title());
      }
      visitChildren(s);
      indent_post();
      printf("</simplesect>\n");
    }

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()() [49/59]

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

inline

Definition at line 251 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("<simplesectsep/>");
    }

References indent_leaf().

operator()() [50/59]

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

inline

Definition at line 98 of file printdocvisitor.h.

    {
      indent_leaf();
      switch (s.style())
      {
        case DocStyleChange::Bold:
          if (s.enable()) printf("<bold>"); else printf("</bold>");
          break;
        case DocStyleChange::S:
          if (s.enable()) printf("<s>"); else printf("</s>");
          break;
        case DocStyleChange::Strike:
          if (s.enable()) printf("<strike>"); else printf("</strike>");
          break;
        case DocStyleChange::Del:
          if (s.enable()) printf("<del>"); else printf("</del>");
          break;
        case DocStyleChange::Underline:
          if (s.enable()) printf("<underline>"); else printf("</underline>");
          break;
        case DocStyleChange::Ins:
          if (s.enable()) printf("<ins>"); else printf("</ins>");
          break;
        case DocStyleChange::Italic:
          if (s.enable()) printf("<italic>"); else printf("</italic>");
          break;
        case DocStyleChange::Kbd:
          if (s.enable()) printf("<kbd>"); else printf("</kbd>");
          break;
        case DocStyleChange::Typewriter:
          if (s.enable()) printf("<tt>"); else printf("</tt>");
          break;
        case DocStyleChange::Code:
          if (s.enable()) printf("<code>"); else printf("</code>");
          break;
        case DocStyleChange::Subscript:
          if (s.enable()) printf("<sub>"); else printf("</sub>");
          break;
        case DocStyleChange::Superscript:
          if (s.enable()) printf("<sup>"); else printf("</sup>");
          break;
        case DocStyleChange::Center:
          if (s.enable()) printf("<center>"); else printf("</center>");
          break;
        case DocStyleChange::Small:
          if (s.enable()) printf("<small>"); else printf("</small>");
          break;
        case DocStyleChange::Cite:
          if (s.enable()) printf("<cite>"); else printf("</cite>");
          break;
        case DocStyleChange::Preformatted:
          if (s.enable()) printf("<pre>"); else printf("</pre>");
          break;
        case DocStyleChange::Div:
          if (s.enable()) printf("<div>"); else printf("</div>");
          break;
        case DocStyleChange::Span:
          if (s.enable()) printf("<span>"); else printf("</span>");
          break;
      }
    }

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()() [51/59]

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

inline

Definition at line 57 of file printdocvisitor.h.

    {
      indent_leaf();
      const char *res = HtmlEntityMapper::instance().utf8(s.symbol(),TRUE);
      if (res)
      {
        printf("%s",res);
      }
      else
      {
        printf("print: non supported HTML-entity found: %s\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));
      }
    }

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

operator()() [52/59]

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

inline

Definition at line 728 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<text>\n");
      visitChildren(t);
      indent_post();
      printf("</text>\n");
    }

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

operator()() [53/59]

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

inline

Definition at line 386 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<title>\n");
      visitChildren(t);
      indent_post();
      printf("</title>\n");
    }

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

operator()() [54/59]

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

inline

Definition at line 83 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("%s",qPrint(u.url()));
    }

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

operator()() [55/59]

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

inline

Definition at line 159 of file printdocvisitor.h.

    {
      indent_leaf();
      switch(s.type())
      {
        case DocVerbatim::Code: printf("<code>"); break;
        case DocVerbatim::Verbatim: printf("<verbatim>"); break;
        case DocVerbatim::JavaDocLiteral: printf("<javadocliteral>"); break;
        case DocVerbatim::JavaDocCode: printf("<javadoccode>"); break;
        case DocVerbatim::HtmlOnly: printf("<htmlonly>"); break;
        case DocVerbatim::RtfOnly: printf("<rtfonly>"); break;
        case DocVerbatim::ManOnly: printf("<manonly>"); break;
        case DocVerbatim::LatexOnly: printf("<latexonly>"); break;
        case DocVerbatim::XmlOnly: printf("<xmlonly>"); break;
        case DocVerbatim::DocbookOnly: printf("<docbookonly>"); break;
        case DocVerbatim::Dot: printf("<dot>"); break;
        case DocVerbatim::Msc: printf("<msc>"); break;
        case DocVerbatim::PlantUML: printf("<plantuml>"); break;
        case DocVerbatim::Mermaid: printf("<mermaid>"); break;
      }
      printf("%s",qPrint(s.text()));
      switch(s.type())
      {
        case DocVerbatim::Code: printf("</code>"); break;
        case DocVerbatim::Verbatim: printf("</verbatim>"); break;
        case DocVerbatim::JavaDocLiteral: printf("</javadocliteral>"); break;
        case DocVerbatim::JavaDocCode: printf("</javadoccode>"); break;
        case DocVerbatim::HtmlOnly: printf("</htmlonly>"); break;
        case DocVerbatim::RtfOnly: printf("</rtfonly>"); break;
        case DocVerbatim::ManOnly: printf("</manonly>"); break;
        case DocVerbatim::LatexOnly: printf("</latexonly>"); break;
        case DocVerbatim::XmlOnly: printf("</xmlonly>"); break;
        case DocVerbatim::DocbookOnly: printf("</docbookonly>"); break;
        case DocVerbatim::Dot: printf("</dot>"); break;
        case DocVerbatim::Msc: printf("</msc>"); break;
        case DocVerbatim::PlantUML: printf("</plantuml>"); break;
        case DocVerbatim::Mermaid: printf("</mermaid>"); break;
      }
    }

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

operator()() [56/59]

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

inline

Definition at line 744 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<vhdlflow>\n");
      visitChildren(vf);
      indent_post();
      printf("</vhdlflow>\n");
    }

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

operator()() [57/59]

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

inline

Definition at line 45 of file printdocvisitor.h.

    {
      indent_leaf();
      if (m_insidePre)
      {
        printf("%s",qPrint(w.chars()));
      }
      else
      {
        printf(" ");
      }
    }

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

operator()() [58/59]

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

inline

Definition at line 35 of file printdocvisitor.h.

    {
      indent_leaf();
      printf("%s",qPrint(w.word()));
    }

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

operator()() [59/59]

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

inline

Definition at line 711 of file printdocvisitor.h.

    {
      indent_pre();
      printf("<xrefitem file=\"%s\" anchor=\"%s\" title=\"%s\">\n",
          qPrint(x.file()),qPrint(x.anchor()),qPrint(x.title()));
      visitChildren(x);
      indent_post();
      printf("</xrefitem>\n");
    }

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

visitChildren()

template<class T>

void PrintDocVisitor::visitChildren ( const T & t )

inline

Definition at line 285 of file printdocvisitor.h.

    {
      for (const auto &child : t.children())
      {
        std::visit(*this, child);
      }
    }

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()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), and operator()().

Member Data Documentation

m_indent

int PrintDocVisitor::m_indent

private

Definition at line 786 of file printdocvisitor.h.

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

m_insidePre

bool PrintDocVisitor::m_insidePre

private

Definition at line 788 of file printdocvisitor.h.

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

m_needsEnter

bool PrintDocVisitor::m_needsEnter

private

Definition at line 787 of file printdocvisitor.h.

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

---

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

• src/printdocvisitor.h