use crate::{ alt, compositor::{self, Component, Compositor, Context, Event, EventResult}, ctrl, job::Callback, key, shift, ui::{ self, document::{render_document, LineDecoration, LinePos, TextRenderer}, EditorView, }, }; use futures_util::{future::BoxFuture, FutureExt}; use nucleo::pattern::CaseMatching; use nucleo::{Config, Nucleo, Utf32String}; use tui::{ buffer::Buffer as Surface, layout::Constraint, text::{Span, Spans}, widgets::{Block, BorderType, Borders, Cell, Table}, }; use tui::widgets::Widget; use std::{ collections::HashMap, io::Read, path::PathBuf, sync::{ atomic::{self, AtomicBool}, Arc, }, }; use crate::ui::{Prompt, PromptEvent}; use helix_core::{ char_idx_at_visual_offset, fuzzy::MATCHER, movement::Direction, text_annotations::TextAnnotations, unicode::segmentation::UnicodeSegmentation, Position, Syntax, }; use helix_view::{ editor::Action, graphics::{CursorKind, Margin, Modifier, Rect}, theme::Style, view::ViewPosition, Document, DocumentId, Editor, }; use super::{menu::Item, overlay::Overlay}; pub const MIN_AREA_WIDTH_FOR_PREVIEW: u16 = 72; /// Biggest file size to preview in bytes pub const MAX_FILE_SIZE_FOR_PREVIEW: u64 = 10 * 1024 * 1024; #[derive(PartialEq, Eq, Hash)] pub enum PathOrId { Id(DocumentId), Path(PathBuf), } impl PathOrId { fn get_canonicalized(self) -> Self { use PathOrId::*; match self { Path(path) => Path(helix_core::path::get_canonicalized_path(&path)), Id(id) => Id(id), } } } impl From for PathOrId { fn from(v: PathBuf) -> Self { Self::Path(v) } } impl From for PathOrId { fn from(v: DocumentId) -> Self { Self::Id(v) } } type FileCallback = Box Option>; /// File path and range of lines (used to align and highlight lines) pub type FileLocation = (PathOrId, Option<(usize, usize)>); pub enum CachedPreview { Document(Box), Binary, LargeFile, NotFound, } // We don't store this enum in the cache so as to avoid lifetime constraints // from borrowing a document already opened in the editor. pub enum Preview<'picker, 'editor> { Cached(&'picker CachedPreview), EditorDocument(&'editor Document), } impl Preview<'_, '_> { fn document(&self) -> Option<&Document> { match self { Preview::EditorDocument(doc) => Some(doc), Preview::Cached(CachedPreview::Document(doc)) => Some(doc), _ => None, } } /// Alternate text to show for the preview. fn placeholder(&self) -> &str { match *self { Self::EditorDocument(_) => "", Self::Cached(preview) => match preview { CachedPreview::Document(_) => "", CachedPreview::Binary => "", CachedPreview::LargeFile => "", CachedPreview::NotFound => "", }, } } } fn item_to_nucleo(item: T, editor_data: &T::Data) -> Option<(T, Utf32String)> { let row = item.format(editor_data); let mut cells = row.cells.iter(); let mut text = String::with_capacity(row.cell_text().map(|cell| cell.len()).sum()); let cell = cells.next()?; if let Some(cell) = cell.content.lines.first() { for span in &cell.0 { text.push_str(&span.content); } } for cell in cells { text.push(' '); if let Some(cell) = cell.content.lines.first() { for span in &cell.0 { text.push_str(&span.content); } } } Some((item, text.into())) } pub struct Injector { dst: nucleo::Injector, editor_data: Arc, shutown: Arc, } impl Clone for Injector { fn clone(&self) -> Self { Injector { dst: self.dst.clone(), editor_data: self.editor_data.clone(), shutown: Arc::new(AtomicBool::new(false)), } } } pub struct InjectorShutdown; impl Injector { pub fn push(&self, item: T) -> Result<(), InjectorShutdown> { if self.shutown.load(atomic::Ordering::Relaxed) { return Err(InjectorShutdown); } if let Some((item, matcher_text)) = item_to_nucleo(item, &self.editor_data) { self.dst.push(item, |dst| dst[0] = matcher_text); } Ok(()) } } pub struct Picker { editor_data: Arc, shutdown: Arc, matcher: Nucleo, /// Current height of the completions box completion_height: u16, cursor: u32, prompt: Prompt, previous_pattern: String, /// Whether to show the preview panel (default true) show_preview: bool, /// Constraints for tabular formatting widths: Vec, callback_fn: PickerCallback, pub truncate_start: bool, /// Caches paths to documents preview_cache: HashMap, read_buffer: Vec, /// Given an item in the picker, return the file path and line number to display. file_fn: Option>, } impl Picker { pub fn stream(editor_data: T::Data) -> (Nucleo, Injector) { let matcher = Nucleo::new( Config::DEFAULT, Arc::new(helix_event::request_redraw), None, 1, ); let streamer = Injector { dst: matcher.injector(), editor_data: Arc::new(editor_data), shutown: Arc::new(AtomicBool::new(false)), }; (matcher, streamer) } pub fn new( options: Vec, editor_data: T::Data, callback_fn: impl Fn(&mut Context, &T, Action) + 'static, ) -> Self { let matcher = Nucleo::new( Config::DEFAULT, Arc::new(helix_event::request_redraw), None, 1, ); let injector = matcher.injector(); for item in options { if let Some((item, matcher_text)) = item_to_nucleo(item, &editor_data) { injector.push(item, |dst| dst[0] = matcher_text); } } Self::with( matcher, Arc::new(editor_data), Arc::new(AtomicBool::new(false)), callback_fn, ) } pub fn with_stream( matcher: Nucleo, injector: Injector, callback_fn: impl Fn(&mut Context, &T, Action) + 'static, ) -> Self { Self::with(matcher, injector.editor_data, injector.shutown, callback_fn) } fn with( matcher: Nucleo, editor_data: Arc, shutdown: Arc, callback_fn: impl Fn(&mut Context, &T, Action) + 'static, ) -> Self { let prompt = Prompt::new( "".into(), None, ui::completers::none, |_editor: &mut Context, _pattern: &str, _event: PromptEvent| {}, ); Self { matcher, editor_data, shutdown, cursor: 0, prompt, previous_pattern: String::new(), truncate_start: true, show_preview: true, callback_fn: Box::new(callback_fn), completion_height: 0, widths: Vec::new(), preview_cache: HashMap::new(), read_buffer: Vec::with_capacity(1024), file_fn: None, } } pub fn injector(&self) -> Injector { Injector { dst: self.matcher.injector(), editor_data: self.editor_data.clone(), shutown: self.shutdown.clone(), } } pub fn truncate_start(mut self, truncate_start: bool) -> Self { self.truncate_start = truncate_start; self } pub fn with_preview( mut self, preview_fn: impl Fn(&Editor, &T) -> Option + 'static, ) -> Self { self.file_fn = Some(Box::new(preview_fn)); // assumption: if we have a preview we are matching paths... If this is ever // not true this could be a separate builder function self.matcher.update_config(Config::DEFAULT.match_paths()); self } pub fn set_options(&mut self, new_options: Vec) { self.matcher.restart(false); let injector = self.matcher.injector(); for item in new_options { if let Some((item, matcher_text)) = item_to_nucleo(item, &self.editor_data) { injector.push(item, |dst| dst[0] = matcher_text); } } } /// Move the cursor by a number of lines, either down (`Forward`) or up (`Backward`) pub fn move_by(&mut self, amount: u32, direction: Direction) { let len = self.matcher.snapshot().matched_item_count(); if len == 0 { // No results, can't move. return; } match direction { Direction::Forward => { self.cursor = self.cursor.saturating_add(amount) % len; } Direction::Backward => { self.cursor = self.cursor.saturating_add(len).saturating_sub(amount) % len; } } } /// Move the cursor down by exactly one page. After the last page comes the first page. pub fn page_up(&mut self) { self.move_by(self.completion_height as u32, Direction::Backward); } /// Move the cursor up by exactly one page. After the first page comes the last page. pub fn page_down(&mut self) { self.move_by(self.completion_height as u32, Direction::Forward); } /// Move the cursor to the first entry pub fn to_start(&mut self) { self.cursor = 0; } /// Move the cursor to the last entry pub fn to_end(&mut self) { self.cursor = self .matcher .snapshot() .matched_item_count() .saturating_sub(1); } pub fn selection(&self) -> Option<&T> { self.matcher .snapshot() .get_matched_item(self.cursor) .map(|item| item.data) } pub fn toggle_preview(&mut self) { self.show_preview = !self.show_preview; } fn prompt_handle_event(&mut self, event: &Event, cx: &mut Context) -> EventResult { if let EventResult::Consumed(_) = self.prompt.handle_event(event, cx) { let pattern = self.prompt.line(); // TODO: better track how the pattern has changed if pattern != &self.previous_pattern { self.matcher.pattern.reparse( 0, pattern, CaseMatching::Smart, pattern.starts_with(&self.previous_pattern), ); self.previous_pattern = pattern.clone(); } } EventResult::Consumed(None) } fn current_file(&self, editor: &Editor) -> Option { self.selection() .and_then(|current| (self.file_fn.as_ref()?)(editor, current)) .map(|(path_or_id, line)| (path_or_id.get_canonicalized(), line)) } /// Get (cached) preview for a given path. If a document corresponding /// to the path is already open in the editor, it is used instead. fn get_preview<'picker, 'editor>( &'picker mut self, path_or_id: PathOrId, editor: &'editor Editor, ) -> Preview<'picker, 'editor> { match path_or_id { PathOrId::Path(path) => { let path = &path; if let Some(doc) = editor.document_by_path(path) { return Preview::EditorDocument(doc); } if self.preview_cache.contains_key(path) { return Preview::Cached(&self.preview_cache[path]); } let data = std::fs::File::open(path).and_then(|file| { let metadata = file.metadata()?; // Read up to 1kb to detect the content type let n = file.take(1024).read_to_end(&mut self.read_buffer)?; let content_type = content_inspector::inspect(&self.read_buffer[..n]); self.read_buffer.clear(); Ok((metadata, content_type)) }); let preview = data .map( |(metadata, content_type)| match (metadata.len(), content_type) { (_, content_inspector::ContentType::BINARY) => CachedPreview::Binary, (size, _) if size > MAX_FILE_SIZE_FOR_PREVIEW => { CachedPreview::LargeFile } _ => Document::open(path, None, None, editor.config.clone()) .map(|doc| CachedPreview::Document(Box::new(doc))) .unwrap_or(CachedPreview::NotFound), }, ) .unwrap_or(CachedPreview::NotFound); self.preview_cache.insert(path.to_owned(), preview); Preview::Cached(&self.preview_cache[path]) } PathOrId::Id(id) => { let doc = editor.documents.get(&id).unwrap(); Preview::EditorDocument(doc) } } } fn handle_idle_timeout(&mut self, cx: &mut Context) -> EventResult { let Some((current_file, _)) = self.current_file(cx.editor) else { return EventResult::Consumed(None); }; // Try to find a document in the cache let doc = match ¤t_file { PathOrId::Id(doc_id) => doc_mut!(cx.editor, doc_id), PathOrId::Path(path) => match self.preview_cache.get_mut(path) { Some(CachedPreview::Document(ref mut doc)) => doc, _ => return EventResult::Consumed(None), }, }; let mut callback: Option = None; // Then attempt to highlight it if it has no language set if doc.language_config().is_none() { if let Some(language_config) = doc.detect_language_config(&cx.editor.syn_loader) { doc.language = Some(language_config.clone()); let text = doc.text().clone(); let loader = cx.editor.syn_loader.clone(); let job = tokio::task::spawn_blocking(move || { let syntax = language_config.highlight_config(&loader.scopes()).and_then( |highlight_config| Syntax::new(text.slice(..), highlight_config, loader), ); let callback = move |editor: &mut Editor, compositor: &mut Compositor| { let Some(syntax) = syntax else { log::info!("highlighting picker item failed"); return; }; let Some(Overlay { content: picker, .. }) = compositor.find::>() else { log::info!("picker closed before syntax highlighting finished"); return; }; // Try to find a document in the cache let doc = match current_file { PathOrId::Id(doc_id) => doc_mut!(editor, &doc_id), PathOrId::Path(path) => match picker.preview_cache.get_mut(&path) { Some(CachedPreview::Document(ref mut doc)) => doc, _ => return, }, }; doc.syntax = Some(syntax); }; Callback::EditorCompositor(Box::new(callback)) }); let tmp: compositor::Callback = Box::new(move |_, ctx| { ctx.jobs .callback(job.map(|res| res.map_err(anyhow::Error::from))) }); callback = Some(Box::new(tmp)) } } // QUESTION: do we want to compute inlay hints in pickers too ? Probably not for now // but it could be interesting in the future EventResult::Consumed(callback) } fn render_picker(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) { let status = self.matcher.tick(10); let snapshot = self.matcher.snapshot(); if status.changed { self.cursor = self .cursor .min(snapshot.matched_item_count().saturating_sub(1)) } let text_style = cx.editor.theme.get("ui.text"); let selected = cx.editor.theme.get("ui.text.focus"); let highlight_style = cx.editor.theme.get("special").add_modifier(Modifier::BOLD); // -- Render the frame: // clear area let background = cx.editor.theme.get("ui.background"); surface.clear_with(area, background); // don't like this but the lifetime sucks let block = Block::default().borders(Borders::ALL); // calculate the inner area inside the box let inner = block.inner(area); block.render(area, surface); // -- Render the input bar: let area = inner.clip_left(1).with_height(1); // render the prompt first since it will clear its background self.prompt.render(area, surface, cx); let count = format!( "{}{}/{}", if status.running { "(running) " } else { "" }, snapshot.matched_item_count(), snapshot.item_count(), ); surface.set_stringn( (area.x + area.width).saturating_sub(count.len() as u16 + 1), area.y, &count, (count.len()).min(area.width as usize), text_style, ); // -- Separator let sep_style = cx.editor.theme.get("ui.background.separator"); let borders = BorderType::line_symbols(BorderType::Plain); for x in inner.left()..inner.right() { if let Some(cell) = surface.get_mut(x, inner.y + 1) { cell.set_symbol(borders.horizontal).set_style(sep_style); } } // -- Render the contents: // subtract area of prompt from top let inner = inner.clip_top(2); let rows = inner.height as u32; let offset = self.cursor - (self.cursor % std::cmp::max(1, rows)); let cursor = self.cursor.saturating_sub(offset); let end = offset .saturating_add(rows) .min(snapshot.matched_item_count()); let mut indices = Vec::new(); let mut matcher = MATCHER.lock(); matcher.config = Config::DEFAULT; if self.file_fn.is_some() { matcher.config.set_match_paths() } let options = snapshot.matched_items(offset..end).map(|item| { snapshot.pattern().column_pattern(0).indices( item.matcher_columns[0].slice(..), &mut matcher, &mut indices, ); indices.sort_unstable(); indices.dedup(); let mut row = item.data.format(&self.editor_data); let mut grapheme_idx = 0u32; let mut indices = indices.drain(..); let mut next_highlight_idx = indices.next().unwrap_or(u32::MAX); if self.widths.len() < row.cells.len() { self.widths.resize(row.cells.len(), Constraint::Length(0)); } let mut widths = self.widths.iter_mut(); for cell in &mut row.cells { let Some(Constraint::Length(max_width)) = widths.next() else { unreachable!(); }; // merge index highlights on top of existing hightlights let mut span_list = Vec::new(); let mut current_span = String::new(); let mut current_style = Style::default(); let mut width = 0; let spans: &[Span] = cell.content.lines.first().map_or(&[], |it| it.0.as_slice()); for span in spans { // this looks like a bug on first glance, we are iterating // graphemes but treating them as char indices. The reason that // this is correct is that nucleo will only ever consider the first char // of a grapheme (and discard the rest of the grapheme) so the indices // returned by nucleo are essentially grapheme indecies for grapheme in span.content.graphemes(true) { let style = if grapheme_idx == next_highlight_idx { next_highlight_idx = indices.next().unwrap_or(u32::MAX); span.style.patch(highlight_style) } else { span.style }; if style != current_style { if !current_span.is_empty() { span_list.push(Span::styled(current_span, current_style)) } current_span = String::new(); current_style = style; } current_span.push_str(grapheme); grapheme_idx += 1; } width += span.width(); } span_list.push(Span::styled(current_span, current_style)); if width as u16 > *max_width { *max_width = width as u16; } *cell = Cell::from(Spans::from(span_list)); // spacer if grapheme_idx == next_highlight_idx { next_highlight_idx = indices.next().unwrap_or(u32::MAX); } grapheme_idx += 1; } row }); let table = Table::new(options) .style(text_style) .highlight_style(selected) .highlight_symbol(" > ") .column_spacing(1) .widths(&self.widths); use tui::widgets::TableState; table.render_table( inner, surface, &mut TableState { offset: 0, selected: Some(cursor as usize), }, self.truncate_start, ); } fn render_preview(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) { // -- Render the frame: // clear area let background = cx.editor.theme.get("ui.background"); let text = cx.editor.theme.get("ui.text"); surface.clear_with(area, background); // don't like this but the lifetime sucks let block = Block::default().borders(Borders::ALL); // calculate the inner area inside the box let inner = block.inner(area); // 1 column gap on either side let margin = Margin::horizontal(1); let inner = inner.inner(&margin); block.render(area, surface); if let Some((path, range)) = self.current_file(cx.editor) { let preview = self.get_preview(path, cx.editor); let doc = match preview.document() { Some(doc) => doc, None => { let alt_text = preview.placeholder(); let x = inner.x + inner.width.saturating_sub(alt_text.len() as u16) / 2; let y = inner.y + inner.height / 2; surface.set_stringn(x, y, alt_text, inner.width as usize, text); return; } }; let mut offset = ViewPosition::default(); if let Some(range) = range { let text_fmt = doc.text_format(inner.width, None); let annotations = TextAnnotations::default(); (offset.anchor, offset.vertical_offset) = char_idx_at_visual_offset( doc.text().slice(..), doc.text().line_to_char(range.0), // align to middle -(inner.height as isize / 2), 0, &text_fmt, &annotations, ); } let mut highlights = EditorView::doc_syntax_highlights( doc, offset.anchor, area.height, &cx.editor.theme, ); for spans in EditorView::doc_diagnostics_highlights(doc, &cx.editor.theme) { if spans.is_empty() { continue; } highlights = Box::new(helix_core::syntax::merge(highlights, spans)); } let mut decorations: Vec> = Vec::new(); if let Some((start, end)) = range { let style = cx .editor .theme .try_get("ui.highlight") .unwrap_or_else(|| cx.editor.theme.get("ui.selection")); let draw_highlight = move |renderer: &mut TextRenderer, pos: LinePos| { if (start..=end).contains(&pos.doc_line) { let area = Rect::new( renderer.viewport.x, renderer.viewport.y + pos.visual_line, renderer.viewport.width, 1, ); renderer.surface.set_style(area, style) } }; decorations.push(Box::new(draw_highlight)) } render_document( surface, inner, doc, offset, // TODO: compute text annotations asynchronously here (like inlay hints) &TextAnnotations::default(), highlights, &cx.editor.theme, &mut decorations, &mut [], ); } } } impl Component for Picker { fn render(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) { // +---------+ +---------+ // |prompt | |preview | // +---------+ | | // |picker | | | // | | | | // +---------+ +---------+ let render_preview = self.show_preview && area.width > MIN_AREA_WIDTH_FOR_PREVIEW; let picker_width = if render_preview { area.width / 2 } else { area.width }; let picker_area = area.with_width(picker_width); self.render_picker(picker_area, surface, cx); if render_preview { let preview_area = area.clip_left(picker_width); self.render_preview(preview_area, surface, cx); } } fn handle_event(&mut self, event: &Event, ctx: &mut Context) -> EventResult { if let Event::IdleTimeout = event { return self.handle_idle_timeout(ctx); } // TODO: keybinds for scrolling preview let key_event = match event { Event::Key(event) => *event, Event::Paste(..) => return self.prompt_handle_event(event, ctx), Event::Resize(..) => return EventResult::Consumed(None), _ => return EventResult::Ignored(None), }; let close_fn = EventResult::Consumed(Some(Box::new(|compositor: &mut Compositor, _ctx| { // remove the layer compositor.last_picker = compositor.pop(); }))); // So that idle timeout retriggers ctx.editor.reset_idle_timer(); match key_event { shift!(Tab) | key!(Up) | ctrl!('p') => { self.move_by(1, Direction::Backward); } key!(Tab) | key!(Down) | ctrl!('n') => { self.move_by(1, Direction::Forward); } key!(PageDown) | ctrl!('d') => { self.page_down(); } key!(PageUp) | ctrl!('u') => { self.page_up(); } key!(Home) => { self.to_start(); } key!(End) => { self.to_end(); } key!(Esc) | ctrl!('c') => { return close_fn; } alt!(Enter) => { if let Some(option) = self.selection() { (self.callback_fn)(ctx, option, Action::Load); } } key!(Enter) => { if let Some(option) = self.selection() { (self.callback_fn)(ctx, option, Action::Replace); } return close_fn; } ctrl!('s') => { if let Some(option) = self.selection() { (self.callback_fn)(ctx, option, Action::HorizontalSplit); } return close_fn; } ctrl!('v') => { if let Some(option) = self.selection() { (self.callback_fn)(ctx, option, Action::VerticalSplit); } return close_fn; } ctrl!('t') => { self.toggle_preview(); } _ => { self.prompt_handle_event(event, ctx); } } EventResult::Consumed(None) } fn cursor(&self, area: Rect, editor: &Editor) -> (Option, CursorKind) { let block = Block::default().borders(Borders::ALL); // calculate the inner area inside the box let inner = block.inner(area); // prompt area let area = inner.clip_left(1).with_height(1); self.prompt.cursor(area, editor) } fn required_size(&mut self, (width, height): (u16, u16)) -> Option<(u16, u16)> { self.completion_height = height.saturating_sub(4); Some((width, height)) } } impl Drop for Picker { fn drop(&mut self) { // ensure we cancel any ongoing background threads streaming into the picker self.shutdown.store(true, atomic::Ordering::Relaxed) } } type PickerCallback = Box; /// Returns a new list of options to replace the contents of the picker /// when called with the current picker query, pub type DynQueryCallback = Box BoxFuture<'static, anyhow::Result>>>; /// A picker that updates its contents via a callback whenever the /// query string changes. Useful for live grep, workspace symbols, etc. pub struct DynamicPicker { file_picker: Picker, query_callback: DynQueryCallback, query: String, } impl DynamicPicker { pub const ID: &'static str = "dynamic-picker"; pub fn new(file_picker: Picker, query_callback: DynQueryCallback) -> Self { Self { file_picker, query_callback, query: String::new(), } } } impl Component for DynamicPicker { fn render(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) { self.file_picker.render(area, surface, cx); } fn handle_event(&mut self, event: &Event, cx: &mut Context) -> EventResult { let event_result = self.file_picker.handle_event(event, cx); let current_query = self.file_picker.prompt.line(); if !matches!(event, Event::IdleTimeout) || self.query == *current_query { return event_result; } self.query.clone_from(current_query); let new_options = (self.query_callback)(current_query.to_owned(), cx.editor); cx.jobs.callback(async move { let new_options = new_options.await?; let callback = Callback::EditorCompositor(Box::new(move |editor, compositor| { // Wrapping of pickers in overlay is done outside the picker code, // so this is fragile and will break if wrapped in some other widget. let picker = match compositor.find_id::>>(Self::ID) { Some(overlay) => &mut overlay.content.file_picker, None => return, }; picker.set_options(new_options); editor.reset_idle_timer(); })); anyhow::Ok(callback) }); EventResult::Consumed(None) } fn cursor(&self, area: Rect, ctx: &Editor) -> (Option, CursorKind) { self.file_picker.cursor(area, ctx) } fn required_size(&mut self, viewport: (u16, u16)) -> Option<(u16, u16)> { self.file_picker.required_size(viewport) } fn id(&self) -> Option<&'static str> { Some(Self::ID) } }