rune/languageserver/

state.rs

use std::collections::{BTreeMap, HashSet};
use std::fmt;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use anyhow::{Context as _, Result};
use lsp::Url;
use ropey::Rope;
use tokio::sync::Notify;

use crate::alloc::prelude::*;
use crate::alloc::{self, HashMap, String, Vec};
use crate::ast::{Span, Spanned};
use crate::compile::meta;
use crate::compile::{
    self, CompileVisitor, LinkerError, Located, Location, MetaError, MetaRef, SourceMeta, WithSpan,
};
use crate::diagnostics::{Diagnostic, FatalDiagnosticKind};
use crate::doc::VisitorData;
use crate::item::ComponentRef;
use crate::languageserver::connection::Output;
use crate::languageserver::Language;
use crate::workspace::{self, WorkspaceError};
use crate::{self as rune, Diagnostics};
use crate::{BuildError, Context, Item, Options, Source, SourceId, Sources, Unit};

#[derive(Default)]
struct Reporter {
    by_url: BTreeMap<Url, Vec<lsp::Diagnostic>>,
}

impl Reporter {
    /// Ensure that the given URL is being reporter.
    fn ensure(&mut self, url: &Url) {
        if !self.by_url.contains_key(url) {
            self.by_url.insert(url.clone(), Vec::new());
        }
    }

    /// Get entry for the given URL.
    fn entry(&mut self, url: &Url) -> &mut Vec<lsp::Diagnostic> {
        self.by_url.entry(url.clone()).or_default()
    }
}

struct Build {
    id_to_url: HashMap<SourceId, Url>,
    sources: Sources,
    /// If a file is coming from a workspace.
    workspace: bool,
}

impl Build {
    pub(super) fn from_workspace() -> Self {
        Self {
            id_to_url: HashMap::new(),
            sources: Sources::default(),
            workspace: true,
        }
    }

    pub(super) fn from_file() -> Self {
        Self {
            id_to_url: HashMap::new(),
            sources: Sources::default(),
            workspace: false,
        }
    }

    pub(super) fn populate(&mut self, reporter: &mut Reporter) -> Result<()> {
        for id in self.sources.source_ids() {
            let Some(source) = self.sources.get(id) else {
                continue;
            };

            let Some(path) = source.path() else {
                continue;
            };

            let Ok(url) = crate::languageserver::url::from_file_path(path) else {
                continue;
            };

            reporter.ensure(&url);
            self.id_to_url.try_insert(id, url)?;
        }

        Ok(())
    }

    pub(super) fn visit(&mut self, visited: &mut HashSet<Url>) {
        for id in self.sources.source_ids() {
            let Some(source) = self.sources.get(id) else {
                continue;
            };

            let Some(path) = source.path() else {
                continue;
            };

            let Ok(url) = crate::languageserver::url::from_file_path(path) else {
                continue;
            };

            visited.insert(url.clone());
        }
    }
}

pub(super) enum StateEncoding {
    Utf8,
    Utf16,
}

impl StateEncoding {
    /// Get line column out of source.
    pub(super) fn source_range(&self, source: &Source, span: Span) -> Result<lsp::Range> {
        let start = self.source_position(source, span.start.into_usize())?;
        let end = self.source_position(source, span.end.into_usize())?;
        Ok(lsp::Range { start, end })
    }

    /// Get line column out of source.
    pub(super) fn source_position(&self, source: &Source, at: usize) -> Result<lsp::Position> {
        let (l, c) = match self {
            StateEncoding::Utf16 => source.pos_to_utf16cu_linecol(at),
            StateEncoding::Utf8 => source.pos_to_utf8_linecol(at),
        };

        Ok(lsp::Position {
            line: u32::try_from(l)?,
            character: u32::try_from(c)?,
        })
    }

    pub(super) fn rope_position(&self, rope: &Rope, pos: lsp::Position) -> Result<usize> {
        /// Translate the given lsp::Position, which is in UTF-16 because Microsoft.
        ///
        /// Please go complain here:
        /// <https://github.com/microsoft/language-server-protocol/issues/376>
        fn rope_position_utf16(rope: &Rope, pos: lsp::Position) -> Result<usize> {
            let line = usize::try_from(pos.line)?;
            let character = usize::try_from(pos.character)?;
            let line = rope.try_line_to_char(line)?;
            Ok(rope.try_utf16_cu_to_char(line + character)?)
        }

        fn rope_position_utf8(rope: &Rope, pos: lsp::Position) -> Result<usize> {
            let line = usize::try_from(pos.line)?;
            let character = usize::try_from(pos.character)?;
            Ok(rope.try_line_to_char(line)? + character)
        }

        match self {
            StateEncoding::Utf16 => rope_position_utf16(rope, pos),
            StateEncoding::Utf8 => rope_position_utf8(rope, pos),
        }
    }
}

impl fmt::Display for StateEncoding {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            StateEncoding::Utf8 => "utf-8".fmt(f),
            StateEncoding::Utf16 => "utf-16".fmt(f),
        }
    }
}

/// Shared server state.
pub(super) struct State<'a> {
    pub(super) encoding: StateEncoding,
    /// The output abstraction.
    pub(super) output: Output,
    /// Sender to indicate interest in rebuilding the project.
    /// Can be triggered on modification.
    rebuild_notify: &'a Notify,
    /// The rune context to build for.
    context: crate::Context,
    /// Build options.
    options: Options,
    /// Indicate if the server is initialized.
    initialized: bool,
    /// Indicate that the server is stopped.
    stopped: bool,
    /// Sources used in the project.
    pub(super) workspace: Workspace,
}

impl<'a> State<'a> {
    /// Construct a new state.
    pub(super) fn new(
        output: Output,
        rebuild_notify: &'a Notify,
        context: Context,
        options: Options,
    ) -> Self {
        Self {
            encoding: StateEncoding::Utf16,
            output,
            rebuild_notify,
            context,
            options,
            initialized: bool::default(),
            stopped: bool::default(),
            workspace: Workspace::default(),
        }
    }

    /// Mark server as initialized.
    pub(super) fn initialize(&mut self) {
        self.initialized = true;
    }

    /// Test if server is initialized.
    pub(super) fn is_initialized(&self) -> bool {
        self.initialized
    }

    /// Mark server as stopped.
    pub(super) fn stop(&mut self) {
        self.stopped = true;
    }

    /// Test if server is stopped.
    pub(super) fn is_stopped(&self) -> bool {
        self.stopped
    }

    /// Indicate interest in having the project rebuild.
    ///
    /// Sources that have been modified will be marked as dirty.
    pub(super) fn rebuild_interest(&self) {
        self.rebuild_notify.notify_one();
    }

    /// Find definition at the given uri and LSP position.
    pub(super) async fn goto_definition(
        &self,
        uri: &Url,
        position: lsp::Position,
    ) -> Result<Option<lsp::Location>> {
        let Some(source) = self.workspace.get(uri) else {
            return Ok(None);
        };

        let offset = self.encoding.rope_position(&source.content, position)?;

        let Some(def) = source.find_definition_at(Span::point(offset)) else {
            return Ok(None);
        };

        let url = match def.source.path() {
            Some(path) => crate::languageserver::url::from_file_path(path)?,
            None => uri.clone(),
        };

        let Some(source) = source
            .build_sources
            .as_ref()
            .and_then(|s| s.get(def.source.source_id()))
        else {
            return Ok(None);
        };

        let range = self.encoding.source_range(source, def.source.span())?;

        let location = lsp::Location { uri: url, range };

        tracing::trace!("go to location: {:?}", location);
        Ok(Some(location))
    }

    /// Find definition at the given uri and LSP position.
    #[tracing::instrument(skip_all)]
    pub(super) fn complete(
        &self,
        uri: &Url,
        position: lsp::Position,
    ) -> Result<Option<Vec<lsp::CompletionItem>>> {
        let sources = &self.workspace.sources;
        tracing::trace!(uri = ?uri, uri_exists = sources.get(uri).is_some());

        let Some(workspace_source) = sources.get(uri) else {
            return Ok(None);
        };

        let offset = self
            .encoding
            .rope_position(&workspace_source.content, position)?;

        let Some((mut symbol, _start)) = workspace_source.looking_back(offset)? else {
            return Ok(None);
        };

        tracing::trace!(?symbol, start = ?_start);

        if symbol.is_empty() {
            return Ok(None);
        }

        let mut results = Vec::new();

        let can_use_instance_fn: &[_] = &['.'];
        let first_char = symbol.remove(0);
        let symbol = symbol.trim();

        if let Some(unit) = workspace_source.unit.as_ref() {
            super::completion::complete_for_unit(
                workspace_source,
                unit,
                symbol,
                position,
                &mut results,
            )?;
        }

        if first_char.is_ascii_alphabetic() || can_use_instance_fn.contains(&first_char) {
            super::completion::complete_native_instance_data(
                &self.context,
                symbol,
                position,
                &mut results,
            )?;
        } else {
            super::completion::complete_native_loose_data(
                &self.context,
                symbol,
                position,
                &mut results,
            )?;
        }

        Ok(Some(results))
    }

    pub(super) fn format(&mut self, uri: &Url) -> Result<Option<lsp::TextEdit>> {
        let sources = &mut self.workspace.sources;
        tracing::trace!(uri = ?uri.try_to_string()?, uri_exists = sources.get(uri).is_some());

        let Some(s) = sources.get_mut(uri) else {
            return Ok(None);
        };

        let source = s.content.try_to_string()?;

        let mut diagnostics = Diagnostics::new();

        let Ok(formatted) = crate::fmt::layout_source_with(
            &source,
            SourceId::EMPTY,
            &self.options,
            &mut diagnostics,
        ) else {
            return Ok(None);
        };

        // Only modify if changed
        if source == formatted {
            return Ok(None);
        }

        let edit = lsp::TextEdit::new(
            // Range over full document
            lsp::Range::new(
                lsp::Position::new(0, 0),
                lsp::Position::new(u32::MAX, u32::MAX),
            ),
            formatted.into_std(),
        );

        Ok(Some(edit))
    }

    pub(super) fn range_format(
        &mut self,
        uri: &Url,
        range: &lsp::Range,
    ) -> Result<Option<lsp::TextEdit>> {
        let sources = &mut self.workspace.sources;
        tracing::trace!(uri = ?uri.try_to_string()?, uri_exists = sources.get(uri).is_some());

        let Some(s) = sources.get_mut(uri) else {
            return Ok(None);
        };

        let start = self.encoding.rope_position(&s.content, range.start)?;
        let end = self.encoding.rope_position(&s.content, range.end)?;

        let Some(source) = s.content.get_slice(start..end) else {
            return Ok(None);
        };

        let source = source.try_to_string()?;

        let mut options = self.options.clone();
        options.fmt.force_newline = false;

        let mut diagnostics = Diagnostics::new();

        let Ok(formatted) =
            crate::fmt::layout_source_with(&source, SourceId::EMPTY, &options, &mut diagnostics)
        else {
            return Ok(None);
        };

        // Only modify if changed
        if source == formatted {
            return Ok(None);
        }

        let edit = lsp::TextEdit::new(*range, formatted.into_std());
        Ok(Some(edit))
    }

    /// Rebuild the project.
    pub(super) async fn rebuild(&mut self) -> Result<()> {
        // Keep track of URLs visited as part of workspace builds.
        let mut visited = HashSet::new();
        // Workspace results.
        let mut workspace_results = Vec::new();
        // Build results.
        let mut script_results = Vec::new();
        // Emitted diagnostics, grouped by URL.
        let mut reporter = Reporter::default();

        if let Some((workspace_url, workspace_path)) = &self.workspace.manifest_path {
            let mut diagnostics = workspace::Diagnostics::default();
            let mut build = Build::from_workspace();

            let result = self.load_workspace(
                workspace_url,
                workspace_path,
                &mut build,
                &mut diagnostics,
                &self.workspace,
            );

            match result {
                Err(error) => {
                    tracing::error!("error loading workspace: {error}");

                    for _error in error.chain().skip(1) {
                        tracing::error!("caused by: {_error}");
                    }
                }
                Ok(script_builds) => {
                    for script_build in script_builds {
                        script_results
                            .try_push(self.build_scripts(script_build, Some(&mut visited))?)?;
                    }
                }
            };

            workspace_results.try_push((diagnostics, build))?;
        }

        for (url, source) in &self.workspace.sources {
            if visited.contains(url) {
                tracing::trace!(url = ?url.try_to_string()?, "already populated by workspace");
                continue;
            }

            if !matches!(source.language, Language::Rune) {
                continue;
            }

            tracing::trace!(url = ?url.try_to_string()?, "build plain source");

            let mut build = Build::from_file();

            let input = match url.to_file_path() {
                Ok(path) => Source::with_path(url, source.try_to_string()?, path)?,
                Err(..) => Source::new(url, source.try_to_string()?)?,
            };

            build.sources.insert(input)?;
            script_results.try_push(self.build_scripts(build, None)?)?;
        }

        // We need to pupulate diagnostics for everything we know about, in
        // order to clear errors which might've previously been set.
        for url in self.workspace.removed.drain(..) {
            reporter.ensure(&url);
        }

        for (diagnostics, mut build) in workspace_results {
            build.populate(&mut reporter)?;
            self.emit_workspace(diagnostics, &build, &mut reporter)?;
        }

        for (diagnostics, mut build, source_visitor, doc_visitor, unit) in script_results {
            build.populate(&mut reporter)?;
            self.emit_scripts(diagnostics, &build, &mut reporter)?;

            let sources = Arc::new(build.sources);
            let doc_visitor = Arc::new(doc_visitor);

            for (source_id, value) in source_visitor.into_indexes() {
                let Some(url) = build.id_to_url.get(&source_id) else {
                    continue;
                };

                let Some(source) = self.workspace.sources.get_mut(url) else {
                    continue;
                };

                source.index = value;
                source.build_sources = Some(sources.clone());

                if let Ok(unit) = &unit {
                    source.unit = Some(unit.try_clone()?);
                }

                source.docs = Some(doc_visitor.clone());
            }
        }

        for (url, diagnostics) in reporter.by_url {
            tracing::info!(
                url = ?url.try_to_string()?,
                diagnostics = diagnostics.len(),
                "publishing diagnostics"
            );

            let diagnostics = lsp::PublishDiagnosticsParams {
                uri: url.clone(),
                diagnostics: diagnostics.into_std(),
                version: None,
            };

            self.output
                .notification::<lsp::notification::PublishDiagnostics>(diagnostics)
                .await?;
        }

        Ok(())
    }

    /// Try to load workspace.
    fn load_workspace(
        &self,
        url: &Url,
        path: &Path,
        manifest_build: &mut Build,
        diagnostics: &mut workspace::Diagnostics,
        workspace: &Workspace,
    ) -> Result<Vec<Build>, anyhow::Error> {
        tracing::info!(url = ?url.try_to_string(), "building workspace");

        let source = match workspace.sources.get(url) {
            Some(source) => source.chunks().try_collect::<String>()?,
            None => match std::fs::read_to_string(path) {
                Ok(source) => String::try_from(source)?,
                Err(error) => {
                    return Err(error).context(url.try_to_string()?);
                }
            },
        };

        manifest_build
            .sources
            .insert(Source::with_path(url, source, path)?)?;

        let mut source_loader = WorkspaceSourceLoader::new(&self.workspace.sources);

        let manifest = workspace::prepare(&mut manifest_build.sources)
            .with_diagnostics(diagnostics)
            .with_source_loader(&mut source_loader)
            .build()?;

        let mut script_builds = Vec::new();

        for p in manifest.find_all(workspace::WorkspaceFilter::All)? {
            let Ok(url) = crate::languageserver::url::from_file_path(&p.found.path) else {
                continue;
            };

            tracing::trace!("Found manifest source: {}", url);

            let source = match workspace.sources.get(&url) {
                Some(source) => source.chunks().try_collect::<String>()?,
                None => match std::fs::read_to_string(&p.found.path) {
                    Ok(string) => String::try_from(string)?,
                    Err(err) => return Err(err).context(p.found.path.display().try_to_string()?),
                },
            };

            let mut build = Build::from_workspace();

            build
                .sources
                .insert(Source::with_path(&url, source, p.found.path)?)?;

            script_builds.try_push(build)?;
        }

        Ok(script_builds)
    }

    fn build_scripts(
        &self,
        mut build: Build,
        built: Option<&mut HashSet<Url>>,
    ) -> Result<(
        crate::Diagnostics,
        Build,
        Visitor,
        crate::doc::Visitor,
        Result<Unit, BuildError>,
    )> {
        let mut diagnostics = crate::Diagnostics::new();
        let mut source_visitor = Visitor::default();
        let mut doc_visitor = crate::doc::Visitor::new(Item::new())?;

        let mut source_loader = ScriptSourceLoader::new(&self.workspace.sources);

        let mut options = self.options.clone();

        if !build.workspace {
            options.function_body = true;
        }

        let unit = crate::prepare(&mut build.sources)
            .with_context(&self.context)
            .with_diagnostics(&mut diagnostics)
            .with_options(&options)
            .with_visitor(&mut doc_visitor)?
            .with_visitor(&mut source_visitor)?
            .with_source_loader(&mut source_loader)
            .build();

        if let Some(built) = built {
            build.visit(built);
        }

        Ok((diagnostics, build, source_visitor, doc_visitor, unit))
    }

    /// Emit diagnostics workspace.
    fn emit_workspace(
        &self,
        diagnostics: workspace::Diagnostics,
        build: &Build,
        reporter: &mut Reporter,
    ) -> Result<()> {
        if tracing::enabled!(tracing::Level::TRACE) {
            let _id_to_url = build
                .id_to_url
                .iter()
                .map(|(k, v)| Ok::<_, alloc::Error>((*k, v.try_to_string()?)))
                .try_collect::<alloc::Result<HashMap<_, _>, _>>()??;

            tracing::trace!(id_to_url = ?_id_to_url, "emitting manifest diagnostics");
        }

        for diagnostic in diagnostics.diagnostics() {
            tracing::trace!(?diagnostic, "workspace diagnostic");

            let workspace::Diagnostic::Fatal(f) = diagnostic;
            self.report(build, reporter, f.source_id(), f.error(), to_error)?;
        }

        Ok(())
    }

    /// Emit regular compile diagnostics.
    fn emit_scripts(
        &self,
        diagnostics: crate::Diagnostics,
        build: &Build,
        reporter: &mut Reporter,
    ) -> Result<()> {
        if tracing::enabled!(tracing::Level::TRACE) {
            let _id_to_url = build
                .id_to_url
                .iter()
                .map(|(k, v)| Ok::<_, alloc::Error>((*k, v.try_to_string()?)))
                .try_collect::<alloc::Result<HashMap<_, _>, _>>()??;

            tracing::trace!(id_to_url = ?_id_to_url, "emitting script diagnostics");
        }

        for diagnostic in diagnostics.diagnostics() {
            tracing::trace!(?diagnostic, id_to_url = ?build.id_to_url, "script diagnostic");

            match diagnostic {
                Diagnostic::Fatal(f) => match f.kind() {
                    FatalDiagnosticKind::CompileError(e) => {
                        self.report(build, reporter, f.source_id(), e, to_error)?;
                    }
                    FatalDiagnosticKind::LinkError(e) => match e {
                        LinkerError::MissingFunction { hash, spans } => {
                            for (span, source_id) in spans {
                                let (Some(url), Some(source)) = (
                                    build.id_to_url.get(source_id),
                                    build.sources.get(*source_id),
                                ) else {
                                    continue;
                                };

                                let range = self.encoding.source_range(source, *span)?;

                                let diagnostics = reporter.entry(url);

                                diagnostics.try_push(to_error(
                                    range,
                                    format_args!("Missing function with hash `{}`", hash),
                                )?)?;
                            }
                        }
                    },
                    FatalDiagnosticKind::Internal(e) => {
                        report_without_span(build, reporter, f.source_id(), e, to_error)?;
                    }
                },
                Diagnostic::Warning(e) => {
                    self.report(build, reporter, e.source_id(), e, to_warning)?;
                }
                Diagnostic::RuntimeWarning(_) => {}
            }
        }

        Ok(())
    }

    /// Convert the given span and error into an error diagnostic.
    fn report<E, R>(
        &self,
        build: &Build,
        reporter: &mut Reporter,
        source_id: SourceId,
        error: E,
        report: R,
    ) -> Result<()>
    where
        E: fmt::Display,
        E: Spanned,
        R: Fn(lsp::Range, E) -> alloc::Result<lsp::Diagnostic>,
    {
        let span = error.span();

        let (Some(source), Some(url)) = (
            build.sources.get(source_id),
            build.id_to_url.get(&source_id),
        ) else {
            return Ok(());
        };

        let range = self.encoding.source_range(source, span)?;

        reporter.entry(url).try_push(report(range, error)?)?;
        Ok(())
    }
}

/// A collection of open sources.
#[derive(Default)]
pub(super) struct Workspace {
    /// Found workspace root.
    pub(super) manifest_path: Option<(Url, PathBuf)>,
    /// Sources that might be modified.
    sources: HashMap<Url, ServerSource>,
    /// A source that has been removed.
    removed: Vec<Url>,
}

impl Workspace {
    /// Insert the given source at the given url.
    pub(super) fn insert_source(
        &mut self,
        url: Url,
        text: String,
        language: Language,
    ) -> alloc::Result<Option<ServerSource>> {
        let source = ServerSource {
            content: Rope::from_str(text.as_str()),
            index: Default::default(),
            build_sources: None,
            language,
            unit: None,
            docs: None,
        };

        self.sources.try_insert(url, source)
    }

    /// Get the source at the given url.
    pub(super) fn get(&self, url: &Url) -> Option<&ServerSource> {
        self.sources.get(url)
    }

    /// Get the mutable source at the given url.
    pub(super) fn get_mut(&mut self, url: &Url) -> Option<&mut ServerSource> {
        self.sources.get_mut(url)
    }

    /// Remove the given url as a source.
    pub(super) fn remove(&mut self, url: &Url) -> Result<()> {
        if self.sources.remove(url).is_some() {
            self.removed.try_push(url.clone())?;
        }

        Ok(())
    }
}

/// A single open source.
pub(super) struct ServerSource {
    /// The content of the current source.
    content: Rope,
    /// Indexes used to answer queries.
    index: Index,
    /// Loaded Rune sources for this source file. Will be present after the
    /// source file has been built.
    build_sources: Option<Arc<Sources>>,
    /// The language of the source.
    language: Language,
    /// The compiled unit
    unit: Option<Unit>,
    /// Comments captured
    docs: Option<Arc<crate::doc::Visitor>>,
}

impl ServerSource {
    /// Find the definition at the given span.
    pub(super) fn find_definition_at(&self, span: Span) -> Option<&Definition> {
        let (found_span, definition) = self.index.definitions.range(..=span).next_back()?;

        if span.start >= found_span.start && span.end <= found_span.end {
            tracing::trace!("found {:?}", definition);
            return Some(definition);
        }

        None
    }

    /// Modify the given lsp range in the file.
    pub(super) fn modify_lsp_range(
        &mut self,
        encoding: &StateEncoding,
        range: lsp::Range,
        content: &str,
    ) -> Result<()> {
        let start = encoding.rope_position(&self.content, range.start)?;
        let end = encoding.rope_position(&self.content, range.end)?;
        self.modify_range(start, end, content)
    }

    fn modify_range(&mut self, start: usize, end: usize, content: &str) -> Result<()> {
        self.content.try_remove(start..end)?;

        if !content.is_empty() {
            self.content.try_insert(start, content)?;
        }

        Ok(())
    }

    /// Iterate over the text chunks in the source.
    pub(super) fn chunks(&self) -> impl Iterator<Item = &str> {
        self.content.chunks()
    }

    /// Returns the best match wordwise when looking back. Note that this will also include the *previous* terminal token.
    pub(crate) fn looking_back(&self, offset: usize) -> alloc::Result<Option<(String, usize)>> {
        let (chunk, start_byte, _, _) = self.content.chunk_at_byte(offset);

        // The set of tokens that delimit symbols.
        let x: &[_] = &[
            ',', ';', '(', '.', '=', '+', '-', '*', '/', '}', '{', ']', '[', ')',
        ];

        let end_search = (offset - start_byte + 1).min(chunk.len());

        let Some(looking_back) = chunk[..end_search].rfind(x) else {
            return Ok(None);
        };

        Ok(Some((
            chunk[looking_back..end_search].trim().try_to_owned()?,
            start_byte + looking_back,
        )))
    }

    pub(super) fn get_docs_by_hash(&self, hash: crate::Hash) -> Option<&VisitorData> {
        self.docs.as_ref().and_then(|docs| docs.get_by_hash(hash))
    }
}

impl fmt::Display for ServerSource {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.content)
    }
}

/// Convert the given span and error into an error diagnostic.
fn report_without_span<E, R>(
    build: &Build,
    reporter: &mut Reporter,
    source_id: SourceId,
    error: E,
    report: R,
) -> Result<()>
where
    E: fmt::Display,
    R: Fn(lsp::Range, E) -> alloc::Result<lsp::Diagnostic>,
{
    let Some(url) = build.id_to_url.get(&source_id) else {
        return Ok(());
    };

    let range = lsp::Range::default();
    let diagnostics = reporter.entry(url);
    diagnostics.try_push(report(range, error)?)?;
    Ok(())
}

/// Convert the given span and error into an error diagnostic.
fn to_error<E>(range: lsp::Range, error: E) -> alloc::Result<lsp::Diagnostic>
where
    E: fmt::Display,
{
    display_to_diagnostic(range, error, lsp::DiagnosticSeverity::ERROR)
}

/// Convert the given span and error into a warning diagnostic.
fn to_warning<E>(range: lsp::Range, error: E) -> alloc::Result<lsp::Diagnostic>
where
    E: fmt::Display,
{
    display_to_diagnostic(range, error, lsp::DiagnosticSeverity::WARNING)
}

/// Convert a span and something displayeable into diagnostics.
fn display_to_diagnostic<E>(
    range: lsp::Range,
    error: E,
    severity: lsp::DiagnosticSeverity,
) -> alloc::Result<lsp::Diagnostic>
where
    E: fmt::Display,
{
    Ok(lsp::Diagnostic {
        range,
        severity: Some(severity),
        code: None,
        code_description: None,
        source: None,
        message: error.try_to_string()?.into_std(),
        related_information: None,
        tags: None,
        data: None,
    })
}

#[derive(Default)]
pub(super) struct Index {
    /// Spans mapping to their corresponding definitions.
    definitions: BTreeMap<Span, Definition>,
}

/// A definition source.
#[derive(Debug, TryClone)]
pub(super) enum DefinitionSource {
    /// Only a file source.
    Source(SourceId),
    /// A location definition (source and span).
    Location(Location),
    /// A complete compile source.
    SourceMeta(SourceMeta),
}

impl DefinitionSource {
    fn span(&self) -> Span {
        match self {
            Self::Source(..) => Span::empty(),
            Self::Location(location) => location.span,
            Self::SourceMeta(compile_source) => compile_source.location.span,
        }
    }

    fn source_id(&self) -> SourceId {
        match self {
            Self::Source(source_id) => *source_id,
            Self::Location(location) => location.source_id,
            Self::SourceMeta(compile_source) => compile_source.location.source_id,
        }
    }

    fn path(&self) -> Option<&Path> {
        match self {
            Self::SourceMeta(compile_source) => compile_source.path.as_deref(),
            _ => None,
        }
    }
}

#[derive(Debug, TryClone)]
pub(super) struct Definition {
    /// The kind of the definition.
    pub(super) kind: DefinitionKind,
    /// The id of the source id the definition corresponds to.
    pub(super) source: DefinitionSource,
}

#[derive(Debug, TryClone, Clone, Copy)]
#[try_clone(copy)]
pub(super) enum DefinitionKind {
    /// A unit struct.
    EmptyStruct,
    /// A tuple struct.
    TupleStruct,
    /// A struct.
    Struct,
    /// A unit variant.
    UnitVariant,
    /// A tuple variant.
    TupleVariant,
    /// A struct variant.
    StructVariant,
    /// An enum.
    Enum,
    /// A function.
    Function,
    /// An associated function.
    AssociatedFunction,
    /// A local variable.
    Local,
    /// A module that can be jumped to.
    Module,
}

#[derive(Default)]
struct Visitor {
    indexes: HashMap<SourceId, Index>,
}

impl Visitor {
    /// Convert visitor back into an index.
    pub(super) fn into_indexes(self) -> HashMap<SourceId, Index> {
        self.indexes
    }
}

impl CompileVisitor for Visitor {
    fn visit_meta(&mut self, location: &dyn Located, meta: MetaRef<'_>) -> Result<(), MetaError> {
        let Some(source) = meta.source else {
            return Ok(());
        };

        let kind = match &meta.kind {
            meta::Kind::Struct {
                fields: meta::Fields::Empty,
                ..
            } => DefinitionKind::EmptyStruct,
            meta::Kind::Struct {
                fields: meta::Fields::Unnamed(..),
                ..
            } => DefinitionKind::TupleStruct,
            meta::Kind::Struct {
                fields: meta::Fields::Named(..),
                ..
            } => DefinitionKind::Struct,
            meta::Kind::Variant {
                fields: meta::Fields::Empty,
                ..
            } => DefinitionKind::UnitVariant,
            meta::Kind::Variant {
                fields: meta::Fields::Unnamed(..),
                ..
            } => DefinitionKind::TupleVariant,
            meta::Kind::Variant {
                fields: meta::Fields::Named(..),
                ..
            } => DefinitionKind::StructVariant,
            meta::Kind::Enum { .. } => DefinitionKind::Enum,
            meta::Kind::Function {
                associated: None, ..
            } => DefinitionKind::Function,
            meta::Kind::Function {
                associated: Some(..),
                ..
            } => DefinitionKind::AssociatedFunction,
            _ => return Ok(()),
        };

        let definition = Definition {
            kind,
            source: DefinitionSource::SourceMeta(source.try_clone()?),
        };

        let location = location.location();

        let index = self.indexes.entry(location.source_id).or_try_default()?;

        if let Some(_def) = index.definitions.insert(location.span, definition) {
            tracing::warn!("Replaced definition: {:?}", _def.kind);
        }

        Ok(())
    }

    fn visit_variable_use(
        &mut self,
        source_id: SourceId,
        var_span: &dyn Spanned,
        span: &dyn Spanned,
    ) -> Result<(), MetaError> {
        let definition = Definition {
            kind: DefinitionKind::Local,
            source: DefinitionSource::Location(Location::new(source_id, var_span.span())),
        };

        let index = self.indexes.entry(source_id).or_try_default()?;

        if let Some(_def) = index.definitions.insert(span.span(), definition) {
            tracing::warn!("replaced definition: {:?}", _def.kind);
        }

        Ok(())
    }

    fn visit_mod(&mut self, location: &dyn Located) -> Result<(), MetaError> {
        let location = location.location();

        let definition = Definition {
            kind: DefinitionKind::Module,
            source: DefinitionSource::Source(location.source_id),
        };

        let index = self.indexes.entry(location.source_id).or_try_default()?;

        if let Some(_def) = index.definitions.insert(location.span, definition) {
            tracing::warn!("replaced definition: {:?}", _def.kind);
        }

        Ok(())
    }
}

struct ScriptSourceLoader<'a> {
    sources: &'a HashMap<Url, ServerSource>,
    base: compile::FileSourceLoader,
}

impl<'a> ScriptSourceLoader<'a> {
    /// Construct a new source loader.
    pub(super) fn new(sources: &'a HashMap<Url, ServerSource>) -> Self {
        Self {
            sources,
            base: compile::FileSourceLoader::new(),
        }
    }

    /// Generate a collection of URl candidates.
    fn candidates(
        root: &Path,
        item: &Item,
        span: &dyn Spanned,
    ) -> compile::Result<Option<[(Url, PathBuf); 2]>> {
        let mut base = root.try_to_owned()?;

        let mut it = item.iter().peekable();
        let mut last = None;

        while let Some(c) = it.next() {
            if it.peek().is_none() {
                let ComponentRef::Str(string) = c else {
                    return Ok(None);
                };

                last = Some(string);
                break;
            }

            let ComponentRef::Str(string) = c else {
                return Ok(None);
            };

            base.push(string);
        }

        let Some(last) = last else {
            return Ok(None);
        };

        let mut a = base.clone();
        a.push(format!("{last}.rn"));

        let mut b = base;
        b.push(last);
        b.push("mod.rn");

        let a_url = crate::languageserver::url::from_file_path(&a).with_span(span)?;
        let b_url = crate::languageserver::url::from_file_path(&b).with_span(span)?;

        Ok(Some([(a_url, a), (b_url, b)]))
    }
}

impl crate::compile::SourceLoader for ScriptSourceLoader<'_> {
    fn load(&mut self, root: &Path, item: &Item, span: &dyn Spanned) -> compile::Result<Source> {
        tracing::trace!("load {} (root: {})", item, root.display());

        if let Some(candidates) = Self::candidates(root, item, span)? {
            for (url, path) in candidates {
                if let Some(s) = self.sources.get(&url) {
                    return Ok(Source::with_path(url, s.try_to_string()?, path)?);
                }
            }
        }

        self.base.load(root, item, span)
    }
}

struct WorkspaceSourceLoader<'a> {
    sources: &'a HashMap<Url, ServerSource>,
    base: workspace::FileSourceLoader,
}

impl<'a> WorkspaceSourceLoader<'a> {
    /// Construct a new source loader.
    pub(super) fn new(sources: &'a HashMap<Url, ServerSource>) -> Self {
        Self {
            sources,
            base: workspace::FileSourceLoader::new(),
        }
    }
}

impl workspace::SourceLoader for WorkspaceSourceLoader<'_> {
    fn load(&mut self, span: Span, path: &Path) -> Result<Source, WorkspaceError> {
        if let Ok(url) = crate::languageserver::url::from_file_path(path) {
            if let Some(s) = self.sources.get(&url) {
                let source = s.try_to_string().with_span(span)?;
                return Ok(Source::with_path(url, source, path).with_span(span)?);
            }
        }

        self.base.load(span, path)
    }
}