compiler/rustc_builtin_macros/src/deriving/decodable.rs

   1 //! The compiler code necessary for `#[derive(RustcDecodable)]`. See encodable.rs for more.
   2
   3 use crate::deriving::generic::ty::*;
   4 use crate::deriving::generic::*;
   5 use crate::deriving::pathvec_std;
   6
   7 use rustc_ast::ptr::P;
   8 use rustc_ast::{self as ast, Expr, MetaItem, Mutability};
   9 use rustc_expand::base::{Annotatable, ExtCtxt};
  10 use rustc_span::symbol::{sym, Ident, Symbol};
  11 use rustc_span::Span;
  12
  13 pub fn expand_deriving_rustc_decodable(
  14     cx: &mut ExtCtxt<'_>,
  15     span: Span,
  16     mitem: &MetaItem,
  17     item: &Annotatable,
  18     push: &mut dyn FnMut(Annotatable),
  19 ) {
  20     let krate = sym::rustc_serialize;
  21     let typaram = sym::__D;
  22
  23     let trait_def = TraitDef {
  24         span,
  25         attributes: Vec::new(),
  26         path: Path::new_(vec![krate, sym::Decodable], None, vec![], PathKind::Global),
  27         additional_bounds: Vec::new(),
  28         generics: Bounds::empty(),
  29         is_unsafe: false,
  30         supports_unions: false,
  31         methods: vec![MethodDef {
  32             name: sym::decode,
  33             generics: Bounds {
  34                 bounds: vec![(
  35                     typaram,
  36                     vec![Path::new_(vec![krate, sym::Decoder], None, vec![], PathKind::Global)],
  37                 )],
  38             },
  39             explicit_self: None,
  40             args: vec![(
  41                 Ptr(Box::new(Literal(Path::new_local(typaram))), Borrowed(None, Mutability::Mut)),
  42                 sym::d,
  43             )],
  44             ret_ty: Literal(Path::new_(
  45                 pathvec_std!(result::Result),
  46                 None,
  47                 vec![
  48                     Box::new(Self_),
  49                     Box::new(Literal(Path::new_(
  50                         vec![typaram, sym::Error],
  51                         None,
  52                         vec![],
  53                         PathKind::Local,
  54                     ))),
  55                 ],
  56                 PathKind::Std,
  57             )),
  58             attributes: Vec::new(),
  59             is_unsafe: false,
  60             unify_fieldless_variants: false,
  61             combine_substructure: combine_substructure(Box::new(|a, b, c| {
  62                 decodable_substructure(a, b, c, krate)
  63             })),
  64         }],
  65         associated_types: Vec::new(),
  66     };
  67
  68     trait_def.expand(cx, mitem, item, push)
  69 }
  70
  71 fn decodable_substructure(
  72     cx: &mut ExtCtxt<'_>,
  73     trait_span: Span,
  74     substr: &Substructure<'_>,
  75     krate: Symbol,
  76 ) -> P<Expr> {
  77     let decoder = substr.nonself_args[0].clone();
  78     let recurse = vec![
  79         Ident::new(krate, trait_span),
  80         Ident::new(sym::Decodable, trait_span),
  81         Ident::new(sym::decode, trait_span),
  82     ];
  83     let exprdecode = cx.expr_path(cx.path_global(trait_span, recurse));
  84     // throw an underscore in front to suppress unused variable warnings
  85     let blkarg = Ident::new(sym::_d, trait_span);
  86     let blkdecoder = cx.expr_ident(trait_span, blkarg);
  87
  88     match *substr.fields {
  89         StaticStruct(_, ref summary) => {
  90             let nfields = match *summary {
  91                 Unnamed(ref fields, _) => fields.len(),
  92                 Named(ref fields) => fields.len(),
  93             };
  94             let fn_read_struct_field_path: Vec<_> =
  95                 cx.def_site_path(&[sym::rustc_serialize, sym::Decoder, sym::read_struct_field]);
  96
  97             let path = cx.path_ident(trait_span, substr.type_ident);
  98             let result =
  99                 decode_static_fields(cx, trait_span, path, summary, |cx, span, name, field| {
 100                     cx.expr_try(
 101                         span,
 102                         cx.expr_call_global(
 103                             span,
 104                             fn_read_struct_field_path.clone(),
 105                             vec![
 106                                 blkdecoder.clone(),
 107                                 cx.expr_str(span, name),
 108                                 cx.expr_usize(span, field),
 109                                 exprdecode.clone(),
 110                             ],
 111                         ),
 112                     )
 113                 });
 114             let result = cx.expr_ok(trait_span, result);
 115             let fn_read_struct_path: Vec<_> =
 116                 cx.def_site_path(&[sym::rustc_serialize, sym::Decoder, sym::read_struct]);
 117
 118             cx.expr_call_global(
 119                 trait_span,
 120                 fn_read_struct_path,
 121                 vec![
 122                     decoder,
 123                     cx.expr_str(trait_span, substr.type_ident.name),
 124                     cx.expr_usize(trait_span, nfields),
 125                     cx.lambda1(trait_span, result, blkarg),
 126                 ],
 127             )
 128         }
 129         StaticEnum(_, ref fields) => {
 130             let variant = Ident::new(sym::i, trait_span);
 131
 132             let mut arms = Vec::with_capacity(fields.len() + 1);
 133             let mut variants = Vec::with_capacity(fields.len());
 134
 135             let fn_read_enum_variant_arg_path: Vec<_> =
 136                 cx.def_site_path(&[sym::rustc_serialize, sym::Decoder, sym::read_enum_variant_arg]);
 137
 138             for (i, &(ident, v_span, ref parts)) in fields.iter().enumerate() {
 139                 variants.push(cx.expr_str(v_span, ident.name));
 140
 141                 let path = cx.path(trait_span, vec![substr.type_ident, ident]);
 142                 let decoded =
 143                     decode_static_fields(cx, v_span, path, parts, |cx, span, _, field| {
 144                         let idx = cx.expr_usize(span, field);
 145                         cx.expr_try(
 146                             span,
 147                             cx.expr_call_global(
 148                                 span,
 149                                 fn_read_enum_variant_arg_path.clone(),
 150                                 vec![blkdecoder.clone(), idx, exprdecode.clone()],
 151                             ),
 152                         )
 153                     });
 154
 155                 arms.push(cx.arm(v_span, cx.pat_lit(v_span, cx.expr_usize(v_span, i)), decoded));
 156             }
 157
 158             arms.push(cx.arm_unreachable(trait_span));
 159
 160             let result = cx.expr_ok(
 161                 trait_span,
 162                 cx.expr_match(trait_span, cx.expr_ident(trait_span, variant), arms),
 163             );
 164             let lambda = cx.lambda(trait_span, vec![blkarg, variant], result);
 165             let variant_vec = cx.expr_vec(trait_span, variants);
 166             let variant_vec = cx.expr_addr_of(trait_span, variant_vec);
 167             let fn_read_enum_variant_path: Vec<_> =
 168                 cx.def_site_path(&[sym::rustc_serialize, sym::Decoder, sym::read_enum_variant]);
 169             let result = cx.expr_call_global(
 170                 trait_span,
 171                 fn_read_enum_variant_path,
 172                 vec![blkdecoder, variant_vec, lambda],
 173             );
 174             let fn_read_enum_path: Vec<_> =
 175                 cx.def_site_path(&[sym::rustc_serialize, sym::Decoder, sym::read_enum]);
 176
 177             cx.expr_call_global(
 178                 trait_span,
 179                 fn_read_enum_path,
 180                 vec![
 181                     decoder,
 182                     cx.expr_str(trait_span, substr.type_ident.name),
 183                     cx.lambda1(trait_span, result, blkarg),
 184                 ],
 185             )
 186         }
 187         _ => cx.bug("expected StaticEnum or StaticStruct in derive(Decodable)"),
 188     }
 189 }
 190
 191 /// Creates a decoder for a single enum variant/struct:
 192 /// - `outer_pat_path` is the path to this enum variant/struct
 193 /// - `getarg` should retrieve the `usize`-th field with name `@str`.
 194 fn decode_static_fields<F>(
 195     cx: &mut ExtCtxt<'_>,
 196     trait_span: Span,
 197     outer_pat_path: ast::Path,
 198     fields: &StaticFields,
 199     mut getarg: F,
 200 ) -> P<Expr>
 201 where
 202     F: FnMut(&mut ExtCtxt<'_>, Span, Symbol, usize) -> P<Expr>,
 203 {
 204     match *fields {
 205         Unnamed(ref fields, is_tuple) => {
 206             let path_expr = cx.expr_path(outer_pat_path);
 207             if !is_tuple {
 208                 path_expr
 209             } else {
 210                 let fields = fields
 211                     .iter()
 212                     .enumerate()
 213                     .map(|(i, &span)| getarg(cx, span, Symbol::intern(&format!("_field{}", i)), i))
 214                     .collect();
 215
 216                 cx.expr_call(trait_span, path_expr, fields)
 217             }
 218         }
 219         Named(ref fields) => {
 220             // use the field's span to get nicer error messages.
 221             let fields = fields
 222                 .iter()
 223                 .enumerate()
 224                 .map(|(i, &(ident, span))| {
 225                     let arg = getarg(cx, span, ident.name, i);
 226                     cx.field_imm(span, ident, arg)
 227                 })
 228                 .collect();
 229             cx.expr_struct(trait_span, outer_pat_path, fields)
 230         }
 231     }
 232 }