use crate::{ input::InputState, modal::Modal, notification::{Notification, NotificationList}, sheet::Sheet, window_border, ActiveTheme, Placement, }; use gpui::{ actions, canvas, div, prelude::FluentBuilder as _, AnyView, App, AppContext, Context, DefiniteLength, Entity, FocusHandle, InteractiveElement, IntoElement, KeyBinding, ParentElement as _, Render, Styled, Window, }; use std::{any::TypeId, rc::Rc}; actions!(root, [Tab, TabPrev]); const CONTEXT: &str = "Root"; pub(crate) fn init(cx: &mut App) { cx.bind_keys([ KeyBinding::new("tab", Tab, Some(CONTEXT)), KeyBinding::new("shift-tab", TabPrev, Some(CONTEXT)), ]); } /// Extension trait for [`Window`] to add modal, sheet .. functionality. pub trait WindowExt: Sized { /// Opens a Sheet at right placement. fn open_sheet(&mut self, cx: &mut App, build: F) where F: Fn(Sheet, &mut Window, &mut App) -> Sheet + 'static; /// Opens a Sheet at the given placement. fn open_sheet_at(&mut self, placement: Placement, cx: &mut App, build: F) where F: Fn(Sheet, &mut Window, &mut App) -> Sheet + 'static; /// Return true, if there is an active Sheet. fn has_active_sheet(&mut self, cx: &mut App) -> bool; /// Closes the active Sheet. fn close_sheet(&mut self, cx: &mut App); /// Opens a Modal. fn open_modal(&mut self, cx: &mut App, build: F) where F: Fn(Modal, &mut Window, &mut App) -> Modal + 'static; /// Return true, if there is an active Modal. fn has_active_modal(&mut self, cx: &mut App) -> bool; /// Closes the last active Modal. fn close_modal(&mut self, cx: &mut App); /// Closes all active Modals. fn close_all_modals(&mut self, cx: &mut App); /// Pushes a notification to the notification list. fn push_notification(&mut self, note: impl Into, cx: &mut App); /// Removes the notification with the given id. fn remove_notification(&mut self, cx: &mut App); /// Clears all notifications. fn clear_notifications(&mut self, cx: &mut App); /// Returns number of notifications. fn notifications(&mut self, cx: &mut App) -> Rc>>; /// Return current focused Input entity. fn focused_input(&mut self, cx: &mut App) -> Option>; /// Returns true if there is a focused Input entity. fn has_focused_input(&mut self, cx: &mut App) -> bool; } impl WindowExt for Window { fn open_sheet(&mut self, cx: &mut App, build: F) where F: Fn(Sheet, &mut Window, &mut App) -> Sheet + 'static, { self.open_sheet_at(Placement::Right, cx, build) } fn open_sheet_at(&mut self, placement: Placement, cx: &mut App, build: F) where F: Fn(Sheet, &mut Window, &mut App) -> Sheet + 'static, { Root::update(self, cx, move |root, window, cx| { if root.active_sheet.is_none() { root.previous_focus_handle = window.focused(cx); } let focus_handle = cx.focus_handle(); focus_handle.focus(window); root.active_sheet = Some(ActiveSheet { focus_handle, placement, builder: Rc::new(build), }); cx.notify(); }) } fn has_active_sheet(&mut self, cx: &mut App) -> bool { Root::read(self, cx).active_sheet.is_some() } fn close_sheet(&mut self, cx: &mut App) { Root::update(self, cx, |root, window, cx| { root.focused_input = None; root.active_sheet = None; root.focus_back(window, cx); cx.notify(); }) } fn open_modal(&mut self, cx: &mut App, build: F) where F: Fn(Modal, &mut Window, &mut App) -> Modal + 'static, { Root::update(self, cx, move |root, window, cx| { // Only save focus handle if there are no active modals. // This is used to restore focus when all modals are closed. if root.active_modals.len() == 0 { root.previous_focus_handle = window.focused(cx); } let focus_handle = cx.focus_handle(); focus_handle.focus(window); root.active_modals.push(ActiveModal { focus_handle, builder: Rc::new(build), }); cx.notify(); }) } fn has_active_modal(&mut self, cx: &mut App) -> bool { Root::read(self, cx).active_modals.len() > 0 } fn close_modal(&mut self, cx: &mut App) { Root::update(self, cx, move |root, window, cx| { root.focused_input = None; root.active_modals.pop(); if let Some(top_modal) = root.active_modals.last() { // Focus the next modal. top_modal.focus_handle.focus(window); } else { // Restore focus if there are no more modals. root.focus_back(window, cx); } cx.notify(); }) } fn close_all_modals(&mut self, cx: &mut App) { Root::update(self, cx, |root, window, cx| { root.focused_input = None; root.active_modals.clear(); root.focus_back(window, cx); cx.notify(); }) } fn push_notification(&mut self, note: impl Into, cx: &mut App) { let note = note.into(); Root::update(self, cx, move |root, window, cx| { root.notification .update(cx, |view, cx| view.push(note, window, cx)); cx.notify(); }) } fn remove_notification(&mut self, cx: &mut App) { Root::update(self, cx, move |root, window, cx| { root.notification.update(cx, |view, cx| { let id = TypeId::of::(); view.close(id, window, cx); }); cx.notify(); }) } fn clear_notifications(&mut self, cx: &mut App) { Root::update(self, cx, move |root, window, cx| { root.notification .update(cx, |view, cx| view.clear(window, cx)); cx.notify(); }) } fn notifications(&mut self, cx: &mut App) -> Rc>> { let entity = Root::read(self, cx).notification.clone(); Rc::new(entity.read(cx).notifications()) } fn has_focused_input(&mut self, cx: &mut App) -> bool { Root::read(self, cx).focused_input.is_some() } fn focused_input(&mut self, cx: &mut App) -> Option> { Root::read(self, cx).focused_input.clone() } } /// Root is a view for the App window for as the top level view (Must be the first view in the window). /// /// It is used to manage the Sheet, Modal, and Notification. pub struct Root { /// Used to store the focus handle of the previous view. /// When the Modal, Sheet closes, we will focus back to the previous view. previous_focus_handle: Option, active_sheet: Option, pub(crate) active_modals: Vec, pub(super) focused_input: Option>, pub notification: Entity, sheet_size: Option, view: AnyView, } #[derive(Clone)] struct ActiveSheet { focus_handle: FocusHandle, placement: Placement, builder: Rc Sheet + 'static>, } #[derive(Clone)] pub(crate) struct ActiveModal { focus_handle: FocusHandle, builder: Rc Modal + 'static>, } impl Root { pub fn new(view: AnyView, window: &mut Window, cx: &mut Context) -> Self { Self { previous_focus_handle: None, active_sheet: None, active_modals: Vec::new(), focused_input: None, notification: cx.new(|cx| NotificationList::new(window, cx)), sheet_size: None, view, } } pub fn update(window: &mut Window, cx: &mut App, f: F) -> R where F: FnOnce(&mut Self, &mut Window, &mut Context) -> R, { let root = window .root::() .flatten() .expect("BUG: window first layer should be a gpui_component::Root."); root.update(cx, |root, cx| f(root, window, cx)) } pub fn read<'a>(window: &'a Window, cx: &'a App) -> &'a Self { &window .root::() .expect("The window root view should be of type `ui::Root`.") .unwrap() .read(cx) } fn focus_back(&mut self, window: &mut Window, _: &mut App) { if let Some(handle) = self.previous_focus_handle.clone() { window.focus(&handle); } } // Render Notification layer. pub fn render_notification_layer( window: &mut Window, cx: &mut App, ) -> Option { let root = window.root::()??; let active_sheet_placement = root.read(cx).active_sheet.clone().map(|d| d.placement); let (mt, mr) = match active_sheet_placement { Some(Placement::Right) => (None, root.read(cx).sheet_size), Some(Placement::Top) => (root.read(cx).sheet_size, None), _ => (None, None), }; Some( div() .absolute() .top_0() .right_0() .when_some(mt, |this, offset| this.mt(offset)) .when_some(mr, |this, offset| this.mr(offset)) .child(root.read(cx).notification.clone()), ) } /// Render the Sheet layer. pub fn render_sheet_layer(window: &mut Window, cx: &mut App) -> Option { let root = window.root::()??; if let Some(active_sheet) = root.read(cx).active_sheet.clone() { let mut sheet = Sheet::new(window, cx); sheet = (active_sheet.builder)(sheet, window, cx); sheet.focus_handle = active_sheet.focus_handle.clone(); sheet.placement = active_sheet.placement; let size = sheet.size; return Some( div().relative().child(sheet).child( canvas( move |_, _, cx| root.update(cx, |r, _| r.sheet_size = Some(size)), |_, _, _, _| {}, ) .absolute() .size_full(), ), ); } None } /// Render the Modal layer. pub fn render_modal_layer(window: &mut Window, cx: &mut App) -> Option { let root = window.root::()??; let active_modals = root.read(cx).active_modals.clone(); if active_modals.is_empty() { return None; } let mut show_overlay_ix = None; let mut modals = active_modals .iter() .enumerate() .map(|(i, active_modal)| { let mut modal = Modal::new(window, cx); modal = (active_modal.builder)(modal, window, cx); // Give the modal the focus handle, because `modal` is a temporary value, is not possible to // keep the focus handle in the modal. // // So we keep the focus handle in the `active_modal`, this is owned by the `Root`. modal.focus_handle = active_modal.focus_handle.clone(); modal.layer_ix = i; // Find the modal which one needs to show overlay. if modal.has_overlay() { show_overlay_ix = Some(i); } modal }) .collect::>(); if let Some(ix) = show_overlay_ix { if let Some(modal) = modals.get_mut(ix) { modal.overlay_visible = true; } } Some(div().children(modals)) } /// Return the root view of the Root. pub fn view(&self) -> &AnyView { &self.view } fn on_action_tab(&mut self, _: &Tab, window: &mut Window, _: &mut Context) { window.focus_next(); } fn on_action_tab_prev(&mut self, _: &TabPrev, window: &mut Window, _: &mut Context) { window.focus_prev(); } } impl Render for Root { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let base_font_size = cx.theme().font_size; window.set_rem_size(base_font_size); window_border().child( div() .id("root") .key_context(CONTEXT) .on_action(cx.listener(Self::on_action_tab)) .on_action(cx.listener(Self::on_action_tab_prev)) .relative() .size_full() .font_family(".SystemUIFont") .bg(cx.theme().background) .text_color(cx.theme().foreground) .child(self.view.clone()), ) } }