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 WKIconDatabase_h
27#define WKIconDatabase_h
28
29#include <WebKit/WKBase.h>
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
35// IconDatabase Client.
36typedef void (*WKIconDatabaseDidChangeIconForPageURLCallback)(WKIconDatabaseRef iconDatabase, WKURLRef pageURL, const void* clientInfo);
37typedef void (*WKIconDatabaseDidRemoveAllIconsCallback)(WKIconDatabaseRef iconDatabase, const void* clientInfo);
38typedef void (*WKIconDatabaseIconDataReadyForPageURLCallback)(WKIconDatabaseRef iconDatabase, WKURLRef pageURL, const void* clientInfo);
39
40typedef struct WKIconDatabaseClientBase {
41    int                                                                 version;
42    const void *                                                        clientInfo;
43} WKIconDatabaseClientBase;
44
45typedef struct WKIconDatabaseClientV0 {
46    WKIconDatabaseClientBase                                            base;
47
48    // Version 0.
49    WKIconDatabaseDidChangeIconForPageURLCallback                       didChangeIconForPageURL;
50    WKIconDatabaseDidRemoveAllIconsCallback                             didRemoveAllIcons;
51} WKIconDatabaseClientV0;
52
53typedef struct WKIconDatabaseClientV1 {
54    WKIconDatabaseClientBase                                            base;
55
56    // Version 0.
57    WKIconDatabaseDidChangeIconForPageURLCallback                       didChangeIconForPageURL;
58    WKIconDatabaseDidRemoveAllIconsCallback                             didRemoveAllIcons;
59
60    // Version 1.
61    WKIconDatabaseIconDataReadyForPageURLCallback                       iconDataReadyForPageURL;
62} WKIconDatabaseClientV1;
63
64enum { kWKIconDatabaseClientCurrentVersion WK_ENUM_DEPRECATED("Use an explicit version number instead") = 1 };
65typedef struct WKIconDatabaseClient {
66    int                                                                 version;
67    const void *                                                        clientInfo;
68
69    // Version 0.
70    WKIconDatabaseDidChangeIconForPageURLCallback                       didChangeIconForPageURL;
71    WKIconDatabaseDidRemoveAllIconsCallback                             didRemoveAllIcons;
72
73    // Version 1.
74    WKIconDatabaseIconDataReadyForPageURLCallback                       iconDataReadyForPageURL;
75} WKIconDatabaseClient WK_DEPRECATED("Use an explicit versioned struct instead");
76
77WK_EXPORT WKTypeID WKIconDatabaseGetTypeID();
78
79WK_EXPORT void WKIconDatabaseSetIconDatabaseClient(WKIconDatabaseRef iconDatabase, const WKIconDatabaseClientBase* client);
80
81WK_EXPORT void WKIconDatabaseRetainIconForURL(WKIconDatabaseRef iconDatabase, WKURLRef pageURL);
82WK_EXPORT void WKIconDatabaseReleaseIconForURL(WKIconDatabaseRef iconDatabase, WKURLRef pageURL);
83WK_EXPORT void WKIconDatabaseSetIconDataForIconURL(WKIconDatabaseRef iconDatabase, WKDataRef iconData, WKURLRef iconURL);
84WK_EXPORT void WKIconDatabaseSetIconURLForPageURL(WKIconDatabaseRef iconDatabase, WKURLRef iconURL, WKURLRef pageURL);
85WK_EXPORT WKURLRef WKIconDatabaseCopyIconURLForPageURL(WKIconDatabaseRef iconDatabase, WKURLRef pageURL);
86WK_EXPORT WKDataRef WKIconDatabaseCopyIconDataForPageURL(WKIconDatabaseRef iconDatabase, WKURLRef pageURL);
87
88WK_EXPORT void WKIconDatabaseEnableDatabaseCleanup(WKIconDatabaseRef iconDatabase);
89
90WK_EXPORT void WKIconDatabaseRemoveAllIcons(WKIconDatabaseRef iconDatabase);
91WK_EXPORT void WKIconDatabaseCheckIntegrityBeforeOpening(WKIconDatabaseRef iconDatabase);
92
93WK_EXPORT void WKIconDatabaseClose(WKIconDatabaseRef iconDatabase);
94
95#ifdef __cplusplus
96}
97#endif
98
99#endif /* WKIconDatabase_h */
100