PolytreeDE
/
alacritty
mirror of https://github.com/alacritty/alacritty.git
1
0
Fork 0
Code Releases Activity
alacritty/alacritty/src/display/window.rs

621 lines
20 KiB
Rust
Raw Blame History

#[rustfmt::skip]
#[cfg(not(any(target_os = "macos", windows)))]
use {
std::sync::atomic::AtomicBool,
std::sync::Arc,
glutin::platform::unix::{WindowBuilderExtUnix, WindowExtUnix},
};
#[rustfmt::skip]
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
use {
wayland_client::protocol::wl_surface::WlSurface,
wayland_client::{Attached, EventQueue, Proxy},
glutin::platform::unix::EventLoopWindowTargetExtUnix,
glutin::window::Theme,
};
#[rustfmt::skip]
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
use {
std::io::Cursor,
x11_dl::xlib::{Display as XDisplay, PropModeReplace, XErrorEvent, Xlib},
glutin::window::Icon,
png::Decoder,
};
use std::fmt::{self, Display, Formatter};
use std::ops::{Deref, DerefMut};
use std::sync::atomic::{AtomicU8, Ordering};
use bitflags::bitflags;
#[cfg(target_os = "macos")]
use cocoa::base::{id, NO, YES};
use glutin::dpi::{PhysicalPosition, PhysicalSize};
use glutin::event_loop::EventLoopWindowTarget;
#[cfg(target_os = "macos")]
use glutin::platform::macos::{WindowBuilderExtMacOS, WindowExtMacOS};
#[cfg(windows)]
use glutin::platform::windows::IconExtWindows;
use glutin::window::{
CursorIcon, Fullscreen, UserAttentionType, Window as GlutinWindow, WindowBuilder, WindowId,
};
use glutin::{self, ContextBuilder, PossiblyCurrent, Rect, WindowedContext};
#[cfg(target_os = "macos")]
use objc::{msg_send, sel, sel_impl};
#[cfg(target_os = "macos")]
use raw_window_handle::{HasRawWindowHandle, RawWindowHandle};
#[cfg(windows)]
use winapi::shared::minwindef::WORD;
use alacritty_terminal::index::Point;
use crate::config::window::{Decorations, Identity, WindowConfig};
use crate::config::UiConfig;
use crate::display::SizeInfo;
use crate::gl;
/// Window icon for `_NET_WM_ICON` property.
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
static WINDOW_ICON: &[u8] = include_bytes!("../../extra/logo/compat/alacritty-term.png");
/// This should match the definition of IDI_ICON from `alacritty.rc`.
#[cfg(windows)]
const IDI_ICON: WORD = 0x101;
/// Context creation flags from probing config.
static GL_CONTEXT_CREATION_FLAGS: AtomicU8 = AtomicU8::new(GlContextFlags::SRGB.bits);
bitflags! {
pub struct GlContextFlags: u8 {
const EMPTY = 0b000000000;
const SRGB = 0b0000_0001;
const DEEP_COLOR = 0b0000_0010;
}
}
/// Window errors.
#[derive(Debug)]
pub enum Error {
/// Error creating the window.
ContextCreation(glutin::CreationError),
/// Error dealing with fonts.
Font(crossfont::Error),
/// Error manipulating the rendering context.
Context(glutin::ContextError),
}
/// Result of fallible operations concerning a Window.
type Result<T> = std::result::Result<T, Error>;
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
match self {
Error::ContextCreation(err) => err.source(),
Error::Context(err) => err.source(),
Error::Font(err) => err.source(),
}
}
}
impl Display for Error {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match self {
Error::ContextCreation(err) => write!(f, "Error creating GL context; {}", err),
Error::Context(err) => write!(f, "Error operating on render context; {}", err),
Error::Font(err) => err.fmt(f),
}
}
}
impl From<glutin::CreationError> for Error {
fn from(val: glutin::CreationError) -> Self {
Error::ContextCreation(val)
}
}
impl From<glutin::ContextError> for Error {
fn from(val: glutin::ContextError) -> Self {
Error::Context(val)
}
}
impl From<crossfont::Error> for Error {
fn from(val: crossfont::Error) -> Self {
Error::Font(val)
}
}
fn create_gl_window<E>(
mut window: WindowBuilder,
event_loop: &EventLoopWindowTarget<E>,
flags: GlContextFlags,
vsync: bool,
dimensions: Option<PhysicalSize<u32>>,
) -> Result<WindowedContext<PossiblyCurrent>> {
if let Some(dimensions) = dimensions {
window = window.with_inner_size(dimensions);
}
let mut windowed_context_builder = ContextBuilder::new()
.with_srgb(flags.contains(GlContextFlags::SRGB))
.with_vsync(vsync)
.with_hardware_acceleration(None);
if flags.contains(GlContextFlags::DEEP_COLOR) {
windowed_context_builder = windowed_context_builder.with_pixel_format(30, 2);
}
let windowed_context = windowed_context_builder.build_windowed(window, event_loop)?;
// Make the context current so OpenGL operations can run.
let windowed_context = unsafe { windowed_context.make_current().map_err(|(_, err)| err)? };
Ok(windowed_context)
}
/// A window which can be used for displaying the terminal.
///
/// Wraps the underlying windowing library to provide a stable API in Alacritty.
pub struct Window {
/// Flag tracking frame redraw requests from Wayland compositor.
#[cfg(not(any(target_os = "macos", windows)))]
pub should_draw: Arc<AtomicBool>,
/// Attached Wayland surface to request new frame events.
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
pub wayland_surface: Option<Attached<WlSurface>>,
/// Cached scale factor for quickly scaling pixel sizes.
pub scale_factor: f64,
/// Current window title.
title: String,
windowed_context: Replaceable<WindowedContext<PossiblyCurrent>>,
current_mouse_cursor: CursorIcon,
mouse_visible: bool,
}
impl Window {
/// Create a new window.
///
/// This creates a window and fully initializes a window.
pub fn new<E>(
event_loop: &EventLoopWindowTarget<E>,
config: &UiConfig,
identity: &Identity,
size: Option<PhysicalSize<u32>>,
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
wayland_event_queue: Option<&EventQueue>,
) -> Result<Window> {
let identity = identity.clone();
let mut window_builder = Window::get_platform_window(&identity, &config.window);
if let Some(position) = config.window.position {
window_builder = window_builder
.with_position(PhysicalPosition::<i32>::from((position.x, position.y)));
}
// Check if we're running Wayland to disable vsync.
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
let is_wayland = event_loop.is_wayland();
#[cfg(any(not(feature = "wayland"), target_os = "macos", windows))]
let is_wayland = false;
let mut windowed_context = None;
let current_flags =
GlContextFlags::from_bits_truncate(GL_CONTEXT_CREATION_FLAGS.load(Ordering::Relaxed));
for flags in [
current_flags,
GlContextFlags::EMPTY,
GlContextFlags::SRGB | GlContextFlags::DEEP_COLOR,
GlContextFlags::DEEP_COLOR,
] {
windowed_context = Some(create_gl_window(
window_builder.clone(),
event_loop,
flags,
!is_wayland,
size,
));
if windowed_context.as_ref().unwrap().is_ok() {
GL_CONTEXT_CREATION_FLAGS.store(flags.bits, Ordering::Relaxed);
break;
}
}
let windowed_context = windowed_context.unwrap()?;
// Text cursor.
let current_mouse_cursor = CursorIcon::Text;
windowed_context.window().set_cursor_icon(current_mouse_cursor);
// Enable IME.
windowed_context.window().set_ime_allowed(true);
// Set OpenGL symbol loader. This call MUST be after window.make_current on windows.
gl::load_with(|symbol| windowed_context.get_proc_address(symbol) as *const _);
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
if !is_wayland {
// On X11, embed the window inside another if the parent ID has been set.
if let Some(parent_window_id) = config.window.embed {
x_embed_window(windowed_context.window(), parent_window_id);
}
}
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
let wayland_surface = if is_wayland {
// Attach surface to Alacritty's internal wayland queue to handle frame callbacks.
let surface = windowed_context.window().wayland_surface().unwrap();
let proxy: Proxy<WlSurface> = unsafe { Proxy::from_c_ptr(surface as _) };
Some(proxy.attach(wayland_event_queue.as_ref().unwrap().token()))
} else {
None
};
let scale_factor = windowed_context.window().scale_factor();
Ok(Self {
current_mouse_cursor,
mouse_visible: true,
windowed_context: Replaceable::new(windowed_context),
title: identity.title,
#[cfg(not(any(target_os = "macos", windows)))]
should_draw: Arc::new(AtomicBool::new(true)),
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
wayland_surface,
scale_factor,
})
}
#[inline]
pub fn set_inner_size(&self, size: PhysicalSize<u32>) {
self.window().set_inner_size(size);
}
#[inline]
pub fn inner_size(&self) -> PhysicalSize<u32> {
self.window().inner_size()
}
#[inline]
pub fn set_visible(&self, visibility: bool) {
self.window().set_visible(visibility);
}
/// Set the window title.
#[inline]
pub fn set_title(&mut self, title: String) {
self.title = title;
self.window().set_title(&self.title);
}
/// Get the window title.
#[inline]
pub fn title(&self) -> &str {
&self.title
}
#[inline]
pub fn request_redraw(&self) {
self.window().request_redraw();
}
#[inline]
pub fn set_mouse_cursor(&mut self, cursor: CursorIcon) {
if cursor != self.current_mouse_cursor {
self.current_mouse_cursor = cursor;
self.window().set_cursor_icon(cursor);
}
}
/// Set mouse cursor visible.
pub fn set_mouse_visible(&mut self, visible: bool) {
if visible != self.mouse_visible {
self.mouse_visible = visible;
self.window().set_cursor_visible(visible);
}
}
#[cfg(not(any(target_os = "macos", windows)))]
pub fn get_platform_window(identity: &Identity, window_config: &WindowConfig) -> WindowBuilder {
#[cfg(feature = "x11")]
let icon = {
let decoder = Decoder::new(Cursor::new(WINDOW_ICON));
let mut reader = decoder.read_info().expect("invalid embedded icon");
let mut buf = vec![0; reader.output_buffer_size()];
let _ = reader.next_frame(&mut buf);
Icon::from_rgba(buf, reader.info().width, reader.info().height)
};
let builder = WindowBuilder::new()
.with_title(&identity.title)
.with_name(&identity.class.general, &identity.class.instance)
.with_visible(false)
.with_transparent(true)
.with_decorations(window_config.decorations != Decorations::None)
.with_maximized(window_config.maximized())
.with_fullscreen(window_config.fullscreen());
#[cfg(feature = "x11")]
let builder = builder.with_window_icon(icon.ok());
#[cfg(feature = "x11")]
let builder = match window_config.decorations_theme_variant() {
Some(val) => builder.with_gtk_theme_variant(val.to_string()),
None => builder,
};
#[cfg(feature = "wayland")]
let builder = match window_config.decorations_theme_variant() {
Some("light") => builder.with_wayland_csd_theme(Theme::Light),
// Prefer dark theme by default, since default alacritty theme is dark.
_ => builder.with_wayland_csd_theme(Theme::Dark),
};
builder
}
#[cfg(windows)]
pub fn get_platform_window(identity: &Identity, window_config: &WindowConfig) -> WindowBuilder {
let icon = glutin::window::Icon::from_resource(IDI_ICON, None);
WindowBuilder::new()
.with_title(&identity.title)
.with_visible(false)
.with_decorations(window_config.decorations != Decorations::None)
.with_transparent(true)
.with_maximized(window_config.maximized())
.with_fullscreen(window_config.fullscreen())
.with_window_icon(icon.ok())
}
#[cfg(target_os = "macos")]
pub fn get_platform_window(identity: &Identity, window_config: &WindowConfig) -> WindowBuilder {
let window = WindowBuilder::new()
.with_title(&identity.title)
.with_visible(false)
.with_transparent(true)
.with_maximized(window_config.maximized())
.with_fullscreen(window_config.fullscreen());
match window_config.decorations {
Decorations::Full => window,
Decorations::Transparent => window
.with_title_hidden(true)
.with_titlebar_transparent(true)
.with_fullsize_content_view(true),
Decorations::Buttonless => window
.with_title_hidden(true)
.with_titlebar_buttons_hidden(true)
.with_titlebar_transparent(true)
.with_fullsize_content_view(true),
Decorations::None => window.with_titlebar_hidden(true),
}
}
pub fn set_urgent(&self, is_urgent: bool) {
let attention = if is_urgent { Some(UserAttentionType::Critical) } else { None };
self.window().request_user_attention(attention);
}
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
pub fn x11_window_id(&self) -> Option<usize> {
self.window().xlib_window().map(|xlib_window| xlib_window as usize)
}
#[cfg(any(not(feature = "x11"), target_os = "macos", windows))]
pub fn x11_window_id(&self) -> Option<usize> {
None
}
pub fn id(&self) -> WindowId {
self.window().id()
}
pub fn set_maximized(&self, maximized: bool) {
self.window().set_maximized(maximized);
}
pub fn set_minimized(&self, minimized: bool) {
self.window().set_minimized(minimized);
}
/// Toggle the window's fullscreen state.
pub fn toggle_fullscreen(&self) {
self.set_fullscreen(self.window().fullscreen().is_none());
}
/// Toggle the window's maximized state.
pub fn toggle_maximized(&self) {
self.set_maximized(!self.window().is_maximized());
}
#[cfg(target_os = "macos")]
pub fn toggle_simple_fullscreen(&self) {
self.set_simple_fullscreen(!self.window().simple_fullscreen());
}
pub fn set_fullscreen(&self, fullscreen: bool) {
if fullscreen {
self.window().set_fullscreen(Some(Fullscreen::Borderless(None)));
} else {
self.window().set_fullscreen(None);
}
}
#[cfg(target_os = "macos")]
pub fn set_simple_fullscreen(&self, simple_fullscreen: bool) {
self.window().set_simple_fullscreen(simple_fullscreen);
}
#[cfg(all(feature = "wayland", not(any(target_os = "macos", windows))))]
pub fn wayland_surface(&self) -> Option<&Attached<WlSurface>> {
self.wayland_surface.as_ref()
}
/// Adjust the IME editor position according to the new location of the cursor.
pub fn update_ime_position(&self, point: Point, size: &SizeInfo) {
let nspot_x = f64::from(size.padding_x() + point.column.0 as f32 * size.cell_width());
let nspot_y = f64::from(size.padding_y() + (point.line.0 + 1) as f32 * size.cell_height());
self.window().set_ime_position(PhysicalPosition::new(nspot_x, nspot_y));
}
pub fn swap_buffers(&self) {
self.windowed_context.swap_buffers().expect("swap buffers");
}
pub fn swap_buffers_with_damage(&self, damage: &[Rect]) {
self.windowed_context.swap_buffers_with_damage(damage).expect("swap buffes with damage");
}
#[cfg(any(target_os = "macos", windows))]
pub fn swap_buffers_with_damage_supported(&self) -> bool {
// Disable damage tracking on macOS/Windows since there's no observation of it working.
false
}
#[cfg(not(any(target_os = "macos", windows)))]
pub fn swap_buffers_with_damage_supported(&self) -> bool {
// On X11 damage tracking is behaving in unexpected ways on some NVIDIA systems. Since
// there's no compositor supporting it, damage tracking is disabled on X11.
//
// For more see https://github.com/alacritty/alacritty/issues/6051.
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
if self.window().xlib_window().is_some() {
return false;
}
self.windowed_context.swap_buffers_with_damage_supported()
}
pub fn resize(&self, size: PhysicalSize<u32>) {
self.windowed_context.resize(size);
}
pub fn make_not_current(&mut self) {
if self.windowed_context.is_current() {
self.windowed_context.replace_with(|context| unsafe {
// We do ensure that context is current before any rendering operation due to multi
// window support, so we don't need extra "type aid" from glutin here.
context.make_not_current().expect("context swap").treat_as_current()
});
}
}
pub fn make_current(&mut self) {
if !self.windowed_context.is_current() {
self.windowed_context
.replace_with(|context| unsafe { context.make_current().expect("context swap") });
}
}
/// Disable macOS window shadows.
///
/// This prevents rendering artifacts from showing up when the window is transparent.
#[cfg(target_os = "macos")]
pub fn set_has_shadow(&self, has_shadows: bool) {
let raw_window = match self.window().raw_window_handle() {
RawWindowHandle::AppKit(handle) => handle.ns_window as id,
_ => return,
};
let value = if has_shadows { YES } else { NO };
unsafe {
let _: id = msg_send![raw_window, setHasShadow: value];
}
}
fn window(&self) -> &GlutinWindow {
self.windowed_context.window()
}
}
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
fn x_embed_window(window: &GlutinWindow, parent_id: std::os::raw::c_ulong) {
let (xlib_display, xlib_window) = match (window.xlib_display(), window.xlib_window()) {
(Some(display), Some(window)) => (display, window),
_ => return,
};
let xlib = Xlib::open().expect("get xlib");
unsafe {
let atom = (xlib.XInternAtom)(xlib_display as *mut _, "_XEMBED".as_ptr() as *const _, 0);
(xlib.XChangeProperty)(
xlib_display as _,
xlib_window as _,
atom,
atom,
32,
PropModeReplace,
[0, 1].as_ptr(),
2,
);
// Register new error handler.
let old_handler = (xlib.XSetErrorHandler)(Some(xembed_error_handler));
// Check for the existence of the target before attempting reparenting.
(xlib.XReparentWindow)(xlib_display as _, xlib_window as _, parent_id, 0, 0);
// Drain errors and restore original error handler.
(xlib.XSync)(xlib_display as _, 0);
(xlib.XSetErrorHandler)(old_handler);
}
}
#[cfg(all(feature = "x11", not(any(target_os = "macos", windows))))]
unsafe extern "C" fn xembed_error_handler(_: *mut XDisplay, _: *mut XErrorEvent) -> i32 {
log::error!("Could not embed into specified window.");
std::process::exit(1);
}
/// Struct for safe in-place replacement.
///
/// This struct allows easily replacing struct fields that provide `self -> Self` methods in-place,
/// without having to deal with constantly unwrapping the underlying [`Option`].
struct Replaceable<T>(Option<T>);
impl<T> Replaceable<T> {
pub fn new(inner: T) -> Self {
Self(Some(inner))
}
/// Replace the contents of the container.
pub fn replace_with<F: FnMut(T) -> T>(&mut self, f: F) {
self.0 = self.0.take().map(f);
}
/// Get immutable access to the wrapped value.
pub fn get(&self) -> &T {
self.0.as_ref().unwrap()
}
/// Get mutable access to the wrapped value.
pub fn get_mut(&mut self) -> &mut T {
self.0.as_mut().unwrap()
}
}
impl<T> Deref for Replaceable<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.get()
}
}
impl<T> DerefMut for Replaceable<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.get_mut()
}
}
View Git Blame Copy Permalink