issue doxygen#11492 @plantumlfile command not recognized

- The original problem is about the fact that fact that the `@startuml` command had a filename and this was not expected / anticipated, the result was a concatenation of the name with and "inline" name (i.e. an generated dummy name) and the given name
- Potential problem with handing out the same number for an "inline" file name (multithreading, now protected by means of a mutex.
- With a `\plantumlfile` it is possible to have multiple diagrams in one file, only one was shown, now all are shown.

Author: albert-github

src/docbookvisitor.cpp

@@ -431,13 +431,16 @@ DB_VIS_C
     case DocVerbatim::PlantUML:
       {
         QCString docbookOutput = Config_getString(DOCBOOK_OUTPUT);
-        QCString baseName = PlantumlManager::instance().writePlantUMLSource(docbookOutput,
+        std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(docbookOutput,
             s.exampleFile(),s.text(),PlantumlManager::PUML_BITMAP,
             s.engine(),s.srcFile(),s.srcLine(),true);
-        QCString shortName = makeShortName(baseName);
-        m_t << "<para>\n";
-        writePlantUMLFile(baseName,s);
-        m_t << "</para>\n";
+        for(const auto &baseName: baseNameVector)
+        {
+          QCString shortName = makeShortName(baseName);
+          m_t << "<para>\n";
+          writePlantUMLFile(baseName,s);
+          m_t << "</para>\n";
+        }
       }
       break;
   }
@@ -1561,12 +1564,18 @@ DB_VIS_C
   QCString outDir = Config_getString(DOCBOOK_OUTPUT);
   std::string inBuf;
   readInputFile(fileName,inBuf);
-  QCString baseName = PlantumlManager::instance().writePlantUMLSource(outDir,
+  std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(outDir,
             QCString(),inBuf.c_str(),PlantumlManager::PUML_BITMAP,QCString(),srcFile,srcLine,false);
-  baseName=makeBaseName(baseName);
-  PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP);
-  m_t << "<para>\n";
-  visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png",  width,  height);
+  bool first = true;
+  for(auto &baseName: baseNameVector)
+  {
+    baseName=makeBaseName(baseName);
+    PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,PlantumlManager::PUML_BITMAP);
+    if (!first) endPlantUmlFile(hasCaption);
+    first = false;
+    m_t << "<para>\n";
+    visitPreStart(m_t, children, hasCaption, relPath + baseName + ".png",  width,  height);
+  }
 }
 
 void DocbookDocVisitor::endPlantUmlFile(bool hasCaption)

src/htmldocvisitor.cpp

@@ -675,13 +675,16 @@ void HtmlDocVisitor::operator()(const DocVerbatim &s)
         {
           format = PlantumlManager::PUML_SVG;
         }
-        QCString baseName = PlantumlManager::instance().writePlantUMLSource(
+        std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                                     htmlOutput,s.exampleFile(),
                                     s.text(),format,s.engine(),s.srcFile(),s.srcLine(),true);
-        m_t << "<div class=\"plantumlgraph\">\n";
-        writePlantUMLFile(baseName,s.relPath(),s.context(),s.srcFile(),s.srcLine());
-        visitCaption(m_t, s);
-        m_t << "</div>\n";
+        for(const auto &baseName: baseNameVector)
+        {
+          m_t << "<div class=\"plantumlgraph\">\n";
+          writePlantUMLFile(baseName,s.relPath(),s.context(),s.srcFile(),s.srcLine());
+          visitCaption(m_t, s);
+          m_t << "</div>\n";
+        }
         forceStartParagraph(s);
       }
       break;
@@ -1836,22 +1839,25 @@ void HtmlDocVisitor::operator()(const DocPlantUmlFile &df)
   }
   std::string inBuf;
   readInputFile(df.file(),inBuf);
-  QCString baseName = PlantumlManager::instance().writePlantUMLSource(
+  std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                                     htmlOutput,QCString(),
                                     inBuf.c_str(),format,QCString(),df.srcFile(),df.srcLine(),false);
-  baseName=makeBaseName(baseName);
-  m_t << "<div class=\"plantumlgraph\">\n";
-  writePlantUMLFile(baseName,df.relPath(),QCString(),df.srcFile(),df.srcLine());
-  if (df.hasCaption())
-  {
-    m_t << "<div class=\"caption\">\n";
-  }
-  visitChildren(df);
-  if (df.hasCaption())
+  for(auto &baseName: baseNameVector)
   {
+    baseName=makeBaseName(baseName);
+    m_t << "<div class=\"plantumlgraph\">\n";
+    writePlantUMLFile(baseName,df.relPath(),QCString(),df.srcFile(),df.srcLine());
+    if (df.hasCaption())
+    {
+      m_t << "<div class=\"caption\">\n";
+    }
+    visitChildren(df);
+    if (df.hasCaption())
+    {
+      m_t << "</div>\n";
+    }
     m_t << "</div>\n";
   }
-  m_t << "</div>\n";
   forceStartParagraph(df);
 }
 

src/latexdocvisitor.cpp

@@ -548,12 +548,15 @@ void LatexDocVisitor::operator()(const DocVerbatim &s)
     case DocVerbatim::PlantUML:
       {
         QCString latexOutput = Config_getString(LATEX_OUTPUT);
-        QCString baseName = PlantumlManager::instance().writePlantUMLSource(
+        std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                               latexOutput,s.exampleFile(),s.text(),
                               s.useBitmap() ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS,
                               s.engine(),s.srcFile(),s.srcLine(),true);
 
-        writePlantUMLFile(baseName, s);
+        for(const auto &baseName: baseNameVector)
+        {
+          writePlantUMLFile(baseName, s);
+        }
       }
       break;
   }
@@ -2067,19 +2070,25 @@ void LatexDocVisitor::startPlantUmlFile(const QCString &fileName,
   readInputFile(fileName,inBuf);
 
   bool useBitmap = inBuf.find("@startditaa") != std::string::npos;
-  QCString baseName = PlantumlManager::instance().writePlantUMLSource(
+  std::vector<QCString> baseNameVector = PlantumlManager::instance().writePlantUMLSource(
                               outDir,QCString(),inBuf.c_str(),
                               useBitmap ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS,
                               QCString(),srcFile,srcLine,false);
-  baseName=makeBaseName(baseName);
-  QCString shortName = makeShortName(baseName);
-  if (useBitmap)
+  bool first = true;
+  for(auto &baseName: baseNameVector)
   {
-    if (shortName.find('.')==-1) shortName += ".png";
+    baseName=makeBaseName(baseName);
+    QCString shortName = makeShortName(baseName);
+    if (useBitmap)
+    {
+      if (shortName.find('.')==-1) shortName += ".png";
+    }
+    PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,
+                                useBitmap ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS);
+    if (!first) endPlantUmlFile(hasCaption);
+    first = false;
+    visitPreStart(m_t,hasCaption, shortName, width, height);
   }
-  PlantumlManager::instance().generatePlantUMLOutput(baseName,outDir,
-                              useBitmap ? PlantumlManager::PUML_BITMAP : PlantumlManager::PUML_EPS);
-  visitPreStart(m_t,hasCaption, shortName, width, height);
 }
 
 void LatexDocVisitor::endPlantUmlFile(bool hasCaption)

src/plantuml.cpp

@@ -13,6 +13,7 @@
  *
  */
 
+#include <mutex>
 #include "plantuml.h"
 #include "util.h"
 #include "portable.h"
@@ -25,15 +26,17 @@
 #include "indexlist.h"
 #include "stringutil.h"
 
-QCString PlantumlManager::writePlantUMLSource(const QCString &outDirArg,const QCString &fileName,
+static std::mutex g_PlantUmlMutex;
+
+std::vector<QCString> PlantumlManager::writePlantUMLSource(const QCString &outDirArg,const QCString &fileName,
                                               const QCString &content,OutputFormat format, const QCString &engine,
                                               const QCString &srcFile,int srcLine,bool inlineCode)
 {
+  std::vector<QCString> baseNameVector;
   QCString baseName;
   QCString puName;
   QCString imgName;
   QCString outDir(outDirArg);
-  static int umlindex=1;
 
   Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource fileName: {}\n",fileName);
   Debug::print(Debug::Plantuml,0,"*** writePlantUMLSource outDir: {}\n",outDir);
@@ -45,32 +48,7 @@ QCString PlantumlManager::writePlantUMLSource(const QCString &outDirArg,const QC
     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;
-  }
+  generatePlantUmlFileNames(fileName,format,outDir,baseName,puName,imgName);
 
   Debug::print(Debug::Plantuml,0,"*** writePlantUMLSourcebaseName: {}\n",baseName);
   Debug::print(Debug::Plantuml,0,"*** writePlantUMLSourcebaseName puName: {}\n",puName);
@@ -84,7 +62,7 @@ QCString PlantumlManager::writePlantUMLSource(const QCString &outDirArg,const QC
   {
     char c = 0;
     bool insideComment = false;
-    bool initial       = true;
+    QCString locEngine;
     while ((c=*p++))
     {
       text+=c;
@@ -95,34 +73,153 @@ QCString PlantumlManager::writePlantUMLSource(const QCString &outDirArg,const QC
         case '\t': break;
         case ' ':  break;
         case '@':
-          if (initial && literal_at(p,"start")) // @start...
+          if (!insideComment && literal_at(p,"start")) // @start...
           {
-            while ((c=*p++) && isId(c)) text+=c;
+            locEngine.clear();
+            p+=5;
+            text += "start";
+            while ((c=*p++) && isId(c))
+            {
+              locEngine += c;
+              text+=c;
+            }
+            QCString line;
+            // get everything till end or endOfLine
+            if (c && (c!='\n'))
+            {
+              line += c;
+              while ((c=*p++) && (c!='\n')) line+=c;
+              line = line.stripWhiteSpace();
+            }
+            QCString inpName;
+            QCString rest;
+            // REGEXP (<fn>)(<ext>?)(<rest>)
+            static const reg::Ex re_new0(R"((([A-Za-z0-9_][A-Za-z0-9_-]*)))");
+            static const reg::Ex re_new1(R"((([A-Za-z0-9_][A-Za-z0-9_-]*)(\.[A-Za-z0-9_][A-Za-z0-9_-]*)))");
+            static const reg::Ex re_new2(R"((([A-Za-z0-9_][A-Za-z0-9_-]*)(\.[A-Za-z0-9_][A-Za-z0-9_-]*)(.*)))");
+            static const reg::Ex re_new3(R"(([A-Za-z0-9_][A-Za-z0-9_-]*)(.*))");
+            //std::string_view txtStr = line.view();
+            if (!line.isEmpty())
+            {
+              reg::Match match0;
+              reg::Match match1;
+              reg::Match match2;
+              reg::Match match3;
+              bool matchSet = false;
+              if (matchSet = reg::match(line.str(),match0,re_new0))
+              {
+                inpName = match0[1].str();
+              }
+              else if (matchSet = reg::match(line.str(),match1,re_new1))
+              {
+                inpName = match1[1].str();
+              }
+              else if (matchSet = reg::match(line.str(),match2,re_new2))
+              {
+                inpName = match2[1].str();
+                rest = match2[3].str();
+              }
+              else if (matchSet = reg::match(line.str(),match3,re_new3))
+              {
+                inpName = match3[1].str();
+                rest = match3[2].str();
+              }
+              if (matchSet)
+              {
+                generatePlantUmlFileNames(inpName,format,outDir,baseName,puName,imgName);
+              }
+              else
+              {
+                generatePlantUmlFileNames(QCString(),format,outDir,baseName,puName,imgName);
+              }
+            }
+            else
+            {
+              generatePlantUmlFileNames(QCString(),format,outDir,baseName,puName,imgName);
+            }
+
             // insert the image name
             text+=' ';
             text+=imgName;
+
+            if (!rest.isEmpty())
+            {
+              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)
+            {
+              QCString qcOutDir(substitute(outDir,"\\","/"));
+              uint32_t pos = qcOutDir.findRev("/");
+              QCString generateType(qcOutDir.right(qcOutDir.length() - (pos + 1)) );
+              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.emplace_back(baseName);
+              text.clear();
+            }
+          }
           break;
         default:
-          if (!insideComment) initial=false;
           break;
       }
     }
     text+='\n';
   }
-  if (inlineCode) text +="@end"+engine+"\n";
+  if (inlineCode)
+  {
+    text +="@end"+engine+"\n";
+    //printf("content\n====\n%s\n=====\n->\n-----\n%s\n------\n",qPrint(content),qPrint(text));
+    QCString qcOutDir(substitute(outDir,"\\","/"));
+    uint32_t pos = qcOutDir.findRev("/");
+    QCString generateType(qcOutDir.right(qcOutDir.length() - (pos + 1)) );
+    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.emplace_back(baseName);
+  }
 
-  //printf("content\n====\n%s\n=====\n->\n-----\n%s\n------\n",qPrint(content),qPrint(text));
+  return baseNameVector;
+}
 
-  QCString qcOutDir(substitute(outDir,"\\","/"));
-  uint32_t pos = qcOutDir.findRev("/");
-  QCString generateType(qcOutDir.right(qcOutDir.length() - (pos + 1)) );
-  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);
+void PlantumlManager::generatePlantUmlFileNames(const QCString &fileName,OutputFormat format,const QCString &outDir,
+                                                QCString &baseName,QCString &puName,QCString &imgName)
+{
+  static int umlindex=1;
+
+  if (fileName.isEmpty()) // generate name
+  {
+    std::lock_guard<std::mutex> lock(g_PlantUmlMutex);
+    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+"/");
+  }
 
-  return baseName;
+  switch (format)
+  {
+    case PUML_BITMAP:
+      imgName =puName+".png";
+      break;
+    case PUML_EPS:
+      imgName =puName+".eps";
+      break;
+    case PUML_SVG:
+      imgName =puName+".svg";
+      break;
+  }
 }
 
 void PlantumlManager::generatePlantUMLOutput(const QCString &baseName,const QCString &/* outDir */,OutputFormat format)