MermaidManager Class Reference

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

#include <src/mermaid.h>

Classes
struct	MermaidDiagram

Public Types
enum class	OutputFormat { HTML , LaTeX , RTF , Docbook }
	Mermaid output image formats. More...
enum class	ImageFormat { PNG , SVG , PDF }
using	DiagramList = std::vector<MermaidDiagram>

Public Member Functions
void	setHasInlineDiagrams ()
bool	hasInlineDiagrams () const
void	run ()
	Run mmdc tool for all collected diagrams.
QCString	writeMermaidSource (const QCString &outDirArg, const QCString &fileName, const QCString &content, ImageFormat 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, ImageFormat format, bool toIndex)
	Register a generated Mermaid image with the index.

Static Public Member Functions
static MermaidManager &	instance ()
static QCString	imageExtension (ImageFormat imageFormat)
static ImageFormat	convertToImageFormat (OutputFormat outputFormat)

Private Member Functions
	MermaidManager ()

Private Attributes
DiagramList	m_diagrams
bool	m_hasInlineDiagrams = false

Detailed Description

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

Definition at line 40 of file mermaid.h.

Member Typedef Documentation

DiagramList

using MermaidManager::DiagramList = std::vector<MermaidDiagram>

Definition at line 82 of file mermaid.h.

Member Enumeration Documentation

ImageFormat

enum class MermaidManager::ImageFormat

strong

Enumerator
PNG
SVG
PDF

Definition at line 45 of file mermaid.h.

{ PNG, SVG, PDF };

OutputFormat

enum class MermaidManager::OutputFormat

strong

Mermaid output image formats.

Enumerator
HTML
LaTeX
RTF
Docbook

Definition at line 44 of file mermaid.h.

{ HTML, LaTeX, RTF, Docbook };

Constructor & Destructor Documentation

MermaidManager()

MermaidManager::MermaidManager ( )

private

Definition at line 39 of file mermaid.cpp.

{
}

Referenced by instance().

Member Function Documentation

convertToImageFormat()

MermaidManager::ImageFormat MermaidManager::convertToImageFormat ( OutputFormat outputFormat )

static

Definition at line 54 of file mermaid.cpp.

{
  switch(outputFormat)
  {
    case OutputFormat::HTML:
      // fall through
    case OutputFormat::RTF:
      // fall through
    case OutputFormat::Docbook:
      return getDotImageExtension()=="svg" ? ImageFormat::SVG : ImageFormat::PNG;
    case OutputFormat::LaTeX:
      return Config_getBool(USE_PDFLATEX) ? ImageFormat::PDF : ImageFormat::PNG;
  }
  return ImageFormat::PNG;
}

References Config_getBool, Docbook, getDotImageExtension(), HTML, LaTeX, PDF, PNG, RTF, and SVG.

Referenced by 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().

generateMermaidOutput()

void MermaidManager::generateMermaidOutput	(	const QCString &	baseName,
		const QCString &	outDir,
		ImageFormat	format,
		bool	toIndex )

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.
[in]	toIndex	add the file to the index lists for htmlhelp / qhc etc.

Definition at line 117 of file mermaid.cpp.

{
  if (!toIndex) return;
  QCString imgName = baseName;
  int i = imgName.findRev('/');
  if (i != -1)
  {
    imgName = imgName.mid(i + 1);
  }
  imgName += "." + imageExtension(imageFormat);
  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().

hasInlineDiagrams()

bool MermaidManager::hasInlineDiagrams ( ) const

inline

Definition at line 50 of file mermaid.h.

{ return m_hasInlineDiagrams; }

References m_hasInlineDiagrams.

imageExtension()

QCString MermaidManager::imageExtension ( ImageFormat imageFormat )

static

Definition at line 43 of file mermaid.cpp.

{
  switch (format)
  {
    case ImageFormat::PNG: return "png";
    case ImageFormat::SVG: return "svg";
    case ImageFormat::PDF: return "pdf";
  }
  return "png";
}

References PDF, PNG, and SVG.

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

instance()

MermaidManager & MermaidManager::instance ( )

static

Definition at line 33 of file mermaid.cpp.

{
  static MermaidManager theInstance;
  return theInstance;
}

References MermaidManager().

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

run()

void MermaidManager::run

(

)

Run mmdc tool for all collected diagrams.

Definition at line 252 of file mermaid.cpp.

{
  Debug::print(Debug::Mermaid, 0, "*** MermaidManager::run\n");
  runMermaid(m_diagrams);
}

References m_diagrams, Debug::Mermaid, Debug::print(), and runMermaid().

Referenced by generateOutput().

setHasInlineDiagrams()

void MermaidManager::setHasInlineDiagrams

(

)

Definition at line 245 of file mermaid.cpp.

{
  // CLI mode creates images locally, other modes create inline diagram descriptions
  // in the HTML output and rely on rendering them in the browser.
  m_hasInlineDiagrams=Config_getEnum(MERMAID_RENDER_MODE)!=MERMAID_RENDER_MODE_t::CLI;
}

References Config_getEnum, and m_hasInlineDiagrams.

Referenced by handleFormatBlock(), and handleMermaidFile().

writeMermaidSource()

QCString MermaidManager::writeMermaidSource	(	const QCString &	outDirArg,
		const QCString &	fileName,
		const QCString &	content,
		ImageFormat	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 70 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()
  m_diagrams.emplace_back(imageFormat,MermaidDiagramInfo(baseName, content, outDir, srcFile, srcLine));
 
  return baseName;
}

References QCString::at(), QCString::data(), err_full, QCString::findRev(), g_mermaidIndex, g_mermaidMutex, QCString::isEmpty(), QCString::left(), QCString::length(), m_diagrams, 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_diagrams

DiagramList MermaidManager::m_diagrams

private

Definition at line 90 of file mermaid.h.

Referenced by run(), and writeMermaidSource().

m_hasInlineDiagrams

bool MermaidManager::m_hasInlineDiagrams = false

private

Definition at line 91 of file mermaid.h.

Referenced by hasInlineDiagrams(), and setHasInlineDiagrams().

---

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

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