[WK2] [OS X] Create API for switching RTL scrollbar policy
[WebKit-https.git] / Source / WebCore / testing / InternalSettings.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013, 2014, 2015, 2016 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 // FIXME (121927): This include should not be needed.
30 #include <wtf/text/AtomicStringHash.h>
31
32 #include "EditingBehaviorTypes.h"
33 #include "FontGenericFamilies.h"
34 #include "IntSize.h"
35 #include "InternalSettingsGenerated.h"
36 #include "SecurityOrigin.h"
37 #include "Settings.h"
38 #include "WritingMode.h"
39
40 namespace WebCore {
41
42 typedef int ExceptionCode;
43
44 class Frame;
45 class Document;
46 class Page;
47 class Settings;
48
49 class InternalSettings : public InternalSettingsGenerated {
50 public:
51     class Backup {
52     public:
53         explicit Backup(Settings&);
54         void restoreTo(Settings&);
55
56         bool m_originalCSSShapesEnabled;
57         EditingBehaviorType m_originalEditingBehavior;
58
59         // Initially empty, only used if changed by a test.
60         ScriptFontFamilyMap m_standardFontFamilies;
61         ScriptFontFamilyMap m_fixedFontFamilies;
62         ScriptFontFamilyMap m_serifFontFamilies;
63         ScriptFontFamilyMap m_sansSerifFontFamilies;
64         ScriptFontFamilyMap m_cursiveFontFamilies;
65         ScriptFontFamilyMap m_fantasyFontFamilies;
66         ScriptFontFamilyMap m_pictographFontFamilies;
67
68 #if ENABLE(TEXT_AUTOSIZING)
69         bool m_originalTextAutosizingEnabled;
70         IntSize m_originalTextAutosizingWindowSizeOverride;
71         float m_originalTextAutosizingFontScaleFactor;
72 #endif
73         String m_originalMediaTypeOverride;
74         bool m_originalCanvasUsesAcceleratedDrawing;
75         bool m_originalMockScrollbarsEnabled;
76         bool m_originalUsesOverlayScrollbars;
77         bool m_langAttributeAwareFormControlUIEnabled;
78         bool m_imagesEnabled;
79         std::chrono::milliseconds m_minimumTimerInterval;
80 #if ENABLE(VIDEO_TRACK)
81         bool m_shouldDisplaySubtitles;
82         bool m_shouldDisplayCaptions;
83         bool m_shouldDisplayTextDescriptions;
84 #endif
85         String m_defaultVideoPosterURL;
86         bool m_forcePendingWebGLPolicy;
87         bool m_originalTimeWithoutMouseMovementBeforeHidingControls;
88         bool m_useLegacyBackgroundSizeShorthandBehavior;
89         bool m_autoscrollForDragAndDropEnabled;
90         bool m_pluginReplacementEnabled;
91         bool m_shouldConvertPositionStyleOnCopy;
92         bool m_fontFallbackPrefersPictographs;
93         bool m_backgroundShouldExtendBeyondPage;
94         SecurityOrigin::StorageBlockingPolicy m_storageBlockingPolicy;
95         bool m_scrollingTreeIncludesFrames;
96 #if ENABLE(TOUCH_EVENTS)
97         bool m_touchEventEmulationEnabled;
98 #endif
99 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
100         bool m_allowsAirPlayForMediaPlayback;
101 #endif
102         bool m_allowsInlineMediaPlayback;
103         bool m_inlineMediaPlaybackRequiresPlaysInlineAttribute;
104 #if ENABLE(INDEXED_DATABASE_IN_WORKERS)
105         bool m_indexedDBWorkersEnabled;
106 #endif
107         UserInterfaceDirectionPolicy m_userInterfaceDirectionPolicy;
108         TextDirection m_systemLayoutDirection;
109     };
110
111     static Ref<InternalSettings> create(Page* page)
112     {
113         return adoptRef(*new InternalSettings(page));
114     }
115     static InternalSettings* from(Page*);
116     void hostDestroyed() { m_page = 0; }
117
118     virtual ~InternalSettings();
119     void resetToConsistentState();
120
121     void setUsesOverlayScrollbars(bool, ExceptionCode&);
122     void setTouchEventEmulationEnabled(bool, ExceptionCode&);
123     void setStandardFontFamily(const String& family, const String& script, ExceptionCode&);
124     void setSerifFontFamily(const String& family, const String& script, ExceptionCode&);
125     void setSansSerifFontFamily(const String& family, const String& script, ExceptionCode&);
126     void setFixedFontFamily(const String& family, const String& script, ExceptionCode&);
127     void setCursiveFontFamily(const String& family, const String& script, ExceptionCode&);
128     void setFantasyFontFamily(const String& family, const String& script, ExceptionCode&);
129     void setPictographFontFamily(const String& family, const String& script, ExceptionCode&);
130     void setTextAutosizingEnabled(bool enabled, ExceptionCode&);
131     void setTextAutosizingWindowSizeOverride(int width, int height, ExceptionCode&);
132     void setTextAutosizingFontScaleFactor(float fontScaleFactor, ExceptionCode&);
133     void setMediaTypeOverride(const String& mediaType, ExceptionCode&);
134     void setCSSShapesEnabled(bool, ExceptionCode&);
135     void setCanStartMedia(bool, ExceptionCode&);
136     void setWirelessPlaybackDisabled(bool);
137     void setEditingBehavior(const String&, ExceptionCode&);
138     void setShouldDisplayTrackKind(const String& kind, bool enabled, ExceptionCode&);
139     bool shouldDisplayTrackKind(const String& kind, ExceptionCode&);
140     void setStorageBlockingPolicy(const String&, ExceptionCode&);
141     void setLangAttributeAwareFormControlUIEnabled(bool);
142     void setImagesEnabled(bool, ExceptionCode&);
143     void setMinimumTimerInterval(double intervalInSeconds, ExceptionCode&);
144     void setDefaultVideoPosterURL(const String& url, ExceptionCode&);
145     void setForcePendingWebGLPolicy(bool, ExceptionCode&);
146     void setTimeWithoutMouseMovementBeforeHidingControls(double time, ExceptionCode&);
147     void setUseLegacyBackgroundSizeShorthandBehavior(bool, ExceptionCode&);
148     void setAutoscrollForDragAndDropEnabled(bool, ExceptionCode&);
149     void setFontFallbackPrefersPictographs(bool, ExceptionCode&);
150     void setPluginReplacementEnabled(bool);
151     void setBackgroundShouldExtendBeyondPage(bool, ExceptionCode&);
152     void setShouldConvertPositionStyleOnCopy(bool, ExceptionCode&);
153     void setScrollingTreeIncludesFrames(bool, ExceptionCode&);
154     void setAllowsInlineMediaPlayback(bool, ExceptionCode&);
155     void setInlineMediaPlaybackRequiresPlaysInlineAttribute(bool, ExceptionCode&);
156     void setIndexedDBWorkersEnabled(bool, ExceptionCode&);
157     String userInterfaceDirectionPolicy(ExceptionCode&);
158     void setUserInterfaceDirectionPolicy(const String& policy, ExceptionCode&);
159     String systemLayoutDirection(ExceptionCode&);
160     void setSystemLayoutDirection(const String& direction, ExceptionCode&);
161
162 private:
163     explicit InternalSettings(Page*);
164
165     Settings* settings() const;
166     Page* page() const { return m_page; }
167     static const char* supplementName();
168
169     Page* m_page;
170     Backup m_backup;
171 };
172
173 } // namespace WebCore