1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
use generate::generate_impl;
use module::get_struct_from_path;
use path::{get_root_src_path, parse_input_paths};
use proc_macro::TokenStream;
use syn::{parse_macro_input, Expr, ExprPath, ItemStruct};
/// Helper macro, which attaches an error to a given span.
macro_rules! err {
($span:expr, $($text:expr),*) => {
{
let message = format!($($text,)*);
let span = $span.span();
quote::quote_spanned!( span => compile_error!(#message); )
}
}
}
// Uncomment this as soon as proc_macro_diagnostic land in stable.
//
//#![feature(proc_macro_diagnostic)]
///// Helper macro, which attaches an error to a given span.
//macro_rules! err {
// ($span:ident, $($text:expr),*) => {
// $span.span()
// .unwrap()
// .error(format!($($text,)*))
// .emit();
// }
//}
/// Helper macro, which takes a result.
/// Ok(T) => simply return the T
/// Err(err) => Emits an compiler error on the given span with the provided error message.
/// Also returns early with `None`.
/// `None` is used throughout this crate as a gracefull failure.
/// That way all code that can be created is being generated and the user sees all
/// errors without the macro code panicking.
macro_rules! ok_or_err_return {
($expr:expr, $span:ident, $($text:expr),*) => {
match $expr {
Ok(result) => result,
Err(error) => {
return Err(err!($span, $($text,)* error));
}
}
}
}
mod generate;
mod module;
mod path;
/// Implement the `struct_merge::StructMerge<S>` trait for all given targets.
///
/// Eiter a single struct or a list of structs can be provided.
/// `StructMerge<T>` will then be implemented on each given target struct.
///
/// Examples:
/// - `#[struct_merge(crate::structs::Target)]`
/// - `#[struct_merge([crate::structs::Target, crate:structs::OtherTarget])]`
///
/// The targets struct paths have to be
/// - absolute
/// - relative to the current crate
/// - contained in this crate
///
/// `struct.rs`
/// ```ignore
/// use struct_merge::struct_merge;
///
/// pub struct Target {
/// pub test: String,
/// }
///
/// pub struct OtherTarget {
/// pub test: String,
/// }
///
/// #[struct_merge([crate::structs::Target, crate:structs::OtherTarget])]
/// pub struct Test {
/// pub test: String,
/// }
/// ```
#[proc_macro_attribute]
pub fn struct_merge(args: TokenStream, struct_ast: TokenStream) -> TokenStream {
struct_merge_base(args, struct_ast, Mode::Owned)
}
/// Implement the `struct_merge::StructMergeRef<S>` trait for all given targets.
///
/// All fields to be merged must implement the [std::clone::Clone] trait.
///
/// Eiter a single struct or a list of structs can be provided.
/// `StructMergeRef<T>` will then be implemented on each given target struct.
///
/// Examples:
/// - `#[struct_merge_ref(crate::structs::Target)]`
/// - `#[struct_merge_ref([crate::structs::Target, crate:structs::OtherTarget])]`
///
/// The targets struct paths have to be
/// - absolute
/// - relative to the current crate
/// - contained in this crate
///
/// `struct.rs`
/// ```ignore
/// use struct_merge::struct_merge_ref;
///
/// pub struct Target {
/// pub test: String,
/// }
///
/// pub struct OtherTarget {
/// pub test: String,
/// }
///
/// #[struct_merge_ref([crate::structs::Target, crate:structs::OtherTarget])]
/// pub struct Test {
/// pub test: String,
/// }
/// ```
#[proc_macro_attribute]
pub fn struct_merge_ref(args: TokenStream, struct_ast: TokenStream) -> TokenStream {
struct_merge_base(args, struct_ast, Mode::Borrowed)
}
/// This enum is used to differentiate between owned and borrowed merge behavior.
/// Depending on this, we need to generate another trait impl and slightly different code.
enum Mode {
Owned,
Borrowed,
}
pub(crate) struct Parameters {
pub src_struct: ItemStruct,
pub target_path: ExprPath,
pub target_struct: ItemStruct,
}
fn struct_merge_base(args: TokenStream, mut struct_ast: TokenStream, mode: Mode) -> TokenStream {
let parsed_args = parse_macro_input!(args as Expr);
// Check if we can find the src root path of this crate.
// Return early if it doesn't exist.
let src_root_path = match get_root_src_path(&parsed_args) {
Some(path) => path,
None => return struct_ast,
};
// Parse the main macro input as a struct.
// We work on a clone of the struct ast.
// That way we don't have to parse it lateron when we return it.
let cloned_struct_ast = struct_ast.clone();
let src_struct = parse_macro_input!(cloned_struct_ast as ItemStruct);
// Get the input paths from the given argument expressions.
let paths = parse_input_paths(parsed_args);
// Go through all paths and process the respective struct.
let mut impls = Vec::new();
for target_path in paths {
// Make sure we found the struct at that path.
let target_struct = match get_struct_from_path(src_root_path.clone(), target_path.clone()) {
Ok(ast) => ast,
Err(error) => {
impls.push(error);
continue;
}
};
let params = Parameters {
src_struct: src_struct.clone(),
target_path,
target_struct,
};
// Generate the MergeStruct trait implementations.
match generate_impl(&mode, params) {
Ok(ast) => impls.push(ast),
Err(error) => {
impls.push(error);
continue;
}
}
}
// Merge all generated pieces of the code with the original unaltered struct.
struct_ast.extend(impls.into_iter().map(TokenStream::from));
// Hand the final output tokens back to the compiler.
struct_ast
}