dot.h File Reference

#include <map>
#include <vector>
#include "construct.h"
#include "dotfilepatcher.h"
#include "dotgraph.h"
#include "dotjob.h"
#include "dotrunner.h"
#include "doxygen.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 dot invocations and patching files for embedding image maps. More...

Functions
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)

Function Documentation

writeDotGraphFromFile()

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

Definition at line 197 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, Dir::exists(), getDotImageExtension(), Doxygen::indexList, DString::str(), Portable::system(), term, and Doxygen::verifiedDotPath.

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

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 250 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(), TextStream::empty(), Dir::exists(), getDotImageExtension(), MAP_CMD, Dir::remove(), DotFilePatcher::run(), DString::str(), TextStream::str(), Portable::system(), term, Doxygen::verifiedDotPath, and DotFilePatcher::writeSVGFigureLink().

Referenced by HtmlDocVisitor::writeDotFile().