registry.rs

  1use anyhow::Result;
  2use async_trait::async_trait;
  3use collections::FxHashMap;
  4use gpui::{App, Global, SharedString};
  5use language::LanguageName;
  6use parking_lot::RwLock;
  7use task::{
  8    AdapterSchema, AdapterSchemas, DebugRequest, DebugScenario, SpawnInTerminal, TaskTemplate,
  9};
 10
 11use crate::{
 12    adapters::{DebugAdapter, DebugAdapterName},
 13    inline_value::InlineValueProvider,
 14};
 15use std::{collections::BTreeMap, sync::Arc};
 16
 17/// Given a user build configuration, locator creates a fill-in debug target ([DebugRequest]) on behalf of the user.
 18#[async_trait]
 19pub trait DapLocator: Send + Sync {
 20    fn name(&self) -> SharedString;
 21    /// Determines whether this locator can generate debug target for given task.
 22    fn create_scenario(
 23        &self,
 24        build_config: &TaskTemplate,
 25        resolved_label: &str,
 26        adapter: DebugAdapterName,
 27    ) -> Option<DebugScenario>;
 28
 29    async fn run(&self, build_config: SpawnInTerminal) -> Result<DebugRequest>;
 30}
 31
 32#[derive(Default)]
 33struct DapRegistryState {
 34    adapters: BTreeMap<DebugAdapterName, Arc<dyn DebugAdapter>>,
 35    locators: FxHashMap<SharedString, Arc<dyn DapLocator>>,
 36    inline_value_providers: FxHashMap<String, Arc<dyn InlineValueProvider>>,
 37}
 38
 39#[derive(Clone, Default)]
 40/// Stores available debug adapters.
 41pub struct DapRegistry(Arc<RwLock<DapRegistryState>>);
 42impl Global for DapRegistry {}
 43
 44impl DapRegistry {
 45    pub fn global(cx: &mut App) -> &mut Self {
 46        cx.default_global::<Self>()
 47    }
 48
 49    pub fn add_adapter(&self, adapter: Arc<dyn DebugAdapter>) {
 50        let name = adapter.name();
 51        let _previous_value = self.0.write().adapters.insert(name, adapter);
 52    }
 53
 54    pub fn adapter_language(&self, adapter_name: &str) -> Option<LanguageName> {
 55        self.adapter(adapter_name)
 56            .and_then(|adapter| adapter.adapter_language_name())
 57    }
 58
 59    pub fn add_locator(&self, locator: Arc<dyn DapLocator>) {
 60        let _previous_value = self.0.write().locators.insert(locator.name(), locator);
 61        debug_assert!(
 62            _previous_value.is_none(),
 63            "Attempted to insert a new debug locator when one is already registered"
 64        );
 65    }
 66
 67    pub async fn adapters_schema(&self) -> task::AdapterSchemas {
 68        let mut schemas = AdapterSchemas(vec![]);
 69
 70        // Clone to avoid holding lock over await points
 71        let adapters = self.0.read().adapters.clone();
 72
 73        for (name, adapter) in adapters.into_iter() {
 74            schemas.0.push(AdapterSchema {
 75                adapter: name.into(),
 76                schema: adapter.dap_schema().await,
 77            });
 78        }
 79
 80        schemas
 81    }
 82
 83    pub fn add_inline_value_provider(
 84        &self,
 85        language: String,
 86        provider: Arc<dyn InlineValueProvider>,
 87    ) {
 88        let _previous_value = self
 89            .0
 90            .write()
 91            .inline_value_providers
 92            .insert(language, provider);
 93        debug_assert!(
 94            _previous_value.is_none(),
 95            "Attempted to insert a new inline value provider when one is already registered"
 96        );
 97    }
 98
 99    pub fn locators(&self) -> FxHashMap<SharedString, Arc<dyn DapLocator>> {
100        self.0.read().locators.clone()
101    }
102
103    pub fn adapter(&self, name: &str) -> Option<Arc<dyn DebugAdapter>> {
104        self.0.read().adapters.get(name).cloned()
105    }
106
107    pub fn inline_value_provider(&self, language: &str) -> Option<Arc<dyn InlineValueProvider>> {
108        self.0.read().inline_value_providers.get(language).cloned()
109    }
110
111    pub fn enumerate_adapters(&self) -> Vec<DebugAdapterName> {
112        self.0.read().adapters.keys().cloned().collect()
113    }
114}