Skip to content

Commit

Permalink
remove Callback::Compositor variant
Browse files Browse the repository at this point in the history
To reduce likelihood of accidental discarding of important callbacks
  • Loading branch information
dead10ck committed Oct 19, 2022
1 parent b3fc31a commit b530a86
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 31 deletions.
2 changes: 1 addition & 1 deletion helix-term/src/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,7 @@ impl Application {

let mut result = match self
.jobs
.finish(Some(&mut self.editor), Some(&mut self.compositor))
.finish(&mut self.editor, Some(&mut self.compositor))
.await
{
Ok(_) => Ok(()),
Expand Down
18 changes: 10 additions & 8 deletions helix-term/src/commands/dap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -277,10 +277,11 @@ pub fn dap_launch(cx: &mut Context) {
let completions = template.completion.clone();
let name = template.name.clone();
let callback = Box::pin(async move {
let call: Callback = Callback::Compositor(Box::new(move |compositor| {
let prompt = debug_parameter_prompt(completions, name, Vec::new());
compositor.push(Box::new(prompt));
}));
let call: Callback =
Callback::EditorCompositor(Box::new(move |_editor, compositor| {
let prompt = debug_parameter_prompt(completions, name, Vec::new());
compositor.push(Box::new(prompt));
}));
Ok(call)
});
cx.jobs.callback(callback);
Expand Down Expand Up @@ -335,10 +336,11 @@ fn debug_parameter_prompt(
let config_name = config_name.clone();
let params = params.clone();
let callback = Box::pin(async move {
let call: Callback = Callback::Compositor(Box::new(move |compositor| {
let prompt = debug_parameter_prompt(completions, config_name, params);
compositor.push(Box::new(prompt));
}));
let call: Callback =
Callback::EditorCompositor(Box::new(move |_editor, compositor| {
let prompt = debug_parameter_prompt(completions, config_name, params);
compositor.push(Box::new(prompt));
}));
Ok(call)
});
cx.jobs.callback(callback);
Expand Down
4 changes: 1 addition & 3 deletions helix-term/src/compositor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ impl<'a> Context<'a> {
/// Waits on all pending jobs, and then tries to flush all pending write
/// operations for all documents.
pub fn block_try_flush_writes(&mut self) -> anyhow::Result<()> {
tokio::task::block_in_place(|| {
helix_lsp::block_on(self.jobs.finish(Some(self.editor), None))
})?;
tokio::task::block_in_place(|| helix_lsp::block_on(self.jobs.finish(self.editor, None)))?;

for doc in &mut self.editor.documents.values_mut() {
tokio::task::block_in_place(|| helix_lsp::block_on(doc.try_flush_saves()))
Expand Down
20 changes: 4 additions & 16 deletions helix-term/src/job.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ use futures_util::stream::{FuturesUnordered, StreamExt};
pub enum Callback {
EditorCompositor(Box<dyn FnOnce(&mut Editor, &mut Compositor) + Send>),
Editor(Box<dyn FnOnce(&mut Editor) + Send>),
Compositor(Box<dyn FnOnce(&mut Compositor) + Send>),
}

pub type JobFuture = BoxFuture<'static, anyhow::Result<Option<Callback>>>;
Expand Down Expand Up @@ -76,7 +75,6 @@ impl Jobs {
Ok(Some(call)) => match call {
Callback::EditorCompositor(call) => call(editor, compositor),
Callback::Editor(call) => call(editor),
Callback::Compositor(call) => call(compositor),
},
Err(e) => {
editor.set_error(format!("Async job failed: {}", e));
Expand All @@ -102,7 +100,7 @@ impl Jobs {
/// Blocks until all the jobs that need to be waited on are done.
pub async fn finish(
&mut self,
mut editor: Option<&mut Editor>,
editor: &mut Editor,
mut compositor: Option<&mut Compositor>,
) -> anyhow::Result<()> {
log::debug!("waiting on jobs...");
Expand All @@ -117,20 +115,10 @@ impl Jobs {
// clippy doesn't realize this is an error without the derefs
#[allow(clippy::needless_option_as_deref)]
match callback {
Callback::EditorCompositor(call)
if editor.is_some() && compositor.is_some() =>
{
call(
editor.as_deref_mut().unwrap(),
compositor.as_deref_mut().unwrap(),
)
}
Callback::Editor(call) if editor.is_some() => {
call(editor.as_deref_mut().unwrap())
}
Callback::Compositor(call) if compositor.is_some() => {
call(compositor.as_deref_mut().unwrap())
Callback::EditorCompositor(call) if compositor.is_some() => {
call(editor, compositor.as_deref_mut().unwrap())
}
Callback::Editor(call) => call(editor),

// skip callbacks for which we don't have the necessary references
_ => (),
Expand Down
7 changes: 4 additions & 3 deletions helix-term/src/ui/editor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -945,9 +945,10 @@ impl EditorView {

// TODO: Use an on_mode_change hook to remove signature help
cxt.jobs.callback(async {
let call: job::Callback = Callback::Compositor(Box::new(|compositor| {
compositor.remove(SignatureHelp::ID);
}));
let call: job::Callback =
Callback::EditorCompositor(Box::new(|_editor, compositor| {
compositor.remove(SignatureHelp::ID);
}));
Ok(call)
});
}
Expand Down

0 comments on commit b530a86

Please sign in to comment.