Singleton that manages plantuml relation actions 更多...

#include <plantuml.h>

Public 类型
enum	OutputFormat { PUML_BITMAP, PUML_EPS, PUML_SVG }
	Plant UML output image formats 更多...

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

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

Public 成员函数
void	run ()
	Run plant UML tool for all images 更多...

QCString	writePlantUMLSource (const QCString &outDir, const QCString &fileName, const QCString &content, OutputFormat format, const QCString &engine, const QCString &srcFile, int srcLine)
	Write a PlantUML compatible file. 更多...

void	generatePlantUMLOutput (const QCString &baseName, const QCString &outDir, OutputFormat format)
	Convert a PlantUML file to an image. 更多...

静态 Public 成员函数
static PlantumlManager &	instance ()

Private 成员函数
	PlantumlManager ()

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

Private 属性
FilesMap	m_pngPlantumlFiles

FilesMap	m_svgPlantumlFiles

FilesMap	m_epsPlantumlFiles

ContentMap	m_pngPlantumlContent

ContentMap	m_svgPlantumlContent

ContentMap	m_epsPlantumlContent

详细描述

Singleton that manages plantuml relation actions

在文件 plantuml.h 第 40 行定义.

成员类型定义说明

◆ ContentMap

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

在文件 plantuml.h 第 74 行定义.

◆ FilesMap

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

在文件 plantuml.h 第 73 行定义.

成员枚举类型说明

◆ OutputFormat

enum PlantumlManager::OutputFormat

Plant UML output image formats

枚举值
PUML_BITMAP
PUML_EPS
PUML_SVG

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

44 { PUML_BITMAP, PUML_EPS, PUML_SVG };

构造及析构函数说明

◆ PlantumlManager()

PlantumlManager::PlantumlManager ( )

private

在文件 plantuml.cpp 第 130 行定义.

131 {

132 }

成员函数说明

◆ generatePlantUMLOutput()

void PlantumlManager::generatePlantUMLOutput	(	const QCString &	baseName,
		const QCString &	outDir,
		OutputFormat	format
	)

Convert a PlantUML file to an image.

参数

[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.

在文件 plantuml.cpp 第 91 行定义.

 {
   QCString plantumlJarPath = Config_getString(PLANTUML_JAR_PATH);
   QCString plantumlConfigFile = Config_getString(PLANTUML_CFG_FILE);
   QCString dotPath = Config_getString(DOT_PATH);
  
   QCString 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).
   int i;
   if ((i=imgName.findRev('/'))!=-1) // strip path
   {
     imgName=imgName.right(imgName.length()-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);
 }

引用了 IndexList::addImageFile(), Config_getString, QCString::findRev(), Doxygen::indexList, QCString::length(), PUML_BITMAP, PUML_EPS, PUML_SVG , 以及 QCString::right().

被这些函数引用 FlowChart::printUmlTree(), HtmlDocVisitor::writePlantUMLFile(), DocbookDocVisitor::writePlantUMLFile(), RTFDocVisitor::writePlantUMLFile() , 以及 LatexDocVisitor::writePlantUMLFile().

◆ insert()

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

private

在文件 plantuml.cpp 第 340 行定义.

 {
   Debug::print(Debug::Plantuml,0,"*** %s key:%s ,value:%s\n","PlantumlManager::insert",qPrint(key),qPrint(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;
   }
 }

引用了 addPlantumlContent(), addPlantumlFiles(), m_epsPlantumlContent, m_epsPlantumlFiles, m_pngPlantumlContent, m_pngPlantumlFiles, m_svgPlantumlContent, m_svgPlantumlFiles, Debug::Plantuml, Debug::print(), print(), PUML_BITMAP, PUML_EPS, PUML_SVG , 以及 qPrint().

被这些函数引用 writePlantUMLSource().

◆ instance()

PlantumlManager & PlantumlManager::instance ( )

static

在文件 plantuml.cpp 第 124 行定义.

 {
   static PlantumlManager theInstance;
   return theInstance;
 }

被这些函数引用 generateOutput(), FlowChart::printUmlTree(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), HtmlDocVisitor::writePlantUMLFile(), DocbookDocVisitor::writePlantUMLFile(), RTFDocVisitor::writePlantUMLFile(), LatexDocVisitor::writePlantUMLFile() , 以及 writePlantUMLSource().

◆ run()

void PlantumlManager::run ( )

Run plant UML tool for all images

在文件 plantuml.cpp 第 282 行定义.

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

引用了 m_epsPlantumlContent, m_epsPlantumlFiles, m_pngPlantumlContent, m_pngPlantumlFiles, m_svgPlantumlContent, m_svgPlantumlFiles, Debug::Plantuml, Debug::print(), PUML_BITMAP, PUML_EPS, PUML_SVG , 以及 runPlantumlContent().

被这些函数引用 generateOutput().

◆ writePlantUMLSource()

QCString PlantumlManager::writePlantUMLSource	(	const QCString &	outDir,
		const QCString &	fileName,
		const QCString &	content,
		OutputFormat	format,
		const QCString &	engine,
		const QCString &	srcFile,
		int	srcLine
	)

Write a PlantUML compatible file.

参数

[in]	outDir	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.

返回: The name of the generated file.

在文件 plantuml.cpp 第 26 行定义.

 {
   QCString baseName;
   QCString puName;
   QCString imgName;
   QCString outDir(outDirArg);
   static int umlindex=1;
  
   Debug::print(Debug::Plantuml,0,"*** %s fileName: %s\n","writePlantUMLSource",qPrint(fileName));
   Debug::print(Debug::Plantuml,0,"*** %s outDir: %s\n","writePlantUMLSource",qPrint(outDir));
  
   // strip any trailing slashes and backslashes
   uint l;
   while ((l=outDir.length())>0 && (outDir.at(l-1)=='/' || outDir.at(l-1)=='\\'))
   {
     outDir = outDir.left(l-1);
   }
  
   if (fileName.isEmpty()) // generate name
   {
     puName = "inline_umlgraph_"+QCString().setNum(umlindex);
     baseName = outDir+"/inline_umlgraph_"+QCString().setNum(umlindex++);
   }
   else // user specified name
   {
     baseName = fileName;
     int i=baseName.findRev('.');
     if (i!=-1) 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;
   }
  
   Debug::print(Debug::Plantuml,0,"*** %s baseName: %s\n","writePlantUMLSource",qPrint(baseName));
   Debug::print(Debug::Plantuml,0,"*** %s puName: %s\n","writePlantUMLSource",qPrint(puName));
   Debug::print(Debug::Plantuml,0,"*** %s imgName: %s\n","writePlantUMLSource",qPrint(imgName));
  
   QCString text = "@start"+engine+" "+imgName+"\n";
   text+=content;
   text+="\n@end"+engine+"\n";
  
   QCString qcOutDir(outDir);
   uint pos = qcOutDir.findRev("/");
   QCString generateType(qcOutDir.right(qcOutDir.length() - (pos + 1)) );
   Debug::print(Debug::Plantuml,0,"*** %s generateType: %s\n","writePlantUMLSource",qPrint(generateType));
   PlantumlManager::instance().insert(generateType.str(),puName.str(),outDir,format,text,srcFile,srcLine);
   Debug::print(Debug::Plantuml,0,"*** %s generateType: %s\n","writePlantUMLSource",qPrint(generateType));
  
   return baseName;
 }

引用了 QCString::at(), QCString::findRev(), insert(), instance(), QCString::isEmpty(), QCString::left(), QCString::length(), Debug::Plantuml, QCString::prepend(), Debug::print(), PUML_BITMAP, PUML_EPS, PUML_SVG, QCString::QCString(), qPrint(), QCString::right() , 以及 QCString::str().

被这些函数引用 FlowChart::printUmlTree(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit() , 以及 RTFDocVisitor::visit().

类成员变量说明

◆ m_epsPlantumlContent

ContentMap PlantumlManager::m_epsPlantumlContent

private

在文件 plantuml.h 第 90 行定义.

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

◆ m_epsPlantumlFiles

FilesMap PlantumlManager::m_epsPlantumlFiles

private

在文件 plantuml.h 第 87 行定义.

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

◆ m_pngPlantumlContent

ContentMap PlantumlManager::m_pngPlantumlContent

private

在文件 plantuml.h 第 88 行定义.

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

◆ m_pngPlantumlFiles

FilesMap PlantumlManager::m_pngPlantumlFiles

private

在文件 plantuml.h 第 85 行定义.

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

◆ m_svgPlantumlContent

ContentMap PlantumlManager::m_svgPlantumlContent

private

在文件 plantuml.h 第 89 行定义.

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

◆ m_svgPlantumlFiles

FilesMap PlantumlManager::m_svgPlantumlFiles

private

在文件 plantuml.h 第 86 行定义.

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

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

src/plantuml.h
src/plantuml.cpp

Public 类型

Public 成员函数

静态 Public 成员函数

Private 成员函数

Private 属性

详细描述

成员类型定义说明

◆ ContentMap

◆ FilesMap

成员枚举类型说明

◆ OutputFormat

构造及析构函数说明

◆ PlantumlManager()

成员函数说明

◆ generatePlantUMLOutput()

◆ insert()

◆ instance()

◆ run()

◆ writePlantUMLSource()

类成员变量说明

◆ m_epsPlantumlContent

◆ m_epsPlantumlFiles

◆ m_pngPlantumlContent

◆ m_pngPlantumlFiles

◆ m_svgPlantumlContent

◆ m_svgPlantumlFiles