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