use crate::{ContentId, RelPath, SourceAnchor, SymbolRef};
use serde::{Deserialize, Serialize};
use std::sync::{
Arc,
atomic::{AtomicBool, Ordering},
};
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct ProviderVersion {
pub provider: String,
pub revision: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
pub struct SourceVersion {
pub path: RelPath,
pub content: ContentId,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SemanticRequest {
pub version: ProviderVersion,
pub origin: SourceAnchor,
pub source: String,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "kind", rename_all = "snake_case")]
pub enum SemanticTarget {
Workspace {
symbol: SymbolRef,
},
External {
uri: String,
content: ContentId,
span: crate::Span,
},
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct SemanticReply {
pub version: ProviderVersion,
pub origin: SourceAnchor,
pub dependencies: Vec<SourceVersion>,
pub targets: Vec<SemanticTarget>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SemanticFailure {
Unavailable,
Incomplete,
Cancelled,
}
pub trait NavigationProvider: Send + Sync {
fn version(&self) -> ProviderVersion;
fn navigate(
&self,
request: &SemanticRequest,
cancellation: &NavigationCancellation,
) -> Result<SemanticReply, SemanticFailure>;
}
#[derive(Debug, Clone, Default)]
pub struct NavigationCancellation(Arc<AtomicBool>);
impl NavigationCancellation {
pub fn cancel(&self) {
self.0.store(true, Ordering::Release);
}
pub fn is_cancelled(&self) -> bool {
self.0.load(Ordering::Acquire)
}
pub(crate) fn check(&self) -> Result<(), crate::EngineError> {
if self.is_cancelled() {
Err(crate::EngineError::NavigationCancelled)
} else {
Ok(())
}
}
}
pub(crate) struct SemanticNavigation<'a> {
pub provider: &'a dyn NavigationProvider,
pub cancellation: &'a NavigationCancellation,
}