1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/******************************************************************************
*
* Copyright (C) 1997-2020 by Dimitri van Heesch.
*
* Permission to use, copy, modify, and distribute this software and its
* documentation under the terms of the GNU General Public License is hereby
* granted. No representations are made about the suitability of this software
* for any purpose. It is provided "as is" without express or implied warranty.
* See the GNU General Public License for more details.
*
* Documents produced by Doxygen are derivative works derived from the
* input used in their production; they are not affected by this license.
*
*/
#include <map>
#include <memory>
#include <unordered_map>
#include <string>
#include <mutex>
#include "tooltip.h"
#include "definition.h"
#include "outputlist.h"
#include "util.h"
#include "filedef.h"
#include "doxygen.h"
#include "config.h"
static std::mutex g_tooltipsMutex;
static std::unordered_map<int, std::set<std::string> > g_tooltipsWrittenPerFile;
class TooltipManager::Private
{
public:
std::map<std::string,const Definition*> tooltipInfo;
};
TooltipManager::TooltipManager() : p(std::make_unique<Private>())
{
}
TooltipManager::~TooltipManager()
{
}
static QCString escapeId(const QCString &s)
{
QCString res=s;
for (uint32_t i=0;i<res.length();i++) if (!isId(res[i])) res[i]='_';
return res;
}
void TooltipManager::addTooltip(const Definition *d)
{
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)\n",this,id.data());
}
void TooltipManager::writeTooltips(OutputCodeList &ol)
{
// critical section
std::lock_guard<std::mutex> lock(g_tooltipsMutex);
int id = ol.id();
auto 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 &[name,d] : p->tooltipInfo)
{
bool written = it->second.find(name)!=it->second.end();
if (!written) // only write tooltips once
{
//printf("%p: writeTooltips(%s) ol=%d\n",this,name.c_str(),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...
QCString decl;
if (d->definitionType()==Definition::TypeMember)
{
const MemberDef *md = toMemberDef(d);
if (!md->isAnonymous())
{
decl = md->declaration();
}
}
ol.writeTooltip(name.c_str(), // id
docInfo, // symName
decl, // decl
d->briefDescriptionAsTooltip(), // desc
defInfo,
declInfo
);
it->second.insert(name); // remember we wrote this tooltip for the given file id
}
}
}
|
