latexdocvisitor.cpp File Reference

#include "latexdocvisitor.h"
#include <algorithm>
#include <array>
#include "cite.h"
#include "codefragment.h"
#include "config.h"
#include "dia.h"
#include "docparser.h"
#include "dot.h"
#include "doxygen.h"
#include "emoji.h"
#include "filedef.h"
#include "fileinfo.h"
#include "htmlattrib.h"
#include "htmlentity.h"
#include "language.h"
#include "latexgen.h"
#include "mermaid.h"
#include "message.h"
#include "msc.h"
#include "outputlist.h"
#include "parserintf.h"
#include "plantuml.h"
#include "portable.h"
#include "regex.h"
#include "util.h"

Include dependency graph for latexdocvisitor.cpp:

Go to the source code of this file.

Functions
static void	insertDimension (TextStream &t, DString dimension, const char *orientationString)
static void	visitPreStart (TextStream &t, bool hasCaption, DString name, DString width, DString height, bool inlineImage=false)
static void	visitPostEnd (TextStream &t, bool hasCaption, bool inlineImage=false)
static bool	classEqualsReflist (const DocHtmlDescList &dl)
static bool	listIsNested (const DocHtmlDescList &dl)

Variables
static const int	g_maxLevels = 7
static const std::array< const char *, g_maxLevels >	g_secLabels
static const char *	g_paragraphLabel = "doxyparagraph"
static const char *	g_subparagraphLabel = "doxysubparagraph"

Function Documentation

classEqualsReflist()

bool classEqualsReflist ( const DocHtmlDescList & dl )

static

Definition at line 1127 of file latexdocvisitor.cpp.

{
  HtmlAttribList attrs = dl.attribs();
  auto it = std::find_if(attrs.begin(),attrs.end(),
                      [](const auto &att) { return att.name=="class"; });
  if (it!=attrs.end() && it->value == "reflist") return true;
  return false;
}

References DocHtmlDescList::attribs().

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

insertDimension()

void insertDimension ( TextStream & t, DString dimension, const char * orientationString )

static

Definition at line 93 of file latexdocvisitor.cpp.

{
  // dimensions for latex images can be a percentage, in this case they need some extra
  // handling as the % symbol is used for comments
  static const reg::Ex re(R"((\d+)%)");
  std::string s = dimension.str();
  reg::Match match;
  if (reg::search(s,match,re))
  {
    bool ok = false;
    double percent = DString(match[1].str()).toInt(&ok);
    if (ok)
    {
      t << percent/100.0 << "\\text" << orientationString;
      return;
    }
  }
  t << dimension;
}

References reg::search(), DString::str(), and DString::toInt().

Referenced by visitPreStart().

listIsNested()

bool listIsNested ( const DocHtmlDescList & dl )

static

Definition at line 1136 of file latexdocvisitor.cpp.

{
  bool isNested=false;
  const DocNodeVariant *n = dl.parent();
  while (n && !isNested)
  {
    if (std::get_if<DocHtmlDescList>(n))
    {
      isNested = !classEqualsReflist(std::get<DocHtmlDescList>(*n));
    }
    n = ::parent(n);
  }
  return isNested;
}

References classEqualsReflist(), DocNode::parent(), and parent().

Referenced by LatexDocVisitor::operator()().

visitPostEnd()

void visitPostEnd ( TextStream & t, bool hasCaption, bool inlineImage = false )

static

Definition at line 192 of file latexdocvisitor.cpp.

{
    if (inlineImage)
    {
      t << "%\n\\end{DoxyInlineImage}\n";
    }
    else
    {
      t << "}%\n"; // end doxymbox or caption
      if (hasCaption)
      {
        t << "\\end{DoxyImage}\n";
      }
      else
      {
        t << "\\end{DoxyImageNoCaption}\n";
      }
    }
}

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

visitPreStart()

void visitPreStart ( TextStream & t, bool hasCaption, DString name, DString width, DString height, bool inlineImage = false )

static

Definition at line 113 of file latexdocvisitor.cpp.

{
    if (inlineImage)
    {
      t << "\n\\begin{DoxyInlineImage}%\n";
    }
    else
    {
      if (hasCaption)
      {
        t << "\n\\begin{DoxyImage}%\n";
      }
      else
      {
        t << "\n\\begin{DoxyImageNoCaption}%\n"
               "  \\doxymbox{";
      }
    }
 
    t << "\\includegraphics";
    if (!width.empty() || !height.empty())
    {
      t << "[";
    }
    if (!width.empty())
    {
      t << "width=";
      insertDimension(t, width, "width");
    }
    if (!width.empty() && !height.empty())
    {
      t << ",";
    }
    if (!height.empty())
    {
      t << "height=";
      insertDimension(t, height, "height");
    }
    if (width.empty() && height.empty())
    {
      /* default setting */
      if (inlineImage)
      {
        t << "[height=\\baselineskip,keepaspectratio=true]";
      }
      else
      {
        t << "[width=\\textwidth,height=\\textheight/2,keepaspectratio=true]";
      }
    }
    else
    {
      t << "]";
    }
 
    t << "{" << name << "}";
 
    if (hasCaption)
    {
      if (!inlineImage)
      {
        if (Config_getBool(PDF_HYPERLINKS))
        {
          t << "%\n\\doxyfigcaption{";
        }
        else
        {
          t << "%\n\\doxyfigcaptionnolink{";
        }
      }
      else
      {
        t << "%"; // to catch the caption
      }
    }
}

References Config_getBool, DString::empty(), and insertDimension().

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

Variable Documentation

g_maxLevels

const int g_maxLevels = 7

static

Definition at line 48 of file latexdocvisitor.cpp.

Referenced by LatexDocVisitor::getSectionName().

g_paragraphLabel

const char* g_paragraphLabel = "doxyparagraph"

static

Definition at line 59 of file latexdocvisitor.cpp.

Referenced by LatexDocVisitor::getSectionName().

g_secLabels

const std::array<const char *,g_maxLevels> g_secLabels

static

Initial value:

                                    =
{ "doxysection",
  "doxysubsection",
  "doxysubsubsection",
  "doxysubsubsubsection",
  "doxysubsubsubsubsection",
  "doxysubsubsubsubsubsection",
  "doxysubsubsubsubsubsubsection"
}

Definition at line 49 of file latexdocvisitor.cpp.

Referenced by LatexDocVisitor::getSectionName().

g_subparagraphLabel

const char* g_subparagraphLabel = "doxysubparagraph"

static

Definition at line 60 of file latexdocvisitor.cpp.

Referenced by LatexDocVisitor::getSectionName().