DotManager Class Reference

Singleton that manages dot invocations and patching files for embedding image maps. More...

#include <src/dot.h>

Collaboration diagram for DotManager:

Public Member Functions
void	addJob (const DotJob &newJob)
DotFilePatcher *	createFilePatcher (const QCString &fileName)
bool	run ()

Static Public Member Functions
static DotManager *	instance ()

Private Member Functions
	DotManager ()
virtual	~DotManager ()

Private Attributes
DotRunner	m_runner
std::map< std::string, DotFilePatcher >	m_filePatchers
DotJobs	m_jobs

Detailed Description

Singleton that manages dot invocations and patching files for embedding image maps.

Definition at line 33 of file dot.h.

Constructor & Destructor Documentation

DotManager()

DotManager::DotManager ( )

private

Definition at line 84 of file dot.cpp.

                       : m_filePatchers()
{
}

References m_filePatchers.

Referenced by instance().

~DotManager()

DotManager::~DotManager ( )

privatevirtual

Definition at line 88 of file dot.cpp.

{
}

Member Function Documentation

addJob()

void DotManager::addJob

(

const DotJob &

newJob

)

Definition at line 92 of file dot.cpp.

{
  std::lock_guard<std::mutex> lock(g_dotManagerMutex);
  for (const auto &job : m_jobs)
  {
    if (job.absPath == newJob.absPath && job.relDotName == newJob.relDotName && job.format == newJob.format) return; // already queued
    if (job.absPath == newJob.absPath && job.relDotName == newJob.relDotName && job.md5Hash != newJob.md5Hash)
    {
      err("md5 hash does not match for two different runs of {}{} !\n", newJob.absPath, newJob.relDotName);
      return;
    }
  }
  m_jobs.push_back(newJob);
}

References DotJob::absPath, err, DotJob::format, g_dotManagerMutex, m_jobs, DotJob::md5Hash, and DotJob::relDotName.

Referenced by DotGraph::prepareDotFile().

createFilePatcher()

DotFilePatcher * DotManager::createFilePatcher

(

const QCString &

fileName

)

Definition at line 107 of file dot.cpp.

{
  std::lock_guard<std::mutex> lock(g_dotManagerMutex);
  auto patcher = m_filePatchers.find(fileName.str());
 
  if (patcher != m_filePatchers.end()) return &(patcher->second);
 
  auto rv = m_filePatchers.emplace(fileName.str(), fileName);
  assert(rv.second);
  return &(rv.first->second);
}

References g_dotManagerMutex, m_filePatchers, and QCString::str().

instance()

DotManager * DotManager::instance ( )

static

Definition at line 78 of file dot.cpp.

{
  static DotManager theInstance;
  return &theInstance;
}

References DotManager().

Referenced by DotGraph::generateCode(), generateOutput(), DotGraph::prepareDotFile(), and DotLegendGraph::writeGraph().

run()

bool DotManager::run

(

)

Definition at line 119 of file dot.cpp.

{
  size_t numFilePatchers = m_filePatchers.size();
  if (m_jobs.size()+numFilePatchers > 0)
  {
    if (Config_getInt(DOT_NUM_THREADS)<=1)
    {
      msg("Generating {:d} dot graphs in single threaded mode with batch size {:d}...\n",
          m_jobs.size(),Config_getInt(DOT_BATCH_SIZE));
    }
    else
    {
      msg("Generating {:d} dot graphs using {:d} parallel threads with batch size {:d}...\n",
          m_jobs.size(),Config_getInt(DOT_NUM_THREADS),Config_getInt(DOT_BATCH_SIZE));
    }
  }
 
  bool setPath=FALSE;
  if (Config_getBool(GENERATE_HTML))
  {
    setDotFontPath(Config_getString(HTML_OUTPUT));
    setPath=TRUE;
  }
  else if (Config_getBool(GENERATE_LATEX))
  {
    setDotFontPath(Config_getString(LATEX_OUTPUT));
    setPath=TRUE;
  }
  else if (Config_getBool(GENERATE_RTF))
  {
    setDotFontPath(Config_getString(RTF_OUTPUT));
    setPath=TRUE;
  }
  else if (Config_getBool(GENERATE_DOCBOOK))
  {
    setDotFontPath(Config_getString(DOCBOOK_OUTPUT));
    setPath=TRUE;
  }
 
  bool ok = m_runner.run(m_jobs);
 
  if (setPath)
  {
    unsetDotFontPath();
  }
 
  if (!ok) return FALSE;
 
  // patch the output file and insert the maps and figures
  size_t i=1;
  // since patching the svg files may involve patching the header of the SVG
  // (for zoomable SVGs), and patching the .html files requires reading that
  // header after the SVG is patched, we first process the .svg files and
  // then the other files.
  for (auto & fp : m_filePatchers)
  {
    if (fp.second.isSVGFile())
    {
      msg("Patching output file {}/{}\n",i,numFilePatchers);
      if (!fp.second.run()) return FALSE;
      i++;
    }
  }
  for (auto& fp : m_filePatchers)
  {
    if (!fp.second.isSVGFile())
    {
      msg("Patching output file {}/{}\n",i,numFilePatchers);
      if (!fp.second.run()) return FALSE;
      i++;
    }
  }
  return TRUE;
}

References Config_getBool, Config_getInt, Config_getString, FALSE, m_filePatchers, m_jobs, m_runner, msg, setDotFontPath(), TRUE, and unsetDotFontPath().

Referenced by generateOutput().

Member Data Documentation

m_filePatchers

std::map<std::string, DotFilePatcher> DotManager::m_filePatchers

private

Definition at line 47 of file dot.h.

Referenced by createFilePatcher(), DotManager(), and run().

m_jobs

DotJobs DotManager::m_jobs

private

Definition at line 48 of file dot.h.

Referenced by addJob(), and run().

m_runner

DotRunner DotManager::m_runner

private

Definition at line 46 of file dot.h.

Referenced by run().

---

The documentation for this class was generated from the following files:

• src/dot.h
• src/dot.cpp