DocbookDocVisitor Class Reference

Concrete visitor implementation for Docbook output. More...

#include <src/docbookvisitor.h>

Inheritance diagram for DocbookDocVisitor:

Collaboration diagram for DocbookDocVisitor:

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

Private Member Functions
void	filter (const QCString &str, const bool retainNewLine=false)
void	startLink (const QCString &file, const QCString &anchor)
void	endLink ()
void	startMscFile (const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine, bool newFile=true)
void	endMscFile (bool hasCaption)
void	writeMscFile (const QCString &fileName, const DocVerbatim &s, bool newFile=true)
void	startDiaFile (const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine, bool newFile=true)
void	endDiaFile (bool hasCaption)
void	writeDiaFile (const QCString &fileName, const DocVerbatim &s)
void	startDotFile (const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine, bool newFile=true)
void	endDotFile (bool hasCaption)
void	writeDotFile (const QCString &fileName, const DocVerbatim &s, bool newFile=true)
void	writePlantUMLFile (const QCString &fileName, const DocVerbatim &s)
void	startPlantUmlFile (const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
void	endPlantUmlFile (bool hasCaption)
void	writeMermaidFile (const QCString &fileName, const DocVerbatim &s)
void	startMermaidFile (const QCString &fileName, const QCString &relPath, const QCString &width, const QCString &height, bool hasCaption, const DocNodeList &children, const QCString &srcFile, int srcLine)
void	endMermaidFile (bool hasCaption)
void	visitPreStart (TextStream &t, const DocNodeList &children, bool hasCaption, const QCString &name, const QCString &width, const QCString &height, bool inlineImage=FALSE)
void	visitPostEnd (TextStream &t, bool hasCaption, bool inlineImage=FALSE)
void	visitCaption (const DocNodeList &children)

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
bool	m_insidePre = false
bool	m_hide = false
BoolStack	m_enabled
QCString	m_langExt
int	m_colCnt = 0
BoolStack	m_bodySet

Detailed Description

Concrete visitor implementation for Docbook output.

Definition at line 31 of file docbookvisitor.h.

Constructor & Destructor Documentation

DocbookDocVisitor()

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

Definition at line 156 of file docbookvisitor.cpp.

  : m_t(t), m_ci(ci),m_langExt(langExt)
{
DB_VIS_C
  // m_t << "<section>\n";
}

References DB_VIS_C, m_ci, m_langExt, and m_t.

Member Function Documentation

endDiaFile()

void DocbookDocVisitor::endDiaFile ( bool hasCaption )

private

Definition at line 1725 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  visitPostEnd(m_t, hasCaption);
  m_t << "</para>\n";
}

References DB_VIS_C, m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endDotFile()

void DocbookDocVisitor::endDotFile ( bool hasCaption )

private

Definition at line 1764 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  visitPostEnd(m_t, hasCaption);
  m_t << "</para>\n";
}

References DB_VIS_C, m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endLink()

void DocbookDocVisitor::endLink ( )

private

Definition at line 1554 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_t << "</link>";
}

References DB_VIS_C, and m_t.

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

endMermaidFile()

void DocbookDocVisitor::endMermaidFile ( bool hasCaption )

private

Definition at line 1659 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  visitPostEnd(m_t, hasCaption);
  m_t << "</para>\n";
}

References DB_VIS_C, m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endMscFile()

void DocbookDocVisitor::endMscFile ( bool hasCaption )

private

Definition at line 1687 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  visitPostEnd(m_t, hasCaption);
  m_t << "</para>\n";
}

References DB_VIS_C, m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endPlantUmlFile()

void DocbookDocVisitor::endPlantUmlFile ( bool hasCaption )

private

Definition at line 1610 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  visitPostEnd(m_t, hasCaption);
  m_t << "</para>\n";
}

References DB_VIS_C, m_hide, m_t, and visitPostEnd().

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

filter()

void DocbookDocVisitor::filter ( const QCString & str, const bool retainNewLine = false )

private

Definition at line 1536 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_t << convertToDocBook(str, retainNewLine);
}

References convertToDocBook(), DB_VIS_C, and m_t.

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

operator()() [1/59]

void DocbookDocVisitor::operator()

(

const DocAnchor &

anc

)

Definition at line 419 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<anchor xml:id=\"_" <<  stripPath(anc.file()) << "_1" << filterId(anc.anchor()) << "\"/>";
}

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

operator()() [2/59]

void DocbookDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 600 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (l.isEnumList())
  {
    m_t << "<orderedlist>\n";
  }
  else
  {
    m_t << "<itemizedlist>\n";
  }
  visitChildren(l);
  if (l.isEnumList())
  {
    m_t << "</orderedlist>\n";
  }
  else
  {
    m_t << "</itemizedlist>\n";
  }
}

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

operator()() [3/59]

void DocbookDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 623 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  switch (li.itemNumber())
  {
    case DocAutoList::Unchecked: // unchecked
      m_t << "<listitem override=\"unchecked\">";
      break;
    case DocAutoList::Checked_x: // checked with x
    case DocAutoList::Checked_X: // checked with X
      m_t << "<listitem override=\"checked\">";
      break;
    default:
      m_t << "<listitem>";
      break;
  }
  visitChildren(li);
  m_t << "</listitem>";
}

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

operator()() [4/59]

void DocbookDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 573 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  auto opt = cite.option();
  if (!cite.file().isEmpty())
  {
    if (!opt.noCite()) startLink(cite.file(),filterId(cite.anchor()));
 
    filter(cite.getText());
 
    if (!opt.noCite()) endLink();
  }
  else
  {
    if (!opt.noPar()) filter("[");
    filter(cite.target());
    if (!opt.noPar()) filter("]");
 
  }
 
}

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

operator()() [5/59]

void DocbookDocVisitor::operator()

(

const DocDiaFile &

df

)

Definition at line 1276 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeFileContents(Config_getString(DOCBOOK_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                      ".dia",                                                        // extension
                                      inBuf,                                                         // contents
                                      exists);
    if (!fileName.isEmpty())
    {
      startDiaFile(fileName,df.relPath(),df.width(),df.height(),df.hasCaption(),df.children(),df.srcFile(),df.srcLine(),!exists);
      visitChildren(df);
      endDiaFile(df.hasCaption());
    }
  }
}

References DocCompoundNode::children(), Config_getString, DB_VIS_C, endDiaFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startDiaFile(), stripPath(), visitChildren(), DocDiagramFileBase::width(), and writeFileContents().

operator()() [6/59]

void DocbookDocVisitor::operator()

(

const DocDotFile &

df

)

Definition at line 1234 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeFileContents(Config_getString(DOCBOOK_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                      ".dot",                                                        // extension
                                      inBuf,                                                         // contents
                                      exists);
    if (!fileName.isEmpty())
    {
      startDotFile(fileName,df.relPath(),df.width(),df.height(),df.hasCaption(),df.children(),df.srcFile(),df.srcLine(),!exists);
      visitChildren(df);
      endDotFile(df.hasCaption());
    }
  }
}

References DocCompoundNode::children(), Config_getString, DB_VIS_C, endDotFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startDotFile(), stripPath(), visitChildren(), DocDiagramFileBase::width(), and writeFileContents().

operator()() [7/59]

void DocbookDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 212 of file docbookvisitor.cpp.

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

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

operator()() [8/59]

void DocbookDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 543 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
 
  if (f.isInline()) m_t  << "<inlinemediaobject>\n";
  else m_t << "        <mediaobject>\n";
  m_t << "            <imageobject>\n";
  m_t << "                <imagedata ";
  m_t << "align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << f.relPath() << f.name() << ".png\"/>\n";
  m_t << "            </imageobject>\n";
  if (f.isInline()) m_t  << "</inlinemediaobject>\n";
  else m_t << "        </mediaobject>\n";
}

References DB_VIS_C, DocFormula::isInline(), m_hide, m_t, DocFormula::name(), and DocFormula::relPath().

operator()() [9/59]

void DocbookDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 248 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<informaltable frame='bottom'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>\n";
  m_t << "</entry></row></tbody></tgroup></informaltable>\n";
}

References DB_VIS_C, m_hide, and m_t.

operator()() [10/59]

void DocbookDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 1159 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (href.url().at(0) != '#')
  {
    m_t << "<link xlink:href=\"" << convertToDocBook(href.url()) << "\">";
  }
  else
  {
    startLink(href.file(),filterId(href.url().mid(1)));
  }
  visitChildren(href);
  m_t << "</link>";
}

References QCString::at(), convertToDocBook(), DB_VIS_C, DocHRef::file(), filterId(), m_hide, m_t, QCString::mid(), startLink(), DocHRef::url(), and visitChildren().

operator()() [11/59]

void DocbookDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 1513 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<blockquote>";
  visitChildren(q);
  m_t << "</blockquote>";
}

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

operator()() [12/59]

void DocbookDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 1139 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<caption>";
  if (!c.file().isEmpty())
  {
    m_t << "<anchor xml:id=\"_" <<  stripPath(c.file()) << "_1" << filterId(c.anchor()) << "\"/>";
  }
  visitChildren(c);
  m_t << "</caption>\n";
}

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

operator()() [13/59]

void DocbookDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 1084 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_colCnt++;
  if (m_hide) return;
  m_t << "<entry";
 
  for (const auto &opt : c.attribs())
  {
    if (opt.name=="colspan")
    {
      m_t << " namest='c" << m_colCnt << "'";
      int cols = opt.value.toInt();
      m_colCnt += (cols - 1);
      m_t << " nameend='c" << m_colCnt << "'";
    }
    else if (opt.name=="rowspan")
    {
      int extraRows = opt.value.toInt() - 1;
      m_t << " morerows='" << extraRows << "'";
    }
    else if (opt.name=="class")
    {
      if (opt.value.startsWith("markdownTable")) // handle markdown generated attributes
      {
        if (opt.value.endsWith("Right"))
        {
          m_t << " align='right'";
        }
        else if (opt.value.endsWith("Left"))
        {
          m_t << " align='left'";
        }
        else if (opt.value.endsWith("Center"))
        {
          m_t << " align='center'";
        }
        // skip 'markdownTable*' value ending with "None"
      }
      else
      {
        m_t << " class='" << convertToDocBook(opt.value) << "'";
      }
    }
    else if (supportedHtmlAttribute(opt.name))
    {
      // process supported attributes only
      m_t << " " << opt.name << "='" << convertToDocBook(opt.value) << "'";
    }
  }
  m_t << ">";
  visitChildren(c);
  m_t << "</entry>";
}

References DocHtmlCell::attribs(), convertToDocBook(), DB_VIS_C, m_colCnt, m_hide, m_t, supportedHtmlAttribute(), and visitChildren().

operator()() [14/59]

void DocbookDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 1014 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<listitem>";
  visitChildren(dd);
  m_t << "</listitem>\n";
}

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

operator()() [15/59]

void DocbookDocVisitor::operator()

(

const DocHtmlDescList &

l

)

Definition at line 996 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<variablelist>\n";
  visitChildren(l);
  m_t << "</variablelist>\n";
}

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

operator()() [16/59]

void DocbookDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 1005 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<varlistentry><term>";
  visitChildren(dt);
  m_t << "</term></varlistentry>\n";
}

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

operator()() [17/59]

void DocbookDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 1184 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  auto summary = d.summary();
  if (summary)
  {
    std::visit(*this,*summary);
  }
  m_t << "<para>";
  visitChildren(d);
  m_t << "</para>";
  m_t << "\n";
}

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

operator()() [18/59]

void DocbookDocVisitor::operator()

(

const DocHtmlHeader &

h

)

Definition at line 1200 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<formalpara><title>";
  visitChildren(h);
  m_t << "</title></formalpara>\n";
}

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

operator()() [19/59]

void DocbookDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 917 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (s.children().empty()) return;
  // opening tag for ordered list will be handled in DocHtmlListItem
  // due to (re-)numbering possibilities
  if (s.type()!=DocHtmlList::Ordered)
    m_t << "<itemizedlist>\n";
  visitChildren(s);
  if (s.type()==DocHtmlList::Ordered)
    m_t << "</orderedlist>\n";
  else
    m_t << "</itemizedlist>\n";
}

References DocCompoundNode::children(), DB_VIS_C, GrowVector< T >::empty(), m_hide, m_t, DocHtmlList::Ordered, DocHtmlList::type(), and visitChildren().

operator()() [20/59]

void DocbookDocVisitor::operator()

(

const DocHtmlListItem &

s

)

Definition at line 933 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  const DocHtmlList *l = std::get_if<DocHtmlList>(s.parent());
  if (l->type()==DocHtmlList::Ordered)
  {
    bool isFirst = &std::get<DocHtmlListItem>(l->children().front())==&s;
    int value = 0;
    QCString type;
    for (const auto &opt : s.attribs())
    {
      if (opt.name=="value")
      {
        bool ok = false;
        int val = opt.value.toInt(&ok);
        if (ok) value = val;
      }
    }
 
    if (value>0 || isFirst)
    {
      for (const auto &opt : l->attribs())
      {
        if (opt.name=="type")
        {
          if (opt.value=="1")
            type = " numeration=\"arabic\"";
          else if (opt.value=="a")
            type = " numeration=\"loweralpha\"";
            else if (opt.value=="A")
            type =  " numeration=\"upperalpha\"";
          else if (opt.value=="i")
            type =  " numeration=\"lowerroman\"";
          else if (opt.value=="I")
            type =  " numeration=\"upperroman\"";
        }
        else if (value==0 && opt.name=="start")
        {
          bool ok = false;
          int val = opt.value.toInt(&ok);
          if (ok) value = val;
        }
      }
    }
 
    if (value>0 && !isFirst)
    {
      m_t << "</orderedlist>\n";
    }
    if (value>0 || isFirst)
    {
      m_t << "<orderedlist";
      if (!type.isEmpty()) m_t << type.data();
      if (value>0)         m_t << " startingnumber=\"" << value << "\"";
      m_t << ">\n";
    }
  }
  m_t << "<listitem>\n";
  visitChildren(s);
  m_t << "</listitem>\n";
}

References DocHtmlList::attribs(), DocHtmlListItem::attribs(), DocCompoundNode::children(), QCString::data(), DB_VIS_C, GrowVector< T >::front(), QCString::isEmpty(), m_hide, m_t, DocHtmlList::Ordered, DocNode::parent(), DocHtmlList::type(), and visitChildren().

operator()() [21/59]

void DocbookDocVisitor::operator()

(

const DocHtmlRow &

tr

)

Definition at line 1046 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_colCnt = 0;
  if (m_hide) return;
 
  if (tr.isHeading())
  {
    if (m_bodySet.top()) m_t << "</tbody>\n";
    m_bodySet.top() = false;
    m_t << "<thead>\n";
  }
  else if (!m_bodySet.top())
  {
    m_bodySet.top() = true;
    m_t << "<tbody>\n";
  }
 
  m_t << "      <row ";
 
  for (const auto &opt : tr.attribs())
  {
    if (supportedHtmlAttribute(opt.name))
    {
      // process supported attributes only
      m_t << " " << opt.name << "='" << convertToDocBook(opt.value) << "'";
    }
  }
  m_t << ">\n";
  visitChildren(tr);
  m_t << "</row>\n";
  if (tr.isHeading())
  {
    m_t << "</thead><tbody>\n";
    m_bodySet.top() = true;
  }
}

References DocHtmlRow::attribs(), convertToDocBook(), DB_VIS_C, DocHtmlRow::isHeading(), m_bodySet, m_colCnt, m_hide, m_t, supportedHtmlAttribute(), and visitChildren().

operator()() [22/59]

void DocbookDocVisitor::operator()

(

const DocHtmlSummary &

s

)

Definition at line 1175 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<para><emphasis role=\"bold\">";
  visitChildren(s);
  m_t << "</emphasis></para>";
}

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

operator()() [23/59]

void DocbookDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 1023 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_bodySet.push(false);
  if (m_hide) return;
  m_t << "<informaltable frame=\"all\">\n";
  m_t << "    <tgroup cols=\"" << t.numColumns() << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
  for (uint32_t i = 0; i <t.numColumns(); i++)
  {
    // do something with colwidth based of cell width specification (be aware of possible colspan in the header)?
    m_t << "      <colspec colname='c" << i+1 << "'/>\n";
  }
  if (t.caption())
  {
    std::visit(*this,*t.caption());
  }
  visitChildren(t);
  if (m_bodySet.top()) m_t << "    </tbody>\n";
  m_bodySet.pop();
  m_t << "    </tgroup>\n";
  m_t << "</informaltable>\n";
}

References DocHtmlTable::caption(), DB_VIS_C, m_bodySet, m_hide, m_t, DocHtmlTable::numColumns(), and visitChildren().

operator()() [24/59]

void DocbookDocVisitor::operator()

(

const DocImage &

img

)

Definition at line 1209 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (img.type()==DocImage::DocBook)
  {
    if (m_hide) return;
    m_t << "\n";
    QCString baseName=stripPath(img.name());
    visitPreStart(m_t, img.children(), img.hasCaption(), img.relPath() + baseName, img.width(), img.height(), img.isInlineImage());
    visitChildren(img);
    visitPostEnd(m_t, img.hasCaption(),img.isInlineImage());
    QCString file;
    bool ambig = false;
    FileDef *fd=findFileDef(Doxygen::imageNameLinkedMap, baseName, ambig);
    if (fd)
    {
      file=fd->absFilePath();
    }
    copyFile(file,Config_getString(DOCBOOK_OUTPUT)+"/"+baseName);
  }
  else // skip other formats
  {
  }
}

References FileDef::absFilePath(), DocCompoundNode::children(), Config_getString, copyFile(), DB_VIS_C, DocImage::DocBook, findFileDef(), DocImage::hasCaption(), DocImage::height(), Doxygen::imageNameLinkedMap, DocImage::isInlineImage(), m_hide, m_t, DocImage::name(), DocImage::relPath(), stripPath(), DocImage::type(), visitChildren(), visitPostEnd(), visitPreStart(), and DocImage::width().

operator()() [25/59]

void DocbookDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 426 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc.extension());
  switch(inc.type())
  {
    case DocInclude::IncWithLines:
      {
        m_t << "<literallayout><computeroutput>";
        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())
                                                 );
        m_t << "</computeroutput></literallayout>";
      }
      break;
    case DocInclude::Include:
      m_t << "<literallayout><computeroutput>";
      getCodeParser(inc.extension()).parseCode(m_ci,inc.context(),
                                                inc.text(),
                                                langExt,
                                                inc.stripCodeComments(),
                                                CodeParserOptions()
                                                .setExample(inc.isExample(),inc.exampleFile())
                                               );
      m_t << "</computeroutput></literallayout>";
      break;
    case DocInclude::DontInclude:
    case DocInclude::DontIncWithLines:
    case DocInclude::HtmlInclude:
    case DocInclude::LatexInclude:
    case DocInclude::RtfInclude:
    case DocInclude::ManInclude:
    case DocInclude::XmlInclude:
      break;
    case DocInclude::DocbookInclude:
      m_t << inc.text();
      break;
    case DocInclude::VerbInclude:
      m_t << "<literallayout>";
      filter(inc.text());
      m_t << "</literallayout>";
      break;
    case DocInclude::Snippet:
    case DocInclude::SnippetWithLines:
      m_t << "<literallayout><computeroutput>";
      CodeFragmentManager::instance().parseCodeFragment(m_ci,
                                          inc.file(),
                                          inc.blockId(),
                                          inc.context(),
                                          inc.type()==DocInclude::SnippetWithLines,
                                          inc.trimLeft(),
                                          inc.stripCodeComments()
                                         );
      m_t << "</computeroutput></literallayout>";
      break;
  }
}

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

operator()() [26/59]

void DocbookDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 492 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (op.isFirst())
  {
    if (!m_hide)
    {
      m_t << "<programlisting linenumbering=\"unnumbered\">";
    }
    pushHidden(m_hide);
    m_hide = TRUE;
  }
  QCString locLangExt = getFileNameExtension(op.includeFileName());
  if (locLangExt.isEmpty()) locLangExt = m_langExt;
  SrcLangExt langExt = getLanguageFromFileName(locLangExt);
  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(),
                                        CodeParserOptions()
                                        .setExample(op.isExample(), op.exampleFile())
                                        .setFileDef(fd.get())
                                        .setStartLine(op.line())
                                        .setShowLineNumbers(op.showLineNo())
                                       );
    }
    pushHidden(m_hide);
    m_hide=TRUE;
  }
  if (op.isLast())
  {
    m_hide = popHidden();
    if (!m_hide) m_t << "</programlisting>";
  }
  else
  {
    if (!m_hide) m_t << "\n";
  }
}

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

operator()() [27/59]

void DocbookDocVisitor::operator()

(

const DocIndexEntry &

ie

)

Definition at line 558 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<indexterm><primary>";
  filter(ie.entry());
  m_t << "</primary></indexterm>\n";
}

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

operator()() [28/59]

void DocbookDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 1152 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  visitChildren(i);
}

References DB_VIS_C, m_hide, and visitChildren().

operator()() [29/59]

void DocbookDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 1496 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  startLink(ref.file(),ref.anchor());
  visitChildren(ref);
  endLink();
  m_t << " ";
}

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

operator()() [30/59]

void DocbookDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 239 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<?linebreak?>";
  // gives nicer results but gives problems as it is not allowed in <pare> and also problems with dblatex
  // m_t << "\n" << "<sbr/>\n";
}

References DB_VIS_C, m_hide, and m_t.

operator()() [31/59]

void DocbookDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 1318 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  startLink(lnk.file(),lnk.anchor());
  visitChildren(lnk);
  endLink();
}

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

operator()() [32/59]

void DocbookDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 174 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  startLink(w.file(),w.anchor());
  filter(w.word());
  endLink();
}

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

operator()() [33/59]

void DocbookDocVisitor::operator()

(

const DocMermaidFile &

df

)

Definition at line 1307 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (Config_getBool(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLIENT_SIDE) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(DOCBOOK_OUTPUT)+"/"+stripPath(df.file()));
  startMermaidFile(df.file(),df.relPath(),df.width(),df.height(),df.hasCaption(),df.children(),df.srcFile(),df.srcLine());
  visitChildren(df);
  endMermaidFile(df.hasCaption());
}

References DocCompoundNode::children(), Config_getBool, Config_getString, copyFile(), DB_VIS_C, endMermaidFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startMermaidFile(), stripPath(), visitChildren(), and DocDiagramFileBase::width().

operator()() [34/59]

void DocbookDocVisitor::operator()

(

const DocMscFile &

df

)

Definition at line 1255 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  bool exists = false;
  std::string inBuf;
  if (readInputFile(df.file(),inBuf))
  {
    auto fileName = writeFileContents(Config_getString(DOCBOOK_OUTPUT)+"/"+stripPath(df.file())+"_", // baseName
                                      ".msc",                                                        // extension
                                      inBuf,                                                         // contents
                                      exists);
    if (!fileName.isEmpty())
    {
      startMscFile(fileName,df.relPath(),df.width(),df.height(),df.hasCaption(),df.children(),df.srcFile(),df.srcLine(),!exists);
      visitChildren(df);
      endMscFile(df.hasCaption());
    }
  }
}

References DocCompoundNode::children(), Config_getString, DB_VIS_C, endMscFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, readInputFile(), DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startMscFile(), stripPath(), visitChildren(), DocDiagramFileBase::width(), and writeFileContents().

operator()() [35/59]

void DocbookDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 644 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  m_t << "<para>";
  visitChildren(p);
  m_t << "</para>";
  m_t << "\n";
}

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

operator()() [36/59]

void DocbookDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 1414 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "                            <row>\n";
 
  const DocParamSect *sect = std::get_if<DocParamSect>(pl.parent());
  if (sect && sect->hasInOutSpecifier())
  {
    m_t << "<entry>";
    if (pl.direction()!=DocParamSect::Unspecified)
    {
      if (pl.direction()==DocParamSect::In)
      {
        m_t << "in";
      }
      else if (pl.direction()==DocParamSect::Out)
      {
        m_t << "out";
      }
      else if (pl.direction()==DocParamSect::InOut)
      {
        m_t << "in,out";
      }
    }
    m_t << "</entry>";
  }
 
  if (sect && sect->hasTypeSpecifier())
  {
    m_t << "<entry>";
    for (const auto &type : pl.paramTypes())
    {
      std::visit(*this,type);
    }
    m_t << "</entry>";
  }
 
  if (pl.parameters().empty())
  {
    m_t << "<entry></entry>\n";
  }
  else
  {
    m_t << "<entry>";
    int cnt = 0;
    for (const auto &param : pl.parameters())
    {
      if (cnt)
      {
        m_t << ", ";
      }
      std::visit(*this,param);
      cnt++;
    }
    m_t << "</entry>";
  }
  m_t << "<entry>";
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  m_t << "</entry>\n";
  m_t << "                            </row>\n";
}

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

operator()() [37/59]

void DocbookDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 1364 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "\n";
  m_t << "                <formalpara>\n";
  m_t << "                    <title>\n";
  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 << "</title>\n";
  m_t << "                    <para>\n";
  m_t << "                    <table frame=\"all\">\n";
  int ncols = 2;
  if (s.type() == DocParamSect::Param)
  {
    bool hasInOutSpecs = s.hasInOutSpecifier();
    bool hasTypeSpecs  = s.hasTypeSpecifier();
    if      (hasInOutSpecs && hasTypeSpecs) ncols += 2;
    else if (hasInOutSpecs || hasTypeSpecs) ncols += 1;
  }
  m_t << "                        <tgroup cols=\"" << ncols << "\" align=\"left\" colsep=\"1\" rowsep=\"1\">\n";
  for (int i = 1; i <= ncols; i++)
  {
    if (i == ncols) m_t << "                        <colspec colwidth=\"4*\"/>\n";
    else            m_t << "                        <colspec colwidth=\"1*\"/>\n";
  }
  m_t << "                        <tbody>\n";
  visitChildren(s);
  m_t << "                        </tbody>\n";
  m_t << "                        </tgroup>\n";
  m_t << "                    </table>\n";
  m_t << "                    </para>\n";
  m_t << "                </formalpara>\n";
  m_t << "                ";
}

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

operator()() [38/59]

void DocbookDocVisitor::operator()

(

const DocParBlock &

b

)

Definition at line 1528 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  visitChildren(b);
}

References DB_VIS_C, m_hide, and visitChildren().

operator()() [39/59]

void DocbookDocVisitor::operator()

(

const DocPlantUmlFile &

df

)

Definition at line 1297 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(DOCBOOK_OUTPUT)+"/"+stripPath(df.file()));
  startPlantUmlFile(df.file(),df.relPath(),df.width(),df.height(),df.hasCaption(),df.children(),df.srcFile(),df.srcLine());
  visitChildren(df);
  endPlantUmlFile(df.hasCaption());
}

References DocCompoundNode::children(), Config_getBool, Config_getString, copyFile(), DB_VIS_C, endPlantUmlFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, DocDiagramFileBase::relPath(), DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startPlantUmlFile(), stripPath(), visitChildren(), and DocDiagramFileBase::width().

operator()() [40/59]

void DocbookDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 1327 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (ref.isSubPage())
  {
    startLink(QCString(),ref.anchor());
  }
  else
  {
    if (!ref.file().isEmpty()) startLink(ref.file(),ref.anchor());
  }
 
  if (!ref.hasLinkText()) filter(ref.targetTitle());
  visitChildren(ref);
  if (!ref.file().isEmpty()) endLink();
}

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

operator()() [41/59]

void DocbookDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 655 of file docbookvisitor.cpp.

{
DB_VIS_C
  visitChildren(r);
}

References DB_VIS_C, and visitChildren().

operator()() [42/59]

void DocbookDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 1345 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  //m_t << "<tocentry xml:idref=\"_" <<  stripPath(ref->file()) << "_1" << ref->anchor() << "\">";
  m_t << "<tocentry>";
  visitChildren(ref);
  m_t << "</tocentry>\n";
}

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

operator()() [43/59]

void DocbookDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 1355 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<toc>\n";
  visitChildren(l);
  m_t << "</toc>\n";
}

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

operator()() [44/59]

void DocbookDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 902 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<section xml:id=\"_" <<  stripPath(s.file());
  if (!s.anchor().isEmpty()) m_t << "_1" << s.anchor();
  m_t << "\">\n";
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  visitChildren(s);
  m_t << "</section>\n";
}

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

operator()() [45/59]

void DocbookDocVisitor::operator()

(

const DocSeparator &

sep

)

Definition at line 1407 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << " " << sep.chars() << " ";
}

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

operator()() [46/59]

void DocbookDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 881 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<itemizedlist>\n";
  visitChildren(l);
  m_t << "</itemizedlist>\n";
}

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

operator()() [47/59]

void DocbookDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 890 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<listitem>";
  if (li.paragraph())
  {
    visit(*this,*li.paragraph());
  }
  m_t << "</listitem>\n";
}

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

operator()() [48/59]

void DocbookDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 661 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  switch(s.type())
  {
    case DocSimpleSect::See:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trSeeAlso() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trSeeAlso()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Return:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trReturns()<< "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trReturns()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Author:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trAuthor(TRUE, TRUE) << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trAuthor(TRUE, TRUE)) << "</title>\n";
      }
      break;
    case DocSimpleSect::Authors:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trAuthor(TRUE, FALSE) << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trAuthor(TRUE, FALSE)) << "</title>\n";
      }
      break;
    case DocSimpleSect::Version:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trVersion() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trVersion()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Since:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trSince() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trSince()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Date:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trDate() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trDate()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Note:
      if (m_insidePre)
      {
        m_t << "<note><title>" << theTranslator->trNote() << "</title>\n";
      }
      else
      {
        m_t << "<note><title>" << convertToDocBook(theTranslator->trNote()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Warning:
      if (m_insidePre)
      {
        m_t << "<warning><title>" << theTranslator->trWarning() << "</title>\n";
      }
      else
      {
        m_t << "<warning><title>" << convertToDocBook(theTranslator->trWarning()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Pre:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trPrecondition() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trPrecondition()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Post:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trPostcondition() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trPostcondition()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Copyright:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trCopyright() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trCopyright()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Invar:
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trInvariant() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trInvariant()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Remark:
      // <remark> is miising the <title> possibility
      if (m_insidePre)
      {
        m_t << "<formalpara><title>" << theTranslator->trRemarks() << "</title>\n";
      }
      else
      {
        m_t << "<formalpara><title>" << convertToDocBook(theTranslator->trRemarks()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Attention:
      if (m_insidePre)
      {
        m_t << "<caution><title>" << theTranslator->trAttention() << "</title>\n";
      }
      else
      {
        m_t << "<caution><title>" << convertToDocBook(theTranslator->trAttention()) << "</title>\n";
      }
      break;
    case DocSimpleSect::Important:
      if (m_insidePre)
      {
        m_t << "<important><title>" << theTranslator->trImportant() << "</title>\n";
      }
      else
      {
        m_t << "<important><title>" << convertToDocBook(theTranslator->trImportant()) << "</title>\n";
      }
      break;
    case DocSimpleSect::User:
    case DocSimpleSect::Rcs:
    case DocSimpleSect::Unknown:
      if (s.hasTitle())
        m_t << "<formalpara>\n";
      else
        m_t << "<para>\n";
      break;
  }
 
  if (s.title())
  {
    std::visit(*this,*s.title());
  }
  visitChildren(s);
 
  switch(s.type())
  {
    case DocSimpleSect::User:
    case DocSimpleSect::Rcs:
    case DocSimpleSect::Unknown:
      if (s.hasTitle())
        m_t << "</formalpara>\n";
      else
        m_t << "</para>\n";
      break;
    case DocSimpleSect::Note:
      m_t << "</note>\n";
      break;
    case DocSimpleSect::Attention:
      m_t << "</caution>\n";
      break;
    case DocSimpleSect::Important:
      m_t << "</important>\n";
      break;
    case DocSimpleSect::Warning:
      m_t << "</warning>\n";
      break;
    default:
      m_t << "</formalpara>\n";
      break;
  }
}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, convertToDocBook(), DocSimpleSect::Copyright, DocSimpleSect::Date, DB_VIS_C, FALSE, DocSimpleSect::hasTitle(), DocSimpleSect::Important, DocSimpleSect::Invar, m_hide, m_insidePre, 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()() [49/59]

void DocbookDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 567 of file docbookvisitor.cpp.

{
DB_VIS_C
  // m_t << "<simplesect/>";
}

References DB_VIS_C.

operator()() [50/59]

void DocbookDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 256 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  switch (s.style())
  {
    case DocStyleChange::Bold:
      if (s.enable()) m_t << "<emphasis role=\"bold\">";      else m_t << "</emphasis>";
      break;
    case DocStyleChange::Italic:
      if (s.enable()) m_t << "<emphasis>";     else m_t << "</emphasis>";
      break;
    case DocStyleChange::Kbd:
    case DocStyleChange::Typewriter:
    case DocStyleChange::Code:
      if (s.enable()) m_t << "<computeroutput>";   else m_t << "</computeroutput>";
      break;
    case DocStyleChange::Subscript:
      if (s.enable()) m_t << "<subscript>";    else m_t << "</subscript>";
      break;
    case DocStyleChange::Superscript:
      if (s.enable()) m_t << "<superscript>";    else m_t << "</superscript>";
      break;
    case DocStyleChange::Center:
      if (s.enable()) m_t << "<informaltable frame='none'><tgroup cols='1'><colspec align='center'/><tbody><row><entry align='center'>";
      else m_t << "</entry></row></tbody></tgroup></informaltable>";
      break;
    case DocStyleChange::Preformatted:
      if (s.enable())
      {
        m_t << "<literallayout>";
        m_insidePre=TRUE;
      }
      else
      {
        m_t << "</literallayout>";
        m_insidePre=FALSE;
      }
      break;
      /* There is no equivalent Docbook tag for rendering Small text */
    case DocStyleChange::Small: /* XSLT Stylesheets can be used */ break;
                                                                   /* HTML only */
    case DocStyleChange::Cite:  break;
    case DocStyleChange::S:  break;
    case DocStyleChange::Strike:  break;
    case DocStyleChange::Del:        break;
    case DocStyleChange::Underline:  break;
    case DocStyleChange::Ins:        break;
    case DocStyleChange::Div:  /* HTML only */ break;
    case DocStyleChange::Span: /* HTML only */ break;
  }
}

References DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Cite, DocStyleChange::Code, DB_VIS_C, DocStyleChange::Del, DocStyleChange::Div, DocStyleChange::enable(), FALSE, DocStyleChange::Ins, DocStyleChange::Italic, DocStyleChange::Kbd, m_hide, m_insidePre, m_t, DocStyleChange::Preformatted, DocStyleChange::S, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::Strike, DocStyleChange::style(), DocStyleChange::Subscript, DocStyleChange::Superscript, TRUE, DocStyleChange::Typewriter, and DocStyleChange::Underline.

operator()() [51/59]

void DocbookDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 197 of file docbookvisitor.cpp.

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

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

operator()() [52/59]

void DocbookDocVisitor::operator()

(

const DocText &

t

)

Definition at line 1506 of file docbookvisitor.cpp.

{
DB_VIS_C
  visitChildren(t);
}

References DB_VIS_C, and visitChildren().

operator()() [53/59]

void DocbookDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 872 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (t.hasTitle()) m_t << "<title>";
  visitChildren(t);
  if (t.hasTitle()) m_t << "</title>";
}

References DB_VIS_C, DocTitle::hasTitle(), m_hide, m_t, and visitChildren().

operator()() [54/59]

void DocbookDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 227 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  m_t << "<link xlink:href=\"";
  if (u.isEmail()) m_t << "mailto:";
  filter(u.url());
  m_t << "\">";
  filter(u.url());
  m_t << "</link>";
}

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

operator()() [55/59]

void DocbookDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 309 of file docbookvisitor.cpp.

{
DB_VIS_C
  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:
      m_t << "<literallayout><computeroutput>";
      getCodeParser(m_langExt).parseCode(m_ci,s.context(),
                                         s.text(),
                                         langExt,
                                         Config_getBool(STRIP_CODE_COMMENTS),
                                         CodeParserOptions()
                                         .setExample(s.isExample(),s.exampleFile())
                                        );
      m_t << "</computeroutput></literallayout>";
      break;
    case DocVerbatim::Verbatim:
      m_t << "<literallayout><computeroutput>";
      filter(s.text());
      m_t << "</computeroutput></literallayout>";
      break;
    case DocVerbatim::JavaDocLiteral:
      filter(s.text(), true);
      break;
    case DocVerbatim::JavaDocCode:
      m_t << "<computeroutput>";
      filter(s.text(), true);
      m_t << "</computeroutput>";
      break;
    case DocVerbatim::HtmlOnly:
      break;
    case DocVerbatim::RtfOnly:
      break;
    case DocVerbatim::ManOnly:
      break;
    case DocVerbatim::LatexOnly:
      break;
    case DocVerbatim::XmlOnly:
      break;
    case DocVerbatim::DocbookOnly:
      m_t << s.text();
      break;
    case DocVerbatim::Dot:
      {
        m_t << "<para>\n";
        bool exists = false;
        auto fileName = writeFileContents(Config_getString(DOCBOOK_OUTPUT)+"/inline_dotgraph_", // baseName
                                          ".dot",                                               // extension
                                          s.text(),                                             // contents
                                          exists);
        if (!fileName.isEmpty())
        {
          writeDotFile(fileName, s, !exists);
        }
        m_t << "</para>\n";
      }
      break;
    case DocVerbatim::Msc:
      {
        m_t << "<para>\n";
        bool exists = false;
        auto fileName = writeFileContents(Config_getString(DOCBOOK_OUTPUT)+"/inline_mscgraph_", // baseName
                                          ".msc",                                               // extension
                                          "msc {"+s.text()+"}",                                 // contents
                                          exists);
        if (!fileName.isEmpty())
        {
          writeMscFile(fileName,s,!exists);
        }
        m_t << "</para>\n";
      }
      break;
    case DocVerbatim::PlantUML:
      {
        QCString docbookOutput = Config_getString(DOCBOOK_OUTPUT);
        auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(docbookOutput,
            s.exampleFile(),s.text(),PlantumlManager::PUML_BITMAP,
            s.engine(),s.srcFile(),s.srcLine(),true);
        for (const auto &baseName: baseNameVector)
        {
          m_t << "<para>\n";
          writePlantUMLFile(baseName,s);
          m_t << "</para>\n";
        }
      }
      break;
    case DocVerbatim::Mermaid:
      if (Config_getBool(MERMAID_RENDER_MODE)!=MERMAID_RENDER_MODE_t::CLIENT_SIDE)
      {
        auto docbookOutput = Config_getString(DOCBOOK_OUTPUT);
        auto outputFormat  = MermaidManager::OutputFormat::Docbook;
        auto imageFormat   = MermaidManager::convertToImageFormat(outputFormat);
        auto baseName      = MermaidManager::instance().writeMermaidSource(docbookOutput,
            s.exampleFile(),s.text(),imageFormat,
            s.srcFile(),s.srcLine());
        m_t << "<para>\n";
        writeMermaidFile(baseName,s);
        m_t << "</para>\n";
      }
      break;
  }
}

References DocVerbatim::Code, Config_getBool, Config_getString, DocVerbatim::context(), MermaidManager::convertToImageFormat(), DB_VIS_C, MermaidManager::Docbook, DocVerbatim::DocbookOnly, DocVerbatim::Dot, DocVerbatim::engine(), DocVerbatim::exampleFile(), filter(), DocVisitor::getCodeParser(), getLanguageFromCodeLang(), DocVerbatim::HtmlOnly, MermaidManager::instance(), PlantumlManager::instance(), QCString::isEmpty(), DocVerbatim::isExample(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, m_ci, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Mermaid, DocVerbatim::Msc, CodeParserInterface::parseCode(), DocVerbatim::PlantUML, PlantumlManager::PUML_BITMAP, DocVerbatim::RtfOnly, DocVerbatim::srcFile(), DocVerbatim::srcLine(), DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, writeDotFile(), writeFileContents(), writeMermaidFile(), MermaidManager::writeMermaidSource(), writeMscFile(), writePlantUMLFile(), PlantumlManager::writePlantUMLSource(), and DocVerbatim::XmlOnly.

operator()() [56/59]

void DocbookDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 1522 of file docbookvisitor.cpp.

{
DB_VIS_C
  // TODO: to be implemented
}

References DB_VIS_C.

operator()() [57/59]

void DocbookDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 183 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (m_insidePre)
  {
    m_t << w.chars();
  }
  else
  {
    m_t << " ";
  }
}

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

operator()() [58/59]

void DocbookDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 167 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  filter(w.word());
}

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

operator()() [59/59]

void DocbookDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 1480 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (m_hide) return;
  if (x.title().isEmpty()) return;
  m_t << "<para><link linkend=\"_";
  m_t << stripPath(x.file()) << "_1" << x.anchor();
  m_t << "\">";
  filter(x.title());
  m_t << "</link>";
  m_t << " ";
  visitChildren(x);
  if (x.title().isEmpty()) return;
  m_t << "</para>";
}

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

startDiaFile()

void DocbookDocVisitor::startDiaFile ( const QCString & fileName, const QCString & relPath, const QCString & width, const QCString & height, bool hasCaption, const DocNodeList & children, const QCString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 1706 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString baseName=makeBaseName(fileName,".dia");
  baseName.prepend("dia_");
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  if (newFile) writeDiaGraphFromFile(fileName,outDir,baseName,DiaOutputFormat::BITMAP,srcFile,srcLine,false);
  m_t << "<para>\n";
  visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png",  width,  height);
}

References BITMAP, Config_getString, DB_VIS_C, m_t, makeBaseName(), visitPreStart(), and writeDiaGraphFromFile().

Referenced by operator()().

startDotFile()

void DocbookDocVisitor::startDotFile ( const QCString & fileName, const QCString & relPath, const QCString & width, const QCString & height, bool hasCaption, const DocNodeList & children, const QCString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 1744 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString baseName=makeBaseName(fileName,".dot");
  baseName.prepend("dot_");
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  QCString imgExt = getDotImageExtension();
  if (newFile) writeDotGraphFromFile(fileName,outDir,baseName,GraphOutputFormat::BITMAP,srcFile,srcLine,false);
  m_t << "<para>\n";
  visitPreStart(m_t, children, hasCaption, relPath + baseName + "." + imgExt,  width,  height);
}

References BITMAP, Config_getString, DB_VIS_C, getDotImageExtension(), m_t, makeBaseName(), visitPreStart(), and writeDotGraphFromFile().

Referenced by operator()().

startLink()

void DocbookDocVisitor::startLink ( const QCString & file, const QCString & anchor )

private

Definition at line 1542 of file docbookvisitor.cpp.

{
DB_VIS_C
  m_t << "<link linkend=\"_" << stripPath(file);
  if (!anchor.isEmpty())
  {
    if (!file.isEmpty()) m_t << "_1";
    m_t << anchor;
  }
  m_t << "\">";
}

References DB_VIS_C, QCString::isEmpty(), m_t, and stripPath().

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

startMermaidFile()

void DocbookDocVisitor::startMermaidFile ( const QCString & fileName, const QCString & relPath, const QCString & width, const QCString & height, bool hasCaption, const DocNodeList & children, const QCString & srcFile, int srcLine )

private

Definition at line 1634 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (Config_getBool(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLIENT_SIDE) return;
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  std::string inBuf;
  readInputFile(fileName,inBuf);
  auto outputFormat = MermaidManager::OutputFormat::Docbook;
  auto imageFormat  = MermaidManager::convertToImageFormat(outputFormat);
  auto imgExt       = MermaidManager::imageExtension(imageFormat);
  auto baseName     = MermaidManager::instance().writeMermaidSource(outDir,QCString(),inBuf,imageFormat,srcFile,srcLine);
  auto shortName    = stripPath(baseName);
  MermaidManager::instance().generateMermaidOutput(baseName,outDir,imageFormat,false);
  m_t << "<para>\n";
  visitPreStart(m_t, children, hasCaption, relPath + shortName + "." + imgExt, width, height);
}

References Config_getBool, Config_getString, MermaidManager::convertToImageFormat(), DB_VIS_C, MermaidManager::Docbook, MermaidManager::generateMermaidOutput(), MermaidManager::imageExtension(), MermaidManager::instance(), m_t, readInputFile(), stripPath(), visitPreStart(), and MermaidManager::writeMermaidSource().

Referenced by operator()().

startMscFile()

void DocbookDocVisitor::startMscFile ( const QCString & fileName, const QCString & relPath, const QCString & width, const QCString & height, bool hasCaption, const DocNodeList & children, const QCString & srcFile, int srcLine, bool newFile = true )

private

Definition at line 1668 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString baseName=makeBaseName(fileName,".msc");
  baseName.prepend("msc_");
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  if (newFile) writeMscGraphFromFile(fileName,outDir,baseName,MscOutputFormat::BITMAP,srcFile,srcLine,false);
  m_t << "<para>\n";
  visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png",  width,  height);
}

References BITMAP, Config_getString, DB_VIS_C, m_t, makeBaseName(), visitPreStart(), and writeMscGraphFromFile().

Referenced by operator()().

startPlantUmlFile()

void DocbookDocVisitor::startPlantUmlFile ( const QCString & fileName, const QCString & relPath, const QCString & width, const QCString & height, bool hasCaption, const DocNodeList & children, const QCString & srcFile, int srcLine )

private

Definition at line 1582 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  std::string inBuf;
  readInputFile(fileName,inBuf);
  auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(outDir,
                           QCString(),inBuf,PlantumlManager::PUML_BITMAP,QCString(),srcFile,srcLine,false);
  bool first = true;
  for (const auto &bName: baseNameVector)
  {
    QCString baseName=makeBaseName(bName,".pu");
    PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP,false);
    if (!first) endPlantUmlFile(hasCaption);
    first = false;
    m_t << "<para>\n";
    visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png",  width,  height);
  }
}

References Config_getString, DB_VIS_C, endPlantUmlFile(), PlantumlManager::generatePlantUMLOutput(), PlantumlManager::instance(), m_t, makeBaseName(), PlantumlManager::PUML_BITMAP, readInputFile(), visitPreStart(), and PlantumlManager::writePlantUMLSource().

Referenced by operator()().

visitCaption()

void DocbookDocVisitor::visitCaption ( const DocNodeList & children )

private

Definition at line 87 of file docbookvisitor.cpp.

{
  for (const auto &n : children)
  {
    std::visit(*this,n);
  }
}

Referenced by visitPreStart(), writeDiaFile(), writeDotFile(), writeMermaidFile(), writeMscFile(), and writePlantUMLFile().

visitChildren()

template<class T>

void DocbookDocVisitor::visitChildren ( const T & t )

inline

Definition at line 37 of file docbookvisitor.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()().

visitPostEnd()

void DocbookDocVisitor::visitPostEnd ( TextStream & t, bool hasCaption, bool inlineImage = FALSE )

private

Definition at line 138 of file docbookvisitor.cpp.

{
  t << "\n";
  if (hasCaption && !inlineImage)
  {
    t << "        -->\n"; // Needed for general formatting with title for other formats
  }
  t << "        </mediaobject>\n";
  if (hasCaption && !inlineImage)
  {
    t << "    </figure>\n";
  }
  else
  {
    t << "    </informalfigure>\n";
  }
}

Referenced by endDiaFile(), endDotFile(), endMermaidFile(), endMscFile(), endPlantUmlFile(), operator()(), writeDiaFile(), writeDotFile(), writeMermaidFile(), writeMscFile(), and writePlantUMLFile().

visitPreStart()

void DocbookDocVisitor::visitPreStart ( TextStream & t, const DocNodeList & children, bool hasCaption, const QCString & name, const QCString & width, const QCString & height, bool inlineImage = FALSE )

private

Definition at line 95 of file docbookvisitor.cpp.

{
  if (hasCaption && !inlineImage)
  {
    t << "    <figure>\n";
    t << "        <title>\n";
    visitCaption(children);
    t << "        </title>\n";
  }
  else
  {
    t << "    <informalfigure>\n";
  }
  t << "        <mediaobject>\n";
  t << "            <imageobject>\n";
  t << "                <imagedata";
  if (!width.isEmpty())
  {
    t << " width=\"" << convertToDocBook(width) << "\"";
  }
  else
  {
    if (!height.isEmpty() && !inlineImage) t << " width=\"50%\"";
  }
  if (!height.isEmpty())
  {
    t << " depth=\"" << convertToDocBook(height) << "\"";
  }
  t << " align=\"center\" valign=\"middle\" scalefit=\"0\" fileref=\"" << name << "\">";
  t << "</imagedata>\n";
  t << "            </imageobject>\n";
  if (hasCaption && !inlineImage)
  {
    t << "        <!--\n"; // Needed for general formatting with title for other formats
  }
}

References convertToDocBook(), QCString::isEmpty(), and visitCaption().

Referenced by operator()(), startDiaFile(), startDotFile(), startMermaidFile(), startMscFile(), startPlantUmlFile(), writeDiaFile(), writeDotFile(), writeMermaidFile(), writeMscFile(), and writePlantUMLFile().

writeDiaFile()

void DocbookDocVisitor::writeDiaFile ( const QCString & fileName, const DocVerbatim & s )

private

Definition at line 1695 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString shortName = stripPath(baseName);
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  writeDiaGraphFromFile(baseName+".dia",outDir,shortName,DiaOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
  visitPreStart(m_t, s.children(), s.hasCaption(), shortName, s.width(),s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References BITMAP, DocVerbatim::children(), Config_getString, DB_VIS_C, DocVerbatim::hasCaption(), DocVerbatim::height(), m_t, DocVerbatim::srcFile(), DocVerbatim::srcLine(), stripPath(), visitCaption(), visitPostEnd(), visitPreStart(), DocVerbatim::width(), and writeDiaGraphFromFile().

writeDotFile()

void DocbookDocVisitor::writeDotFile ( const QCString & fileName, const DocVerbatim & s, bool newFile = true )

private

Definition at line 1733 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString shortName = makeBaseName(fileName,".dot");
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  if (newFile) writeDotGraphFromFile(fileName,outDir,shortName,GraphOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
  visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + "." + getDotImageExtension(), s.width(),s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References BITMAP, DocVerbatim::children(), Config_getString, DB_VIS_C, getDotImageExtension(), DocVerbatim::hasCaption(), DocVerbatim::height(), m_t, makeBaseName(), DocVerbatim::relPath(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), visitCaption(), visitPostEnd(), visitPreStart(), DocVerbatim::width(), and writeDotGraphFromFile().

Referenced by operator()().

writeMermaidFile()

void DocbookDocVisitor::writeMermaidFile ( const QCString & fileName, const DocVerbatim & s )

private

Definition at line 1619 of file docbookvisitor.cpp.

{
DB_VIS_C
  if (Config_getBool(MERMAID_RENDER_MODE)==MERMAID_RENDER_MODE_t::CLIENT_SIDE) return;
  auto shortName    = stripPath(baseName);
  auto outDir       = Config_getString(DOCBOOK_OUTPUT);
  auto outputFormat = MermaidManager::OutputFormat::Docbook;
  auto imageFormat  = MermaidManager::convertToImageFormat(outputFormat);
  auto imgExt       = MermaidManager::imageExtension(imageFormat);
  MermaidManager::instance().generateMermaidOutput(baseName,outDir,imageFormat,false);
  visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + "." + imgExt, s.width(),s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References DocVerbatim::children(), Config_getBool, Config_getString, MermaidManager::convertToImageFormat(), DB_VIS_C, MermaidManager::Docbook, MermaidManager::generateMermaidOutput(), DocVerbatim::hasCaption(), DocVerbatim::height(), MermaidManager::imageExtension(), MermaidManager::instance(), m_t, DocVerbatim::relPath(), stripPath(), visitCaption(), visitPostEnd(), visitPreStart(), and DocVerbatim::width().

Referenced by operator()().

writeMscFile()

void DocbookDocVisitor::writeMscFile ( const QCString & fileName, const DocVerbatim & s, bool newFile = true )

private

Definition at line 1560 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString shortName = makeBaseName(fileName,".msc");
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  if (newFile) writeMscGraphFromFile(fileName,outDir,shortName,MscOutputFormat::BITMAP,s.srcFile(),s.srcLine(),false);
  visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + ".png", s.width(), s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References BITMAP, DocVerbatim::children(), Config_getString, DB_VIS_C, DocVerbatim::hasCaption(), DocVerbatim::height(), m_t, makeBaseName(), DocVerbatim::relPath(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), visitCaption(), visitPostEnd(), visitPreStart(), DocVerbatim::width(), and writeMscGraphFromFile().

Referenced by operator()().

writePlantUMLFile()

void DocbookDocVisitor::writePlantUMLFile ( const QCString & fileName, const DocVerbatim & s )

private

Definition at line 1571 of file docbookvisitor.cpp.

{
DB_VIS_C
  QCString shortName = stripPath(baseName);
  QCString outDir = Config_getString(DOCBOOK_OUTPUT);
  PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP,false);
  visitPreStart(m_t, s.children(), s.hasCaption(), s.relPath() + shortName + ".png", s.width(),s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References DocVerbatim::children(), Config_getString, DB_VIS_C, PlantumlManager::generatePlantUMLOutput(), DocVerbatim::hasCaption(), DocVerbatim::height(), PlantumlManager::instance(), m_t, PlantumlManager::PUML_BITMAP, DocVerbatim::relPath(), stripPath(), visitCaption(), visitPostEnd(), visitPreStart(), and DocVerbatim::width().

Referenced by operator()().

Member Data Documentation

m_bodySet

BoolStack DocbookDocVisitor::m_bodySet

private

Definition at line 162 of file docbookvisitor.h.

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

m_ci

OutputCodeList& DocbookDocVisitor::m_ci

private

Definition at line 156 of file docbookvisitor.h.

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

m_colCnt

int DocbookDocVisitor::m_colCnt = 0

private

Definition at line 161 of file docbookvisitor.h.

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

m_enabled

BoolStack DocbookDocVisitor::m_enabled

private

Definition at line 159 of file docbookvisitor.h.

m_hide

bool DocbookDocVisitor::m_hide = false

private

Definition at line 158 of file docbookvisitor.h.

Referenced by endDiaFile(), endDotFile(), endMermaidFile(), endMscFile(), endPlantUmlFile(), 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()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), operator()(), and operator()().

m_insidePre

bool DocbookDocVisitor::m_insidePre = false

private

Definition at line 157 of file docbookvisitor.h.

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

m_langExt

QCString DocbookDocVisitor::m_langExt

private

Definition at line 160 of file docbookvisitor.h.

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

m_t

TextStream& DocbookDocVisitor::m_t

private

Definition at line 155 of file docbookvisitor.h.

Referenced by DocbookDocVisitor(), endDiaFile(), endDotFile(), endLink(), endMermaidFile(), endMscFile(), endPlantUmlFile(), filter(), 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()(), operator()(), operator()(), operator()(), operator()(), operator()(), startDiaFile(), startDotFile(), startLink(), startMermaidFile(), startMscFile(), startPlantUmlFile(), writeDiaFile(), writeDotFile(), writeMermaidFile(), writeMscFile(), and writePlantUMLFile().

---

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

• src/docbookvisitor.h
• src/docbookvisitor.cpp