Expose SPI to disable synchronously blocking on painting after parenting a WKWebView
[WebKit-https.git] / Source / WebKit2 / UIProcess / API / APIPageConfiguration.h
1 /*
2  * Copyright (C) 2015 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 APIPageConfiguration_h
27 #define APIPageConfiguration_h
28
29 #include "APIObject.h"
30 #include "WebPreferencesStore.h"
31 #include <WebCore/SessionID.h>
32 #include <wtf/GetPtr.h>
33
34 namespace WebKit {
35 class VisitedLinkStore;
36 class WebPageGroup;
37 class WebPageProxy;
38 class WebPreferences;
39 class WebProcessPool;
40 class WebUserContentControllerProxy;
41 }
42
43 namespace API {
44
45 class WebsiteDataStore;
46
47 class PageConfiguration : public ObjectImpl<Object::Type::PageConfiguration> {
48 public:
49     static Ref<PageConfiguration> create();
50
51     explicit PageConfiguration();
52     virtual ~PageConfiguration();
53
54     Ref<PageConfiguration> copy() const;
55
56     // FIXME: The configuration properties should return their default values
57     // rather than nullptr.
58     
59     WebKit::WebProcessPool* processPool();
60     void setProcessPool(WebKit::WebProcessPool*);
61
62     WebKit::WebUserContentControllerProxy* userContentController();
63     void setUserContentController(WebKit::WebUserContentControllerProxy*);
64
65     WebKit::WebPageGroup* pageGroup();
66     void setPageGroup(WebKit::WebPageGroup*);
67
68     WebKit::WebPreferences* preferences();
69     void setPreferences(WebKit::WebPreferences*);
70
71     WebKit::WebPreferencesStore::ValueMap& preferenceValues() { return m_preferenceValues; }
72
73     WebKit::WebPageProxy* relatedPage();
74     void setRelatedPage(WebKit::WebPageProxy*);
75
76     WebKit::VisitedLinkStore* visitedLinkStore();
77     void setVisitedLinkStore(WebKit::VisitedLinkStore*);
78
79     WebsiteDataStore* websiteDataStore();
80     void setWebsiteDataStore(WebsiteDataStore*);
81
82     WebCore::SessionID sessionID();
83     void setSessionID(WebCore::SessionID);
84
85     bool treatsSHA1SignedCertificatesAsInsecure() { return m_treatsSHA1SignedCertificatesAsInsecure; }
86     void setTreatsSHA1SignedCertificatesAsInsecure(bool treatsSHA1SignedCertificatesAsInsecure) { m_treatsSHA1SignedCertificatesAsInsecure = treatsSHA1SignedCertificatesAsInsecure; } 
87
88 #if PLATFORM(IOS)
89     bool alwaysRunsAtForegroundPriority() { return m_alwaysRunsAtForegroundPriority; }
90     void setAlwaysRunsAtForegroundPriority(bool alwaysRunsAtForegroundPriority) { m_alwaysRunsAtForegroundPriority = alwaysRunsAtForegroundPriority; } 
91 #endif
92     bool initialCapitalizationEnabled() { return m_initialCapitalizationEnabled; }
93     void setInitialCapitalizationEnabled(bool initialCapitalizationEnabled) { m_initialCapitalizationEnabled = initialCapitalizationEnabled; }
94
95     bool shouldWaitForPaintAfterViewDidMoveToWindow() const { return m_shouldWaitForPaintAfterViewDidMoveToWindow; }
96     void setShouldWaitForPaintAfterViewDidMoveToWindow(bool shouldSynchronize) { m_shouldWaitForPaintAfterViewDidMoveToWindow = shouldSynchronize; }
97
98 private:
99
100     RefPtr<WebKit::WebProcessPool> m_processPool;
101     RefPtr<WebKit::WebUserContentControllerProxy> m_userContentController;
102     RefPtr<WebKit::WebPageGroup> m_pageGroup;
103     RefPtr<WebKit::WebPreferences> m_preferences;
104     WebKit::WebPreferencesStore::ValueMap m_preferenceValues;
105     RefPtr<WebKit::WebPageProxy> m_relatedPage;
106     RefPtr<WebKit::VisitedLinkStore> m_visitedLinkStore;
107
108     RefPtr<WebsiteDataStore> m_websiteDataStore;
109     // FIXME: We currently have to pass the session ID separately here to support the legacy private browsing session.
110     // Once we get rid of it we should get rid of this configuration parameter as well.
111     WebCore::SessionID m_sessionID;
112
113     bool m_treatsSHA1SignedCertificatesAsInsecure = true;
114 #if PLATFORM(IOS)
115     bool m_alwaysRunsAtForegroundPriority = false;
116 #endif
117     bool m_initialCapitalizationEnabled = true;
118     bool m_shouldWaitForPaintAfterViewDidMoveToWindow = true;
119 };
120
121 } // namespace API
122
123
124 #endif // APIPageConfiguration_h