rust-analyzer/crates/proc-macro-srv/src/server.rs

//! proc-macro server implementation
//!
//! Based on idea from <https://github.com/fedochet/rust-proc-macro-expander>
//! The lib-proc-macro server backend is `TokenStream`-agnostic, such that
//! we could provide any TokenStream implementation.
//! The original idea from fedochet is using proc-macro2 as backend,
//! we use tt instead for better integration with RA.
//!
//! FIXME: No span and source file information is implemented yet

use proc_macro::bridge;

mod token_stream;
pub use token_stream::TokenStream;

pub mod rust_analyzer_span;
mod symbol;
pub mod token_id;
pub use symbol::*;
use syntax::ast::{self, HasModuleItem, IsString};
use tt::Spacing;

fn delim_to_internal<S>(d: proc_macro::Delimiter, span: bridge::DelimSpan<S>) -> tt::Delimiter<S> {
    let kind = match d {
        proc_macro::Delimiter::Parenthesis => tt::DelimiterKind::Parenthesis,
        proc_macro::Delimiter::Brace => tt::DelimiterKind::Brace,
        proc_macro::Delimiter::Bracket => tt::DelimiterKind::Bracket,
        proc_macro::Delimiter::None => tt::DelimiterKind::Invisible,
    };
    tt::Delimiter { open: span.open, close: span.close, kind }
}

fn delim_to_external<S>(d: tt::Delimiter<S>) -> proc_macro::Delimiter {
    match d.kind {
        tt::DelimiterKind::Parenthesis => proc_macro::Delimiter::Parenthesis,
        tt::DelimiterKind::Brace => proc_macro::Delimiter::Brace,
        tt::DelimiterKind::Bracket => proc_macro::Delimiter::Bracket,
        tt::DelimiterKind::Invisible => proc_macro::Delimiter::None,
    }
}

#[allow(unused)]
fn spacing_to_internal(spacing: proc_macro::Spacing) -> Spacing {
    match spacing {
        proc_macro::Spacing::Alone => Spacing::Alone,
        proc_macro::Spacing::Joint => Spacing::Joint,
    }
}

#[allow(unused)]
fn spacing_to_external(spacing: Spacing) -> proc_macro::Spacing {
    match spacing {
        Spacing::Alone => proc_macro::Spacing::Alone,
        Spacing::Joint => proc_macro::Spacing::Joint,
    }
}

fn literal_to_external(literal: ast::LiteralKind) -> Option<proc_macro::bridge::LitKind> {
    Some(match lit.kind() {
        ast::LiteralKind::String(data) => {
            if data.is_raw() {
                bridge::LitKind::StrRaw(raw_delimiter_count(data)?)
            } else {
                bridge::LitKind::Str
            }
        }
        ast::LiteralKind::ByteString(data) => {
            if data.is_raw() {
                bridge::LitKind::ByteStrRaw(raw_delimiter_count(data)?)
            } else {
                bridge::LitKind::ByteStr
            }
        }
        ast::LiteralKind::CString(data) => {
            if data.is_raw() {
                bridge::LitKind::CStrRaw(raw_delimiter_count(data)?)
            } else {
                bridge::LitKind::CStr
            }
        }
        ast::LiteralKind::IntNumber(num) => bridge::LitKind::Integer,
        ast::LiteralKind::FloatNumber(num) => bridge::LitKind::Float,
        ast::LiteralKind::Char(_) => bridge::LitKind::Char,
        ast::LiteralKind::Byte(_) => bridge::LitKind::Byte,
        ast::LiteralKind::Bool(_) => unreachable!(),
    })
}

fn raw_delimiter_count<S: IsString>(s: S) -> Option<u8> {
    let text = s.text();
    let quote_range = s.text_range_between_quotes()?;
    let range_start = s.syntax().text_range().start();
    text[TextRange::up_to((quote_range - range_start).start())].matches('#').count().try_into().ok()
}

fn str_to_lit_node(input: &str) -> Option<ast::Literal> {
    let input = input.trim();
    let source_code = format!("fn f() {{ let _ = {input}; }}");

    let parse = ast::SourceFile::parse(&source_code);
    let file = parse.tree();

    let ast::Item::Fn(func) = file.items().next()? else { return None };
    let ast::Stmt::LetStmt(stmt) = func.body()?.stmt_list()?.statements().next()? else {
        return None;
    };
    let ast::Expr::Literal(lit) = stmt.initializer()? else { return None };

    Some(lit)
}

struct LiteralFormatter<S>(bridge::Literal<S, Symbol>);

impl<S> LiteralFormatter<S> {
    /// Invokes the callback with a `&[&str]` consisting of each part of the
    /// literal's representation. This is done to allow the `ToString` and
    /// `Display` implementations to borrow references to symbol values, and
    /// both be optimized to reduce overhead.
    fn with_stringify_parts<R>(
        &self,
        interner: SymbolInternerRef,
        f: impl FnOnce(&[&str]) -> R,
    ) -> R {
        /// Returns a string containing exactly `num` '#' characters.
        /// Uses a 256-character source string literal which is always safe to
        /// index with a `u8` index.
        fn get_hashes_str(num: u8) -> &'static str {
            const HASHES: &str = "\
                        ################################################################\
                        ################################################################\
                        ################################################################\
                        ################################################################\
                        ";
            const _: () = assert!(HASHES.len() == 256);
            &HASHES[..num as usize]
        }

        self.with_symbol_and_suffix(interner, |symbol, suffix| match self.0.kind {
            bridge::LitKind::Byte => f(&["b'", symbol, "'", suffix]),
            bridge::LitKind::Char => f(&["'", symbol, "'", suffix]),
            bridge::LitKind::Str => f(&["\"", symbol, "\"", suffix]),
            bridge::LitKind::StrRaw(n) => {
                let hashes = get_hashes_str(n);
                f(&["r", hashes, "\"", symbol, "\"", hashes, suffix])
            }
            bridge::LitKind::ByteStr => f(&["b\"", symbol, "\"", suffix]),
            bridge::LitKind::ByteStrRaw(n) => {
                let hashes = get_hashes_str(n);
                f(&["br", hashes, "\"", symbol, "\"", hashes, suffix])
            }
            _ => f(&[symbol, suffix]),
        })
    }

    fn with_symbol_and_suffix<R>(
        &self,
        interner: SymbolInternerRef,
        f: impl FnOnce(&str, &str) -> R,
    ) -> R {
        let symbol = self.0.symbol.text(interner);
        let suffix = self.0.suffix.map(|s| s.text(interner)).unwrap_or_default();
        f(symbol.as_str(), suffix.as_str())
    }
}