Issue #8206: Incorrect XHTML results

Changes:
- Change TooltipManager back into a singleton
- Give the OutputList object a unique output id
- Increment the id at each startFile() atomically
- Pass the id to the HTML code generator
- Store tooltips per output id.
- Keep track of tooltips that are already written for a given id
- for output formats other than HTML the output id is 0 and tooltips are
  not collected and written

1 files changed, 74 insertions, 31 deletions

diff --git a/src/tooltip.cpp b/src/tooltip.cpp
index 3c2f0e1..f8222d7 100644
--- a/src/tooltip.cpp
+++ b/src/tooltip.cpp
@@ -14,7 +14,10 @@
  */
 
 #include <map>
+#include <memory>
+#include <unordered_map>
 #include <string>
+#include <mutex>
 
 #include "tooltip.h"
 #include "definition.h"
@@ -24,12 +27,27 @@
 #include "doxygen.h"
 #include "config.h"
 
+static std::mutex g_tooltipLock;
+
+struct TooltipData
+{
+  std::map<std::string,const Definition*> tooltipInfo;
+  std::set<std::string> tooltipWritten;
+};
+
 class TooltipManager::Private
 {
   public:
-    std::map<std::string,const Definition*> tooltipInfo;
+    std::unordered_map<int, std::unique_ptr<TooltipData> > tooltips;
+    std::unique_ptr<TooltipData> &getTooltipData(int id);
 };
 
+TooltipManager &TooltipManager::instance()
+{
+  static TooltipManager s_instance;
+  return s_instance;
+}
+
 TooltipManager::TooltipManager() : p(std::make_unique<Private>())
 {
 }
@@ -50,10 +68,22 @@ static QCString escapeId(const char *s)
   return res;
 }
 
-void TooltipManager::addTooltip(const Definition *d)
+std::unique_ptr<TooltipData> &TooltipManager::Private::getTooltipData(int id)
+{
+  std::lock_guard<std::mutex> lock(g_tooltipLock);
+  auto it = tooltips.insert(std::make_pair(id,std::make_unique<TooltipData>())).first;
+  return it->second;
+}
+
+void TooltipManager::addTooltip(CodeOutputInterface &ol,const Definition *d)
 {
   bool sourceTooltips = Config_getBool(SOURCE_TOOLTIPS);
   if (!sourceTooltips) return;
+  int outputId = ol.id();
+  if (outputId==0) return;
+
+  auto &ttd = p->getTooltipData(outputId);
+
   QCString id = d->getOutputFileBase();
   int i=id.findRev('/');
   if (i!=-1)
@@ -67,44 +97,57 @@ void TooltipManager::addTooltip(const Definition *d)
     id+="_"+anc;
   }
   id = "a" + id;
-  p->tooltipInfo.insert({id.str(),d});
+  ttd->tooltipInfo.insert(std::make_pair(id.str(),d));
+  //printf("%p: addTooltip(%s) ol=%d\n",this,id.data(),ol.id());
 }
 
 void TooltipManager::writeTooltips(CodeOutputInterface &ol)
 {
-  for (const auto &kv : p->tooltipInfo)
+  int outputId = ol.id(); // get unique identifier per output file
+  if (outputId==0) return; // not set => no HTML output
+  auto it = p->tooltips.find(outputId); // see if we have tooltips for this file
+  if (it!=p->tooltips.end())
   {
-    const Definition *d = kv.second;
-    DocLinkInfo docInfo;
-    docInfo.name   = d->qualifiedName();
-    docInfo.ref    = d->getReference();
-    docInfo.url    = d->getOutputFileBase();
-    docInfo.anchor = d->anchor();
-    SourceLinkInfo defInfo;
-    if (d->getBodyDef() && d->getStartBodyLine()!=-1)
-    {
-      defInfo.file    = d->getBodyDef()->name();
-      defInfo.line    = d->getStartBodyLine();
-      defInfo.url     = d->getSourceFileBase();
-      defInfo.anchor  = d->getSourceAnchor();
-    }
-    SourceLinkInfo declInfo; // TODO: fill in...
-    QCString decl;
-    if (d->definitionType()==Definition::TypeMember)
+    auto &ttd = it->second;
+    for (const auto &kv : ttd->tooltipInfo)
     {
-      const MemberDef *md = toMemberDef(d);
-      if (!md->isAnonymous())
+      if (ttd->tooltipWritten.find(kv.first)==ttd->tooltipWritten.end()) // only write tooltips once
       {
-        decl = md->declaration();
+        //printf("%p: writeTooltips(%s) ol=%d\n",this,kv.first.c_str(),ol.id());
+        const Definition *d = kv.second;
+        DocLinkInfo docInfo;
+        docInfo.name   = d->qualifiedName();
+        docInfo.ref    = d->getReference();
+        docInfo.url    = d->getOutputFileBase();
+        docInfo.anchor = d->anchor();
+        SourceLinkInfo defInfo;
+        if (d->getBodyDef() && d->getStartBodyLine()!=-1)
+        {
+          defInfo.file    = d->getBodyDef()->name();
+          defInfo.line    = d->getStartBodyLine();
+          defInfo.url     = d->getSourceFileBase();
+          defInfo.anchor  = d->getSourceAnchor();
+        }
+        SourceLinkInfo declInfo; // TODO: fill in...
+        QCString decl;
+        if (d->definitionType()==Definition::TypeMember)
+        {
+          const MemberDef *md = toMemberDef(d);
+          if (!md->isAnonymous())
+          {
+            decl = md->declaration();
+          }
+        }
+        ol.writeTooltip(kv.first.c_str(),                // id
+            docInfo,                         // symName
+            decl,                            // decl
+            d->briefDescriptionAsTooltip(),  // desc
+            defInfo,
+            declInfo
+            );
+        ttd->tooltipWritten.insert(kv.first);
       }
     }
-    ol.writeTooltip(kv.first.c_str(),                // id
-                    docInfo,                         // symName
-                    decl,                            // decl
-                    d->briefDescriptionAsTooltip(),  // desc
-                    defInfo,
-                    declInfo
-                   );
   }
 }