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 "WebIconDatabaseClient.h"
  33 #include <WebCore/IconDatabaseClient.h>
  34 #include <WebCore/ImageSource.h>
  35 #include <WebCore/IntSize.h>
  36 #include <wtf/Forward.h>
  37 #include <wtf/PassRefPtr.h>
  38 #include <wtf/RefPtr.h>
  39 #include <wtf/Vector.h>
  40 #include <wtf/text/StringHash.h>
  41
  42 namespace CoreIPC {
  43 class ArgumentDecoder;
  44 class DataReference;
  45 class MessageID;
  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 APIObject, public WebCore::IconDatabaseClient {
  58 public:
  59     static const Type APIType = TypeIconDatabase;
  60
  61     static PassRefPtr<WebIconDatabase> create(WebContext*);
  62     virtual ~WebIconDatabase();
  63
  64     void invalidate();
  65     void clearContext() { m_webContext = 0; }
  66     void setDatabasePath(const String&);
  67     void enableDatabaseCleanup();
  68
  69     void retainIconForPageURL(const String&);
  70     void releaseIconForPageURL(const String&);
  71     void setIconURLForPageURL(const String&, const String&);
  72     void setIconDataForIconURL(const CoreIPC::DataReference&, const String&);
  73
  74     void synchronousIconDataForPageURL(const String&, CoreIPC::DataReference&);
  75     void synchronousIconURLForPageURL(const String&, String&);
  76     void synchronousIconDataKnownForIconURL(const String&, bool&) const;
  77     void synchronousLoadDecisionForIconURL(const String&, int&) const;
  78
  79     void getLoadDecisionForIconURL(const String&, uint64_t callbackID);
  80     void didReceiveIconForPageURL(const String&);
  81
  82     WebCore::Image* imageForPageURL(const String&, const WebCore::IntSize& iconSize = WebCore::IntSize(32, 32));
  83     WebCore::NativeImagePtr nativeImageForPageURL(const String&, const WebCore::IntSize& iconSize = WebCore::IntSize(32, 32));
  84     bool isOpen();
  85     bool isUrlImportCompleted();
  86
  87     void removeAllIcons();
  88     void checkIntegrityBeforeOpening();
  89     void close();
  90
  91     void initializeIconDatabaseClient(const WKIconDatabaseClient*);
  92
  93     // WebCore::IconDatabaseClient
  94     virtual bool performImport();
  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     void didReceiveMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
 102     void didReceiveSyncMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, OwnPtr<CoreIPC::ArgumentEncoder>&);
 103
 104 private:
 105     WebIconDatabase(WebContext*);
 106
 107     virtual Type type() const { return APIType; }
 108
 109     void didReceiveWebIconDatabaseMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*);
 110     void didReceiveSyncWebIconDatabaseMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, OwnPtr<CoreIPC::ArgumentEncoder>&);
 111     void notifyIconDataReadyForPageURL(const String&);
 112
 113     WebContext* m_webContext;
 114
 115     OwnPtr<WebCore::IconDatabase> m_iconDatabaseImpl;
 116     bool m_urlImportCompleted;
 117     bool m_databaseCleanupDisabled;
 118     HashMap<uint64_t, String> m_pendingLoadDecisionURLMap;
 119
 120     WebIconDatabaseClient m_iconDatabaseClient;
 121 };
 122
 123 } // namespace WebKit
 124
 125 #endif // WebIconDatabase_h