zed/crates/workspace/src/notifications.rs

use std::{any::TypeId, ops::DerefMut};

use collections::HashSet;
use gpui::{AnyViewHandle, AppContext, Entity, View, ViewContext, ViewHandle};

use crate::Workspace;

pub fn init(cx: &mut AppContext) {
    cx.set_global(NotificationTracker::new());
    simple_message_notification::init(cx);
}

pub trait Notification: View {
    fn should_dismiss_notification_on_event(&self, event: &<Self as Entity>::Event) -> bool;
}

pub trait NotificationHandle {
    fn id(&self) -> usize;
    fn as_any(&self) -> &AnyViewHandle;
}

impl<T: Notification> NotificationHandle for ViewHandle<T> {
    fn id(&self) -> usize {
        self.id()
    }

    fn as_any(&self) -> &AnyViewHandle {
        self
    }
}

impl From<&dyn NotificationHandle> for AnyViewHandle {
    fn from(val: &dyn NotificationHandle) -> Self {
        val.as_any().clone()
    }
}

struct NotificationTracker {
    notifications_sent: HashSet<TypeId>,
}

impl std::ops::Deref for NotificationTracker {
    type Target = HashSet<TypeId>;

    fn deref(&self) -> &Self::Target {
        &self.notifications_sent
    }
}

impl DerefMut for NotificationTracker {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.notifications_sent
    }
}

impl NotificationTracker {
    fn new() -> Self {
        Self {
            notifications_sent: HashSet::default(),
        }
    }
}

impl Workspace {
    pub fn show_notification_once<V: Notification>(
        &mut self,
        id: usize,
        cx: &mut ViewContext<Self>,
        build_notification: impl FnOnce(&mut ViewContext<Self>) -> ViewHandle<V>,
    ) {
        if !cx
            .global::<NotificationTracker>()
            .contains(&TypeId::of::<V>())
        {
            cx.update_global::<NotificationTracker, _, _>(|tracker, _| {
                tracker.insert(TypeId::of::<V>())
            });

            self.show_notification::<V>(id, cx, build_notification)
        }
    }

    pub fn show_notification<V: Notification>(
        &mut self,
        id: usize,
        cx: &mut ViewContext<Self>,
        build_notification: impl FnOnce(&mut ViewContext<Self>) -> ViewHandle<V>,
    ) {
        let type_id = TypeId::of::<V>();
        if self
            .notifications
            .iter()
            .all(|(existing_type_id, existing_id, _)| {
                (*existing_type_id, *existing_id) != (type_id, id)
            })
        {
            let notification = build_notification(cx);
            cx.subscribe(&notification, move |this, handle, event, cx| {
                if handle.read(cx).should_dismiss_notification_on_event(event) {
                    this.dismiss_notification_internal(type_id, id, cx);
                }
            })
            .detach();
            self.notifications
                .push((type_id, id, Box::new(notification)));
            cx.notify();
        }
    }

    pub fn dismiss_notification<V: Notification>(&mut self, id: usize, cx: &mut ViewContext<Self>) {
        let type_id = TypeId::of::<V>();

        self.dismiss_notification_internal(type_id, id, cx)
    }

    fn dismiss_notification_internal(
        &mut self,
        type_id: TypeId,
        id: usize,
        cx: &mut ViewContext<Self>,
    ) {
        self.notifications
            .retain(|(existing_type_id, existing_id, _)| {
                if (*existing_type_id, *existing_id) == (type_id, id) {
                    cx.notify();
                    false
                } else {
                    true
                }
            });
    }
}

pub mod simple_message_notification {

    use std::borrow::Cow;

    use gpui::{
        actions,
        elements::{Flex, MouseEventHandler, Padding, ParentElement, Svg, Text},
        impl_actions,
        platform::{CursorStyle, MouseButton},
        Action, AppContext, Element, Entity, View, ViewContext,
    };
    use menu::Cancel;
    use serde::Deserialize;
    use settings::Settings;

    use crate::Workspace;

    use super::Notification;

    actions!(message_notifications, [CancelMessageNotification]);

    #[derive(Clone, Default, Deserialize, PartialEq)]
    pub struct OsOpen(pub Cow<'static, str>);

    impl OsOpen {
        pub fn new<I: Into<Cow<'static, str>>>(url: I) -> Self {
            OsOpen(url.into())
        }
    }

    impl_actions!(message_notifications, [OsOpen]);

    pub fn init(cx: &mut AppContext) {
        cx.add_action(MessageNotification::dismiss);
        cx.add_action(
            |_workspace: &mut Workspace, open_action: &OsOpen, cx: &mut ViewContext<Workspace>| {
                cx.platform().open_url(open_action.0.as_ref());
            },
        )
    }

    pub struct MessageNotification {
        message: Cow<'static, str>,
        click_action: Option<Box<dyn Action>>,
        click_message: Option<Cow<'static, str>>,
    }

    pub enum MessageNotificationEvent {
        Dismiss,
    }

    impl Entity for MessageNotification {
        type Event = MessageNotificationEvent;
    }

    impl MessageNotification {
        pub fn new_message<S: Into<Cow<'static, str>>>(message: S) -> MessageNotification {
            Self {
                message: message.into(),
                click_action: None,
                click_message: None,
            }
        }

        pub fn new_boxed_action<S1: Into<Cow<'static, str>>, S2: Into<Cow<'static, str>>>(
            message: S1,
            click_action: Box<dyn Action>,
            click_message: S2,
        ) -> Self {
            Self {
                message: message.into(),
                click_action: Some(click_action),
                click_message: Some(click_message.into()),
            }
        }

        pub fn new<S1: Into<Cow<'static, str>>, A: Action, S2: Into<Cow<'static, str>>>(
            message: S1,
            click_action: A,
            click_message: S2,
        ) -> Self {
            Self {
                message: message.into(),
                click_action: Some(Box::new(click_action) as Box<dyn Action>),
                click_message: Some(click_message.into()),
            }
        }

        pub fn dismiss(&mut self, _: &CancelMessageNotification, cx: &mut ViewContext<Self>) {
            cx.emit(MessageNotificationEvent::Dismiss);
        }
    }

    impl View for MessageNotification {
        fn ui_name() -> &'static str {
            "MessageNotification"
        }

        fn render(&mut self, cx: &mut gpui::RenderContext<'_, Self>) -> gpui::ElementBox {
            let theme = cx.global::<Settings>().theme.clone();
            let theme = &theme.simple_message_notification;

            enum MessageNotificationTag {}

            let click_action = self
                .click_action
                .as_ref()
                .map(|action| action.boxed_clone());
            let click_message = self.click_message.as_ref().map(|message| message.clone());
            let message = self.message.clone();

            let has_click_action = click_action.is_some();

            MouseEventHandler::<MessageNotificationTag>::new(0, cx, |state, cx| {
                Flex::column()
                    .with_child(
                        Flex::row()
                            .with_child(
                                Text::new(message, theme.message.text.clone())
                                    .contained()
                                    .with_style(theme.message.container)
                                    .aligned()
                                    .top()
                                    .left()
                                    .flex(1., true)
                                    .boxed(),
                            )
                            .with_child(
                                MouseEventHandler::<Cancel>::new(0, cx, |state, _| {
                                    let style = theme.dismiss_button.style_for(state, false);
                                    Svg::new("icons/x_mark_8.svg")
                                        .with_color(style.color)
                                        .constrained()
                                        .with_width(style.icon_width)
                                        .aligned()
                                        .contained()
                                        .with_style(style.container)
                                        .constrained()
                                        .with_width(style.button_width)
                                        .with_height(style.button_width)
                                        .boxed()
                                })
                                .with_padding(Padding::uniform(5.))
                                .on_click(MouseButton::Left, move |_, cx| {
                                    cx.dispatch_action(CancelMessageNotification)
                                })
                                .with_cursor_style(CursorStyle::PointingHand)
                                .aligned()
                                .constrained()
                                .with_height(
                                    cx.font_cache().line_height(theme.message.text.font_size),
                                )
                                .aligned()
                                .top()
                                .flex_float()
                                .boxed(),
                            )
                            .boxed(),
                    )
                    .with_children({
                        let style = theme.action_message.style_for(state, false);
                        if let Some(click_message) = click_message {
                            Some(
                                Flex::row()
                                    .with_child(
                                        Text::new(click_message, style.text.clone())
                                            .contained()
                                            .with_style(style.container)
                                            .boxed(),
                                    )
                                    .boxed(),
                            )
                        } else {
                            None
                        }
                        .into_iter()
                    })
                    .contained()
                    .boxed()
            })
            // Since we're not using a proper overlay, we have to capture these extra events
            .on_down(MouseButton::Left, |_, _| {})
            .on_up(MouseButton::Left, |_, _| {})
            .on_click(MouseButton::Left, move |_, cx| {
                if let Some(click_action) = click_action.as_ref() {
                    cx.dispatch_any_action(click_action.boxed_clone());
                    cx.dispatch_action(CancelMessageNotification)
                }
            })
            .with_cursor_style(if has_click_action {
                CursorStyle::PointingHand
            } else {
                CursorStyle::Arrow
            })
            .boxed()
        }
    }

    impl Notification for MessageNotification {
        fn should_dismiss_notification_on_event(&self, event: &<Self as Entity>::Event) -> bool {
            match event {
                MessageNotificationEvent::Dismiss => true,
            }
        }
    }
}

pub trait NotifyResultExt {
    type Ok;

    fn notify_err(
        self,
        workspace: &mut Workspace,
        cx: &mut ViewContext<Workspace>,
    ) -> Option<Self::Ok>;
}

impl<T, E> NotifyResultExt for Result<T, E>
where
    E: std::fmt::Debug,
{
    type Ok = T;

    fn notify_err(self, workspace: &mut Workspace, cx: &mut ViewContext<Workspace>) -> Option<T> {
        match self {
            Ok(value) => Some(value),
            Err(err) => {
                workspace.show_notification(0, cx, |cx| {
                    cx.add_view(|_cx| {
                        simple_message_notification::MessageNotification::new_message(format!(
                            "Error: {:?}",
                            err,
                        ))
                    })
                });

                None
            }
        }
    }
}