issue doxygen#12221 Mermaid CDN loading in offline builds and unclear render mode behavio

Author: doxygen

src/commentscan.l

@@ -56,6 +56,7 @@ typedef yyguts_t *yyscan_t;
 #include "entry.h"
 #include "formula.h"
 #include "language.h"
+#include "mermaid.h"
 #include "message.h"
 #include "parserintf.h"
 #include "reflist.h"
@@ -112,6 +113,7 @@ static bool handleAnchor(yyscan_t yyscanner,const QCString &, const StringVector
 static bool handleImage(yyscan_t yyscanner,const QCString &, const StringVector &);
 static bool handleCite(yyscan_t yyscanner,const QCString &, const StringVector &);
 static bool handleFormatBlock(yyscan_t yyscanner,const QCString &, const StringVector &);
+static bool handleMermaidFile(yyscan_t yyscanner,const QCString &s,const StringVector &);
 static bool handleAddIndex(yyscan_t yyscanner,const QCString &, const StringVector &);
 static bool handleIf(yyscan_t yyscanner,const QCString &, const StringVector &);
 static bool handleIfNot(yyscan_t yyscanner,const QCString &, const StringVector &);
@@ -327,7 +329,7 @@ static const std::unordered_map< std::string, DocCmdMap > docCmdMap =
   { "msc",                    { &handleFormatBlock,              CommandSpacing::Block,     SectionHandling::Break   }},
   { "mscfile",                { nullptr,                         CommandSpacing::Block,     SectionHandling::Break   }},
   { "mermaid",                { &handleFormatBlock,              CommandSpacing::Block,     SectionHandling::Break   }},
-  { "mermaidfile",            { nullptr,                         CommandSpacing::Block,     SectionHandling::Break   }},
+  { "mermaidfile",            { &handleMermaidFile,              CommandSpacing::Block,     SectionHandling::Break   }},
   { "name",                   { &handleName,                     CommandSpacing::Invisible, SectionHandling::Escape  }},
   { "namespace",              { &handleNamespace,                CommandSpacing::Invisible, SectionHandling::Escape  }},
   { "noop",                   { &handleNoop,                     CommandSpacing::Invisible, SectionHandling::Replace }},
@@ -3608,6 +3610,10 @@ static bool handleFormatBlock(yyscan_t yyscanner,const QCString &s, const String
     addOutput(yyscanner,yyextra->spaceBeforeCmd);
     yyextra->spaceBeforeCmd.clear();
   }
+  if (s=="mermaid")
+  {
+    MermaidManager::instance().setHasInlineDiagrams();
+  }
   if (optList.empty())
   {
     addOutput(yyscanner,"@"+s+" ");
@@ -3623,6 +3629,14 @@ static bool handleFormatBlock(yyscan_t yyscanner,const QCString &s, const String
   return FALSE;
 }
 
+static bool handleMermaidFile(yyscan_t yyscanner,const QCString &s,const StringVector &)
+{
+  struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;
+  MermaidManager::instance().setHasInlineDiagrams();
+  addOutput(yyscanner,yytext);
+  return false;
+}
+
 static bool handleAddIndex(yyscan_t yyscanner,const QCString &, const StringVector &)
 {
   struct yyguts_t *yyg = (struct yyguts_t*)yyscanner;

src/htmlgen.cpp

@@ -56,6 +56,7 @@
 #include "portable.h"
 #include "outputlist.h"
 #include "stringutil.h"
+#include "mermaid.h"
 
 //#define DBG_HTML(x) x;
 #define DBG_HTML(x)
@@ -579,8 +580,7 @@ static QCString substituteHtmlKeywords(const QCString &file,
     darkModeJs="<script type=\"text/javascript\" src=\"$relpath^darkmode_toggle.js\"></script>\n";
   }
 
-  QCString mermaidRenderMode = Config_getEnumAsString(MERMAID_RENDER_MODE);
-  if (mermaidRenderMode=="CLIENT_SIDE" || mermaidRenderMode=="AUTO")
+  if (MermaidManager::instance().hasInlineDiagrams())
   {
     QCString mermaidJsUrl = Config_getString(MERMAID_JS_URL);
     mermaidJs =  "<script type=\"module\">\n"

src/mermaid.cpp

@@ -242,6 +242,13 @@ static void runMermaid(const MermaidManager::DiagramList &diagrams)
   }
 }
 
+void MermaidManager::setHasInlineDiagrams()
+{
+  // 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;
+}
+
 void MermaidManager::run()
 {
   Debug::print(Debug::Mermaid, 0, "*** MermaidManager::run\n");

src/mermaid.h

@@ -46,6 +46,9 @@ class MermaidManager
 
     static MermaidManager &instance();
 
+    void setHasInlineDiagrams();
+    bool hasInlineDiagrams() const { return m_hasInlineDiagrams; }
+
     /** Run mmdc tool for all collected diagrams */
     void run();
 
@@ -85,6 +88,7 @@ class MermaidManager
     MermaidManager();
 
     DiagramList m_diagrams;
+    bool m_hasInlineDiagrams = false;
 };
 
 #endif