-pub mod file_event;

-mod file_operations;

-use arc_swap::ArcSwap;

-pub use helix_lsp_types as lsp;

-use helix_core::syntax::config::{

- LanguageConfiguration, LanguageServerConfiguration, LanguageServerFeatures,

-};

-use helix_stdx::path;

-use slotmap::SlotMap;

- collections::HashMap,

- path::{Path, PathBuf},

- sync::Arc,

-pub type Result<T, E = Error> = core::result::Result<T, E>;

-pub type LanguageServerName = String;

-pub use helix_core::diagnostic::LanguageServerId;

- Parse(Box<dyn std::error::Error + Send + Sync>),

- #[error("request {0} timed out")]

- Timeout(jsonrpc::Id),

- ExecutableNotFound(#[from] helix_stdx::env::ExecutableNotFoundError),

- #[error(transparent)]

-impl From<serde_json::Error> for Error {

- fn from(value: serde_json::Error) -> Self {

- Self::Parse(Box::new(value))

- }

-}

-

-impl From<sonic_rs::Error> for Error {

- fn from(value: sonic_rs::Error) -> Self {

- Self::Parse(Box::new(value))

- }

-}

-

-#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]

- /// UTF-32 code units aka chars

- Utf32,

- #[default]

- use helix_core::line_ending::{line_end_byte_index, line_end_char_index};

- use helix_core::snippets::{RenderedSnippet, Snippet, SnippetRenderCtx};

- use helix_core::{chars, RopeSlice};

- /// Returns `None` if position.line is out of bounds or an overflow occurs

- // If it extends past the end, truncate it to the end. This is because the

- // way the LSP describes the range including the last newline is by

- // specifying a line number after what we would call the last line.

- log::warn!("LSP position {pos:?} out of range assuming EOF");

- return Some(doc.len_chars());

- // We need to be careful here to fully comply ith the LSP spec.

- // Two relevant quotes from the spec:

- //

- // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#position

- // > If the character value is greater than the line length it defaults back

- // > to the line length.

- //

- // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocuments

- // > To ensure that both client and server split the string into the same

- // > line representation the protocol specifies the following end-of-line sequences:

- // > ‘\n’, ‘\r\n’ and ‘\r’. Positions are line end character agnostic.

- // > So you can not specify a position that denotes \r|\n or \n| where | represents the character offset.

- //

- // This means that while the line must be in bounds the `character`

- // must be capped to the end of the line.

- // Note that the end of the line here is **before** the line terminator

- // so we must use `line_end_char_index` instead of `doc.line_to_char(pos_line + 1)`

- //

- // FIXME: Helix does not fully comply with the LSP spec for line terminators.

- // The LSP standard requires that line terminators are ['\n', '\r\n', '\r'].

- // Without the unicode-linebreak feature disabled, the `\r` terminator is not handled by helix.

- // With the unicode-linebreak feature, helix recognizes multiple extra line break chars

- // which means that positions will be decoded/encoded incorrectly in their presence

-

- let line = match offset_encoding {

- let line_start = doc.line_to_byte(pos_line);

- let line_end = line_end_byte_index(&doc.slice(..), pos_line);

- line_start..line_end

- // TODO directly translate line index to char-idx

- // ropey can do this just as easily as utf-8 byte translation

- // but the functions are just missing.

- // Translate to char first and then utf-16 as a workaround

- let line_start = doc.line_to_char(pos_line);

- let line_end = line_end_char_index(&doc.slice(..), pos_line);

- doc.char_to_utf16_cu(line_start)..doc.char_to_utf16_cu(line_end)

- OffsetEncoding::Utf32 => {

- let line_start = doc.line_to_char(pos_line);

- let line_end = line_end_char_index(&doc.slice(..), pos_line);

- line_start..line_end

- }

- };

-

- // The LSP spec demands that the offset is capped to the end of the line

- let pos = line

- .start

- .checked_add(pos.character as usize)

- .unwrap_or(line.end)

- .min(line.end);

-

- match offset_encoding {

- OffsetEncoding::Utf8 => doc.try_byte_to_char(pos).ok(),

- OffsetEncoding::Utf16 => doc.try_utf16_cu_to_char(pos).ok(),

- OffsetEncoding::Utf32 => Some(pos),

- let line_start = doc.line_to_byte(line);

- let col = doc.char_to_byte(pos) - line_start;

- OffsetEncoding::Utf32 => {

- let line = doc.char_to_line(pos);

- let line_start = doc.line_to_char(line);

- let col = pos - line_start;

-

- lsp::Position::new(line as u32, col as u32)

- }

- mut range: lsp::Range,

- // This is sort of an edgecase. It's not clear from the spec how to deal with

- // ranges where end < start. They don't make much sense but vscode simply caps start to end

- // and because it's not specified quite a few LS rely on this as a result (for example the TS server)

- if range.start > range.end {

- log::error!(

- "Invalid LSP range start {:?} > end {:?}, using an empty range at the end instead",

- range.start,

- range.end

- );

- range.start = range.end;

- }

- /// If the LS did not provide a range for the completion or the range of the

- /// primary cursor can not be used for the secondary cursor, this function

- /// can be used to find the completion range for a cursor

- fn find_completion_range(text: RopeSlice, replace_mode: bool, cursor: usize) -> (usize, usize) {

- let start = cursor

- - text

- .chars_at(cursor)

- .reversed()

- .take_while(|ch| chars::char_is_word(*ch))

- .count();

- let mut end = cursor;

- if replace_mode {

- end += text

- .chars_at(cursor)

- .take_while(|ch| chars::char_is_word(*ch))

- .count();

- }

- (start, end)

- }

- fn completion_range(

- text: RopeSlice,

- edit_offset: Option<(i128, i128)>,

- replace_mode: bool,

- cursor: usize,

- ) -> Option<(usize, usize)> {

- let res = match edit_offset {

- Some((start_offset, end_offset)) => {

- let start_offset = cursor as i128 + start_offset;

- if start_offset < 0 {

- return None;

- }

- let end_offset = cursor as i128 + end_offset;

- if end_offset > text.len_chars() as i128 {

- return None;

- }

- (start_offset as usize, end_offset as usize)

- }

- None => find_completion_range(text, replace_mode, cursor),

- };

- Some(res)

- }

-

- edit_offset: Option<(i128, i128)>,

- replace_mode: bool,

- new_text: String,

- let replacement: Option<Tendril> = if new_text.is_empty() {

- Some(new_text.into())

- let (removed_start, removed_end) = completion_range(

- text,

- edit_offset,

- replace_mode,

- selection.primary().cursor(text),

- )

- .expect("transaction must be valid for primary selection");

- let removed_text = text.slice(removed_start..removed_end);

- let (transaction, mut selection) = Transaction::change_by_selection_ignore_overlapping(

- doc,

- selection,

- |range| {

- let cursor = range.cursor(text);

- completion_range(text, edit_offset, replace_mode, cursor)

- .filter(|(start, end)| text.slice(start..end) == removed_text)

- .unwrap_or_else(|| find_completion_range(text, replace_mode, cursor))

- },

- |_, _| replacement.clone(),

- );

- if transaction.changes().is_empty() {

- return transaction;

- }

- selection = selection.map(transaction.changes());

- transaction.with_selection(selection)

- }

- /// Creates a [Transaction] from the [Snippet] in a completion response.

- /// The transaction applies the edit to all cursors.

- pub fn generate_transaction_from_snippet(

- doc: &Rope,

- selection: &Selection,

- edit_offset: Option<(i128, i128)>,

- replace_mode: bool,

- snippet: Snippet,

- cx: &mut SnippetRenderCtx,

- ) -> (Transaction, RenderedSnippet) {

- let text = doc.slice(..);

- let (removed_start, removed_end) = completion_range(

- text,

- edit_offset,

- replace_mode,

- selection.primary().cursor(text),

- )

- .expect("transaction must be valid for primary selection");

- let removed_text = text.slice(removed_start..removed_end);

- let (transaction, mapped_selection, snippet) = snippet.render(

- doc,

- selection,

- |range| {

- let cursor = range.cursor(text);

- completion_range(text, edit_offset, replace_mode, cursor)

- .filter(|(start, end)| text.slice(start..end) == removed_text)

- .unwrap_or_else(|| find_completion_range(text, replace_mode, cursor))

- },

- cx,

- );

- let transaction = transaction.with_selection(snippet.first_selection(

- // we keep the direction of the old primary selection in case it changed during mapping

- // but use the primary idx from the mapped selection in case ranges had to be merged

- selection.primary().direction(),

- mapped_selection.primary_index(),

- ));

- (transaction, snippet)

- edits.sort_by_key(|edit| edit.range.start);

-

- if start > end {

- log::error!(

- "Invalid LSP text edit start {:?} > end {:?}, discarding",

- start,

- end

- );

- return (0, 0, None);

- }

-

- RegisterCapability(lsp::RegistrationParams),

- UnregisterCapability(lsp::UnregistrationParams),

- ShowDocument(lsp::ShowDocumentParams),

- WorkspaceDiagnosticRefresh,

- lsp::request::RegisterCapability::METHOD => {

- let params: lsp::RegistrationParams = params.parse()?;

- Self::RegisterCapability(params)

- }

- lsp::request::UnregisterCapability::METHOD => {

- let params: lsp::UnregistrationParams = params.parse()?;

- Self::UnregisterCapability(params)

- }

- lsp::request::ShowDocument::METHOD => {

- let params: lsp::ShowDocumentParams = params.parse()?;

- Self::ShowDocument(params)

- }

- lsp::request::WorkspaceDiagnosticRefresh::METHOD => Self::WorkspaceDiagnosticRefresh,

- inner: SlotMap<LanguageServerId, Arc<Client>>,

- inner_by_name: HashMap<LanguageServerName, Vec<Arc<Client>>>,

- syn_loader: Arc<ArcSwap<helix_core::syntax::Loader>>,

- pub incoming: SelectAll<UnboundedReceiverStream<(LanguageServerId, Call)>>,

- pub file_event_handler: file_event::Handler,

- pub fn new(syn_loader: Arc<ArcSwap<helix_core::syntax::Loader>>) -> Self {

- inner: SlotMap::with_key(),

- inner_by_name: HashMap::new(),

- syn_loader,

- file_event_handler: file_event::Handler::new(),

- pub fn get_by_id(&self, id: LanguageServerId) -> Option<&Arc<Client>> {

- self.inner.get(id)

- }

-

- pub fn remove_by_id(&mut self, id: LanguageServerId) {

- let Some(client) = self.inner.remove(id) else {

- log::debug!("client was already removed");

- return;

- };

- self.file_event_handler.remove_client(id);

- let instances = self

- .inner_by_name

- .get_mut(client.name())

- .expect("inner and inner_by_name must be synced");

- instances.retain(|ls| id != ls.id());

- if instances.is_empty() {

- self.inner_by_name.remove(client.name());

- }

- fn start_client(

- &mut self,

- name: String,

- ls_config: &LanguageConfiguration,

- doc_path: Option<&std::path::PathBuf>,

- root_dirs: &[PathBuf],

- enable_snippets: bool,

- ) -> Result<Arc<Client>, StartupError> {

- let syn_loader = self.syn_loader.load();

- let config = syn_loader

- .language_server_configs()

- .get(&name)

- .ok_or_else(|| anyhow::anyhow!("Language server '{name}' not defined"))?;

- let id = self.inner.try_insert_with_key(|id| {

- start_client(

- id,

- name,

- ls_config,

- config,

- doc_path,

- root_dirs,

- enable_snippets,

- )

- .map(|client| {

- self.incoming.push(UnboundedReceiverStream::new(client.1));

- client.0

- })

- })?;

- Ok(self.inner[id].clone())

- /// If this method is called, all documents that have a reference to the language server have to refresh their language servers,

- /// See helix_view::editor::Editor::refresh_language_servers

- pub fn restart_server(

- name: &str,

- root_dirs: &[PathBuf],

- enable_snippets: bool,

- ) -> Option<Result<Arc<Client>>> {

- if let Some(old_clients) = self.inner_by_name.remove(name) {

- if old_clients.is_empty() {

- log::info!("restarting client for '{name}' which was manually stopped");

- } else {

- log::info!("stopping existing clients for '{name}'");

- }

- for old_client in old_clients {

- self.file_event_handler.remove_client(old_client.id());

- self.inner.remove(old_client.id());

- let client = match self.start_client(

- name.to_string(),

- language_config,

- doc_path,

- root_dirs,

- enable_snippets,

- ) {

- Ok(client) => client,

- Err(StartupError::NoRequiredRootFound) => return None,

- Err(StartupError::Error(err)) => return Some(Err(err)),

- self.inner_by_name

- .insert(name.to_owned(), vec![client.clone()]);

- Some(Ok(client))

- }

- pub fn stop(&mut self, name: &str) {

- if let Some(clients) = self.inner_by_name.get_mut(name) {

- // Drain the clients vec so that the entry in `inner_by_name` remains

- // empty. We use the empty vec as a "tombstone" to mean that a server

- // has been manually stopped with :lsp-stop and shouldn't be automatically

- // restarted by `get`. :lsp-restart can be used to restart the server

- // manually.

- for client in clients.drain(..) {

- self.file_event_handler.remove_client(client.id());

- self.inner.remove(client.id());

- tokio::spawn(async move {

- let _ = client.force_shutdown().await;

- });

- pub fn get<'a>(

- &'a mut self,

- language_config: &'a LanguageConfiguration,

- doc_path: Option<&'a std::path::PathBuf>,

- root_dirs: &'a [PathBuf],

- enable_snippets: bool,

- ) -> impl Iterator<Item = (LanguageServerName, Result<Arc<Client>>)> + 'a {

- language_config.language_servers.iter().filter_map(

- move |LanguageServerFeatures { name, .. }| {

- if let Some(clients) = self.inner_by_name.get(name) {

- // If the clients vec is empty, do not automatically start a client

- // for this server. The empty vec is a tombstone left to mean that a

- // server has been manually stopped and shouldn't be started automatically.

- // See `stop`.

- if clients.is_empty() {

- return None;

- }

-

- if let Some((_, client)) = clients.iter().enumerate().find(|(i, client)| {

- let manual_roots = language_config

- .workspace_lsp_roots

- .as_deref()

- .unwrap_or(root_dirs);

- client.try_add_doc(&language_config.roots, manual_roots, doc_path, *i == 0)

- }) {

- return Some((name.to_owned(), Ok(client.clone())));

- }

- }

- match self.start_client(

- name.clone(),

- language_config,

- doc_path,

- root_dirs,

- enable_snippets,

- ) {

- Ok(client) => {

- self.inner_by_name

- .entry(name.to_owned())

- .or_default()

- .push(client.clone());

- Some((name.clone(), Ok(client)))

- }

- Err(StartupError::NoRequiredRootFound) => None,

- Err(StartupError::Error(err)) => Some((name.to_owned(), Err(err))),

- }

- },

- )

- }

-

- self.inner.values()

- Started {

- title: String,

- progress: lsp::WorkDoneProgress,

- },

- ProgressStatus::Started { title: _, progress } => Some(progress),

-pub struct LspProgressMap(HashMap<LanguageServerId, HashMap<lsp::ProgressToken, ProgressStatus>>);

- pub fn progress_map(

- &self,

- id: LanguageServerId,

- ) -> Option<&HashMap<lsp::ProgressToken, ProgressStatus>> {

- pub fn is_progressing(&self, id: LanguageServerId) -> bool {

- pub fn progress(

- &self,

- id: LanguageServerId,

- token: &lsp::ProgressToken,

- ) -> Option<&ProgressStatus> {

- pub fn title(&self, id: LanguageServerId, token: &lsp::ProgressToken) -> Option<&String> {

- self.progress(id, token).and_then(|p| match p {

- ProgressStatus::Created => None,

- ProgressStatus::Started { title, .. } => Some(title),

- })

- }

-

- pub fn is_created(&mut self, id: LanguageServerId, token: &lsp::ProgressToken) -> bool {

- pub fn create(&mut self, id: LanguageServerId, token: lsp::ProgressToken) {

- id: LanguageServerId,

- /// Updates the progress of `token` for server with `id` to begin state `status`

- pub fn begin(

- &mut self,

- id: LanguageServerId,

- token: lsp::ProgressToken,

- status: lsp::WorkDoneProgressBegin,

- ) {

- self.0.entry(id).or_default().insert(

- token,

- ProgressStatus::Started {

- title: status.title.clone(),

- progress: lsp::WorkDoneProgress::Begin(status),

- },

- );

- }

-

- /// Updates the progress of `token` for server with `id` to report state `status`.

- id: LanguageServerId,

- status: lsp::WorkDoneProgressReport,

- ) {

- .entry(token)

- .and_modify(|e| match e {

- ProgressStatus::Created => (),

- ProgressStatus::Started { progress, .. } => {

- *progress = lsp::WorkDoneProgress::Report(status)

- }

- });

-struct NewClient(Arc<Client>, UnboundedReceiver<(LanguageServerId, Call)>);

-

-enum StartupError {

- NoRequiredRootFound,

- Error(Error),

-}

-

-impl<T: Into<Error>> From<T> for StartupError {

- fn from(value: T) -> Self {

- StartupError::Error(value.into())

- }

-}

- id: LanguageServerId,

- name: String,

- root_dirs: &[PathBuf],

- enable_snippets: bool,

-) -> Result<NewClient, StartupError> {

- let (workspace, workspace_is_cwd) = helix_loader::find_workspace();

- let workspace = path::normalize(workspace);

- let root = find_lsp_workspace(

- doc_path

- .and_then(|x| x.parent().and_then(|x| x.to_str()))

- .unwrap_or("."),

- &config.roots,

- config.workspace_lsp_roots.as_deref().unwrap_or(root_dirs),

- &workspace,

- workspace_is_cwd,

- );

-

- // `root_uri` and `workspace_folder` can be empty in case there is no workspace

- // `root_url` can not, use `workspace` as a fallback

- let root_path = root.clone().unwrap_or_else(|| workspace.clone());

- let root_uri = root.and_then(|root| lsp::Url::from_file_path(root).ok());

-

- if let Some(globset) = &ls_config.required_root_patterns {

- if !root_path

- .read_dir()?

- .flatten()

- .map(|entry| entry.file_name())

- .any(|entry| globset.is_match(entry))

- {

- return Err(StartupError::NoRequiredRootFound);

- }

- }

-

- ls_config.config.clone(),

- &ls_config.environment,

- root_path,

- root_uri,

- name,

- .initialize(enable_snippets)

- _client.notify::<lsp::notification::Initialized>(lsp::InitializedParams {});

- Ok(NewClient(client, incoming))

-}

-

-/// Find an LSP workspace of a file using the following mechanism:

-/// * if the file is outside `workspace` return `None`

-/// * start at `file` and search the file tree upward

-/// * stop the search at the first `root_dirs` entry that contains `file`

-/// * if no `root_dirs` matches `file` stop at workspace

-/// * Returns the top most directory that contains a `root_marker`

-/// * If no root marker and we stopped at a `root_dirs` entry, return the directory we stopped at

-/// * If we stopped at `workspace` instead and `workspace_is_cwd == false` return `None`

-/// * If we stopped at `workspace` instead and `workspace_is_cwd == true` return `workspace`

-pub fn find_lsp_workspace(

- file: &str,

- root_markers: &[String],

- root_dirs: &[PathBuf],

- workspace: &Path,

- workspace_is_cwd: bool,

-) -> Option<PathBuf> {

- let file = std::path::Path::new(file);

- let mut file = if file.is_absolute() {

- file.to_path_buf()

- } else {

- let current_dir = helix_stdx::env::current_working_dir();

- current_dir.join(file)

- };

- file = path::normalize(&file);

-

- if !file.starts_with(workspace) {

- return None;

- }

-

- let mut top_marker = None;

- for ancestor in file.ancestors() {

- if root_markers

- .iter()

- .any(|marker| ancestor.join(marker).exists())

- {

- top_marker = Some(ancestor);

- }

-

- if root_dirs

- .iter()

- .any(|root_dir| path::normalize(workspace.join(root_dir)) == ancestor)

- {

- // if the worskapce is the cwd do not search any higher for workspaces

- // but specify

- return Some(top_marker.unwrap_or(workspace).to_owned());

- }

- if ancestor == workspace {

- // if the workspace is the CWD, let the LSP decide what the workspace

- // is

- return top_marker

- .or_else(|| (!workspace_is_cwd).then_some(workspace))

- .map(Path::to_owned);

- }

- }

-

- debug_assert!(false, "workspace must be an ancestor of <file>");

- None

- test_case!("", (0, 1) => Some(0));

- test_case!("", (1, 0) => Some(0));

- test_case!("\n\n", (1, 1) => Some(1));

- test_case!("\n\n", (3, 0) => Some(2));

- test_case!("test\n\n\n\ncase", (4, 5) => Some(12));

- test_case!("", (u32::MAX, u32::MAX) => Some(0));

- }

-

- #[test]

- fn emoji_format_gh_4791() {

- use lsp::{Position, Range, TextEdit};

-

- let edits = vec![

- TextEdit {

- range: Range {

- start: Position {

- line: 0,

- character: 1,

- },

- end: Position {

- line: 1,

- character: 0,

- },

- },

- new_text: "\n ".to_string(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 1,

- character: 7,

- },

- end: Position {

- line: 2,

- character: 0,

- },

- },

- new_text: "\n ".to_string(),

- },

- ];

-

- let mut source = Rope::from_str("[\n\"🇺🇸\",\n\"🎄\",\n]");

-

- let transaction = generate_transaction_from_edits(&source, edits, OffsetEncoding::Utf16);

- assert!(transaction.apply(&mut source));

- assert_eq!(source, "[\n \"🇺🇸\",\n \"🎄\",\n]");

- }

- #[test]

- fn rahh() {

- use helix_lsp_types::*;

- let th = [

- TextEdit {

- range: Range {

- start: Position {

- line: 1,

- character: 0,

- },

- end: Position {

- line: 1,

- character: 4,

- },

- },

- new_text: "".into(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 2,

- character: 0,

- },

- end: Position {

- line: 3,

- character: 1,

- },

- },

- new_text: "".into(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 3,

- character: 9,

- },

- end: Position {

- line: 3,

- character: 9,

- },

- },

- new_text: "let new =\n".into(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 3,

- character: 20,

- },

- end: Position {

- line: 3,

- character: 29,

- },

- },

- new_text: "".into(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 3,

- character: 56,

- },

- end: Position {

- line: 4,

- character: 24,

- },

- },

- new_text: "".into(),

- },

- TextEdit {

- range: Range {

- start: Position {

- line: 6,

- character: 1,

- },

- end: Position {

- line: 6,

- character: 1,

- },

- },

- new_text: "\n".into(),

- },

- ];

- let mut source = Rope::from_str(

- "impl Editor { // 0

- pub fn open(f: &Path) { // 1

-// 2

- let new = std::fs::read_to_string(f) // 3

- .map_err(anyhow::Error::from)?; // 4

- }

-}",

- );

- println!("{}", source);

-

- let transaction =

- generate_transaction_from_edits(&source, th.to_vec(), OffsetEncoding::Utf8);

- assert!(transaction.apply(&mut source));

- println!("{}", source);