8e3281f258991cc96dbcacfdc6c610ff54dcc365
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebIconDatabase.h
1 /*
2  * Copyright (C) 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebIconDatabase_h
27 #define WebIconDatabase_h
28
29 #include "APIObject.h"
30
31 #include "Connection.h"
32 #include "ShareableBitmap.h"
33 #include "WebIconDatabaseClient.h"
34 #include <WebCore/IconDatabaseClient.h>
35 #include <WebCore/ImageSource.h>
36 #include <WebCore/IntSize.h>
37 #include <wtf/Forward.h>
38 #include <wtf/PassRefPtr.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41 #include <wtf/text/StringHash.h>
42
43 namespace CoreIPC {
44 class ArgumentDecoder;
45 class DataReference;
46 }
47
48 namespace WebCore {
49 class IconDatabase;
50 class Image;
51 }
52
53 namespace WebKit {
54
55 class WebContext;
56
57 class WebIconDatabase : public TypedAPIObject<APIObject::TypeIconDatabase>, public WebCore::IconDatabaseClient, private CoreIPC::MessageReceiver {
58 public:
59     static PassRefPtr<WebIconDatabase> create(WebContext*);
60     virtual ~WebIconDatabase();
61
62     void invalidate();
63     void clearContext() { m_webContext = 0; }
64     void setDatabasePath(const String&);
65     void enableDatabaseCleanup();
66
67     void retainIconForPageURL(const String&);
68     void releaseIconForPageURL(const String&);
69     void setIconURLForPageURL(const String&, const String&);
70     void setIconBitmapForIconURL(const ShareableBitmap::Handle&, const String&);
71     
72     void synchronousIconDataForPageURL(const String&, CoreIPC::DataReference&);
73     void synchronousIconURLForPageURL(const String&, String&);
74     void synchronousIconDataKnownForIconURL(const String&, bool&) const;
75     void synchronousLoadDecisionForIconURL(const String&, int&) const;
76     
77     void getLoadDecisionForIconURL(const String&, uint64_t callbackID);
78     void didReceiveIconForPageURL(const String&);
79
80     WebCore::Image* imageForPageURL(const String&, const WebCore::IntSize& iconSize = WebCore::IntSize(32, 32));
81     WebCore::NativeImagePtr nativeImageForPageURL(const String&, const WebCore::IntSize& iconSize = WebCore::IntSize(32, 32));
82     bool isOpen();
83     bool isUrlImportCompleted();
84
85     void removeAllIcons();
86     void checkIntegrityBeforeOpening();
87     void close();
88
89     void initializeIconDatabaseClient(const WKIconDatabaseClient*);
90
91 private:
92     WebIconDatabase(WebContext*);
93
94     // WebCore::IconDatabaseClient
95     virtual void didImportIconURLForPageURL(const String&);
96     virtual void didImportIconDataForPageURL(const String&);
97     virtual void didChangeIconForPageURL(const String&);
98     virtual void didRemoveAllIcons();
99     virtual void didFinishURLImport();
100
101     // CoreIPC::MessageReceiver
102     virtual void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&) OVERRIDE;
103     virtual void didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageDecoder&, OwnPtr<CoreIPC::MessageEncoder>&) OVERRIDE;
104
105     void notifyIconDataReadyForPageURL(const String&);
106
107     WebContext* m_webContext;
108     
109     OwnPtr<WebCore::IconDatabase> m_iconDatabaseImpl;
110     bool m_urlImportCompleted;
111     bool m_databaseCleanupDisabled;
112     HashMap<uint64_t, String> m_pendingLoadDecisionURLMap;
113
114     WebIconDatabaseClient m_iconDatabaseClient;
115 };
116
117 } // namespace WebKit
118
119 #endif // WebIconDatabase_h