initial import
[vuplus_webkit] / Source / WebKit2 / UIProcess / API / C / WKContext.h
1 /*
2  * Copyright (C) 2010, 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 WKContext_h
27 #define WKContext_h
28
29 #include <WebKit2/WKBase.h>
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34
35 enum {
36     kWKCacheModelDocumentViewer = 0,
37     kWKCacheModelDocumentBrowser = 1,
38     kWKCacheModelPrimaryWebBrowser = 2
39 };
40 typedef uint32_t WKCacheModel;
41
42 // Injected Bundle Client
43 typedef void (*WKContextDidReceiveMessageFromInjectedBundleCallback)(WKContextRef page, WKStringRef messageName, WKTypeRef messageBody, const void *clientInfo);
44 typedef void (*WKContextDidReceiveSynchronousMessageFromInjectedBundleCallback)(WKContextRef page, WKStringRef messageName, WKTypeRef messageBody, WKTypeRef* returnData, const void *clientInfo);
45
46 struct WKContextInjectedBundleClient {
47     int                                                                 version;
48     const void *                                                        clientInfo;
49     WKContextDidReceiveMessageFromInjectedBundleCallback                didReceiveMessageFromInjectedBundle;
50     WKContextDidReceiveSynchronousMessageFromInjectedBundleCallback     didReceiveSynchronousMessageFromInjectedBundle;
51 };
52 typedef struct WKContextInjectedBundleClient WKContextInjectedBundleClient;
53
54 enum { kWKContextInjectedBundleClientCurrentVersion = 0 };
55
56 // History Client
57 typedef void (*WKContextDidNavigateWithNavigationDataCallback)(WKContextRef context, WKPageRef page, WKNavigationDataRef navigationData, WKFrameRef frame, const void *clientInfo);
58 typedef void (*WKContextDidPerformClientRedirectCallback)(WKContextRef context, WKPageRef page, WKURLRef sourceURL, WKURLRef destinationURL, WKFrameRef frame, const void *clientInfo);
59 typedef void (*WKContextDidPerformServerRedirectCallback)(WKContextRef context, WKPageRef page, WKURLRef sourceURL, WKURLRef destinationURL, WKFrameRef frame, const void *clientInfo);
60 typedef void (*WKContextDidUpdateHistoryTitleCallback)(WKContextRef context, WKPageRef page, WKStringRef title, WKURLRef URL, WKFrameRef frame, const void *clientInfo);
61 typedef void (*WKContextPopulateVisitedLinksCallback)(WKContextRef context, const void *clientInfo);
62
63 struct WKContextHistoryClient {
64     int                                                                 version;
65     const void *                                                        clientInfo;
66     WKContextDidNavigateWithNavigationDataCallback                      didNavigateWithNavigationData;
67     WKContextDidPerformClientRedirectCallback                           didPerformClientRedirect;
68     WKContextDidPerformServerRedirectCallback                           didPerformServerRedirect;
69     WKContextDidUpdateHistoryTitleCallback                              didUpdateHistoryTitle;
70     WKContextPopulateVisitedLinksCallback                               populateVisitedLinks;
71 };
72 typedef struct WKContextHistoryClient WKContextHistoryClient;
73
74 enum { kWKContextHistoryClientCurrentVersion = 0 };
75
76 // Download Client
77 typedef void (*WKContextDownloadDidStartCallback)(WKContextRef context, WKDownloadRef download, const void *clientInfo);
78 typedef void (*WKContextDownloadDidReceiveAuthenticationChallengeCallback)(WKContextRef context, WKDownloadRef download, WKAuthenticationChallengeRef authenticationChallenge, const void *clientInfo);
79 typedef void (*WKContextDownloadDidReceiveResponseCallback)(WKContextRef context, WKDownloadRef download, WKURLResponseRef response, const void *clientInfo);
80 typedef void (*WKContextDownloadDidReceiveDataCallback)(WKContextRef context, WKDownloadRef download, uint64_t length, const void *clientInfo);
81 typedef bool (*WKContextDownloadShouldDecodeSourceDataOfMIMETypeCallback)(WKContextRef context, WKDownloadRef download, WKStringRef mimeType, const void *clientInfo);
82 typedef WKStringRef (*WKContextDownloadDecideDestinationWithSuggestedFilenameCallback)(WKContextRef context, WKDownloadRef download, WKStringRef filename, bool* allowOverwrite, const void *clientInfo);
83 typedef void (*WKContextDownloadDidCreateDestinationCallback)(WKContextRef context, WKDownloadRef download, WKStringRef path, const void *clientInfo);
84 typedef void (*WKContextDownloadDidFinishCallback)(WKContextRef context, WKDownloadRef download, const void *clientInfo);
85 typedef void (*WKContextDownloadDidFailCallback)(WKContextRef context, WKDownloadRef download, WKErrorRef error, const void *clientInfo);
86 typedef void (*WKContextDownloadDidCancel)(WKContextRef context, WKDownloadRef download, const void *clientInfo);
87 typedef void (*WKContextDownloadProcessDidCrashCallback)(WKContextRef context, WKDownloadRef download, const void *clientInfo);
88
89 struct WKContextDownloadClient {
90     int                                                                 version;
91     const void *                                                        clientInfo;
92     WKContextDownloadDidStartCallback                                   didStart;
93     WKContextDownloadDidReceiveAuthenticationChallengeCallback          didReceiveAuthenticationChallenge;
94     WKContextDownloadDidReceiveResponseCallback                         didReceiveResponse;
95     WKContextDownloadDidReceiveDataCallback                             didReceiveData;
96     WKContextDownloadShouldDecodeSourceDataOfMIMETypeCallback           shouldDecodeSourceDataOfMIMEType;
97     WKContextDownloadDecideDestinationWithSuggestedFilenameCallback     decideDestinationWithSuggestedFilename;
98     WKContextDownloadDidCreateDestinationCallback                       didCreateDestination;
99     WKContextDownloadDidFinishCallback                                  didFinish;
100     WKContextDownloadDidFailCallback                                    didFail;
101     WKContextDownloadDidCancel                                          didCancel;
102     WKContextDownloadProcessDidCrashCallback                            processDidCrash;
103 };
104 typedef struct WKContextDownloadClient WKContextDownloadClient;
105
106 enum { kWKContextDownloadClientCurrentVersion = 0 };
107
108 WK_EXPORT WKTypeID WKContextGetTypeID();
109
110 WK_EXPORT WKContextRef WKContextCreate();
111 WK_EXPORT WKContextRef WKContextCreateWithInjectedBundlePath(WKStringRef path);
112 WK_EXPORT WKContextRef WKContextGetSharedProcessContext();
113
114 WK_EXPORT void WKContextSetInjectedBundleClient(WKContextRef context, const WKContextInjectedBundleClient* client);
115 WK_EXPORT void WKContextSetHistoryClient(WKContextRef context, const WKContextHistoryClient* client);
116 WK_EXPORT void WKContextSetDownloadClient(WKContextRef context, const WKContextDownloadClient* client);
117
118 WK_EXPORT WKDownloadRef WKContextDownloadURLRequest(WKContextRef context, const WKURLRequestRef request);
119
120 WK_EXPORT void WKContextSetInitializationUserDataForInjectedBundle(WKContextRef context, WKTypeRef userData);
121 WK_EXPORT void WKContextPostMessageToInjectedBundle(WKContextRef context, WKStringRef messageName, WKTypeRef messageBody);
122
123 WK_EXPORT void WKContextAddVisitedLink(WKContextRef context, WKStringRef visitedURL);
124
125 WK_EXPORT void WKContextSetCacheModel(WKContextRef context, WKCacheModel cacheModel);
126 WK_EXPORT WKCacheModel WKContextGetCacheModel(WKContextRef context);
127
128 WK_EXPORT void WKContextStartMemorySampler(WKContextRef context, WKDoubleRef interval);
129 WK_EXPORT void WKContextStopMemorySampler(WKContextRef context);
130
131 WK_EXPORT WKApplicationCacheManagerRef WKContextGetApplicationCacheManager(WKContextRef context);
132 WK_EXPORT WKCookieManagerRef WKContextGetCookieManager(WKContextRef context);
133 WK_EXPORT WKDatabaseManagerRef WKContextGetDatabaseManager(WKContextRef context);
134 WK_EXPORT WKGeolocationManagerRef WKContextGetGeolocationManager(WKContextRef context);
135 WK_EXPORT WKIconDatabaseRef WKContextGetIconDatabase(WKContextRef context);
136 WK_EXPORT WKKeyValueStorageManagerRef WKContextGetKeyValueStorageManager(WKContextRef context);
137 WK_EXPORT WKMediaCacheManagerRef WKContextGetMediaCacheManager(WKContextRef context);
138 WK_EXPORT WKPluginSiteDataManagerRef WKContextGetPluginSiteDataManager(WKContextRef context);
139 WK_EXPORT WKResourceCacheManagerRef WKContextGetResourceCacheManager(WKContextRef context);
140     
141 typedef void (*WKContextGetStatisticsFunction)(WKDictionaryRef statistics, WKErrorRef error, void* functionContext);
142 WK_EXPORT void WKContextGetStatistics(WKContextRef context, void* functionContext, WKContextGetStatisticsFunction function);
143     
144 WK_EXPORT void WKContextGarbageCollectJavaScriptObjects(WKContextRef context);
145
146 #ifdef __cplusplus
147 }
148 #endif
149
150 #endif /* WKContext_h */