servoshell/desktop/
headless_window.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
5//! A headless window implementation.
6
7#![deny(clippy::panic)]
8#![deny(clippy::unwrap_used)]
9
10use std::cell::Cell;
11use std::rc::Rc;
12
13use euclid::num::Zero;
14use euclid::{Length, Point2D, Scale, Size2D};
15use servo::servo_geometry::{
16    DeviceIndependentIntRect, DeviceIndependentPixel, convert_rect_to_css_pixel,
17};
18use servo::webrender_api::units::{DeviceIntPoint, DeviceIntRect, DeviceIntSize, DevicePixel};
19use servo::{RenderingContext, ScreenGeometry, SoftwareRenderingContext, WebView};
20use winit::dpi::PhysicalSize;
21
22use super::app_state::RunningAppState;
23use crate::desktop::window_trait::{MIN_INNER_HEIGHT, MIN_INNER_WIDTH, WindowPortsMethods};
24use crate::prefs::ServoShellPreferences;
25
26pub struct Window {
27    fullscreen: Cell<bool>,
28    device_pixel_ratio_override: Option<Scale<f32, DeviceIndependentPixel, DevicePixel>>,
29    inner_size: Cell<DeviceIntSize>,
30    screen_size: Size2D<i32, DevicePixel>,
31    // virtual top-left position of the window in device pixels.
32    window_position: Cell<Point2D<i32, DevicePixel>>,
33    rendering_context: Rc<SoftwareRenderingContext>,
34}
35
36impl Window {
37    #[allow(clippy::new_ret_no_self)]
38    pub fn new(servoshell_preferences: &ServoShellPreferences) -> Rc<dyn WindowPortsMethods> {
39        let size = servoshell_preferences.initial_window_size;
40
41        let device_pixel_ratio_override = servoshell_preferences.device_pixel_ratio_override;
42        let device_pixel_ratio_override: Option<Scale<f32, DeviceIndependentPixel, DevicePixel>> =
43            device_pixel_ratio_override.map(Scale::new);
44        let hidpi_factor = device_pixel_ratio_override.unwrap_or_else(Scale::identity);
45
46        let inner_size = (size.to_f32() * hidpi_factor).to_i32();
47        let physical_size = PhysicalSize::new(inner_size.width as u32, inner_size.height as u32);
48        let rendering_context =
49            SoftwareRenderingContext::new(physical_size).expect("Failed to create WR surfman");
50
51        let screen_size = servoshell_preferences
52            .screen_size_override
53            .map_or(inner_size * 2, |screen_size_override| {
54                (screen_size_override.to_f32() * hidpi_factor).to_i32()
55            });
56
57        let window = Window {
58            fullscreen: Cell::new(false),
59            device_pixel_ratio_override,
60            inner_size: Cell::new(inner_size),
61            screen_size,
62            window_position: Cell::new(Point2D::zero()),
63            rendering_context: Rc::new(rendering_context),
64        };
65
66        Rc::new(window)
67    }
68}
69
70impl WindowPortsMethods for Window {
71    fn id(&self) -> winit::window::WindowId {
72        winit::window::WindowId::dummy()
73    }
74
75    fn screen_geometry(&self) -> servo::ScreenGeometry {
76        ScreenGeometry {
77            size: self.screen_size,
78            available_size: self.screen_size,
79            window_rect: DeviceIntRect::from_origin_and_size(
80                self.window_position.get(),
81                self.inner_size.get(),
82            ),
83        }
84    }
85
86    fn set_position(&self, point: DeviceIntPoint) {
87        self.window_position.set(point);
88    }
89
90    fn request_resize(
91        &self,
92        webview: &WebView,
93        outer_size: DeviceIntSize,
94    ) -> Option<DeviceIntSize> {
95        let new_size = DeviceIntSize::new(
96            outer_size.width.max(MIN_INNER_WIDTH),
97            outer_size.height.max(MIN_INNER_HEIGHT),
98        );
99        if self.inner_size.get() == new_size {
100            return Some(new_size);
101        }
102
103        self.inner_size.set(new_size);
104
105        // Because we are managing the rendering surface ourselves, there will be no other
106        // notification (such as from the display manager) that it has changed size, so we
107        // must notify the compositor here.
108        webview.move_resize(outer_size.to_f32().into());
109        webview.resize(PhysicalSize::new(
110            outer_size.width as u32,
111            outer_size.height as u32,
112        ));
113
114        Some(new_size)
115    }
116
117    fn device_hidpi_scale_factor(&self) -> Scale<f32, DeviceIndependentPixel, DevicePixel> {
118        Scale::new(1.0)
119    }
120
121    fn hidpi_scale_factor(&self) -> Scale<f32, DeviceIndependentPixel, DevicePixel> {
122        self.device_pixel_ratio_override
123            .unwrap_or_else(|| self.device_hidpi_scale_factor())
124    }
125
126    fn page_height(&self) -> f32 {
127        let height = self.inner_size.get().height;
128        let dpr = self.hidpi_scale_factor();
129        height as f32 * dpr.get()
130    }
131
132    fn set_fullscreen(&self, state: bool) {
133        self.fullscreen.set(state);
134    }
135
136    fn get_fullscreen(&self) -> bool {
137        self.fullscreen.get()
138    }
139
140    fn handle_winit_event(&self, _: Rc<RunningAppState>, _: winit::event::WindowEvent) {
141        // Not expecting any winit events.
142    }
143
144    #[cfg(feature = "webxr")]
145    fn new_glwindow(
146        &self,
147        _events_loop: &winit::event_loop::ActiveEventLoop,
148    ) -> Rc<dyn servo::webxr::glwindow::GlWindow> {
149        unimplemented!()
150    }
151
152    fn winit_window(&self) -> Option<&winit::window::Window> {
153        None
154    }
155
156    fn toolbar_height(&self) -> Length<f32, DeviceIndependentPixel> {
157        Length::zero()
158    }
159
160    fn window_rect(&self) -> DeviceIndependentIntRect {
161        convert_rect_to_css_pixel(
162            DeviceIntRect::from_origin_and_size(self.window_position.get(), self.inner_size.get()),
163            self.hidpi_scale_factor(),
164        )
165    }
166
167    fn set_toolbar_height(&self, _height: Length<f32, DeviceIndependentPixel>) {
168        unimplemented!("headless Window only")
169    }
170
171    fn rendering_context(&self) -> Rc<dyn RenderingContext> {
172        self.rendering_context.clone()
173    }
174
175    fn maximize(&self, webview: &WebView) {
176        self.window_position.set(Point2D::zero());
177        self.inner_size.set(self.screen_size);
178        // Because we are managing the rendering surface ourselves, there will be no other
179        // notification (such as from the display manager) that it has changed size, so we
180        // must notify the compositor here.
181        webview.move_resize(self.screen_size.to_f32().into());
182        webview.resize(PhysicalSize::new(
183            self.screen_size.width as u32,
184            self.screen_size.height as u32,
185        ));
186    }
187}