zed/crates/editor/src/items.rs

use crate::{Autoscroll, Editor, Event, MultiBuffer, NavigationData, ToOffset, ToPoint as _};
use anyhow::Result;
use gpui::{
    elements::*, AppContext, Entity, ModelContext, ModelHandle, MutableAppContext, RenderContext,
    Subscription, Task, View, ViewContext, ViewHandle, WeakModelHandle,
};
use language::{Bias, Buffer, Diagnostic};
use postage::watch;
use project::worktree::File;
use project::{Project, ProjectEntry, ProjectPath};
use std::rc::Rc;
use std::{fmt::Write, path::PathBuf};
use text::{Point, Selection};
use util::TryFutureExt;
use workspace::{
    ItemHandle, ItemView, ItemViewHandle, NavHistory, PathOpener, Settings, StatusItemView,
    WeakItemHandle, Workspace,
};

pub struct BufferOpener;

#[derive(Clone)]
pub struct BufferItemHandle(pub ModelHandle<Buffer>);

#[derive(Clone)]
struct WeakBufferItemHandle(WeakModelHandle<Buffer>);

impl PathOpener for BufferOpener {
    fn open(
        &self,
        project: &mut Project,
        project_path: ProjectPath,
        cx: &mut ModelContext<Project>,
    ) -> Option<Task<Result<Box<dyn ItemHandle>>>> {
        let buffer = project.open_buffer(project_path, cx);
        let task = cx.spawn(|_, _| async move {
            let buffer = buffer.await?;
            Ok(Box::new(BufferItemHandle(buffer)) as Box<dyn ItemHandle>)
        });
        Some(task)
    }
}

impl ItemHandle for BufferItemHandle {
    fn add_view(
        &self,
        window_id: usize,
        workspace: &Workspace,
        nav_history: Rc<NavHistory>,
        cx: &mut MutableAppContext,
    ) -> Box<dyn ItemViewHandle> {
        let buffer = cx.add_model(|cx| MultiBuffer::singleton(self.0.clone(), cx));
        let weak_buffer = buffer.downgrade();
        Box::new(cx.add_view(window_id, |cx| {
            let mut editor = Editor::for_buffer(
                buffer,
                crate::settings_builder(weak_buffer, workspace.settings()),
                cx,
            );
            editor.nav_history = Some(nav_history);
            editor
        }))
    }

    fn boxed_clone(&self) -> Box<dyn ItemHandle> {
        Box::new(self.clone())
    }

    fn to_any(&self) -> gpui::AnyModelHandle {
        self.0.clone().into()
    }

    fn downgrade(&self) -> Box<dyn workspace::WeakItemHandle> {
        Box::new(WeakBufferItemHandle(self.0.downgrade()))
    }

    fn project_entry(&self, cx: &AppContext) -> Option<ProjectEntry> {
        File::from_dyn(self.0.read(cx).file()).and_then(|f| f.project_entry(cx))
    }

    fn id(&self) -> usize {
        self.0.id()
    }
}

impl WeakItemHandle for WeakBufferItemHandle {
    fn upgrade(&self, cx: &AppContext) -> Option<Box<dyn ItemHandle>> {
        self.0
            .upgrade(cx)
            .map(|buffer| Box::new(BufferItemHandle(buffer)) as Box<dyn ItemHandle>)
    }

    fn id(&self) -> usize {
        self.0.id()
    }
}

impl ItemView for Editor {
    type ItemHandle = BufferItemHandle;

    fn item_handle(&self, cx: &AppContext) -> Self::ItemHandle {
        BufferItemHandle(self.buffer.read(cx).as_singleton().unwrap())
    }

    fn navigate(&mut self, data: Box<dyn std::any::Any>, cx: &mut ViewContext<Self>) {
        if let Some(data) = data.downcast_ref::<NavigationData>() {
            let buffer = self.buffer.read(cx).read(cx);
            let offset = if buffer.can_resolve(&data.anchor) {
                data.anchor.to_offset(&buffer)
            } else {
                buffer.clip_offset(data.offset, Bias::Left)
            };

            drop(buffer);
            let nav_history = self.nav_history.take();
            self.select_ranges([offset..offset], Some(Autoscroll::Fit), cx);
            self.nav_history = nav_history;
        }
    }

    fn title(&self, cx: &AppContext) -> String {
        let filename = self
            .buffer()
            .read(cx)
            .file(cx)
            .and_then(|file| file.file_name());
        if let Some(name) = filename {
            name.to_string_lossy().into()
        } else {
            "untitled".into()
        }
    }

    fn project_entry(&self, cx: &AppContext) -> Option<ProjectEntry> {
        File::from_dyn(self.buffer().read(cx).file(cx)).and_then(|file| file.project_entry(cx))
    }

    fn clone_on_split(&self, cx: &mut ViewContext<Self>) -> Option<Self>
    where
        Self: Sized,
    {
        Some(self.clone(cx))
    }

    fn deactivated(&mut self, cx: &mut ViewContext<Self>) {
        if let Some(selection) = self.newest_selection_internal() {
            self.push_to_nav_history(selection.head(), None, cx);
        }
    }

    fn is_dirty(&self, cx: &AppContext) -> bool {
        self.buffer().read(cx).read(cx).is_dirty()
    }

    fn has_conflict(&self, cx: &AppContext) -> bool {
        self.buffer().read(cx).read(cx).has_conflict()
    }

    fn can_save(&self, cx: &AppContext) -> bool {
        self.project_entry(cx).is_some()
    }

    fn save(&mut self, cx: &mut ViewContext<Self>) -> Result<Task<Result<()>>> {
        let buffer = self.buffer().clone();
        Ok(cx.spawn(|editor, mut cx| async move {
            buffer
                .update(&mut cx, |buffer, cx| buffer.format(cx).log_err())
                .await;
            editor.update(&mut cx, |editor, cx| {
                editor.request_autoscroll(Autoscroll::Fit, cx)
            });
            buffer
                .update(&mut cx, |buffer, cx| buffer.save(cx))?
                .await?;
            Ok(())
        }))
    }

    fn can_save_as(&self, _: &AppContext) -> bool {
        true
    }

    fn save_as(
        &mut self,
        project: ModelHandle<Project>,
        abs_path: PathBuf,
        cx: &mut ViewContext<Self>,
    ) -> Task<Result<()>> {
        let buffer = self
            .buffer()
            .read(cx)
            .as_singleton()
            .expect("cannot call save_as on an excerpt list")
            .clone();

        project.update(cx, |project, cx| {
            project.save_buffer_as(buffer, abs_path, cx)
        })
    }

    fn should_activate_item_on_event(event: &Event) -> bool {
        matches!(event, Event::Activate)
    }

    fn should_close_item_on_event(event: &Event) -> bool {
        matches!(event, Event::Closed)
    }

    fn should_update_tab_on_event(event: &Event) -> bool {
        matches!(
            event,
            Event::Saved | Event::Dirtied | Event::FileHandleChanged
        )
    }
}

pub struct CursorPosition {
    position: Option<Point>,
    selected_count: usize,
    settings: watch::Receiver<Settings>,
    _observe_active_editor: Option<Subscription>,
}

impl CursorPosition {
    pub fn new(settings: watch::Receiver<Settings>) -> Self {
        Self {
            position: None,
            selected_count: 0,
            settings,
            _observe_active_editor: None,
        }
    }

    fn update_position(&mut self, editor: ViewHandle<Editor>, cx: &mut ViewContext<Self>) {
        let editor = editor.read(cx);
        let buffer = editor.buffer().read(cx).snapshot(cx);

        self.selected_count = 0;
        let mut last_selection: Option<Selection<usize>> = None;
        for selection in editor.local_selections::<usize>(cx) {
            self.selected_count += selection.end - selection.start;
            if last_selection
                .as_ref()
                .map_or(true, |last_selection| selection.id > last_selection.id)
            {
                last_selection = Some(selection);
            }
        }
        self.position = last_selection.map(|s| s.head().to_point(&buffer));

        cx.notify();
    }
}

impl Entity for CursorPosition {
    type Event = ();
}

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

    fn render(&mut self, _: &mut RenderContext<Self>) -> ElementBox {
        if let Some(position) = self.position {
            let theme = &self.settings.borrow().theme.workspace.status_bar;
            let mut text = format!("{},{}", position.row + 1, position.column + 1);
            if self.selected_count > 0 {
                write!(text, " ({} selected)", self.selected_count).unwrap();
            }
            Label::new(text, theme.cursor_position.clone()).boxed()
        } else {
            Empty::new().boxed()
        }
    }
}

impl StatusItemView for CursorPosition {
    fn set_active_pane_item(
        &mut self,
        active_pane_item: Option<&dyn ItemViewHandle>,
        cx: &mut ViewContext<Self>,
    ) {
        if let Some(editor) = active_pane_item.and_then(|item| item.to_any().downcast::<Editor>()) {
            self._observe_active_editor = Some(cx.observe(&editor, Self::update_position));
            self.update_position(editor, cx);
        } else {
            self.position = None;
            self._observe_active_editor = None;
        }

        cx.notify();
    }
}

pub struct DiagnosticMessage {
    settings: watch::Receiver<Settings>,
    diagnostic: Option<Diagnostic>,
    _observe_active_editor: Option<Subscription>,
}

impl DiagnosticMessage {
    pub fn new(settings: watch::Receiver<Settings>) -> Self {
        Self {
            diagnostic: None,
            settings,
            _observe_active_editor: None,
        }
    }

    fn update(&mut self, editor: ViewHandle<Editor>, cx: &mut ViewContext<Self>) {
        let editor = editor.read(cx);
        let buffer = editor.buffer().read(cx);
        let cursor_position = editor.newest_selection::<usize>(&buffer.read(cx)).head();
        let new_diagnostic = buffer
            .read(cx)
            .diagnostics_in_range::<_, usize>(cursor_position..cursor_position)
            .filter(|entry| !entry.range.is_empty())
            .min_by_key(|entry| (entry.diagnostic.severity, entry.range.len()))
            .map(|entry| entry.diagnostic);
        if new_diagnostic != self.diagnostic {
            self.diagnostic = new_diagnostic;
            cx.notify();
        }
    }
}

impl Entity for DiagnosticMessage {
    type Event = ();
}

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

    fn render(&mut self, _: &mut RenderContext<Self>) -> ElementBox {
        if let Some(diagnostic) = &self.diagnostic {
            let theme = &self.settings.borrow().theme.workspace.status_bar;
            Flex::row()
                .with_child(
                    Svg::new("icons/warning.svg")
                        .with_color(theme.diagnostic_icon_color)
                        .constrained()
                        .with_height(theme.diagnostic_icon_size)
                        .contained()
                        .with_margin_right(theme.diagnostic_icon_spacing)
                        .boxed(),
                )
                .with_child(
                    Label::new(
                        diagnostic.message.lines().next().unwrap().to_string(),
                        theme.diagnostic_message.clone(),
                    )
                    .boxed(),
                )
                .boxed()
        } else {
            Empty::new().boxed()
        }
    }
}

impl StatusItemView for DiagnosticMessage {
    fn set_active_pane_item(
        &mut self,
        active_pane_item: Option<&dyn ItemViewHandle>,
        cx: &mut ViewContext<Self>,
    ) {
        if let Some(editor) = active_pane_item.and_then(|item| item.to_any().downcast::<Editor>()) {
            self._observe_active_editor = Some(cx.observe(&editor, Self::update));
            self.update(editor, cx);
        } else {
            self.diagnostic = Default::default();
            self._observe_active_editor = None;
        }
        cx.notify();
    }
}