LatexDocVisitor Class Reference

Concrete visitor implementation for LaTeX output. More...

#include <src/latexdocvisitor.h>

Inheritance diagram for LatexDocVisitor:

Collaboration diagram for LatexDocVisitor:

Classes
struct	ActiveRowSpan
struct	TableState
struct	LatexListItemInfo

Public Member Functions
	LatexDocVisitor (TextStream &t, OutputCodeList &ci, LatexCodeGenerator &lcg, const QCString &langExt, int hierarchyLevel=0)
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 Types
typedef std::vector< ActiveRowSpan >	RowSpanList

Private Member Functions
template<class T>
void	visitChildren (const T &t)
void	filter (const QCString &str, const bool retainNewLine=false)
void	startLink (const QCString &ref, const QCString &file, const QCString &anchor, bool refToTable=false, bool refToSection=false)
void	endLink (const QCString &ref, const QCString &file, const QCString &anchor, bool refToTable=false, bool refToSection=false, SectionType sectionType=SectionType::Anchor)
QCString	escapeMakeIndexChars (const char *s)
void	startDotFile (const QCString &fileName, const QCString &width, const QCString &height, bool hasCaption, const QCString &srcFile, int srcLine)
void	endDotFile (bool hasCaption)
void	startMscFile (const QCString &fileName, const QCString &width, const QCString &height, bool hasCaption, const QCString &srcFile, int srcLine)
void	endMscFile (bool hasCaption)
void	writeMscFile (const QCString &fileName, const DocVerbatim &s)
void	startDiaFile (const QCString &fileName, const QCString &width, const QCString &height, bool hasCaption, const QCString &srcFile, int srcLine)
void	endDiaFile (bool hasCaption)
void	writeDiaFile (const QCString &fileName, const DocVerbatim &s)
void	writePlantUMLFile (const QCString &fileName, const DocVerbatim &s)
void	startPlantUmlFile (const QCString &fileName, const QCString &width, const QCString &height, bool hasCaption, const QCString &srcFile, int srcLine)
void	endPlantUmlFile (bool hasCaption)
void	visitCaption (const DocNodeList &children)
void	incIndentLevel ()
void	decIndentLevel ()
int	indentLevel () const
const char *	getSectionName (int level) const
void	pushTableState ()
void	popTableState ()
size_t	currentColumn () const
void	setCurrentColumn (size_t col)
size_t	numCols () const
void	setNumCols (size_t num)
RowSpanList &	rowSpans ()
void	addRowSpan (ActiveRowSpan &&span)
bool	insideTable () const
bool	isTableNested (const DocNodeVariant *n) const
void	writeStartTableCommand (const DocNodeVariant *n, size_t cols)
void	writeEndTableCommand (const DocNodeVariant *n)

Private Attributes
TextStream &	m_t
OutputCodeList &	m_ci
LatexCodeGenerator &	m_lcg
bool	m_insidePre
bool	m_insideItem
bool	m_hide
QCString	m_langExt
int	m_hierarchyLevel
TexOrPdf	m_texOrPdf = TexOrPdf::NO
std::stack< TableState >	m_tableStateStack
RowSpanList	m_emptyRowSpanList
int	m_indentLevel = 0
LatexListItemInfo	m_listItemInfo [maxIndentLevels]

Static Private Attributes
static const int	maxIndentLevels = 13

Detailed Description

Concrete visitor implementation for LaTeX output.

Definition at line 37 of file latexdocvisitor.h.

Member Typedef Documentation

RowSpanList

typedef std::vector<ActiveRowSpan> LatexDocVisitor::RowSpanList

private

Definition at line 131 of file latexdocvisitor.h.

Constructor & Destructor Documentation

LatexDocVisitor()

LatexDocVisitor::LatexDocVisitor	(	TextStream &	t,
		OutputCodeList &	ci,
		LatexCodeGenerator &	lcg,
		const QCString &	langExt,
		int	hierarchyLevel = 0 )

Definition at line 268 of file latexdocvisitor.cpp.

  : m_t(t), m_ci(ci), m_lcg(lcg), m_insidePre(FALSE),
    m_insideItem(FALSE), m_hide(FALSE),
    m_langExt(langExt), m_hierarchyLevel(hierarchyLevel)
{
}

References FALSE, m_ci, m_hide, m_hierarchyLevel, m_insideItem, m_insidePre, m_langExt, m_lcg, and m_t.

Member Function Documentation

addRowSpan()

void LatexDocVisitor::addRowSpan ( ActiveRowSpan && span )

inlineprivate

Definition at line 233 of file latexdocvisitor.h.

    {
      if (!m_tableStateStack.empty()) m_tableStateStack.top().rowSpans.push_back(std::move(span));
    }

References m_tableStateStack.

Referenced by operator()().

currentColumn()

size_t LatexDocVisitor::currentColumn ( ) const

inlineprivate

Definition at line 213 of file latexdocvisitor.h.

    {
      return !m_tableStateStack.empty() ? m_tableStateStack.top().currentColumn : 0;
    }

References m_tableStateStack.

Referenced by operator()().

decIndentLevel()

void LatexDocVisitor::decIndentLevel ( )

private

Definition at line 2125 of file latexdocvisitor.cpp.

{
  if (m_indentLevel>0)
  {
    m_indentLevel--;
  }
}

References m_indentLevel.

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

endDiaFile()

void LatexDocVisitor::endDiaFile ( bool hasCaption )

private

Definition at line 2039 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t,hasCaption);
}

References m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endDotFile()

void LatexDocVisitor::endDotFile ( bool hasCaption )

private

Definition at line 1983 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t,hasCaption);
}

References m_hide, m_t, and visitPostEnd().

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

endLink()

void LatexDocVisitor::endLink ( const QCString & ref, const QCString & file, const QCString & anchor, bool refToTable = false, bool refToSection = false, SectionType sectionType = SectionType::Anchor )

private

Definition at line 1942 of file latexdocvisitor.cpp.

{
  m_t << "}";
  bool pdfHyperLinks = Config_getBool(PDF_HYPERLINKS);
  if (ref.isEmpty() && !pdfHyperLinks)
  {
    m_t << "{";
    filter(theTranslator->trPageAbbreviation());
    m_t << "}{" << file;
    if (!file.isEmpty() && !anchor.isEmpty()) m_t << "_";
    m_t << anchor << "}";
    if (refToSection)
    {
      m_t << "{" << sectionType.level() << "}";
    }
  }
  if (ref.isEmpty() && pdfHyperLinks) // internal PDF link
  {
    if (refToSection)
    {
      if (m_texOrPdf != TexOrPdf::PDF) m_t << "{" << sectionType.level() << "}";
    }
  }
}

References Config_getBool, filter(), QCString::isEmpty(), SectionType::level(), m_t, m_texOrPdf, PDF, and theTranslator.

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

endMscFile()

void LatexDocVisitor::endMscFile ( bool hasCaption )

private

Definition at line 2005 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t,hasCaption);
}

References m_hide, m_t, and visitPostEnd().

Referenced by operator()().

endPlantUmlFile()

void LatexDocVisitor::endPlantUmlFile ( bool hasCaption )

private

Definition at line 2105 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  visitPostEnd(m_t,hasCaption);
}

References m_hide, m_t, and visitPostEnd().

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

escapeMakeIndexChars()

QCString LatexDocVisitor::escapeMakeIndexChars ( const char * s )

private

Definition at line 240 of file latexdocvisitor.cpp.

{
  QCString result;
  const char *p=s;
  char str[2]; str[1]=0;
  char c = 0;
  if (p)
  {
    while ((c=*p++))
    {
      switch (c)
      {
        case '!': m_t << "\"!"; break;
        case '"': m_t << "\"\""; break;
        case '@': m_t << "\"@"; break;
        case '|': m_t << "\\texttt{\"|}"; break;
        case '[': m_t << "["; break;
        case ']': m_t << "]"; break;
        case '{': m_t << "\\lcurly{}"; break;
        case '}': m_t << "\\rcurly{}"; break;
        default:  str[0]=c; filter(str); break;
      }
    }
  }
  return result;
}

References filter(), and m_t.

filter()

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

private

Definition at line 1882 of file latexdocvisitor.cpp.

{
  //printf("LatexDocVisitor::filter(%s) m_insideTabbing=%d m_insideTable=%d\n",qPrint(str),m_lcg.insideTabbing(),m_lcg.usedTableLevel()>0);
  filterLatexString(m_t,str,
                    m_lcg.insideTabbing(),
                    m_insidePre,
                    m_insideItem,
                    m_lcg.usedTableLevel()>0,  // insideTable
                    false, // keepSpaces
                    retainNewLine
                   );
}

References filterLatexString(), m_insideItem, m_insidePre, m_lcg, and m_t.

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

getSectionName()

const char * LatexDocVisitor::getSectionName ( int level ) const

private

Definition at line 59 of file latexdocvisitor.cpp.

{
  bool compactLatex = Config_getBool(COMPACT_LATEX);
  int l = level;
  if (compactLatex) l++;
 
  if (l < g_maxLevels)
  {
    l += m_hierarchyLevel; /* May be -1 if generating main page */
    // Sections get special treatment because they inherit the parent's level
    if (l >= g_maxLevels)
    {
      l = g_maxLevels - 1;
    }
    else if (l < 0)
    {
      /* Should not happen; level is always >= 1 and hierarchyLevel >= -1 */
      l = 0;
    }
    return g_secLabels[l];
  }
  else if (l == 7)
  {
    return g_paragraphLabel;
  }
  else
  {
    return g_subparagraphLabel;
  }
}

References Config_getBool, g_maxLevels, g_paragraphLabel, g_secLabels, g_subparagraphLabel, and m_hierarchyLevel.

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

incIndentLevel()

void LatexDocVisitor::incIndentLevel ( )

private

Definition at line 2116 of file latexdocvisitor.cpp.

{
  m_indentLevel++;
  if (m_indentLevel>=maxIndentLevels)
  {
    err("Maximum indent level ({}) exceeded while generating LaTeX output!\n",maxIndentLevels-1);
  }
}

References err, m_indentLevel, and maxIndentLevels.

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

indentLevel()

int LatexDocVisitor::indentLevel ( ) const

private

Definition at line 2111 of file latexdocvisitor.cpp.

{
  return std::min(m_indentLevel,maxIndentLevels-1);
}

References m_indentLevel, and maxIndentLevels.

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

insideTable()

bool LatexDocVisitor::insideTable ( ) const

inlineprivate

Definition at line 237 of file latexdocvisitor.h.

    {
      return !m_tableStateStack.empty();
    }

References m_tableStateStack.

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

isTableNested()

bool LatexDocVisitor::isTableNested ( const DocNodeVariant * n ) const

private

Definition at line 1262 of file latexdocvisitor.cpp.

{
  bool isNested=m_lcg.usedTableLevel()>0;
  while (n && !isNested)
  {
    isNested = holds_one_of_alternatives<DocHtmlTable,DocParamSect>(*n);
    n = ::parent(n);
  }
  return isNested;
}

References holds_one_of_alternatives(), m_lcg, and parent().

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

numCols()

size_t LatexDocVisitor::numCols ( ) const

inlineprivate

Definition at line 221 of file latexdocvisitor.h.

    {
      return !m_tableStateStack.empty() ? m_tableStateStack.top().numCols : 0;
    }

References m_tableStateStack.

operator()() [1/58]

void LatexDocVisitor::operator()

(

const DocAnchor &

anc

)

Definition at line 576 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\label{" << stripPath(anc.file()) << "_" << anc.anchor() << "}%\n";
  if (!anc.file().isEmpty() && Config_getBool(PDF_HYPERLINKS))
  {
    m_t << "\\Hypertarget{" << stripPath(anc.file()) << "_" << anc.anchor()
      << "}%\n";
  }
}

References DocAnchor::anchor(), Config_getBool, DocAnchor::file(), QCString::isEmpty(), m_hide, m_t, and stripPath().

operator()() [2/58]

void LatexDocVisitor::operator()

(

const DocAutoList &

l

)

Definition at line 821 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (m_indentLevel>=maxIndentLevels-1) return;
  if (l.isEnumList())
  {
    m_t << "\n\\begin{DoxyEnumerate}";
    m_listItemInfo[indentLevel()].isEnum = true;
  }
  else
  {
    m_listItemInfo[indentLevel()].isEnum = false;
    m_t << "\n\\begin{DoxyItemize}";
  }
  visitChildren(l);
  if (l.isEnumList())
  {
    m_t << "\n\\end{DoxyEnumerate}";
  }
  else
  {
    m_t << "\n\\end{DoxyItemize}";
  }
}

References indentLevel(), DocAutoList::isEnumList(), m_hide, m_indentLevel, m_listItemInfo, m_t, maxIndentLevels, and visitChildren().

operator()() [3/58]

void LatexDocVisitor::operator()

(

const DocAutoListItem &

li

)

Definition at line 846 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  switch (li.itemNumber())
  {
    case DocAutoList::Unchecked: // unchecked
      m_t << "\n\\item[\\DoxyUnchecked] ";
      break;
    case DocAutoList::Checked_x: // checked with x
    case DocAutoList::Checked_X: // checked with X
      m_t << "\n\\item[\\DoxyChecked] ";
      break;
    default:
      m_t << "\n\\item ";
      break;
  }
  incIndentLevel();
  visitChildren(li);
  decIndentLevel();
}

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

operator()() [4/58]

void LatexDocVisitor::operator()

(

const DocCite &

cite

)

Definition at line 758 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  auto opt = cite.option();
  QCString txt;
  if (opt.noCite())
  {
    if (!cite.file().isEmpty())
    {
      txt = cite.getText();
    }
    else
    {
      if (!opt.noPar()) txt += "[";
      txt += cite.target();
      if (!opt.noPar()) txt += "]";
    }
    m_t << "{\\bfseries ";
    filter(txt);
    m_t << "}";
  }
  else
  {
    if (!cite.file().isEmpty())
    {
      QCString anchor = cite.anchor();
      QCString anchorPrefix = CitationManager::instance().anchorPrefix();
      anchor = anchor.mid(anchorPrefix.length()); // strip prefix
 
      txt = "\\DoxyCite{" + anchor + "}";
      if (opt.isNumber())
      {
        txt += "{number}";
      }
      else if (opt.isShortAuthor())
      {
        txt += "{shortauthor}";
      }
      else if (opt.isYear())
      {
        txt += "{year}";
      }
      if (!opt.noPar()) txt += "{1}";
      else txt += "{0}";
 
      m_t << txt;
    }
    else
    {
      if (!opt.noPar()) txt += "[";
      txt += cite.target();
      if (!opt.noPar()) txt += "]";
      m_t << "{\\bfseries ";
      filter(txt);
      m_t << "}";
    }
  }
}

References DocCite::anchor(), CitationManager::anchorPrefix(), DocCite::file(), filter(), DocCite::getText(), CitationManager::instance(), QCString::isEmpty(), QCString::length(), m_hide, m_t, QCString::mid(), DocCite::option(), and DocCite::target().

operator()() [5/58]

void LatexDocVisitor::operator()

(

const DocDiaFile &

df

)

Definition at line 1582 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(LATEX_OUTPUT)+"/"+stripPath(df.file()));
  startDiaFile(df.file(),df.width(),df.height(),df.hasCaption(),df.srcFile(),df.srcLine());
  visitChildren(df);
  endDiaFile(df.hasCaption());
}

References Config_getBool, Config_getString, copyFile(), endDiaFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startDiaFile(), stripPath(), visitChildren(), and DocDiagramFileBase::width().

operator()() [6/58]

void LatexDocVisitor::operator()

(

const DocDotFile &

df

)

Definition at line 1564 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(LATEX_OUTPUT)+"/"+stripPath(df.file()));
  startDotFile(df.file(),df.width(),df.height(),df.hasCaption(),df.srcFile(),df.srcLine());
  visitChildren(df);
  endDotFile(df.hasCaption());
}

References Config_getBool, Config_getString, copyFile(), endDotFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startDotFile(), stripPath(), visitChildren(), and DocDiagramFileBase::width().

operator()() [7/58]

void LatexDocVisitor::operator()

(

const DocEmoji &

s

)

Definition at line 347 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  QCString emojiName = EmojiEntityMapper::instance().name(s.index());
  if (!emojiName.isEmpty())
  {
    QCString imageName=emojiName.mid(1,emojiName.length()-2); // strip : at start and end
    if (m_texOrPdf != TexOrPdf::PDF) m_t << "\\doxygenemoji{";
    filter(emojiName);
    if (m_texOrPdf != TexOrPdf::PDF) m_t << "}{" << imageName << "}";
  }
  else
  {
    m_t << s.name();
  }
}

References filter(), DocEmoji::index(), EmojiEntityMapper::instance(), QCString::isEmpty(), QCString::length(), m_hide, m_t, m_texOrPdf, QCString::mid(), DocEmoji::name(), EmojiEntityMapper::name(), and PDF.

operator()() [8/58]

void LatexDocVisitor::operator()

(

const DocFormula &

f

)

Definition at line 725 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  QCString s = f.text();
  const char *p = s.data();
  char c = 0;
  if (p)
  {
    while ((c=*p++))
    {
      switch (c)
      {
        case '\'': m_t << "\\textnormal{\\textquotesingle}"; break;
        default:  m_t << c; break;
      }
    }
  }
}

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

operator()() [9/58]

void LatexDocVisitor::operator()

(

const DocHorRuler &

)

Definition at line 384 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (insideTable())
    m_t << "\\DoxyHorRuler{1}\n";
  else
    m_t << "\\DoxyHorRuler{0}\n";
}

References insideTable(), m_hide, and m_t.

operator()() [10/58]

void LatexDocVisitor::operator()

(

const DocHRef &

href

)

Definition at line 1493 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (Config_getBool(PDF_HYPERLINKS))
  {
    m_t << "\\href{";
    m_t << latexFilterURL(href.url());
    m_t << "}";
  }
  m_t << "{\\texttt{";
  visitChildren(href);
  m_t << "}}";
}

References Config_getBool, latexFilterURL(), m_hide, m_t, DocHRef::url(), and visitChildren().

operator()() [11/58]

void LatexDocVisitor::operator()

(

const DocHtmlBlockQuote &

q

)

Definition at line 1862 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\begin{quote}\n";
  incIndentLevel();
  visitChildren(q);
  m_t << "\\end{quote}\n";
  decIndentLevel();
}

References decIndentLevel(), incIndentLevel(), m_hide, m_t, and visitChildren().

operator()() [12/58]

void LatexDocVisitor::operator()

(

const DocHtmlCaption &

c

)

Definition at line 1342 of file latexdocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [13/58]

void LatexDocVisitor::operator()

(

const DocHtmlCell &

c

)

Definition at line 1378 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  //printf("Cell(r=%u,c=%u) rowSpan=%d colSpan=%d currentColumn()=%zu\n",c.rowIndex(),c.columnIndex(),c.rowSpan(),c.colSpan(),currentColumn());
 
  setCurrentColumn(currentColumn()+1);
 
  QCString cellOpts;
  QCString cellSpec;
  auto appendOpt = [&cellOpts](const QCString &s)
  {
    if (!cellOpts.isEmpty()) cellOpts+=",";
    cellOpts+=s;
  };
  auto appendSpec = [&cellSpec](const QCString &s)
  {
    if (!cellSpec.isEmpty()) cellSpec+=",";
    cellSpec+=s;
  };
  auto writeCell = [this,&cellOpts,&cellSpec]()
  {
    if (!cellOpts.isEmpty() || !cellSpec.isEmpty())
    {
      m_t << "\\SetCell";
      if (!cellOpts.isEmpty())
      {
        m_t << "[" << cellOpts << "]";
      }
      m_t << "{" << cellSpec << "}";
    }
  };
 
  // skip over columns that have a row span starting at an earlier row
  for (const auto &span : rowSpans())
  {
    //printf("span(r=%u,c=%u): column=%zu colSpan=%zu,rowSpan=%zu currentColumn()=%zu\n",
    //    span.cell.rowIndex(),span.cell.columnIndex(),
    //    span.column,span.colSpan,span.rowSpan,
    //    currentColumn());
    if (span.rowSpan>0 && span.column==currentColumn())
    {
      setCurrentColumn(currentColumn()+span.colSpan);
      for (size_t i=0;i<span.colSpan;i++)
      {
        m_t << "&";
      }
    }
  }
 
  int cs = c.colSpan();
  int ha = c.alignment();
  int rs = c.rowSpan();
  int va = c.valignment();
 
  switch (ha) // horizontal alignment
  {
    case DocHtmlCell::Right:
      appendSpec("r");
      break;
    case DocHtmlCell::Center:
      appendSpec("c");
      break;
    default:
      // default
      break;
  }
  if (rs>0) // row span
  {
    appendOpt("r="+QCString().setNum(rs));
    //printf("adding row span: cell={r=%d c=%d rs=%d cs=%d} curCol=%zu\n",
    //                       c.rowIndex(),c.columnIndex(),c.rowSpan(),c.colSpan(),
    //                       currentColumn());
    addRowSpan(ActiveRowSpan(c,rs,cs,currentColumn()));
  }
  if (cs>1) // column span
  {
    // update column to the end of the span, needs to be done *after* calling addRowSpan()
    setCurrentColumn(currentColumn()+cs-1);
    appendOpt("c="+QCString().setNum(cs));
  }
  if (c.isHeading())
  {
    appendSpec("bg=\\tableheadbgcolor");
    appendSpec("font=\\bfseries");
  }
  switch(va) // vertical alignment
  {
    case DocHtmlCell::Top:
      appendSpec("h");
      break;
    case DocHtmlCell::Bottom:
      appendSpec("f");
      break;
    case DocHtmlCell::Middle:
      // default
      break;
  }
  writeCell();
 
  visitChildren(c);
 
  for (int i=0;i<cs-1;i++)
  {
    m_t << "&"; // placeholder for invisible cell
  }
 
  if (!c.isLast()) m_t << "&";
}

References addRowSpan(), DocHtmlCell::alignment(), DocHtmlCell::Bottom, DocHtmlCell::Center, DocHtmlCell::colSpan(), currentColumn(), QCString::isEmpty(), DocHtmlCell::isHeading(), DocHtmlCell::isLast(), m_hide, m_t, DocHtmlCell::Middle, DocHtmlCell::Right, DocHtmlCell::rowSpan(), rowSpans(), setCurrentColumn(), DocHtmlCell::Top, DocHtmlCell::valignment(), and visitChildren().

operator()() [14/58]

void LatexDocVisitor::operator()

(

const DocHtmlDescData &

dd

)

Definition at line 1253 of file latexdocvisitor.cpp.

{
  incIndentLevel();
  if (!m_insideItem) m_t << "\\hfill";
  m_t << " \\\\\n";
  visitChildren(dd);
  decIndentLevel();
}

References decIndentLevel(), incIndentLevel(), m_insideItem, m_t, and visitChildren().

operator()() [15/58]

void LatexDocVisitor::operator()

(

const DocHtmlDescList &

dl

)

Definition at line 1219 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  bool eq = classEqualsReflist(dl);
  if (eq)
  {
    m_t << "\n\\begin{DoxyRefList}";
  }
  else
  {
    if (listIsNested(dl)) m_t << "\n\\hfill";
    m_t << "\n\\begin{DoxyDescription}";
  }
  visitChildren(dl);
  if (eq)
  {
    m_t << "\n\\end{DoxyRefList}";
  }
  else
  {
    m_t << "\n\\end{DoxyDescription}";
  }
}

References classEqualsReflist(), listIsNested(), m_hide, m_t, and visitChildren().

operator()() [16/58]

void LatexDocVisitor::operator()

(

const DocHtmlDescTitle &

dt

)

Definition at line 1243 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\n\\item[";
  m_insideItem=TRUE;
  visitChildren(dt);
  m_insideItem=FALSE;
  m_t << "]";
}

References FALSE, m_hide, m_insideItem, m_t, TRUE, and visitChildren().

operator()() [17/58]

void LatexDocVisitor::operator()

(

const DocHtmlDetails &

d

)

Definition at line 1515 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\n\n";
  auto summary = d.summary();
  if (summary)
  {
    std::visit(*this,*summary);
    m_t << "\\begin{adjustwidth}{1em}{0em}\n";
  }
  visitChildren(d);
  if (summary)
  {
    m_t << "\\end{adjustwidth}\n";
  }
  else
  {
    m_t << "\n\n";
  }
}

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

operator()() [18/58]

void LatexDocVisitor::operator()

(

const DocHtmlHeader &

header

)

Definition at line 1536 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\" << getSectionName(header.level()) << "*{";
  visitChildren(header);
  m_t << "}";
}

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

operator()() [19/58]

void LatexDocVisitor::operator()

(

const DocHtmlList &

s

)

Definition at line 1103 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (m_indentLevel>=maxIndentLevels-1) return;
  m_listItemInfo[indentLevel()].isEnum = s.type()==DocHtmlList::Ordered;
  if (s.type()==DocHtmlList::Ordered)
  {
    bool first = true;
    m_t << "\n\\begin{DoxyEnumerate}";
    for (const auto &opt : s.attribs())
    {
      if (opt.name=="type")
      {
        if (opt.value=="1")
        {
          m_t << (first ?  "[": ",");
          m_t << "label=\\arabic*";
          first = false;
        }
        else if (opt.value=="a")
        {
          m_t << (first ?  "[": ",");
          m_t << "label=\\enumalphalphcnt*";
          first = false;
        }
        else if (opt.value=="A")
        {
          m_t << (first ?  "[": ",");
          m_t << "label=\\enumAlphAlphcnt*";
          first = false;
        }
        else if (opt.value=="i")
        {
          m_t << (first ?  "[": ",");
          m_t << "label=\\roman*";
          first = false;
        }
        else if (opt.value=="I")
        {
          m_t << (first ?  "[": ",");
          m_t << "label=\\Roman*";
          first = false;
        }
      }
      else if (opt.name=="start")
      {
        m_t << (first ?  "[": ",");
        bool ok = false;
        int val = opt.value.toInt(&ok);
        if (ok) m_t << "start=" << val;
        first = false;
      }
    }
    if (!first) m_t << "]\n";
  }
  else
  {
    m_t << "\n\\begin{DoxyItemize}";
  }
  visitChildren(s);
  if (m_indentLevel>=maxIndentLevels-1) return;
  if (s.type()==DocHtmlList::Ordered)
    m_t << "\n\\end{DoxyEnumerate}";
  else
    m_t << "\n\\end{DoxyItemize}";
}

References DocHtmlList::attribs(), indentLevel(), m_hide, m_indentLevel, m_listItemInfo, m_t, maxIndentLevels, DocHtmlList::Ordered, DocHtmlList::type(), and visitChildren().

operator()() [20/58]

void LatexDocVisitor::operator()

(

const DocHtmlListItem &

l

)

Definition at line 1170 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (m_listItemInfo[indentLevel()].isEnum)
  {
    for (const auto &opt : l.attribs())
    {
      if (opt.name=="value")
      {
        bool ok = false;
        int val = opt.value.toInt(&ok);
        if (ok)
        {
          m_t << "\n\\setcounter{DoxyEnumerate" << integerToRoman(indentLevel()+1,false) << "}{" << (val - 1) << "}";
        }
      }
    }
  }
  m_t << "\n\\item ";
  incIndentLevel();
  visitChildren(l);
  decIndentLevel();
}

References DocHtmlListItem::attribs(), decIndentLevel(), incIndentLevel(), indentLevel(), integerToRoman(), m_hide, m_listItemInfo, m_t, and visitChildren().

operator()() [21/58]

void LatexDocVisitor::operator()

(

const DocHtmlRow &

row

)

Definition at line 1348 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  setCurrentColumn(0);
 
  visitChildren(row);
 
  m_t << "\\\\";
 
  size_t col = 1;
  for (auto &span : rowSpans())
  {
    if (span.rowSpan>0) span.rowSpan--;
    if (span.rowSpan<=0)
    {
      // inactive span
    }
    else if (span.column>col)
    {
      col = span.column+span.colSpan;
    }
    else
    {
      col = span.column+span.colSpan;
    }
  }
 
  m_t << "\n";
}

References m_hide, m_t, rowSpans(), setCurrentColumn(), and visitChildren().

operator()() [22/58]

void LatexDocVisitor::operator()

(

const DocHtmlSummary &

d

)

Definition at line 1507 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "{\\bfseries{";
  visitChildren(d);
  m_t << "}}";
}

References m_hide, m_t, and visitChildren().

operator()() [23/58]

void LatexDocVisitor::operator()

(

const DocHtmlTable &

t

)

Definition at line 1297 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  pushTableState();
  const DocHtmlCaption *c = t.caption() ? &std::get<DocHtmlCaption>(*t.caption()) : nullptr;
  if (c)
  {
    bool pdfHyperLinks = Config_getBool(PDF_HYPERLINKS);
    if (!c->file().isEmpty() && pdfHyperLinks)
    {
      m_t << "\\hypertarget{" << stripPath(c->file()) << "_" << c->anchor()
        << "}{}";
    }
    m_t << "\n";
  }
 
  writeStartTableCommand(t.parent(),t.numColumns());
  if (!isTableNested(t.parent()))
  {
    // write caption
    m_t << "{";
    if (c)
    {
      std::visit(*this, *t.caption());
    }
    m_t << "}";
    // write label
    m_t << "{";
    if (c && (!stripPath(c->file()).isEmpty() || !c->anchor().isEmpty()))
    {
      m_t << stripPath(c->file()) << "_" << c->anchor();
    }
    m_t << "}";
  }
 
  // write head row(s)
  m_t << "{" << t.numberHeaderRows() << "}\n";
 
  setNumCols(t.numColumns());
 
  visitChildren(t);
  writeEndTableCommand(t.parent());
  popTableState();
}

References DocHtmlCaption::anchor(), DocHtmlTable::caption(), Config_getBool, DocHtmlCaption::file(), QCString::isEmpty(), isTableNested(), m_hide, m_t, DocHtmlTable::numberHeaderRows(), DocHtmlTable::numColumns(), DocNode::parent(), popTableState(), pushTableState(), setNumCols(), stripPath(), visitChildren(), writeEndTableCommand(), and writeStartTableCommand().

operator()() [24/58]

void LatexDocVisitor::operator()

(

const DocImage &

img

)

Definition at line 1544 of file latexdocvisitor.cpp.

{
  if (img.type()==DocImage::Latex)
  {
    if (m_hide) return;
    QCString gfxName = img.name();
    if (gfxName.endsWith(".eps") || gfxName.endsWith(".pdf"))
    {
      gfxName=gfxName.left(gfxName.length()-4);
    }
 
    visitPreStart(m_t,img.hasCaption(), gfxName, img.width(),  img.height(), img.isInlineImage());
    visitChildren(img);
    visitPostEnd(m_t,img.hasCaption(), img.isInlineImage());
  }
  else // other format -> skip
  {
  }
}

References QCString::endsWith(), DocImage::hasCaption(), DocImage::height(), DocImage::isInlineImage(), DocImage::Latex, QCString::left(), QCString::length(), m_hide, m_t, DocImage::name(), DocImage::type(), visitChildren(), visitPostEnd(), visitPreStart(), and DocImage::width().

operator()() [25/58]

void LatexDocVisitor::operator()

(

const DocInclude &

inc

)

Definition at line 587 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  SrcLangExt langExt = getLanguageFromFileName(inc.extension());
  switch(inc.type())
  {
    case DocInclude::IncWithLines:
      {
        m_ci.startCodeFragment("DoxyCodeInclude");
        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   // show line numbers
                                                 );
        m_ci.endCodeFragment("DoxyCodeInclude");
      }
      break;
    case DocInclude::Include:
      {
        m_ci.startCodeFragment("DoxyCodeInclude");
        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_ci.endCodeFragment("DoxyCodeInclude");
      }
      break;
    case DocInclude::DontInclude:
    case DocInclude::DontIncWithLines:
    case DocInclude::HtmlInclude:
    case DocInclude::RtfInclude:
    case DocInclude::ManInclude:
    case DocInclude::XmlInclude:
    case DocInclude::DocbookInclude:
      break;
    case DocInclude::LatexInclude:
      m_t << inc.text();
      break;
    case DocInclude::VerbInclude:
      if (isTableNested(inc.parent())) // in table
      {
        m_t << "\\begin{DoxyCode}{0}";
        filter(inc.text(), true);
        m_t << "\\end{DoxyCode}\n";
      }
      else
      {
        m_t << "\n\\begin{DoxyVerbInclude}\n";
        m_t << inc.text();
        m_t << "\\end{DoxyVerbInclude}\n";
      }
      break;
    case DocInclude::Snippet:
    case DocInclude::SnippetWithLines:
      {
        m_ci.startCodeFragment("DoxyCodeInclude");
        CodeFragmentManager::instance().parseCodeFragment(m_ci,
                                         inc.file(),
                                         inc.blockId(),
                                         inc.context(),
                                         inc.type()==DocInclude::SnippetWithLines,
                                         inc.trimLeft(),
                                         inc.stripCodeComments()
                                        );
        m_ci.endCodeFragment("DoxyCodeInclude");
      }
      break;
  }
}

References DocInclude::blockId(), DocInclude::context(), createFileDef(), FileInfo::dirPath(), DocInclude::DocbookInclude, DocInclude::DontInclude, DocInclude::DontIncWithLines, DocInclude::exampleFile(), DocInclude::extension(), FALSE, DocInclude::file(), FileInfo::fileName(), filter(), DocVisitor::getCodeParser(), getLanguageFromFileName(), DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, CodeFragmentManager::instance(), DocInclude::isExample(), isTableNested(), DocInclude::LatexInclude, m_ci, m_hide, m_t, DocInclude::ManInclude, DocNode::parent(), 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 LatexDocVisitor::operator()

(

const DocIncOperator &

op

)

Definition at line 675 of file latexdocvisitor.cpp.

{
  //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) m_ci.startCodeFragment("DoxyCodeInclude");
    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(),
                                          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) m_ci.endCodeFragment("DoxyCodeInclude");
  }
  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_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 LatexDocVisitor::operator()

(

const DocIndexEntry &

i

)

Definition at line 744 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\index{";
  m_t << latexEscapeLabelName(i.entry());
  m_t << "@{";
  m_t << latexEscapeIndexChars(i.entry());
  m_t << "}}";
}

References DocIndexEntry::entry(), latexEscapeIndexChars(), latexEscapeLabelName(), m_hide, and m_t.

operator()() [28/58]

void LatexDocVisitor::operator()

(

const DocInternal &

i

)

Definition at line 1487 of file latexdocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [29/58]

void LatexDocVisitor::operator()

(

const DocInternalRef &

ref

)

Definition at line 1848 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  startLink(QCString(),ref.file(),ref.anchor());
  visitChildren(ref);
  endLink(QCString(),ref.file(),ref.anchor());
}

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

operator()() [30/58]

void LatexDocVisitor::operator()

(

const DocLineBreak &

)

Definition at line 378 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "~\\newline\n";
}

References m_hide, and m_t.

operator()() [31/58]

void LatexDocVisitor::operator()

(

const DocLink &

lnk

)

Definition at line 1600 of file latexdocvisitor.cpp.

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

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

operator()() [32/58]

void LatexDocVisitor::operator()

(

const DocLinkedWord &

w

)

Definition at line 286 of file latexdocvisitor.cpp.

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

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

operator()() [33/58]

void LatexDocVisitor::operator()

(

const DocMscFile &

df

)

Definition at line 1573 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (!Config_getBool(DOT_CLEANUP)) copyFile(df.file(),Config_getString(LATEX_OUTPUT)+"/"+stripPath(df.file()));
  startMscFile(df.file(),df.width(),df.height(),df.hasCaption(),df.srcFile(),df.srcLine());
  visitChildren(df);
  endMscFile(df.hasCaption());
}

References Config_getBool, Config_getString, copyFile(), endMscFile(), DocDiagramFileBase::file(), DocDiagramFileBase::hasCaption(), DocDiagramFileBase::height(), m_hide, DocDiagramFileBase::srcFile(), DocDiagramFileBase::srcLine(), startMscFile(), stripPath(), visitChildren(), and DocDiagramFileBase::width().

operator()() [34/58]

void LatexDocVisitor::operator()

(

const DocPara &

p

)

Definition at line 867 of file latexdocvisitor.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 (insideTable())
    {
      m_t << "~\\newline\n";
    }
    else
    {
      m_t << "\n\n";
    }
  }
}

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

operator()() [35/58]

void LatexDocVisitor::operator()

(

const DocParamList &

pl

)

Definition at line 1740 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  DocParamSect::Type parentType = DocParamSect::Unknown;
  const DocParamSect *sect = std::get_if<DocParamSect>(pl.parent());
  if (sect)
  {
    parentType = sect->type();
  }
  bool useTable = parentType==DocParamSect::Param ||
                  parentType==DocParamSect::RetVal ||
                  parentType==DocParamSect::Exception ||
                  parentType==DocParamSect::TemplateParam;
  if (!useTable)
  {
    m_t << "\\item[";
  }
  if (sect && sect->hasInOutSpecifier())
  {
    if (pl.direction()!=DocParamSect::Unspecified)
    {
      m_t << "\\mbox{\\texttt{";
      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 << "}} ";
    }
    if (useTable) m_t << " & ";
  }
  if (sect && sect->hasTypeSpecifier())
  {
    for (const auto &type : pl.paramTypes())
    {
      std::visit(*this,type);
    }
    if (useTable) m_t << " & ";
  }
  m_t << "{\\em ";
  bool first=TRUE;
  for (const auto &param : pl.parameters())
  {
    if (!first) m_t << ","; else first=FALSE;
    m_insideItem=TRUE;
    std::visit(*this,param);
    m_insideItem=FALSE;
  }
  m_t << "}";
  if (useTable)
  {
    m_t << " & ";
  }
  else
  {
    m_t << "]";
  }
  for (const auto &par : pl.paragraphs())
  {
    std::visit(*this,par);
  }
  if (useTable)
  {
    m_t << "\\\\\n"
        << "\\hline\n";
  }
}

References DocParamList::direction(), DocParamSect::Exception, FALSE, DocParamSect::hasInOutSpecifier(), DocParamSect::hasTypeSpecifier(), DocParamSect::In, DocParamSect::InOut, m_hide, m_insideItem, m_t, DocParamSect::Out, DocParamList::paragraphs(), DocParamSect::Param, DocParamList::parameters(), DocParamList::paramTypes(), DocNode::parent(), DocParamSect::RetVal, DocParamSect::TemplateParam, TRUE, DocParamSect::type(), DocParamSect::Unknown, and DocParamSect::Unspecified.

operator()() [36/58]

void LatexDocVisitor::operator()

(

const DocParamSect &

s

)

Definition at line 1681 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  bool hasInOutSpecs = s.hasInOutSpecifier();
  bool hasTypeSpecs  = s.hasTypeSpecifier();
  m_lcg.incUsedTableLevel();
  switch(s.type())
  {
    case DocParamSect::Param:
      m_t << "\n\\begin{DoxyParams}";
      if      (hasInOutSpecs && hasTypeSpecs) m_t << "[2]"; // 2 extra cols
      else if (hasInOutSpecs || hasTypeSpecs) m_t << "[1]"; // 1 extra col
      m_t << "{";
      filter(theTranslator->trParameters());
      break;
    case DocParamSect::RetVal:
      m_t << "\n\\begin{DoxyRetVals}{";
      filter(theTranslator->trReturnValues());
      break;
    case DocParamSect::Exception:
      m_t << "\n\\begin{DoxyExceptions}{";
      filter(theTranslator->trExceptions());
      break;
    case DocParamSect::TemplateParam:
      m_t << "\n\\begin{DoxyTemplParams}{";
      filter(theTranslator->trTemplateParameters());
      break;
    default:
      ASSERT(0);
      incIndentLevel();
  }
  m_t << "}\n";
  visitChildren(s);
  m_lcg.decUsedTableLevel();
  switch(s.type())
  {
    case DocParamSect::Param:
      m_t << "\\end{DoxyParams}\n";
      break;
    case DocParamSect::RetVal:
      m_t << "\\end{DoxyRetVals}\n";
      break;
    case DocParamSect::Exception:
      m_t << "\\end{DoxyExceptions}\n";
      break;
    case DocParamSect::TemplateParam:
      m_t << "\\end{DoxyTemplParams}\n";
      break;
    default:
      ASSERT(0);
      decIndentLevel();
  }
}

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

operator()() [37/58]

void LatexDocVisitor::operator()

(

const DocParBlock &

pb

)

Definition at line 1876 of file latexdocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [38/58]

void LatexDocVisitor::operator()

(

const DocPlantUmlFile &

df

)

Definition at line 1591 of file latexdocvisitor.cpp.

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

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

operator()() [39/58]

void LatexDocVisitor::operator()

(

const DocRef &

ref

)

Definition at line 1608 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  // when ref.isSubPage()==TRUE we use ref.file() for HTML and
  // ref.anchor() for LaTeX/RTF
  if (ref.isSubPage())
  {
    startLink(ref.ref(),QCString(),ref.anchor());
  }
  else
  {
    if (!ref.file().isEmpty()) startLink(ref.ref(),ref.file(),ref.anchor(),ref.refToTable(),ref.refToSection());
  }
  if (!ref.hasLinkText())
  {
    filter(ref.targetTitle());
  }
  visitChildren(ref);
  if (ref.isSubPage())
  {
    endLink(ref.ref(),QCString(),ref.anchor());
  }
  else
  {
    if (!ref.file().isEmpty()) endLink(ref.ref(),ref.file(),ref.anchor(),ref.refToTable(),ref.refToSection(),ref.sectionType());
  }
}

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

operator()() [40/58]

void LatexDocVisitor::operator()

(

const DocRoot &

r

)

Definition at line 888 of file latexdocvisitor.cpp.

{
  visitChildren(r);
}

References visitChildren().

operator()() [41/58]

void LatexDocVisitor::operator()

(

const DocSecRefItem &

ref

)

Definition at line 1636 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\item \\contentsline{section}{";
  if (ref.isSubPage())
  {
    startLink(ref.ref(),QCString(),ref.anchor());
  }
  else
  {
    if (!ref.file().isEmpty())
    {
      startLink(ref.ref(),ref.file(),ref.anchor(),ref.refToTable());
    }
  }
  visitChildren(ref);
  if (ref.isSubPage())
  {
    endLink(ref.ref(),QCString(),ref.anchor());
  }
  else
  {
    if (!ref.file().isEmpty()) endLink(ref.ref(),ref.file(),ref.anchor(),ref.refToTable());
  }
  m_t << "}{\\ref{";
  if (!ref.file().isEmpty()) m_t << stripPath(ref.file());
  if (!ref.file().isEmpty() && !ref.anchor().isEmpty()) m_t << "_";
  if (!ref.anchor().isEmpty()) m_t << ref.anchor();
  m_t << "}}{}\n";
}

References DocSecRefItem::anchor(), endLink(), DocSecRefItem::file(), QCString::isEmpty(), DocSecRefItem::isSubPage(), m_hide, m_t, DocSecRefItem::ref(), DocSecRefItem::refToTable(), startLink(), stripPath(), and visitChildren().

operator()() [42/58]

void LatexDocVisitor::operator()

(

const DocSecRefList &

l

)

Definition at line 1667 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\footnotesize\n";
  m_t << "\\begin{multicols}{2}\n";
  m_t << "\\begin{DoxyCompactList}\n";
  incIndentLevel();
  visitChildren(l);
  decIndentLevel();
  m_t << "\\end{DoxyCompactList}\n";
  m_t << "\\end{multicols}\n";
  m_t << "\\normalsize\n";
}

References decIndentLevel(), incIndentLevel(), m_hide, m_t, and visitChildren().

operator()() [43/58]

void LatexDocVisitor::operator()

(

const DocSection &

s

)

Definition at line 1069 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (pdfHyperlinks)
  {
    m_t << "\\hypertarget{" << stripPath(s.file()) << "_" << s.anchor() << "}{}";
  }
  m_t << "\\" << getSectionName(s.level()) << "{";
  if (pdfHyperlinks)
  {
    m_t << "\\texorpdfstring{";
  }
  if (s.title())
  {
    if (pdfHyperlinks) m_texOrPdf = TexOrPdf::TEX;
    std::visit(*this,*s.title());
    m_texOrPdf = TexOrPdf::NO;
  }
  if (pdfHyperlinks)
  {
    m_t << "}{";
    if (s.title())
    {
      if (pdfHyperlinks) m_texOrPdf = TexOrPdf::PDF;
      std::visit(*this,*s.title());
      m_texOrPdf = TexOrPdf::NO;
    }
    m_t << "}";
  }
  m_t << "}\\label{" << stripPath(s.file()) << "_" << s.anchor() << "}\n";
  visitChildren(s);
}

References DocSection::anchor(), Config_getBool, DocSection::file(), getSectionName(), DocSection::level(), m_hide, m_t, m_texOrPdf, NO, PDF, stripPath(), TEX, DocSection::title(), and visitChildren().

operator()() [44/58]

void LatexDocVisitor::operator()

(

const DocSeparator &

sep

)

Definition at line 1735 of file latexdocvisitor.cpp.

{
  m_t << " " << sep.chars() << " ";
}

References DocSeparator::chars(), and m_t.

operator()() [45/58]

void LatexDocVisitor::operator()

(

const DocSimpleList &

l

)

Definition at line 1048 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\begin{DoxyItemize}\n";
  m_listItemInfo[indentLevel()].isEnum = false;
  visitChildren(l);
  m_t << "\\end{DoxyItemize}\n";
}

References indentLevel(), m_hide, m_listItemInfo, m_t, and visitChildren().

operator()() [46/58]

void LatexDocVisitor::operator()

(

const DocSimpleListItem &

li

)

Definition at line 1057 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  m_t << "\\item ";
  incIndentLevel();
  if (li.paragraph())
  {
    visit(*this,*li.paragraph());
  }
  decIndentLevel();
}

References decIndentLevel(), incIndentLevel(), m_hide, m_t, and DocSimpleListItem::paragraph().

operator()() [47/58]

void LatexDocVisitor::operator()

(

const DocSimpleSect &

s

)

Definition at line 893 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  switch(s.type())
  {
    case DocSimpleSect::See:
      m_t << "\\begin{DoxySeeAlso}{";
      filter(theTranslator->trSeeAlso());
      break;
    case DocSimpleSect::Return:
      m_t << "\\begin{DoxyReturn}{";
      filter(theTranslator->trReturns());
      break;
    case DocSimpleSect::Author:
      m_t << "\\begin{DoxyAuthor}{";
      filter(theTranslator->trAuthor(TRUE,TRUE));
      break;
    case DocSimpleSect::Authors:
      m_t << "\\begin{DoxyAuthor}{";
      filter(theTranslator->trAuthor(TRUE,FALSE));
      break;
    case DocSimpleSect::Version:
      m_t << "\\begin{DoxyVersion}{";
      filter(theTranslator->trVersion());
      break;
    case DocSimpleSect::Since:
      m_t << "\\begin{DoxySince}{";
      filter(theTranslator->trSince());
      break;
    case DocSimpleSect::Date:
      m_t << "\\begin{DoxyDate}{";
      filter(theTranslator->trDate());
      break;
    case DocSimpleSect::Note:
      m_t << "\\begin{DoxyNote}{";
      filter(theTranslator->trNote());
      break;
    case DocSimpleSect::Warning:
      m_t << "\\begin{DoxyWarning}{";
      filter(theTranslator->trWarning());
      break;
    case DocSimpleSect::Pre:
      m_t << "\\begin{DoxyPrecond}{";
      filter(theTranslator->trPrecondition());
      break;
    case DocSimpleSect::Post:
      m_t << "\\begin{DoxyPostcond}{";
      filter(theTranslator->trPostcondition());
      break;
    case DocSimpleSect::Copyright:
      m_t << "\\begin{DoxyCopyright}{";
      filter(theTranslator->trCopyright());
      break;
    case DocSimpleSect::Invar:
      m_t << "\\begin{DoxyInvariant}{";
      filter(theTranslator->trInvariant());
      break;
    case DocSimpleSect::Remark:
      m_t << "\\begin{DoxyRemark}{";
      filter(theTranslator->trRemarks());
      break;
    case DocSimpleSect::Attention:
      m_t << "\\begin{DoxyAttention}{";
      filter(theTranslator->trAttention());
      break;
    case DocSimpleSect::Important:
      m_t << "\\begin{DoxyImportant}{";
      filter(theTranslator->trImportant());
      break;
    case DocSimpleSect::User:
      m_t << "\\begin{DoxyParagraph}{";
      break;
    case DocSimpleSect::Rcs:
      m_t << "\\begin{DoxyParagraph}{";
      break;
    case DocSimpleSect::Unknown:  break;
  }
 
  if (s.title())
  {
    m_insideItem=TRUE;
    std::visit(*this,*s.title());
    m_insideItem=FALSE;
  }
  m_t << "}\n";
  incIndentLevel();
  visitChildren(s);
  switch(s.type())
  {
    case DocSimpleSect::See:
      m_t << "\n\\end{DoxySeeAlso}\n";
      break;
    case DocSimpleSect::Return:
      m_t << "\n\\end{DoxyReturn}\n";
      break;
    case DocSimpleSect::Author:
      m_t << "\n\\end{DoxyAuthor}\n";
      break;
    case DocSimpleSect::Authors:
      m_t << "\n\\end{DoxyAuthor}\n";
      break;
    case DocSimpleSect::Version:
      m_t << "\n\\end{DoxyVersion}\n";
      break;
    case DocSimpleSect::Since:
      m_t << "\n\\end{DoxySince}\n";
      break;
    case DocSimpleSect::Date:
      m_t << "\n\\end{DoxyDate}\n";
      break;
    case DocSimpleSect::Note:
      m_t << "\n\\end{DoxyNote}\n";
      break;
    case DocSimpleSect::Warning:
      m_t << "\n\\end{DoxyWarning}\n";
      break;
    case DocSimpleSect::Pre:
      m_t << "\n\\end{DoxyPrecond}\n";
      break;
    case DocSimpleSect::Post:
      m_t << "\n\\end{DoxyPostcond}\n";
      break;
    case DocSimpleSect::Copyright:
      m_t << "\n\\end{DoxyCopyright}\n";
      break;
    case DocSimpleSect::Invar:
      m_t << "\n\\end{DoxyInvariant}\n";
      break;
    case DocSimpleSect::Remark:
      m_t << "\n\\end{DoxyRemark}\n";
      break;
    case DocSimpleSect::Attention:
      m_t << "\n\\end{DoxyAttention}\n";
      break;
    case DocSimpleSect::Important:
      m_t << "\n\\end{DoxyImportant}\n";
      break;
    case DocSimpleSect::User:
      m_t << "\n\\end{DoxyParagraph}\n";
      break;
    case DocSimpleSect::Rcs:
      m_t << "\n\\end{DoxyParagraph}\n";
      break;
    default:
      break;
  }
  decIndentLevel();
}

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Copyright, DocSimpleSect::Date, decIndentLevel(), FALSE, filter(), DocSimpleSect::Important, incIndentLevel(), DocSimpleSect::Invar, m_hide, m_insideItem, 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 LatexDocVisitor::operator()

(

const DocSimpleSectSep &

)

Definition at line 754 of file latexdocvisitor.cpp.

{
}

operator()() [49/58]

void LatexDocVisitor::operator()

(

const DocStyleChange &

s

)

Definition at line 393 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  switch (s.style())
  {
    case DocStyleChange::Bold:
      if (s.enable()) m_t << "{\\bfseries{";      else m_t << "}}";
      break;
    case DocStyleChange::S:
    case DocStyleChange::Strike:
    case DocStyleChange::Del:
      if (s.enable()) m_t << "\\sout{";     else m_t << "}";
      break;
    case DocStyleChange::Underline:
    case DocStyleChange::Ins:
      if (s.enable()) m_t << "\\uline{";     else m_t << "}";
      break;
    case DocStyleChange::Italic:
      if (s.enable()) m_t << "{\\itshape ";     else m_t << "}";
      break;
    case DocStyleChange::Kbd:
    case DocStyleChange::Typewriter:
    case DocStyleChange::Code:
      if (s.enable()) m_t << "{\\ttfamily ";   else m_t << "}";
      break;
    case DocStyleChange::Subscript:
      if (s.enable()) m_t << "\\textsubscript{";    else m_t << "}";
      break;
    case DocStyleChange::Superscript:
      if (s.enable()) m_t << "\\textsuperscript{";    else m_t << "}";
      break;
    case DocStyleChange::Center:
      if (s.enable()) m_t << "\\begin{center}"; else m_t << "\\end{center} ";
      break;
    case DocStyleChange::Small:
      if (s.enable()) m_t << "\n\\footnotesize ";  else m_t << "\n\\normalsize ";
      break;
    case DocStyleChange::Cite:
      if (s.enable()) m_t << "{\\itshape ";     else m_t << "}";
      break;
    case DocStyleChange::Preformatted:
      if (s.enable())
      {
        m_t << "\n\\begin{DoxyPre}";
        m_insidePre=TRUE;
      }
      else
      {
        m_insidePre=FALSE;
        m_t << "\\end{DoxyPre}\n";
      }
      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_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 LatexDocVisitor::operator()

(

const DocSymbol &

s

)

Definition at line 307 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  const char *res = HtmlEntityMapper::instance().latex(s.symbol());
  if (res)
  {
    if (((s.symbol() == HtmlEntityMapper::Sym_lt) || (s.symbol() == HtmlEntityMapper::Sym_Less))&& (!m_insidePre))
    {
      if (pdfHyperlinks)
      {
        m_t << "\\texorpdfstring{$<$}{<}";
      }
      else
      {
        m_t << "$<$";
      }
    }
    else if (((s.symbol() == HtmlEntityMapper::Sym_gt) || (s.symbol() == HtmlEntityMapper::Sym_Greater)) && (!m_insidePre))
    {
      if (pdfHyperlinks)
      {
        m_t << "\\texorpdfstring{$>$}{>}";
      }
      else
      {
        m_t << "$>$";
      }
    }
    else
    {
      m_t << res;
    }
  }
  else
  {
    err("LaTeX: non supported HTML-entity found: {}\n",HtmlEntityMapper::instance().html(s.symbol(),TRUE));
  }
}

References Config_getBool, err, HtmlEntityMapper::instance(), HtmlEntityMapper::latex(), m_hide, m_insidePre, m_t, HtmlEntityMapper::Sym_Greater, HtmlEntityMapper::Sym_gt, HtmlEntityMapper::Sym_Less, HtmlEntityMapper::Sym_lt, DocSymbol::symbol(), and TRUE.

operator()() [51/58]

void LatexDocVisitor::operator()

(

const DocText &

t

)

Definition at line 1856 of file latexdocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [52/58]

void LatexDocVisitor::operator()

(

const DocTitle &

t

)

Definition at line 1042 of file latexdocvisitor.cpp.

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

References m_hide, and visitChildren().

operator()() [53/58]

void LatexDocVisitor::operator()

(

const DocURL &

u

)

Definition at line 364 of file latexdocvisitor.cpp.

{
  if (m_hide) return;
  if (Config_getBool(PDF_HYPERLINKS))
  {
    m_t << "\\href{";
    if (u.isEmail()) m_t << "mailto:";
    m_t << latexFilterURL(u.url()) << "}";
  }
  m_t << "{\\texttt{";
  filter(u.url());
  m_t << "}}";
}

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

operator()() [54/58]

void LatexDocVisitor::operator()

(

const DocVerbatim &

s

)

Definition at line 450 of file latexdocvisitor.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:
      {
        m_ci.startCodeFragment("DoxyCode");
        getCodeParser(lang).parseCode(m_ci,s.context(),s.text(),langExt,
                                      Config_getBool(STRIP_CODE_COMMENTS),
                                      s.isExample(),s.exampleFile());
        m_ci.endCodeFragment("DoxyCode");
      }
      break;
    case DocVerbatim::JavaDocLiteral:
      filter(s.text(), true);
      break;
    case DocVerbatim::JavaDocCode:
      m_t << "{\\ttfamily ";
      filter(s.text(), true);
      m_t << "}";
      break;
    case DocVerbatim::Verbatim:
      if (isTableNested(s.parent())) // in table
      {
        m_t << "\\begin{DoxyCode}{0}";
        filter(s.text(), true);
        m_t << "\\end{DoxyCode}\n";
      }
      else
      {
        m_t << "\\begin{DoxyVerb}";
        m_t << s.text();
        m_t << "\\end{DoxyVerb}\n";
      }
      break;
    case DocVerbatim::HtmlOnly:
    case DocVerbatim::XmlOnly:
    case DocVerbatim::ManOnly:
    case DocVerbatim::RtfOnly:
    case DocVerbatim::DocbookOnly:
      /* nothing */
      break;
    case DocVerbatim::LatexOnly:
      m_t << s.text();
      break;
    case DocVerbatim::Dot:
      {
        static int dotindex = 1;
        QCString fileName(4096, QCString::ExplicitSize);
 
        fileName.sprintf("%s%d%s",
            qPrint(Config_getString(LATEX_OUTPUT)+"/inline_dotgraph_"),
            dotindex++,
            ".dot"
           );
        std::ofstream file = Portable::openOutputStream(fileName);
        if (!file.is_open())
        {
          err("Could not open file {} for writing\n",fileName);
        }
        else
        {
          file.write( s.text().data(), s.text().length() );
          file.close();
 
          startDotFile(fileName,s.width(),s.height(),s.hasCaption(),s.srcFile(),s.srcLine());
          visitChildren(s);
          endDotFile(s.hasCaption());
 
          if (Config_getBool(DOT_CLEANUP)) Dir().remove(fileName.str());
        }
      }
      break;
    case DocVerbatim::Msc:
      {
        static int mscindex = 1;
        QCString baseName(4096, QCString::ExplicitSize);
 
        baseName.sprintf("%s%d",
            qPrint(Config_getString(LATEX_OUTPUT)+"/inline_mscgraph_"),
            mscindex++
           );
        QCString fileName = baseName+".msc";
        std::ofstream file = Portable::openOutputStream(fileName);
        if (!file.is_open())
        {
          err("Could not open file {} for writing\n",fileName);
        }
        else
        {
          QCString text = "msc {";
          text+=s.text();
          text+="}";
          file.write( text.data(), text.length() );
          file.close();
 
          writeMscFile(baseName, s);
 
          if (Config_getBool(DOT_CLEANUP)) Dir().remove(fileName.str());
        }
      }
      break;
    case DocVerbatim::PlantUML:
      {
        QCString latexOutput = Config_getString(LATEX_OUTPUT);
        auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                              latexOutput,s.exampleFile(),s.text(),
                              s.useBitmap() ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS,
                              s.engine(),s.srcFile(),s.srcLine(),true);
 
        for (const auto &baseName: baseNameVector)
        {
          writePlantUMLFile(baseName, s);
        }
      }
      break;
  }
}

References DocVerbatim::Code, Config_getBool, Config_getString, DocVerbatim::context(), QCString::data(), DocVerbatim::DocbookOnly, DocVerbatim::Dot, endDotFile(), DocVerbatim::engine(), err, DocVerbatim::exampleFile(), QCString::ExplicitSize, filter(), DocVisitor::getCodeParser(), getLanguageFromCodeLang(), DocVerbatim::hasCaption(), DocVerbatim::height(), DocVerbatim::HtmlOnly, PlantumlManager::instance(), QCString::isEmpty(), DocVerbatim::isExample(), isTableNested(), DocVerbatim::JavaDocCode, DocVerbatim::JavaDocLiteral, DocVerbatim::language(), DocVerbatim::LatexOnly, QCString::length(), m_ci, m_hide, m_langExt, m_t, DocVerbatim::ManOnly, DocVerbatim::Msc, Portable::openOutputStream(), DocNode::parent(), CodeParserInterface::parseCode(), DocVerbatim::PlantUML, PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_EPS, qPrint(), Dir::remove(), DocVerbatim::RtfOnly, QCString::sprintf(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), startDotFile(), QCString::str(), DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::useBitmap(), DocVerbatim::Verbatim, visitChildren(), DocVerbatim::width(), writeMscFile(), writePlantUMLFile(), PlantumlManager::writePlantUMLSource(), and DocVerbatim::XmlOnly.

operator()() [55/58]

void LatexDocVisitor::operator()

(

const DocVhdlFlow &

)

Definition at line 1872 of file latexdocvisitor.cpp.

{
}

operator()() [56/58]

void LatexDocVisitor::operator()

(

const DocWhiteSpace &

w

)

Definition at line 294 of file latexdocvisitor.cpp.

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

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

operator()() [57/58]

void LatexDocVisitor::operator()

(

const DocWord &

w

)

Definition at line 280 of file latexdocvisitor.cpp.

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

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

operator()() [58/58]

void LatexDocVisitor::operator()

(

const DocXRefItem &

x

)

Definition at line 1815 of file latexdocvisitor.cpp.

{
  bool pdfHyperlinks = Config_getBool(PDF_HYPERLINKS);
  if (m_hide) return;
  if (x.title().isEmpty()) return;
  incIndentLevel();
  m_t << "\\begin{DoxyRefDesc}{";
  filter(x.title());
  m_t << "}\n";
  bool anonymousEnum = x.file()=="@";
  m_t << "\\item[";
  if (pdfHyperlinks && !anonymousEnum)
  {
    m_t << "\\mbox{\\hyperlink{" << stripPath(x.file()) << "_" << x.anchor() << "}{";
  }
  else
  {
    m_t << "\\textbf{ ";
  }
  m_insideItem=TRUE;
  filter(x.title());
  m_insideItem=FALSE;
  if (pdfHyperlinks && !anonymousEnum)
  {
    m_t << "}";
  }
  m_t << "}]";
  visitChildren(x);
  if (x.title().isEmpty()) return;
  decIndentLevel();
  m_t << "\\end{DoxyRefDesc}\n";
}

References DocXRefItem::anchor(), Config_getBool, decIndentLevel(), FALSE, DocXRefItem::file(), filter(), incIndentLevel(), QCString::isEmpty(), m_hide, m_insideItem, m_t, stripPath(), DocXRefItem::title(), TRUE, and visitChildren().

popTableState()

void LatexDocVisitor::popTableState ( )

inlineprivate

Definition at line 209 of file latexdocvisitor.h.

    {
      m_tableStateStack.pop();
    }

References m_tableStateStack.

Referenced by operator()().

pushTableState()

void LatexDocVisitor::pushTableState ( )

inlineprivate

Definition at line 205 of file latexdocvisitor.h.

    {
      m_tableStateStack.emplace();
    }

References m_tableStateStack.

Referenced by operator()().

rowSpans()

RowSpanList & LatexDocVisitor::rowSpans ( )

inlineprivate

Definition at line 229 of file latexdocvisitor.h.

    {
      return !m_tableStateStack.empty() ? m_tableStateStack.top().rowSpans : m_emptyRowSpanList;
    }

References m_emptyRowSpanList, and m_tableStateStack.

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

setCurrentColumn()

void LatexDocVisitor::setCurrentColumn ( size_t col )

inlineprivate

Definition at line 217 of file latexdocvisitor.h.

    {
      if (!m_tableStateStack.empty()) m_tableStateStack.top().currentColumn = col;
    }

References m_tableStateStack.

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

setNumCols()

void LatexDocVisitor::setNumCols ( size_t num )

inlineprivate

Definition at line 225 of file latexdocvisitor.h.

    {
      if (!m_tableStateStack.empty()) m_tableStateStack.top().numCols = num;
    }

References m_tableStateStack.

Referenced by operator()().

startDiaFile()

void LatexDocVisitor::startDiaFile ( const QCString & fileName, const QCString & width, const QCString & height, bool hasCaption, const QCString & srcFile, int srcLine )

private

Definition at line 2023 of file latexdocvisitor.cpp.

{
  QCString baseName=makeBaseName(fileName);
  baseName.prepend("dia_");
 
  QCString outDir = Config_getString(LATEX_OUTPUT);
  writeDiaGraphFromFile(fileName,outDir,baseName,DiaOutputFormat::EPS,srcFile,srcLine);
  visitPreStart(m_t,hasCaption, baseName, width, height);
}

References Config_getString, EPS, m_t, makeBaseName(), QCString::prepend(), visitPreStart(), and writeDiaGraphFromFile().

Referenced by operator()().

startDotFile()

void LatexDocVisitor::startDotFile ( const QCString & fileName, const QCString & width, const QCString & height, bool hasCaption, const QCString & srcFile, int srcLine )

private

Definition at line 1967 of file latexdocvisitor.cpp.

{
  QCString baseName=makeBaseName(fileName);
  baseName.prepend("dot_");
  QCString outDir = Config_getString(LATEX_OUTPUT);
  QCString name = fileName;
  writeDotGraphFromFile(name,outDir,baseName,GraphOutputFormat::EPS,srcFile,srcLine);
  visitPreStart(m_t,hasCaption, baseName, width, height);
}

References Config_getString, EPS, m_t, makeBaseName(), QCString::prepend(), visitPreStart(), and writeDotGraphFromFile().

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

startLink()

void LatexDocVisitor::startLink ( const QCString & ref, const QCString & file, const QCString & anchor, bool refToTable = false, bool refToSection = false )

private

Definition at line 1895 of file latexdocvisitor.cpp.

{
  bool pdfHyperLinks = Config_getBool(PDF_HYPERLINKS);
  if (ref.isEmpty() && pdfHyperLinks) // internal PDF link
  {
    if (refToTable)
    {
      m_t << "\\doxytablelink{";
    }
    else if (refToSection)
    {
      if (m_texOrPdf == TexOrPdf::TEX) m_t << "\\protect";
      if (m_texOrPdf != TexOrPdf::PDF) m_t << "\\doxysectlink{";
    }
    else
    {
      if (m_texOrPdf == TexOrPdf::TEX) m_t << "\\protect";
      if (m_texOrPdf != TexOrPdf::PDF) m_t << "\\doxylink{";
    }
    if (refToTable || m_texOrPdf != TexOrPdf::PDF)
    {
      if (!file.isEmpty()) m_t << stripPath(file);
      if (!file.isEmpty() && !anchor.isEmpty()) m_t << "_";
      if (!anchor.isEmpty()) m_t << anchor;
      m_t << "}";
    }
    m_t << "{";
  }
  else if (ref.isEmpty() && refToSection)
  {
    m_t << "\\doxysectref{";
  }
  else if (ref.isEmpty() && refToTable)
  {
    m_t << "\\doxytableref{";
  }
  else if (ref.isEmpty()) // internal non-PDF link
  {
    m_t << "\\doxyref{";
  }
  else // external link
  {
    m_t << "\\textbf{ ";
  }
}

References Config_getBool, QCString::isEmpty(), m_t, m_texOrPdf, PDF, stripPath(), and TEX.

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

startMscFile()

void LatexDocVisitor::startMscFile ( const QCString & fileName, const QCString & width, const QCString & height, bool hasCaption, const QCString & srcFile, int srcLine )

private

Definition at line 1989 of file latexdocvisitor.cpp.

{
  QCString baseName=makeBaseName(fileName);
  baseName.prepend("msc_");
 
  QCString outDir = Config_getString(LATEX_OUTPUT);
  writeMscGraphFromFile(fileName,outDir,baseName,MscOutputFormat::EPS,srcFile,srcLine);
  visitPreStart(m_t,hasCaption, baseName, width, height);
}

References Config_getString, EPS, m_t, makeBaseName(), QCString::prepend(), visitPreStart(), and writeMscGraphFromFile().

Referenced by operator()().

startPlantUmlFile()

void LatexDocVisitor::startPlantUmlFile ( const QCString & fileName, const QCString & width, const QCString & height, bool hasCaption, const QCString & srcFile, int srcLine )

private

Definition at line 2071 of file latexdocvisitor.cpp.

{
  QCString outDir = Config_getString(LATEX_OUTPUT);
  std::string inBuf;
  readInputFile(fileName,inBuf);
 
  bool useBitmap = inBuf.find("@startditaa") != std::string::npos;
  auto baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                              outDir,QCString(),inBuf,
                              useBitmap ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS,
                              QCString(),srcFile,srcLine,false);
  bool first = true;
  for (const auto &bName: baseNameVector)
  {
    QCString baseName = makeBaseName(bName);
    QCString shortName = makeShortName(baseName);
    if (useBitmap)
    {
      if (shortName.find('.')==-1) shortName += ".png";
    }
    PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,
                                useBitmap ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS);
    if (!first) endPlantUmlFile(hasCaption);
    first = false;
    visitPreStart(m_t,hasCaption, shortName, width, height);
  }
}

References Config_getString, endPlantUmlFile(), QCString::find(), PlantumlManager::generatePlantUMLOutput(), PlantumlManager::instance(), m_t, makeBaseName(), makeShortName(), PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_EPS, readInputFile(), visitPreStart(), and PlantumlManager::writePlantUMLSource().

Referenced by operator()().

visitCaption()

void LatexDocVisitor::visitCaption ( const DocNodeList & children )

private

Definition at line 232 of file latexdocvisitor.cpp.

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

Referenced by writeDiaFile(), writeMscFile(), and writePlantUMLFile().

visitChildren()

template<class T>

void LatexDocVisitor::visitChildren ( const T & t )

inlineprivate

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

writeDiaFile()

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

private

Definition at line 2046 of file latexdocvisitor.cpp.

{
  QCString shortName = makeShortName(baseName);
  QCString outDir = Config_getString(LATEX_OUTPUT);
  writeDiaGraphFromFile(baseName+".dia",outDir,shortName,DiaOutputFormat::EPS,s.srcFile(),s.srcLine());
  visitPreStart(m_t, s.hasCaption(), shortName, s.width(), s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

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

writeEndTableCommand()

void LatexDocVisitor::writeEndTableCommand ( const DocNodeVariant * n )

private

Definition at line 1285 of file latexdocvisitor.cpp.

{
  if (isTableNested(n))
  {
    m_t << "\\end{DoxyTableNested}\n";
  }
  else
  {
    m_t << "\\end{DoxyTable}\n";
  }
}

References isTableNested(), and m_t.

Referenced by operator()().

writeMscFile()

void LatexDocVisitor::writeMscFile ( const QCString & fileName, const DocVerbatim & s )

private

Definition at line 2012 of file latexdocvisitor.cpp.

{
  QCString shortName = makeShortName(baseName);
  QCString outDir = Config_getString(LATEX_OUTPUT);
  writeMscGraphFromFile(baseName+".msc",outDir,shortName,MscOutputFormat::EPS,s.srcFile(),s.srcLine());
  visitPreStart(m_t, s.hasCaption(), shortName, s.width(),s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References DocVerbatim::children(), Config_getString, EPS, DocVerbatim::hasCaption(), DocVerbatim::height(), m_t, makeShortName(), DocVerbatim::srcFile(), DocVerbatim::srcLine(), visitCaption(), visitPostEnd(), visitPreStart(), DocVerbatim::width(), and writeMscGraphFromFile().

Referenced by operator()().

writePlantUMLFile()

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

private

Definition at line 2056 of file latexdocvisitor.cpp.

{
  QCString shortName = makeShortName(baseName);
  if (s.useBitmap())
  {
    if (shortName.find('.')==-1) shortName += ".png";
  }
  QCString outDir = Config_getString(LATEX_OUTPUT);
  PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,
                              s.useBitmap() ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS);
  visitPreStart(m_t, s.hasCaption(), shortName, s.width(), s.height());
  visitCaption(s.children());
  visitPostEnd(m_t, s.hasCaption());
}

References DocVerbatim::children(), Config_getString, QCString::find(), PlantumlManager::generatePlantUMLOutput(), DocVerbatim::hasCaption(), DocVerbatim::height(), PlantumlManager::instance(), m_t, makeShortName(), PlantumlManager::PUML_BITMAP, PlantumlManager::PUML_EPS, DocVerbatim::useBitmap(), visitCaption(), visitPostEnd(), visitPreStart(), and DocVerbatim::width().

Referenced by operator()().

writeStartTableCommand()

void LatexDocVisitor::writeStartTableCommand ( const DocNodeVariant * n, size_t cols )

private

Definition at line 1273 of file latexdocvisitor.cpp.

{
  if (isTableNested(n))
  {
    m_t << "\\begin{DoxyTableNested}{" << cols << "}";
  }
  else
  {
    m_t << "\n\\begin{DoxyTable}{" << cols << "}";
  }
}

References isTableNested(), and m_t.

Referenced by operator()().

Member Data Documentation

m_ci

OutputCodeList& LatexDocVisitor::m_ci

private

Definition at line 177 of file latexdocvisitor.h.

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

m_emptyRowSpanList

RowSpanList LatexDocVisitor::m_emptyRowSpanList

private

Definition at line 193 of file latexdocvisitor.h.

Referenced by rowSpans().

m_hide

bool LatexDocVisitor::m_hide

private

Definition at line 181 of file latexdocvisitor.h.

Referenced by endDiaFile(), endDotFile(), endMscFile(), endPlantUmlFile(), LatexDocVisitor(), 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_hierarchyLevel

int LatexDocVisitor::m_hierarchyLevel

private

Definition at line 183 of file latexdocvisitor.h.

Referenced by getSectionName(), and LatexDocVisitor().

m_indentLevel

int LatexDocVisitor::m_indentLevel = 0

private

Definition at line 196 of file latexdocvisitor.h.

Referenced by decIndentLevel(), incIndentLevel(), indentLevel(), operator()(), and operator()().

m_insideItem

bool LatexDocVisitor::m_insideItem

private

Definition at line 180 of file latexdocvisitor.h.

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

m_insidePre

bool LatexDocVisitor::m_insidePre

private

Definition at line 179 of file latexdocvisitor.h.

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

m_langExt

QCString LatexDocVisitor::m_langExt

private

Definition at line 182 of file latexdocvisitor.h.

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

m_lcg

LatexCodeGenerator& LatexDocVisitor::m_lcg

private

Definition at line 178 of file latexdocvisitor.h.

Referenced by filter(), isTableNested(), LatexDocVisitor(), and operator()().

m_listItemInfo

LatexListItemInfo LatexDocVisitor::m_listItemInfo[maxIndentLevels]

private

Definition at line 203 of file latexdocvisitor.h.

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

m_t

TextStream& LatexDocVisitor::m_t

private

Definition at line 176 of file latexdocvisitor.h.

Referenced by endDiaFile(), endDotFile(), endLink(), endMscFile(), endPlantUmlFile(), escapeMakeIndexChars(), filter(), LatexDocVisitor(), 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(), startMscFile(), startPlantUmlFile(), writeDiaFile(), writeEndTableCommand(), writeMscFile(), writePlantUMLFile(), and writeStartTableCommand().

m_tableStateStack

std::stack<TableState> LatexDocVisitor::m_tableStateStack

private

Definition at line 192 of file latexdocvisitor.h.

Referenced by addRowSpan(), currentColumn(), insideTable(), numCols(), popTableState(), pushTableState(), rowSpans(), setCurrentColumn(), and setNumCols().

m_texOrPdf

TexOrPdf LatexDocVisitor::m_texOrPdf = TexOrPdf::NO

private

Definition at line 184 of file latexdocvisitor.h.

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

maxIndentLevels

const int LatexDocVisitor::maxIndentLevels = 13

staticprivate

Definition at line 195 of file latexdocvisitor.h.

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

---

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

• src/latexdocvisitor.h
• src/latexdocvisitor.cpp