mirrors/helix
1
0
Fork 0
mirror of https://github.com/helix-editor/helix.git synced 2025-04-04 11:27:46 +03:00
Code Issues Projects Releases Packages Wiki Activity

dap: Rewrite breakpoints so that there's a single set maintained

Browse source
This commit is contained in:
Blaž Hrastnik 2021-11-30 17:52:39 +09:00
parent 3633f85b38
commit 8ffafb826f
6 changed files with 163 additions and 181 deletions
Download patch file Download diff file Expand all files Collapse all files

2
helix-dap/src/client.rs
View file

@ -35,7 +35,6 @@ pub struct Client {
pub thread_id: Option<ThreadId>, pub thread_id: Option<ThreadId>,
/// Currently active frame for the current thread. /// Currently active frame for the current thread.
pub active_frame: Option<usize>, pub active_frame: Option<usize>,
pub breakpoints: Vec<Breakpoint>,
pub quirks: DebuggerQuirks, pub quirks: DebuggerQuirks,
} }
@ -81,7 +80,6 @@ impl Client {
thread_states: HashMap::new(), thread_states: HashMap::new(),
thread_id: None, thread_id: None,
active_frame: None, active_frame: None,
breakpoints: vec![],
quirks: DebuggerQuirks::default(), quirks: DebuggerQuirks::default(),
}; };

69
helix-term/src/application.rs
View file

@ -1,7 +1,7 @@
use helix_core::{merge_toml_values, syntax}; use helix_core::{merge_toml_values, syntax};
use helix_dap::Payload; use helix_dap::Payload;
use helix_lsp::{lsp, util::lsp_pos_to_pos, LspProgressMap}; use helix_lsp::{lsp, util::lsp_pos_to_pos, LspProgressMap};
use helix_view::{theme, Editor}; use helix_view::{editor::Breakpoint, theme, Editor};
use crate::{ use crate::{
args::Args, commands::fetch_stack_trace, compositor::Compositor, config::Config, job::Jobs, ui, args::Args, commands::fetch_stack_trace, compositor::Compositor, config::Config, job::Jobs, ui,
@ -319,7 +319,7 @@ impl Application {
} }
pub async fn handle_debugger_message(&mut self, payload: helix_dap::Payload) { pub async fn handle_debugger_message(&mut self, payload: helix_dap::Payload) {
use crate::commands::dap::{resume_application, select_thread_id}; use crate::commands::dap::{breakpoints_changed, resume_application, select_thread_id};
use helix_dap::{events, Event}; use helix_dap::{events, Event};
let debugger = match self.editor.debugger.as_mut() { let debugger = match self.editor.debugger.as_mut() {
Some(debugger) => debugger, Some(debugger) => debugger,
@ -388,46 +388,35 @@ impl Application {
} }
Event::Breakpoint(events::Breakpoint { reason, breakpoint }) => match &reason[..] { Event::Breakpoint(events::Breakpoint { reason, breakpoint }) => match &reason[..] {
"new" => { "new" => {
debugger.breakpoints.push(breakpoint); self.editor
.breakpoints
.entry(breakpoint.source.unwrap().path.unwrap()) // TODO: no unwraps
.or_default()
.push(Breakpoint {
id: breakpoint.id,
verified: breakpoint.verified,
message: breakpoint.message,
line: breakpoint.line.unwrap().saturating_sub(1), // TODO: no unwrap
column: breakpoint.column,
..Default::default()
});
} }
"changed" => { "changed" => {
match debugger for breakpoints in self.editor.breakpoints.values_mut() {
.breakpoints if let Some(i) = breakpoints.iter().position(|b| b.id == breakpoint.id)
.iter() {
.position(|b| b.id == breakpoint.id) breakpoints[i].verified = breakpoint.verified;
{ breakpoints[i].message = breakpoint.message.clone();
Some(i) => { breakpoints[i].line = breakpoint.line.unwrap().saturating_sub(1); // TODO: no unwrap
debugger.breakpoints[i] = breakpoint; breakpoints[i].column = breakpoint.column;
// let item = debugger.breakpoints.get_mut(i).unwrap();
// item.verified = breakpoint.verified;
// // TODO: wasteful clones
// item.message = breakpoint.message.or_else(|| item.message.clone());
// item.source = breakpoint.source.or_else(|| item.source.clone());
// item.line = breakpoint.line.or(item.line);
// item.column = breakpoint.column.or(item.column);
// item.end_line = breakpoint.end_line.or(item.end_line);
// item.end_column = breakpoint.end_column.or(item.end_column);
// item.instruction_reference = breakpoint
// .instruction_reference
// .or_else(|| item.instruction_reference.clone());
// item.offset = breakpoint.offset.or(item.offset);
}
None => {
warn!("Changed breakpoint with id {:?} not found", breakpoint.id);
} }
} }
} }
"removed" => { "removed" => {
match debugger for breakpoints in self.editor.breakpoints.values_mut() {
.breakpoints if let Some(i) = breakpoints.iter().position(|b| b.id == breakpoint.id)
.iter() {
.position(|b| b.id == breakpoint.id) breakpoints.remove(i);
{
Some(i) => {
debugger.breakpoints.remove(i);
}
None => {
warn!("Removed breakpoint with id {:?} not found", breakpoint.id);
} }
} }
} }
@ -453,13 +442,9 @@ impl Application {
} }
Event::Initialized => { Event::Initialized => {
// send existing breakpoints // send existing breakpoints
for (path, breakpoints) in &self.editor.breakpoints { for (path, breakpoints) in &mut self.editor.breakpoints {
// TODO: call futures in parallel, await all // TODO: call futures in parallel, await all
debugger.breakpoints = debugger let _ = breakpoints_changed(debugger, path.clone(), breakpoints);
.set_breakpoints(path.clone(), breakpoints.clone())
.await
.unwrap()
.unwrap();
} }
// TODO: fetch breakpoints (in case we're attaching) // TODO: fetch breakpoints (in case we're attaching)

6
helix-term/src/commands.rs
View file

@ -1897,8 +1897,8 @@ fn append_mode(cx: &mut Context) {
mod cmd { mod cmd {
use super::*; use super::*;
use helix_dap::SourceBreakpoint;
use helix_view::editor::Action; use helix_view::editor::Action;
use helix_view::editor::Breakpoint;
use ui::completers::{self, Completer}; use ui::completers::{self, Completer};
#[derive(Clone)] #[derive(Clone)]
@ -2563,9 +2563,7 @@ mod cmd {
Ok(()) Ok(())
} }
pub fn get_breakpoint_at_current_line( pub fn get_breakpoint_at_current_line(editor: &mut Editor) -> Option<(usize, Breakpoint)> {
editor: &mut Editor,
) -> Option<(usize, SourceBreakpoint)> {
let (view, doc) = current!(editor); let (view, doc) = current!(editor);
let text = doc.text().slice(..); let text = doc.text().slice(..);

171
helix-term/src/commands/dap.rs
View file

@ -11,11 +11,13 @@ use helix_core::{
}; };
use helix_dap::{self as dap, Client, ThreadId}; use helix_dap::{self as dap, Client, ThreadId};
use helix_lsp::block_on; use helix_lsp::block_on;
use helix_view::editor::Breakpoint;
use serde_json::{to_value, Value}; use serde_json::{to_value, Value};
use tokio_stream::wrappers::UnboundedReceiverStream; use tokio_stream::wrappers::UnboundedReceiverStream;
use std::collections::HashMap; use std::collections::HashMap;
use std::path::PathBuf;
// general utils: // general utils:
pub fn dap_pos_to_pos(doc: &helix_core::Rope, line: usize, column: usize) -> Option<usize> { pub fn dap_pos_to_pos(doc: &helix_core::Rope, line: usize, column: usize) -> Option<usize> {
@ -406,40 +408,90 @@ pub fn dap_toggle_breakpoint(cx: &mut Context) {
dap_toggle_breakpoint_impl(cx, path, line); dap_toggle_breakpoint_impl(cx, path, line);
} }
pub fn dap_toggle_breakpoint_impl(cx: &mut Context, path: std::path::PathBuf, line: usize) { pub fn breakpoints_changed(
let breakpoint = helix_dap::SourceBreakpoint { debugger: &mut dap::Client,
line: line + 1, // convert from 0-indexing to 1-indexing (TODO: could set debugger to 0-indexing on init) path: PathBuf,
..Default::default() breakpoints: &mut [Breakpoint],
}; ) -> Result<(), anyhow::Error> {
// TODO: handle capabilities correctly again, by filterin breakpoints when emitting
// if breakpoint.condition.is_some()
// && !debugger
// .caps
// .as_ref()
// .unwrap()
// .supports_conditional_breakpoints
// .unwrap_or_default()
// {
// bail!(
// "Can't edit breakpoint: debugger does not support conditional breakpoints"
// )
// }
// if breakpoint.log_message.is_some()
// && !debugger
// .caps
// .as_ref()
// .unwrap()
// .supports_log_points
// .unwrap_or_default()
// {
// bail!("Can't edit breakpoint: debugger does not support logpoints")
// }
let source_breakpoints = breakpoints
.iter()
.map(|breakpoint| helix_dap::SourceBreakpoint {
line: breakpoint.line + 1, // convert from 0-indexing to 1-indexing (TODO: could set debugger to 0-indexing on init)
..Default::default()
})
.collect::<Vec<_>>();
let request = debugger.set_breakpoints(path, source_breakpoints);
match block_on(request) {
Ok(Some(dap_breakpoints)) => {
for (breakpoint, dap_breakpoint) in breakpoints.iter_mut().zip(dap_breakpoints) {
breakpoint.id = dap_breakpoint.id;
breakpoint.verified = dap_breakpoint.verified;
breakpoint.message = dap_breakpoint.message;
// TODO: handle breakpoint.message
// TODO: verify source matches
breakpoint.line = dap_breakpoint.line.unwrap_or(0).saturating_sub(1); // convert to 0-indexing
// TODO: no unwrap
breakpoint.column = dap_breakpoint.column;
// TODO: verify end_linef/col instruction reference, offset
}
}
Err(e) => anyhow::bail!("Failed to set breakpoints: {}", e),
_ => {}
};
Ok(())
}
pub fn dap_toggle_breakpoint_impl(cx: &mut Context, path: PathBuf, line: usize) {
// TODO: need to map breakpoints over edits and update them? // TODO: need to map breakpoints over edits and update them?
// we shouldn't really allow editing while debug is running though // we shouldn't really allow editing while debug is running though
let breakpoints = cx.editor.breakpoints.entry(path.clone()).or_default(); let breakpoints = cx.editor.breakpoints.entry(path.clone()).or_default();
// TODO: always keep breakpoints sorted and use binary search // TODO: always keep breakpoints sorted and use binary search to determine insertion point
if let Some(pos) = breakpoints.iter().position(|b| b.line == breakpoint.line) { if let Some(pos) = breakpoints
.iter()
.position(|breakpoint| breakpoint.line == line)
{
breakpoints.remove(pos); breakpoints.remove(pos);
} else { } else {
breakpoints.push(breakpoint); breakpoints.push(Breakpoint {
line,
..Default::default()
});
} }
let breakpoints = breakpoints.clone();
let debugger = match &mut cx.editor.debugger { let debugger = match &mut cx.editor.debugger {
Some(debugger) => debugger, Some(debugger) => debugger,
None => return, None => return,
}; };
let request = debugger.set_breakpoints(path, breakpoints);
match block_on(request) { if let Err(e) = breakpoints_changed(debugger, path, breakpoints) {
Ok(Some(breakpoints)) => { cx.editor
// TODO: handle breakpoint.message .set_error(format!("Failed to set breakpoints: {}", e));
debugger.breakpoints = breakpoints; }
}
Err(e) => cx
.editor
.set_error(format!("Failed to set breakpoints: {}", e)),
_ => {}
};
} }
pub fn dap_continue(cx: &mut Context) { pub fn dap_continue(cx: &mut Context) {
@ -651,36 +703,15 @@ pub fn dap_edit_condition(cx: &mut Context) {
input => Some(input.to_owned()), input => Some(input.to_owned()),
}; };
if let Some(debugger) = &mut cx.editor.debugger { let debugger = match &mut cx.editor.debugger {
// TODO: handle capabilities correctly again, by filterin breakpoints when emitting Some(debugger) => debugger,
// if breakpoint.condition.is_some() None => return,
// && !debugger };
// .caps
// .as_ref() if let Err(e) = breakpoints_changed(debugger, path.clone(), breakpoints)
// .unwrap() {
// .supports_conditional_breakpoints cx.editor
// .unwrap_or_default() .set_error(format!("Failed to set breakpoints: {}", e));
// {
// bail!(
// "Can't edit breakpoint: debugger does not support conditional breakpoints"
// )
// }
// if breakpoint.log_message.is_some()
// && !debugger
// .caps
// .as_ref()
// .unwrap()
// .supports_log_points
// .unwrap_or_default()
// {
// bail!("Can't edit breakpoint: debugger does not support logpoints")
// }
let request =
debugger.set_breakpoints(path.clone(), breakpoints.clone());
if let Err(e) = block_on(request) {
cx.editor
.set_status(format!("Failed to set breakpoints: {}", e))
}
} }
}, },
); );
@ -719,36 +750,14 @@ pub fn dap_edit_log(cx: &mut Context) {
input => Some(input.to_owned()), input => Some(input.to_owned()),
}; };
if let Some(debugger) = &mut cx.editor.debugger { let debugger = match &mut cx.editor.debugger {
// TODO: handle capabilities correctly again, by filterin breakpoints when emitting Some(debugger) => debugger,
// if breakpoint.condition.is_some() None => return,
// && !debugger };
// .caps if let Err(e) = breakpoints_changed(debugger, path.clone(), breakpoints)
// .as_ref() {
// .unwrap() cx.editor
// .supports_conditional_breakpoints .set_error(format!("Failed to set breakpoints: {}", e));
// .unwrap_or_default()
// {
// bail!(
// "Can't edit breakpoint: debugger does not support conditional breakpoints"
// )
// }
// if breakpoint.log_message.is_some()
// && !debugger
// .caps
// .as_ref()
// .unwrap()
// .supports_log_points
// .unwrap_or_default()
// {
// bail!("Can't edit breakpoint: debugger does not support logpoints")
// }
let request =
debugger.set_breakpoints(path.clone(), breakpoints.clone());
if let Err(e) = block_on(request) {
cx.editor
.set_status(format!("Failed to set breakpoints: {}", e))
}
} }
}, },
); );

81
helix-term/src/ui/editor.rs
View file

@ -15,7 +15,6 @@ use helix_core::{
unicode::width::UnicodeWidthStr, unicode::width::UnicodeWidthStr,
LineEnding, Position, Range, Selection, LineEnding, Position, Range, Selection,
}; };
use helix_dap::{Breakpoint, SourceBreakpoint, StackFrame};
use helix_view::{ use helix_view::{
document::{Mode, SCRATCH_BUFFER_NAME}, document::{Mode, SCRATCH_BUFFER_NAME},
graphics::{Color, CursorKind, Modifier, Rect, Style}, graphics::{Color, CursorKind, Modifier, Rect, Style},
@ -24,7 +23,7 @@ use helix_view::{
keyboard::{KeyCode, KeyModifiers}, keyboard::{KeyCode, KeyModifiers},
Document, Editor, Theme, View, Document, Editor, Theme, View,
}; };
use std::{borrow::Cow, collections::HashMap, path::PathBuf}; use std::borrow::Cow;
use crossterm::event::{Event, MouseButton, MouseEvent, MouseEventKind}; use crossterm::event::{Event, MouseButton, MouseEvent, MouseEventKind};
use tui::buffer::Buffer as Surface; use tui::buffer::Buffer as Surface;
@ -74,7 +73,6 @@ impl EditorView {
let inner = view.inner_area(); let inner = view.inner_area();
let area = view.area; let area = view.area;
let theme = &editor.theme; let theme = &editor.theme;
let all_breakpoints = HashMap::new();
let highlights = Self::doc_syntax_highlights(doc, view.offset, inner.height, theme, loader); let highlights = Self::doc_syntax_highlights(doc, view.offset, inner.height, theme, loader);
let highlights = syntax::merge(highlights, Self::doc_diagnostics_highlights(doc, theme)); let highlights = syntax::merge(highlights, Self::doc_diagnostics_highlights(doc, theme));
@ -107,7 +105,7 @@ impl EditorView {
} }
} }
self.render_diagnostics(doc, view, inner, surface, theme, &all_breakpoints); self.render_diagnostics(doc, view, inner, surface, theme);
let statusline_area = view let statusline_area = view
.area .area
@ -436,39 +434,21 @@ impl EditorView {
let error = theme.get("error"); let error = theme.get("error");
let info = theme.get("info"); let info = theme.get("info");
let all_breakpoints = &editor.breakpoints;
// TODO: debugger breakpoints should keep editor level breakpoints in sync
let breakpoints = doc let breakpoints = doc
.path() .path()
.and_then(|path| all_breakpoints.get(path)) .and_then(|path| editor.breakpoints.get(path))
.unwrap(); .unwrap();
Box::new(move |line: usize, _selected: bool, out: &mut String| { Box::new(move |line: usize, _selected: bool, out: &mut String| {
// TODO: debugger should translate received breakpoints to 0-indexing let breakpoint = breakpoints
let breakpoint = breakpoints.iter().find(|breakpoint| { .iter()
false .find(|breakpoint| breakpoint.line == line);
// if breakpoint.source == doc.path() {
// match (breakpoint.line, breakpoint.end_line) {
// #[allow(clippy::int_plus_one)]
// (Some(l), Some(el)) => l - 1 <= line && line <= el - 1,
// (Some(l), None) => l - 1 == line,
// _ => false,
// }
// } else {
// false
// }
});
let breakpoint = match breakpoint { let breakpoint = match breakpoint {
Some(b) => b, Some(b) => b,
None => return None, None => return None,
}; };
// let verified = breakpoint.verified;
let verified = false;
let mut style = let mut style =
if breakpoint.condition.is_some() && breakpoint.log_message.is_some() { if breakpoint.condition.is_some() && breakpoint.log_message.is_some() {
error.add_modifier(Modifier::UNDERLINED) error.add_modifier(Modifier::UNDERLINED)
@ -480,7 +460,7 @@ impl EditorView {
warning warning
}; };
if !verified { if !breakpoint.verified {
// Faded colors // Faded colors
style = if let Some(Color::Rgb(r, g, b)) = style.fg { style = if let Some(Color::Rgb(r, g, b)) = style.fg {
style.fg(Color::Rgb( style.fg(Color::Rgb(
@ -495,7 +475,7 @@ impl EditorView {
// TODO: also handle breakpoints only present in the user struct // TODO: also handle breakpoints only present in the user struct
use std::fmt::Write; use std::fmt::Write;
let sym = if verified { "▲" } else { "⊚" }; let sym = if breakpoint.verified { "▲" } else { "⊚" };
write!(out, "{}", sym).unwrap(); write!(out, "{}", sym).unwrap();
Some(style) Some(style)
}) })
@ -567,7 +547,6 @@ impl EditorView {
viewport: Rect, viewport: Rect,
surface: &mut Surface, surface: &mut Surface,
theme: &Theme, theme: &Theme,
all_breakpoints: &HashMap<PathBuf, Vec<SourceBreakpoint>>,
) { ) {
use helix_core::diagnostic::Severity; use helix_core::diagnostic::Severity;
use tui::{ use tui::{
@ -605,28 +584,28 @@ impl EditorView {
lines.extend(text.lines); lines.extend(text.lines);
} }
if let Some(path) = doc.path() { // let line = doc.text().char_to_line(cursor);
let line = doc.text().char_to_line(cursor); // let breakpoint = doc
if let Some(breakpoints) = all_breakpoints.get(path) { // .path()
if let Some(breakpoint) = breakpoints // .and_then(|path| all_breakpoints.get(path))
.iter() // .and_then(|breakpoints| {
.find(|breakpoint| breakpoint.line - 1 == line) // breakpoints
{ // .iter()
if let Some(condition) = &breakpoint.condition { // .find(|breakpoint| breakpoint.line == line)
lines.extend( // });
Text::styled(condition, warning.add_modifier(Modifier::UNDERLINED))
.lines, // if let Some(breakpoint) = breakpoint {
); // if let Some(condition) = &breakpoint.condition {
} // lines.extend(
if let Some(log_message) = &breakpoint.log_message { // Text::styled(condition, warning.add_modifier(Modifier::UNDERLINED)).lines,
lines.extend( // );
Text::styled(log_message, info.add_modifier(Modifier::UNDERLINED)) // }
.lines, // if let Some(log_message) = &breakpoint.log_message {
); // lines.extend(
} // Text::styled(log_message, info.add_modifier(Modifier::UNDERLINED)).lines,
} // );
} // }
} // }
let paragraph = Paragraph::new(lines) let paragraph = Paragraph::new(lines)
.alignment(Alignment::Right) .alignment(Alignment::Right)

15
helix-view/src/editor.rs
View file

@ -156,6 +156,19 @@ impl std::fmt::Debug for Motion {
} }
} }
#[derive(Debug, Clone, Default)]
pub struct Breakpoint {
pub id: Option<usize>,
pub verified: bool,
pub message: Option<String>,
pub line: usize,
pub column: Option<usize>,
pub condition: Option<String>,
pub hit_condition: Option<String>,
pub log_message: Option<String>,
}
#[derive(Debug)] #[derive(Debug)]
pub struct Editor { pub struct Editor {
pub tree: Tree, pub tree: Tree,
@ -169,7 +182,7 @@ pub struct Editor {
pub debugger: Option<dap::Client>, pub debugger: Option<dap::Client>,
pub debugger_events: SelectAll<UnboundedReceiverStream<dap::Payload>>, pub debugger_events: SelectAll<UnboundedReceiverStream<dap::Payload>>,
pub breakpoints: HashMap<PathBuf, Vec<dap::SourceBreakpoint>>, pub breakpoints: HashMap<PathBuf, Vec<Breakpoint>>,
pub clipboard_provider: Box<dyn ClipboardProvider>, pub clipboard_provider: Box<dyn ClipboardProvider>,