The TextDocVisitor Class Reference

Concrete visitor implementation for TEXT output. More...

Declaration

class TextDocVisitor { ... }

Included Headers

#include <src/textdocvisitor.h>

Base class

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

Public Constructors Index

	TextDocVisitor (TextStream &t)

Public Operators Index

void	operator() (const DocWord &w)
void	operator() (const DocLinkedWord &w)
void	operator() (const DocWhiteSpace &)
void	operator() (const DocSymbol &)
void	operator() (const DocEmoji &)
void	operator() (const DocURL &u)
void	operator() (const DocLineBreak &)
void	operator() (const DocHorRuler &)
void	operator() (const DocStyleChange &)
void	operator() (const DocVerbatim &s)
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 &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 &)
void	operator() (const DocSection &s)
void	operator() (const DocHtmlList &l)
void	operator() (const DocHtmlListItem &li)
void	operator() (const DocHtmlDescList &dl)
void	operator() (const DocHtmlDescTitle &dt)
void	operator() (const DocHtmlDescData &dd)
void	operator() (const DocHtmlTable &t)
void	operator() (const DocHtmlRow &r)
void	operator() (const DocHtmlCell &c)
void	operator() (const DocHtmlCaption &c)
void	operator() (const DocInternal &i)
void	operator() (const DocHRef &h)
void	operator() (const DocHtmlSummary &s)
void	operator() (const DocHtmlDetails &d)
void	operator() (const DocHtmlHeader &h)
void	operator() (const DocImage &i)
void	operator() (const DocDotFile &df)
void	operator() (const DocMscFile &df)
void	operator() (const DocDiaFile &df)
void	operator() (const DocPlantUmlFile &df)
void	operator() (const DocLink &l)
void	operator() (const DocRef &r)
void	operator() (const DocSecRefItem &s)
void	operator() (const DocSecRefList &l)
void	operator() (const DocParamSect &s)
void	operator() (const DocParamList &)
void	operator() (const DocXRefItem &x)
void	operator() (const DocInternalRef &r)
void	operator() (const DocText &t)
void	operator() (const DocHtmlBlockQuote &q)
void	operator() (const DocVhdlFlow &)
void	operator() (const DocParBlock &pb)

Public Member Functions Index

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

Private Member Functions Index

void	filter (const QCString &str)

Private Member Attributes Index

TextStream &	m_t

Description

Concrete visitor implementation for TEXT output.

Definition at line 28 of file textdocvisitor.h.

Public Constructors

TextDocVisitor()

TextDocVisitor::TextDocVisitor (TextStream & t)

inline

Definition at line 31 of file textdocvisitor.h.

31 TextDocVisitor(TextStream &t) : m_t(t) {}

Reference m_t.

Public Operators

operator()()

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

inline

Definition at line 37 of file textdocvisitor.h.

37 void operator()(const DocWord &w) { filter(w.word()); }

References filter and DocWord::word.

operator()()

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

inline

Definition at line 38 of file textdocvisitor.h.

38 void operator()(const DocLinkedWord &w) { filter(w.word()); }

References filter and DocLinkedWord::word.

operator()()

void TextDocVisitor::operator() (const DocWhiteSpace &)

inline

Definition at line 39 of file textdocvisitor.h.

39 void operator()(const DocWhiteSpace &) { m_t << " "; }

Reference m_t.

operator()()

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

Declaration at line 40 of file textdocvisitor.h, definition at line 28 of file textdocvisitor.cpp.

28void TextDocVisitor::operator()(const DocSymbol &s)

29{

30 const char *res = HtmlEntityMapper::instance().html(s.symbol());

31 if (res)

32 {

33 m_t << res;

34 }

35 else

36 {

37 err("text: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));

38 }

39}

References err, HtmlEntityMapper::html, HtmlEntityMapper::instance, m_t, DocSymbol::symbol and TRUE.

operator()()

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

Declaration at line 41 of file textdocvisitor.h, definition at line 41 of file textdocvisitor.cpp.

41void TextDocVisitor::operator()(const DocEmoji &s)

42{

43 // the TextDocVisitor is only invoked for the JS part of the HTML output

44 const char *res = EmojiEntityMapper::instance().unicode(s.index());

45 if (res)

46 {

47 const char *p = res;

48 while (*p)

49 {

50 switch(*p)

51 {

52 case '&': case '#':

53 break;

54 case 'x':

55 m_t << "\\u{";

56 break;

57 case ';':

58 m_t << "}";

59 break;

60 default:

61 m_t << *p;

62 break;

63 }

64 p++;

65 }

66 }

67 else

68 {

69 filter(s.name());

70 }

71}

References filter, DocEmoji::index, EmojiEntityMapper::instance, m_t, DocEmoji::name and EmojiEntityMapper::unicode.

operator()()

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

inline

Definition at line 42 of file textdocvisitor.h.

42 void operator()(const DocURL &u) { filter(u.url()); }

References filter and DocURL::url.

operator()()

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

inline

Definition at line 43 of file textdocvisitor.h.

43 void operator()(const DocLineBreak &) { m_t << " "; }

Reference m_t.

operator()()

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

inline

Definition at line 44 of file textdocvisitor.h.

44 void operator()(const DocHorRuler &) {}

operator()()

void TextDocVisitor::operator() (const DocStyleChange &)

inline

Definition at line 45 of file textdocvisitor.h.

45 void operator()(const DocStyleChange &) {}

operator()()

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

inline

Definition at line 46 of file textdocvisitor.h.

46 void operator()(const DocVerbatim &s) { filter(s.text()); }

References filter and DocVerbatim::text.

operator()()

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

inline

Definition at line 47 of file textdocvisitor.h.

47 void operator()(const DocAnchor &) {}

operator()()

void TextDocVisitor::operator() (const DocInclude &)

inline

Definition at line 48 of file textdocvisitor.h.

48 void operator()(const DocInclude &) {}

operator()()

void TextDocVisitor::operator() (const DocIncOperator &)

inline

Definition at line 49 of file textdocvisitor.h.

49 void operator()(const DocIncOperator &) {}

operator()()

void TextDocVisitor::operator() (const DocFormula &)

inline

Definition at line 50 of file textdocvisitor.h.

50 void operator()(const DocFormula &) {}

operator()()

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

inline

Definition at line 51 of file textdocvisitor.h.

51 void operator()(const DocIndexEntry &) {}

operator()()

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

inline

Definition at line 52 of file textdocvisitor.h.

52 void operator()(const DocSimpleSectSep &){}

operator()()

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

Declaration at line 53 of file textdocvisitor.h, definition at line 73 of file textdocvisitor.cpp.

73void TextDocVisitor::operator()(const DocCite &cite)

74{

75 if (!cite.file().isEmpty())

76 {

77 QCString anchor = cite.anchor();

78 QCString anchorPrefix = CitationManager::instance().anchorPrefix();

79 anchor = anchor.mid(anchorPrefix.length()); // strip prefix

80 m_t << anchor;

81 }

82 else

83 {

84 filter(cite.target());

85 }

86}

References DocCite::anchor, CitationManager::anchorPrefix, DocCite::file, filter, CitationManager::instance, QCString::isEmpty, QCString::length, m_t, QCString::mid and DocCite::target.

operator()()

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

inline

Definition at line 54 of file textdocvisitor.h.

54 void operator()(const DocSeparator &) { m_t << " "; }

Reference m_t.

operator()()

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

inline

Definition at line 68 of file textdocvisitor.h.

68 void operator()(const DocAutoList &l) { visitChildren(l); }

Reference visitChildren.

operator()()

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

inline

Definition at line 69 of file textdocvisitor.h.

69 void operator()(const DocAutoListItem &li) { visitChildren(li); }

Reference visitChildren.

operator()()

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

inline

Definition at line 70 of file textdocvisitor.h.

70 void operator()(const DocPara &p) { visitChildren(p); }

Reference visitChildren.

operator()()

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

inline

Definition at line 71 of file textdocvisitor.h.

71 void operator()(const DocRoot &r) { visitChildren(r); }

Reference visitChildren.

operator()()

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

inline

Definition at line 72 of file textdocvisitor.h.

72 void operator()(const DocSimpleSect &s) { visitChildren(s); }

Reference visitChildren.

operator()()

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

inline

Definition at line 73 of file textdocvisitor.h.

73 void operator()(const DocTitle &t) { visitChildren(t); }

Reference visitChildren.

operator()()

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

inline

Definition at line 74 of file textdocvisitor.h.

74 void operator()(const DocSimpleList &l) { visitChildren(l); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocSimpleListItem &)

inline

Definition at line 75 of file textdocvisitor.h.

75 void operator()(const DocSimpleListItem &) { }

operator()()

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

inline

Definition at line 76 of file textdocvisitor.h.

76 void operator()(const DocSection &s) { visitChildren(s); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocHtmlList & l)

inline

Definition at line 77 of file textdocvisitor.h.

77 void operator()(const DocHtmlList &l) { visitChildren(l); }

Reference visitChildren.

operator()()

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

inline

Definition at line 78 of file textdocvisitor.h.

78 void operator()(const DocHtmlListItem &li) { visitChildren(li); }

Reference visitChildren.

operator()()

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

inline

Definition at line 79 of file textdocvisitor.h.

79 void operator()(const DocHtmlDescList &dl) { visitChildren(dl); }

Reference visitChildren.

operator()()

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

inline

Definition at line 80 of file textdocvisitor.h.

80 void operator()(const DocHtmlDescTitle &dt) { visitChildren(dt); }

Reference visitChildren.

operator()()

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

inline

Definition at line 81 of file textdocvisitor.h.

81 void operator()(const DocHtmlDescData &dd) { visitChildren(dd); }

Reference visitChildren.

operator()()

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

inline

Definition at line 82 of file textdocvisitor.h.

82 void operator()(const DocHtmlTable &t) { visitChildren(t); }

Reference visitChildren.

operator()()

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

inline

Definition at line 83 of file textdocvisitor.h.

83 void operator()(const DocHtmlRow &r) { visitChildren(r); }

Reference visitChildren.

operator()()

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

inline

Definition at line 84 of file textdocvisitor.h.

84 void operator()(const DocHtmlCell &c) { visitChildren(c); }

Reference visitChildren.

operator()()

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

inline

Definition at line 85 of file textdocvisitor.h.

85 void operator()(const DocHtmlCaption &c) { visitChildren(c); }

Reference visitChildren.

operator()()

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

inline

Definition at line 86 of file textdocvisitor.h.

86 void operator()(const DocInternal &i) { visitChildren(i); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocHRef & h)

inline

Definition at line 87 of file textdocvisitor.h.

87 void operator()(const DocHRef &h) { visitChildren(h); }

Reference visitChildren.

operator()()

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

inline

Definition at line 88 of file textdocvisitor.h.

88 void operator()(const DocHtmlSummary &s) { visitChildren(s); }

Reference visitChildren.

operator()()

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

inline

Definition at line 89 of file textdocvisitor.h.

89 void operator()(const DocHtmlDetails &d) { visitChildren(d); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocHtmlHeader & h)

inline

Definition at line 90 of file textdocvisitor.h.

90 void operator()(const DocHtmlHeader &h) { visitChildren(h); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocImage & i)

inline

Definition at line 91 of file textdocvisitor.h.

91 void operator()(const DocImage &i) { visitChildren(i); }

Reference visitChildren.

operator()()

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

inline

Definition at line 92 of file textdocvisitor.h.

92 void operator()(const DocDotFile &df) { visitChildren(df); }

Reference visitChildren.

operator()()

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

inline

Definition at line 93 of file textdocvisitor.h.

93 void operator()(const DocMscFile &df) { visitChildren(df); }

Reference visitChildren.

operator()()

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

inline

Definition at line 94 of file textdocvisitor.h.

94 void operator()(const DocDiaFile &df) { visitChildren(df); }

Reference visitChildren.

operator()()

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

inline

Definition at line 95 of file textdocvisitor.h.

95 void operator()(const DocPlantUmlFile &df) { visitChildren(df); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocLink & l)

inline

Definition at line 96 of file textdocvisitor.h.

96 void operator()(const DocLink &l) { visitChildren(l); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocRef & r)

inline

Definition at line 97 of file textdocvisitor.h.

97 void operator()(const DocRef &r) { visitChildren(r); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocSecRefItem & s)

inline

Definition at line 98 of file textdocvisitor.h.

98 void operator()(const DocSecRefItem &s) { visitChildren(s); }

Reference visitChildren.

operator()()

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

inline

Definition at line 99 of file textdocvisitor.h.

99 void operator()(const DocSecRefList &l) { visitChildren(l); }

Reference visitChildren.

operator()()

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

inline

Definition at line 100 of file textdocvisitor.h.

100 void operator()(const DocParamSect &s) { visitChildren(s); }

Reference visitChildren.

operator()()

void TextDocVisitor::operator() (const DocParamList &)

inline

Definition at line 101 of file textdocvisitor.h.

101 void operator()(const DocParamList &) { }

operator()()

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

inline

Definition at line 102 of file textdocvisitor.h.

102 void operator()(const DocXRefItem &x) { visitChildren(x); }

Reference visitChildren.

operator()()

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

inline

Definition at line 103 of file textdocvisitor.h.

103 void operator()(const DocInternalRef &r) { visitChildren(r); }

Reference visitChildren.

operator()()

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

inline

Definition at line 104 of file textdocvisitor.h.

104 void operator()(const DocText &t) { visitChildren(t); }

Reference visitChildren.

operator()()

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

inline

Definition at line 105 of file textdocvisitor.h.

105 void operator()(const DocHtmlBlockQuote &q) { visitChildren(q); }

Reference visitChildren.

operator()()

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

inline

Definition at line 106 of file textdocvisitor.h.

106 void operator()(const DocVhdlFlow &) { }

operator()()

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

inline

Definition at line 107 of file textdocvisitor.h.

107 void operator()(const DocParBlock &pb) { visitChildren(pb); }

Reference visitChildren.

Public Member Functions

visitChildren()

template <class T>

void TextDocVisitor::visitChildren (const T & t)

inline

Definition at line 61 of file textdocvisitor.h.

61 void visitChildren(const T &t)

62 {

63 for (const auto &child : t.children())

64 {

65 std::visit(*this, child);

66 }

67 }

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

Private Member Functions

filter()

void TextDocVisitor::filter (const QCString & str)

Declaration at line 111 of file textdocvisitor.h, definition at line 88 of file textdocvisitor.cpp.

88void TextDocVisitor::filter(const QCString &str)

89{

90 if (str.isEmpty()) return;

91 //printf("TextDocVisitor::filter(%s)\n",str);

92 const char *p=str.data();

93 while (*p)

94 {

95 char c = *p++;

96 if (c=='\n') c=' ';

97 else m_t << c;

98 }

99}

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

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

Private Member Attributes

m_t

TextStream& TextDocVisitor::m_t

Definition at line 113 of file textdocvisitor.h.

113 TextStream &m_t;

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

---

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

• textdocvisitor.cpp
• textdocvisitor.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.