hebi_derive 0.3.1

Derive macros for Hebi
Documentation
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
use proc_macro::TokenStream;
use proc_macro2::{Ident, Span, TokenStream as TokenStream2};
use quote::{format_ident, quote};
use syn::spanned::Spanned;
use syn::{Expr, ItemFn, PatType, Receiver, Signature, Type, Visibility};

use crate::class::ReceiverMapping;
use crate::util::is_attr;

// TODO: don't fully clear attrs, only those we use

pub fn macro_impl(args: TokenStream, input: TokenStream) -> TokenStream {
  if !args.is_empty() {
    return syn::Error::new(Span::call_site(), "attribute does not accept any arguments")
      .into_compile_error()
      .into();
  }

  let crate_name = match proc_macro_crate::crate_name("hebi") {
    Ok(found) => match found {
      proc_macro_crate::FoundCrate::Itself => format_ident!("crate"),
      proc_macro_crate::FoundCrate::Name(name) => format_ident!("{name}"),
    },
    Err(e) => {
      return syn::Error::new(Span::call_site(), format!("{e}"))
        .into_compile_error()
        .into()
    }
  };

  let input = syn::parse_macro_input!(input as syn::ItemFn);
  let vis = input.vis.clone();
  let sig = input.sig.clone();

  let fn_info = match FnInfo::parse(vis, &sig) {
    Ok(params) => params,
    Err(e) => return e.into_compile_error().into(),
  };

  if let Some(receiver) = &fn_info.receiver {
    return syn::Error::new(receiver.span(), "`self` is not supported")
      .into_compile_error()
      .into();
  }

  let mut input = input;
  clear_sig_attrs(&mut input.sig);

  Func {
    crate_name: &crate_name,
    out_fn_name: fn_info.name.clone(),
    in_fn_name: None,
    fn_info,
    input_fn: Some(input),
    type_name: None,
    is_assoc_fn: false,
    receiver_mapping: None,
  }
  .emit()
  .into()
}

pub struct Func<'a> {
  pub crate_name: &'a Ident,
  pub out_fn_name: Ident,
  pub in_fn_name: Option<Ident>,
  pub fn_info: FnInfo,
  pub input_fn: Option<ItemFn>,
  pub type_name: Option<Ident>,
  pub is_assoc_fn: bool,
  pub receiver_mapping: Option<&'a ReceiverMapping>,
}

impl<'a> Func<'a> {
  pub fn emit(self) -> TokenStream2 {
    let Func {
      crate_name,
      out_fn_name,
      in_fn_name,
      fn_info,
      input_fn,
      type_name,
      is_assoc_fn,
      receiver_mapping,
    } = self;
    let input_fn_name = in_fn_name.unwrap_or_else(|| fn_info.name.clone());
    let vis = fn_info.vis.clone();
    let (input_mapping, arg_info) =
      emit_input_mapping(crate_name, &fn_info, type_name.as_ref(), receiver_mapping);
    let args = arg_info.call_args;

    let assoc_ty_path = if is_assoc_fn {
      let type_name = type_name.as_ref().unwrap();
      Some(quote!(#type_name::))
    } else {
      None
    };
    let call = if fn_info.receiver.is_some() {
      quote! {#assoc_ty_path #input_fn_name(this, #(#args),*)}
    } else {
      quote! {#assoc_ty_path #input_fn_name(#(#args),*)}
    };

    quote! {
      #[allow(non_snake_case)]
      #vis fn #out_fn_name<'hebi>(
        ctx: &'hebi #crate_name::public::Context<'hebi>,
        args: #crate_name::public::Args<'hebi>,
      ) -> #crate_name::Result<#crate_name::public::Value<'hebi>> {
        #![allow(
          clippy::unnecessary_lazy_evaluations,
          clippy::absurd_extreme_comparisons,
          unused_imports,
          unused_variables,
          dead_code
        )]

        use #crate_name::util::check_args;
        use #crate_name::{FromHebi, FromHebiRef, IntoHebi};

        #input_fn

        #input_mapping

        #call.into_hebi(ctx)
      }
    }
  }
}

pub fn emit_input_mapping(
  crate_name: &Ident,
  params: &FnInfo,
  type_name: Option<&Ident>,
  receiver_mapping: Option<&ReceiverMapping>,
) -> (TokenStream2, ArgInfo) {
  let from_hebi = format_ident!("from_hebi");
  let from_hebi_ref = format_ident!("from_hebi_ref");
  let positional_ref = quote!(&positional);
  let positional_owned = quote!(positional);
  let clone_call = Some(quote!(.clone()));
  let no_clone_call = None;

  let has_self = params.receiver.is_some();

  let required_positional_params = params.required_positional().map(|v| v.name.to_string());
  let max_positional_params = params.max_positional();

  let keyword_params = params
    .keyword
    .iter()
    .map(|v| (v.name.to_string(), v.default.is_some()))
    .map(|(k, r)| quote! {(#k, #r)});

  let positional_param_mapping = params
    .positional
    .iter()
    .enumerate()
    .map(|(i, p)| {
      let name = format_ident!("_pos_{i}");
      let ty = &p.ty;
      let (from_fn, args, clone_call) = if !is_ref(ty) {
        (&from_hebi, &positional_owned, &clone_call)
      } else {
        (&from_hebi_ref, &positional_ref, &no_clone_call)
      };
      let init = match &p.default {
        Some(v) => quote! {
          if positional.len() <= #i {
            #v
          } else {
            <#ty>::#from_fn(ctx, #args[#i]#clone_call)?
          }
        },
        None => quote! {
          <#ty>::#from_fn(ctx, #args[#i]#clone_call)?
        },
      };

      (quote! {let #name = #init;}, name)
    })
    .collect::<Vec<_>>();

  let keyword_param_mapping = params
    .keyword
    .iter()
    .enumerate()
    .map(|(i, p)| {
      let name = format_ident!("_kw_{i}");
      let key = p.name.to_string();
      let ty = &p.ty;
      let (from_fn, clone_call) = if !is_ref(ty) {
        (&from_hebi, &clone_call)
      } else {
        (&from_hebi_ref, &no_clone_call)
      };
      let init = match &p.default {
        Some(v) => quote! {
          if let Some(value) = keyword.as_ref().and_then(|kw| kw.get(#key)) {
            <#ty>::#from_fn(ctx, value #clone_call)?
          } else {
            #v
          }
        },
        None => quote! {
          <#ty>::#from_fn(ctx, keyword.as_ref().and_then(|kw| kw.get(#key)).unwrap() #clone_call)?
        },
      };

      (quote! {let #name = #init;}, name)
    })
    .collect::<Vec<_>>();

  let this_mapping = match params.receiver.as_ref().map(|r| r.mutability) {
    Some(m) => {
      let is_mut = m.is_some();
      if let Some(mapping) = receiver_mapping {
        match is_mut {
          true => mapping.mut_.clone(),
          false => mapping.ref_.clone(),
        }
      } else {
        let cast_error_msg = format!(
          "receiver is not an instance of {}",
          type_name.as_ref().unwrap()
        );
        let cast = match is_mut {
          true => format_ident!("cast_mut"),
          false => format_ident!("cast"),
        };
        quote! {
          let mut args = args;
          let args = args.resolve_receiver()?;
          let mut this = match args.this().as_user_data() {
            Some(this) => this,
            None => return Err(#crate_name::Error::runtime(#cast_error_msg)),
          };
          let mut this = match unsafe { this.#cast::<#type_name>() } {
            Some(this) => this,
            None => return Err(#crate_name::Error::runtime(#cast_error_msg)),
          };
        }
      }
    }
    _ => TokenStream2::new(),
  };

  let input_mapping = positional_param_mapping
    .iter()
    .map(|(t, _)| t)
    .chain(keyword_param_mapping.iter().map(|(t, _)| t));

  let args = positional_param_mapping
    .iter()
    .map(|(_, i)| i)
    .chain(keyword_param_mapping.iter().map(|(_, i)| i))
    .collect::<Vec<_>>();

  let out_args = ArgInfo {
    call_args: args.iter().map(|&i| i.clone()).collect(),
  };

  (
    quote! {
      check_args(
        &args,
        /* has_self */ #has_self,
        /* pos_required */ &[#(#required_positional_params),*],
        /* pos_max */ #max_positional_params,
        /* kw */ &[#(#keyword_params),*],
      )?;

      #this_mapping
      let positional = args.positional();
      let keyword = args.keyword();

      #(#input_mapping)*
    },
    out_args,
  )
}

pub fn clear_sig_attrs(sig: &mut Signature) {
  for input in sig.inputs.iter_mut() {
    match input {
      syn::FnArg::Receiver(Receiver { attrs, .. }) | syn::FnArg::Typed(PatType { attrs, .. }) => {
        *attrs = attrs
          .iter()
          .cloned()
          .filter(|a| !is_attr(a, &["kw", "default"]))
          .collect()
      }
    }
  }
}

pub struct ArgInfo {
  pub call_args: Vec<Ident>,
}

// TODO: rest argv/kwargs

pub struct FnInfo {
  pub name: Ident,
  pub vis: Visibility,
  pub receiver: Option<Receiver>,
  pub positional: Vec<Param>,
  pub keyword: Vec<Param>,
}

pub struct Param {
  pub name: Ident,
  pub ty: Type,
  pub default: Option<Expr>,
}

impl FnInfo {
  pub fn required_positional(&self) -> impl Iterator<Item = &Param> {
    self.positional.iter().filter(|v| v.default.is_none())
  }

  pub fn max_positional(&self) -> usize {
    self.positional.len()
  }
}

impl FnInfo {
  pub fn parse(vis: Visibility, sig: &Signature) -> syn::Result<Self> {
    if !sig.generics.params.is_empty() {
      return Err(syn::Error::new(
        sig.generics.span(),
        "generics are not supported",
      ));
    }

    let name = sig.ident.clone();
    let inputs = &sig.inputs;
    let mut receiver = None;
    let mut positional = vec![];
    let mut keyword = vec![];

    enum State {
      Positional,
      PositionalDefault,
      Keyword,
    }

    let mut state = State::Positional;

    for param in inputs.iter() {
      match param {
        syn::FnArg::Receiver(r) => {
          if r.reference.is_none() {
            return Err(syn::Error::new(
              r.span(),
              "receiver must be taken by reference",
            ));
          }
          receiver = Some(r.clone());
        }
        syn::FnArg::Typed(r) => {
          let name = get_name(r)?;
          let ty = r.ty.as_ref().clone();
          let default = get_default(r)?;

          if !is_keyword(r) {
            if matches!(state, State::Keyword) {
              return Err(syn::Error::new(
                name.span(),
                "positional parameters may not appear after keyword parameters",
              ));
            }

            if default.is_some() {
              state = State::PositionalDefault;
            } else if matches!(state, State::PositionalDefault) {
              return Err(syn::Error::new(
                name.span(),
                "non-default positional parameters may not appear after default positional parameters",
              ));
            }
          } else {
            state = State::Keyword;
          }

          let param = Param { name, ty, default };
          if is_keyword(r) {
            keyword.push(param);
          } else {
            positional.push(param)
          }
        }
      }
    }

    Ok(FnInfo {
      name,
      vis,
      receiver,
      positional,
      keyword,
    })
  }
}

pub fn get_name(param: &PatType) -> syn::Result<Ident> {
  if let syn::Pat::Ident(pat) = &*param.pat {
    Ok(pat.ident.clone())
  } else {
    Err(syn::Error::new(
      param.pat.span(),
      "param pattern must be an identifier",
    ))
  }
}

pub fn is_keyword(param: &PatType) -> bool {
  param.attrs.iter().any(|v| v.path.is_ident("kw"))
}

pub fn is_option(param: &PatType) -> bool {
  match &*param.ty {
    Type::Path(ty) if ty.path.segments.len() == 1 => match ty.path.segments.first() {
      Some(segment) => segment.ident == "Option" && !segment.arguments.is_empty(),
      None => false,
    },
    _ => false,
  }
}

pub fn get_default(param: &PatType) -> syn::Result<Option<Expr>> {
  let default = param
    .attrs
    .iter()
    .find(|v| v.path.is_ident("default"))
    .map(|v| v.parse_args())
    .transpose()?;
  if default.is_none() && is_option(param) {
    Ok(Some(syn::parse_quote!(None)))
  } else {
    Ok(default)
  }
}

pub fn is_ref(ty: &Type) -> bool {
  match ty {
    Type::Path(ty) if ty.path.segments.len() == 1 => match ty.path.segments.first() {
      Some(syn::PathSegment {
        ident,
        arguments: syn::PathArguments::AngleBracketed(inner),
      }) => {
        ident == "Option"
          && inner
            .args
            .first()
            .and_then(|v| match v {
              syn::GenericArgument::Type(ty) => Some(ty),
              _ => None,
            })
            .map(is_direct_ref)
            .unwrap_or(false)
      }
      _ => false,
    },
    Type::Reference(_) => true,
    _ => false,
  }
}

pub fn is_direct_ref(ty: &Type) -> bool {
  matches!(ty, Type::Reference(_))
}