Class that manages the tooltips for a source file. More...

#include <src/tooltip.h>

Classes
class	Private

Public Member Functions
	TooltipManager ()
	~TooltipManager ()
void	addTooltip (const Definition *d)
	add a tooltip for a given symbol definition
void	writeTooltips (OutputCodeList &ol)
	write the list of all collected tooltip to the given outputs

Private Attributes
std::unique_ptr< Private >	p

Detailed Description

Class that manages the tooltips for a source file.

Definition at line 25 of file tooltip.h.

Constructor & Destructor Documentation

◆ TooltipManager()

TooltipManager::TooltipManager ( )

Definition at line 41 of file tooltip.cpp.

                               : p(std::make_unique<Private>())
{
}

References p.

◆ ~TooltipManager()

TooltipManager::~TooltipManager ( )

Definition at line 45 of file tooltip.cpp.

46{

47}

Member Function Documentation

◆ addTooltip()

void TooltipManager::addTooltip ( const Definition * d )

add a tooltip for a given symbol definition

Definition at line 56 of file tooltip.cpp.

{
  bool sourceTooltips = Config_getBool(SOURCE_TOOLTIPS);
  if (!sourceTooltips) return;
 
  DString id = d->getOutputFileBase();
  if (size_t i=id.rfind('/'); i!=DString::npos)
  {
    id = id.mid(i+1); // strip path (for CREATE_SUBDIRS=YES)
  }
  // In case an extension is present translate this extension to something understood by the tooltip handler
  // otherwise extend t with a translated htmlFileExtension.
  DString currentExtension = getFileNameExtension(id);
  if (currentExtension.empty())
  {
    id += escapeId(Doxygen::htmlFileExtension);
  }
  else
  {
    id = stripExtensionGeneral(id,currentExtension) + escapeId(currentExtension);
  }
 
  DString anc = d->anchor();
  if (!anc.empty())
  {
    id+="_"+anc;
  }
  id = "a" + id;
  p->tooltipInfo.emplace(id.str(),d);
  //printf("%p: addTooltip(%s)\n",this,id.data());
}

References Definition::anchor(), Config_getBool, DString::empty(), escapeId(), getFileNameExtension(), Definition::getOutputFileBase(), Doxygen::htmlFileExtension, DString::npos, p, and stripExtensionGeneral().

◆ writeTooltips()

void TooltipManager::writeTooltips ( OutputCodeList & ol )

write the list of all collected tooltip to the given outputs

Definition at line 88 of file tooltip.cpp.

{
  std::unordered_map<int, std::unordered_set<std::string> >::iterator it;
  // critical section
  {
    std::lock_guard<std::mutex> lock(g_tooltipsFileMutex);
 
    int id = ol.id();
    it = g_tooltipsWrittenPerFile.find(id);
    if (it==g_tooltipsWrittenPerFile.end()) // new file
    {
      it = g_tooltipsWrittenPerFile.emplace(id,std::unordered_set<std::string>()).first;
    }
  }
 
  for (const auto &[name,d] : p->tooltipInfo)
  {
    bool written = false;
 
    // critical section
    {
      std::lock_guard<std::mutex> lock(g_tooltipsTipMutex);
      written = it->second.find(name)!=it->second.end();
      if (!written) // only write tooltips once
      {
        it->second.insert(name); // remember we wrote this tooltip for the given file id
      }
    }
 
    if (!written)
    {
      //printf("%p: writeTooltips(%s) ol=%d\n",this,qPrint(name),ol.id());
      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...
      DString decl;
      if (d->definitionType()==Definition::TypeMember)
      {
        const MemberDef *md = toMemberDef(d);
        if (!md->isAnonymous())
        {
          decl = md->declaration();
        }
      }
      ol.writeTooltip(name,                // id
          docInfo,                         // symName
          decl,                            // decl
          d->briefDescriptionAsTooltip(),  // desc
          defInfo,
          declInfo
          );
    }
  }
}