use std::cmp::Ordering;
use smallvec::SmallVec;
use crate::{
Anchor, AnyElement, App, Axis, Bounds, Display, Edges, Element, GlobalElementId,
InspectorElementId, IntoElement, LayoutId, ParentElement, Pixels, Point, Position, Size, Style,
Window, point, px,
};
pub struct AnchoredState {
child_layout_ids: SmallVec<[LayoutId; 4]>,
}
pub struct Anchored {
children: SmallVec<[AnyElement; 2]>,
anchor: Anchor,
fit_mode: AnchoredFitMode,
placement: Placement,
position_mode: AnchoredPositionMode,
offset: Option<Point<Pixels>>,
}
#[derive(Clone, Copy)]
enum Placement {
InPlace,
At(Point<Pixels>),
Attached {
target: Bounds<Pixels>,
corner: Anchor,
},
}
pub fn anchored() -> Anchored {
Anchored {
children: SmallVec::new(),
anchor: Anchor::TopLeft,
fit_mode: AnchoredFitMode::SwitchAnchor,
placement: Placement::InPlace,
position_mode: AnchoredPositionMode::Window,
offset: None,
}
}
impl Anchored {
pub fn anchor(mut self, anchor: Anchor) -> Self {
self.anchor = anchor;
self
}
pub fn position(mut self, anchor: Point<Pixels>) -> Self {
self.placement = Placement::At(anchor);
self
}
pub fn attach(mut self, target: Bounds<Pixels>, corner: Anchor) -> Self {
self.placement = Placement::Attached { target, corner };
self
}
pub fn offset(mut self, offset: Point<Pixels>) -> Self {
self.offset = Some(offset);
self
}
pub fn position_mode(mut self, mode: AnchoredPositionMode) -> Self {
self.position_mode = mode;
self
}
pub fn snap_to_window(mut self) -> Self {
self.fit_mode = AnchoredFitMode::SnapToWindow;
self
}
pub fn snap_to_window_with_margin(mut self, edges: impl Into<Edges<Pixels>>) -> Self {
self.fit_mode = AnchoredFitMode::SnapToWindowWithMargin(edges.into());
self
}
}
impl ParentElement for Anchored {
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
self.children.extend(elements)
}
}
impl Element for Anchored {
type RequestLayoutState = AnchoredState;
type PrepaintState = ();
fn id(&self) -> Option<crate::ElementId> {
None
}
fn source_location(&self) -> Option<&'static core::panic::Location<'static>> {
None
}
fn request_layout(
&mut self,
_id: Option<&GlobalElementId>,
_inspector_id: Option<&InspectorElementId>,
window: &mut Window,
cx: &mut App,
) -> (crate::LayoutId, Self::RequestLayoutState) {
let child_layout_ids = self
.children
.iter_mut()
.map(|child| child.request_layout(window, cx))
.collect::<SmallVec<_>>();
let anchored_style = Style {
position: Position::Absolute,
display: Display::Flex,
..Style::default()
};
let layout_id = window.request_layout(anchored_style, child_layout_ids.iter().copied(), cx);
(layout_id, AnchoredState { child_layout_ids })
}
fn prepaint(
&mut self,
_id: Option<&GlobalElementId>,
_inspector_id: Option<&InspectorElementId>,
bounds: Bounds<Pixels>,
request_layout: &mut Self::RequestLayoutState,
window: &mut Window,
cx: &mut App,
) {
if request_layout.child_layout_ids.is_empty() {
return;
}
let children_bounds = request_layout
.child_layout_ids
.iter()
.map(|id| window.layout_bounds(*id))
.reduce(|acc, bounds| acc.union(&bounds))
.unwrap();
let anchor_position = match self.placement {
Placement::InPlace => None,
Placement::At(position) => Some(position),
Placement::Attached { target, corner } => Some(target.corner(corner)),
};
let (origin, mut desired) = self.position_mode.get_position_and_bounds(
anchor_position,
self.anchor,
children_bounds.size,
bounds,
self.offset,
);
let limits = Bounds {
origin: Point::default(),
size: window.viewport_size(),
};
if let Placement::Attached { target, mut corner } = self.placement {
let visible = limits.inset(window.client_inset.unwrap_or(px(0.)));
let overflow_along = |bounds: Bounds<Pixels>, axis: Axis| match axis {
Axis::Horizontal => {
(visible.left() - bounds.left()).max(px(0.))
+ (bounds.right() - visible.right()).max(px(0.))
}
Axis::Vertical => {
(visible.top() - bounds.top()).max(px(0.))
+ (bounds.bottom() - visible.bottom()).max(px(0.))
}
};
let mut anchor = self.anchor;
let mut offset = self.offset.unwrap_or_default();
for axis in [Axis::Horizontal, Axis::Vertical] {
let corner_side = side_along(corner, axis);
let is_outside_target = corner_side != Ordering::Equal
&& side_along(anchor, axis) == corner_side.reverse();
let overflow = overflow_along(desired, axis);
if !is_outside_target || overflow == px(0.) {
continue;
}
let flipped_corner = corner.other_side_along(axis);
let flipped_anchor = anchor.other_side_along(axis);
let flipped_offset = match axis {
Axis::Horizontal => point(-offset.x, offset.y),
Axis::Vertical => point(offset.x, -offset.y),
};
let (_, flipped) = self.position_mode.get_position_and_bounds(
Some(target.corner(flipped_corner)),
flipped_anchor,
children_bounds.size,
bounds,
Some(flipped_offset),
);
if overflow_along(flipped, axis) < overflow {
corner = flipped_corner;
anchor = flipped_anchor;
offset = flipped_offset;
desired = flipped;
}
}
} else if self.fit_mode == AnchoredFitMode::SwitchAnchor {
let mut anchor = self.anchor;
if desired.left() < limits.left() || desired.right() > limits.right() {
let switched = Bounds::from_anchor_and_size(
anchor.other_side_along(Axis::Horizontal),
origin,
children_bounds.size,
);
if !(switched.left() < limits.left() || switched.right() > limits.right()) {
anchor = anchor.other_side_along(Axis::Horizontal);
desired = switched
}
}
if desired.top() < limits.top() || desired.bottom() > limits.bottom() {
let switched = Bounds::from_anchor_and_size(
anchor.other_side_along(Axis::Vertical),
origin,
children_bounds.size,
);
if !(switched.top() < limits.top() || switched.bottom() > limits.bottom()) {
desired = switched;
}
}
}
let client_inset = window.client_inset.unwrap_or(px(0.));
let edges = match self.fit_mode {
AnchoredFitMode::SnapToWindowWithMargin(edges) => edges,
_ => Edges::default(),
}
.map(|edge| *edge + client_inset);
if desired.right() > limits.right() {
desired.origin.x -= desired.right() - limits.right() + edges.right;
}
if desired.left() < limits.left() {
desired.origin.x = limits.origin.x + edges.left;
}
if desired.bottom() > limits.bottom() {
desired.origin.y -= desired.bottom() - limits.bottom() + edges.bottom;
}
if desired.top() < limits.top() {
desired.origin.y = limits.origin.y + edges.top;
}
let offset = desired.origin - bounds.origin;
let offset = point(offset.x.round(), offset.y.round());
window.with_element_offset(offset, |window| {
for child in &mut self.children {
child.prepaint(window, cx);
}
})
}
fn paint(
&mut self,
_id: Option<&GlobalElementId>,
_inspector_id: Option<&InspectorElementId>,
_bounds: crate::Bounds<crate::Pixels>,
_request_layout: &mut Self::RequestLayoutState,
_prepaint: &mut Self::PrepaintState,
window: &mut Window,
cx: &mut App,
) {
for child in &mut self.children {
child.paint(window, cx);
}
}
}
impl IntoElement for Anchored {
type Element = Self;
fn into_element(self) -> Self::Element {
self
}
}
fn side_along(anchor: Anchor, axis: Axis) -> Ordering {
match axis {
Axis::Horizontal => match anchor {
Anchor::TopLeft | Anchor::BottomLeft | Anchor::LeftCenter => Ordering::Less,
Anchor::TopCenter | Anchor::BottomCenter => Ordering::Equal,
Anchor::TopRight | Anchor::BottomRight | Anchor::RightCenter => Ordering::Greater,
},
Axis::Vertical => match anchor {
Anchor::TopLeft | Anchor::TopRight | Anchor::TopCenter => Ordering::Less,
Anchor::LeftCenter | Anchor::RightCenter => Ordering::Equal,
Anchor::BottomLeft | Anchor::BottomRight | Anchor::BottomCenter => Ordering::Greater,
},
}
}
#[derive(Copy, Clone, PartialEq)]
pub enum AnchoredFitMode {
SnapToWindow,
SnapToWindowWithMargin(Edges<Pixels>),
SwitchAnchor,
}
#[derive(Copy, Clone, PartialEq)]
pub enum AnchoredPositionMode {
Window,
Local,
}
impl AnchoredPositionMode {
fn get_position_and_bounds(
&self,
anchor_position: Option<Point<Pixels>>,
anchor: Anchor,
size: Size<Pixels>,
bounds: Bounds<Pixels>,
offset: Option<Point<Pixels>>,
) -> (Point<Pixels>, Bounds<Pixels>) {
let offset = offset.unwrap_or_default();
match self {
AnchoredPositionMode::Window => {
let anchor_position = anchor_position.unwrap_or(bounds.origin);
let bounds = Bounds::from_anchor_and_size(anchor, anchor_position + offset, size);
(anchor_position, bounds)
}
AnchoredPositionMode::Local => {
let anchor_position = anchor_position.unwrap_or_default();
let bounds = Bounds::from_anchor_and_size(
anchor,
bounds.origin + anchor_position + offset,
size,
);
(anchor_position, bounds)
}
}
}
}
#[cfg(test)]
mod tests {
use crate::{
Anchor, Bounds, Context, Pixels, PlatformInput, Point, TestAppContext, Window, deferred,
div, point, prelude::*, px, size,
};
struct AnchoredTestView {
position: Point<Pixels>,
}
impl Render for AnchoredTestView {
fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
div().size_full().child(
div()
.id("scroll-container")
.overflow_y_scroll()
.size_full()
.child(div().h(px(2000.)).w_full())
.child(
deferred(
super::anchored()
.snap_to_window()
.position(self.position)
.child(
div()
.id("menu")
.debug_selector(|| "MENU".into())
.w(px(200.))
.h(px(300.)),
),
)
.with_priority(1),
),
)
}
}
#[gpui::test]
fn test_anchored_position_without_scroll(cx: &mut TestAppContext) {
let window = cx.open_window(size(px(800.), px(600.)), |_, _| AnchoredTestView {
position: point(px(100.), px(100.)),
});
cx.run_until_parked();
let menu_bounds = window
.update(cx, |_, window, _| {
window.rendered_frame.debug_bounds.get("MENU").copied()
})
.unwrap()
.expect("MENU debug bounds not found");
assert_eq!(menu_bounds.origin, point(px(100.), px(100.)));
assert_eq!(menu_bounds.size, size(px(200.), px(300.)));
}
#[gpui::test]
fn test_anchored_position_when_scrolled(cx: &mut TestAppContext) {
let window = cx.open_window(size(px(800.), px(600.)), |_, _| AnchoredTestView {
position: point(px(100.), px(100.)),
});
cx.run_until_parked();
window
.update(cx, |_, window, cx| {
let event = gpui::ScrollEvent {
position: point(px(400.), px(300.)),
delta: gpui::ScrollDelta::Pixels(point(px(0.), px(-1000.))),
..Default::default()
};
window.dispatch_event(PlatformInput::Scroll(event), cx);
})
.unwrap();
cx.run_until_parked();
let menu_bounds = window
.update(cx, |_, window, _| {
window.rendered_frame.debug_bounds.get("MENU").copied()
})
.unwrap()
.expect("MENU debug bounds not found");
assert_eq!(menu_bounds.origin, point(px(100.), px(100.)));
assert_eq!(menu_bounds.size, size(px(200.), px(300.)));
}
#[gpui::test]
fn test_anchored_snaps_to_window(cx: &mut TestAppContext) {
let window = cx.open_window(size(px(800.), px(600.)), |_, _| AnchoredTestView {
position: point(px(100.), px(500.)),
});
cx.run_until_parked();
let menu_bounds = window
.update(cx, |_, window, _| {
window.rendered_frame.debug_bounds.get("MENU").copied()
})
.unwrap()
.expect("MENU debug bounds not found");
assert_eq!(menu_bounds.origin, point(px(100.), px(300.)));
assert_eq!(menu_bounds.size, size(px(200.), px(300.)));
}
struct AttachedTestView {
target: Bounds<Pixels>,
corner: Anchor,
anchor: Anchor,
}
impl Render for AttachedTestView {
fn render(&mut self, _window: &mut Window, _cx: &mut Context<Self>) -> impl IntoElement {
div().size_full().child(
deferred(
super::anchored()
.attach(self.target, self.corner)
.anchor(self.anchor)
.offset(point(px(-2.), px(4.)))
.snap_to_window_with_margin(px(8.))
.child(
div()
.debug_selector(|| "MENU".into())
.w(px(200.))
.h(px(300.)),
),
)
.with_priority(1),
)
}
}
#[gpui::test]
fn test_anchored_attach_moves_to_the_side_with_room(cx: &mut TestAppContext) {
let trigger = |x: f32, y: f32| Bounds::new(point(px(x), px(y)), size(px(100.), px(20.)));
let submenu = (Anchor::TopRight, Anchor::TopLeft);
let dropdown = (Anchor::BottomLeft, Anchor::TopLeft);
for (target, (corner, anchor), expected_origin) in [
(trigger(100., 100.), submenu, point(px(198.), px(104.))),
(trigger(550., 100.), submenu, point(px(352.), px(104.))),
(trigger(100., 400.), dropdown, point(px(98.), px(96.))),
(trigger(498., 100.), submenu, point(px(596.), px(104.))),
(
Bounds::new(point(px(180.), px(100.)), size(px(500.), px(20.))),
submenu,
point(px(8.), px(104.)),
),
(
Bounds::new(point(px(50.), px(100.)), size(px(650.), px(20.))),
submenu,
point(px(592.), px(104.)),
),
(trigger(700., 100.), dropdown, point(px(592.), px(124.))),
(
trigger(100., 400.),
(Anchor::BottomCenter, Anchor::TopCenter),
point(px(48.), px(96.)),
),
] {
let window = cx.open_window(size(px(800.), px(600.)), |_, _| AttachedTestView {
target,
corner,
anchor,
});
cx.run_until_parked();
let menu_bounds = window
.update(cx, |_, window, _| {
window.rendered_frame.debug_bounds.get("MENU").copied()
})
.unwrap()
.expect("MENU debug bounds not found");
assert_eq!(
menu_bounds.origin, expected_origin,
"target: {target:?}, corner: {corner:?}, anchor: {anchor:?}"
);
}
}
}