msc.h File Reference

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

Go to the source code of this file.

Enumerations
enum class	MscOutputFormat { BITMAP , EPS , SVG }

Functions
void	writeMscGraphFromFile (const DString &inFile, const DString &outDir, const DString &outFile, MscOutputFormat format, const DString &srcFile, int srcLine, bool toIndex)
DString	getMscImageMapFromFile (const DString &inFile, const DString &outDir, const DString &relPath, const DString &context, const DString &srcFile, int srcLine)
void	writeMscImageMapFromFile (TextStream &t, const DString &inFile, const DString &outDir, const DString &relPath, const DString &baseName, const DString &context, MscOutputFormat format, const DString &srcFile, int srcLine)

Enumeration Type Documentation

MscOutputFormat

enum class MscOutputFormat

strong

Enumerator
BITMAP
EPS
SVG

Definition at line 22 of file msc.h.

{ BITMAP, EPS, SVG };

Function Documentation

getMscImageMapFromFile()

DString getMscImageMapFromFile	(	const DString &	inFile,
		const DString &	outDir,
		const DString &	relPath,
		const DString &	context,
		const DString &	srcFile,
		int	srcLine )

writeMscGraphFromFile()

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

Definition at line 157 of file msc.cpp.

{
  DString absOutFile = outDir;
  absOutFile+=Portable::pathSeparator();
  absOutFile+=outFile;
 
  mscgen_format_t msc_format = mscgen_format_png;
  DString imgName = absOutFile;
  switch (format)
  {
    case MscOutputFormat::BITMAP:
      msc_format = mscgen_format_png;
      imgName+=".png";
      break;
    case MscOutputFormat::EPS:
      msc_format = mscgen_format_eps;
      imgName+=".eps";
      break;
    case MscOutputFormat::SVG:
      msc_format = mscgen_format_svg;
      imgName+=".svg";
      break;
    default:
      return;
  }
  if (!do_mscgen_generate(inFile,imgName,msc_format,srcFile,srcLine))
  {
    return;
  }
 
  if ( (format==MscOutputFormat::EPS) && (Config_getBool(USE_PDFLATEX)) )
  {
    DString epstopdfArgs(maxCmdLine, DString::ExplicitSize);
    epstopdfArgs.sprintf("\"%s.eps\" --outfile=\"%s.pdf\"",
                         qPrint(absOutFile),qPrint(absOutFile));
    if (Portable::system("epstopdf",epstopdfArgs)!=0)
    {
      err_full(srcFile,srcLine,"Problems running epstopdf when processing '{}.eps'. Check your TeX installation!", absOutFile);
    }
    else
    {
      Dir().remove((absOutFile + ".eps").data());
    }
  }
 
  size_t i0 = imgName.rfind('/');
  size_t i1 = imgName.rfind('\\');
  size_t i  = i0!=DString::npos && i1!=DString::npos ? std::max(i0,i1) :
              i0!=DString::npos ? i0 : i1;
  if (i!=DString::npos) // strip path
  {
    imgName=imgName.mid(i+1);
  }
  if (toIndex) Doxygen::indexList->addImageFile(imgName);
 
}

References IndexList::addImageFile(), BITMAP, Config_getBool, do_mscgen_generate(), EPS, err_full, DString::ExplicitSize, Doxygen::indexList, maxCmdLine, DString::mid(), DString::npos, Portable::pathSeparator(), qPrint(), Dir::remove(), DString::rfind(), DString::sprintf(), SVG, and Portable::system().

Referenced by DocbookDocVisitor::startMscFile(), LatexDocVisitor::startMscFile(), DocbookDocVisitor::writeMscFile(), HtmlDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), and RTFDocVisitor::writeMscFile().

writeMscImageMapFromFile()

void writeMscImageMapFromFile	(	TextStream &	t,
		const DString &	inFile,
		const DString &	outDir,
		const DString &	relPath,
		const DString &	baseName,
		const DString &	context,
		MscOutputFormat	format,
		const DString &	srcFile,
		int	srcLine )

Definition at line 236 of file msc.cpp.

{
  DString mapName = baseName+".map";
  t << "<img src=\"" << relPath << baseName << ".";
  switch (format)
  {
    case MscOutputFormat::BITMAP:
      t << "png";
      break;
    case MscOutputFormat::EPS:
      t << "eps";
      break;
    case MscOutputFormat::SVG:
      t << "svg";
      break;
    default:
      t << "unknown";
  }
  DString imap = getMscImageMapFromFile(inFile,outDir,relPath,context,format==MscOutputFormat::SVG,srcFile,srcLine);
  if (!imap.empty())
  {
    t << "\" alt=\""
      << baseName << "\" border=\"0\" usemap=\"#" << mapName << "\"/>\n";
    t << "<map name=\"" << mapName << "\" id=\"" << mapName << "\">" << imap << "</map>\n";
  }
  else
  {
    t << "\" alt=\"" << baseName << "\" border=\"0\"/>\n";
  }
}

References BITMAP, DString::empty(), EPS, getMscImageMapFromFile(), and SVG.

Referenced by HtmlDocVisitor::writeMscFile().