dot.cpp File Reference

#include <cstdlib>
#include <cassert>
#include <sstream>
#include <algorithm>
#include <mutex>
#include "config.h"
#include "dot.h"
#include "dotrunner.h"
#include "dotfilepatcher.h"
#include "util.h"
#include "portable.h"
#include "message.h"
#include "doxygen.h"
#include "language.h"
#include "indexlist.h"
#include "dir.h"

Include dependency graph for dot.cpp:

Go to the source code of this file.

Macros
#define	MAP_CMD   "cmapx"

Functions
static void	setDotFontPath (const DString &path)
static void	unsetDotFontPath ()
void	writeDotGraphFromFile (const DString &inFile, const DString &outDir, const DString &outFile, GraphOutputFormat format, const DString &srcFile, int srcLine, bool toIndex)
void	writeDotImageMapFromFile (TextStream &t, const DString &inFile, const DString &outDir, const DString &relPath, const DString &baseName, const DString &context, int graphId, const DString &srcFile, int srcLine, bool newFile)

Variables
static DString	g_dotFontPath
static std::mutex	g_dotManagerMutex

Macro Definition Documentation

MAP_CMD

#define MAP_CMD   "cmapx"

Definition at line 34 of file dot.cpp.

Referenced by writeDotImageMapFromFile().

Function Documentation

setDotFontPath()

void setDotFontPath ( const DString & path )

static

Definition at line 42 of file dot.cpp.

{
  ASSERT(g_dotFontPath.empty());
  g_dotFontPath = Portable::getenv("DOTFONTPATH");
  DString newFontPath = Config_getString(DOT_FONTPATH);
  if (!newFontPath.empty() && !path.empty())
  {
    newFontPath.prepend(path+Portable::pathListSeparator());
  }
  else if (newFontPath.empty() && !path.empty())
  {
    newFontPath=path;
  }
  else
  {
    Portable::unsetenv("DOTFONTPATH");
    return;
  }
  Portable::setenv("DOTFONTPATH",newFontPath);
}

References ASSERT, Config_getString, DString::empty(), g_dotFontPath, Portable::getenv(), Portable::pathListSeparator(), DString::prepend(), setDotFontPath(), Portable::setenv(), and Portable::unsetenv().

Referenced by DotManager::run(), and setDotFontPath().

unsetDotFontPath()

void unsetDotFontPath ( )

static

Definition at line 63 of file dot.cpp.

{
  if (g_dotFontPath.empty())
  {
    Portable::unsetenv("DOTFONTPATH");
  }
  else
  {
    Portable::setenv("DOTFONTPATH",g_dotFontPath);
  }
  g_dotFontPath="";
}

References DString::empty(), g_dotFontPath, Portable::setenv(), unsetDotFontPath(), and Portable::unsetenv().

Referenced by DotManager::run(), and unsetDotFontPath().

writeDotGraphFromFile()

void writeDotGraphFromFile	(	const DString &	inFile,
		const DString &	outDir,
		const DString &	outFile,
		GraphOutputFormat	format,
		const DString &	srcFile,
		int	srcLine,
		bool	toIndex )

Definition at line 196 of file dot.cpp.

{
  Dir d(outDir.str());
  if (!d.exists())
  {
    term("Output dir {} does not exist!\n",outDir);
  }
 
  DString imgExt = getDotImageExtension();
  DString imgName = outFile+"."+imgExt;
  DString absImgName = d.absPath()+"/"+imgName;
  DString absOutFile = d.absPath()+"/"+outFile;
 
  DString dotArgs;
  if (format==GraphOutputFormat::BITMAP)
  {
    dotArgs = DString("-T") + Config_getEnumAsString(DOT_IMAGE_FORMAT) + " -o \"" + absImgName + "\" \"" + inFile + "\"";
  }
  else // format==GraphOutputFormat::EPS
  {
    if (Config_getBool(USE_PDFLATEX))
    {
      dotArgs = DString("-Tpdf -o \"") + absOutFile + ".pdf\" \"" + inFile + "\"";
    }
    else
    {
      dotArgs = DString("-Teps -o \"") + absOutFile + ".eps\" \"" + inFile + "\"";
    }
  }
 
  if (Portable::system(Doxygen::verifiedDotPath, dotArgs, false) != 0)
  {
    return;
  }
 
  if (toIndex) Doxygen::indexList->addImageFile(imgName);
 
}

References Dir::absPath(), IndexList::addImageFile(), BITMAP, Config_getBool, Config_getEnumAsString, DString::DString(), Dir::exists(), getDotImageExtension(), Doxygen::indexList, DString::str(), Portable::system(), term, Doxygen::verifiedDotPath, and writeDotGraphFromFile().

Referenced by DocbookDocVisitor::startDotFile(), LatexDocVisitor::startDotFile(), DocbookDocVisitor::writeDotFile(), HtmlDocVisitor::writeDotFile(), RTFDocVisitor::writeDotFile(), and writeDotGraphFromFile().

writeDotImageMapFromFile()

void writeDotImageMapFromFile	(	TextStream &	t,
		const DString &	inFile,
		const DString &	outDir,
		const DString &	relPath,
		const DString &	baseName,
		const DString &	context,
		int	graphId,
		const DString &	srcFile,
		int	srcLine,
		bool	newFile )

Writes user defined image map to the output.

Parameters

t	text stream to write to
inFile	just the basename part of the filename
outDir	output directory
relPath	relative path the to root of the output dir
baseName	the base name of the output files
context	the scope in which this graph is found (for resolving links)
graphId	a unique id for this graph, use for dynamic sections
srcFile	the source file
srcLine	the line number in the source file
newFile	signal whether or not the file has been generated before (value false) or not.

Definition at line 249 of file dot.cpp.

{
 
  Dir d(outDir.str());
  if (!d.exists())
  {
    term("Output dir {} does not exist!\n",outDir);
  }
 
  DString mapName = baseName+".cmapx";
  DString imgExt = getDotImageExtension();
  DString imgName = baseName+"."+imgExt;
  DString absOutFile = d.absPath()+"/"+mapName;
 
  DString dotArgs = DString("-T" MAP_CMD " -o \"") + absOutFile + "\" \"" + inFile + "\"";
  if (Portable::system(Doxygen::verifiedDotPath, dotArgs, false) != 0)
  {
    return;
  }
 
  if (imgExt=="svg") // vector graphics
  {
    DString svgName = outDir+"/"+baseName+".svg";
    DotFilePatcher::writeSVGFigureLink(t,relPath,baseName,svgName);
    if (newFile)
    {
      DotFilePatcher patcher(svgName);
      patcher.addSVGConversion("",true,context,true,graphId);
      patcher.run();
    }
  }
  else // bitmap graphics
  {
    TextStream tt;
    t << "<img src=\"" << relPath << imgName << "\" alt=\""
      << imgName << "\" border=\"0\" usemap=\"#" << mapName << "\"/>\n";
    DotFilePatcher::convertMapFile(tt, absOutFile, relPath ,true, context);
    if (!tt.empty())
    {
      t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">";
      t << tt.str();
      t << "</map>\n";
    }
  }
  d.remove(absOutFile.str());
}

References Dir::absPath(), DotFilePatcher::addSVGConversion(), DotFilePatcher::convertMapFile(), DString::DString(), TextStream::empty(), Dir::exists(), getDotImageExtension(), MAP_CMD, Dir::remove(), DotFilePatcher::run(), DString::str(), TextStream::str(), Portable::system(), term, Doxygen::verifiedDotPath, writeDotImageMapFromFile(), and DotFilePatcher::writeSVGFigureLink().

Referenced by HtmlDocVisitor::writeDotFile(), and writeDotImageMapFromFile().

Variable Documentation

g_dotFontPath

DString g_dotFontPath

static

Definition at line 38 of file dot.cpp.

Referenced by setDotFontPath(), and unsetDotFontPath().

g_dotManagerMutex

std::mutex g_dotManagerMutex

static

Definition at line 40 of file dot.cpp.

Referenced by DotManager::addJob(), and DotManager::createFilePatcher().