latexdocvisitor.cpp 文件参考

#include <algorithm>
#include "htmlattrib.h"
#include "latexdocvisitor.h"
#include "latexgen.h"
#include "docparser.h"
#include "language.h"
#include "doxygen.h"
#include "outputgen.h"
#include "dot.h"
#include "util.h"
#include "message.h"
#include "parserintf.h"
#include "msc.h"
#include "dia.h"
#include "cite.h"
#include "filedef.h"
#include "config.h"
#include "htmlentity.h"
#include "emoji.h"
#include "plantuml.h"
#include "fileinfo.h"

latexdocvisitor.cpp 的引用(Include)关系图:

浏览源代码.

函数
static const char *	getSectionName (int level)
static void	visitPreStart (TextStream &t, bool hasCaption, QCString name, QCString width, QCString height, bool inlineImage=FALSE)
static void	visitPostEnd (TextStream &t, bool hasCaption, bool inlineImage=FALSE)
static void	visitCaption (LatexDocVisitor *parent, const DocNodeList &children)
static bool	classEqualsReflist (const DocNode *n)
static bool	listIsNested (const DocNode *n)
static bool	tableIsNested (const DocNode *n)
static void	writeStartTableCommand (TextStream &t, const DocNode *n, int cols)
static void	writeEndTableCommand (TextStream &t, const DocNode *n)

变量
const int	maxLevels =5
static const char *	secLabels [maxLevels]

函数说明

classEqualsReflist()

static bool classEqualsReflist ( const DocNode *  n )

static

在文件 latexdocvisitor.cpp 第 1055 行定义.

{
  if (n->kind()==DocNode::Kind_HtmlDescList)
  {
    HtmlAttribList attrs = ((DocHtmlDescList *)n)->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;
}

引用了 DocNode::kind() , 以及 DocNode::Kind_HtmlDescList.

被这些函数引用 listIsNested(), LatexDocVisitor::visitPost() , 以及 LatexDocVisitor::visitPre().

getSectionName()

static const char* getSectionName ( int  level )

static

在文件 latexdocvisitor.cpp 第 46 行定义.

{
  static bool compactLatex = Config_getBool(COMPACT_LATEX);
  int l = level;
  if (compactLatex) l++;
  if (Doxygen::insideMainPage) l--;
  return secLabels[std::min(maxLevels-1,l)];
}

引用了 Config_getBool, Doxygen::insideMainPage, maxLevels , 以及 secLabels.

被这些函数引用 LatexDocVisitor::visitPre().

listIsNested()

static bool listIsNested ( const DocNode *  n )

static

在文件 latexdocvisitor.cpp 第 1068 行定义.

{
  bool isNested=false;
  if (n)
  {
    if (classEqualsReflist(n)) return false;
    n  = n->parent();
  }
  while (n && !isNested)
  {
    if (n->kind()==DocNode::Kind_HtmlDescList)
    {
      isNested = !classEqualsReflist(n);
    }
    n  = n->parent();
  }
  return isNested;
}

引用了 classEqualsReflist(), DocNode::kind(), DocNode::Kind_HtmlDescList , 以及 DocNode::parent().

被这些函数引用 LatexDocVisitor::visitPre().

tableIsNested()

static bool tableIsNested ( const DocNode *  n )

static

在文件 latexdocvisitor.cpp 第 1138 行定义.

{
  bool isNested=FALSE;
  while (n && !isNested)
  {
    isNested = n->kind()==DocNode::Kind_HtmlTable || n->kind()==DocNode::Kind_ParamSect;
    n  = n->parent();
  }
  return isNested;
}

引用了 FALSE, DocNode::kind(), DocNode::Kind_HtmlTable, DocNode::Kind_ParamSect , 以及 DocNode::parent().

被这些函数引用 LatexDocVisitor::visitPost(), LatexDocVisitor::visitPre(), writeEndTableCommand() , 以及 writeStartTableCommand().

visitCaption()

static void visitCaption ( LatexDocVisitor *  parent, const DocNodeList &  children  )

static

在文件 latexdocvisitor.cpp 第 146 行定义.

{
  for (const auto &n : children) n->accept(parent);
}

被这些函数引用 LatexDocVisitor::visit(), LatexDocVisitor::visitPre(), LatexDocVisitor::writeDiaFile(), LatexDocVisitor::writeMscFile() , 以及 LatexDocVisitor::writePlantUMLFile().

visitPostEnd()

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

static

在文件 latexdocvisitor.cpp 第 125 行定义.

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

被这些函数引用 LatexDocVisitor::endDiaFile(), LatexDocVisitor::endDotFile(), LatexDocVisitor::endMscFile(), LatexDocVisitor::visitPost(), LatexDocVisitor::writeDiaFile(), LatexDocVisitor::writeMscFile() , 以及 LatexDocVisitor::writePlantUMLFile().

visitPreStart()

static void visitPreStart ( TextStream &  t, bool  hasCaption, QCString  name, QCString  width, QCString  height, bool  inlineImage = FALSE  )

static

在文件 latexdocvisitor.cpp 第 55 行定义.

{
    if (inlineImage)
    {
      t << "\n\\begin{DoxyInlineImage}\n";
    }
    else
    {
      if (hasCaption)
      {
        t << "\n\\begin{DoxyImage}\n";
      }
      else
      {
        t << "\n\\begin{DoxyImageNoCaption}\n"
               "  \\mbox{";
      }
    }
 
    t << "\\includegraphics";
    if (!width.isEmpty() || !height.isEmpty())
    {
      t << "[";
    }
    if (!width.isEmpty())
    {
      t << "width=" << width;
    }
    if (!width.isEmpty() && !height.isEmpty())
    {
      t << ",";
    }
    if (!height.isEmpty())
    {
      t << "height=" << height;
    }
    if (width.isEmpty() && height.isEmpty())
    {
      /* 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)
      {
        t << "\n\\doxyfigcaption{";
      }
      else
      {
        t << "%"; // to catch the caption
      }
    }
}

引用了 QCString::isEmpty().

被这些函数引用 LatexDocVisitor::startDiaFile(), LatexDocVisitor::startDotFile(), LatexDocVisitor::startMscFile(), LatexDocVisitor::visitPre(), LatexDocVisitor::writeDiaFile(), LatexDocVisitor::writeMscFile() , 以及 LatexDocVisitor::writePlantUMLFile().

writeEndTableCommand()

static void writeEndTableCommand ( TextStream &  t, const DocNode *  n  )

static

在文件 latexdocvisitor.cpp 第 1162 行定义.

{
  if (tableIsNested(n))
  {
    t << "\\end{tabularx}}\n";
  }
  else
  {
    t << "\\end{longtabu}\n";
  }
  //return isNested ? "TabularNC" : "TabularC";
}

引用了 tableIsNested().

被这些函数引用 LatexDocVisitor::visitPost().

writeStartTableCommand()

static void writeStartTableCommand ( TextStream &  t, const DocNode *  n, int  cols  )

static

在文件 latexdocvisitor.cpp 第 1149 行定义.

{
  if (tableIsNested(n))
  {
    t << "{\\begin{tabularx}{\\linewidth}{|*{" << cols << "}{>{\\raggedright\\arraybackslash}X|}}";
  }
  else
  {
    t << "\\tabulinesep=1mm\n\\begin{longtabu}spread 0pt [c]{*{" << cols << "}{|X[-1]}|}\n";
  }
  //return isNested ? "TabularNC" : "TabularC";
}

引用了 tableIsNested().

被这些函数引用 LatexDocVisitor::visitPre().

变量说明

maxLevels

const int maxLevels =5

在文件 latexdocvisitor.cpp 第 42 行定义.

被这些函数引用 getSectionName().

secLabels

const char* secLabels[maxLevels]

static

初始值:

=
   { "doxysection","doxysubsection","doxysubsubsection","doxyparagraph","doxysubparagraph" }

在文件 latexdocvisitor.cpp 第 43 行定义.

被这些函数引用 getSectionName().