crates/proc-macro-srv/src/abis/mod.rs

   1 //! Procedural macros are implemented by compiling the macro providing crate
   2 //! to a dynamic library with a particular ABI which the compiler uses to expand
   3 //! macros. Unfortunately this ABI is not specified and can change from version
   4 //! to version of the compiler. To support this we copy the ABI from the rust
   5 //! compiler into submodules of this module (e.g proc_macro_srv::abis::abi_1_47).
   6 //!
   7 //! All of these ABIs are subsumed in the `Abi` enum, which exposes a simple
   8 //! interface the rest of rust analyzer can use to talk to the macro
   9 //! provider.
  10 //!
  11 //! # Adding a new ABI
  12 //!
  13 //! To add a new ABI you'll need to copy the source of the target proc_macro
  14 //! crate from the source tree of the Rust compiler into this directory tree.
  15 //! Then you'll need to modify it
  16 //! - Remove any feature! or other things which won't compile on stable
  17 //! - change any absolute imports to relative imports within the ABI tree
  18 //!
  19 //! Then you'll need to add a branch to the `Abi` enum and an implementation of
  20 //! `Abi::expand`, `Abi::list_macros` and `Abi::from_lib` for the new ABI. See
  21 //! `proc_macro_srv/src/abis/abi_1_47/mod.rs` for an example. Finally you'll
  22 //! need to update the conditionals in `Abi::from_lib` to return your new ABI
  23 //! for the relevant versions of the rust compiler
  24 //!
  25
  26 mod abi_1_58;
  27 mod abi_1_63;
  28 mod abi_1_64;
  29
  30 // Used by `test/utils.rs`
  31 #[cfg(test)]
  32 pub(crate) use abi_1_64::TokenStream as TestTokenStream;
  33
  34 use super::dylib::LoadProcMacroDylibError;
  35 pub(crate) use abi_1_58::Abi as Abi_1_58;
  36 pub(crate) use abi_1_63::Abi as Abi_1_63;
  37 pub(crate) use abi_1_64::Abi as Abi_1_64;
  38 use libloading::Library;
  39 use proc_macro_api::{ProcMacroKind, RustCInfo};
  40
  41 pub struct PanicMessage {
  42     message: Option<String>,
  43 }
  44
  45 impl PanicMessage {
  46     pub fn as_str(&self) -> Option<String> {
  47         self.message.clone()
  48     }
  49 }
  50
  51 pub(crate) enum Abi {
  52     Abi1_58(Abi_1_58),
  53     Abi1_63(Abi_1_63),
  54     Abi1_64(Abi_1_64),
  55 }
  56
  57 impl Abi {
  58     /// Load a new ABI.
  59     ///
  60     /// # Arguments
  61     ///
  62     /// *`lib` - The dynamic library containing the macro implementations
  63     /// *`symbol_name` - The symbol name the macros can be found attributes
  64     /// *`info` - RustCInfo about the compiler that was used to compile the
  65     ///           macro crate. This is the information we use to figure out
  66     ///           which ABI to return
  67     pub fn from_lib(
  68         lib: &Library,
  69         symbol_name: String,
  70         info: RustCInfo,
  71     ) -> Result<Abi, LoadProcMacroDylibError> {
  72         // FIXME: this should use exclusive ranges when they're stable
  73         // https://github.com/rust-lang/rust/issues/37854
  74         match (info.version.0, info.version.1) {
  75             (1, 58..=62) => {
  76                 let inner = unsafe { Abi_1_58::from_lib(lib, symbol_name) }?;
  77                 Ok(Abi::Abi1_58(inner))
  78             }
  79             (1, 63) => {
  80                 let inner = unsafe { Abi_1_63::from_lib(lib, symbol_name) }?;
  81                 Ok(Abi::Abi1_63(inner))
  82             }
  83             (1, 64..) => {
  84                 let inner = unsafe { Abi_1_64::from_lib(lib, symbol_name) }?;
  85                 Ok(Abi::Abi1_64(inner))
  86             }
  87             _ => Err(LoadProcMacroDylibError::UnsupportedABI),
  88         }
  89     }
  90
  91     pub fn expand(
  92         &self,
  93         macro_name: &str,
  94         macro_body: &tt::Subtree,
  95         attributes: Option<&tt::Subtree>,
  96     ) -> Result<tt::Subtree, PanicMessage> {
  97         match self {
  98             Self::Abi1_58(abi) => abi.expand(macro_name, macro_body, attributes),
  99             Self::Abi1_63(abi) => abi.expand(macro_name, macro_body, attributes),
 100             Self::Abi1_64(abi) => abi.expand(macro_name, macro_body, attributes),
 101         }
 102     }
 103
 104     pub fn list_macros(&self) -> Vec<(String, ProcMacroKind)> {
 105         match self {
 106             Self::Abi1_58(abi) => abi.list_macros(),
 107             Self::Abi1_63(abi) => abi.list_macros(),
 108             Self::Abi1_64(abi) => abi.list_macros(),
 109         }
 110     }
 111 }