7961355ba1
Fixes #323. Due to terminal limitations we can only change the shape of the primary cursor.
650 lines
21 KiB
Rust
650 lines
21 KiB
Rust
use crate::{
|
|
clipboard::{get_clipboard_provider, ClipboardProvider},
|
|
document::{Mode, SCRATCH_BUFFER_NAME},
|
|
graphics::{CursorKind, Rect},
|
|
theme::{self, Theme},
|
|
tree::{self, Tree},
|
|
Document, DocumentId, View, ViewId,
|
|
};
|
|
|
|
use futures_util::future;
|
|
use std::{
|
|
collections::{BTreeMap, HashMap},
|
|
io::stdin,
|
|
path::{Path, PathBuf},
|
|
pin::Pin,
|
|
sync::Arc,
|
|
};
|
|
|
|
use tokio::time::{sleep, Duration, Instant, Sleep};
|
|
|
|
use anyhow::Error;
|
|
|
|
pub use helix_core::diagnostic::Severity;
|
|
pub use helix_core::register::Registers;
|
|
use helix_core::{hashmap, syntax};
|
|
use helix_core::{Position, Selection};
|
|
|
|
use serde::Deserialize;
|
|
|
|
fn deserialize_duration_millis<'de, D>(deserializer: D) -> Result<Duration, D::Error>
|
|
where
|
|
D: serde::Deserializer<'de>,
|
|
{
|
|
let millis = u64::deserialize(deserializer)?;
|
|
Ok(Duration::from_millis(millis))
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Deserialize)]
|
|
#[serde(rename_all = "kebab-case", default, deny_unknown_fields)]
|
|
pub struct FilePickerConfig {
|
|
/// IgnoreOptions
|
|
/// Enables ignoring hidden files.
|
|
/// Whether to hide hidden files in file picker and global search results. Defaults to true.
|
|
pub hidden: bool,
|
|
/// Enables reading ignore files from parent directories. Defaults to true.
|
|
pub parents: bool,
|
|
/// Enables reading `.ignore` files.
|
|
/// Whether to hide files listed in .ignore in file picker and global search results. Defaults to true.
|
|
pub ignore: bool,
|
|
/// Enables reading `.gitignore` files.
|
|
/// Whether to hide files listed in .gitignore in file picker and global search results. Defaults to true.
|
|
pub git_ignore: bool,
|
|
/// Enables reading global .gitignore, whose path is specified in git's config: `core.excludefile` option.
|
|
/// Whether to hide files listed in global .gitignore in file picker and global search results. Defaults to true.
|
|
pub git_global: bool,
|
|
/// Enables reading `.git/info/exclude` files.
|
|
/// Whether to hide files listed in .git/info/exclude in file picker and global search results. Defaults to true.
|
|
pub git_exclude: bool,
|
|
/// WalkBuilder options
|
|
/// Maximum Depth to recurse directories in file picker and global search. Defaults to `None`.
|
|
pub max_depth: Option<usize>,
|
|
}
|
|
|
|
impl Default for FilePickerConfig {
|
|
fn default() -> Self {
|
|
Self {
|
|
hidden: true,
|
|
parents: true,
|
|
ignore: true,
|
|
git_ignore: true,
|
|
git_global: true,
|
|
git_exclude: true,
|
|
max_depth: None,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Deserialize)]
|
|
#[serde(rename_all = "kebab-case", default, deny_unknown_fields)]
|
|
pub struct Config {
|
|
/// Padding to keep between the edge of the screen and the cursor when scrolling. Defaults to 5.
|
|
pub scrolloff: usize,
|
|
/// Number of lines to scroll at once. Defaults to 3
|
|
pub scroll_lines: isize,
|
|
/// Mouse support. Defaults to true.
|
|
pub mouse: bool,
|
|
/// Shell to use for shell commands. Defaults to ["cmd", "/C"] on Windows and ["sh", "-c"] otherwise.
|
|
pub shell: Vec<String>,
|
|
/// Line number mode.
|
|
pub line_number: LineNumber,
|
|
/// Middle click paste support. Defaults to true.
|
|
pub middle_click_paste: bool,
|
|
/// Smart case: Case insensitive searching unless pattern contains upper case characters. Defaults to true.
|
|
pub smart_case: bool,
|
|
/// Automatic insertion of pairs to parentheses, brackets, etc. Defaults to true.
|
|
pub auto_pairs: bool,
|
|
/// Automatic auto-completion, automatically pop up without user trigger. Defaults to true.
|
|
pub auto_completion: bool,
|
|
/// Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. Defaults to 400ms.
|
|
#[serde(skip_serializing, deserialize_with = "deserialize_duration_millis")]
|
|
pub idle_timeout: Duration,
|
|
pub completion_trigger_len: u8,
|
|
/// Whether to display infoboxes. Defaults to true.
|
|
pub auto_info: bool,
|
|
pub file_picker: FilePickerConfig,
|
|
/// Shape for cursor in each mode
|
|
pub cursor_shape: CursorShapeConfig,
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Deserialize)]
|
|
#[serde(transparent)]
|
|
pub struct CursorShapeConfig(HashMap<Mode, CursorKind>);
|
|
|
|
impl std::ops::Deref for CursorShapeConfig {
|
|
type Target = HashMap<Mode, CursorKind>;
|
|
|
|
fn deref(&self) -> &Self::Target {
|
|
&self.0
|
|
}
|
|
}
|
|
|
|
impl Default for CursorShapeConfig {
|
|
fn default() -> Self {
|
|
Self(hashmap!(
|
|
Mode::Insert => CursorKind::Bar,
|
|
Mode::Normal => CursorKind::Block,
|
|
Mode::Select => CursorKind::Underline,
|
|
))
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
|
|
#[serde(rename_all = "kebab-case")]
|
|
pub enum LineNumber {
|
|
/// Show absolute line number
|
|
Absolute,
|
|
/// Show relative line number to the primary cursor
|
|
Relative,
|
|
}
|
|
|
|
impl Default for Config {
|
|
fn default() -> Self {
|
|
Self {
|
|
scrolloff: 5,
|
|
scroll_lines: 3,
|
|
mouse: true,
|
|
shell: if cfg!(windows) {
|
|
vec!["cmd".to_owned(), "/C".to_owned()]
|
|
} else {
|
|
vec!["sh".to_owned(), "-c".to_owned()]
|
|
},
|
|
line_number: LineNumber::Absolute,
|
|
middle_click_paste: true,
|
|
smart_case: true,
|
|
auto_pairs: true,
|
|
auto_completion: true,
|
|
idle_timeout: Duration::from_millis(400),
|
|
completion_trigger_len: 2,
|
|
auto_info: true,
|
|
file_picker: FilePickerConfig::default(),
|
|
cursor_shape: CursorShapeConfig::default(),
|
|
}
|
|
}
|
|
}
|
|
|
|
pub struct Motion(pub Box<dyn Fn(&mut Editor)>);
|
|
impl Motion {
|
|
pub fn run(&self, e: &mut Editor) {
|
|
(self.0)(e)
|
|
}
|
|
}
|
|
impl std::fmt::Debug for Motion {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
f.write_str("motion")
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub struct Editor {
|
|
pub tree: Tree,
|
|
pub next_document_id: usize,
|
|
pub documents: BTreeMap<DocumentId, Document>,
|
|
pub count: Option<std::num::NonZeroUsize>,
|
|
pub selected_register: Option<char>,
|
|
pub registers: Registers,
|
|
pub theme: Theme,
|
|
pub language_servers: helix_lsp::Registry,
|
|
pub clipboard_provider: Box<dyn ClipboardProvider>,
|
|
|
|
pub syn_loader: Arc<syntax::Loader>,
|
|
pub theme_loader: Arc<theme::Loader>,
|
|
|
|
pub status_msg: Option<(String, Severity)>,
|
|
|
|
pub config: Config,
|
|
|
|
pub idle_timer: Pin<Box<Sleep>>,
|
|
pub last_motion: Option<Motion>,
|
|
|
|
pub exit_code: i32,
|
|
}
|
|
|
|
#[derive(Debug, Copy, Clone)]
|
|
pub enum Action {
|
|
Load,
|
|
Replace,
|
|
HorizontalSplit,
|
|
VerticalSplit,
|
|
}
|
|
|
|
impl Editor {
|
|
pub fn new(
|
|
mut area: Rect,
|
|
themes: Arc<theme::Loader>,
|
|
config_loader: Arc<syntax::Loader>,
|
|
config: Config,
|
|
) -> Self {
|
|
let language_servers = helix_lsp::Registry::new();
|
|
|
|
// HAXX: offset the render area height by 1 to account for prompt/commandline
|
|
area.height -= 1;
|
|
|
|
Self {
|
|
tree: Tree::new(area),
|
|
next_document_id: 0,
|
|
documents: BTreeMap::new(),
|
|
count: None,
|
|
selected_register: None,
|
|
theme: themes.default(),
|
|
language_servers,
|
|
syn_loader: config_loader,
|
|
theme_loader: themes,
|
|
registers: Registers::default(),
|
|
clipboard_provider: get_clipboard_provider(),
|
|
status_msg: None,
|
|
idle_timer: Box::pin(sleep(config.idle_timeout)),
|
|
last_motion: None,
|
|
config,
|
|
exit_code: 0,
|
|
}
|
|
}
|
|
|
|
pub fn clear_idle_timer(&mut self) {
|
|
// equivalent to internal Instant::far_future() (30 years)
|
|
self.idle_timer
|
|
.as_mut()
|
|
.reset(Instant::now() + Duration::from_secs(86400 * 365 * 30));
|
|
}
|
|
|
|
pub fn reset_idle_timer(&mut self) {
|
|
self.idle_timer
|
|
.as_mut()
|
|
.reset(Instant::now() + self.config.idle_timeout);
|
|
}
|
|
|
|
pub fn clear_status(&mut self) {
|
|
self.status_msg = None;
|
|
}
|
|
|
|
pub fn set_status(&mut self, status: String) {
|
|
self.status_msg = Some((status, Severity::Info));
|
|
}
|
|
|
|
pub fn set_error(&mut self, error: String) {
|
|
self.status_msg = Some((error, Severity::Error));
|
|
}
|
|
|
|
pub fn set_theme(&mut self, theme: Theme) {
|
|
// `ui.selection` is the only scope required to be able to render a theme.
|
|
if theme.find_scope_index("ui.selection").is_none() {
|
|
self.set_error("Invalid theme: `ui.selection` required".to_owned());
|
|
return;
|
|
}
|
|
|
|
let scopes = theme.scopes();
|
|
for config in self
|
|
.syn_loader
|
|
.language_configs_iter()
|
|
.filter(|cfg| cfg.is_highlight_initialized())
|
|
{
|
|
config.reconfigure(scopes);
|
|
}
|
|
|
|
self.theme = theme;
|
|
self._refresh();
|
|
}
|
|
|
|
pub fn set_theme_from_name(&mut self, theme: &str) -> anyhow::Result<()> {
|
|
use anyhow::Context;
|
|
let theme = self
|
|
.theme_loader
|
|
.load(theme.as_ref())
|
|
.with_context(|| format!("failed setting theme `{}`", theme))?;
|
|
self.set_theme(theme);
|
|
Ok(())
|
|
}
|
|
|
|
fn _refresh(&mut self) {
|
|
for (view, _) in self.tree.views_mut() {
|
|
let doc = &self.documents[&view.doc];
|
|
view.ensure_cursor_in_view(doc, self.config.scrolloff)
|
|
}
|
|
}
|
|
|
|
fn replace_document_in_view(&mut self, current_view: ViewId, doc_id: DocumentId) {
|
|
let view = self.tree.get_mut(current_view);
|
|
view.doc = doc_id;
|
|
view.offset = Position::default();
|
|
|
|
let doc = self.documents.get_mut(&doc_id).unwrap();
|
|
|
|
// initialize selection for view
|
|
doc.selections
|
|
.entry(view.id)
|
|
.or_insert_with(|| Selection::point(0));
|
|
// TODO: reuse align_view
|
|
let pos = doc
|
|
.selection(view.id)
|
|
.primary()
|
|
.cursor(doc.text().slice(..));
|
|
let line = doc.text().char_to_line(pos);
|
|
view.offset.row = line.saturating_sub(view.inner_area().height as usize / 2);
|
|
}
|
|
|
|
pub fn switch(&mut self, id: DocumentId, action: Action) {
|
|
use crate::tree::Layout;
|
|
|
|
if !self.documents.contains_key(&id) {
|
|
log::error!("cannot switch to document that does not exist (anymore)");
|
|
return;
|
|
}
|
|
|
|
match action {
|
|
Action::Replace => {
|
|
let (view, doc) = current_ref!(self);
|
|
// If the current view is an empty scratch buffer and is not displayed in any other views, delete it.
|
|
// Boolean value is determined before the call to `view_mut` because the operation requires a borrow
|
|
// of `self.tree`, which is mutably borrowed when `view_mut` is called.
|
|
let remove_empty_scratch = !doc.is_modified()
|
|
// If the buffer has no path and is not modified, it is an empty scratch buffer.
|
|
&& doc.path().is_none()
|
|
// If the buffer we are changing to is not this buffer
|
|
&& id != doc.id
|
|
// Ensure the buffer is not displayed in any other splits.
|
|
&& !self
|
|
.tree
|
|
.traverse()
|
|
.any(|(_, v)| v.doc == doc.id && v.id != view.id);
|
|
let view = view_mut!(self);
|
|
if remove_empty_scratch {
|
|
// Copy `doc.id` into a variable before calling `self.documents.remove`, which requires a mutable
|
|
// borrow, invalidating direct access to `doc.id`.
|
|
let id = doc.id;
|
|
self.documents.remove(&id);
|
|
} else {
|
|
let jump = (view.doc, doc.selection(view.id).clone());
|
|
view.jumps.push(jump);
|
|
view.last_accessed_doc = Some(view.doc);
|
|
}
|
|
|
|
let view_id = view.id;
|
|
self.replace_document_in_view(view_id, id);
|
|
|
|
return;
|
|
}
|
|
Action::Load => {
|
|
let view_id = view!(self).id;
|
|
if let Some(doc) = self.document_mut(id) {
|
|
if doc.selections().is_empty() {
|
|
doc.selections.insert(view_id, Selection::point(0));
|
|
}
|
|
}
|
|
return;
|
|
}
|
|
Action::HorizontalSplit => {
|
|
let view = View::new(id);
|
|
let view_id = self.tree.split(view, Layout::Horizontal);
|
|
// initialize selection for view
|
|
let doc = self.documents.get_mut(&id).unwrap();
|
|
doc.selections.insert(view_id, Selection::point(0));
|
|
}
|
|
Action::VerticalSplit => {
|
|
let view = View::new(id);
|
|
let view_id = self.tree.split(view, Layout::Vertical);
|
|
// initialize selection for view
|
|
let doc = self.documents.get_mut(&id).unwrap();
|
|
doc.selections.insert(view_id, Selection::point(0));
|
|
}
|
|
}
|
|
|
|
self._refresh();
|
|
}
|
|
|
|
fn new_document(&mut self, mut document: Document) -> DocumentId {
|
|
let id = DocumentId(self.next_document_id);
|
|
self.next_document_id += 1;
|
|
document.id = id;
|
|
self.documents.insert(id, document);
|
|
id
|
|
}
|
|
|
|
fn new_file_from_document(&mut self, action: Action, document: Document) -> DocumentId {
|
|
let id = self.new_document(document);
|
|
self.switch(id, action);
|
|
id
|
|
}
|
|
|
|
pub fn new_file(&mut self, action: Action) -> DocumentId {
|
|
self.new_file_from_document(action, Document::default())
|
|
}
|
|
|
|
pub fn new_file_from_stdin(&mut self, action: Action) -> Result<DocumentId, Error> {
|
|
let (rope, encoding) = crate::document::from_reader(&mut stdin(), None)?;
|
|
Ok(self.new_file_from_document(action, Document::from(rope, Some(encoding))))
|
|
}
|
|
|
|
pub fn open(&mut self, path: PathBuf, action: Action) -> Result<DocumentId, Error> {
|
|
let path = helix_core::path::get_canonicalized_path(&path)?;
|
|
|
|
let id = self
|
|
.documents()
|
|
.find(|doc| doc.path() == Some(&path))
|
|
.map(|doc| doc.id);
|
|
|
|
let id = if let Some(id) = id {
|
|
id
|
|
} else {
|
|
let mut doc = Document::open(&path, None, Some(&self.theme), Some(&self.syn_loader))?;
|
|
|
|
// try to find a language server based on the language name
|
|
let language_server = doc.language.as_ref().and_then(|language| {
|
|
self.language_servers
|
|
.get(language)
|
|
.map_err(|e| {
|
|
log::error!(
|
|
"Failed to initialize the LSP for `{}` {{ {} }}",
|
|
language.scope(),
|
|
e
|
|
)
|
|
})
|
|
.ok()
|
|
});
|
|
|
|
if let Some(language_server) = language_server {
|
|
let language_id = doc
|
|
.language()
|
|
.and_then(|s| s.split('.').last()) // source.rust
|
|
.map(ToOwned::to_owned)
|
|
.unwrap_or_default();
|
|
|
|
// TODO: this now races with on_init code if the init happens too quickly
|
|
tokio::spawn(language_server.text_document_did_open(
|
|
doc.url().unwrap(),
|
|
doc.version(),
|
|
doc.text(),
|
|
language_id,
|
|
));
|
|
|
|
doc.set_language_server(Some(language_server));
|
|
}
|
|
|
|
let id = DocumentId(self.next_document_id);
|
|
self.next_document_id += 1;
|
|
doc.id = id;
|
|
self.documents.insert(id, doc);
|
|
id
|
|
};
|
|
|
|
self.switch(id, action);
|
|
Ok(id)
|
|
}
|
|
|
|
pub fn close(&mut self, id: ViewId) {
|
|
let view = self.tree.get(self.tree.focus);
|
|
// remove selection
|
|
self.documents
|
|
.get_mut(&view.doc)
|
|
.unwrap()
|
|
.selections
|
|
.remove(&id);
|
|
|
|
self.tree.remove(id);
|
|
self._refresh();
|
|
}
|
|
|
|
pub fn close_document(&mut self, doc_id: DocumentId, force: bool) -> anyhow::Result<()> {
|
|
let doc = match self.documents.get(&doc_id) {
|
|
Some(doc) => doc,
|
|
None => anyhow::bail!("document does not exist"),
|
|
};
|
|
|
|
if !force && doc.is_modified() {
|
|
anyhow::bail!(
|
|
"buffer {:?} is modified",
|
|
doc.relative_path()
|
|
.map(|path| path.to_string_lossy().to_string())
|
|
.unwrap_or_else(|| SCRATCH_BUFFER_NAME.into())
|
|
);
|
|
}
|
|
|
|
if let Some(language_server) = doc.language_server() {
|
|
tokio::spawn(language_server.text_document_did_close(doc.identifier()));
|
|
}
|
|
|
|
let views_to_close = self
|
|
.tree
|
|
.views()
|
|
.filter_map(|(view, _focus)| {
|
|
if view.doc == doc_id {
|
|
Some(view.id)
|
|
} else {
|
|
None
|
|
}
|
|
})
|
|
.collect::<Vec<_>>();
|
|
|
|
for view_id in views_to_close {
|
|
self.close(view_id);
|
|
}
|
|
|
|
self.documents.remove(&doc_id);
|
|
|
|
// If the document we removed was visible in all views, we will have no more views. We don't
|
|
// want to close the editor just for a simple buffer close, so we need to create a new view
|
|
// containing either an existing document, or a brand new document.
|
|
if self.tree.views().peekable().peek().is_none() {
|
|
let doc_id = self
|
|
.documents
|
|
.iter()
|
|
.map(|(&doc_id, _)| doc_id)
|
|
.next()
|
|
.unwrap_or_else(|| self.new_document(Document::default()));
|
|
let view = View::new(doc_id);
|
|
let view_id = self.tree.insert(view);
|
|
let doc = self.documents.get_mut(&doc_id).unwrap();
|
|
doc.selections.insert(view_id, Selection::point(0));
|
|
}
|
|
|
|
self._refresh();
|
|
|
|
Ok(())
|
|
}
|
|
|
|
pub fn resize(&mut self, area: Rect) {
|
|
if self.tree.resize(area) {
|
|
self._refresh();
|
|
};
|
|
}
|
|
|
|
pub fn focus_next(&mut self) {
|
|
self.tree.focus_next();
|
|
}
|
|
|
|
pub fn focus_right(&mut self) {
|
|
self.tree.focus_direction(tree::Direction::Right);
|
|
}
|
|
|
|
pub fn focus_left(&mut self) {
|
|
self.tree.focus_direction(tree::Direction::Left);
|
|
}
|
|
|
|
pub fn focus_up(&mut self) {
|
|
self.tree.focus_direction(tree::Direction::Up);
|
|
}
|
|
|
|
pub fn focus_down(&mut self) {
|
|
self.tree.focus_direction(tree::Direction::Down);
|
|
}
|
|
|
|
pub fn should_close(&self) -> bool {
|
|
self.tree.is_empty()
|
|
}
|
|
|
|
pub fn ensure_cursor_in_view(&mut self, id: ViewId) {
|
|
let view = self.tree.get_mut(id);
|
|
let doc = &self.documents[&view.doc];
|
|
view.ensure_cursor_in_view(doc, self.config.scrolloff)
|
|
}
|
|
|
|
#[inline]
|
|
pub fn document(&self, id: DocumentId) -> Option<&Document> {
|
|
self.documents.get(&id)
|
|
}
|
|
|
|
#[inline]
|
|
pub fn document_mut(&mut self, id: DocumentId) -> Option<&mut Document> {
|
|
self.documents.get_mut(&id)
|
|
}
|
|
|
|
#[inline]
|
|
pub fn documents(&self) -> impl Iterator<Item = &Document> {
|
|
self.documents.values()
|
|
}
|
|
|
|
#[inline]
|
|
pub fn documents_mut(&mut self) -> impl Iterator<Item = &mut Document> {
|
|
self.documents.values_mut()
|
|
}
|
|
|
|
pub fn document_by_path<P: AsRef<Path>>(&self, path: P) -> Option<&Document> {
|
|
self.documents()
|
|
.find(|doc| doc.path().map(|p| p == path.as_ref()).unwrap_or(false))
|
|
}
|
|
|
|
pub fn document_by_path_mut<P: AsRef<Path>>(&mut self, path: P) -> Option<&mut Document> {
|
|
self.documents_mut()
|
|
.find(|doc| doc.path().map(|p| p == path.as_ref()).unwrap_or(false))
|
|
}
|
|
|
|
pub fn cursor(&self) -> (Option<Position>, CursorKind) {
|
|
let view = view!(self);
|
|
let doc = &self.documents[&view.doc];
|
|
let cursor = doc
|
|
.selection(view.id)
|
|
.primary()
|
|
.cursor(doc.text().slice(..));
|
|
if let Some(mut pos) = view.screen_coords_at_pos(doc, doc.text().slice(..), cursor) {
|
|
let inner = view.inner_area();
|
|
pos.col += inner.x as usize;
|
|
pos.row += inner.y as usize;
|
|
let cursorkind = self
|
|
.config
|
|
.cursor_shape
|
|
.get(&doc.mode())
|
|
.copied()
|
|
.unwrap_or_default();
|
|
(Some(pos), cursorkind)
|
|
} else {
|
|
(None, CursorKind::default())
|
|
}
|
|
}
|
|
|
|
/// Closes language servers with timeout. The default timeout is 500 ms, use
|
|
/// `timeout` parameter to override this.
|
|
pub async fn close_language_servers(
|
|
&self,
|
|
timeout: Option<u64>,
|
|
) -> Result<(), tokio::time::error::Elapsed> {
|
|
tokio::time::timeout(
|
|
Duration::from_millis(timeout.unwrap_or(500)),
|
|
future::join_all(
|
|
self.language_servers
|
|
.iter_clients()
|
|
.map(|client| client.force_shutdown()),
|
|
),
|
|
)
|
|
.await
|
|
.map(|_| ())
|
|
}
|
|
}
|