TextDocVisitor Class Reference

Concrete visitor implementation for TEXT output. More...

#include <src/textdocvisitor.h>

Inheritance diagram for TextDocVisitor:

Collaboration diagram for TextDocVisitor:

Public Member Functions
	TextDocVisitor (TextStream &t)
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 &)
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 &)
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 DocMermaidFile &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 inherited from DocVisitor
	DocVisitor ()
virtual	~DocVisitor ()
CodeParserInterface &	getCodeParser (const DString &langExt)
void	pushHidden (bool hide)
bool	popHidden ()

Private Member Functions
void	filter (const DString &str)

Private Attributes
TextStream &	m_t

Detailed Description

Concrete visitor implementation for TEXT output.

Definition at line 24 of file textdocvisitor.h.

Constructor & Destructor Documentation

TextDocVisitor()

TextDocVisitor::TextDocVisitor ( TextStream & t )

inline

Definition at line 27 of file textdocvisitor.h.

: m_t(t) {}

References m_t.

Member Function Documentation

filter()

void TextDocVisitor::filter ( const DString & str )

private

Definition at line 88 of file textdocvisitor.cpp.

{
  if (str.empty()) return;
  //printf("TextDocVisitor::filter(%s)\n",str);
  const char *p=str.data();
  while (*p)
  {
    char c = *p++;
    if (c=='\n') c=' ';
    else m_t << c;
  }
}

References DString::data(), DString::empty(), and m_t.

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

operator()() [1/59]

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

inline

Definition at line 43 of file textdocvisitor.h.

{}

operator()() [2/59]

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

inline

Definition at line 64 of file textdocvisitor.h.

{ visitChildren(l);  }

References visitChildren().

operator()() [3/59]

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

inline

Definition at line 65 of file textdocvisitor.h.

{ visitChildren(li); }

References visitChildren().

operator()() [4/59]

void TextDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 73 of file textdocvisitor.cpp.

{
  if (!cite.file().empty())
  {
    DString anchor = cite.anchor();
    DString anchorPrefix = CitationManager::instance().anchorPrefix();
    anchor = anchor.mid(anchorPrefix.length()); // strip prefix
    m_t << anchor;
  }
  else
  {
    filter(cite.target());
  }
}

References DocCite::anchor(), CitationManager::anchorPrefix(), DString::empty(), DocCite::file(), filter(), CitationManager::instance(), DString::length(), m_t, DString::mid(), and DocCite::target().

operator()() [5/59]

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

inline

Definition at line 90 of file textdocvisitor.h.

{ visitChildren(df); }

References visitChildren().

operator()() [6/59]

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

inline

Definition at line 88 of file textdocvisitor.h.

{ visitChildren(df); }

References visitChildren().

operator()() [7/59]

void TextDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 41 of file textdocvisitor.cpp.

{
  // the TextDocVisitor is only invoked for the JS part of the HTML output
  const char *res = EmojiEntityMapper::instance().unicode(s.index());
  if (res)
  {
    const char *p = res;
    while (*p)
    {
      switch(*p)
      {
        case '&': case '#':
          break;
        case 'x':
          m_t << "\\u{";
          break;
        case ';':
          m_t << "}";
          break;
        default:
          m_t << *p;
          break;
      }
      p++;
    }
  }
  else
  {
    filter(s.name());
  }
}

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

operator()() [8/59]

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

inline

Definition at line 46 of file textdocvisitor.h.

{}

operator()() [9/59]

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

inline

Definition at line 40 of file textdocvisitor.h.

{}

operator()() [10/59]

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

inline

Definition at line 83 of file textdocvisitor.h.

{ visitChildren(h);  }

References visitChildren().

operator()() [11/59]

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

inline

Definition at line 102 of file textdocvisitor.h.

{ visitChildren(q);  }

References visitChildren().

operator()() [12/59]

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

inline

Definition at line 81 of file textdocvisitor.h.

{ visitChildren(c);  }

References visitChildren().

operator()() [13/59]

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

inline

Definition at line 80 of file textdocvisitor.h.

{ visitChildren(c);  }

References visitChildren().

operator()() [14/59]

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

inline

Definition at line 77 of file textdocvisitor.h.

{ visitChildren(dd); }

References visitChildren().

operator()() [15/59]

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

inline

Definition at line 75 of file textdocvisitor.h.

{ visitChildren(dl); }

References visitChildren().

operator()() [16/59]

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

inline

Definition at line 76 of file textdocvisitor.h.

{ visitChildren(dt); }

References visitChildren().

operator()() [17/59]

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

inline

Definition at line 85 of file textdocvisitor.h.

{ visitChildren(d);  }

References visitChildren().

operator()() [18/59]

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

inline

Definition at line 86 of file textdocvisitor.h.

{ visitChildren(h);  }

References visitChildren().

operator()() [19/59]

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

inline

Definition at line 73 of file textdocvisitor.h.

{ visitChildren(l);  }

References visitChildren().

operator()() [20/59]

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

inline

Definition at line 74 of file textdocvisitor.h.

{ visitChildren(li); }

References visitChildren().

operator()() [21/59]

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

inline

Definition at line 79 of file textdocvisitor.h.

{ visitChildren(r);  }

References visitChildren().

operator()() [22/59]

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

inline

Definition at line 84 of file textdocvisitor.h.

{ visitChildren(s);  }

References visitChildren().

operator()() [23/59]

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

inline

Definition at line 78 of file textdocvisitor.h.

{ visitChildren(t);  }

References visitChildren().

operator()() [24/59]

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

inline

Definition at line 87 of file textdocvisitor.h.

{ visitChildren(i);  }

References visitChildren().

operator()() [25/59]

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

inline

Definition at line 44 of file textdocvisitor.h.

{}

operator()() [26/59]

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

inline

Definition at line 45 of file textdocvisitor.h.

{}

operator()() [27/59]

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

inline

Definition at line 47 of file textdocvisitor.h.

{}

operator()() [28/59]

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

inline

Definition at line 82 of file textdocvisitor.h.

{ visitChildren(i);  }

References visitChildren().

operator()() [29/59]

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

inline

Definition at line 100 of file textdocvisitor.h.

{ visitChildren(r);  }

References visitChildren().

operator()() [30/59]

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

inline

Definition at line 39 of file textdocvisitor.h.

{ m_t << " ";       }

References m_t.

operator()() [31/59]

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

inline

Definition at line 93 of file textdocvisitor.h.

{ visitChildren(l);  }

References visitChildren().

operator()() [32/59]

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

inline

Definition at line 34 of file textdocvisitor.h.

{ filter(w.word()); }

References filter(), and DocLinkedWord::word().

operator()() [33/59]

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

inline

Definition at line 92 of file textdocvisitor.h.

{ visitChildren(df); }

References visitChildren().

operator()() [34/59]

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

inline

Definition at line 89 of file textdocvisitor.h.

{ visitChildren(df); }

References visitChildren().

operator()() [35/59]

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

inline

Definition at line 66 of file textdocvisitor.h.

{ visitChildren(p);  }

References visitChildren().

operator()() [36/59]

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

inline

Definition at line 98 of file textdocvisitor.h.

{                    }

operator()() [37/59]

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

inline

Definition at line 97 of file textdocvisitor.h.

{ visitChildren(s);  }

References visitChildren().

operator()() [38/59]

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

inline

Definition at line 104 of file textdocvisitor.h.

{ visitChildren(pb); }

References visitChildren().

operator()() [39/59]

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

inline

Definition at line 91 of file textdocvisitor.h.

{ visitChildren(df); }

References visitChildren().

operator()() [40/59]

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

inline

Definition at line 94 of file textdocvisitor.h.

{ visitChildren(r);  }

References visitChildren().

operator()() [41/59]

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

inline

Definition at line 67 of file textdocvisitor.h.

{ visitChildren(r);  }

References visitChildren().

operator()() [42/59]

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

inline

Definition at line 95 of file textdocvisitor.h.

{ visitChildren(s);  }

References visitChildren().

operator()() [43/59]

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

inline

Definition at line 96 of file textdocvisitor.h.

{ visitChildren(l);  }

References visitChildren().

operator()() [44/59]

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

inline

Definition at line 72 of file textdocvisitor.h.

{ visitChildren(s);  }

References visitChildren().

operator()() [45/59]

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

inline

Definition at line 50 of file textdocvisitor.h.

{ m_t << " "; }

References m_t.

operator()() [46/59]

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

inline

Definition at line 70 of file textdocvisitor.h.

{ visitChildren(l);  }

References visitChildren().

operator()() [47/59]

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

inline

Definition at line 71 of file textdocvisitor.h.

{                    }

operator()() [48/59]

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

inline

Definition at line 68 of file textdocvisitor.h.

{ visitChildren(s);  }

References visitChildren().

operator()() [49/59]

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

inline

Definition at line 48 of file textdocvisitor.h.

{}

operator()() [50/59]

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

inline

Definition at line 41 of file textdocvisitor.h.

{}

operator()() [51/59]

void TextDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 28 of file textdocvisitor.cpp.

{
  const char *res = HtmlEntityMapper::instance().html(s.symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    err("text: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),true));
  }
}

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

operator()() [52/59]

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

inline

Definition at line 101 of file textdocvisitor.h.

{ visitChildren(t);  }

References visitChildren().

operator()() [53/59]

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

inline

Definition at line 69 of file textdocvisitor.h.

{ visitChildren(t);  }

References visitChildren().

operator()() [54/59]

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

inline

Definition at line 38 of file textdocvisitor.h.

{ filter(u.url());  }

References filter(), and DocURL::url().

operator()() [55/59]

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

inline

Definition at line 42 of file textdocvisitor.h.

{ filter(s.text()); }

References filter(), and DocVerbatim::text().

operator()() [56/59]

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

inline

Definition at line 103 of file textdocvisitor.h.

{                    }

operator()() [57/59]

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

inline

Definition at line 35 of file textdocvisitor.h.

{ m_t << " ";       }

References m_t.

operator()() [58/59]

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

inline

Definition at line 33 of file textdocvisitor.h.

{ filter(w.word()); }

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

operator()() [59/59]

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

inline

Definition at line 99 of file textdocvisitor.h.

{ visitChildren(x);  }

References visitChildren().

visitChildren()

template<class T>

void TextDocVisitor::visitChildren ( const T & t )

inline

Definition at line 57 of file textdocvisitor.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()(), and operator()().

Member Data Documentation

m_t

TextStream& TextDocVisitor::m_t

private

Definition at line 110 of file textdocvisitor.h.

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

---

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

• src/textdocvisitor.h
• src/textdocvisitor.cpp