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

Concrete visitor implementation for XML output. More...

#include <src/xmldocvisitor.h>

Inheritance diagram for XmlDocVisitor:
Collaboration diagram for XmlDocVisitor:

Public Member Functions

 XmlDocVisitor (TextStream &t, OutputCodeList &ci, const QCString &langExt)
void operator() (const DocWord &)
void operator() (const DocLinkedWord &)
void operator() (const DocWhiteSpace &)
void operator() (const DocSymbol &)
void operator() (const DocEmoji &)
void operator() (const DocURL &)
void operator() (const DocLineBreak &)
void operator() (const DocHorRuler &)
void operator() (const DocStyleChange &)
void operator() (const DocVerbatim &)
void operator() (const DocAnchor &)
void operator() (const DocInclude &)
void operator() (const DocIncOperator &)
void operator() (const DocFormula &)
void operator() (const DocIndexEntry &)
void operator() (const DocSimpleSectSep &)
void operator() (const DocCite &)
void operator() (const DocSeparator &)
void operator() (const DocAutoList &)
void operator() (const DocAutoListItem &)
void operator() (const DocPara &)
void operator() (const DocRoot &)
void operator() (const DocSimpleSect &)
void operator() (const DocTitle &)
void operator() (const DocSimpleList &)
void operator() (const DocSimpleListItem &)
void operator() (const DocSection &)
void operator() (const DocHtmlList &)
void operator() (const DocHtmlListItem &)
void operator() (const DocHtmlDescList &)
void operator() (const DocHtmlDescTitle &)
void operator() (const DocHtmlDescData &)
void operator() (const DocHtmlTable &)
void operator() (const DocHtmlRow &)
void operator() (const DocHtmlCell &)
void operator() (const DocHtmlCaption &)
void operator() (const DocInternal &)
void operator() (const DocHRef &)
void operator() (const DocHtmlSummary &)
void operator() (const DocHtmlDetails &)
void operator() (const DocHtmlHeader &)
void operator() (const DocImage &)
void operator() (const DocDotFile &)
void operator() (const DocMscFile &)
void operator() (const DocDiaFile &)
void operator() (const DocPlantUmlFile &)
void operator() (const DocMermaidFile &)
void operator() (const DocLink &)
void operator() (const DocRef &)
void operator() (const DocSecRefItem &)
void operator() (const DocSecRefList &)
void operator() (const DocParamSect &)
void operator() (const DocParamList &)
void operator() (const DocXRefItem &)
void operator() (const DocInternalRef &)
void operator() (const DocText &)
void operator() (const DocHtmlBlockQuote &)
void operator() (const DocVhdlFlow &)
void operator() (const DocParBlock &)
Public Member Functions inherited from DocVisitor
 DocVisitor ()
virtual ~DocVisitor ()
CodeParserInterfacegetCodeParser (const QCString &langExt)
void pushHidden (bool hide)
bool popHidden ()

Private Member Functions

template<class T>
void visitChildren (const T &t)
void filter (const QCString &str)
void startLink (const QCString &ref, const QCString &file, const QCString &anchor)
void endLink ()

Private Attributes

TextStreamm_t
OutputCodeListm_ci
bool m_insidePre = false
bool m_hide = false
QCString m_langExt
int m_sectionLevel

Detailed Description

Concrete visitor implementation for XML output.

Definition at line 33 of file xmldocvisitor.h.

Constructor & Destructor Documentation

◆ XmlDocVisitor()

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

Definition at line 151 of file xmldocvisitor.cpp.

152 : m_t(t), m_ci(ci), m_insidePre(FALSE), m_hide(FALSE),
153 m_langExt(langExt), m_sectionLevel(0)
154{
155}
OutputCodeList & m_ci
TextStream & m_t
QCString m_langExt
#define FALSE
Definition qcstring.h:34

References FALSE, m_ci, m_hide, m_insidePre, m_langExt, m_sectionLevel, and m_t.

Member Function Documentation

◆ endLink()

void XmlDocVisitor::endLink ( )
private

Definition at line 1201 of file xmldocvisitor.cpp.

1202{
1203 m_t << "</ref>";
1204}

References m_t.

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

◆ filter()

void XmlDocVisitor::filter ( const QCString & str)
private

Definition at line 1184 of file xmldocvisitor.cpp.

1185{
1186 m_t << convertToXML(str);
1187}
QCString convertToXML(const QCString &s, bool keepEntities)
Definition util.cpp:3923

References convertToXML(), and m_t.

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

◆ operator()() [1/59]

void XmlDocVisitor::operator() ( const DocAnchor & anc)

Definition at line 401 of file xmldocvisitor.cpp.

402{
403 if (m_hide) return;
404 m_t << "<anchor id=\"" << anc.file() << "_1" << anc.anchor() << "\"/>";
405}
QCString anchor() const
Definition docnode.h:232
QCString file() const
Definition docnode.h:233

References DocAnchor::anchor(), DocAnchor::file(), m_hide, and m_t.

◆ operator()() [2/59]

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

Definition at line 610 of file xmldocvisitor.cpp.

611{
612 if (m_hide) return;
613 if (l.isEnumList())
614 {
615 m_t << "<orderedlist>\n";
616 }
617 else
618 {
619 m_t << "<itemizedlist>\n";
620 }
621 visitChildren(l);
622 if (l.isEnumList())
623 {
624 m_t << "</orderedlist>\n";
625 }
626 else
627 {
628 m_t << "</itemizedlist>\n";
629 }
630}
bool isEnumList() const
Definition docnode.h:580
void visitChildren(const T &t)

References DocAutoList::isEnumList(), m_hide, m_t, and visitChildren().

◆ operator()() [3/59]

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

Definition at line 632 of file xmldocvisitor.cpp.

633{
634 if (m_hide) return;
635 switch (li.itemNumber())
636 {
637 case DocAutoList::Unchecked: // unchecked
638 m_t << "<listitem override=\"unchecked\">";
639 break;
640 case DocAutoList::Checked_x: // checked with x
641 case DocAutoList::Checked_X: // checked with X
642 m_t << "<listitem override=\"checked\">";
643 break;
644 default:
645 m_t << "<listitem>";
646 break;
647 }
648 visitChildren(li);
649 m_t << "</listitem>";
650}
int itemNumber() const
Definition docnode.h:598

References DocAutoList::Checked_X, DocAutoList::Checked_x, DocAutoListItem::itemNumber(), m_hide, m_t, DocAutoList::Unchecked, and visitChildren().

◆ operator()() [4/59]

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

Definition at line 584 of file xmldocvisitor.cpp.

585{
586 if (m_hide) return;
587 auto opt = cite.option();
588 if (!cite.file().isEmpty())
589 {
590 if (!opt.noCite()) startLink(cite.ref(),cite.file(),cite.anchor());
591
592 filter(cite.getText());
593
594 if (!opt.noCite()) endLink();
595 }
596 else
597 {
598 m_t << "<b>";
599 if (!opt.noPar()) filter("[");
600 filter(cite.target());
601 if (!opt.noPar()) filter("]");
602 m_t << "</b>";
603 }
604}
QCString getText() const
Definition docnode.cpp:974
CiteInfoOption option() const
Definition docnode.h:253
QCString target() const
Definition docnode.h:252
QCString anchor() const
Definition docnode.h:251
QCString ref() const
Definition docnode.h:250
QCString file() const
Definition docnode.h:248
bool isEmpty() const
Returns TRUE iff the string is empty.
Definition qcstring.h:163
void filter(const QCString &str)
void startLink(const QCString &ref, const QCString &file, const QCString &anchor)

References DocCite::anchor(), endLink(), DocCite::file(), filter(), DocCite::getText(), QCString::isEmpty(), m_hide, m_t, DocCite::option(), DocCite::ref(), startLink(), and DocCite::target().

◆ operator()() [5/59]

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

Definition at line 990 of file xmldocvisitor.cpp.

991{
992 if (m_hide) return;
993 copyFile(df.file(),Config_getString(XML_OUTPUT)+"/"+stripPath(df.file()));
994 visitPreStart(m_t, "diafile", FALSE, *this, df.children(), stripPath(df.file()), FALSE, DocImage::Html, df.width(), df.height());
995 visitChildren(df);
996 visitPostEnd(m_t, "diafile");
997}
DocNodeList & children()
Definition docnode.h:143
QCString height() const
Definition docnode.h:689
QCString file() const
Definition docnode.h:685
QCString width() const
Definition docnode.h:688
#define Config_getString(name)
Definition config.h:32
static void visitPreStart(TextStream &t, bool hasCaption, QCString name, QCString width, QCString height, bool inlineImage=FALSE)
static void visitPostEnd(TextStream &t, bool hasCaption, bool inlineImage=FALSE)
QCString stripPath(const QCString &s)
Definition util.cpp:4959
bool copyFile(const QCString &src, const QCString &dest)
Copies the contents of file with name src to the newly created file with name dest.
Definition util.cpp:5887

References DocCompoundNode::children(), Config_getString, copyFile(), FALSE, DocDiagramFileBase::file(), DocDiagramFileBase::height(), DocImage::Html, m_hide, m_t, stripPath(), visitChildren(), visitPostEnd(), visitPreStart(), and DocDiagramFileBase::width().

◆ operator()() [6/59]

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

◆ operator()() [7/59]

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

Definition at line 202 of file xmldocvisitor.cpp.

203{
204 if (m_hide) return;
205 const char *res = EmojiEntityMapper::instance().name(s.index());
206 if (res)
207 {
208 QCString name=res;
209 name = name.mid(1,name.length()-2);
210 m_t << "<emoji name=\"" << name << "\" unicode=\"";
212 m_t << "\"/>";
213 }
214 else
215 {
216 m_t << s.name();
217 }
218}
int index() const
Definition docnode.h:345
QCString name() const
Definition docnode.h:344
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
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition qcstring.h:166
QCString mid(size_t index, size_t len=static_cast< size_t >(-1)) const
Definition qcstring.h:241

References filter(), DocEmoji::index(), EmojiEntityMapper::instance(), QCString::length(), m_hide, m_t, QCString::mid(), DocEmoji::name(), and EmojiEntityMapper::name().

◆ operator()() [8/59]

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

Definition at line 555 of file xmldocvisitor.cpp.

556{
557 if (m_hide) return;
558 m_t << "<formula id=\"" << f.id() << "\">";
559 filter(f.text());
560 m_t << "</formula>";
561}
QCString text() const
Definition docnode.h:533
int id() const
Definition docnode.h:535

References filter(), DocFormula::id(), m_hide, m_t, and DocFormula::text().

◆ operator()() [9/59]

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

Definition at line 237 of file xmldocvisitor.cpp.

238{
239 if (m_hide) return;
240 m_t << "<hruler/>\n";
241}

References m_hide, and m_t.

◆ operator()() [10/59]

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

Definition at line 902 of file xmldocvisitor.cpp.

903{
904 if (m_hide) return;
905 m_t << "<ulink url=\"" << convertToXML(href.url(), TRUE) << "\">";
906 visitChildren(href);
907 m_t << "</ulink>";
908}
QCString url() const
Definition docnode.h:839
#define TRUE
Definition qcstring.h:37

References convertToXML(), m_hide, m_t, TRUE, DocHRef::url(), and visitChildren().

◆ operator()() [11/59]

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

Definition at line 1163 of file xmldocvisitor.cpp.

1164{
1165 if (m_hide) return;
1166 m_t << "<blockquote>";
1167 visitChildren(q);
1168 m_t << "</blockquote>";
1169}

References m_hide, m_t, and visitChildren().

◆ operator()() [12/59]

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

Definition at line 881 of file xmldocvisitor.cpp.

882{
883 if (m_hide) return;
884 m_t << "<caption";
885 if (!c.file().isEmpty())
886 {
887 m_t << " id=\"" << stripPath(c.file()) << "_1" << c.anchor() << "\"";
888 }
889 m_t << ">";
890 visitChildren(c);
891 m_t << "</caption>\n";
892}
QCString anchor() const
Definition docnode.h:1241
QCString file() const
Definition docnode.h:1240

References DocHtmlCaption::anchor(), DocHtmlCaption::file(), QCString::isEmpty(), m_hide, m_t, stripPath(), and visitChildren().

◆ operator()() [13/59]

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

Definition at line 828 of file xmldocvisitor.cpp.

829{
830 if (m_hide) return;
831 if (c.isHeading()) m_t << "<entry thead=\"yes\""; else m_t << "<entry thead=\"no\"";
832 for (const auto &opt : c.attribs())
833 {
834 if (opt.name=="colspan" || opt.name=="rowspan")
835 {
836 m_t << " " << opt.name << "=\"" << opt.value.toInt() << "\"";
837 }
838 else if (opt.name=="align" &&
839 (opt.value=="right" || opt.value=="left" || opt.value=="center"))
840 {
841 m_t << " align=\"" << opt.value << "\"";
842 }
843 else if (opt.name=="valign" &&
844 (opt.value == "bottom" || opt.value == "top" || opt.value == "middle"))
845 {
846 m_t << " valign=\"" << opt.value << "\"";
847 }
848 else if (opt.name=="width")
849 {
850 m_t << " width=\"" << opt.value << "\"";
851 }
852 else if (opt.name=="class") // handle markdown generated attributes
853 {
854 if (opt.value.startsWith("markdownTable")) // handle markdown generated attributes
855 {
856 if (opt.value.endsWith("Right"))
857 {
858 m_t << " align='right'";
859 }
860 else if (opt.value.endsWith("Left"))
861 {
862 m_t << " align='left'";
863 }
864 else if (opt.value.endsWith("Center"))
865 {
866 m_t << " align='center'";
867 }
868 // skip 'markdownTable*' value ending with "None"
869 }
870 else if (!opt.value.isEmpty())
871 {
872 m_t << " class=\"" << convertToXML(opt.value) << "\"";
873 }
874 }
875 }
876 m_t << ">";
877 visitChildren(c);
878 m_t << "</entry>";
879}
bool isHeading() const
Definition docnode.h:1206
const HtmlAttribList & attribs() const
Definition docnode.h:1211

References DocHtmlCell::attribs(), convertToXML(), DocHtmlCell::isHeading(), m_hide, m_t, and visitChildren().

◆ operator()() [14/59]

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

Definition at line 791 of file xmldocvisitor.cpp.

792{
793 if (m_hide) return;
794 m_t << "<listitem>";
795 visitChildren(dd);
796 m_t << "</listitem>\n";
797}

References m_hide, m_t, and visitChildren().

◆ operator()() [15/59]

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

Definition at line 775 of file xmldocvisitor.cpp.

776{
777 if (m_hide) return;
778 m_t << "<variablelist>\n";
779 visitChildren(dl);
780 m_t << "</variablelist>\n";
781}

References m_hide, m_t, and visitChildren().

◆ operator()() [16/59]

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

Definition at line 783 of file xmldocvisitor.cpp.

784{
785 if (m_hide) return;
786 m_t << "<varlistentry><term>";
787 visitChildren(dt);
788 m_t << "</term></varlistentry>\n";
789}

References m_hide, m_t, and visitChildren().

◆ operator()() [17/59]

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

Definition at line 918 of file xmldocvisitor.cpp.

919{
920 if (m_hide) return;
921 m_t << "<details>";
922 auto summary = d.summary();
923 if (summary)
924 {
925 std::visit(*this,*summary);
926 }
927 visitChildren(d);
928 m_t << "</details>";
929}
const DocNodeVariant * summary() const
Definition docnode.h:873

References m_hide, m_t, DocHtmlDetails::summary(), and visitChildren().

◆ operator()() [18/59]

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

Definition at line 931 of file xmldocvisitor.cpp.

932{
933 if (m_hide) return;
934 m_t << "<heading level=\"" << header.level() << "\">";
935 visitChildren(header);
936 m_t << "</heading>\n";
937}
int level() const
Definition docnode.h:886

References DocHtmlHeader::level(), m_hide, m_t, and visitChildren().

◆ operator()() [19/59]

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

Definition at line 732 of file xmldocvisitor.cpp.

733{
734 if (m_hide) return;
735 if (s.type()==DocHtmlList::Ordered)
736 {
737 m_t << "<orderedlist";
738 for (const auto &opt : s.attribs())
739 {
740 m_t << " " << opt.name << "=\"" << opt.value << "\"";
741 }
742 m_t << ">\n";
743 }
744 else
745 {
746 m_t << "<itemizedlist>\n";
747 }
748 visitChildren(s);
749 if (s.type()==DocHtmlList::Ordered)
750 {
751 m_t << "</orderedlist>\n";
752 }
753 else
754 {
755 m_t << "</itemizedlist>\n";
756 }
757}
const HtmlAttribList & attribs() const
Definition docnode.h:1015
Type type() const
Definition docnode.h:1014

References DocHtmlList::attribs(), m_hide, m_t, DocHtmlList::Ordered, DocHtmlList::type(), and visitChildren().

◆ operator()() [20/59]

void XmlDocVisitor::operator() ( const DocHtmlListItem & l)

Definition at line 759 of file xmldocvisitor.cpp.

760{
761 if (m_hide) return;
762 m_t << "<listitem";
763 for (const auto &opt : l.attribs())
764 {
765 if (opt.name=="value")
766 {
767 m_t << " " << opt.name << "=\"" << opt.value << "\"";
768 }
769 }
770 m_t << ">\n";
771 visitChildren(l);
772 m_t << "</listitem>\n";
773}
const HtmlAttribList & attribs() const
Definition docnode.h:1176

References DocHtmlListItem::attribs(), m_hide, m_t, and visitChildren().

◆ operator()() [21/59]

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

Definition at line 820 of file xmldocvisitor.cpp.

821{
822 if (m_hide) return;
823 m_t << "<row>\n";
824 visitChildren(r);
825 m_t << "</row>\n";
826}

References m_hide, m_t, and visitChildren().

◆ operator()() [22/59]

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

Definition at line 910 of file xmldocvisitor.cpp.

911{
912 if (m_hide) return;
913 m_t << "<summary>";
914 visitChildren(s);
915 m_t << "</summary>";
916}

References m_hide, m_t, and visitChildren().

◆ operator()() [23/59]

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

Definition at line 799 of file xmldocvisitor.cpp.

800{
801 if (m_hide) return;
802 m_t << "<table rows=\"" << t.numRows()
803 << "\" cols=\"" << t.numColumns() << "\"" ;
804 for (const auto &opt : t.attribs())
805 {
806 if (opt.name=="width")
807 {
808 m_t << " " << opt.name << "=\"" << opt.value << "\"";
809 }
810 }
811 m_t << ">";
812 if (t.caption())
813 {
814 std::visit(*this,*t.caption());
815 }
816 visitChildren(t);
817 m_t << "</table>\n";
818}
size_t numRows() const
Definition docnode.h:1279
size_t numColumns() const
Definition docnode.h:1284
const DocNodeVariant * caption() const
Definition docnode.cpp:2250
const HtmlAttribList & attribs() const
Definition docnode.h:1281

References DocHtmlTable::attribs(), DocHtmlTable::caption(), m_hide, m_t, DocHtmlTable::numColumns(), DocHtmlTable::numRows(), and visitChildren().

◆ operator()() [24/59]

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

Definition at line 939 of file xmldocvisitor.cpp.

940{
941 if (m_hide) return;
942
943 QCString url = img.url();
944 QCString baseName;
945 if (url.isEmpty())
946 {
947 baseName = img.relPath()+img.name();
948 }
949 else
950 {
951 baseName = correctURL(url,img.relPath());
952 }
953 HtmlAttribList attribs = img.attribs();
954 auto it = std::find_if(attribs.begin(),attribs.end(),
955 [](const auto &att) { return att.name=="alt"; });
956 QCString altValue = it!=attribs.end() ? it->value : "";
957 visitPreStart(m_t, "image", FALSE, *this, img.children(), baseName, TRUE,
958 img.type(), img.width(), img.height(), QCString(),
959 altValue, img.isInlineImage());
960
961 // copy the image to the output dir
962 FileDef *fd = nullptr;
963 bool ambig;
964 if (url.isEmpty() && (fd=findFileDef(Doxygen::imageNameLinkedMap,img.name(),ambig)))
965 {
966 copyFile(fd->absFilePath(),Config_getString(XML_OUTPUT)+"/"+baseName);
967 }
968 visitChildren(img);
969 visitPostEnd(m_t, "image");
970}
const HtmlAttribList & attribs() const
Definition docnode.h:656
QCString relPath() const
Definition docnode.h:652
QCString name() const
Definition docnode.h:648
QCString url() const
Definition docnode.h:653
QCString height() const
Definition docnode.h:651
Type type() const
Definition docnode.h:647
QCString width() const
Definition docnode.h:650
bool isInlineImage() const
Definition docnode.h:654
static FileNameLinkedMap * imageNameLinkedMap
Definition doxygen.h:105
virtual QCString absFilePath() const =0
QCString correctURL(const QCString &url, const QCString &relPath)
Corrects URL url according to the relative path relPath.
Definition util.cpp:5955
FileDef * findFileDef(const FileNameLinkedMap *fnMap, const QCString &n, bool &ambig)
Definition util.cpp:2894

References FileDef::absFilePath(), DocImage::attribs(), DocCompoundNode::children(), Config_getString, copyFile(), correctURL(), FALSE, findFileDef(), DocImage::height(), Doxygen::imageNameLinkedMap, QCString::isEmpty(), DocImage::isInlineImage(), m_hide, m_t, DocImage::name(), DocImage::relPath(), TRUE, DocImage::type(), DocImage::url(), visitChildren(), visitPostEnd(), visitPreStart(), and DocImage::width().

◆ operator()() [25/59]

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

Definition at line 407 of file xmldocvisitor.cpp.

408{
409 if (m_hide) return;
411 //printf("XMLDocVisitor: DocInclude type=%d trimleft=%d\n",inc.type(),inc.trimLeft());
412 switch(inc.type())
413 {
415 {
416 m_t << "<programlisting filename=\"" << inc.file() << "\">";
417 FileInfo cfi( inc.file().str() );
418 auto fd = createFileDef( cfi.dirPath(), cfi.fileName());
420 inc.text(),
421 langExt,
422 inc.stripCodeComments(),
423 CodeParserOptions()
424 .setExample(inc.isExample(),inc.exampleFile())
425 .setFileDef(fd.get())
426 .setInlineFragment(true)
427 );
428 m_t << "</programlisting>";
429 }
430 break;
432 m_t << "<programlisting filename=\"" << inc.file() << "\">";
434 inc.text(),
435 langExt,
436 inc.stripCodeComments(),
437 CodeParserOptions()
438 .setExample(inc.isExample(),inc.exampleFile())
439 .setInlineFragment(true)
440 .setShowLineNumbers(false)
441 );
442 m_t << "</programlisting>";
443 break;
446 break;
448 if (inc.isBlock())
449 {
450 m_t << "<htmlonly block=\"yes\">";
451 }
452 else
453 {
454 m_t << "<htmlonly>";
455 }
456 filter(inc.text());
457 m_t << "</htmlonly>";
458 break;
460 m_t << "<latexonly>";
461 filter(inc.text());
462 m_t << "</latexonly>";
463 break;
465 m_t << "<rtfonly>";
466 filter(inc.text());
467 m_t << "</rtfonly>";
468 break;
470 m_t << "<manonly>";
471 filter(inc.text());
472 m_t << "</manonly>";
473 break;
475 filter(inc.text());
476 break;
478 m_t << "<docbookonly>";
479 filter(inc.text());
480 m_t << "</docbookonly>";
481 break;
483 m_t << "<verbatim>";
484 filter(inc.text());
485 m_t << "</verbatim>";
486 break;
489 m_t << "<programlisting filename=\"" << inc.file() << "\">";
491 inc.file(),
492 inc.blockId(),
493 inc.context(),
495 inc.trimLeft(),
497 );
498 m_t << "</programlisting>";
499 break;
500 }
501}
void parseCodeFragment(OutputCodeList &codeOutList, const QCString &fileName, const QCString &blockId, const QCString &scopeName, bool showLineNumbers, bool trimLeft, bool stripCodeComments)
static CodeFragmentManager & instance()
virtual void parseCode(OutputCodeList &codeOutList, const QCString &scopeName, const QCString &input, SrcLangExt lang, bool stripCodeComments, const CodeParserOptions &options)=0
Parses a source file or fragment with the goal to produce highlighted and cross-referenced output.
QCString blockId() const
Definition docnode.h:454
QCString extension() const
Definition docnode.h:450
bool isBlock() const
Definition docnode.h:458
bool stripCodeComments() const
Definition docnode.h:455
@ LatexInclude
Definition docnode.h:437
@ SnippetWithLines
Definition docnode.h:438
@ DontIncWithLines
Definition docnode.h:439
@ IncWithLines
Definition docnode.h:438
@ HtmlInclude
Definition docnode.h:437
@ VerbInclude
Definition docnode.h:437
@ DontInclude
Definition docnode.h:437
@ DocbookInclude
Definition docnode.h:439
Type type() const
Definition docnode.h:451
QCString exampleFile() const
Definition docnode.h:457
QCString text() const
Definition docnode.h:452
QCString file() const
Definition docnode.h:449
bool trimLeft() const
Definition docnode.h:459
bool isExample() const
Definition docnode.h:456
QCString context() const
Definition docnode.h:453
CodeParserInterface & getCodeParser(const QCString &langExt)
const std::string & str() const
Definition qcstring.h:552
std::unique_ptr< FileDef > createFileDef(const QCString &p, const QCString &n, const QCString &ref, const QCString &dn)
Definition filedef.cpp:268
SrcLangExt
Definition types.h:207
SrcLangExt getLanguageFromFileName(const QCString &fileName, SrcLangExt defLang)
Definition util.cpp:5221

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

◆ operator()() [26/59]

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

Definition at line 503 of file xmldocvisitor.cpp.

504{
505 //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
506 // op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
507 if (op.isFirst())
508 {
509 if (!m_hide)
510 {
511 m_t << "<programlisting filename=\"" << op.includeFileName() << "\">";
512 }
514 m_hide = TRUE;
515 }
516 QCString locLangExt = getFileNameExtension(op.includeFileName());
517 if (locLangExt.isEmpty()) locLangExt = m_langExt;
518 SrcLangExt langExt = getLanguageFromFileName(locLangExt);
519 if (op.type()!=DocIncOperator::Skip)
520 {
521 m_hide = popHidden();
522 if (!m_hide)
523 {
524 std::unique_ptr<FileDef> fd;
525 if (!op.includeFileName().isEmpty())
526 {
527 FileInfo cfi( op.includeFileName().str() );
528 fd = createFileDef( cfi.dirPath(), cfi.fileName() );
529 }
530
531 getCodeParser(locLangExt).parseCode(m_ci,op.context(),
532 op.text(),langExt,
534 CodeParserOptions()
535 .setExample(op.isExample(), op.exampleFile())
536 .setFileDef(fd.get())
537 .setStartLine(op.line())
538 .setShowLineNumbers(op.showLineNo())
539 );
540 }
542 m_hide=TRUE;
543 }
544 if (op.isLast())
545 {
546 m_hide = popHidden();
547 if (!m_hide) m_t << "</programlisting>";
548 }
549 else
550 {
551 if (!m_hide) m_t << "\n";
552 }
553}
bool stripCodeComments() const
Definition docnode.h:506
bool isLast() const
Definition docnode.h:503
QCString includeFileName() const
Definition docnode.h:509
QCString text() const
Definition docnode.h:499
QCString context() const
Definition docnode.h:501
QCString exampleFile() const
Definition docnode.h:508
int line() const
Definition docnode.h:497
Type type() const
Definition docnode.h:485
bool isFirst() const
Definition docnode.h:502
bool showLineNo() const
Definition docnode.h:498
bool isExample() const
Definition docnode.h:507
void pushHidden(bool hide)
bool popHidden()
QCString getFileNameExtension(const QCString &fn)
Definition util.cpp:5263

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

◆ operator()() [27/59]

void XmlDocVisitor::operator() ( const DocIndexEntry & ie)

Definition at line 563 of file xmldocvisitor.cpp.

564{
565 if (m_hide) return;
566 m_t << "<indexentry>"
567 "<primaryie>";
568 filter(ie.entry());
569 m_t << "</primaryie>"
570 "<secondaryie></secondaryie>"
571 "</indexentry>";
572}
QCString entry() const
Definition docnode.h:559

References DocIndexEntry::entry(), filter(), m_hide, and m_t.

◆ operator()() [28/59]

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

Definition at line 894 of file xmldocvisitor.cpp.

895{
896 if (m_hide) return;
897 m_t << "<internal>";
898 visitChildren(i);
899 m_t << "</internal>\n";
900}

References m_hide, m_t, and visitChildren().

◆ operator()() [29/59]

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

Definition at line 1149 of file xmldocvisitor.cpp.

1150{
1151 if (m_hide) return;
1152 startLink(QCString(),ref.file(),ref.anchor());
1153 visitChildren(ref);
1154 endLink();
1155 m_t << " ";
1156}
QCString file() const
Definition docnode.h:820
QCString anchor() const
Definition docnode.h:822

References DocInternalRef::anchor(), endLink(), DocInternalRef::file(), m_hide, m_t, startLink(), and visitChildren().

◆ operator()() [30/59]

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

Definition at line 231 of file xmldocvisitor.cpp.

232{
233 if (m_hide) return;
234 m_t << "<linebreak/>\n";
235}

References m_hide, and m_t.

◆ operator()() [31/59]

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

Definition at line 1017 of file xmldocvisitor.cpp.

1018{
1019 if (m_hide) return;
1020 startLink(lnk.ref(),lnk.file(),lnk.anchor());
1021 visitChildren(lnk);
1022 endLink();
1023}

References DocLink::anchor(), endLink(), DocLink::file(), m_hide, DocLink::ref(), startLink(), and visitChildren().

◆ operator()() [32/59]

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

Definition at line 167 of file xmldocvisitor.cpp.

168{
169 if (m_hide) return;
170 startLink(w.ref(),w.file(),w.anchor());
171 filter(w.word());
172 endLink();
173}
QCString file() const
Definition docnode.h:171
QCString ref() const
Definition docnode.h:173
QCString word() const
Definition docnode.h:170
QCString anchor() const
Definition docnode.h:174

References DocLinkedWord::anchor(), endLink(), DocLinkedWord::file(), filter(), m_hide, DocLinkedWord::ref(), startLink(), and DocLinkedWord::word().

◆ operator()() [33/59]

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

◆ operator()() [34/59]

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

◆ operator()() [35/59]

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

Definition at line 652 of file xmldocvisitor.cpp.

653{
654 if (m_hide) return;
655 m_t << "<para>";
656 visitChildren(p);
657 m_t << "</para>\n";
658}

References m_hide, m_t, and visitChildren().

◆ operator()() [36/59]

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

Definition at line 1084 of file xmldocvisitor.cpp.

1085{
1086 if (m_hide) return;
1087 m_t << "<parameteritem>\n";
1088 m_t << "<parameternamelist>\n";
1089 for (const auto &param : pl.parameters())
1090 {
1091 if (!pl.paramTypes().empty())
1092 {
1093 m_t << "<parametertype>";
1094 for (const auto &type : pl.paramTypes())
1095 {
1096 std::visit(*this,type);
1097 }
1098 m_t << "</parametertype>\n";
1099 }
1100 m_t << "<parametername";
1102 {
1103 m_t << " direction=\"";
1104 if (pl.direction()==DocParamSect::In)
1105 {
1106 m_t << "in";
1107 }
1108 else if (pl.direction()==DocParamSect::Out)
1109 {
1110 m_t << "out";
1111 }
1112 else if (pl.direction()==DocParamSect::InOut)
1113 {
1114 m_t << "inout";
1115 }
1116 m_t << "\"";
1117 }
1118 m_t << ">";
1119 std::visit(*this,param);
1120 m_t << "</parametername>\n";
1121 }
1122 m_t << "</parameternamelist>\n";
1123 m_t << "<parameterdescription>\n";
1124 for (const auto &par : pl.paragraphs())
1125 {
1126 std::visit(*this,par);
1127 }
1128 m_t << "</parameterdescription>\n";
1129 m_t << "</parameteritem>\n";
1130}
const DocNodeList & parameters() const
Definition docnode.h:1135
const DocNodeList & paramTypes() const
Definition docnode.h:1136
DocParamSect::Direction direction() const
Definition docnode.h:1139
const DocNodeList & paragraphs() const
Definition docnode.h:1137
bool empty() const
checks whether the container is empty
Definition growvector.h:140

References DocParamList::direction(), GrowVector< T >::empty(), DocParamSect::In, DocParamSect::InOut, m_hide, m_t, DocParamSect::Out, DocParamList::paragraphs(), DocParamList::parameters(), DocParamList::paramTypes(), and DocParamSect::Unspecified.

◆ operator()() [37/59]

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

Definition at line 1056 of file xmldocvisitor.cpp.

1057{
1058 if (m_hide) return;
1059 m_t << "<parameterlist kind=\"";
1060 switch(s.type())
1061 {
1063 m_t << "param"; break;
1065 m_t << "retval"; break;
1067 m_t << "exception"; break;
1069 m_t << "templateparam"; break;
1070 default:
1071 ASSERT(0);
1072 }
1073 m_t << "\">";
1074 visitChildren(s);
1075 m_t << "</parameterlist>\n";
1076}
Type type() const
Definition docnode.h:1077
#define ASSERT(x)
Definition qcstring.h:39

References ASSERT, DocParamSect::Exception, m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, DocParamSect::type(), and visitChildren().

◆ operator()() [38/59]

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

Definition at line 1175 of file xmldocvisitor.cpp.

1176{
1177 if (m_hide) return;
1178 m_t << "<parblock>";
1179 visitChildren(pb);
1180 m_t << "</parblock>";
1181}

References m_hide, m_t, and visitChildren().

◆ operator()() [39/59]

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

◆ operator()() [40/59]

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

Definition at line 1025 of file xmldocvisitor.cpp.

1026{
1027 if (m_hide) return;
1028 if (!ref.file().isEmpty())
1029 {
1030 startLink(ref.ref(),ref.file(),ref.isSubPage() ? QCString() : ref.anchor());
1031 }
1032 if (!ref.hasLinkText()) filter(ref.targetTitle());
1033 visitChildren(ref);
1034 if (!ref.file().isEmpty()) endLink();
1035}
QCString anchor() const
Definition docnode.h:794
QCString targetTitle() const
Definition docnode.h:795
bool isSubPage() const
Definition docnode.h:801
QCString file() const
Definition docnode.h:791
QCString ref() const
Definition docnode.h:793
bool hasLinkText() const
Definition docnode.h:797

References DocRef::anchor(), endLink(), DocRef::file(), filter(), DocRef::hasLinkText(), QCString::isEmpty(), DocRef::isSubPage(), m_hide, DocRef::ref(), startLink(), DocRef::targetTitle(), and visitChildren().

◆ operator()() [41/59]

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

Definition at line 660 of file xmldocvisitor.cpp.

661{
662 visitChildren(r);
663}

References visitChildren().

◆ operator()() [42/59]

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

Definition at line 1037 of file xmldocvisitor.cpp.

1038{
1039 if (m_hide) return;
1040 m_t << "<tocitem id=\"" << ref.file();
1041 if (!ref.anchor().isEmpty()) m_t << "_1" << ref.anchor();
1042 m_t << "\"";
1043 m_t << ">";
1044 visitChildren(ref);
1045 m_t << "</tocitem>\n";
1046}
QCString file() const
Definition docnode.h:948
QCString anchor() const
Definition docnode.h:949

References DocSecRefItem::anchor(), DocSecRefItem::file(), QCString::isEmpty(), m_hide, m_t, and visitChildren().

◆ operator()() [43/59]

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

Definition at line 1048 of file xmldocvisitor.cpp.

1049{
1050 if (m_hide) return;
1051 m_t << "<toclist>\n";
1052 visitChildren(l);
1053 m_t << "</toclist>\n";
1054}

References m_hide, m_t, and visitChildren().

◆ operator()() [44/59]

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

Definition at line 704 of file xmldocvisitor.cpp.

705{
706 if (m_hide) return;
707 int orgSectionLevel = m_sectionLevel;
708 QCString sectId = s.file();
709 if (!s.anchor().isEmpty()) sectId += "_1"+s.anchor();
710 while (m_sectionLevel+1<s.level()) // fix missing intermediate levels
711 {
713 m_t << "<sect" << m_sectionLevel << " id=\"" << sectId << "_1s" << m_sectionLevel << "\">";
714 }
716 m_t << "<sect" << s.level() << " id=\"" << sectId << "\">\n";
717 if (s.title())
718 {
719 std::visit(*this,*s.title());
720 }
721 visitChildren(s);
722 m_t << "</sect" << s.level() << ">";
724 while (orgSectionLevel<m_sectionLevel) // fix missing intermediate levels
725 {
726 m_t << "</sect" << m_sectionLevel << ">";
728 }
729 m_t << "\n";
730}
QCString file() const
Definition docnode.h:931
int level() const
Definition docnode.h:927
QCString anchor() const
Definition docnode.h:929
const DocNodeVariant * title() const
Definition docnode.h:928

References DocSection::anchor(), DocSection::file(), QCString::isEmpty(), DocSection::level(), m_hide, m_sectionLevel, m_t, DocSection::title(), and visitChildren().

◆ operator()() [45/59]

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

Definition at line 1078 of file xmldocvisitor.cpp.

1079{
1080 m_t << "</parametertype>\n";
1081 m_t << "<parametertype>";
1082}

References m_t.

◆ operator()() [46/59]

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

Definition at line 685 of file xmldocvisitor.cpp.

686{
687 if (m_hide) return;
688 m_t << "<itemizedlist>\n";
689 visitChildren(l);
690 m_t << "</itemizedlist>\n";
691}

References m_hide, m_t, and visitChildren().

◆ operator()() [47/59]

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

Definition at line 693 of file xmldocvisitor.cpp.

694{
695 if (m_hide) return;
696 m_t << "<listitem>";
697 if (li.paragraph())
698 {
699 std::visit(*this,*li.paragraph());
700 }
701 m_t << "</listitem>\n";
702}
const DocNodeVariant * paragraph() const
Definition docnode.h:1163

References m_hide, m_t, and DocSimpleListItem::paragraph().

◆ operator()() [48/59]

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

Definition at line 665 of file xmldocvisitor.cpp.

666{
667 if (m_hide) return;
669 if (s.title())
670 {
671 std::visit(*this,*s.title());
672 }
673 visitChildren(s);
675}
const DocNodeVariant * title() const
Definition docnode.h:1042
static void endSimpleSect(TextStream &t, const DocSimpleSect &)
static void startSimpleSect(TextStream &t, const DocSimpleSect &s)

References endSimpleSect(), m_hide, m_t, startSimpleSect(), DocSimpleSect::title(), and visitChildren().

◆ operator()() [49/59]

void XmlDocVisitor::operator() ( const DocSimpleSectSep & sep)

Definition at line 574 of file xmldocvisitor.cpp.

575{
576 const DocSimpleSect *sect = std::get_if<DocSimpleSect>(sep.parent());
577 if (sect)
578 {
579 endSimpleSect(m_t,*sect);
580 startSimpleSect(m_t,*sect);
581 }
582}
DocNodeVariant * parent()
Definition docnode.h:90

References endSimpleSect(), m_t, DocNode::parent(), and startSimpleSect().

◆ operator()() [50/59]

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

Definition at line 243 of file xmldocvisitor.cpp.

244{
245 if (m_hide) return;
246 switch (s.style())
247 {
249 if (s.enable()) m_t << "<bold>"; else m_t << "</bold>";
250 break;
252 if (s.enable()) m_t << "<s>"; else m_t << "</s>";
253 break;
255 if (s.enable()) m_t << "<strike>"; else m_t << "</strike>";
256 break;
258 if (s.enable()) m_t << "<del>"; else m_t << "</del>";
259 break;
261 if (s.enable()) m_t << "<underline>"; else m_t << "</underline>";
262 break;
264 if (s.enable()) m_t << "<ins>"; else m_t << "</ins>";
265 break;
267 if (s.enable()) m_t << "<emphasis>"; else m_t << "</emphasis>";
268 break;
272 if (s.enable()) m_t << "<computeroutput>"; else m_t << "</computeroutput>";
273 break;
275 if (s.enable()) m_t << "<subscript>"; else m_t << "</subscript>";
276 break;
278 if (s.enable()) m_t << "<superscript>"; else m_t << "</superscript>";
279 break;
281 if (s.enable()) m_t << "<center>"; else m_t << "</center>";
282 break;
284 if (s.enable()) m_t << "<small>"; else m_t << "</small>";
285 break;
287 if (s.enable()) m_t << "<cite>"; else m_t << "</cite>";
288 break;
290 if (s.enable())
291 {
292 m_t << "<preformatted>";
294 }
295 else
296 {
297 m_t << "</preformatted>";
299 }
300 break;
301 case DocStyleChange::Div: /* HTML only */ break;
302 case DocStyleChange::Span: /* HTML only */ break;
303 }
304}
Style style() const
Definition docnode.h:307
bool enable() const
Definition docnode.h:309

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), FALSE, DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, 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()() [51/59]

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

Definition at line 188 of file xmldocvisitor.cpp.

189{
190 if (m_hide) return;
191 const char *res = HtmlEntityMapper::instance().xml(s.symbol());
192 if (res)
193 {
194 m_t << res;
195 }
196 else
197 {
198 err("XML: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));
199 }
200}
HtmlEntityMapper::SymType symbol() const
Definition docnode.h:332
const char * xml(SymType symb) const
Access routine to the XML code of the HTML entity.
static HtmlEntityMapper & instance()
Returns the one and only instance of the HTML entity mapper.
#define err(fmt,...)
Definition message.h:127

References err, HtmlEntityMapper::instance(), m_hide, m_t, DocSymbol::symbol(), TRUE, and HtmlEntityMapper::xml().

◆ operator()() [52/59]

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

Definition at line 1158 of file xmldocvisitor.cpp.

1159{
1160 visitChildren(t);
1161}

References visitChildren().

◆ operator()() [53/59]

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

Definition at line 677 of file xmldocvisitor.cpp.

678{
679 if (m_hide) return;
680 m_t << "<title>";
681 visitChildren(t);
682 m_t << "</title>";
683}

References m_hide, m_t, and visitChildren().

◆ operator()() [54/59]

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

Definition at line 220 of file xmldocvisitor.cpp.

221{
222 if (m_hide) return;
223 m_t << "<ulink url=\"";
224 if (u.isEmail()) m_t << "mailto:";
225 filter(u.url());
226 m_t << "\">";
227 filter(u.url());
228 m_t << "</ulink>";
229}
QCString url() const
Definition docnode.h:192
bool isEmail() const
Definition docnode.h:193

References filter(), DocURL::isEmail(), m_hide, m_t, and DocURL::url().

◆ operator()() [55/59]

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

Definition at line 306 of file xmldocvisitor.cpp.

307{
308 if (m_hide) return;
309 QCString lang = m_langExt;
310 if (!s.language().isEmpty()) // explicit language setting
311 {
312 lang = s.language();
313 }
314 SrcLangExt langExt = getLanguageFromCodeLang(lang);
315 switch(s.type())
316 {
318 m_t << "<programlisting";
319 if (!s.language().isEmpty())
320 m_t << " filename=\"" << lang << "\">";
321 else
322 m_t << ">";
323 getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),langExt,
324 Config_getBool(STRIP_CODE_COMMENTS),
325 CodeParserOptions().setExample(s.isExample(),s.exampleFile()));
326 m_t << "</programlisting>";
327 break;
329 m_t << "<javadocliteral>";
330 filter(s.text());
331 m_t << "</javadocliteral>";
332 break;
334 m_t << "<javadoccode>";
335 filter(s.text());
336 m_t << "</javadoccode>";
337 break;
339 m_t << "<verbatim>";
340 filter(s.text());
341 m_t << "</verbatim>";
342 break;
344 if (s.isBlock())
345 {
346 m_t << "<htmlonly block=\"yes\">";
347 }
348 else
349 {
350 m_t << "<htmlonly>";
351 }
352 filter(s.text());
353 m_t << "</htmlonly>";
354 break;
356 m_t << "<rtfonly>";
357 filter(s.text());
358 m_t << "</rtfonly>";
359 break;
361 m_t << "<manonly>";
362 filter(s.text());
363 m_t << "</manonly>";
364 break;
366 m_t << "<latexonly>";
367 filter(s.text());
368 m_t << "</latexonly>";
369 break;
371 m_t << "<docbookonly>";
372 filter(s.text());
373 m_t << "</docbookonly>";
374 break;
376 m_t << s.text();
377 break;
378 case DocVerbatim::Dot:
379 visitPreStart(m_t, "dot", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height());
380 filter(s.text());
381 visitPostEnd(m_t, "dot");
382 break;
383 case DocVerbatim::Msc:
384 visitPreStart(m_t, "msc", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height());
385 filter(s.text());
386 visitPostEnd(m_t, "msc");
387 break;
389 visitPreStart(m_t, "plantuml", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height(), s.engine());
390 filter(s.text());
391 visitPostEnd(m_t, "plantuml");
392 break;
394 visitPreStart(m_t, "mermaid", s.hasCaption(), *this, s.children(), QCString(""), FALSE, DocImage::Html, s.width(), s.height());
395 filter(s.text());
396 visitPostEnd(m_t, "mermaid");
397 break;
398 }
399}
QCString height() const
Definition docnode.h:392
bool hasCaption() const
Definition docnode.h:390
QCString language() const
Definition docnode.h:388
const DocNodeList & children() const
Definition docnode.h:395
bool isBlock() const
Definition docnode.h:389
bool isExample() const
Definition docnode.h:385
QCString context() const
Definition docnode.h:384
Type type() const
Definition docnode.h:382
QCString text() const
Definition docnode.h:383
QCString exampleFile() const
Definition docnode.h:386
QCString engine() const
Definition docnode.h:393
@ JavaDocLiteral
Definition docnode.h:378
QCString width() const
Definition docnode.h:391
#define Config_getBool(name)
Definition config.h:33
SrcLangExt getLanguageFromCodeLang(QCString &fileName)
Routine to handle the language attribute of the \code command.
Definition util.cpp:5239

References DocVerbatim::children(), DocVerbatim::Code, Config_getBool, DocVerbatim::context(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, DocVerbatim::engine(), DocVerbatim::exampleFile(), FALSE, filter(), DocVisitor::getCodeParser(), getLanguageFromCodeLang(), DocVerbatim::hasCaption(), DocVerbatim::height(), DocImage::Html, DocVerbatim::HtmlOnly, DocVerbatim::isBlock(), QCString::isEmpty(), DocVerbatim::isExample(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, m_ci, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, DocVerbatim::RtfOnly, DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, visitPostEnd(), visitPreStart(), DocVerbatim::width(), and DocVerbatim::XmlOnly.

◆ operator()() [56/59]

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

Definition at line 1171 of file xmldocvisitor.cpp.

1172{
1173}

◆ operator()() [57/59]

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

Definition at line 175 of file xmldocvisitor.cpp.

176{
177 if (m_hide) return;
178 if (m_insidePre)
179 {
180 m_t << w.chars();
181 }
182 else
183 {
184 m_t << " ";
185 }
186}
QCString chars() const
Definition docnode.h:358

References DocWhiteSpace::chars(), m_hide, m_insidePre, and m_t.

◆ operator()() [58/59]

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

Definition at line 161 of file xmldocvisitor.cpp.

162{
163 if (m_hide) return;
164 filter(w.word());
165}
QCString word() const
Definition docnode.h:156

References filter(), m_hide, and DocWord::word().

◆ operator()() [59/59]

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

Definition at line 1132 of file xmldocvisitor.cpp.

1133{
1134 if (m_hide) return;
1135 if (x.title().isEmpty()) return;
1136 m_t << "<xrefsect id=\"";
1137 m_t << x.file() << "_1" << x.anchor();
1138 m_t << "\">";
1139 m_t << "<xreftitle>";
1140 filter(x.title());
1141 m_t << "</xreftitle>";
1142 m_t << "<xrefdescription>";
1143 visitChildren(x);
1144 if (x.title().isEmpty()) return;
1145 m_t << "</xrefdescription>";
1146 m_t << "</xrefsect>";
1147}
QCString anchor() const
Definition docnode.h:625
QCString file() const
Definition docnode.h:624
QCString title() const
Definition docnode.h:626

References DocXRefItem::anchor(), DocXRefItem::file(), filter(), QCString::isEmpty(), m_hide, m_t, DocXRefItem::title(), and visitChildren().

◆ startLink()

void XmlDocVisitor::startLink ( const QCString & ref,
const QCString & file,
const QCString & anchor )
private

Definition at line 1189 of file xmldocvisitor.cpp.

1190{
1191 //printf("XmlDocVisitor: file=%s anchor=%s\n",qPrint(file),qPrint(anchor));
1192 m_t << "<ref refid=\"" << file;
1193 if (!anchor.isEmpty()) m_t << "_1" << anchor;
1194 m_t << "\" kindref=\"";
1195 if (!anchor.isEmpty()) m_t << "member"; else m_t << "compound";
1196 m_t << "\"";
1197 if (!ref.isEmpty()) m_t << " external=\"" << ref << "\"";
1198 m_t << ">";
1199}

References QCString::isEmpty(), and m_t.

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

◆ visitChildren()

Member Data Documentation

◆ m_ci

OutputCodeList& XmlDocVisitor::m_ci
private

Definition at line 131 of file xmldocvisitor.h.

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

◆ m_hide

◆ m_insidePre

bool XmlDocVisitor::m_insidePre = false
private

Definition at line 132 of file xmldocvisitor.h.

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

◆ m_langExt

QCString XmlDocVisitor::m_langExt
private

Definition at line 134 of file xmldocvisitor.h.

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

◆ m_sectionLevel

int XmlDocVisitor::m_sectionLevel
private

Definition at line 135 of file xmldocvisitor.h.

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

◆ m_t


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