dot.h File Reference

#include <map>
#include "threadpool.h"
#include "qcstring.h"
#include "dotgraph.h"
#include "dotfilepatcher.h"
#include "dotrunner.h"
#include "doxygen.h"
#include "construct.h"

Include dependency graph for dot.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	DotManager
	Singleton that manages parallel dot invocations and patching files for embedding image maps. More...

Functions
void	writeDotGraphFromFile (const QCString &inFile, const QCString &outDir, const QCString &outFile, GraphOutputFormat format, const QCString &srcFile, int srcLine)
void	writeDotImageMapFromFile (TextStream &t, const QCString &inFile, const QCString &outDir, const QCString &relPath, const QCString &baseName, const QCString &context, int graphId, const QCString &srcFile, int srcLine, bool newFile)

Function Documentation

writeDotGraphFromFile()

void writeDotGraphFromFile	(	const QCString &	inFile,
		const QCString &	outDir,
		const QCString &	outFile,
		GraphOutputFormat	format,
		const QCString &	srcFile,
		int	srcLine )

Definition at line 230 of file dot.cpp.

{
  Dir d(outDir.str());
  if (!d.exists())
  {
    term("Output dir {} does not exist!\n",outDir);
  }
 
  QCString imgExt = getDotImageExtension();
  QCString imgName = outFile+"."+imgExt;
  QCString absImgName = d.absPath()+"/"+imgName;
  QCString absOutFile = d.absPath()+"/"+outFile;
 
  DotRunner dotRun(inFile);
  if (format==GraphOutputFormat::BITMAP)
  {
    dotRun.addJob(Config_getEnumAsString(DOT_IMAGE_FORMAT),absImgName,srcFile,srcLine);
  }
  else // format==GraphOutputFormat::EPS
  {
    if (Config_getBool(USE_PDFLATEX))
    {
      dotRun.addJob("pdf",absOutFile+".pdf",srcFile,srcLine);
    }
    else
    {
      dotRun.addJob("ps",absOutFile+".eps",srcFile,srcLine);
    }
  }
 
  dotRun.preventCleanUp();
  if (!dotRun.run())
  {
     return;
  }
 
  Doxygen::indexList->addImageFile(imgName);
 
}

References Dir::absPath(), DotRunner::addJob(), BITMAP, Config_getBool, Config_getEnumAsString, Dir::exists(), getDotImageExtension(), Doxygen::indexList, DotRunner::preventCleanUp(), DotRunner::run(), QCString::str(), and term.

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

writeDotImageMapFromFile()

void writeDotImageMapFromFile	(	TextStream &	t,
		const QCString &	inFile,
		const QCString &	outDir,
		const QCString &	relPath,
		const QCString &	baseName,
		const QCString &	context,
		int	graphId,
		const QCString &	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 284 of file dot.cpp.

{
 
  Dir d(outDir.str());
  if (!d.exists())
  {
    term("Output dir {} does not exist!\n",outDir);
  }
 
  QCString mapName = baseName+".map";
  QCString imgExt = getDotImageExtension();
  QCString imgName = baseName+"."+imgExt;
  QCString absOutFile = d.absPath()+"/"+mapName;
 
  DotRunner dotRun(inFile);
  dotRun.addJob(MAP_CMD,absOutFile,srcFile,srcLine);
  dotRun.preventCleanUp();
  if (!dotRun.run())
  {
    return;
  }
 
  if (imgExt=="svg") // vector graphics
  {
    QCString 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(), DotRunner::addJob(), DotFilePatcher::addSVGConversion(), DotFilePatcher::convertMapFile(), TextStream::empty(), Dir::exists(), getDotImageExtension(), MAP_CMD, DotRunner::preventCleanUp(), Dir::remove(), DotFilePatcher::run(), DotRunner::run(), QCString::str(), TextStream::str(), term, TRUE, and DotFilePatcher::writeSVGFigureLink().

Referenced by HtmlDocVisitor::writeDotFile().