ra_ap_proc_macro_api 0.0.336

RPC Api for the `proc-macro-srv` crate of rust-analyzer.
Documentation
//! Bidirectional protocol messages
#![expect(clippy::disallowed_types)]

use std::{
    collections::{HashMap, HashSet},
    io::{self, BufRead, Write},
    ops::Range,
};

use paths::Utf8PathBuf;
use serde::{Deserialize, Serialize};

use crate::{
    ProcMacroKind,
    legacy_protocol::msg::{FlatTree, Message, PanicMessage, ServerConfig},
    transport::postcard,
};

#[derive(Debug, Serialize, Deserialize)]
pub enum SubRequest {
    FilePath {
        file_id: u32,
    },
    SourceText {
        file_id: u32,
        ast_id: u32,
        start: u32,
        end: u32,
    },
    LocalFilePath {
        file_id: u32,
    },
    LineColumn {
        file_id: u32,
        ast_id: u32,
        offset: u32,
    },
    ByteRange {
        file_id: u32,
        ast_id: u32,
        start: u32,
        end: u32,
    },
    SpanSource {
        file_id: u32,
        ast_id: u32,
        start: u32,
        end: u32,
        ctx: u32,
    },
    SpanParent {
        file_id: u32,
        ast_id: u32,
        start: u32,
        end: u32,
        ctx: u32,
    },
    SpanJoin {
        file_id: u32,
        ast_id_first: u32,
        start_first: u32,
        end_first: u32,
        ctx_first: u32,
        ast_id_second: u32,
        start_second: u32,
        end_second: u32,
        ctx_second: u32,
    },
}

#[derive(Debug, Serialize, Deserialize)]
pub enum SubResponse {
    FilePathResult {
        name: String,
    },
    SourceTextResult {
        text: Option<String>,
    },
    LocalFilePathResult {
        name: Option<String>,
    },
    /// Line and column are 1-based.
    LineColumnResult {
        line: u32,
        column: u32,
    },
    ByteRangeResult {
        range: Range<usize>,
    },
    SpanSourceResult {
        file_id: u32,
        ast_id: u32,
        start: u32,
        end: u32,
        ctx: u32,
    },
    SpanParentResult {
        parent_span: Option<ParentSpan>,
    },
    SpanJoinResult {
        span: Option<SpanJoin>,
    },
    Cancel {
        reason: String,
    },
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ParentSpan {
    pub file_id: u32,
    pub ast_id: u32,
    pub start: u32,
    pub end: u32,
    pub ctx: u32,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct SpanJoin {
    pub ast_id: u32,
    pub start: u32,
    pub end: u32,
    pub ctx: u32,
}

#[expect(clippy::large_enum_variant)]
#[derive(Debug, Serialize, Deserialize)]
pub enum BidirectionalMessage {
    Request(Request),
    Response(Response),
    SubRequest(SubRequest),
    SubResponse(SubResponse),
}

#[derive(Debug, Serialize, Deserialize)]
pub enum Request {
    ListMacros(ListMacros),
    ExpandMacro(Box<ExpandMacro>),
    ApiVersionCheck(ApiVersionCheck),
    SetConfig(ServerConfig),
}

#[expect(clippy::large_enum_variant)]
#[derive(Debug, Serialize, Deserialize)]
pub enum Response {
    ListMacros(Result<Vec<(String, ProcMacroKind)>, String>),
    ApiVersionCheck(u32),
    SetConfig(ServerConfig),
    ExpandMacro(Result<ExpandMacroResponse, PanicMessage>),
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ListMacros {
    pub dylib_path: Utf8PathBuf,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ApiVersionCheck {}

#[derive(Debug, Serialize, Deserialize)]
pub struct ExpandMacro {
    pub lib: Utf8PathBuf,
    pub env: Vec<(String, String)>,
    pub current_dir: Option<String>,
    pub data: ExpandMacroData,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ExpandMacroResponse {
    pub tree: FlatTree,
    pub span_data_table: Vec<u32>,
    pub tracked_env_vars: HashMap<Box<str>, Option<Box<str>>>,
    pub tracked_paths: HashSet<Box<str>>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ExpandMacroData {
    pub macro_body: FlatTree,
    pub macro_name: String,
    pub attributes: Option<FlatTree>,
    #[serde(default)]
    pub has_global_spans: ExpnGlobals,
    #[serde(default)]
    pub span_data_table: Vec<u32>,
}

#[derive(Clone, Copy, Default, Debug, Serialize, Deserialize)]
pub struct ExpnGlobals {
    pub def_site: usize,
    pub call_site: usize,
    pub mixed_site: usize,
}

impl Message for BidirectionalMessage {
    type Buf = Vec<u8>;

    fn read(inp: &mut dyn BufRead, buf: &mut Self::Buf) -> io::Result<Option<Self>> {
        Ok(match postcard::read(inp, buf)? {
            None => None,
            Some(buf) => Some(postcard::decode(buf)?),
        })
    }
    fn write(self, out: &mut dyn Write) -> io::Result<()> {
        let value = postcard::encode(&self)?;
        postcard::write(out, &value)
    }
}