1use anyhow::Result;
2use async_trait::async_trait;
3use collections::FxHashMap;
4use gpui::{App, Global, SharedString};
5use parking_lot::RwLock;
6use task::{DebugRequest, DebugScenario, SpawnInTerminal, TaskTemplate};
7
8use crate::adapters::{DebugAdapter, DebugAdapterName};
9use std::{collections::BTreeMap, sync::Arc};
10
11/// Given a user build configuration, locator creates a fill-in debug target ([DebugRequest]) on behalf of the user.
12#[async_trait]
13pub trait DapLocator: Send + Sync {
14 fn name(&self) -> SharedString;
15 /// Determines whether this locator can generate debug target for given task.
16 fn create_scenario(&self, build_config: &TaskTemplate, adapter: &str) -> Option<DebugScenario>;
17
18 async fn run(&self, build_config: SpawnInTerminal) -> Result<DebugRequest>;
19}
20
21#[derive(Default)]
22struct DapRegistryState {
23 adapters: BTreeMap<DebugAdapterName, Arc<dyn DebugAdapter>>,
24 locators: FxHashMap<SharedString, Arc<dyn DapLocator>>,
25}
26
27#[derive(Clone, Default)]
28/// Stores available debug adapters.
29pub struct DapRegistry(Arc<RwLock<DapRegistryState>>);
30impl Global for DapRegistry {}
31
32impl DapRegistry {
33 pub fn global(cx: &mut App) -> &mut Self {
34 let ret = cx.default_global::<Self>();
35
36 #[cfg(any(test, feature = "test-support"))]
37 if ret.adapter(crate::FakeAdapter::ADAPTER_NAME).is_none() {
38 ret.add_adapter(Arc::new(crate::FakeAdapter::new()));
39 }
40
41 ret
42 }
43
44 pub fn add_adapter(&self, adapter: Arc<dyn DebugAdapter>) {
45 let name = adapter.name();
46 let _previous_value = self.0.write().adapters.insert(name, adapter);
47 debug_assert!(
48 _previous_value.is_none(),
49 "Attempted to insert a new debug adapter when one is already registered"
50 );
51 }
52
53 pub fn add_locator(&self, locator: Arc<dyn DapLocator>) {
54 let _previous_value = self.0.write().locators.insert(locator.name(), locator);
55 debug_assert!(
56 _previous_value.is_none(),
57 "Attempted to insert a new debug locator when one is already registered"
58 );
59 }
60
61 pub fn locators(&self) -> FxHashMap<SharedString, Arc<dyn DapLocator>> {
62 self.0.read().locators.clone()
63 }
64
65 pub fn adapter(&self, name: &str) -> Option<Arc<dyn DebugAdapter>> {
66 self.0.read().adapters.get(name).cloned()
67 }
68
69 pub fn enumerate_adapters(&self) -> Vec<DebugAdapterName> {
70 self.0.read().adapters.keys().cloned().collect()
71 }
72}