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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
// Copyright (C) 2016 Marc Reilly <marc.reilly+qtc@gmail.com>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "resourcepreviewhoverhandler.h"
#include <projectexplorer/project.h>
#include <projectexplorer/projectnodes.h>
#include <projectexplorer/projecttree.h>
#include <texteditor/basehoverhandler.h>
#include <texteditor/texteditor.h>
#include <utils/mimeutils.h>
#include <utils/qtcassert.h>
#include <utils/tooltip/tooltip.h>
#include <QPoint>
#include <QScopeGuard>
#include <QTextBlock>
#include <QXmlStreamReader>
using namespace Core;
using namespace TextEditor;
using namespace Utils;
namespace ProjectExplorer {
/*
* finds a quoted sub-string around the pos in the given string
*/
static QString extractString(const QString &s, int pos)
{
if (s.size() < 2 || pos < 0 || pos >= s.size())
return QString();
const int firstQuote = s.lastIndexOf('"', pos);
if (firstQuote >= 0) {
int endQuote = s.indexOf('"', firstQuote + 1);
if (endQuote > firstQuote)
return s.mid(firstQuote + 1, endQuote - firstQuote - 1);
}
return QString();
}
static QString makeResourcePath(const QStringList &prefixList, const QString &file)
{
QTC_ASSERT(!prefixList.isEmpty(), return QString());
const QChar sep = '/';
const QString prefix = prefixList.join(sep);
if (prefix == sep)
return prefix + file;
return prefix + sep + file;
}
/*
* tries to match a resource within a given .qrc file, including by alias
*
* note: resource name should not have any semi-colon in front of it
*/
static QString findResourceInFile(const QString &resName, const FilePath &qrcFile)
{
const Result<QByteArray> res = qrcFile.fileContents();
if (!res)
return {};
QXmlStreamReader xmlr(*res);
QStringList prefixStack;
while (!xmlr.atEnd() && !xmlr.hasError()) {
const QXmlStreamReader::TokenType token = xmlr.readNext();
if (token == QXmlStreamReader::StartElement) {
if (xmlr.name() == QLatin1String("qresource")) {
const QXmlStreamAttributes sa = xmlr.attributes();
QString prefixName = sa.value("prefix").toString();
if (!prefixName.isEmpty()) {
// non-root prefixes will get a '/' when joined in makeResourcePath
// it avoids "//" which make comparisons below return false
if (prefixName != "/" && prefixName.back() == '/')
prefixName.chop(1);
prefixStack.push_back(prefixName);
}
} else if (xmlr.name() == QLatin1String("file")) {
const QXmlStreamAttributes sa = xmlr.attributes();
const QString aliasName = sa.value("alias").toString();
const QString fileName = xmlr.readElementText();
if (!aliasName.isEmpty()) {
const QString fullAliasName = makeResourcePath(prefixStack, aliasName);
if (resName == fullAliasName)
return fileName;
}
const QString fullResName = makeResourcePath(prefixStack, fileName);
if (resName == fullResName)
return fileName;
}
} else if (token == QXmlStreamReader::EndElement) {
if (xmlr.name() == QLatin1String("qresource")) {
if (!prefixStack.isEmpty())
prefixStack.pop_back();
}
}
}
return QString();
}
/*
* A more efficient way to do this would be to parse the relevant project files
* before hand, or cache them as we go - but this works well enough so far.
*/
static QString findResourceInProject(const QString &resName)
{
QString s = resName;
if (s.startsWith(":/"))
s.remove(0, 1);
else if (s.startsWith("qrc://"))
s.remove(0, 5);
else
return QString();
if (const Project *project = ProjectTree::currentProject()) {
const FilePaths files = project->files(
[](const Node *n) { return n->filePath().endsWith(".qrc"); });
for (const FilePath &file : files) {
const QFileInfo fi = file.toFileInfo();
if (!fi.isReadable())
continue;
const QString fileName = findResourceInFile(s, file);
if (fileName.isEmpty())
continue;
if (QFileInfo::exists(fileName))
return fileName;
QString ret = fi.absolutePath();
if (!ret.endsWith('/'))
ret.append('/');
ret.append(fileName);
return ret;
}
}
return QString();
}
class ResourcePreviewHoverHandler final : public BaseHoverHandler
{
private:
void identifyMatch(TextEditorWidget *editorWidget, int pos, ReportPriority report) final;
void operateTooltip(TextEditorWidget *editorWidget, const QPoint &point) final;
private:
QString makeTooltip() const;
QString m_path;
};
void ResourcePreviewHoverHandler::identifyMatch(TextEditorWidget *editorWidget,
int pos,
ReportPriority report)
{
const QScopeGuard cleanup([this, report] { report(priority()); });
if (editorWidget->extraSelectionTooltip(pos).isEmpty()) {
const QTextBlock tb = editorWidget->document()->findBlock(pos);
const int tbpos = pos - tb.position();
const QString tbtext = tb.text();
const QString str = extractString(tbtext, tbpos);
m_path = findResourceInProject(str);
// If resource does not exit, try to fallback to local files
if (m_path.isEmpty()) {
if (QFileInfo::exists(str))
m_path = str;
else if (QUrl(str).isLocalFile())
m_path = str;
}
setPriority(m_path.isEmpty() ? Priority_None : Priority_Diagnostic + 1);
}
}
void ResourcePreviewHoverHandler::operateTooltip(TextEditorWidget *editorWidget, const QPoint &point)
{
const QString tt = makeTooltip();
if (!tt.isEmpty())
Utils::ToolTip::show(point, tt, Qt::MarkdownText, editorWidget);
else
Utils::ToolTip::hide();
}
QString ResourcePreviewHoverHandler::makeTooltip() const
{
if (m_path.isEmpty())
return QString();
QString ret;
const Utils::MimeType mimeType = Utils::mimeTypeForFile(m_path);
if (mimeType.name().startsWith("image", Qt::CaseInsensitive))
ret += QString(" \n").arg(m_path);
ret += QString("[%1](%2)").arg(QDir::toNativeSeparators(m_path), m_path);
return ret;
}
BaseHoverHandler &resourcePreviewHoverHandler()
{
static ResourcePreviewHoverHandler theResourcePreviewHoverHandler;
return theResourcePreviewHoverHandler;
}
} // namespace ProjectExplorer
|
