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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "fileiconprovider.h"
#include <utils/hostosinfo.h>
#include <utils/mimetypes/mimedatabase.h>
#include <utils/optional.h>
#include <utils/qtcassert.h>
#include <utils/variant.h>
#include <QApplication>
#include <QStyle>
#include <QPainter>
#include <QFileInfo>
#include <QHash>
#include <QDebug>
#include <QFileIconProvider>
#include <QIcon>
using namespace Utils;
/*!
\class Core::FileIconProvider
Provides icons based on file suffixes with the ability to overwrite system
icons for specific subtypes. The underlying QFileIconProvider
can be used for QFileSystemModel.
Note: Registering overlay icons currently completely replaces the system
icon and is therefore not recommended on platforms that have their
own overlay icon handling (Mac/Windows).
Plugins can register custom overlay icons via registerIconOverlayForSuffix(), and
retrieve icons via the icon() function.
*/
using Item = Utils::variant<QIcon, QString>; // icon or filename for the icon
namespace Core {
namespace FileIconProvider {
enum { debug = 0 };
static Utils::optional<QIcon> getIcon(QHash<QString, Item> &cache, const QString &key)
{
auto it = cache.constFind(key);
if (it == cache.constEnd())
return {};
if (const QIcon *icon = Utils::get_if<QIcon>(&*it))
return *icon;
// need to create icon from file name first
const QString *fileName = Utils::get_if<QString>(&*it);
QTC_ASSERT(fileName, return {});
const QIcon icon = QIcon(
FileIconProvider::overlayIcon(QStyle::SP_FileIcon, QIcon(*fileName), QSize(16, 16)));
cache.insert(key, icon);
return icon;
}
class FileIconProviderImplementation : public QFileIconProvider
{
public:
FileIconProviderImplementation()
{}
QIcon icon(const QFileInfo &info) const override;
using QFileIconProvider::icon;
void registerIconOverlayForFilename(const QString &iconFilePath, const QString &filename)
{
m_filenameCache.insert(filename, iconFilePath);
}
void registerIconOverlayForSuffix(const QString &iconFilePath, const QString &suffix)
{
m_suffixCache.insert(suffix, iconFilePath);
}
void registerIconOverlayForMimeType(const QIcon &icon, const Utils::MimeType &mimeType)
{
const QStringList suffixes = mimeType.suffixes();
for (const QString &suffix : suffixes) {
QTC_ASSERT(!icon.isNull() && !suffix.isEmpty(), return );
const QPixmap fileIconPixmap = FileIconProvider::overlayIcon(QStyle::SP_FileIcon,
icon,
QSize(16, 16));
// replace old icon, if it exists
m_suffixCache.insert(suffix, fileIconPixmap);
}
}
void registerIconOverlayForMimeType(const QString &iconFilePath, const Utils::MimeType &mimeType)
{
foreach (const QString &suffix, mimeType.suffixes())
registerIconOverlayForSuffix(iconFilePath, suffix);
}
// Mapping of file suffix to icon.
mutable QHash<QString, Item> m_suffixCache;
mutable QHash<QString, Item> m_filenameCache;
};
FileIconProviderImplementation *instance()
{
static FileIconProviderImplementation theInstance;
return &theInstance;
}
QFileIconProvider *iconProvider()
{
return instance();
}
QIcon FileIconProviderImplementation::icon(const QFileInfo &fileInfo) const
{
if (debug)
qDebug() << "FileIconProvider::icon" << fileInfo.absoluteFilePath();
// Check for cached overlay icons by file suffix.
bool isDir = fileInfo.isDir();
const QString filename = !isDir ? fileInfo.fileName() : QString();
if (!filename.isEmpty()) {
const Utils::optional<QIcon> icon = getIcon(m_filenameCache, filename);
if (icon)
return *icon;
}
const QString suffix = !isDir ? fileInfo.suffix() : QString();
if (!suffix.isEmpty()) {
const Utils::optional<QIcon> icon = getIcon(m_suffixCache, suffix);
if (icon)
return *icon;
}
// Get icon from OS (and cache it based on suffix!)
QIcon icon;
if (HostOsInfo::isWindowsHost() || HostOsInfo::isMacHost()) {
icon = QFileIconProvider::icon(fileInfo);
} else { // File icons are unknown on linux systems.
static const QIcon unknownFileIcon(QApplication::style()->standardIcon(QStyle::SP_FileIcon));
icon = isDir ? QFileIconProvider::icon(fileInfo) : unknownFileIcon;
}
if (!isDir && !suffix.isEmpty())
m_suffixCache.insert(suffix, icon);
return icon;
}
/*!
Returns the icon associated with the file suffix in fileInfo. If there is none,
the default icon of the operating system is returned.
*/
QIcon icon(const QFileInfo &info)
{
return instance()->icon(info);
}
/*!
* \overload
*/
QIcon icon(QFileIconProvider::IconType type)
{
return instance()->icon(type);
}
/*!
Creates a pixmap with baseicon and overlays overlayIcon over it.
See platform note in class documentation about recommended usage.
*/
QPixmap overlayIcon(const QPixmap &baseIcon, const QIcon &overlayIcon)
{
QPixmap result = baseIcon;
QPainter painter(&result);
overlayIcon.paint(&painter, QRect(QPoint(), result.size() / result.devicePixelRatio()));
return result;
}
/*!
Creates a pixmap with baseicon at size and overlays overlayIcon over it.
See platform note in class documentation about recommended usage.
*/
QPixmap overlayIcon(QStyle::StandardPixmap baseIcon, const QIcon &overlay, const QSize &size)
{
return overlayIcon(QApplication::style()->standardIcon(baseIcon).pixmap(size), overlay);
}
/*!
Registers an icon for a given suffix, overlaying the system file icon.
See platform note in class documentation about recommended usage.
*/
void registerIconOverlayForSuffix(const QString &path, const QString &suffix)
{
instance()->registerIconOverlayForSuffix(path, suffix);
}
/*!
Registers an icon for all the suffixes of a given mime type, overlaying the system file icon.
*/
void registerIconOverlayForMimeType(const QIcon &icon, const QString &mimeType)
{
instance()->registerIconOverlayForMimeType(icon, Utils::mimeTypeForName(mimeType));
}
/*!
* \overload
*/
void registerIconOverlayForMimeType(const QString &path, const QString &mimeType)
{
instance()->registerIconOverlayForMimeType(path, Utils::mimeTypeForName(mimeType));
}
void registerIconOverlayForFilename(const QString &path, const QString &filename)
{
instance()->registerIconOverlayForFilename(path, filename);
}
// Return a standard directory icon with the specified overlay:
QIcon directoryIcon(const QString &overlay)
{
// Overlay the SP_DirIcon with the custom icons
const QSize desiredSize = QSize(16, 16);
const QPixmap dirPixmap = QApplication::style()->standardIcon(QStyle::SP_DirIcon).pixmap(desiredSize);
const QIcon overlayIcon(overlay);
QIcon result;
result.addPixmap(Core::FileIconProvider::overlayIcon(dirPixmap, overlayIcon));
return result;
}
} // namespace FileIconProvider
} // namespace Core
|
