ManDocVisitor Class Reference

Concrete visitor implementation for LaTeX output. More...

#include <src/mandocvisitor.h>

Inheritance diagram for ManDocVisitor:

Collaboration diagram for ManDocVisitor:

Classes
struct	ManListItemInfo

Public Member Functions
	ManDocVisitor (TextStream &t, OutputCodeList &ci, const DString &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 &s)
void	operator() (const DocHtmlList &s)
void	operator() (const DocHtmlListItem &)
void	operator() (const DocHtmlDescList &)
void	operator() (const DocHtmlDescTitle &)
void	operator() (const DocHtmlDescData &)
void	operator() (const DocHtmlTable &t)
void	operator() (const DocHtmlCaption &)
void	operator() (const DocHtmlRow &)
void	operator() (const DocHtmlCell &)
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 &lnk)
void	operator() (const DocRef &ref)
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 ()
CodeParserInterface &	getCodeParser (const DString &langExt)
void	pushHidden (bool hide)
bool	popHidden ()

Private Member Functions
template<class T>
void	visitChildren (const T &t)
void	filter (const DString &str, const bool retainNewline=false, const bool citeEntry=false)

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
bool	m_insidePre
bool	m_hide
bool	m_firstCol
int	m_indent
DString	m_langExt
std::array< ManListItemInfo, maxIndentLevels >	m_listItemInfo {}

Static Private Attributes
static const int	maxIndentLevels = 13

Detailed Description

Concrete visitor implementation for LaTeX output.

Definition at line 29 of file mandocvisitor.h.

Constructor & Destructor Documentation

ManDocVisitor()

ManDocVisitor::ManDocVisitor	(	TextStream &	t,
		OutputCodeList &	ci,
		const DString &	langExt )

Definition at line 36 of file mandocvisitor.cpp.

  : m_t(t), m_ci(ci), m_insidePre(false), m_hide(false), m_firstCol(false),
    m_indent(0), m_langExt(langExt)
{
}

References m_ci, m_firstCol, m_hide, m_indent, m_insidePre, m_langExt, and m_t.

Member Function Documentation

filter()

void ManDocVisitor::filter ( const DString & str, const bool retainNewline = false, const bool citeEntry = false )

private

Definition at line 1001 of file mandocvisitor.cpp.

{
  if (!str.empty())
  {
    const char *p=str.data();
    char c=0;
    bool insideDoubleQuote = false;
    while ((c=*p++))
    {
      switch(c)
      {
        case '.':  m_t << "\\&."; break; // see  bug652277
        case '\\': m_t << "\\\\"; break;
        case '\"': m_t << "\""; insideDoubleQuote = !insideDoubleQuote; break;
        case '\n': if (retainNewline || !insideDoubleQuote) m_t << c; break;
        case '&':  // possibility to have a special symbol
          if (!citeEntry) { m_t << c; break;}
          p = HtmlEntityMapper::instance().writeHtmlEntity(
              m_t,
              p-1,
              [](HtmlEntityMapper::SymType symType) { return HtmlEntityMapper::instance().man(symType); },
              "&");
          break;
        default: m_t << c; break;
      }
    }
  }
}

References DString::data(), DString::empty(), HtmlEntityMapper::instance(), m_t, HtmlEntityMapper::man(), and HtmlEntityMapper::writeHtmlEntity().

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

operator()() [1/59]

void ManDocVisitor::operator()

(

const DocAnchor &

)

Definition at line 262 of file mandocvisitor.cpp.

{
  /* no support for anchors in man pages */
}

operator()() [2/59]

void ManDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 456 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent++;
  visitChildren(l);
  m_indent--;
  m_t << ".PP\n";
}

References m_hide, m_indent, m_t, and visitChildren().

operator()() [3/59]

void ManDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 465 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  DString ws;
  if (m_indent>0) ws.fill(' ',2*(m_indent-1));
  if (!m_firstCol) m_t << "\n";
  m_t << ".IP \"" << ws;
  const DocAutoList *list = std::get_if<DocAutoList>(li.parent());
  if (list && list->isEnumList())
  {
    m_t << li.itemNumber() << ".\" " << (2*(m_indent+1));
  }
  else // bullet list
  {
    switch (li.itemNumber())
    {
      case DocAutoList::Unchecked: // unchecked
        m_t << "[ ]\" " << (2*m_indent) + 2;
        break;
      case DocAutoList::Checked_x: // checked with x
        m_t << "[x]\" " << (2*m_indent) + 2;
        break;
      case DocAutoList::Checked_X: // checked with X
        m_t << "[X]\" " << (2*m_indent) + 2;
        break;
      default:
        m_t << "\\(bu\" " << (2*m_indent);
        break;
    }
  }
  m_t << "\n";
  m_firstCol=true;
  visitChildren(li);
  m_t << "\n";
  m_firstCol=true;
}

References DocAutoList::Checked_X, DocAutoList::Checked_x, DString::fill(), DocAutoList::isEnumList(), DocAutoListItem::itemNumber(), m_firstCol, m_hide, m_indent, m_t, DocNode::parent(), DocAutoList::Unchecked, and visitChildren().

operator()() [4/59]

void ManDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 424 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  auto opt = cite.option();
  DString txt;
  if (!cite.file().empty())
  {
    txt = cite.getText();
    filter(txt, false, true);
  }
  else
  {
    if (!opt.noPar()) txt += "[";
    txt += cite.target();
    if (!opt.noPar()) txt += "]";
    filter(txt);
  }
  m_t << "\\fP";
}

References DString::empty(), DocCite::file(), filter(), DocCite::getText(), m_hide, m_t, DocCite::option(), and DocCite::target().

operator()() [5/59]

void ManDocVisitor::operator()

(

const DocDiaFile &

)

Definition at line 837 of file mandocvisitor.cpp.

{
}

operator()() [6/59]

void ManDocVisitor::operator()

(

const DocDotFile &

)

Definition at line 829 of file mandocvisitor.cpp.

{
}

operator()() [7/59]

void ManDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 97 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = EmojiEntityMapper::instance().name(s.index());
  if (res)
  {
    m_t << res;
  }
  else
  {
    m_t << s.name();
  }
  m_firstCol=false;
}

References DocEmoji::index(), EmojiEntityMapper::instance(), m_firstCol, m_hide, m_t, DocEmoji::name(), and EmojiEntityMapper::name().

operator()() [8/59]

void ManDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 410 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << f.text();
}

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

operator()() [9/59]

void ManDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 126 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << "\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References m_firstCol, m_hide, and m_t.

operator()() [10/59]

void ManDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 773 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fR";
  visitChildren(href);
  m_t << "\\fP";
}

References m_hide, m_t, and visitChildren().

operator()() [11/59]

void ManDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 976 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  {
    m_t << "\n";
    m_t << ".PP\n";
  }
  m_t << ".RS 4\n"; // TODO: add support for nested block quotes
  visitChildren(q);
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References m_firstCol, m_hide, m_t, and visitChildren().

operator()() [12/59]

void ManDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 753 of file mandocvisitor.cpp.

{
  visitChildren(c);
}

References visitChildren().

operator()() [13/59]

void ManDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 763 of file mandocvisitor.cpp.

{
  visitChildren(c);
}

References visitChildren().

operator()() [14/59]

void ManDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 740 of file mandocvisitor.cpp.

{
  if (!m_firstCol) m_t << "\n";
  m_t << ".IP \"\" 1c\n";
  m_firstCol=true;
  visitChildren(dd);
}

References m_firstCol, m_t, and visitChildren().

operator()() [15/59]

void ManDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 719 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent+=2;
  visitChildren(dl);
  m_indent-=2;
  if (!m_firstCol) m_t << "\n";
  m_t << "\n.PP\n";
  m_firstCol=true;
}

References m_firstCol, m_hide, m_indent, m_t, and visitChildren().

operator()() [16/59]

void ManDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 730 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << "\n";
  m_t << "\n.PP";
  m_t << "\n.IP \"\\fB";
  m_firstCol=false;
  visitChildren(dt);
}

References m_firstCol, m_hide, m_t, and visitChildren().

operator()() [17/59]

void ManDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 788 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  {
    m_t << "\n";
    m_t << ".PP\n";
  }
  auto summary = d.summary();
  if (summary)
  {
    std::visit(*this,*summary);
    m_t << ".PP\n";
    m_t << ".RS 4\n";
  }
  visitChildren(d);
  if (!m_firstCol) m_t << "\n";
  if (summary)
  {
    m_t << ".RE\n";
  }
  m_t << ".PP\n";
  m_firstCol=true;
}

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

operator()() [18/59]

void ManDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 813 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << "\n";
  if (header.level()==1) m_t << ".SH"; else m_t << ".SS";
  m_t << " \"";
  visitChildren(header);
  m_t << "\"\n";
  if (header.level()==1) m_t << ".PP\n";
  m_firstCol=true;
}

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

operator()() [19/59]

void ManDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 635 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent++;
  if (!m_firstCol) m_t << "\n";
  m_t << ".PD 0\n";
  m_firstCol=true;
  int indent = std::min(m_indent,maxIndentLevels-1);
  m_listItemInfo[indent].number = 1;
  m_listItemInfo[indent].type   = '1';
  for (const auto &opt : l.attribs())
  {
    if (opt.name=="type")
    {
      m_listItemInfo[indent].type = opt.value[0];
    }
    if (opt.name=="start")
    {
      bool ok = false;
      int val = opt.value.toInt(&ok);
      if (ok) m_listItemInfo[indent].number = val;
    }
  }
  visitChildren(l);
  m_indent--;
  if (!m_firstCol) m_t << "\n";
  m_t << ".PP\n";
}

References DocHtmlList::attribs(), m_firstCol, m_hide, m_indent, m_listItemInfo, m_t, maxIndentLevels, and visitChildren().

operator()() [20/59]

void ManDocVisitor::operator()

(

const DocHtmlListItem &

li

)

Definition at line 664 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  DString ws;
  if (m_indent>0) ws.fill(' ',2*(m_indent-1));
  if (!m_firstCol) m_t << "\n";
  m_t << ".IP \"" << ws;
  const DocHtmlList *list = std::get_if<DocHtmlList>(li.parent());
  if (list && list->type()==DocHtmlList::Ordered)
  {
    int indent = std::min(m_indent,maxIndentLevels-1);
    for (const auto &opt : li.attribs())
    {
      if (opt.name=="value")
      {
        bool ok = false;
        int val = opt.value.toInt(&ok);
        if (ok) m_listItemInfo[indent].number = val;
      }
    }
    switch (m_listItemInfo[indent].type)
    {
      case '1':
        m_t << m_listItemInfo[indent].number;
        break;
      case 'a':
        m_t << DString::integerToAlpha(m_listItemInfo[indent].number,false);
        break;
      case 'A':
        m_t << DString::integerToAlpha(m_listItemInfo[indent].number);
        break;
      case 'i':
        m_t << DString::integerToRoman(m_listItemInfo[indent].number,false);
        break;
      case 'I':
        m_t << DString::integerToRoman(m_listItemInfo[indent].number);
        break;
      default:
        m_t << m_listItemInfo[indent].number;
        break;
    }
    m_t << ".\" " << ((m_indent+1)*2);
    m_listItemInfo[indent].number++;
  }
  else // bullet list
  {
    m_t << "\\(bu\" " << (m_indent*2);
  }
  m_t << "\n";
  m_firstCol=true;
  visitChildren(li);
  m_t << "\n";
  m_firstCol=true;
}

References DocHtmlListItem::attribs(), DString::fill(), DString::integerToAlpha(), DString::integerToRoman(), m_firstCol, m_hide, m_indent, m_listItemInfo, m_t, maxIndentLevels, DocHtmlList::Ordered, DocNode::parent(), DocHtmlList::type(), and visitChildren().

operator()() [21/59]

void ManDocVisitor::operator()

(

const DocHtmlRow &

r

)

Definition at line 758 of file mandocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [22/59]

void ManDocVisitor::operator()

(

const DocHtmlSummary &

s

)

Definition at line 781 of file mandocvisitor.cpp.

{
  m_t << "\\fB";
  visitChildren(s);
  m_t << "\\fP\n.PP\n";
}

References m_t, and visitChildren().

operator()() [23/59]

void ManDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 748 of file mandocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [24/59]

void ManDocVisitor::operator()

(

const DocImage &

)

Definition at line 825 of file mandocvisitor.cpp.

{
}

operator()() [25/59]

void ManDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 267 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc.extension());
  switch(inc.type())
  {
    case DocInclude::IncWithLines:
      {
         if (!m_firstCol) m_t << "\n";
         m_t << ".PP\n";
         m_t << ".nf\n";
         FileInfo cfi( inc.file().str() );
         auto fd = createFileDef( cfi.dirPath(), cfi.fileName() );
         getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
                                                  inc.text(),
                                                  langExt,
                                                  inc.stripCodeComments(),
                                                  CodeParserOptions()
                                                  .setExample(inc.isExample(),inc.exampleFile())
                                                  .setFileDef(fd.get())
                                                  .setInlineFragment(true)
                                                 );
         m_t << ".fi\n";
         m_t << ".PP\n";
         m_firstCol=true;
      }
      break;
    case DocInclude::Include:
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
      getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
                                               inc.text(),
                                               langExt,
                                               inc.stripCodeComments(),
                                               CodeParserOptions()
                                               .setExample(inc.isExample(),inc.exampleFile())
                                               .setInlineFragment(true)
                                               .setShowLineNumbers(false)
                                              );
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
      break;
    case DocInclude::DontInclude:
    case DocInclude::DontIncWithLines:
    case DocInclude::HtmlInclude:
    case DocInclude::LatexInclude:
    case DocInclude::RtfInclude:
    case DocInclude::XmlInclude:
    case DocInclude::DocbookInclude:
      break;
    case DocInclude::ManInclude:
      m_t << inc.text();
      break;
    case DocInclude::VerbInclude:
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
      m_t << inc.text();
      if (!m_firstCol) m_t << "\n";
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
      break;
    case DocInclude::Snippet:
    case DocInclude::SnippetWithLines:
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
      CodeFragmentManager::instance().parseCodeFragment(m_ci,
                                                        inc.file(),
                                                        inc.blockId(),
                                                        inc.context(),
                                                        inc.type()==DocInclude::SnippetWithLines,
                                                        inc.trimLeft(),
                                                        inc.stripCodeComments()
                                                       );
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
      break;
  }
}

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

operator()() [26/59]

void ManDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 352 of file mandocvisitor.cpp.

{
  DString locLangExt = getFileNameExtension(op.includeFileName());
  if (locLangExt.empty()) locLangExt = m_langExt;
  SrcLangExt langExt = getLanguageFromFileName(locLangExt);
  //printf("DocIncOperator: type=%d first=%d, last=%d text='%s'\n",
  //    op.type(),op.isFirst(),op.isLast(),qPrint(op.text()));
  if (op.isFirst())
  {
    if (!m_hide)
    {
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
    }
    pushHidden(m_hide);
    m_hide = true;
  }
  if (op.type()!=DocIncOperator::Skip)
  {
    m_hide = popHidden();
    if (!m_hide)
    {
      std::unique_ptr<FileDef> fd;
      if (!op.includeFileName().empty())
      {
        FileInfo cfi( op.includeFileName().str() );
        fd = createFileDef( cfi.dirPath(), cfi.fileName() );
      }
 
      getCodeParser(locLangExt).parseCode(m_ci,op.context(),op.text(),langExt,
                                          op.stripCodeComments(),
                                          CodeParserOptions()
                                          .setExample(op.isExample(),op.exampleFile())
                                          .setFileDef(fd.get())
                                          .setShowLineNumbers(op.showLineNo())
                                         );
    }
    pushHidden(m_hide);
    m_hide=true;
  }
  if (op.isLast())
  {
    m_hide = popHidden();
    if (!m_hide)
    {
      if (!m_firstCol) m_t << "\n";
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
    }
  }
  else
  {
    if (!m_hide) m_t << "\n";
  }
}

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

operator()() [27/59]

void ManDocVisitor::operator()

(

const DocIndexEntry &

)

Definition at line 416 of file mandocvisitor.cpp.

{
}

operator()() [28/59]

void ManDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 768 of file mandocvisitor.cpp.

{
  visitChildren(i);
}

References visitChildren().

operator()() [29/59]

void ManDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 963 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  visitChildren(ref);
  m_t << "\\fP";
}

References m_hide, m_t, and visitChildren().

operator()() [30/59]

void ManDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 119 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\n.br\n";
  m_firstCol=true;
}

References m_firstCol, m_hide, and m_t.

operator()() [31/59]

void ManDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 849 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  visitChildren(dl);
  m_t << "\\fP";
}

References m_hide, m_t, and visitChildren().

operator()() [32/59]

void ManDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 54 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  filter(w.word());
  m_t << "\\fP";
  m_firstCol=false;
}

References filter(), m_firstCol, m_hide, m_t, and DocLinkedWord::word().

operator()() [33/59]

void ManDocVisitor::operator()

(

const DocMermaidFile &

)

Definition at line 845 of file mandocvisitor.cpp.

{
}

operator()() [34/59]

void ManDocVisitor::operator()

(

const DocMscFile &

)

Definition at line 833 of file mandocvisitor.cpp.

{
}

operator()() [35/59]

void ManDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 502 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  visitChildren(p);
  if (!p.isLast() &&            // omit <p> for last paragraph
      !(p.parent() &&           // and for parameter sections
        std::get_if<DocParamSect>(p.parent())
       )
     )
  {
    if (!m_firstCol) m_t << "\n";
    m_t << "\n.PP\n";
    m_firstCol=true;
  }
}

References DocPara::isLast(), m_firstCol, m_hide, m_t, DocNode::parent(), and visitChildren().

operator()() [36/59]

void ManDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 920 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fI";
  bool first=true;
  for (const auto &param : pl.parameters())
  {
    if (!first) m_t << ","; else first=false;
    std::visit(*this,param);
  }
  m_t << "\\fP ";
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  if (!pl.isLast())
  {
    if (!m_firstCol) m_t << "\n";
    m_t << ".br\n";
  }
}

References DocParamList::isLast(), m_firstCol, m_hide, m_t, DocParamList::paragraphs(), and DocParamList::parameters().

operator()() [37/59]

void ManDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 889 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  {
    m_t << "\n";
    m_t << ".PP\n";
  }
  m_t << "\\fB";
  switch(s.type())
  {
    case DocParamSect::Param:
      m_t << theTranslator->trParameters(); break;
    case DocParamSect::RetVal:
      m_t << theTranslator->trReturnValues(); break;
    case DocParamSect::Exception:
      m_t << theTranslator->trExceptions(); break;
    case DocParamSect::TemplateParam:
      m_t << theTranslator->trTemplateParameters(); break;
    default:
      ASSERT(0);
  }
  m_t << "\\fP\n";
  m_t << ".RS 4\n";
  visitChildren(s);
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References ASSERT, DocParamSect::Exception, m_firstCol, m_hide, m_t, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, theTranslator, Translator::trExceptions(), Translator::trParameters(), Translator::trReturnValues(), Translator::trTemplateParameters(), DocParamSect::type(), and visitChildren().

operator()() [38/59]

void ManDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 996 of file mandocvisitor.cpp.

{
  visitChildren(pb);
}

References visitChildren().

operator()() [39/59]

void ManDocVisitor::operator()

(

const DocPlantUmlFile &

)

Definition at line 841 of file mandocvisitor.cpp.

{
}

operator()() [40/59]

void ManDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 857 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  if (!ref.hasLinkText()) filter(ref.targetTitle());
  visitChildren(ref);
  m_t << "\\fP";
}

References filter(), DocRef::hasLinkText(), m_hide, m_t, DocRef::targetTitle(), and visitChildren().

operator()() [41/59]

void ManDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 518 of file mandocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [42/59]

void ManDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 866 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  DString ws;
  if (m_indent>0) ws.fill(' ',2*(m_indent-1));
  if (!m_firstCol) m_t << "\n";
  m_t << ".IP \"" << ws << "\\(bu\" " << (2*m_indent) << "\n";
  m_firstCol=true;
  visitChildren(ref);
  m_t << "\n";
  m_firstCol=true;
}

References DString::fill(), m_firstCol, m_hide, m_indent, m_t, and visitChildren().

operator()() [43/59]

void ManDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 879 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent++;
  visitChildren(l);
  m_indent--;
  if (!m_firstCol) m_t << "\n";
  m_t << ".PP\n";
}

References m_firstCol, m_hide, m_indent, m_t, and visitChildren().

operator()() [44/59]

void ManDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 619 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol) m_t << "\n";
  if (s.level()==1) m_t << ".SH"; else m_t << ".SS";
  m_t << " \"";
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  m_t << "\"\n";
  if (s.level()==1) m_t << ".PP\n";
  m_firstCol=true;
  visitChildren(s);
}

References DocSection::level(), m_firstCol, m_hide, m_t, DocSection::title(), and visitChildren().

operator()() [45/59]

void ManDocVisitor::operator()

(

const DocSeparator &

s

)

Definition at line 445 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << s.chars();
}

References DocSeparator::chars(), m_hide, and m_t.

operator()() [46/59]

void ManDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 591 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_indent++;
  if (!m_firstCol) m_t << "\n";
  m_t << ".PD 0\n";
  m_firstCol=true;
  visitChildren(l);
  m_indent--;
  m_t << ".PP\n";
}

References m_firstCol, m_hide, m_indent, m_t, and visitChildren().

operator()() [47/59]

void ManDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 603 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  DString ws;
  if (m_indent>0) ws.fill(' ',2*(m_indent-1));
  if (!m_firstCol) m_t << "\n";
  m_t << ".IP \"" << ws << "\\(bu\" " << m_indent << "\n";
  m_firstCol=true;
  if (li.paragraph())
  {
    visit(*this,*li.paragraph());
  }
  m_t << "\n";
  m_firstCol=true;
}

References DString::fill(), m_firstCol, m_hide, m_indent, m_t, and DocSimpleListItem::paragraph().

operator()() [48/59]

void ManDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 523 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (!m_firstCol)
  {
    m_t << "\n";
    m_t << ".PP\n";
  }
  m_t << "\\fB";
  switch(s.type())
  {
    case DocSimpleSect::See:
      m_t << theTranslator->trSeeAlso(); break;
    case DocSimpleSect::Return:
      m_t << theTranslator->trReturns(); break;
    case DocSimpleSect::Author:
      m_t << theTranslator->trAuthor(true,true); break;
    case DocSimpleSect::Authors:
      m_t << theTranslator->trAuthor(true,false); break;
    case DocSimpleSect::Version:
      m_t << theTranslator->trVersion(); break;
    case DocSimpleSect::Since:
      m_t << theTranslator->trSince(); break;
    case DocSimpleSect::Date:
      m_t << theTranslator->trDate(); break;
    case DocSimpleSect::Note:
      m_t << theTranslator->trNote(); break;
    case DocSimpleSect::Warning:
      m_t << theTranslator->trWarning(); break;
    case DocSimpleSect::Pre:
      m_t << theTranslator->trPrecondition(); break;
    case DocSimpleSect::Post:
      m_t << theTranslator->trPostcondition(); break;
    case DocSimpleSect::Copyright:
      m_t << theTranslator->trCopyright(); break;
    case DocSimpleSect::Invar:
      m_t << theTranslator->trInvariant(); break;
    case DocSimpleSect::Remark:
      m_t << theTranslator->trRemarks(); break;
    case DocSimpleSect::Attention:
      m_t << theTranslator->trAttention(); break;
    case DocSimpleSect::Important:
      m_t << theTranslator->trImportant(); break;
    case DocSimpleSect::User: break;
    case DocSimpleSect::Rcs: break;
    case DocSimpleSect::Unknown:  break;
  }
 
  // special case 1: user defined title
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  m_t << "\\fP\n";
  m_t << ".RS 4\n";
  visitChildren(s);
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, DocSimpleSect::Important, DocSimpleSect::Invar, m_firstCol, m_hide, m_t, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, theTranslator, DocSimpleSect::title(), Translator::trAttention(), Translator::trAuthor(), Translator::trCopyright(), Translator::trDate(), Translator::trImportant(), Translator::trInvariant(), Translator::trNote(), Translator::trPostcondition(), Translator::trPrecondition(), Translator::trRemarks(), Translator::trReturns(), Translator::trSeeAlso(), Translator::trSince(), Translator::trVersion(), Translator::trWarning(), DocSimpleSect::type(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren(), and DocSimpleSect::Warning.

operator()() [49/59]

void ManDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 420 of file mandocvisitor.cpp.

{
}

operator()() [50/59]

void ManDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 134 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  switch (s.style())
  {
    case DocStyleChange::Bold:
      if (s.enable()) m_t << "\\fB";      else m_t << "\\fP";
      m_firstCol=false;
      break;
    case DocStyleChange::S:
    case DocStyleChange::Strike:
    case DocStyleChange::Del:
      /* not supported */
      break;
    case DocStyleChange::Underline: //underline is shown as emphasis
    case DocStyleChange::Ins:
      if (s.enable()) m_t << "\\fI";     else m_t << "\\fP";
      m_firstCol=false;
      break;
    case DocStyleChange::Italic:
      if (s.enable()) m_t << "\\fI";     else m_t << "\\fP";
      m_firstCol=false;
      break;
    case DocStyleChange::Kbd:
    case DocStyleChange::Typewriter:
    case DocStyleChange::Code:
      if (s.enable()) m_t << "\\fR";   else m_t << "\\fP";
      m_firstCol=false;
      break;
    case DocStyleChange::Subscript:
      if (s.enable()) m_t << "\\*<";    else m_t << "\\*> ";
      m_firstCol=false;
      break;
    case DocStyleChange::Superscript:
      if (s.enable()) m_t << "\\*{";    else m_t << "\\*} ";
      m_firstCol=false;
      break;
    case DocStyleChange::Center:
      /* not supported */
      break;
    case DocStyleChange::Small:
      /* not supported */
      break;
    case DocStyleChange::Cite:
      /* not supported */
      break;
    case DocStyleChange::Preformatted:
      if (s.enable())
      {
        if (!m_firstCol) m_t << "\n";
        m_t << ".PP\n";
        m_t << ".nf\n";
        m_insidePre=true;
      }
      else
      {
        m_insidePre=false;
        if (!m_firstCol) m_t << "\n";
        m_t << ".fi\n";
        m_t << ".PP\n";
        m_firstCol=true;
      }
      break;
    case DocStyleChange::Div:  /* HTML only */ break;
    case DocStyleChange::Span: /* HTML only */ break;
  }
}

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, m_firstCol, m_hide, m_insidePre, m_t, 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 ManDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 81 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  const char *res = HtmlEntityMapper::instance().man(s.symbol());
  if (res)
  {
    m_t << res;
  }
  else
  {
    // no error or warning to be supplied
    // err("man: non supported HTML-entity found: &{};\n",get_symbol_item(s->symbol()));
  }
  m_firstCol=false;
}

References HtmlEntityMapper::instance(), m_firstCol, m_hide, m_t, HtmlEntityMapper::man(), and DocSymbol::symbol().

operator()() [52/59]

void ManDocVisitor::operator()

(

const DocText &

t

)

Definition at line 971 of file mandocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [53/59]

void ManDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 585 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  visitChildren(t);
}

References m_hide, and visitChildren().

operator()() [54/59]

void ManDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 112 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << u.url();
  m_firstCol=false;
}

References m_firstCol, m_hide, m_t, and DocURL::url().

operator()() [55/59]

void ManDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 202 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  DString lang = m_langExt;
  if (!s.language().empty()) // explicit language setting
  {
    lang = s.language();
  }
  SrcLangExt langExt = getLanguageFromCodeLang(lang);
  switch (s.type())
  {
    case DocVerbatim::Code:
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
      getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),
                                    langExt,
                                    Config_getBool(STRIP_CODE_COMMENTS),
                                    CodeParserOptions().setExample(s.isExample(),s.exampleFile())
                                   );
      if (!m_firstCol) m_t << "\n";
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
      break;
    case DocVerbatim::JavaDocLiteral:
      filter(s.text(),true);
      break;
    case DocVerbatim::JavaDocCode:
      m_t << "\\fR\n";
      filter(s.text(),true);
      m_t << "\\fP\n";
      break;
    case DocVerbatim::Verbatim:
      if (!m_firstCol) m_t << "\n";
      m_t << ".PP\n";
      m_t << ".nf\n";
      filter(s.text(),true);
      if (!m_firstCol) m_t << "\n";
      m_t << ".fi\n";
      m_t << ".PP\n";
      m_firstCol=true;
      break;
    case DocVerbatim::ManOnly:
      m_t << s.text();
      break;
    case DocVerbatim::HtmlOnly:
    case DocVerbatim::XmlOnly:
    case DocVerbatim::LatexOnly:
    case DocVerbatim::RtfOnly:
    case DocVerbatim::DocbookOnly:
    case DocVerbatim::Dot:
    case DocVerbatim::Msc:
    case DocVerbatim::PlantUML:
    case DocVerbatim::Mermaid:
      /* nothing */
      break;
  }
}

References DocVerbatim::Code, Config_getBool, DocVerbatim::context(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, DString::empty(), DocVerbatim::exampleFile(), filter(), DocVisitor::getCodeParser(), getLanguageFromCodeLang(), DocVerbatim::HtmlOnly, DocVerbatim::isExample(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, m_ci, m_firstCol, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, DocVerbatim::RtfOnly, DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, and DocVerbatim::XmlOnly.

operator()() [56/59]

void ManDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 992 of file mandocvisitor.cpp.

{
}

operator()() [57/59]

void ManDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 63 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w.chars();
    m_firstCol=w.chars().at(w.chars().length()-1)=='\n';
  }
  else if (!m_firstCol)
  {
    m_t << " ";
  }
  else
  {
    m_firstCol=false;
  }
}

References DString::at(), DocWhiteSpace::chars(), DString::length(), m_firstCol, m_hide, m_insidePre, and m_t.

operator()() [58/59]

void ManDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 47 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  filter(w.word());
  m_firstCol=false;
}

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

operator()() [59/59]

void ManDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 942 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (x.title().empty()) return;
  if (!m_firstCol)
  {
    m_t << "\n";
    m_t << ".PP\n";
  }
  m_t << "\\fB";
  filter(x.title());
  m_t << "\\fP\n";
  m_t << ".RS 4\n";
  visitChildren(x);
  if (x.title().empty()) return;
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=true;
}

References DString::empty(), filter(), m_firstCol, m_hide, m_t, DocXRefItem::title(), and visitChildren().

visitChildren()

template<class T>

void ManDocVisitor::visitChildren ( const T & t )

inlineprivate

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

Member Data Documentation

m_ci

OutputCodeList& ManDocVisitor::m_ci

private

Definition at line 124 of file mandocvisitor.h.

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

m_firstCol

bool ManDocVisitor::m_firstCol

private

Definition at line 127 of file mandocvisitor.h.

Referenced by ManDocVisitor(), 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()().

m_hide

bool ManDocVisitor::m_hide

private

Definition at line 126 of file mandocvisitor.h.

Referenced by ManDocVisitor(), 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()().

m_indent

int ManDocVisitor::m_indent

private

Definition at line 128 of file mandocvisitor.h.

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

m_insidePre

bool ManDocVisitor::m_insidePre

private

Definition at line 125 of file mandocvisitor.h.

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

m_langExt

DString ManDocVisitor::m_langExt

private

Definition at line 129 of file mandocvisitor.h.

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

m_listItemInfo

std::array<ManListItemInfo,maxIndentLevels> ManDocVisitor::m_listItemInfo {}

private

Definition at line 138 of file mandocvisitor.h.

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

m_t

TextStream& ManDocVisitor::m_t

private

Definition at line 123 of file mandocvisitor.h.

Referenced by filter(), ManDocVisitor(), 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()().

maxIndentLevels

const int ManDocVisitor::maxIndentLevels = 13

staticprivate

Definition at line 136 of file mandocvisitor.h.

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

---

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

• src/mandocvisitor.h
• src/mandocvisitor.cpp