Add runtime and compile time flags for enabling Web Animations API and model.
[WebKit-https.git] / Source / WebKit2 / WebProcess / InjectedBundle / InjectedBundle.h
1 /*
2  * Copyright (C) 2010 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 InjectedBundle_h
27 #define InjectedBundle_h
28
29 #include "APIObject.h"
30 #include "InjectedBundleClient.h"
31 #include "SandboxExtension.h"
32 #include "WKBundle.h"
33 #include <WebCore/UserContentTypes.h>
34 #include <WebCore/UserScriptTypes.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RetainPtr.h>
37 #include <wtf/text/WTFString.h>
38
39 #if PLATFORM(GTK)
40 typedef struct _GModule GModule;
41 #endif
42
43 #if PLATFORM(EFL)
44 #include <Eina.h>
45 #endif
46
47 #if USE(FOUNDATION)
48 OBJC_CLASS NSBundle;
49 OBJC_CLASS NSMutableDictionary;
50 OBJC_CLASS WKWebProcessBundleParameters;
51 #endif
52
53 namespace API {
54 class Array;
55 class Data;
56 }
57
58 namespace IPC {
59 class ArgumentDecoder;
60 class Connection;
61 class DataReference;
62 }
63
64 namespace WebKit {
65
66 #if USE(FOUNDATION)
67 typedef NSBundle *PlatformBundle;
68 #elif PLATFORM(GTK)
69 typedef ::GModule* PlatformBundle;
70 #elif PLATFORM(EFL)
71 typedef Eina_Module* PlatformBundle;
72 #endif
73
74 class InjectedBundleScriptWorld;
75 class WebCertificateInfo;
76 class WebConnection;
77 class WebFrame;
78 class WebPage;
79 class WebPageGroupProxy;
80 struct WebProcessCreationParameters;
81
82 class InjectedBundle : public API::ObjectImpl<API::Object::Type::Bundle> {
83 public:
84     static PassRefPtr<InjectedBundle> create(const WebProcessCreationParameters&, API::Object* initializationUserData);
85
86     ~InjectedBundle();
87
88     bool initialize(const WebProcessCreationParameters&, API::Object* initializationUserData);
89
90     void setBundleParameter(const String&, const IPC::DataReference&);
91     void setBundleParameters(const IPC::DataReference&);
92
93     // API
94     void initializeClient(const WKBundleClientBase*);
95     void postMessage(const String&, API::Object*);
96     void postSynchronousMessage(const String&, API::Object*, RefPtr<API::Object>& returnData);
97
98     WebConnection* webConnectionToUIProcess() const;
99
100     // TestRunner only SPI
101     void overrideBoolPreferenceForTestRunner(WebPageGroupProxy*, const String& preference, bool enabled);
102     void overrideXSSAuditorEnabledForTestRunner(WebPageGroupProxy* pageGroup, bool enabled);
103     void setAllowUniversalAccessFromFileURLs(WebPageGroupProxy*, bool);
104     void setAllowFileAccessFromFileURLs(WebPageGroupProxy*, bool);
105     void setMinimumLogicalFontSize(WebPageGroupProxy*, int size);
106     void setFrameFlatteningEnabled(WebPageGroupProxy*, bool);
107     void setPluginsEnabled(WebPageGroupProxy*, bool);
108     void setJavaScriptCanAccessClipboard(WebPageGroupProxy*, bool);
109     void setPrivateBrowsingEnabled(WebPageGroupProxy*, bool);
110     void setPopupBlockingEnabled(WebPageGroupProxy*, bool);
111     void setAuthorAndUserStylesEnabled(WebPageGroupProxy*, bool);
112     void setSpatialNavigationEnabled(WebPageGroupProxy*, bool);
113     void addOriginAccessWhitelistEntry(const String&, const String&, const String&, bool);
114     void removeOriginAccessWhitelistEntry(const String&, const String&, const String&, bool);
115     void resetOriginAccessWhitelists();
116     void setAsynchronousSpellCheckingEnabled(WebPageGroupProxy*, bool);
117     int numberOfPages(WebFrame*, double, double);
118     int pageNumberForElementById(WebFrame*, const String&, double, double);
119     String pageSizeAndMarginsInPixels(WebFrame*, int, int, int, int, int, int, int);
120     bool isPageBoxVisible(WebFrame*, int);
121     void setUserStyleSheetLocation(WebPageGroupProxy*, const String&);
122     void setWebNotificationPermission(WebPage*, const String& originString, bool allowed);
123     void removeAllWebNotificationPermissions(WebPage*);
124     uint64_t webNotificationID(JSContextRef, JSValueRef);
125     PassRefPtr<API::Data> createWebDataFromUint8Array(JSContextRef, JSValueRef);
126
127     // UserContent API
128     void addUserScript(WebPageGroupProxy*, InjectedBundleScriptWorld*, const String& source, const String& url, API::Array* whitelist, API::Array* blacklist, WebCore::UserScriptInjectionTime, WebCore::UserContentInjectedFrames);
129     void addUserStyleSheet(WebPageGroupProxy*, InjectedBundleScriptWorld*, const String& source, const String& url, API::Array* whitelist, API::Array* blacklist, WebCore::UserContentInjectedFrames);
130     void removeUserScript(WebPageGroupProxy*, InjectedBundleScriptWorld*, const String& url);
131     void removeUserStyleSheet(WebPageGroupProxy*, InjectedBundleScriptWorld*, const String& url);
132     void removeUserScripts(WebPageGroupProxy*, InjectedBundleScriptWorld*);
133     void removeUserStyleSheets(WebPageGroupProxy*, InjectedBundleScriptWorld*);
134     void removeAllUserContent(WebPageGroupProxy*);
135
136     // Local storage API
137     void clearAllDatabases();
138     void setDatabaseQuota(uint64_t);
139
140     // Garbage collection API
141     void garbageCollectJavaScriptObjects();
142     void garbageCollectJavaScriptObjectsOnAlternateThreadForDebugging(bool waitUntilDone);
143     size_t javaScriptObjectsCount();
144
145     // Callback hooks
146     void didCreatePage(WebPage*);
147     void willDestroyPage(WebPage*);
148     void didInitializePageGroup(WebPageGroupProxy*);
149     void didReceiveMessage(const String&, API::Object*);
150     void didReceiveMessageToPage(WebPage*, const String&, API::Object*);
151
152     static void reportException(JSContextRef, JSValueRef exception);
153
154     static bool isProcessingUserGesture();
155
156     void setTabKeyCyclesThroughElements(WebPage*, bool enabled);
157     void setSerialLoadingEnabled(bool);
158     void setCSSAnimationTriggersEnabled(bool);
159     void setWebAnimationsEnabled(bool);
160     void setCSSRegionsEnabled(bool);
161     void setCSSCompositingEnabled(bool);
162     void dispatchPendingLoadRequests();
163
164 #if PLATFORM(COCOA) && WK_API_ENABLED
165     WKWebProcessBundleParameters *bundleParameters();
166 #endif
167
168 private:
169     explicit InjectedBundle(const WebProcessCreationParameters&);
170
171     String m_path;
172     PlatformBundle m_platformBundle; // This is leaked right now, since we never unload the bundle/module.
173
174     RefPtr<SandboxExtension> m_sandboxExtension;
175
176     InjectedBundleClient m_client;
177
178 #if PLATFORM(COCOA) && WK_API_ENABLED
179     RetainPtr<WKWebProcessBundleParameters> m_bundleParameters;
180 #endif
181 };
182
183 } // namespace WebKit
184
185 #endif // InjectedBundle_h