winit-sonoma-fix/src/platform/linux/x11/util/geometry.rs

use super::*;

#[derive(Debug)]
pub struct TranslatedCoords {
    pub x_rel_root: c_int,
    pub y_rel_root: c_int,
    pub child: ffi::Window,
}

// This is adequate for get_inner_position
pub unsafe fn translate_coords(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
    root: ffi::Window,
) -> Result<TranslatedCoords, XError> {
    let mut translated_coords: TranslatedCoords = mem::uninitialized();

    (xconn.xlib.XTranslateCoordinates)(
        xconn.display,
        window,
        root,
        0,
        0,
        &mut translated_coords.x_rel_root,
        &mut translated_coords.y_rel_root,
        &mut translated_coords.child,
    );

    //println!("XTranslateCoordinates coords:{:?}", translated_coords);

    xconn.check_errors().map(|_| translated_coords)
}

#[derive(Debug)]
pub struct Geometry {
    pub root: ffi::Window,
    // If you want positions relative to the root window, use translate_coords.
    // Note that the overwhelming majority of window managers are reparenting WMs, thus the window
    // ID we get from window creation is for a nested window used as the window's client area. If
    // you call get_geometry with that window ID, then you'll get the position of that client area
    // window relative to the parent it's nested in (the frame), which isn't helpful if you want
    // to know the frame position.
    pub x_rel_parent: c_int,
    pub y_rel_parent: c_int,
    // In that same case, this will give you client area size.
    pub width: c_uint,
    pub height: c_uint,
    // xmonad and dwm were the only WMs tested that use the border return at all.
    // The majority of WMs seem to simply fill it with 0 unconditionally.
    pub border: c_uint,
    pub depth: c_uint,
}

// This is adequate for get_inner_size
pub unsafe fn get_geometry(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
) -> Result<Geometry, XError> {
    let mut geometry: Geometry = mem::uninitialized();

    let _status = (xconn.xlib.XGetGeometry)(
        xconn.display,
        window,
        &mut geometry.root,
        &mut geometry.x_rel_parent,
        &mut geometry.y_rel_parent,
        &mut geometry.width,
        &mut geometry.height,
        &mut geometry.border,
        &mut geometry.depth,
    );

    //println!("XGetGeometry geo:{:?}", geometry);

    xconn.check_errors().map(|_| geometry)
}

#[derive(Debug, Clone)]
pub struct FrameExtents {
    pub left: c_ulong,
    pub right: c_ulong,
    pub top: c_ulong,
    pub bottom: c_ulong,
}

impl FrameExtents {
    pub fn new(left: c_ulong, right: c_ulong, top: c_ulong, bottom: c_ulong) -> Self {
        FrameExtents { left, right, top, bottom }
    }

    pub fn from_border(border: c_ulong) -> Self {
        Self::new(border, border, border, border)
    }
}

fn get_frame_extents(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
) -> Option<self::FrameExtents> {
    let extents_atom = unsafe { self::get_atom(xconn, b"_NET_FRAME_EXTENTS\0") }
        .expect("Failed to call XInternAtom (_NET_FRAME_EXTENTS)");

    if !self::hint_is_supported(extents_atom) {
        return None;
    }

    // Of the WMs tested, xmonad, i3, dwm, IceWM (1.3.x and earlier), and blackbox don't
    // support this. As this is part of EWMH (Extended Window Manager Hints), it's likely to
    // be unsupported by many smaller WMs.
    let extents: Option<Vec<c_ulong>> = unsafe {
        self::get_property(
            xconn,
            window,
            extents_atom,
            ffi::XA_CARDINAL,
        )
    }.ok();

    extents.and_then(|extents| {
        if extents.len() >= 4 {
            Some(self::FrameExtents {
                left: extents[0],
                right: extents[1],
                top: extents[2],
                bottom: extents[3],
            })
        } else {
            None
        }
    })
}

pub fn is_top_level(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
    root: ffi::Window,
) -> Option<bool> {
    let client_list_atom = unsafe { self::get_atom(xconn, b"_NET_CLIENT_LIST\0") }
        .expect("Failed to call XInternAtom (_NET_CLIENT_LIST)");

    if !self::hint_is_supported(client_list_atom) {
        return None;
    }

    let client_list: Option<Vec<ffi::Window>> = unsafe {
        self::get_property(
            xconn,
            root,
            client_list_atom,
            ffi::XA_WINDOW,
        )
    }.ok();

    client_list.map(|client_list| client_list.contains(&window))
}

unsafe fn get_parent_window(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
) -> Result<ffi::Window, XError> {
    let mut root: ffi::Window = mem::uninitialized();
    let mut parent: ffi::Window = mem::uninitialized();
    let mut children: *mut ffi::Window = ptr::null_mut();
    let mut nchildren: c_uint = mem::uninitialized();

    let _status = (xconn.xlib.XQueryTree)(
        xconn.display,
        window,
        &mut root,
        &mut parent,
        &mut children,
        &mut nchildren,
    );

    // The list of children isn't used
    if children != ptr::null_mut() {
        (xconn.xlib.XFree)(children as *mut _);
    }

    xconn.check_errors().map(|_| parent)
}

fn climb_hierarchy(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
    root: ffi::Window,
) -> Result<ffi::Window, XError> {
    let mut outer_window = window;
    loop {
        let candidate = unsafe { get_parent_window(xconn, outer_window) }?;
        if candidate == root {
            break;
        }
        outer_window = candidate;
    }
    Ok(outer_window)
}

#[derive(Debug, Clone, PartialEq)]
pub enum FrameExtentsHeuristicPath {
    Supported,
    UnsupportedNested,
    UnsupportedBordered,
}

#[derive(Debug, Clone)]
pub struct FrameExtentsHeuristic {
    pub frame_extents: FrameExtents,
    pub heuristic_path: FrameExtentsHeuristicPath,
}

impl FrameExtentsHeuristic {
    pub fn inner_pos_to_outer(&self, x: i32, y: i32) -> (i32, i32) {
        use self::FrameExtentsHeuristicPath::*;
        if self.heuristic_path != UnsupportedBordered {
            (x - self.frame_extents.left as i32, y - self.frame_extents.top as i32)
        } else {
            (x, y)
        }
    }

    pub fn inner_size_to_outer(&self, width: u32, height: u32) -> (u32, u32) {
        (
            width.saturating_add(
                self.frame_extents.left.saturating_add(self.frame_extents.right) as u32
            ),
            height.saturating_add(
                self.frame_extents.top.saturating_add(self.frame_extents.bottom) as u32
            ),
        )
    }
}

pub fn get_frame_extents_heuristic(
    xconn: &Arc<XConnection>,
    window: ffi::Window,
    root: ffi::Window,
) -> FrameExtentsHeuristic {
    use self::FrameExtentsHeuristicPath::*;

    // Position relative to root window.
    // With rare exceptions, this is the position of a nested window. Cases where the window
    // isn't nested are outlined in the comments throghout this function, but in addition to
    // that, fullscreen windows often aren't nested.
    let (inner_y_rel_root, child) = {
        let coords = unsafe { translate_coords(xconn, window, root) }
            .expect("Failed to translate window coordinates");
        (
            coords.y_rel_root,
            coords.child,
        )
    };

    let (width, height, border) = {
        let inner_geometry = unsafe { get_geometry(xconn, window) }
            .expect("Failed to get inner window geometry");
        (
            inner_geometry.width,
            inner_geometry.height,
            inner_geometry.border,
        )
    };

    // The first condition is only false for un-nested windows, but isn't always false for
    // un-nested windows. Mutter/Muffin/Budgie and Marco present a mysterious discrepancy:
    // when y is on the range [0, 2] and if the window has been unfocused since being
    // undecorated (or was undecorated upon construction), the first condition is true,
    // requiring us to rely on the second condition.
    let nested = !(window == child || is_top_level(xconn, child, root) == Some(true));

    // Hopefully the WM supports EWMH, allowing us to get exact info on the window frames.
    if let Some(mut frame_extents) = get_frame_extents(xconn, window) {
        // Mutter/Muffin/Budgie and Marco preserve their decorated frame extents when
        // decorations are disabled, but since the window becomes un-nested, it's easy to
        // catch.
        if !nested {
            frame_extents = FrameExtents::new(0, 0, 0, 0);
        }

        // The difference between the nested window's position and the outermost window's
        // position is equivalent to the frame size. In most scenarios, this is equivalent to
        // manually climbing the hierarchy as is done in the case below. Here's a list of
        // known discrepancies:
        // * Mutter/Muffin/Budgie gives decorated windows a margin of 9px (only 7px on top) in
        //   addition to a 1px semi-transparent border. The margin can be easily observed by
        //   using a screenshot tool to get a screenshot of a selected window, and is
        //   presumably used for drawing drop shadows. Getting window geometry information
        //   via hierarchy-climbing results in this margin being included in both the
        //   position and outer size, so a window positioned at (0, 0) would be reported as
        //   having a position (-10, -8).
        // * Compiz has a drop shadow margin just like Mutter/Muffin/Budgie, though it's 10px
        //   on all sides, and there's no additional border.
        // * Enlightenment otherwise gets a y position equivalent to inner_y_rel_root.
        //   Without decorations, there's no difference. This is presumably related to
        //   Enlightenment's fairly unique concept of window position; it interprets
        //   positions given to XMoveWindow as a client area position rather than a position
        //   of the overall window.

        FrameExtentsHeuristic {
            frame_extents,
            heuristic_path: Supported,
        }
    } else if nested {
        // If the position value we have is for a nested window used as the client area, we'll
        // just climb up the hierarchy and get the geometry of the outermost window we're
        // nested in.
        let outer_window = climb_hierarchy(xconn, window, root)
            .expect("Failed to climb window hierarchy");

        let (outer_y, outer_width, outer_height) = {
            let outer_geometry = unsafe { get_geometry(xconn, outer_window) }
                .expect("Failed to get outer window geometry");
            (
                outer_geometry.y_rel_parent,
                outer_geometry.width,
                outer_geometry.height,
            )
        };

        // Since we have the geometry of the outermost window and the geometry of the client
        // area, we can figure out what's in between.
        let diff_x = outer_width.saturating_sub(width);
        let diff_y = outer_height.saturating_sub(height);
        let offset_y = inner_y_rel_root.saturating_sub(outer_y) as c_uint;

        let left = diff_x / 2;
        let right = left;
        let top = offset_y;
        let bottom = diff_y.saturating_sub(offset_y);

        let frame_extents = FrameExtents::new(
            left.into(),
            right.into(),
            top.into(),
            bottom.into(),
        );
        FrameExtentsHeuristic {
            frame_extents,
            heuristic_path: UnsupportedNested,
        }
    } else {
        // This is the case for xmonad and dwm, AKA the only WMs tested that supplied a
        // border value. This is convenient, since we can use it to get an accurate frame.
        let frame_extents = FrameExtents::from_border(border.into());
        FrameExtentsHeuristic {
            frame_extents,
            heuristic_path: UnsupportedBordered,
        }
    }
}