DotManager类 参考

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

#include <dot.h>

DotManager 的协作图:

Public 成员函数
DotRunner *	createRunner (const QCString &absDotName, const QCString &md5Hash)
DotFilePatcher *	createFilePatcher (const QCString &fileName)
bool	run () const

静态 Public 成员函数
static DotManager *	instance ()
static void	deleteInstance ()

Private 成员函数
	DotManager ()
virtual	~DotManager ()

Private 属性
std::map< std::string, std::unique_ptr< DotRunner > >	m_runners
std::map< std::string, DotFilePatcher >	m_filePatchers
DotRunnerQueue *	m_queue
std::vector< std::unique_ptr< DotWorkerThread > >	m_workers

静态 Private 属性
static DotManager *	m_theInstance = 0

详细描述

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

在文件 dot.h 第 31 行定义.

构造及析构函数说明

DotManager()

DotManager::DotManager ( )

private

在文件 dot.cpp 第 92 行定义.

                       : m_runners(), m_filePatchers()
{
  m_queue = new DotRunnerQueue;
  int i;
  int dotNumThreads = Config_getInt(DOT_NUM_THREADS);
  if (dotNumThreads!=1)
  {
    for (i=0;i<dotNumThreads;i++)
    {
      std::unique_ptr<DotWorkerThread> thread = std::make_unique<DotWorkerThread>(m_queue);
      thread->start();
      if (thread->isRunning())
      {
        m_workers.push_back(std::move(thread));
      }
      else // no more threads available!
      {
      }
    }
    ASSERT(m_workers.size()>0);
  }
}

引用了 ASSERT, Config_getInt, m_queue , 以及 m_workers.

被这些函数引用 instance().

~DotManager()

DotManager::~DotManager ( )

privatevirtual

在文件 dot.cpp 第 115 行定义.

{
  delete m_queue;
}

引用了 m_queue.

成员函数说明

createFilePatcher()

DotFilePatcher * DotManager::createFilePatcher

(

const QCString &

fileName

)

在文件 dot.cpp 第 143 行定义.

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

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

createRunner()

DotRunner * DotManager::createRunner	(	const QCString &	absDotName,
		const QCString &	md5Hash
	)

在文件 dot.cpp 第 120 行定义.

{
  DotRunner* rv = nullptr;
  auto const runit = m_runners.find(absDotName.str());
  if (runit == m_runners.end())
  {
    auto insobj = std::make_unique<DotRunner>(absDotName, md5Hash);
    rv = insobj.get();
    m_runners.emplace(absDotName.str(), std::move(insobj));
  }
  else
  {
    // we have a match
    if (md5Hash != runit->second->getMd5Hash())
    {
      err("md5 hash does not match for two different runs of %s !\n", qPrint(absDotName));
    }
    rv = runit->second.get();
  }
  assert(rv);
  return rv;
}

引用了 err(), m_runners, qPrint() , 以及 QCString::str().

被这些函数引用 DotGraph::prepareDotFile().

deleteInstance()

void DotManager::deleteInstance ( )

static

在文件 dot.cpp 第 86 行定义.

{
  delete m_theInstance;
  m_theInstance=0;
}

引用了 m_theInstance.

被这些函数引用 cleanUpDoxygen().

instance()

DotManager * DotManager::instance ( )

static

在文件 dot.cpp 第 77 行定义.

{
  if (!m_theInstance)
  {
    m_theInstance = new DotManager;
  }
  return m_theInstance;
}

引用了 DotManager() , 以及 m_theInstance.

被这些函数引用 DotGraph::generateCode(), generateOutput(), DotGraph::prepareDotFile() , 以及 DotLegendGraph::writeGraph().

run()

bool DotManager::run

(

)

const

在文件 dot.cpp 第 154 行定义.

{
  size_t numDotRuns = m_runners.size();
  size_t numFilePatchers = m_filePatchers.size();
  if (numDotRuns+numFilePatchers>1)
  {
    if (m_workers.size()==0)
    {
      msg("Generating dot graphs in single threaded mode...\n");
    }
    else
    {
      msg("Generating dot graphs using %zu parallel threads...\n",std::min(numDotRuns+numFilePatchers,m_workers.size()));
    }
  }
  size_t i=1;
 
  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;
  }
  Portable::sysTimerStart();
  // fill work queue with dot operations
  size_t prev=1;
  if (m_workers.size()==0) // no threads to work with
  {
    for (auto & dr : m_runners)
    {
      msg("Running dot for graph %zu/%zu\n",prev,numDotRuns);
      dr.second->run();
      prev++;
    }
  }
  else // use multiple threads to run instances of dot in parallel
  {
    for (auto & dr: m_runners)
    {
      m_queue->enqueue(dr.second.get());
    }
    // wait for the queue to become empty
    while ((i=m_queue->size())>0)
    {
      i = numDotRuns - i;
      while (i>=prev)
      {
        msg("Running dot for graph %zu/%zu\n",prev,numDotRuns);
        prev++;
      }
      Portable::sleep(100);
    }
    while (numDotRuns>=prev)
    {
      msg("Running dot for graph %zu/%zu\n",prev,numDotRuns);
      prev++;
    }
    // signal the workers we are done
    for (i=0;i<m_workers.size();i++)
    {
      m_queue->enqueue(0); // add terminator for each worker
    }
    // wait for the workers to finish
    for (i=0;i<m_workers.size();i++)
    {
      m_workers.at(i)->wait();
    }
  }
  Portable::sysTimerStop();
  if (setPath)
  {
    unsetDotFontPath();
  }
 
  // patch the output file and insert the maps and figures
  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 %zu/%zu\n",i,numFilePatchers);
      if (!fp.second.run()) return FALSE;
      i++;
    }
  }
  for (auto& fp : m_filePatchers)
  {
    if (!fp.second.isSVGFile())
    {
      msg("Patching output file %zu/%zu\n",i,numFilePatchers);
      if (!fp.second.run()) return FALSE;
      i++;
    }
  }
  return TRUE;
}

引用了 Config_getBool, Config_getString, DotRunnerQueue::enqueue(), FALSE, m_filePatchers, m_queue, m_runners, m_workers, msg(), setDotFontPath(), DotRunnerQueue::size(), Portable::sleep(), Portable::sysTimerStart(), Portable::sysTimerStop(), TRUE , 以及 unsetDotFontPath().

被这些函数引用 generateOutput().

类成员变量说明

m_filePatchers

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

private

在文件 dot.h 第 45 行定义.

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

m_queue

DotRunnerQueue* DotManager::m_queue

private

在文件 dot.h 第 47 行定义.

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

m_runners

std::map<std::string, std::unique_ptr<DotRunner> > DotManager::m_runners

private

在文件 dot.h 第 44 行定义.

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

m_theInstance

DotManager * DotManager::m_theInstance = 0

staticprivate

在文件 dot.h 第 46 行定义.

被这些函数引用 deleteInstance() , 以及 instance().

m_workers

std::vector< std::unique_ptr<DotWorkerThread> > DotManager::m_workers

private

在文件 dot.h 第 48 行定义.

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

---

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

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