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
//! A procedural macro that allows you to derive `std::ops::Deref` and `std::ops::DerefMut` for
//! your structs. This macro can only be derived on structs **with atleast one field**. You can
//! specify which field you want to be deref'ed to with the `#[deref]` and allow mutable
//! dereferencing with `#[deref(mutable)]`.
//!
//! ## Deriving `std::ops::Deref`
//! ```ignore
//! use std::collections::HashMap;
//!
//! use derefable::Derefable;
//!
//! #[derive(Default, Derefable)]
//! struct Map {
//!     #[deref]
//!     inner: HashMap<&'static str, &'static str>
//! }
//!
//! fn main() {
//!     let map = Map::default();
//!
//!     assert!(map.is_empty());
//! }
//! ```
//!
//! ## Deriving `std::ops::DerefMut`
//! ```ignore
//! use std::collections::HashMap;
//!
//! use derefable::Derefable;
//!
//! #[derive(Default, Derefable)]
//! struct MutableMap {
//!     #[deref(mutable)]
//!     inner: HashMap<&'static str, &'static str>
//! }
//!
//! fn main() {
//!     let mut map = MutableMap::default();
//!
//!     map.insert("Hello", "World");
//!
//!     assert_eq!(map.get("Hello"), Some("World"));
//! }
//! ```

extern crate proc_macro;
extern crate proc_macro2;

use proc_macro::TokenStream;
use proc_macro2::{Ident, Span};
use quote::{quote, ToTokens};
use syn::*;

#[proc_macro_derive(Derefable, attributes(deref))]
pub fn derefable_derive(input: TokenStream) -> TokenStream {
    let ast = syn::parse(input).unwrap();

    impl_derefable(&ast)
}

fn impl_derefable(ast: &syn::DeriveInput) -> TokenStream {
    let name = &ast.ident;

    let data = match ast.data {
        Data::Struct(ref s) => s,
        _ => {
            // name.span()
            //     .unstable()
            //     .error("`#[derive(Derefable)]` is only available for structs")
            //     .emit();

            // return TokenStream::new()
            panic!("`#[derive(Derefable)]` is only available for structs")
        }
    };

    match data.fields {
        Fields::Unit => {
            // data.span()
            //     .unstable()
            //     .error("`#[derive(Derefable)]` requires a field to be able to deref")
            //     .emit();

            // return TokenStream::new()
            panic!("`#[derive(Derefable)]` requires a field to be able to deref")
        }
        _ => {}
    }

    let mut deref_field = None;
    let mut is_field_mutable = false;

    for (i, field) in data.fields.iter().enumerate() {
        for attribute in &field.attrs {
            if let Ok(meta) = attribute.parse_meta() {
                match meta {
                    Meta::Word(ref ident) if ident == "deref" => {
                        if deref_field.is_none() {
                            deref_field = Some((field.clone(), i as u32));
                        } else {
                            // name.span()
                            //     .unstable()
                            //     .error("Only one field in a struct can be `#[deref]`")
                            //     .emit();

                            // return TokenStream::new()
                            panic!("Only one field in a struct can be `#[deref]`")
                        }
                    }

                    Meta::List(MetaList {
                        ref ident,
                        ref nested,
                        ..
                    }) if ident == "deref" => {
                        is_field_mutable = nested.iter().any(|nested_item| match nested_item {
                            NestedMeta::Meta(m) => match m {
                                Meta::Word(ident) => ident == "mutable",
                                _ => false,
                            },
                            _ => false,
                        });

                        if deref_field.is_none() {
                            deref_field = Some((field.clone(), i as u32));
                        } else {
                            // name.span()
                            //     .unstable()
                            //     .error("Only one field in a struct can be `#[deref]`")
                            //     .emit();

                            // return TokenStream::new()
                            panic!("Only one field in a struct can be `#[deref]`")
                        }
                    }
                    _ => {}
                }
            }
        }
    }

    if deref_field.is_none() {
        // name.span()
        //     .unstable()
        //     .error("`#[derive(Derefable)]` requires one field to be marked `#[deref]`")
        //     .emit();

        // return TokenStream::new()
        panic!("`#[derive(Derefable)]` requires one field to be marked `#[deref]`");
    }

    let (field, index) = deref_field.unwrap();

    let target = field.ty;
    let ident = field
        .ident
        .map(Ident::into_token_stream)
        .unwrap_or_else(|| {
            Index {
                index,
                span: Span::call_site(),
            }
            .into_token_stream()
        });

    let mut_gen = if is_field_mutable {
        quote! {
            impl std::ops::DerefMut for #name {
                fn deref_mut(&mut self) -> &mut Self::Target {
                    &mut self.#ident
                }
            }
        }
    } else {
        quote! {}
    };

    let gen = quote! {
        impl std::ops::Deref for #name {
            type Target = #target;

            fn deref(&self) -> &Self::Target {
                &self.#ident
            }
        }

        #mut_gen
    };

    gen.into()
}