lsp_core/
lib.rs

1#![doc(
2    html_logo_url = "https://ajuvercr.github.io/semantic-web-lsp/assets/icons/favicon.png",
3    html_favicon_url = "https://ajuvercr.github.io/semantic-web-lsp/assets/icons/favicon.ico"
4)]
5//! Core and common implementation for the semantic web language server.
6//!
7//! Proivdes the backbone for the [semantic web lsp binary](../lsp_bin/index.html) and [semantic web
8//! lsp wasm](../lsp_web/index.html).
9//!
10//! With the language server protocol, each different request is handled by an ECS schedule,
11//! combining different systems together.
12//! A system can generate new data and attach it to an entity, a document, or use this data to
13//! respond to requests.
14//!
15//! Language specific implementations that handle things like tokenizing and parsing are
16//! implemented in separate crates. The binary currently supports [Turtle](../lang_turtle/index.html), [JSON-LD](../lang_jsonld/index.html) and [SPARQL](../lang_sparql/index.html).
17//! The goal is that each language at least generates [`Tokens`], [`Triples`] and
18//! [`Prefixes`].
19//! These components are then used to derive properties for autcompletion but also derive
20//! [`TokenComponent`] and [`TripleComponent`] enabling completion.
21//!
22//! The different schedules can be found at [`prelude::feature`].
23//!
24//! ## Example add completion for all subjects that start with `a`
25//! ```
26//! use bevy_ecs::prelude::*;
27//! use lsp_core::prelude::*;
28//! # use sophia_api::dataset::Dataset;
29//! # use sophia_api::prelude::Quad;
30//!
31//! // Define the extra data struct
32//! #[derive(Component)]
33//! struct MyCompletions {
34//!     subjects: Vec<String>,
35//! }
36//!
37//! // Define the generating system
38//! // Don't forget to add it to the ecs later
39//! fn generate_my_completion(
40//!   // Only derive the completions when the document is parsed fully, aka is not Dirty
41//!   query: Query<(Entity, &Triples), (Changed<Triples>, Without<Dirty>)>,
42//!   mut commands: Commands,
43//! ) {
44//!   for (e, triples) in &query {
45//!     let mut subjects = Vec::new();
46//!     for q in triples.quads().flatten() {
47//!       if q.s().as_str().starts_with('a') {
48//!         subjects.push(q.s().as_str().to_string());
49//!       }
50//!     }
51//!     commands.entity(e).insert(MyCompletions { subjects });
52//!   }
53//! }
54//!
55//! // Define a system that adds these completions to the completion request
56//! fn complete_my_completion(
57//!   mut query: Query<(
58//!     &TokenComponent, &TripleComponent, &MyCompletions, &mut CompletionRequest
59//!   )>,
60//! ) {
61//!   for (token, this_triple, completions, mut request) in &mut query {
62//!     if this_triple.target == TripleTarget::Subject {
63//!       for my_completion in &completions.subjects {
64//!         request.push(
65//!           SimpleCompletion::new(
66//!             lsp_core::lsp_types::CompletionItemKind::FIELD,
67//!             my_completion.clone(),
68//!             lsp_core::lsp_types::TextEdit {
69//!               range: token.range.clone(),
70//!               new_text: my_completion.clone(),
71//!             }
72//!           )
73//!         )
74//!       }
75//!     }
76//!   }
77//! }
78//! ```
79//! Note that [`Prefixes`] can help expand and shorten iri's in a document.
80//!
81//!
82
83use bevy_ecs::{prelude::*, schedule::ScheduleLabel};
84use prelude::SemanticTokensDict;
85use systems::{init_onology_extractor, populate_known_ontologies, OntologyExtractor};
86pub use tower_lsp::lsp_types;
87
88use crate::prelude::*;
89
90/// Main language tower_lsp server implementation.
91///
92/// [`Backend`](struct@backend::Backend) implements [`LanguageServer`](tower_lsp::LanguageServer).
93/// Each incoming request a schedule is ran on the main [`World`].
94pub mod backend;
95
96/// Handle platform specific implementations for fetching and spawning tasks.
97pub mod client;
98/// Common utils
99///
100/// Includes range transformations between [`std::ops::Range`] and [`lsp_core::lsp_types::Range`].
101/// And commonly used [`Spanned`].
102pub mod util;
103
104/// Defines all common [`Component`]s and [`Resource`]s
105///
106/// In this [`World`], [Entity]s are documents and [`Components`](`Component`) are derived from these documents.
107/// Different [`System`]s derive new [`Components`](`Component`) from existing [`Components`](`Component`), that are added to
108/// the [`Entity`].
109/// For example, if [`Triples`] are defined, [systems::derive_classes] will
110/// derive [`DefinedClass`](struct@systems::DefinedClass) from them and add them to the [`Entity`].
111pub mod components;
112/// Hosts all common features of the semantic language server.
113pub mod feature;
114/// Defines common language traits
115pub mod lang;
116pub mod prelude;
117pub mod systems;
118
119/// Initializes a [`World`], including [`Resources`](`Resource`) and [`Schedules`].
120/// All systems defined in [`crate`] are added to the [`World`].
121pub fn setup_schedule_labels<C: Client + Resource>(world: &mut World) {
122    world.init_resource::<SemanticTokensDict>();
123    world.init_resource::<TypeHierarchy<'static>>();
124    world.insert_resource(OntologyExtractor::new());
125
126    parse::setup_schedule::<C>(world);
127    hover::setup_schedule(world);
128    completion::setup_schedule(world);
129    rename::setup_schedules(world);
130    diagnostics::setup_schedule(world);
131    save::setup_schedule(world);
132    format::setup_schedule(world);
133    references::setup_schedule(world);
134    inlay::setup_schedule(world);
135    goto_definition::setup_schedule(world);
136    goto_type::setup_schedule(world);
137
138    semantic::setup_world(world);
139
140    world.add_schedule(Schedule::new(Tasks));
141
142    let mut schedule = Schedule::new(Startup);
143    schedule.add_systems((
144        init_onology_extractor,
145        populate_known_ontologies,
146        // extract_known_prefixes_from_config::<C>,
147    ));
148    world.add_schedule(schedule);
149}
150
151/// Event triggers when a document is opened
152///
153/// Example
154/// ```rust
155/// # use lsp_core::components::DynLang;
156/// # use lsp_core::CreateEvent;
157/// # use lsp_core::lang::LangHelper;
158/// # use bevy_ecs::event::EntityEvent;
159/// # use bevy_ecs::prelude::{Commands, On, World, Component};
160///
161/// #[derive(Component)]
162/// pub struct TurtleLang;
163///
164/// #[derive(Debug)]
165/// pub struct TurtleHelper;
166/// impl LangHelper for TurtleHelper {
167///     fn keyword(&self) -> &[&'static str] {
168///         &[
169///             "@prefix",
170///             "@base",
171///             "a",
172///         ]
173///     }
174/// }
175///
176/// let mut world = World::new();
177/// // This example tells the ECS system that the document is Turtle,
178/// // adding Turtle specific components
179/// world.add_observer(|trigger: On<CreateEvent>, mut commands: Commands| {
180///     match &trigger.event().language_id {
181///         Some(x) if x == "turtle" => {
182///             commands
183///                 .entity(trigger.event_target())
184///                 .insert((TurtleLang, DynLang(Box::new(TurtleHelper))));
185///             return;
186///         }
187///         _ => {}
188///     }
189///     if trigger.event().url.as_str().ends_with(".ttl") {
190///         commands
191///             .entity(trigger.event_target())
192///             .insert((TurtleLang, DynLang(Box::new(TurtleHelper))));
193///         return;
194///     }
195/// });
196/// ```
197///
198#[derive(EntityEvent)]
199pub struct CreateEvent {
200    pub url: crate::lsp_types::Url,
201    pub language_id: Option<String>,
202    #[event_target]
203    entity: Entity,
204}
205
206/// [`ScheduleLabel`] related to the Tasks schedule
207/// This schedule is used for async tasks, things that should be done at some point.
208///
209/// For example [`systems::handle_tasks`] spawns command queues sent with
210/// [`CommandSender`]
211#[derive(ScheduleLabel, Clone, Eq, PartialEq, Debug, Hash)]
212pub struct Tasks;
213
214#[derive(ScheduleLabel, Clone, Eq, PartialEq, Debug, Hash)]
215pub struct Startup;
lsp_core/lib.rs

lsp_core/
lib.rs
