Make it easer to add switches to MiniBrowser
[WebKit-https.git] / Tools / MiniBrowser / mac / SettingsController.m
1 /*
2  * Copyright (C) 2014 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 #import "SettingsController.h"
27
28 #import "AppDelegate.h"
29 #import "BrowserWindowController.h"
30
31 static NSString * const defaultURL = @"http://www.webkit.org/";
32 static NSString * const DefaultURLPreferenceKey = @"DefaultURL";
33
34 static NSString * const UseWebKit2ByDefaultPreferenceKey = @"UseWebKit2ByDefault";
35 static NSString * const LayerBordersVisiblePreferenceKey = @"LayerBordersVisible";
36 static NSString * const TiledScrollingIndicatorVisiblePreferenceKey = @"TiledScrollingIndicatorVisible";
37
38 static NSString * const UseTransparentWindowsPreferenceKey = @"UseTransparentWindows";
39 static NSString * const UsePaginatedModePreferenceKey = @"UsePaginatedMode";
40 static NSString * const EnableSubPixelCSSOMMetricsPreferenceKey = @"EnableSubPixelCSSOMMetrics";
41
42 // This default name intentionally overlaps with the key that WebKit2 checks when creating a view.
43 static NSString * const UseRemoteLayerTreeDrawingAreaPreferenceKey = @"WebKit2UseRemoteLayerTreeDrawingArea";
44
45 @implementation SettingsController
46
47 @synthesize menu=_menu;
48
49 + (instancetype)shared
50 {
51     static SettingsController *sharedSettingsController;
52     static dispatch_once_t onceToken;
53     dispatch_once(&onceToken, ^{
54         sharedSettingsController = [[super alloc] init];
55     });
56
57     return sharedSettingsController;
58 }
59
60 - (NSMenu *)menu
61 {
62     if (!_menu)
63         [self _populateMenu];
64
65     return _menu;
66 }
67
68 - (void)_addItemWithTitle:(NSString *)title action:(SEL)action indented:(BOOL)indented
69 {
70     NSMenuItem *item = [[NSMenuItem alloc] initWithTitle:title action:action keyEquivalent:@""];
71     [item setTarget:self];
72     if (indented)
73         [item setIndentationLevel:1];
74     [_menu addItem:item];
75     [item release];
76 }
77
78 - (void)_addHeaderWithTitle:(NSString *)title
79 {
80     [_menu addItem:[NSMenuItem separatorItem]];
81     [_menu addItem:[[[NSMenuItem alloc] initWithTitle:title action:nil keyEquivalent:@""] autorelease]];
82 }
83
84 - (void)_populateMenu
85 {
86     _menu = [[NSMenu alloc] initWithTitle:@"Settings"];
87
88     [self _addItemWithTitle:@"Use WebKit2 By Default" action:@selector(toggleUseWebKit2ByDefault:) indented:NO];
89
90     [_menu addItem:[NSMenuItem separatorItem]];
91
92     [self _addItemWithTitle:@"Use Transparent Windows" action:@selector(toggleUseTransparentWindows:) indented:NO];
93     [self _addItemWithTitle:@"Use Paginated Mode" action:@selector(toggleUsePaginatedMode:) indented:NO];
94     [self _addItemWithTitle:@"Show Layer Borders" action:@selector(toggleShowLayerBorders:) indented:NO];
95
96     [self _addHeaderWithTitle:@"WebKit2-only Settings"];
97     [self _addItemWithTitle:@"Show Tiled Scrolling Indicator" action:@selector(toggleShowTiledScrollingIndicator:) indented:YES];
98     [self _addItemWithTitle:@"Use UI-Side Compositing" action:@selector(toggleUseUISideCompositing:) indented:YES];
99
100     [self _addHeaderWithTitle:@"WebKit1-only Settings"];
101     [self _addItemWithTitle:@"Enable Subpixel CSSOM Metrics" action:@selector(toggleEnableSubPixelCSSOMMetrics:) indented:YES];
102 }
103
104 - (BOOL)validateMenuItem:(NSMenuItem *)menuItem
105 {
106     SEL action = [menuItem action];
107
108     if (action == @selector(toggleUseWebKit2ByDefault:))
109         [menuItem setState:[self useWebKit2ByDefault] ? NSOnState : NSOffState];
110     else if (action == @selector(toggleUseTransparentWindows:))
111         [menuItem setState:[self useTransparentWindows] ? NSOnState : NSOffState];
112     else if (action == @selector(toggleUsePaginatedMode:))
113         [menuItem setState:[self usePaginatedMode] ? NSOnState : NSOffState];
114     else if (action == @selector(toggleShowLayerBorders:))
115         [menuItem setState:[self layerBordersVisible] ? NSOnState : NSOffState];
116     else if (action == @selector(toggleShowTiledScrollingIndicator:))
117         [menuItem setState:[self tiledScrollingIndicatorVisible] ? NSOnState : NSOffState];
118     else if (action == @selector(toggleUseUISideCompositing:))
119         [menuItem setState:[self useUISideCompositing] ? NSOnState : NSOffState];
120     else if (action == @selector(toggleEnableSubPixelCSSOMMetrics:))
121         [menuItem setState:[self subPixelCSSOMMetricsEnabled] ? NSOnState : NSOffState];
122
123     return YES;
124 }
125
126 - (void)_toggleBooleanDefault:(NSString *)defaultName
127 {
128     NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
129     [defaults setBool:![defaults boolForKey:defaultName] forKey:defaultName];
130
131     [(BrowserAppDelegate *)[NSApp delegate] didChangeSettings];
132 }
133
134 - (void)toggleUseWebKit2ByDefault:(id)sender
135 {
136     [self _toggleBooleanDefault:UseWebKit2ByDefaultPreferenceKey];
137 }
138
139 - (BOOL)useWebKit2ByDefault
140 {
141     return [[NSUserDefaults standardUserDefaults] boolForKey:UseWebKit2ByDefaultPreferenceKey];
142 }
143
144 - (void)toggleUseTransparentWindows:(id)sender
145 {
146     [self _toggleBooleanDefault:UseTransparentWindowsPreferenceKey];
147 }
148
149 - (BOOL)useTransparentWindows
150 {
151     return [[NSUserDefaults standardUserDefaults] boolForKey:UseTransparentWindowsPreferenceKey];
152 }
153
154 - (void)toggleUsePaginatedMode:(id)sender
155 {
156     [self _toggleBooleanDefault:UsePaginatedModePreferenceKey];
157 }
158
159 - (BOOL)usePaginatedMode
160 {
161     return [[NSUserDefaults standardUserDefaults] boolForKey:UsePaginatedModePreferenceKey];
162 }
163
164 - (void)toggleUseUISideCompositing:(id)sender
165 {
166     [self _toggleBooleanDefault:UseRemoteLayerTreeDrawingAreaPreferenceKey];
167 }
168
169 - (BOOL)useUISideCompositing
170 {
171     return [[NSUserDefaults standardUserDefaults] boolForKey:UseRemoteLayerTreeDrawingAreaPreferenceKey];
172 }
173
174 - (void)toggleShowLayerBorders:(id)sender
175 {
176     [self _toggleBooleanDefault:LayerBordersVisiblePreferenceKey];
177 }
178
179 - (BOOL)layerBordersVisible
180 {
181     return [[NSUserDefaults standardUserDefaults] boolForKey:LayerBordersVisiblePreferenceKey];
182 }
183
184 - (void)toggleShowTiledScrollingIndicator:(id)sender
185 {
186     [self _toggleBooleanDefault:TiledScrollingIndicatorVisiblePreferenceKey];
187 }
188
189 - (BOOL)tiledScrollingIndicatorVisible
190 {
191     return [[NSUserDefaults standardUserDefaults] boolForKey:TiledScrollingIndicatorVisiblePreferenceKey];
192 }
193
194 - (void)toggleEnableSubPixelCSSOMMetrics:(id)sender
195 {
196     [self _toggleBooleanDefault:EnableSubPixelCSSOMMetricsPreferenceKey];
197 }
198
199 - (BOOL)subPixelCSSOMMetricsEnabled
200 {
201     return [[NSUserDefaults standardUserDefaults] boolForKey:EnableSubPixelCSSOMMetricsPreferenceKey];
202 }
203
204 - (NSString *)defaultURL
205 {
206     NSString *customDefaultURL = [[NSUserDefaults standardUserDefaults] stringForKey:DefaultURLPreferenceKey];
207     if (customDefaultURL)
208         return customDefaultURL;
209     return defaultURL;
210 }
211
212 @end