DotRunner类 参考

Helper class to run dot from doxygen from multiple threads. 更多...

#include <dotrunner.h>

DotRunner 的协作图:

类
struct	DotJob

Public 成员函数
	DotRunner (const QCString &absDotName, const QCString &md5Hash=QCString())
	Creates a runner for a dot file. 更多...
void	addJob (const QCString &format, const QCString &output, const QCString &srcFile, int srcLine)
	Adds an additional job to the run. 更多...
void	preventCleanUp ()
	Prevent cleanup of the dot file (for user provided dot files) 更多...
bool	run ()
	Runs dot for all jobs added. 更多...
QCString	getMd5Hash ()

静态 Public 成员函数
static bool	readBoundingBox (const QCString &fileName, int *width, int *height, bool isEps)

Private 属性
QCString	m_file
QCString	m_md5Hash
QCString	m_dotExe
bool	m_cleanUp
std::vector< DotJob >	m_jobs

详细描述

Helper class to run dot from doxygen from multiple threads.

在文件 dotrunner.h 第 30 行定义.

构造及析构函数说明

DotRunner()

DotRunner::DotRunner	(	const QCString &	absDotName,
		const QCString &	md5Hash = QCString()
	)

Creates a runner for a dot file.

在文件 dotrunner.cpp 第 141 行定义.

  : m_file(absDotName)
  , m_md5Hash(md5Hash)
  , m_dotExe(Config_getString(DOT_PATH)+"dot")
  , m_cleanUp(Config_getBool(DOT_CLEANUP))
{
}

成员函数说明

addJob()

void DotRunner::addJob	(	const QCString &	format,
		const QCString &	output,
		const QCString &	srcFile,
		int	srcLine
	)

Adds an additional job to the run.

Performing multiple jobs one file can be faster.

在文件 dotrunner.cpp 第 150 行定义.

{
 
  for (auto& s: m_jobs)
  {
    if (s.format != format) continue;
    if (s.output != output) continue;
    // we have this job already
    return;
  }
  auto args = QCString("-T") + format + " -o \"" + output + "\"";
  m_jobs.emplace_back(format.str(), output, args, srcFile, srcLine);
}

引用了 m_jobs , 以及 QCString::str().

被这些函数引用 DotGraph::prepareDotFile(), writeDotGraphFromFile() , 以及 writeDotImageMapFromFile().

getMd5Hash()

QCString DotRunner::getMd5Hash ( )

inline

在文件 dotrunner.h 第 72 行定义.

{

preventCleanUp()

void DotRunner::preventCleanUp ( )

inline

Prevent cleanup of the dot file (for user provided dot files)

在文件 dotrunner.h 第 67 行定义.

被这些函数引用 writeDotGraphFromFile() , 以及 writeDotImageMapFromFile().

readBoundingBox()

bool DotRunner::readBoundingBox ( const QCString &  fileName, int *  width, int *  height, bool  isEps  )

static

在文件 dotrunner.cpp 第 107 行定义.

{
  const char *bb = isEps ? "%%PageBoundingBox:" : "/MediaBox [";
  int bblen = (int)strlen(bb);
  FILE *f = Portable::fopen(fileName,"rb");
  if (!f)
  {
    //printf("readBoundingBox: could not open %s\n",fileName);
    return FALSE;
  }
  const int maxLineLen=1024;
  char buf[maxLineLen];
  while (fgets(buf,maxLineLen,f)!=NULL)
  {
     const char *p = strstr(buf,bb);
     if (p) // found PageBoundingBox or /MediaBox string
     {
       int x,y;
       fclose(f);
       if (sscanf(p+bblen,"%d %d %d %d",&x,&y,width,height)!=4)
       {
         //printf("readBoundingBox sscanf fail\n");
         return FALSE;
       }
       return TRUE;
     }
  }
  err("Failed to extract bounding box from generated diagram file %s\n",qPrint(fileName));
  fclose(f);
  return FALSE;
}

引用了 err(), FALSE, Portable::fclose(), Portable::fopen(), qPrint() , 以及 TRUE.

被这些函数引用 run() , 以及 DotFilePatcher::writeVecGfxFigure().

run()

bool DotRunner::run

(

)

Runs dot for all jobs added.

在文件 dotrunner.cpp 第 172 行定义.

{
  int exitCode=0;
 
  QCString dotArgs;
 
  QCString srcFile;
  int srcLine=-1;
 
  // create output
  if (Config_getBool(DOT_MULTI_TARGETS))
  {
    dotArgs=QCString("\"")+m_file+"\"";
    for (auto& s: m_jobs)
    {
      dotArgs+=' ';
      dotArgs+=s.args;
    }
    if (!m_jobs.empty())
    {
      srcFile = m_jobs.front().srcFile;
      srcLine = m_jobs.front().srcLine;
    }
    if ((exitCode=Portable::system(m_dotExe,dotArgs,FALSE))!=0) goto error;
  }
  else
  {
    for (auto& s : m_jobs)
    {
      srcFile = s.srcFile;
      srcLine = s.srcLine;
      dotArgs=QCString("\"")+m_file+"\" "+s.args;
      if ((exitCode=Portable::system(m_dotExe,dotArgs,FALSE))!=0) goto error;
    }
  }
 
  // check output
  // As there should be only one pdf file be generated, we don't need code for regenerating multiple pdf files in one call
  for (auto& s : m_jobs)
  {
    if (s.format.left(3)=="pdf")
    {
      int width=0,height=0;
      if (!readBoundingBox(s.output,&width,&height,FALSE)) goto error;
      if ((width > MAX_LATEX_GRAPH_SIZE) || (height > MAX_LATEX_GRAPH_SIZE))
      {
        if (!resetPDFSize(width,height,getBaseNameOfOutput(s.output))) goto error;
        dotArgs=QCString("\"")+m_file+"\" "+s.args;
        if ((exitCode=Portable::system(m_dotExe,dotArgs,FALSE))!=0) goto error;
      }
    }
 
    if (s.format.left(3)=="png")
    {
      checkPngResult(s.output);
    }
  }
 
  // remove .dot files
  if (m_cleanUp)
  {
    //printf("removing dot file %s\n",qPrint(m_file));
    Portable::unlink(m_file);
  }
 
  // create checksum file
  if (!m_md5Hash.isEmpty())
  {
    QCString md5Name = getBaseNameOfOutput(m_file) + ".md5";
    FILE *f = Portable::fopen(md5Name,"w");
    if (f)
    {
      fwrite(m_md5Hash.data(),1,32,f);
      fclose(f);
    }
  }
  return TRUE;
error:
  err_full(srcFile,srcLine,"Problems running dot: exit code=%d, command='%s', arguments='%s'\n",
    exitCode,qPrint(m_dotExe),qPrint(dotArgs));
  return FALSE;
}

引用了 checkPngResult(), Config_getBool, QCString::data(), err_full(), FALSE, Portable::fclose(), Portable::fopen(), getBaseNameOfOutput(), QCString::isEmpty(), m_cleanUp, m_dotExe, m_file, m_jobs, m_md5Hash, MAX_LATEX_GRAPH_SIZE, qPrint(), readBoundingBox(), resetPDFSize(), Portable::system(), TRUE , 以及 Portable::unlink().

被这些函数引用 DotWorkerThread::run(), writeDotGraphFromFile() , 以及 writeDotImageMapFromFile().

类成员变量说明

m_cleanUp

bool DotRunner::m_cleanUp

private

在文件 dotrunner.h 第 80 行定义.

被这些函数引用 run().

m_dotExe

QCString DotRunner::m_dotExe

private

在文件 dotrunner.h 第 79 行定义.

被这些函数引用 run().

m_file

QCString DotRunner::m_file

private

在文件 dotrunner.h 第 77 行定义.

被这些函数引用 run().

m_jobs

std::vector<DotJob> DotRunner::m_jobs

private

在文件 dotrunner.h 第 81 行定义.

被这些函数引用 addJob() , 以及 run().

m_md5Hash

QCString DotRunner::m_md5Hash

private

在文件 dotrunner.h 第 78 行定义.

被这些函数引用 run().

---

该类的文档由以下文件生成:

• src/dotrunner.h
• src/dotrunner.cpp