TooltipManager类 参考

Class that manages the tooltips for a source file 更多...

#include <tooltip.h>

类
class	Private

Public 成员函数
	TooltipManager ()
	~TooltipManager ()
void	addTooltip (CodeOutputInterface &ol, const Definition *d)
	add a tooltip for a given symbol definition 更多...
void	writeTooltips (CodeOutputInterface &ol)
	write the list of all collected tooltip to the given outputs 更多...

Private 属性
std::unique_ptr< Private >	p

详细描述

Class that manages the tooltips for a source file

在文件 tooltip.h 第 24 行定义.

构造及析构函数说明

TooltipManager()

TooltipManager::TooltipManager

(

)

在文件 tooltip.cpp 第 39 行定义.

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

~TooltipManager()

TooltipManager::~TooltipManager

(

)

在文件 tooltip.cpp 第 43 行定义.

{
}

成员函数说明

addTooltip()

void TooltipManager::addTooltip	(	CodeOutputInterface &	ol,
		const Definition *	d
	)

add a tooltip for a given symbol definition

在文件 tooltip.cpp 第 54 行定义.

{
  bool sourceTooltips = Config_getBool(SOURCE_TOOLTIPS);
  if (!sourceTooltips) return;
 
  QCString id = d->getOutputFileBase();
  int i=id.findRev('/');
  if (i!=-1)
  {
    id = id.right(id.length()-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.
  QCString currentExtension = getFileNameExtension(id);
  if (currentExtension.isEmpty())
  {
    id += escapeId(Doxygen::htmlFileExtension);
  }
  else
  {
    id = stripExtensionGeneral(id,currentExtension) + escapeId(currentExtension);
  }
 
  QCString anc = d->anchor();
  if (!anc.isEmpty())
  {
    id+="_"+anc;
  }
  id = "a" + id;
  p->tooltipInfo.insert(std::make_pair(id.str(),d));
  //printf("%p: addTooltip(%s) ol=%d\n",this,id.data(),ol.id());
}

引用了 Definition::anchor(), Config_getBool, escapeId(), QCString::findRev(), getFileNameExtension(), Definition::getOutputFileBase(), Doxygen::htmlFileExtension, QCString::isEmpty(), p , 以及 stripExtensionGeneral().

writeTooltips()

void TooltipManager::writeTooltips

(

CodeOutputInterface &

ol

)

write the list of all collected tooltip to the given outputs

在文件 tooltip.cpp 第 87 行定义.

{
  int id = ol.id();
  std::unordered_map<int, std::set<std::string> >::iterator it;
  // critical section
  {
    std::lock_guard<std::mutex> lock(g_tooltipsMutex);
    it = g_tooltipsWrittenPerFile.find(id);
    if (it==g_tooltipsWrittenPerFile.end()) // new file
    {
      it = g_tooltipsWrittenPerFile.insert(std::make_pair(id,std::set<std::string>())).first;
    }
  }
 
  for (const auto &kv : p->tooltipInfo)
  {
    bool written = it->second.find(kv.first)!=it->second.end();
    if (!written) // only write tooltips once
    {
      //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
          );
      it->second.insert(kv.first); // remember we wrote this tooltip for the given file id
    }
  }
}

引用了 DocLinkInfo::anchor, SourceLinkInfo::anchor, Definition::anchor(), Definition::briefDescriptionAsTooltip(), MemberDef::declaration(), Definition::definitionType(), SourceLinkInfo::file, g_tooltipsMutex, g_tooltipsWrittenPerFile, Definition::getBodyDef(), Definition::getOutputFileBase(), Definition::getReference(), Definition::getSourceAnchor(), Definition::getSourceFileBase(), Definition::getStartBodyLine(), CodeOutputInterface::id(), Definition::isAnonymous(), SourceLinkInfo::line, DocLinkInfo::name, FileDef::name(), p, Definition::qualifiedName(), DocLinkInfo::ref, toMemberDef(), Definition::TypeMember, DocLinkInfo::url, SourceLinkInfo::url , 以及 CodeOutputInterface::writeTooltip().

类成员变量说明

p

std::unique_ptr<Private> TooltipManager::p

private

在文件 tooltip.h 第 37 行定义.

被这些函数引用 addTooltip() , 以及 writeTooltips().

---

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

• src/tooltip.h
• src/tooltip.cpp