Debug adapter protocol support

Cargo.toml

@@ -6,6 +6,7 @@ members = [
   "helix-tui",
   "helix-syntax",
   "helix-lsp",
+  "helix-dap"
 ]
 
 # Build helix-syntax in release mode to make the code path faster in development.

helix-core/Cargo.toml

@@ -14,6 +14,7 @@ include = ["src/**/*", "README.md"]
 
 [dependencies]
 helix-syntax = { version = "0.4", path = "../helix-syntax" }
+helix-dap = { version = "0.4", path = "../helix-dap" }
 
 ropey = "1.3"
 smallvec = "1.4"
@@ -28,6 +29,7 @@ arc-swap = "1"
 regex = "1"
 
 serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
 toml = "0.5"
 
 similar = "1.3"

helix-core/src/indent.rs

@@ -458,6 +458,8 @@ where
                     unit: String::from("    "),
                 }),
                 indent_query: OnceCell::new(),
+                debug_adapter: None,
+                debug_configs: None,
             }],
         });
 

helix-core/src/syntax.rs

@@ -5,6 +5,7 @@ use crate::{
     Rope, RopeSlice, Tendril,
 };
 
+use helix_dap::DebugAdapterConfig;
 pub use helix_syntax::get_language;
 
 use arc_swap::ArcSwap;
@@ -55,6 +56,8 @@ pub struct LanguageConfiguration {
 
     #[serde(skip)]
     pub(crate) indent_query: OnceCell<Option<IndentQuery>>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub debugger: Option<DebugAdapterConfig>,
 }
 
 #[derive(Debug, Serialize, Deserialize)]

helix-dap/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "helix-dap"
+version = "0.4.1"
+authors = ["Blaž Hrastnik <[email protected]>"]
+edition = "2018"
+license = "MPL-2.0"
+description = "DAP client implementation for Helix project"
+categories = ["editor"]
+repository = "https://github.com/helix-editor/helix"
+homepage = "https://helix-editor.com"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+anyhow = "1.0"
+log = "0.4"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+thiserror = "1.0"
+tokio = { version = "1", features = ["rt", "rt-multi-thread", "io-util", "io-std", "time", "process", "macros", "fs", "parking_lot", "net", "sync"] }
+
+[dev-dependencies]
+fern = "0.6"

helix-dap/examples/dap-dlv.rs

@@ -0,0 +1,117 @@
+use helix_dap::{events, Client, Event, Payload, Result, SourceBreakpoint};
+use serde::{Deserialize, Serialize};
+use serde_json::to_value;
+use tokio::sync::mpsc::UnboundedReceiver;
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct LaunchArguments {
+    mode: String,
+    program: String,
+}
+
+async fn dispatch(mut rx: UnboundedReceiver<Payload>) {
+    loop {
+        match rx.recv().await.unwrap() {
+            Payload::Event(Event::Output(events::Output {
+                category, output, ..
+            })) => {
+                println!(
+                    "> [{}] {}",
+                    category.unwrap_or("unknown".to_owned()),
+                    output
+                );
+            }
+            Payload::Event(Event::Stopped(_)) => {
+                println!("stopped");
+            }
+            _ => {}
+        };
+    }
+}
+
+#[tokio::main]
+pub async fn main() -> Result<()> {
+    let base_config = fern::Dispatch::new().level(log::LevelFilter::Info);
+
+    let stderr_config = fern::Dispatch::new()
+        .format(|out, message, record| out.finish(format_args!("[{}] {}", record.level(), message)))
+        .chain(std::io::stderr());
+
+    base_config
+        .chain(stderr_config)
+        .apply()
+        .expect("Failed to set up logging");
+
+    let (mut client, events) =
+        Client::tcp_process("dlv", vec!["dap"], "-l 127.0.0.1:{}", 0).await?;
+    println!("create: {:?}", client);
+
+    tokio::spawn(dispatch(events));
+
+    println!("init: {:?}", client.initialize("go".to_owned()).await);
+    println!("caps: {:?}", client.capabilities());
+
+    let args = LaunchArguments {
+        mode: "exec".to_owned(),
+        program: "/tmp/godebug/main".to_owned(),
+    };
+
+    println!("launch: {:?}", client.launch(to_value(args)?).await);
+
+    println!(
+        "breakpoints: {:#?}",
+        client
+            .set_breakpoints(
+                "/tmp/godebug/main.go".into(),
+                vec![SourceBreakpoint {
+                    line: 8,
+                    column: Some(2),
+                    condition: None,
+                    hit_condition: None,
+                    log_message: None,
+                }]
+            )
+            .await
+    );
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("configurationDone: {:?}", client.configuration_done().await);
+
+    let threads = client.threads().await?;
+    println!("threads: {:#?}", threads);
+    let bt = client
+        .stack_trace(threads[0].id)
+        .await
+        .expect("expected stack trace");
+    println!("stack trace: {:#?}", bt);
+    let scopes = client
+        .scopes(bt.0[0].id)
+        .await
+        .expect("expected scopes for thread");
+    println!("scopes: {:#?}", scopes);
+    println!(
+        "vars: {:#?}",
+        client.variables(scopes[1].variables_reference).await
+    );
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("continued: {:?}", client.continue_thread(0).await);
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("disconnect: {:?}", client.disconnect().await);
+
+    Ok(())
+}

helix-dap/examples/dap-lldb.rs

@@ -0,0 +1,116 @@
+use helix_dap::{events, Client, Event, Payload, Result, SourceBreakpoint};
+use serde::{Deserialize, Serialize};
+use serde_json::to_value;
+use tokio::sync::mpsc::UnboundedReceiver;
+
+#[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+struct LaunchArguments {
+    program: String,
+    console: String,
+}
+
+async fn dispatch(mut rx: UnboundedReceiver<Payload>) {
+    loop {
+        match rx.recv().await.unwrap() {
+            Payload::Event(Event::Output(events::Output {
+                category, output, ..
+            })) => {
+                println!(
+                    "> [{}] {}",
+                    category.unwrap_or("unknown".to_owned()),
+                    output
+                );
+            }
+            Payload::Event(Event::Stopped(_)) => {
+                println!("stopped");
+            }
+            _ => {}
+        };
+    }
+}
+
+#[tokio::main]
+pub async fn main() -> Result<()> {
+    let base_config = fern::Dispatch::new().level(log::LevelFilter::Info);
+
+    let stderr_config = fern::Dispatch::new()
+        .format(|out, message, record| out.finish(format_args!("[{}] {}", record.level(), message)))
+        .chain(std::io::stderr());
+
+    base_config
+        .chain(stderr_config)
+        .apply()
+        .expect("Failed to set up logging");
+
+    let (mut client, events) = Client::tcp_process("lldb-vscode", vec![], "-p {}", 0).await?;
+    println!("create: {:?}", client);
+
+    tokio::spawn(dispatch(events));
+
+    println!("init: {:?}", client.initialize("lldb".to_owned()).await);
+    println!("caps: {:?}", client.capabilities());
+
+    let args = LaunchArguments {
+        program: "/tmp/cdebug/main".to_owned(),
+        console: "internalConsole".to_owned(),
+    };
+
+    println!("launch: {:?}", client.launch(to_value(args)?).await);
+
+    println!(
+        "breakpoints: {:#?}",
+        client
+            .set_breakpoints(
+                "/tmp/cdebug/main.c".into(),
+                vec![SourceBreakpoint {
+                    line: 6,
+                    column: Some(2),
+                    condition: None,
+                    hit_condition: None,
+                    log_message: None,
+                }]
+            )
+            .await
+    );
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("configurationDone: {:?}", client.configuration_done().await);
+
+    let threads = client.threads().await?;
+    println!("threads: {:#?}", threads);
+    let bt = client
+        .stack_trace(threads[0].id)
+        .await
+        .expect("expected stack trace");
+    println!("stack trace: {:#?}", bt);
+    let scopes = client
+        .scopes(bt.0[0].id)
+        .await
+        .expect("expected scopes for thread");
+    println!("scopes: {:#?}", scopes);
+    println!(
+        "vars: {:#?}",
+        client.variables(scopes[0].variables_reference).await
+    );
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("continued: {:?}", client.continue_thread(0).await);
+
+    let mut _in = String::new();
+    std::io::stdin()
+        .read_line(&mut _in)
+        .expect("Failed to read line");
+
+    println!("disconnect: {:?}", client.disconnect().await);
+
+    Ok(())
+}