MermaidManager Class Reference

Singleton that manages Mermaid diagram rendering via the mmdc CLI tool. More...

#include <src/mermaid.h>

Public Types
enum	OutputFormat { MERM_BITMAP , MERM_SVG }
	Mermaid output image formats. More...
using	ContentList = std::vector<MermaidContent>

Public Member Functions
void	run ()
	Run mmdc tool for all collected diagrams.
QCString	writeMermaidSource (const QCString &outDirArg, const QCString &fileName, const QCString &content, OutputFormat format, const QCString &srcFile, int srcLine)
	Write a Mermaid source file and register it for CLI rendering.
void	generateMermaidOutput (const QCString &baseName, const QCString &outDir, OutputFormat format)
	Register a generated Mermaid image with the index.

Static Public Member Functions
static MermaidManager &	instance ()

Private Member Functions
	MermaidManager ()

Static Private Member Functions
static QCString	imageExtension (OutputFormat format)

Private Attributes
ContentList	m_pngContent
ContentList	m_svgContent

Detailed Description

Singleton that manages Mermaid diagram rendering via the mmdc CLI tool.

Definition at line 40 of file mermaid.h.

Member Typedef Documentation

ContentList

using MermaidManager::ContentList = std::vector<MermaidContent>

Definition at line 71 of file mermaid.h.

Member Enumeration Documentation

OutputFormat

enum MermaidManager::OutputFormat

Mermaid output image formats.

Enumerator
MERM_BITMAP
MERM_SVG

Definition at line 44 of file mermaid.h.

{ MERM_BITMAP, MERM_SVG };

Constructor & Destructor Documentation

MermaidManager()

MermaidManager::MermaidManager ( )

private

Definition at line 38 of file mermaid.cpp.

{
}

Referenced by instance().

Member Function Documentation

generateMermaidOutput()

void MermaidManager::generateMermaidOutput	(	const QCString &	baseName,
		const QCString &	outDir,
		OutputFormat	format )

Register a generated Mermaid image with the index.

Parameters

[in]	baseName	the name of the generated file (as returned by writeMermaidSource())
[in]	outDir	the directory containing the resulting image.
[in]	format	the image format that was generated.

Definition at line 104 of file mermaid.cpp.

{
  QCString imgName = baseName;
  int i = imgName.findRev('/');
  if (i != -1)
  {
    imgName = imgName.mid(i + 1);
  }
  imgName += imageExtension(format);
  Doxygen::indexList->addImageFile(imgName);
}

References QCString::findRev(), imageExtension(), Doxygen::indexList, and QCString::mid().

Referenced by DocbookDocVisitor::startMermaidFile(), LatexDocVisitor::startMermaidFile(), DocbookDocVisitor::writeMermaidFile(), HtmlDocVisitor::writeMermaidFile(), LatexDocVisitor::writeMermaidFile(), and RTFDocVisitor::writeMermaidFile().

imageExtension()

QCString MermaidManager::imageExtension ( OutputFormat format )

staticprivate

Definition at line 42 of file mermaid.cpp.

{
  switch (format)
  {
    case MERM_BITMAP: return ".png";
    case MERM_SVG:    return ".svg";
  }
  return ".png";
}

References MERM_BITMAP, and MERM_SVG.

Referenced by generateMermaidOutput().

instance()

MermaidManager & MermaidManager::instance ( )

static

Definition at line 32 of file mermaid.cpp.

{
  static MermaidManager theInstance;
  return theInstance;
}

References MermaidManager().

Referenced by generateOutput(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), DocbookDocVisitor::startMermaidFile(), LatexDocVisitor::startMermaidFile(), DocbookDocVisitor::writeMermaidFile(), HtmlDocVisitor::writeMermaidFile(), LatexDocVisitor::writeMermaidFile(), and RTFDocVisitor::writeMermaidFile().

run()

void MermaidManager::run

(

)

Run mmdc tool for all collected diagrams.

Definition at line 179 of file mermaid.cpp.

{
  Debug::print(Debug::Mermaid, 0, "*** MermaidManager::run\n");
  runMermaidContent(m_pngContent, MERM_BITMAP);
  runMermaidContent(m_svgContent, MERM_SVG);
}

References m_pngContent, m_svgContent, MERM_BITMAP, MERM_SVG, Debug::Mermaid, Debug::print(), and runMermaidContent().

Referenced by generateOutput().

writeMermaidSource()

QCString MermaidManager::writeMermaidSource	(	const QCString &	outDirArg,
		const QCString &	fileName,
		const QCString &	content,
		OutputFormat	format,
		const QCString &	srcFile,
		int	srcLine )

Write a Mermaid source file and register it for CLI rendering.

Parameters

[in]	outDirArg	the output directory to write the file to.
[in]	fileName	the name of the file. If empty a name will be chosen automatically.
[in]	content	the Mermaid diagram source.
[in]	format	the image format to generate.
[in]	srcFile	the source file resulting in the write command.
[in]	srcLine	the line number resulting in the write command.

Returns

The base name of the generated file (without extension).

Definition at line 52 of file mermaid.cpp.

{
  QCString outDir(outDirArg);
  QCString baseName;
 
  // strip any trailing slashes and backslashes
  while (!outDir.isEmpty() && (outDir.at(outDir.length()-1)=='/' || outDir.at(outDir.length()-1)=='\\'))
  {
    outDir = outDir.left(outDir.length()-1);
  }
 
  if (fileName.isEmpty())
  {
    std::lock_guard<std::mutex> lock(g_mermaidMutex);
    baseName = outDir + "/inline_mermaid_" + QCString().setNum(g_mermaidIndex++);
  }
  else
  {
    baseName = fileName;
    int i = baseName.findRev('.');
    if (i != -1) baseName = baseName.left(i);
    baseName.prepend(outDir + "/");
  }
 
  QCString mmdName = baseName + ".mmd";
 
  Debug::print(Debug::Mermaid, 0, "*** writeMermaidSource baseName: {}\n", baseName);
  Debug::print(Debug::Mermaid, 0, "*** writeMermaidSource mmdName: {}\n", mmdName);
 
  // Write the .mmd source file
  std::ofstream file = Portable::openOutputStream(mmdName);
  if (!file.is_open())
  {
    err_full(srcFile, srcLine, "Could not open file {} for writing", mmdName);
    return baseName;
  }
  file.write(content.data(), content.length());
  file.close();
 
  // Store for batch processing in run()
  MermaidContent mc(baseName, content, outDir, srcFile, srcLine);
  switch (format)
  {
    case MERM_BITMAP: m_pngContent.push_back(mc); break;
    case MERM_SVG:    m_svgContent.push_back(mc); break;
  }
 
  return baseName;
}

References QCString::at(), QCString::data(), err_full, QCString::findRev(), g_mermaidIndex, g_mermaidMutex, QCString::isEmpty(), QCString::left(), QCString::length(), m_pngContent, m_svgContent, MERM_BITMAP, MERM_SVG, Debug::Mermaid, Portable::openOutputStream(), QCString::prepend(), Debug::print(), and QCString::setNum().

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), DocbookDocVisitor::startMermaidFile(), and LatexDocVisitor::startMermaidFile().

Member Data Documentation

m_pngContent

ContentList MermaidManager::m_pngContent

private

Definition at line 78 of file mermaid.h.

Referenced by run(), and writeMermaidSource().

m_svgContent

ContentList MermaidManager::m_svgContent

private

Definition at line 79 of file mermaid.h.

Referenced by run(), and writeMermaidSource().

---

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

• src/mermaid.h
• src/mermaid.cpp