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
|
/*
* Copyright (C) 2011 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef IconDatabaseBase_h
#define IconDatabaseBase_h
#include "NativeImagePtr.h"
#include <wtf/Forward.h>
#include <wtf/Noncopyable.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefCounted.h>
namespace WebCore {
class DocumentLoader;
class IconDatabaseClient;
class Image;
class IntSize;
class SharedBuffer;
enum IconLoadDecision {
IconLoadYes,
IconLoadNo,
IconLoadUnknown
};
class CallbackBase : public RefCounted<CallbackBase> {
public:
virtual ~CallbackBase()
{
}
uint64_t callbackID() const { return m_callbackID; }
protected:
CallbackBase(void* context)
: m_context(context)
, m_callbackID(generateCallbackID())
{
}
void* context() const { return m_context; }
private:
static uint64_t generateCallbackID()
{
static uint64_t uniqueCallbackID = 1;
return uniqueCallbackID++;
}
void* m_context;
uint64_t m_callbackID;
};
template<typename EnumType>
class EnumCallback : public CallbackBase {
public:
typedef void (*CallbackFunction)(EnumType, void*);
static Ref<EnumCallback> create(void* context, CallbackFunction callback)
{
return adoptRef(*new EnumCallback(context, callback));
}
virtual ~EnumCallback()
{
ASSERT(!m_callback);
}
void performCallback(EnumType result)
{
if (!m_callback)
return;
m_callback(result, context());
m_callback = nullptr;
}
void invalidate()
{
m_callback = nullptr;
}
private:
EnumCallback(void* context, CallbackFunction callback)
: CallbackBase(context)
, m_callback(callback)
{
ASSERT(m_callback);
}
CallbackFunction m_callback;
};
template<typename ObjectType>
class ObjectCallback : public CallbackBase {
public:
typedef void (*CallbackFunction)(ObjectType, void*);
static Ref<ObjectCallback> create(void* context, CallbackFunction callback)
{
return adoptRef(*new ObjectCallback(context, callback));
}
virtual ~ObjectCallback()
{
ASSERT(!m_callback);
}
void performCallback(ObjectType result)
{
if (!m_callback)
return;
m_callback(result, context());
m_callback = nullptr;
}
void invalidate()
{
m_callback = nullptr;
}
private:
ObjectCallback(void* context, CallbackFunction callback)
: CallbackBase(context)
, m_callback(callback)
{
ASSERT(m_callback);
}
CallbackFunction m_callback;
};
typedef EnumCallback<IconLoadDecision> IconLoadDecisionCallback;
typedef ObjectCallback<SharedBuffer*> IconDataCallback;
class WEBCORE_EXPORT IconDatabaseBase {
WTF_MAKE_NONCOPYABLE(IconDatabaseBase);
protected:
IconDatabaseBase() { }
public:
virtual ~IconDatabaseBase() { }
// Used internally by WebCore
virtual bool isEnabled() const { return false; }
virtual void retainIconForPageURL(const String&) { }
virtual void releaseIconForPageURL(const String&) { }
virtual void setIconURLForPageURL(const String&, const String&) { }
virtual void setIconDataForIconURL(PassRefPtr<SharedBuffer>, const String&) { }
// Synchronous calls used internally by WebCore.
// Usage should be replaced by asynchronous calls.
virtual String synchronousIconURLForPageURL(const String&);
virtual bool synchronousIconDataKnownForIconURL(const String&) { return false; }
virtual IconLoadDecision synchronousLoadDecisionForIconURL(const String&, DocumentLoader*) { return IconLoadNo; }
virtual Image* synchronousIconForPageURL(const String&, const IntSize&) { return nullptr; }
virtual PassNativeImagePtr synchronousNativeIconForPageURL(const String&, const IntSize&) { return nullptr; }
// Asynchronous calls we should use to replace the above when supported.
virtual bool supportsAsynchronousMode() { return false; }
virtual void loadDecisionForIconURL(const String&, PassRefPtr<IconLoadDecisionCallback>) { }
virtual void iconDataForIconURL(const String&, PassRefPtr<IconDataCallback>) { }
// Used within one or more WebKit ports.
// We should try to remove these dependencies from the IconDatabaseBase class.
virtual void setEnabled(bool) { }
virtual Image* defaultIcon(const IntSize&) { return nullptr; }
virtual size_t pageURLMappingCount() { return 0; }
virtual size_t retainedPageURLCount() { return 0; }
virtual size_t iconRecordCount() { return 0; }
virtual size_t iconRecordCountWithData() { return 0; }
virtual bool shouldStopThreadActivity() const { return true; }
virtual bool open(const String& directory, const String& filename);
virtual void close() { }
virtual void removeAllIcons() { }
virtual void setPrivateBrowsingEnabled(bool) { }
virtual void setClient(IconDatabaseClient*) { }
virtual bool isOpen() const { return false; }
virtual String databasePath() const;
};
// Functions to get/set the global icon database.
WEBCORE_EXPORT IconDatabaseBase& iconDatabase();
WEBCORE_EXPORT void setGlobalIconDatabase(IconDatabaseBase*);
bool documentCanHaveIcon(const String&);
} // namespace WebCore
#endif // IconDatabaseBase_h
|
