servo_config/
prefs.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use std::env::consts::ARCH;
6use std::sync::{RwLock, RwLockReadGuard};
7use std::time::Duration;
8
9use serde::{Deserialize, Serialize};
10use servo_config_macro::ServoPreferences;
11
12pub use crate::pref_util::PrefValue;
13
14static PREFERENCES: RwLock<Preferences> = RwLock::new(Preferences::const_default());
15
16pub trait PreferencesObserver: Send + Sync {
17    fn prefs_changed(&self, _changes: &[(&'static str, PrefValue)]) {}
18}
19
20static OBSERVERS: RwLock<Vec<Box<dyn PreferencesObserver>>> = RwLock::new(Vec::new());
21
22#[inline]
23/// Get the current set of global preferences for Servo.
24pub fn get() -> RwLockReadGuard<'static, Preferences> {
25    PREFERENCES.read().unwrap()
26}
27
28pub fn add_observer(observer: Box<dyn PreferencesObserver>) {
29    OBSERVERS.write().unwrap().push(observer);
30}
31
32pub fn set(preferences: Preferences) {
33    // Map between Stylo preference names and Servo preference names as the This should be
34    // kept in sync with components/script/dom/bindings/codegen/run.py which generates the
35    // DOM CSS style accessors.
36    stylo_static_prefs::set_pref!("layout.unimplemented", preferences.layout_unimplemented);
37    stylo_static_prefs::set_pref!("layout.threads", preferences.layout_threads as i32);
38    stylo_static_prefs::set_pref!("layout.columns.enabled", preferences.layout_columns_enabled);
39    stylo_static_prefs::set_pref!("layout.grid.enabled", preferences.layout_grid_enabled);
40    stylo_static_prefs::set_pref!(
41        "layout.css.attr.enabled",
42        preferences.layout_css_attr_enabled
43    );
44    stylo_static_prefs::set_pref!(
45        "layout.writing-mode.enabled",
46        preferences.layout_writing_mode_enabled
47    );
48    stylo_static_prefs::set_pref!(
49        "layout.container-queries.enabled",
50        preferences.layout_container_queries_enabled
51    );
52    stylo_static_prefs::set_pref!(
53        "layout.variable_fonts.enabled",
54        preferences.layout_variable_fonts_enabled
55    );
56
57    let changed = preferences.diff(&PREFERENCES.read().unwrap());
58
59    *PREFERENCES.write().unwrap() = preferences;
60
61    for observer in &*OBSERVERS.read().unwrap() {
62        observer.prefs_changed(&changed);
63    }
64}
65
66/// A convenience macro for accessing a preference value using its static path.
67/// Passing an invalid path is a compile-time error.
68#[macro_export]
69macro_rules! pref {
70    ($name: ident) => {
71        $crate::prefs::get().$name.clone()
72    };
73}
74
75#[derive(Clone, Deserialize, Serialize, ServoPreferences)]
76pub struct Preferences {
77    pub fonts_default: String,
78    pub fonts_serif: String,
79    pub fonts_sans_serif: String,
80    pub fonts_monospace: String,
81    pub fonts_default_size: i64,
82    pub fonts_default_monospace_size: i64,
83    /// The amount of time that a half cycle of a text caret blink takes in milliseconds.
84    /// If this value is less than or equal to zero, then caret blink is disabled.
85    pub editing_caret_blink_time: i64,
86    pub css_animations_testing_enabled: bool,
87    /// Start the devtools server at startup
88    pub devtools_server_enabled: bool,
89    /// The address:port the devtools server listens to, default to 127.0.0.1:7000.
90    pub devtools_server_listen_address: String,
91    // feature: WebGPU | #24706 | Web/API/WebGPU_API
92    pub dom_webgpu_enabled: bool,
93    /// List of comma-separated backends to be used by wgpu.
94    pub dom_webgpu_wgpu_backend: String,
95    // feature: AbortController | #34866 | Web/API/AbortController
96    pub dom_abort_controller_enabled: bool,
97    // feature: Adopted Stylesheet | #38132 | Web/API/Document/adoptedStyleSheets
98    pub dom_adoptedstylesheet_enabled: bool,
99    pub dom_allow_preloading_module_descendants: bool,
100    // feature: Clipboard API | #36084 | Web/API/Clipboard_API
101    pub dom_async_clipboard_enabled: bool,
102    pub dom_bluetooth_enabled: bool,
103    pub dom_bluetooth_testing_enabled: bool,
104    pub dom_allow_scripts_to_close_windows: bool,
105    // feature: Media Capture and Streams API | #26861 | Web/API/Media_Capture_and_Streams_API
106    pub dom_canvas_capture_enabled: bool,
107    pub dom_canvas_text_enabled: bool,
108    /// Selects canvas backend
109    ///
110    /// Available values:
111    /// - ` `/`auto`
112    /// - vello
113    /// - vello_cpu
114    pub dom_canvas_backend: String,
115    pub dom_clipboardevent_enabled: bool,
116    pub dom_composition_event_enabled: bool,
117    // feature: CookieStore | #37674 | Web/API/CookieStore
118    pub dom_cookiestore_enabled: bool,
119    // feature: Credential Management API | #38788 | Web/API/Credential_Management_API
120    pub dom_credential_management_enabled: bool,
121    // feature: WebCrypto API | #40687 | Web/API/Web_Crypto_API
122    pub dom_crypto_subtle_enabled: bool,
123    pub dom_document_dblclick_timeout: i64,
124    pub dom_document_dblclick_dist: i64,
125    // feature: Document.execCommand | #25005 | Web/API/Document/execCommand
126    pub dom_exec_command_enabled: bool,
127    // feature: CSS Font Loading API | #29376 | Web/API/CSS_Font_Loading_API
128    pub dom_fontface_enabled: bool,
129    pub dom_fullscreen_test: bool,
130    // feature: Gamepad API | #10977 | Web/API/Gamepad_API
131    pub dom_gamepad_enabled: bool,
132    // feature: Geolocation API | #38903 | Web/API/Geolocation_API
133    pub dom_geolocation_enabled: bool,
134    // feature: IndexedDB | #6963 | Web/API/IndexedDB_API
135    pub dom_indexeddb_enabled: bool,
136    // feature: IntersectionObserver | #35767 | Web/API/Intersection_Observer_API
137    pub dom_intersection_observer_enabled: bool,
138    pub dom_microdata_testing_enabled: bool,
139    pub dom_uievent_which_enabled: bool,
140    // feature: MutationObserver | #6633 | Web/API/MutationObserver
141    pub dom_mutation_observer_enabled: bool,
142    // feature: Navigator.registerProtocolHandler() | #40615 | Web/API/Navigator/registerProtocolHandler
143    pub dom_navigator_protocol_handlers_enabled: bool,
144    // feature: Notification API | #34841 | Web/API/Notifications_API
145    pub dom_notification_enabled: bool,
146    // feature: OffscreenCanvas | #34111 | Web/API/OffscreenCanvas
147    pub dom_offscreen_canvas_enabled: bool,
148    pub dom_parallel_css_parsing_enabled: bool,
149    // feature: Permissions API | #31235 | Web/API/Permissions_API
150    pub dom_permissions_enabled: bool,
151    pub dom_permissions_testing_allowed_in_nonsecure_contexts: bool,
152    // feature: ResizeObserver | #39790 | Web/API/ResizeObserver
153    pub dom_resize_observer_enabled: bool,
154    pub dom_script_asynch: bool,
155    // feature: ServiceWorker | #36538 | Web/API/Service_Worker_API
156    pub dom_serviceworker_enabled: bool,
157    pub dom_serviceworker_timeout_seconds: i64,
158    pub dom_servo_helpers_enabled: bool,
159    pub dom_servoparser_async_html_tokenizer_enabled: bool,
160    pub dom_testbinding_enabled: bool,
161    pub dom_testbinding_prefcontrolled_enabled: bool,
162    pub dom_testbinding_prefcontrolled2_enabled: bool,
163    pub dom_testbinding_preference_value_falsy: bool,
164    pub dom_testbinding_preference_value_quote_string_test: String,
165    pub dom_testbinding_preference_value_space_string_test: String,
166    pub dom_testbinding_preference_value_string_empty: String,
167    pub dom_testbinding_preference_value_string_test: String,
168    pub dom_testbinding_preference_value_truthy: bool,
169    pub dom_testing_element_activation_enabled: bool,
170    pub dom_testing_html_input_element_select_files_enabled: bool,
171    pub dom_testperf_enabled: bool,
172    // https://testutils.spec.whatwg.org#availability
173    pub dom_testutils_enabled: bool,
174    /// <https://html.spec.whatwg.org/multipage/#transient-activation-duration>
175    pub dom_transient_activation_duration_ms: i64,
176    /// Enable WebGL2 APIs.
177    // feature: WebGL2 | #41394 | Web/API/WebGL2RenderingContext
178    pub dom_webgl2_enabled: bool,
179    // feature: WebRTC | #41396 | Web/API/WebRTC_API
180    pub dom_webrtc_enabled: bool,
181    // feature: WebRTC Transceiver | #41396 | Web/API/RTCRtpTransceiver
182    pub dom_webrtc_transceiver_enabled: bool,
183    // feature: WebVTT | #22312 | Web/API/WebVTT_API
184    pub dom_webvtt_enabled: bool,
185    pub dom_webxr_enabled: bool,
186    pub dom_webxr_test: bool,
187    pub dom_webxr_first_person_observer_view: bool,
188    pub dom_webxr_glwindow_enabled: bool,
189    pub dom_webxr_glwindow_left_right: bool,
190    pub dom_webxr_glwindow_red_cyan: bool,
191    pub dom_webxr_glwindow_spherical: bool,
192    pub dom_webxr_glwindow_cubemap: bool,
193    pub dom_webxr_hands_enabled: bool,
194    // feature: WebXR Layers | #27468 | Web/API/XRCompositionLayer
195    pub dom_webxr_layers_enabled: bool,
196    pub dom_webxr_openxr_enabled: bool,
197    pub dom_webxr_sessionavailable: bool,
198    pub dom_webxr_unsafe_assume_user_intent: bool,
199    pub dom_worklet_enabled: bool,
200    pub dom_worklet_blockingsleep_enabled: bool,
201    pub dom_worklet_testing_enabled: bool,
202    pub dom_worklet_timeout_ms: i64,
203    /// <https://drafts.csswg.org/cssom-view/#the-visualviewport-interface>
204    // feature: VisualViewport | #41341 | Web/API/VisualViewport
205    pub dom_visual_viewport_enabled: bool,
206    /// True to compile all WebRender shaders when Servo initializes. This is mostly
207    /// useful when modifying the shaders, to ensure they all compile after each change is
208    /// made.
209    pub gfx_precache_shaders: bool,
210    /// Whether or not antialiasing is enabled for text rendering.
211    pub gfx_text_antialiasing_enabled: bool,
212    /// Whether or not subpixel antialiasing is enabled for text rendering.
213    pub gfx_subpixel_text_antialiasing_enabled: bool,
214    pub gfx_texture_swizzling_enabled: bool,
215    /// The amount of image keys we request per batch for the image cache.
216    pub image_key_batch_size: i64,
217    /// Whether or not the DOM inspector should show shadow roots of user-agent shadow trees
218    pub inspector_show_servo_internal_shadow_roots: bool,
219    /// A locale tag (eg. es-ES) to use for language negotiation instead of the system locale.
220    /// An empty string represents no override.
221    /// TODO: Option<> support in PrefValue
222    pub intl_locale_override: String,
223    pub js_asmjs_enabled: bool,
224    pub js_baseline_interpreter_enabled: bool,
225    /// Whether to disable the jit within SpiderMonkey
226    pub js_disable_jit: bool,
227    pub js_baseline_jit_enabled: bool,
228    pub js_baseline_jit_unsafe_eager_compilation_enabled: bool,
229    pub js_ion_enabled: bool,
230    pub js_ion_unsafe_eager_compilation_enabled: bool,
231    pub js_mem_gc_compacting_enabled: bool,
232    pub js_mem_gc_empty_chunk_count_min: i64,
233    pub js_mem_gc_high_frequency_heap_growth_max: i64,
234    pub js_mem_gc_high_frequency_heap_growth_min: i64,
235    pub js_mem_gc_high_frequency_high_limit_mb: i64,
236    pub js_mem_gc_high_frequency_low_limit_mb: i64,
237    pub js_mem_gc_high_frequency_time_limit_ms: i64,
238    pub js_mem_gc_incremental_enabled: bool,
239    pub js_mem_gc_incremental_slice_ms: i64,
240    pub js_mem_gc_low_frequency_heap_growth: i64,
241    pub js_mem_gc_per_zone_enabled: bool,
242    pub js_mem_gc_zeal_frequency: i64,
243    pub js_mem_gc_zeal_level: i64,
244    pub js_mem_max: i64,
245    pub js_native_regex_enabled: bool,
246    pub js_offthread_compilation_enabled: bool,
247    pub js_timers_minimum_duration: i64,
248    pub js_wasm_baseline_enabled: bool,
249    pub js_wasm_enabled: bool,
250    pub js_wasm_ion_enabled: bool,
251    // feature: Largest Contentful Paint | #42000 | Web/API/LargestContentfulPaint
252    pub largest_contentful_paint_enabled: bool,
253    pub layout_animations_test_enabled: bool,
254    // feature: CSS Multicol | #22397 | Web/CSS/Guides/Multicol_layout
255    pub layout_columns_enabled: bool,
256    // feature: CSS Grid | #34479 | Web/CSS/Guides/Grid_layout
257    pub layout_grid_enabled: bool,
258    pub layout_container_queries_enabled: bool,
259    pub layout_css_attr_enabled: bool,
260    pub layout_style_sharing_cache_enabled: bool,
261    pub layout_threads: i64,
262    pub layout_unimplemented: bool,
263    // feature: Variable fonts | #38800 | Web/CSS/Guides/Fonts/Variable_fonts
264    pub layout_variable_fonts_enabled: bool,
265    // feature: CSS writing modes | #2560 | Web/CSS/Guides/Writing_modes
266    pub layout_writing_mode_enabled: bool,
267    /// Enable hardware acceleration for video playback.
268    pub media_glvideo_enabled: bool,
269    /// Enable a non-standard event handler for verifying behavior of media elements during tests.
270    pub media_testing_enabled: bool,
271    /// The default timeout set for establishing a network connection in seconds. This amount
272    /// if for the entire process of connecting to an address. For instance, if a particular host is
273    /// associated with multiple IP addresses, this timeout will be divided equally among
274    /// each IP address.
275    pub network_connection_timeout: u64,
276    pub network_enforce_tls_enabled: bool,
277    pub network_enforce_tls_localhost: bool,
278    pub network_enforce_tls_onion: bool,
279    pub network_http_cache_disabled: bool,
280    /// A url for a http proxy. We treat an empty string as no proxy.
281    pub network_http_proxy_uri: String,
282    /// A url for a https proxy. We treat an empty string as no proxy.
283    pub network_https_proxy_uri: String,
284    /// The domains for which we will not have a proxy. No effect if `network_http_proxy_uri` is not set.
285    /// The exact behavior is given by
286    /// <https://docs.rs/hyper-util/latest/hyper_util/client/proxy/matcher/struct.Builder.html#method.no>
287    pub network_http_no_proxy: String,
288    /// The weight of the http memory cache
289    /// Notice that this is not equal to the number of different urls in the cache.
290    pub network_http_cache_size: u64,
291    pub network_local_directory_listing_enabled: bool,
292    /// Force the use of `rust-webpki` verification for CA roots. If this is false (the
293    /// default), then `rustls-platform-verifier` will be used, except on Android where
294    /// `rust-webpki` is always used.
295    pub network_use_webpki_roots: bool,
296    /// The length of the session history, in navigations, for each `WebView. Back-forward
297    /// cache entries that are more than `session_history_max_length` steps in the future or
298    /// `session_history_max_length` steps in the past will be discarded. Navigating forward
299    /// or backward to that entry will cause the entire page to be reloaded.
300    pub session_history_max_length: i64,
301    /// The background color of shell's viewport. This will be used by OpenGL's `glClearColor`.
302    pub shell_background_color_rgba: [f64; 4],
303    pub webgl_testing_context_creation_error: bool,
304    /// Number of workers per threadpool, if we fail to detect how much
305    /// parallelism is available at runtime.
306    pub threadpools_fallback_worker_num: i64,
307    /// Maximum number of workers for the Image Cache thread pool
308    pub threadpools_image_cache_workers_max: i64,
309    /// Maximum number of workers for the IndexedDB thread pool
310    pub threadpools_indexeddb_workers_max: i64,
311    /// Maximum number of workers for the Web Storage thread pool
312    pub threadpools_webstorage_workers_max: i64,
313    /// Maximum number of workers for the Networking async runtime thread pool
314    pub threadpools_async_runtime_workers_max: i64,
315    /// Maximum number of workers for webrender
316    pub threadpools_webrender_workers_max: i64,
317    /// The user-agent to use for Servo. This can also be set via [`UserAgentPlatform`] in
318    /// order to set the value to the default value for the given platform.
319    pub user_agent: String,
320    /// Whether or not the viewport meta tag is enabled.
321    pub viewport_meta_enabled: bool,
322    pub log_filter: String,
323    /// Whether the accessibility code is enabled.
324    pub accessibility_enabled: bool,
325}
326
327impl Preferences {
328    const fn const_default() -> Self {
329        Self {
330            css_animations_testing_enabled: false,
331            editing_caret_blink_time: 600,
332            devtools_server_enabled: false,
333            devtools_server_listen_address: String::new(),
334            dom_abort_controller_enabled: true,
335            dom_adoptedstylesheet_enabled: false,
336            dom_allow_preloading_module_descendants: false,
337            dom_allow_scripts_to_close_windows: false,
338            dom_async_clipboard_enabled: false,
339            dom_bluetooth_enabled: false,
340            dom_bluetooth_testing_enabled: false,
341            dom_canvas_capture_enabled: false,
342            dom_canvas_text_enabled: true,
343            dom_canvas_backend: String::new(),
344            dom_clipboardevent_enabled: true,
345            dom_composition_event_enabled: false,
346            dom_cookiestore_enabled: false,
347            dom_credential_management_enabled: false,
348            dom_crypto_subtle_enabled: true,
349            dom_document_dblclick_dist: 1,
350            dom_document_dblclick_timeout: 300,
351            dom_exec_command_enabled: false,
352            dom_fontface_enabled: false,
353            dom_fullscreen_test: false,
354            dom_gamepad_enabled: true,
355            dom_geolocation_enabled: false,
356            dom_indexeddb_enabled: false,
357            dom_intersection_observer_enabled: false,
358            dom_microdata_testing_enabled: false,
359            dom_uievent_which_enabled: true,
360            dom_mutation_observer_enabled: true,
361            dom_navigator_protocol_handlers_enabled: false,
362            dom_notification_enabled: false,
363            dom_parallel_css_parsing_enabled: true,
364            dom_offscreen_canvas_enabled: false,
365            dom_permissions_enabled: false,
366            dom_permissions_testing_allowed_in_nonsecure_contexts: false,
367            dom_resize_observer_enabled: true,
368            dom_script_asynch: true,
369            dom_serviceworker_enabled: false,
370            dom_serviceworker_timeout_seconds: 60,
371            dom_servo_helpers_enabled: false,
372            dom_servoparser_async_html_tokenizer_enabled: false,
373            dom_testbinding_enabled: false,
374            dom_testbinding_prefcontrolled2_enabled: false,
375            dom_testbinding_prefcontrolled_enabled: false,
376            dom_testbinding_preference_value_falsy: false,
377            dom_testbinding_preference_value_quote_string_test: String::new(),
378            dom_testbinding_preference_value_space_string_test: String::new(),
379            dom_testbinding_preference_value_string_empty: String::new(),
380            dom_testbinding_preference_value_string_test: String::new(),
381            dom_testbinding_preference_value_truthy: false,
382            dom_testing_element_activation_enabled: false,
383            dom_testing_html_input_element_select_files_enabled: false,
384            dom_testperf_enabled: false,
385            dom_testutils_enabled: false,
386            dom_transient_activation_duration_ms: 5000,
387            dom_webgl2_enabled: false,
388            dom_webgpu_enabled: false,
389            dom_webgpu_wgpu_backend: String::new(),
390            dom_webrtc_enabled: false,
391            dom_webrtc_transceiver_enabled: false,
392            dom_webvtt_enabled: false,
393            dom_webxr_enabled: true,
394            dom_webxr_first_person_observer_view: false,
395            dom_webxr_glwindow_cubemap: false,
396            dom_webxr_glwindow_enabled: true,
397            dom_webxr_glwindow_left_right: false,
398            dom_webxr_glwindow_red_cyan: false,
399            dom_webxr_glwindow_spherical: false,
400            dom_webxr_hands_enabled: true,
401            dom_webxr_layers_enabled: false,
402            dom_webxr_openxr_enabled: true,
403            dom_webxr_sessionavailable: false,
404            dom_webxr_test: false,
405            dom_webxr_unsafe_assume_user_intent: false,
406            dom_worklet_blockingsleep_enabled: false,
407            dom_worklet_enabled: false,
408            dom_worklet_testing_enabled: false,
409            dom_worklet_timeout_ms: 10,
410            dom_visual_viewport_enabled: false,
411            accessibility_enabled: false,
412            fonts_default: String::new(),
413            fonts_default_monospace_size: 13,
414            fonts_default_size: 16,
415            fonts_monospace: String::new(),
416            fonts_sans_serif: String::new(),
417            fonts_serif: String::new(),
418            gfx_precache_shaders: false,
419            gfx_text_antialiasing_enabled: true,
420            gfx_subpixel_text_antialiasing_enabled: true,
421            gfx_texture_swizzling_enabled: true,
422            image_key_batch_size: 10,
423            inspector_show_servo_internal_shadow_roots: false,
424            intl_locale_override: String::new(),
425            js_asmjs_enabled: true,
426            js_baseline_interpreter_enabled: true,
427            js_baseline_jit_enabled: true,
428            js_baseline_jit_unsafe_eager_compilation_enabled: false,
429            js_disable_jit: false,
430            js_ion_enabled: true,
431            js_ion_unsafe_eager_compilation_enabled: false,
432            js_mem_gc_compacting_enabled: true,
433            js_mem_gc_empty_chunk_count_min: 1,
434            js_mem_gc_high_frequency_heap_growth_max: 300,
435            js_mem_gc_high_frequency_heap_growth_min: 150,
436            js_mem_gc_high_frequency_high_limit_mb: 500,
437            js_mem_gc_high_frequency_low_limit_mb: 100,
438            js_mem_gc_high_frequency_time_limit_ms: 1000,
439            js_mem_gc_incremental_enabled: true,
440            js_mem_gc_incremental_slice_ms: 10,
441            js_mem_gc_low_frequency_heap_growth: 150,
442            js_mem_gc_per_zone_enabled: false,
443            js_mem_gc_zeal_frequency: 100,
444            js_mem_gc_zeal_level: 0,
445            js_mem_max: -1,
446            js_native_regex_enabled: true,
447            js_offthread_compilation_enabled: true,
448            js_timers_minimum_duration: 1000,
449            js_wasm_baseline_enabled: true,
450            js_wasm_enabled: true,
451            js_wasm_ion_enabled: true,
452            largest_contentful_paint_enabled: false,
453            layout_animations_test_enabled: false,
454            layout_columns_enabled: false,
455            layout_container_queries_enabled: false,
456            layout_css_attr_enabled: false,
457            layout_grid_enabled: false,
458            layout_style_sharing_cache_enabled: true,
459            // TODO(mrobinson): This should likely be based on the number of processors.
460            layout_threads: 3,
461            layout_unimplemented: false,
462            layout_variable_fonts_enabled: false,
463            layout_writing_mode_enabled: false,
464            media_glvideo_enabled: false,
465            media_testing_enabled: false,
466            network_connection_timeout: 15,
467            network_enforce_tls_enabled: false,
468            network_enforce_tls_localhost: false,
469            network_enforce_tls_onion: false,
470            network_http_cache_disabled: false,
471            network_http_proxy_uri: String::new(),
472            network_https_proxy_uri: String::new(),
473            network_http_no_proxy: String::new(),
474            network_http_cache_size: 5000,
475            network_local_directory_listing_enabled: true,
476            network_use_webpki_roots: false,
477            session_history_max_length: 20,
478            shell_background_color_rgba: [1.0, 1.0, 1.0, 1.0],
479            threadpools_async_runtime_workers_max: 6,
480            threadpools_fallback_worker_num: 3,
481            threadpools_image_cache_workers_max: 4,
482            threadpools_indexeddb_workers_max: 4,
483            threadpools_webstorage_workers_max: 4,
484            threadpools_webrender_workers_max: 4,
485            webgl_testing_context_creation_error: false,
486            user_agent: String::new(),
487            viewport_meta_enabled: false,
488            log_filter: String::new(),
489        }
490    }
491
492    /// The amount of time that a half cycle of a text caret blink takes. If blinking is disabled
493    /// this returns `None`.
494    pub fn editing_caret_blink_time(&self) -> Option<Duration> {
495        if self.editing_caret_blink_time > 0 {
496            Some(Duration::from_millis(self.editing_caret_blink_time as u64))
497        } else {
498            None
499        }
500    }
501}
502
503impl Default for Preferences {
504    fn default() -> Self {
505        let mut preferences = Self::const_default();
506        preferences.user_agent = UserAgentPlatform::default().to_user_agent_string();
507        if let Ok(proxy_uri) = std::env::var("http_proxy").or_else(|_| std::env::var("HTTP_PROXY"))
508        {
509            preferences.network_http_proxy_uri = proxy_uri;
510        }
511        if let Ok(proxy_uri) =
512            std::env::var("https_proxy").or_else(|_| std::env::var("HTTPS_PROXY"))
513        {
514            preferences.network_https_proxy_uri = proxy_uri;
515        }
516        if let Ok(no_proxy) = std::env::var("no_proxy").or_else(|_| std::env::var("NO_PROXY")) {
517            preferences.network_http_no_proxy = no_proxy
518        }
519
520        preferences
521    }
522}
523
524pub enum UserAgentPlatform {
525    Desktop,
526    Android,
527    OpenHarmony,
528    Ios,
529}
530
531impl UserAgentPlatform {
532    /// Return the default `UserAgentPlatform` for this platform. This is
533    /// not an implementation of `Default` so that it can be `const`.
534    pub const fn default() -> Self {
535        if cfg!(target_os = "android") {
536            Self::Android
537        } else if cfg!(target_env = "ohos") {
538            Self::OpenHarmony
539        } else if cfg!(target_os = "ios") {
540            Self::Ios
541        } else {
542            Self::Desktop
543        }
544    }
545}
546
547impl UserAgentPlatform {
548    /// Convert this [`UserAgentPlatform`] into its corresponding `String` value, ie the
549    /// default user-agent to use for this platform.
550    pub fn to_user_agent_string(&self) -> String {
551        const SERVO_VERSION: &str = env!("CARGO_PKG_VERSION");
552        match self {
553            UserAgentPlatform::Desktop
554                if cfg!(all(target_os = "windows", target_arch = "x86_64")) =>
555            {
556                format!(
557                    "Mozilla/5.0 (Windows NT 10.0; Win64; {ARCH}rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
558                )
559            },
560            UserAgentPlatform::Desktop if cfg!(target_os = "macos") => {
561                format!(
562                    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
563                )
564            },
565            UserAgentPlatform::Desktop => {
566                format!(
567                    "Mozilla/5.0 (X11; Linux {ARCH}; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
568                )
569            },
570            UserAgentPlatform::Android => {
571                format!(
572                    "Mozilla/5.0 (Android 10; Mobile; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
573                )
574            },
575            UserAgentPlatform::OpenHarmony => format!(
576                "Mozilla/5.0 (OpenHarmony; Mobile; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
577            ),
578            UserAgentPlatform::Ios => format!(
579                "Mozilla/5.0 (iPhone; CPU iPhone OS 18_6 like Mac OS X; rv:140.0) Servo/{SERVO_VERSION} Firefox/140.0"
580            ),
581        }
582    }
583}
servo_config/prefs.rs

servo_config/
prefs.rs
