PlantumlManager Class Reference

Singleton that manages plantuml relation actions. More...

#include <src/plantuml.h>

Public Types
enum	OutputFormat { PUML_BITMAP , PUML_EPS , PUML_SVG }
	Plant UML output image formats. More...
using	FilesMap = std::map< std::string, StringVector >
using	ContentMap = std::map< std::string, PlantumlContent >

Public Member Functions
bool	needToRun () const
void	run ()
	Run plant UML tool for all images.
StringVector	writePlantUMLSource (const DString &outDirArg, const DString &fileName, const DString &content, OutputFormat format, const DString &engine, const DString &srcFile, int srcLine, bool inlineCode)
	Write a PlantUML compatible file.
void	generatePlantUMLOutput (const DString &baseName, const DString &outDir, OutputFormat format, bool toIndex)
	Convert a PlantUML file to an image.

Static Public Member Functions
static PlantumlManager &	instance ()
static bool	isEnabled ()
	Returns true if doxygen has been configured to run PlantUML, i.e.

Private Member Functions
	PlantumlManager ()
void	insert (const std::string &key, const std::string &value, const DString &outDir, OutputFormat format, const DString &puContent, const DString &srcFile, int srcLine)
void	generatePlantUmlFileNames (const DString &fileName, OutputFormat format, const DString &outDir, DString &baseName, DString &puName, DString &imgName)

Private Attributes
FilesMap	m_pngPlantumlFiles
FilesMap	m_svgPlantumlFiles
FilesMap	m_epsPlantumlFiles
ContentMap	m_pngPlantumlContent
ContentMap	m_svgPlantumlContent
ContentMap	m_epsPlantumlContent

Detailed Description

Singleton that manages plantuml relation actions.

Definition at line 39 of file plantuml.h.

Member Typedef Documentation

ContentMap

using PlantumlManager::ContentMap = std::map< std::string, PlantumlContent >

Definition at line 88 of file plantuml.h.

FilesMap

using PlantumlManager::FilesMap = std::map< std::string, StringVector >

Definition at line 87 of file plantuml.h.

Member Enumeration Documentation

OutputFormat

enum PlantumlManager::OutputFormat

Plant UML output image formats.

Enumerator
PUML_BITMAP
PUML_EPS
PUML_SVG

Definition at line 43 of file plantuml.h.

{ PUML_BITMAP, PUML_EPS, PUML_SVG };

Constructor & Destructor Documentation

PlantumlManager()

PlantumlManager::PlantumlManager ( )

private

Definition at line 236 of file plantuml.cpp.

{
}

Referenced by instance().

Member Function Documentation

generatePlantUmlFileNames()

void PlantumlManager::generatePlantUmlFileNames ( const DString & fileName, OutputFormat format, const DString & outDir, DString & baseName, DString & puName, DString & imgName )

private

Definition at line 168 of file plantuml.cpp.

{
  static int umlindex=1;
 
  if (fileName.empty()) // generate name
  {
    std::lock_guard<std::mutex> lock(g_PlantUmlMutex);
    puName = "inline_umlgraph_"+DString().setNum(umlindex);
    baseName = outDir+"/inline_umlgraph_"+DString().setNum(umlindex++);
  }
  else // user specified name
  {
    baseName = fileName;
    if (size_t i=baseName.rfind('.'); i!=DString::npos) baseName = baseName.left(i);
    puName = baseName;
    baseName.prepend(outDir+"/");
  }
 
  switch (format)
  {
    case PUML_BITMAP:
      imgName =puName+".png";
      break;
    case PUML_EPS:
      imgName =puName+".eps";
      break;
    case PUML_SVG:
      imgName =puName+".svg";
      break;
  }
}

References DString::DString(), DString::empty(), g_PlantUmlMutex, DString::left(), DString::npos, DString::prepend(), PUML_BITMAP, PUML_EPS, PUML_SVG, DString::rfind(), and DString::setNum().

Referenced by writePlantUMLSource().

generatePlantUMLOutput()

void PlantumlManager::generatePlantUMLOutput	(	const DString &	baseName,
		const DString &	outDir,
		OutputFormat	format,
		bool	toIndex )

Convert a PlantUML file to an image.

Parameters

[in]	baseName	the name of the generated file (as returned by writePlantUMLSource())
[in]	outDir	the directory to write the resulting image into.
[in]	format	the image format to generate.
[in]	toIndex	add the file to the index lists for htmlhelp / qhc etc.

Definition at line 201 of file plantuml.cpp.

{
  if (!toIndex) return;
  DString imgName = baseName;
  // The basename contains path, we need to strip the path from the filename in order
  // to create the image file name which should be included in the index.qhp (Qt help index file).
  if (size_t i = imgName.rfind('/'); i!=DString::npos) // strip path
  {
    imgName=imgName.mid(i+1);
  }
  switch (format)
  {
    case PUML_BITMAP:
      imgName+=".png";
      break;
    case PUML_EPS:
      imgName+=".eps";
      break;
    case PUML_SVG:
      imgName+=".svg";
      break;
  }
 
  Doxygen::indexList->addImageFile(imgName);
}

References IndexList::addImageFile(), Doxygen::indexList, DString::mid(), DString::npos, PUML_BITMAP, PUML_EPS, PUML_SVG, and DString::rfind().

Referenced by FlowChart::printUmlTree(), DocbookDocVisitor::startPlantUmlFile(), LatexDocVisitor::startPlantUmlFile(), DocbookDocVisitor::writePlantUMLFile(), HtmlDocVisitor::writePlantUMLFile(), LatexDocVisitor::writePlantUMLFile(), and RTFDocVisitor::writePlantUMLFile().

insert()

void PlantumlManager::insert ( const std::string & key, const std::string & value, const DString & outDir, OutputFormat format, const DString & puContent, const DString & srcFile, int srcLine )

private

Definition at line 484 of file plantuml.cpp.

{
  Debug::print(Debug::Plantuml,0,"*** PlantumlManager::insert key:{} ,value:{}\n",key,value);
 
  switch (format)
  {
    case PUML_BITMAP:
      addPlantumlFiles(m_pngPlantumlFiles,key,value);
      print(m_pngPlantumlFiles);
      addPlantumlContent(m_pngPlantumlContent,key,outDir,puContent,srcFile,srcLine);
      print(m_pngPlantumlContent);
      break;
    case PUML_EPS:
      addPlantumlFiles(m_epsPlantumlFiles,key,value);
      print(m_epsPlantumlFiles);
      addPlantumlContent(m_epsPlantumlContent,key,outDir,puContent,srcFile,srcLine);
      print(m_epsPlantumlContent);
      break;
    case PUML_SVG:
      addPlantumlFiles(m_svgPlantumlFiles,key,value);
      print(m_svgPlantumlFiles);
      addPlantumlContent(m_svgPlantumlContent,key,outDir,puContent,srcFile,srcLine);
      print(m_svgPlantumlContent);
      break;
  }
}

References addPlantumlContent(), addPlantumlFiles(), m_epsPlantumlContent, m_epsPlantumlFiles, m_pngPlantumlContent, m_pngPlantumlFiles, m_svgPlantumlContent, m_svgPlantumlFiles, Debug::Plantuml, Debug::print(), print(), PUML_BITMAP, PUML_EPS, and PUML_SVG.

Referenced by writePlantUMLSource().

instance()

PlantumlManager & PlantumlManager::instance ( )

static

Definition at line 230 of file plantuml.cpp.

{
  static PlantumlManager theInstance;
  return theInstance;
}

References PlantumlManager().

Referenced by generateOutput(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), FlowChart::printUmlTree(), DocbookDocVisitor::startPlantUmlFile(), LatexDocVisitor::startPlantUmlFile(), DocbookDocVisitor::writePlantUMLFile(), HtmlDocVisitor::writePlantUMLFile(), LatexDocVisitor::writePlantUMLFile(), RTFDocVisitor::writePlantUMLFile(), and writePlantUMLSource().

isEnabled()

bool PlantumlManager::isEnabled ( )

static

Returns true if doxygen has been configured to run PlantUML, i.e.

when PLANTUML_JAR_PATH or PLANTUML_TOOL has been set.

Definition at line 240 of file plantuml.cpp.

{
  return !Config_getString(PLANTUML_JAR_PATH).empty() ||
         !Config_getString(PLANTUML_TOOL).empty();
}

References Config_getString.

Referenced by DocPara::handleCommand(), Markdown::Private::processQuotations(), and FlowChart::writeFlowChart().

needToRun()

bool PlantumlManager::needToRun ( ) const

inline

Definition at line 52 of file plantuml.h.

    {
      return !m_pngPlantumlContent.empty() ||
             !m_svgPlantumlContent.empty() ||
             !m_epsPlantumlContent.empty();
    }

References m_epsPlantumlContent, m_pngPlantumlContent, and m_svgPlantumlContent.

run()

void PlantumlManager::run

(

)

Run plant UML tool for all images.

Definition at line 426 of file plantuml.cpp.

{
  Debug::print(Debug::Plantuml,0,"*** PlantumlManager::run\n");
  runPlantumlContent(m_pngPlantumlFiles, m_pngPlantumlContent, PUML_BITMAP);
  runPlantumlContent(m_svgPlantumlFiles, m_svgPlantumlContent, PUML_SVG);
  runPlantumlContent(m_epsPlantumlFiles, m_epsPlantumlContent, PUML_EPS);
}

References m_epsPlantumlContent, m_epsPlantumlFiles, m_pngPlantumlContent, m_pngPlantumlFiles, m_svgPlantumlContent, m_svgPlantumlFiles, Debug::Plantuml, Debug::print(), PUML_BITMAP, PUML_EPS, PUML_SVG, and runPlantumlContent().

Referenced by generateOutput().

writePlantUMLSource()

StringVector PlantumlManager::writePlantUMLSource	(	const DString &	outDirArg,
		const DString &	fileName,
		const DString &	content,
		OutputFormat	format,
		const DString &	engine,
		const DString &	srcFile,
		int	srcLine,
		bool	inlineCode )

Write a PlantUML compatible file.

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 contents of the PlantUML file.
[in]	format	the image format to generate.
[in]	engine	the plantuml engine to use.
[in]	srcFile	the source file resulting in the write command.
[in]	srcLine	the line number resulting in the write command.
[in]	inlineCode	the code is coming from the \statuml ... \enduml (true) command or from the \planumlfile command (false)

Returns

The names of the generated files.

Definition at line 31 of file plantuml.cpp.

{
  StringVector baseNameVector;
  DString baseName;
  DString puName;
  DString imgName;
  DString outDir(outDirArg);
 
  Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource fileName: {}\n",fileName);
  Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource outDir: {}\n",outDir);
 
  // strip any trailing slashes and backslashes
  size_t l = 0;
  while ((l=outDir.length())>0 && (outDir.at(l-1)=='/' || outDir.at(l-1)=='\\'))
  {
    outDir = outDir.left(l-1);
  }
 
  generatePlantUmlFileNames(fileName,format,outDir,baseName,puName,imgName);
 
  Debug::print(Debug::Plantuml,0,"*** writePlantUMLSourcebaseName: {}\n",baseName);
  Debug::print(Debug::Plantuml,0,"*** writePlantUMLSourcebaseName puName: {}\n",puName);
  Debug::print(Debug::Plantuml,0,"*** writePlantUMLSourcebaseName imgName: {}\n",imgName);
 
  DString text;
  if (inlineCode) text = "@start"+engine+" "+imgName+"\n";
  text.reserve(text.length()+content.length()+100); // add room for image name and end marker
  const char *p = content.data();
  if (p)
  {
    char c = 0;
    bool insideComment = false;
    DString locEngine;
    while ((c=*p++))
    {
      text+=c;
      switch (c)
      {
        case '\'': insideComment=true; break;
        case '\n': insideComment=false; break;
        case '\t': break;
        case ' ':  break;
        case '@':
          if (!insideComment && literal_at(p,"start")) // @start...
          {
            locEngine.clear();
            p+=5;
            text += "start";
            while ((c=*p++) && isId(c))
            {
              locEngine += c;
              text+=c;
            }
            DString inpName;
            DString rest;
 
            // skip leading whitespace
            if (*p && (c==' ' || c=='\t'))
            {
              while ((c=*p++) && (c==' ' || c=='\t')) {}
            }
            // get everything till end or endOfLine, and split into inpName (without extension) and rest
            enum State { InName, InExt, InRest };
            State state = InName;
            while (*p && c!='\n')
            {
              switch (state)
              {
                case InName: // looking for the name part
                  if      (isId(c) || c=='-') { inpName+=c; }
                  else if (c=='.')            { state=InExt; }
                  else                        { rest+=c; state=InRest; }
                  break;
                case InExt: // skipping over extension part
                  if (!isId(c) && c!='-')     { rest+=c; state=InRest; }
                  break;
                case InRest: // gather rest until new line
                  rest+=c;
                  break;
              }
              c = *p++;
            }
            //printf("inpName='%s' rest='%s'\n",qPrint(inpName),qPrint(rest));
            generatePlantUmlFileNames(inpName,format,outDir,baseName,puName,imgName);
 
            // insert the image name
            text+=' ';
            text+=imgName;
 
            if (!rest.empty())
            {
              text += '\n';
              text += rest;
            }
            if (c) text+=c;
          }
          else if (!insideComment && strncmp(p,("end"+locEngine).data(), 3+strlen(engine.data()))==0) // @end...
          {
            text += "end"+locEngine+"\n";
            p+=3+locEngine.length();
            if (!inlineCode)
            {
              DString qcOutDir(substitute(outDir,"\\","/"));
              size_t pos = qcOutDir.rfind('/');
              DString generateType(pos!=DString::npos ? qcOutDir.mid(pos+1) : qcOutDir);
              Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource generateType: {}\n",generateType);
              PlantumlManager::instance().insert(generateType.str(),puName.str(),outDir,format,text,srcFile,srcLine);
              Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource generateType: {}\n",generateType);
              baseNameVector.push_back(baseName.str());
              text.clear();
            }
          }
          break;
        default:
          break;
      }
    }
    text+='\n';
  }
  if (inlineCode)
  {
    text +="@end"+engine+"\n";
    //printf("content\n====\n%s\n=====\n->\n-----\n%s\n------\n",qPrint(content),qPrint(text));
    DString qcOutDir(substitute(outDir,"\\","/"));
    size_t pos = qcOutDir.rfind("/");
    DString generateType(pos!=DString::npos ? qcOutDir.mid(pos+1) : qcOutDir);
    Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource generateType: {}\n",generateType);
    PlantumlManager::instance().insert(generateType.str(),puName.str(),outDir,format,text,srcFile,srcLine);
    Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource generateType: {}\n",generateType);
    baseNameVector.push_back(baseName.str());
  }
 
  return baseNameVector;
}

References DString::at(), DString::clear(), DString::data(), DString::empty(), generatePlantUmlFileNames(), insert(), instance(), isId(), DString::left(), DString::length(), literal_at(), DString::mid(), DString::npos, Debug::Plantuml, Debug::print(), DString::reserve(), DString::rfind(), DString::str(), and substitute().

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), FlowChart::printUmlTree(), DocbookDocVisitor::startPlantUmlFile(), and LatexDocVisitor::startPlantUmlFile().

Member Data Documentation

m_epsPlantumlContent

ContentMap PlantumlManager::m_epsPlantumlContent

private

Definition at line 106 of file plantuml.h.

Referenced by insert(), needToRun(), and run().

m_epsPlantumlFiles

FilesMap PlantumlManager::m_epsPlantumlFiles

private

Definition at line 103 of file plantuml.h.

Referenced by insert(), and run().

m_pngPlantumlContent

ContentMap PlantumlManager::m_pngPlantumlContent

private

Definition at line 104 of file plantuml.h.

Referenced by insert(), needToRun(), and run().

m_pngPlantumlFiles

FilesMap PlantumlManager::m_pngPlantumlFiles

private

Definition at line 101 of file plantuml.h.

Referenced by insert(), and run().

m_svgPlantumlContent

ContentMap PlantumlManager::m_svgPlantumlContent

private

Definition at line 105 of file plantuml.h.

Referenced by insert(), needToRun(), and run().

m_svgPlantumlFiles

FilesMap PlantumlManager::m_svgPlantumlFiles

private

Definition at line 102 of file plantuml.h.

Referenced by insert(), and run().

---

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

• src/plantuml.h
• src/plantuml.cpp