File: OverrideUserPreferencesPopover.js

package info (click to toggle)
webkit2gtk 2.48.3-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 429,620 kB
  • sloc: cpp: 3,696,936; javascript: 194,444; ansic: 169,997; python: 46,499; asm: 19,276; ruby: 18,528; perl: 16,602; xml: 4,650; yacc: 2,360; sh: 2,098; java: 1,993; lex: 1,327; pascal: 366; makefile: 295
file content (190 lines) | stat: -rw-r--r-- 10,042 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
/*
 * Copyright (C) 2022 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

WI.OverrideUserPreferencesPopover = class OverrideUserPreferencesPopover extends WI.SettingsPopover
{
    constructor(delegate)
    {
        super(delegate);

        this._defaultValueOptionElementsMap = new Map;
    }

    // Public

    show(targetElement)
    {
        super.show(targetElement);

        WI.cssManager.addEventListener(WI.CSSManager.Event.DefaultUserPreferencesDidChange, this._defaultUserPreferencesDidChange, this);
    }

    dismiss()
    {
        this._defaultValueOptionElementsMap.clear();

        WI.cssManager.removeEventListener(WI.CSSManager.Event.DefaultUserPreferencesDidChange, this._defaultUserPreferencesDidChange, this);

        super.dismiss();
    }

    // Protected

    createContentElement()
    {
        let contentElement = document.createElement("div");
        contentElement.classList.add("user-preferences-content");

        if (WI.cssManager.supportsOverrideColorScheme) {
            let appearanceHeader = contentElement.appendChild(document.createElement("h1"));
            appearanceHeader.textContent = WI.UIString("Appearance", "Appearance @ User Preferences Overrides", "Header for section with appearance user preferences.");
        }

        // COMPATIBILITY (macOS 13.0, iOS 16.0): `PrefersColorScheme` value for `Page.UserPreferenceName` did not exist yet.
        if (WI.cssManager.supportsOverrideColorScheme && InspectorBackend.Enum.Page?.UserPreferenceName?.PrefersColorScheme) {
            this._createSelectElement({
                contentElement,
                id: "override-prefers-color-scheme",
                label: WI.UIString("Color scheme", "Color scheme @ User Preferences Overrides", "Label for input to override the preference for color scheme."),
                preferenceName: InspectorBackend.Enum.Page.UserPreferenceName.PrefersColorScheme,
                preferenceValues: [InspectorBackend.Enum.Page.UserPreferenceValue.Light, InspectorBackend.Enum.Page.UserPreferenceValue.Dark],
                defaultValue: WI.CSSManager.UserPreferenceDefaultValue,
            });
        }

        // COMPATIBILITY (macOS 13, iOS 16.0): `Page.setForcedAppearance()` was removed in favor of `Page.overrideUserPreference()`
        if (WI.cssManager.supportsOverrideColorScheme && InspectorBackend.hasCommand("Page.setForcedAppearance")) {
            this._createSelectElement({
                contentElement,
                id: "override-prefers-color-scheme",
                label: WI.UIString("Color scheme", "Color scheme @ User Preferences Overrides", "Label for input to override the preference for color scheme."),
                preferenceName: WI.CSSManager.ForcedAppearancePreference,
                preferenceValues: [WI.CSSManager.Appearance.Light, WI.CSSManager.Appearance.Dark],
                defaultValue: WI.CSSManager.UserPreferenceDefaultValue,
            });
        }

        if (InspectorBackend.Enum.Page?.UserPreferenceName?.PrefersReducedMotion || InspectorBackend.Enum.Page?.UserPreferenceName?.PrefersContrast) {
            let accessibilityHeader = contentElement.appendChild(document.createElement("h1"));
            accessibilityHeader.textContent = WI.UIString("Accessibility", "Accessibility @ User Preferences Overrides", "Header for section with accessibility user preferences.");
        }

        // COMPATIBILITY (macOS 13.0, iOS 16.0): `PrefersReducedMotion` value for `Page.UserPreferenceName` did not exist yet.
        if (InspectorBackend.Enum.Page?.UserPreferenceName?.PrefersReducedMotion)
            this._createSelectElement({
                contentElement,
                id: "override-prefers-reduced-motion",
                label: WI.UIString("Reduce motion", "Reduce motion @ User Preferences Overrides", "Label for input to override the preference for reduced motion."),
                preferenceName: InspectorBackend.Enum.Page.UserPreferenceName.PrefersReducedMotion,
                preferenceValues: [InspectorBackend.Enum.Page.UserPreferenceValue.Reduce, InspectorBackend.Enum.Page.UserPreferenceValue.NoPreference],
                defaultValue: WI.CSSManager.UserPreferenceDefaultValue,
            });

        // COMPATIBILITY (macOS 13.0, iOS 16.0): `PrefersContrast` value for `Page.UserPreferenceName` did not exist yet.
        if (InspectorBackend.Enum.Page?.UserPreferenceName?.PrefersContrast)
            this._createSelectElement({
                contentElement,
                id: "override-prefers-contrast",
                label: WI.UIString("Increase contrast", "Increase contrast @ User Preferences Overrides", "Label for input to override the preference for high contrast."),
                preferenceName: InspectorBackend.Enum.Page.UserPreferenceName.PrefersContrast,
                preferenceValues: [InspectorBackend.Enum.Page.UserPreferenceValue.More, InspectorBackend.Enum.Page.UserPreferenceValue.NoPreference],
                defaultValue: WI.CSSManager.UserPreferenceDefaultValue,
            });

        return contentElement;
    }

    // Private

    _createSelectElement({contentElement, id, label, preferenceName, preferenceValues, defaultValue})
    {
        if (!preferenceName || !preferenceValues.length)
            return;

        let labelElement = contentElement.appendChild(document.createElement("label"));
        labelElement.textContent = label;
        labelElement.setAttribute("for", id);

        let selectElement = contentElement.appendChild(document.createElement("select"));
        selectElement.setAttribute("name", preferenceName);
        selectElement.setAttribute("id", id);

        let systemValue = WI.cssManager.defaultUserPreferences.get(preferenceName);

        for (let value of [defaultValue, ...preferenceValues]) {
            let optionElement = selectElement.appendChild(document.createElement("option"));
            optionElement.value = value;
            optionElement.textContent = this._userPreferenceValueLabel(value, systemValue);

            let selectedValue = WI.cssManager.overriddenUserPreferences.get(preferenceName) || defaultValue;
            if (value === selectedValue)
                optionElement.setAttribute("selected", true);

            if (value === defaultValue) {
                optionElement.after(document.createElement("hr"));
                this._defaultValueOptionElementsMap.set(preferenceName, optionElement);
            }
        }

        selectElement.addEventListener("change", (event) => {
            let value = event.target.value;
            if (value !== defaultValue)
                WI.cssManager.overrideUserPreference(preferenceName, value);
            else
                WI.cssManager.overrideUserPreference(preferenceName); // Pass no value to remove the override and restore the system default.
        });
    }

    _userPreferenceValueLabel(preferenceValue, systemValue)
    {
        switch (preferenceValue) {
        case WI.CSSManager.UserPreferenceDefaultValue:
            return WI.UIString("System (%s)", "System @ User Preferences Overrides", "Label for a preference that matches the default system value. The system value is shown in parentheses.").format(this._userPreferenceValueLabel(systemValue));
        case InspectorBackend.Enum.Page.UserPreferenceValue?.Reduce:
        case InspectorBackend.Enum.Page.UserPreferenceValue?.More:
            return WI.UIString("On", "On @ User Preferences Overrides", "Label for a preference that is turned on.");
        case InspectorBackend.Enum.Page.UserPreferenceValue?.NoPreference:
            return WI.UIString("Off", "Off @ User Preferences Overrides", "Label for a preference that is turned off.");
        case InspectorBackend.Enum.Page.UserPreferenceValue?.Light:
        case WI.CSSManager.Appearance.Light:
            return WI.UIString("Light", "Light @ User Preferences Overrides", "Label for the light color scheme preference.");
        case InspectorBackend.Enum.Page.UserPreferenceValue?.Dark:
        case WI.CSSManager.Appearance.Dark:
            return WI.UIString("Dark", "Dark @ User Preferences Overrides", "Label for the dark color scheme preference.");
        }

        console.assert(false, "Unknown user preference", preferenceValue);
        return "";
    }

    _defaultUserPreferencesDidChange()
    {
        for (let [preferenceName, systemValue] of WI.cssManager.defaultUserPreferences) {
            let defaultOptionElement = this._defaultValueOptionElementsMap.get(preferenceName);
            if (defaultOptionElement)
                defaultOptionElement.textContent = this._userPreferenceValueLabel(WI.CSSManager.UserPreferenceDefaultValue, systemValue);
        }
    }
};