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 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 &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 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 QCString &langExt)
void	pushHidden (bool hide)
bool	popHidden ()

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

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
bool	m_insidePre
bool	m_hide
bool	m_firstCol
int	m_indent
QCString	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 33 of file mandocvisitor.h.

Constructor & Destructor Documentation

ManDocVisitor()

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

Definition at line 32 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 FALSE, m_ci, m_firstCol, m_hide, m_indent, m_insidePre, m_langExt, and m_t.

Member Function Documentation

filter()

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

private

Definition at line 988 of file mandocvisitor.cpp.

{
  if (!str.isEmpty())
  {
    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;
        default: m_t << c; break;
      }
    }
  }
}

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

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

operator()() [1/58]

void ManDocVisitor::operator()

(

const DocAnchor &

)

Definition at line 253 of file mandocvisitor.cpp.

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

operator()() [2/58]

void ManDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 447 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/58]

void ManDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 456 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString 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, QCString::fill(), DocAutoList::isEnumList(), DocAutoListItem::itemNumber(), m_firstCol, m_hide, m_indent, m_t, DocNode::parent(), TRUE, DocAutoList::Unchecked, and visitChildren().

operator()() [4/58]

void ManDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 426 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\fB";
  if (cite.file().isEmpty()) m_t << "[";
  filter(cite.text());
  if (cite.file().isEmpty()) m_t << "]";
  m_t << "\\fP";
}

References DocCite::file(), filter(), QCString::isEmpty(), m_hide, m_t, and DocCite::text().

operator()() [5/58]

void ManDocVisitor::operator()

(

const DocDiaFile &

)

Definition at line 828 of file mandocvisitor.cpp.

{
}

operator()() [6/58]

void ManDocVisitor::operator()

(

const DocDotFile &

)

Definition at line 820 of file mandocvisitor.cpp.

{
}

operator()() [7/58]

void ManDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 90 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 FALSE, DocEmoji::index(), EmojiEntityMapper::instance(), m_firstCol, m_hide, m_t, DocEmoji::name(), and EmojiEntityMapper::name().

operator()() [8/58]

void ManDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 412 of file mandocvisitor.cpp.

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

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

operator()() [9/58]

void ManDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 119 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, m_t, and TRUE.

operator()() [10/58]

void ManDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 764 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/58]

void ManDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 963 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, TRUE, and visitChildren().

operator()() [12/58]

void ManDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 744 of file mandocvisitor.cpp.

{
  visitChildren(c);
}

References visitChildren().

operator()() [13/58]

void ManDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 754 of file mandocvisitor.cpp.

{
  visitChildren(c);
}

References visitChildren().

operator()() [14/58]

void ManDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 731 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, TRUE, and visitChildren().

operator()() [15/58]

void ManDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 710 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, TRUE, and visitChildren().

operator()() [16/58]

void ManDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 721 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 FALSE, m_firstCol, m_hide, m_t, and visitChildren().

operator()() [17/58]

void ManDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 779 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(), TRUE, and visitChildren().

operator()() [18/58]

void ManDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 804 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, TRUE, and visitChildren().

operator()() [19/58]

void ManDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 626 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/58]

void ManDocVisitor::operator()

(

const DocHtmlListItem &

li

)

Definition at line 655 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString 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 << integerToAlpha(m_listItemInfo[indent].number,false);
        break;
      case 'A':
        m_t << integerToAlpha(m_listItemInfo[indent].number);
        break;
      case 'i':
        m_t << integerToRoman(m_listItemInfo[indent].number,false);
        break;
      case 'I':
        m_t << 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(), QCString::fill(), integerToAlpha(), integerToRoman(), m_firstCol, m_hide, m_indent, m_listItemInfo, m_t, maxIndentLevels, DocHtmlList::Ordered, DocNode::parent(), TRUE, DocHtmlList::type(), and visitChildren().

operator()() [21/58]

void ManDocVisitor::operator()

(

const DocHtmlRow &

r

)

Definition at line 749 of file mandocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [22/58]

void ManDocVisitor::operator()

(

const DocHtmlSummary &

s

)

Definition at line 772 of file mandocvisitor.cpp.

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

References m_t, and visitChildren().

operator()() [23/58]

void ManDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 739 of file mandocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [24/58]

void ManDocVisitor::operator()

(

const DocImage &

)

Definition at line 816 of file mandocvisitor.cpp.

{
}

operator()() [25/58]

void ManDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 258 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(),
                                           inc.isExample(),
                                           inc.exampleFile(),
                                           fd.get(), // fileDef,
                                           -1,    // start line
                                           -1,    // end line
                                           FALSE, // inline fragment
                                           nullptr,     // memberDef
                                           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(),
                                        inc.isExample(),
                                        inc.exampleFile(),
                                        nullptr,     // fileDef
                                        -1,    // startLine
                                        -1,    // endLine
                                        TRUE,  // inlineFragment
                                        nullptr,     // memberDef
                                        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(), FALSE, 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, DocInclude::Snippet, DocInclude::SnippetWithLines, QCString::str(), DocInclude::stripCodeComments(), DocInclude::text(), DocInclude::trimLeft(), TRUE, DocInclude::type(), DocInclude::VerbInclude, and DocInclude::XmlInclude.

operator()() [26/58]

void ManDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 351 of file mandocvisitor.cpp.

{
  QCString locLangExt = getFileNameExtension(op.includeFileName());
  if (locLangExt.isEmpty()) 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().isEmpty())
      {
        FileInfo cfi( op.includeFileName().str() );
        fd = createFileDef( cfi.dirPath(), cfi.fileName() );
      }
 
      getCodeParser(locLangExt).parseCode(m_ci,op.context(),op.text(),langExt,
                                        op.stripCodeComments(),
                                        op.isExample(),op.exampleFile(),
                                        fd.get(),     // fileDef
                                        op.line(),    // startLine
                                        -1,    // endLine
                                        FALSE, // inline fragment
                                        nullptr,     // memberDef
                                        op.showLineNo()  // show line numbers
                                       );
    }
    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(), DocIncOperator::exampleFile(), FALSE, FileInfo::fileName(), DocVisitor::getCodeParser(), getFileNameExtension(), getLanguageFromFileName(), DocIncOperator::includeFileName(), QCString::isEmpty(), DocIncOperator::isExample(), DocIncOperator::isFirst(), DocIncOperator::isLast(), DocIncOperator::line(), m_ci, m_firstCol, m_hide, m_langExt, m_t, CodeParserInterface::parseCode(), DocVisitor::popHidden(), DocVisitor::pushHidden(), DocIncOperator::showLineNo(), DocIncOperator::Skip, QCString::str(), DocIncOperator::stripCodeComments(), DocIncOperator::text(), TRUE, and DocIncOperator::type().

operator()() [27/58]

void ManDocVisitor::operator()

(

const DocIndexEntry &

)

Definition at line 418 of file mandocvisitor.cpp.

{
}

operator()() [28/58]

void ManDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 759 of file mandocvisitor.cpp.

{
  visitChildren(i);
}

References visitChildren().

operator()() [29/58]

void ManDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 950 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/58]

void ManDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 112 of file mandocvisitor.cpp.

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

References m_firstCol, m_hide, m_t, and TRUE.

operator()() [31/58]

void ManDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 836 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/58]

void ManDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 50 of file mandocvisitor.cpp.

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

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

operator()() [33/58]

void ManDocVisitor::operator()

(

const DocMscFile &

)

Definition at line 824 of file mandocvisitor.cpp.

{
}

operator()() [34/58]

void ManDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 493 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(), TRUE, and visitChildren().

operator()() [35/58]

void ManDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 907 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 FALSE, DocParamList::isLast(), m_firstCol, m_hide, m_t, DocParamList::paragraphs(), DocParamList::parameters(), and TRUE.

operator()() [36/58]

void ManDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 876 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, TRUE, DocParamSect::type(), and visitChildren().

operator()() [37/58]

void ManDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 983 of file mandocvisitor.cpp.

{
  visitChildren(pb);
}

References visitChildren().

operator()() [38/58]

void ManDocVisitor::operator()

(

const DocPlantUmlFile &

)

Definition at line 832 of file mandocvisitor.cpp.

{
}

operator()() [39/58]

void ManDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 844 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()() [40/58]

void ManDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 509 of file mandocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [41/58]

void ManDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 853 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString 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 QCString::fill(), m_firstCol, m_hide, m_indent, m_t, TRUE, and visitChildren().

operator()() [42/58]

void ManDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 866 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()() [43/58]

void ManDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 610 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(), TRUE, and visitChildren().

operator()() [44/58]

void ManDocVisitor::operator()

(

const DocSeparator &

s

)

Definition at line 436 of file mandocvisitor.cpp.

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

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

operator()() [45/58]

void ManDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 582 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()() [46/58]

void ManDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 594 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString 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 QCString::fill(), m_firstCol, m_hide, m_indent, m_t, DocSimpleListItem::paragraph(), and TRUE.

operator()() [47/58]

void ManDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 514 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, FALSE, 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(), TRUE, DocSimpleSect::type(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, visitChildren(), and DocSimpleSect::Warning.

operator()() [48/58]

void ManDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 422 of file mandocvisitor.cpp.

{
}

operator()() [49/58]

void ManDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 127 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(), FALSE, 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, TRUE, DocStyleChange::Typewriter, and DocStyleChange::Underline.

operator()() [50/58]

void ManDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 74 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 FALSE, HtmlEntityMapper::instance(), m_firstCol, m_hide, m_t, HtmlEntityMapper::man(), and DocSymbol::symbol().

operator()() [51/58]

void ManDocVisitor::operator()

(

const DocText &

t

)

Definition at line 958 of file mandocvisitor.cpp.

{
  visitChildren(t);
}

References visitChildren().

operator()() [52/58]

void ManDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 576 of file mandocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [53/58]

void ManDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 105 of file mandocvisitor.cpp.

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

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

operator()() [54/58]

void ManDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 195 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  QCString lang = m_langExt;
  if (!s.language().isEmpty()) // 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),
                                        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:
      /* nothing */
      break;
  }
}

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

operator()() [55/58]

void ManDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 979 of file mandocvisitor.cpp.

{
}

operator()() [56/58]

void ManDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 59 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
  {
    m_t << " ";
    m_firstCol=FALSE;
  }
}

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

operator()() [57/58]

void ManDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 43 of file mandocvisitor.cpp.

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

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

operator()() [58/58]

void ManDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 929 of file mandocvisitor.cpp.

{
  if (m_hide) return;
  if (x.title().isEmpty()) 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().isEmpty()) return;
  if (!m_firstCol) m_t << "\n";
  m_t << ".RE\n";
  m_t << ".PP\n";
  m_firstCol=TRUE;
}

References filter(), QCString::isEmpty(), m_firstCol, m_hide, m_t, DocXRefItem::title(), TRUE, and visitChildren().

visitChildren()

template<class T>

void ManDocVisitor::visitChildren ( const T & t )

inlineprivate

Definition at line 108 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 127 of file mandocvisitor.h.

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

m_firstCol

bool ManDocVisitor::m_firstCol

private

Definition at line 130 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 129 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 131 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 128 of file mandocvisitor.h.

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

m_langExt

QCString ManDocVisitor::m_langExt

private

Definition at line 132 of file mandocvisitor.h.

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

m_listItemInfo

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

private

Definition at line 141 of file mandocvisitor.h.

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

m_t

TextStream& ManDocVisitor::m_t

private

Definition at line 126 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 139 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