compiler/rustc_builtin_macros/src/deriving/encodable.rs

   1 //! The compiler code necessary to implement the `#[derive(RustcEncodable)]`
   2 //! (and `RustcDecodable`, in `decodable.rs`) extension. The idea here is that
   3 //! type-defining items may be tagged with
   4 //! `#[derive(RustcEncodable, RustcDecodable)]`.
   5 //!
   6 //! For example, a type like:
   7 //!
   8 //! ```ignore (old code)
   9 //! #[derive(RustcEncodable, RustcDecodable)]
  10 //! struct Node { id: usize }
  11 //! ```
  12 //!
  13 //! would generate two implementations like:
  14 //!
  15 //! ```ignore (old code)
  16 //! # struct Node { id: usize }
  17 //! impl<S: Encoder<E>, E> Encodable<S, E> for Node {
  18 //!     fn encode(&self, s: &mut S) -> Result<(), E> {
  19 //!         s.emit_struct("Node", 1, |this| {
  20 //!             this.emit_struct_field("id", 0, |this| {
  21 //!                 Encodable::encode(&self.id, this)
  22 //!                 /* this.emit_usize(self.id) can also be used */
  23 //!             })
  24 //!         })
  25 //!     }
  26 //! }
  27 //!
  28 //! impl<D: Decoder<E>, E> Decodable<D, E> for Node {
  29 //!     fn decode(d: &mut D) -> Result<Node, E> {
  30 //!         d.read_struct("Node", 1, |this| {
  31 //!             match this.read_struct_field("id", 0, |this| Decodable::decode(this)) {
  32 //!                 Ok(id) => Ok(Node { id: id }),
  33 //!                 Err(e) => Err(e),
  34 //!             }
  35 //!         })
  36 //!     }
  37 //! }
  38 //! ```
  39 //!
  40 //! Other interesting scenarios are when the item has type parameters or
  41 //! references other non-built-in types. A type definition like:
  42 //!
  43 //! ```ignore (old code)
  44 //! # #[derive(RustcEncodable, RustcDecodable)]
  45 //! # struct Span;
  46 //! #[derive(RustcEncodable, RustcDecodable)]
  47 //! struct Spanned<T> { node: T, span: Span }
  48 //! ```
  49 //!
  50 //! would yield functions like:
  51 //!
  52 //! ```ignore (old code)
  53 //! # #[derive(RustcEncodable, RustcDecodable)]
  54 //! # struct Span;
  55 //! # struct Spanned<T> { node: T, span: Span }
  56 //! impl<
  57 //!     S: Encoder<E>,
  58 //!     E,
  59 //!     T: Encodable<S, E>
  60 //! > Encodable<S, E> for Spanned<T> {
  61 //!     fn encode(&self, s: &mut S) -> Result<(), E> {
  62 //!         s.emit_struct("Spanned", 2, |this| {
  63 //!             this.emit_struct_field("node", 0, |this| self.node.encode(this))
  64 //!                 .unwrap();
  65 //!             this.emit_struct_field("span", 1, |this| self.span.encode(this))
  66 //!         })
  67 //!     }
  68 //! }
  69 //!
  70 //! impl<
  71 //!     D: Decoder<E>,
  72 //!     E,
  73 //!     T: Decodable<D, E>
  74 //! > Decodable<D, E> for Spanned<T> {
  75 //!     fn decode(d: &mut D) -> Result<Spanned<T>, E> {
  76 //!         d.read_struct("Spanned", 2, |this| {
  77 //!             Ok(Spanned {
  78 //!                 node: this.read_struct_field("node", 0, |this| Decodable::decode(this))
  79 //!                     .unwrap(),
  80 //!                 span: this.read_struct_field("span", 1, |this| Decodable::decode(this))
  81 //!                     .unwrap(),
  82 //!             })
  83 //!         })
  84 //!     }
  85 //! }
  86 //! ```
  87
  88 use crate::deriving::generic::ty::*;
  89 use crate::deriving::generic::*;
  90 use crate::deriving::pathvec_std;
  91
  92 use rustc_ast::{AttrVec, ExprKind, MetaItem, Mutability};
  93 use rustc_expand::base::{Annotatable, ExtCtxt};
  94 use rustc_span::symbol::{sym, Ident, Symbol};
  95 use rustc_span::Span;
  96
  97 pub fn expand_deriving_rustc_encodable(
  98     cx: &mut ExtCtxt<'_>,
  99     span: Span,
 100     mitem: &MetaItem,
 101     item: &Annotatable,
 102     push: &mut dyn FnMut(Annotatable),
 103 ) {
 104     let krate = sym::rustc_serialize;
 105     let typaram = sym::__S;
 106
 107     let trait_def = TraitDef {
 108         span,
 109         path: Path::new_(vec![krate, sym::Encodable], vec![], PathKind::Global),
 110         skip_path_as_bound: false,
 111         additional_bounds: Vec::new(),
 112         generics: Bounds::empty(),
 113         supports_unions: false,
 114         methods: vec![MethodDef {
 115             name: sym::encode,
 116             generics: Bounds {
 117                 bounds: vec![(
 118                     typaram,
 119                     vec![Path::new_(vec![krate, sym::Encoder], vec![], PathKind::Global)],
 120                 )],
 121             },
 122             explicit_self: true,
 123             nonself_args: vec![(
 124                 Ref(Box::new(Path(Path::new_local(typaram))), Mutability::Mut),
 125                 sym::s,
 126             )],
 127             ret_ty: Path(Path::new_(
 128                 pathvec_std!(result::Result),
 129                 vec![
 130                     Box::new(Unit),
 131                     Box::new(Path(Path::new_(vec![typaram, sym::Error], vec![], PathKind::Local))),
 132                 ],
 133                 PathKind::Std,
 134             )),
 135             attributes: AttrVec::new(),
 136             unify_fieldless_variants: false,
 137             combine_substructure: combine_substructure(Box::new(|a, b, c| {
 138                 encodable_substructure(a, b, c, krate)
 139             })),
 140         }],
 141         associated_types: Vec::new(),
 142     };
 143
 144     trait_def.expand(cx, mitem, item, push)
 145 }
 146
 147 fn encodable_substructure(
 148     cx: &mut ExtCtxt<'_>,
 149     trait_span: Span,
 150     substr: &Substructure<'_>,
 151     krate: Symbol,
 152 ) -> BlockOrExpr {
 153     let encoder = substr.nonselflike_args[0].clone();
 154     // throw an underscore in front to suppress unused variable warnings
 155     let blkarg = Ident::new(sym::_e, trait_span);
 156     let blkencoder = cx.expr_ident(trait_span, blkarg);
 157     let fn_path = cx.expr_path(cx.path_global(
 158         trait_span,
 159         vec![
 160             Ident::new(krate, trait_span),
 161             Ident::new(sym::Encodable, trait_span),
 162             Ident::new(sym::encode, trait_span),
 163         ],
 164     ));
 165
 166     match *substr.fields {
 167         Struct(_, ref fields) => {
 168             let fn_emit_struct_field_path =
 169                 cx.def_site_path(&[sym::rustc_serialize, sym::Encoder, sym::emit_struct_field]);
 170             let mut stmts = Vec::new();
 171             for (i, &FieldInfo { name, ref self_expr, span, .. }) in fields.iter().enumerate() {
 172                 let name = match name {
 173                     Some(id) => id.name,
 174                     None => Symbol::intern(&format!("_field{}", i)),
 175                 };
 176                 let self_ref = cx.expr_addr_of(span, self_expr.clone());
 177                 let enc = cx.expr_call(span, fn_path.clone(), vec![self_ref, blkencoder.clone()]);
 178                 let lambda = cx.lambda1(span, enc, blkarg);
 179                 let call = cx.expr_call_global(
 180                     span,
 181                     fn_emit_struct_field_path.clone(),
 182                     vec![
 183                         blkencoder.clone(),
 184                         cx.expr_str(span, name),
 185                         cx.expr_usize(span, i),
 186                         lambda,
 187                     ],
 188                 );
 189
 190                 // last call doesn't need a try!
 191                 let last = fields.len() - 1;
 192                 let call = if i != last {
 193                     cx.expr_try(span, call)
 194                 } else {
 195                     cx.expr(span, ExprKind::Ret(Some(call)))
 196                 };
 197
 198                 let stmt = cx.stmt_expr(call);
 199                 stmts.push(stmt);
 200             }
 201
 202             // unit structs have no fields and need to return Ok()
 203             let blk = if stmts.is_empty() {
 204                 let ok = cx.expr_ok(trait_span, cx.expr_tuple(trait_span, vec![]));
 205                 cx.lambda1(trait_span, ok, blkarg)
 206             } else {
 207                 cx.lambda_stmts_1(trait_span, stmts, blkarg)
 208             };
 209
 210             let fn_emit_struct_path =
 211                 cx.def_site_path(&[sym::rustc_serialize, sym::Encoder, sym::emit_struct]);
 212
 213             let expr = cx.expr_call_global(
 214                 trait_span,
 215                 fn_emit_struct_path,
 216                 vec![
 217                     encoder,
 218                     cx.expr_str(trait_span, substr.type_ident.name),
 219                     cx.expr_usize(trait_span, fields.len()),
 220                     blk,
 221                 ],
 222             );
 223             BlockOrExpr::new_expr(expr)
 224         }
 225
 226         EnumMatching(idx, _, variant, ref fields) => {
 227             // We're not generating an AST that the borrow checker is expecting,
 228             // so we need to generate a unique local variable to take the
 229             // mutable loan out on, otherwise we get conflicts which don't
 230             // actually exist.
 231             let me = cx.stmt_let(trait_span, false, blkarg, encoder);
 232             let encoder = cx.expr_ident(trait_span, blkarg);
 233
 234             let fn_emit_enum_variant_arg_path: Vec<_> =
 235                 cx.def_site_path(&[sym::rustc_serialize, sym::Encoder, sym::emit_enum_variant_arg]);
 236
 237             let mut stmts = Vec::new();
 238             if !fields.is_empty() {
 239                 let last = fields.len() - 1;
 240                 for (i, &FieldInfo { ref self_expr, span, .. }) in fields.iter().enumerate() {
 241                     let self_ref = cx.expr_addr_of(span, self_expr.clone());
 242                     let enc =
 243                         cx.expr_call(span, fn_path.clone(), vec![self_ref, blkencoder.clone()]);
 244                     let lambda = cx.lambda1(span, enc, blkarg);
 245
 246                     let call = cx.expr_call_global(
 247                         span,
 248                         fn_emit_enum_variant_arg_path.clone(),
 249                         vec![blkencoder.clone(), cx.expr_usize(span, i), lambda],
 250                     );
 251                     let call = if i != last {
 252                         cx.expr_try(span, call)
 253                     } else {
 254                         cx.expr(span, ExprKind::Ret(Some(call)))
 255                     };
 256                     stmts.push(cx.stmt_expr(call));
 257                 }
 258             } else {
 259                 let ok = cx.expr_ok(trait_span, cx.expr_tuple(trait_span, vec![]));
 260                 let ret_ok = cx.expr(trait_span, ExprKind::Ret(Some(ok)));
 261                 stmts.push(cx.stmt_expr(ret_ok));
 262             }
 263
 264             let blk = cx.lambda_stmts_1(trait_span, stmts, blkarg);
 265             let name = cx.expr_str(trait_span, variant.ident.name);
 266
 267             let fn_emit_enum_variant_path: Vec<_> =
 268                 cx.def_site_path(&[sym::rustc_serialize, sym::Encoder, sym::emit_enum_variant]);
 269
 270             let call = cx.expr_call_global(
 271                 trait_span,
 272                 fn_emit_enum_variant_path,
 273                 vec![
 274                     blkencoder,
 275                     name,
 276                     cx.expr_usize(trait_span, idx),
 277                     cx.expr_usize(trait_span, fields.len()),
 278                     blk,
 279                 ],
 280             );
 281
 282             let blk = cx.lambda1(trait_span, call, blkarg);
 283             let fn_emit_enum_path: Vec<_> =
 284                 cx.def_site_path(&[sym::rustc_serialize, sym::Encoder, sym::emit_enum]);
 285             let expr = cx.expr_call_global(
 286                 trait_span,
 287                 fn_emit_enum_path,
 288                 vec![encoder, cx.expr_str(trait_span, substr.type_ident.name), blk],
 289             );
 290             BlockOrExpr::new_mixed(vec![me], Some(expr))
 291         }
 292
 293         _ => cx.bug("expected Struct or EnumMatching in derive(Encodable)"),
 294     }
 295 }