compiler/rustc_builtin_macros/src/deriving/debug.rs

   1 use crate::deriving::generic::ty::*;
   2 use crate::deriving::generic::*;
   3 use crate::deriving::path_std;
   4
   5 use rustc_ast::ptr::P;
   6 use rustc_ast::{self as ast, Expr, MetaItem};
   7 use rustc_expand::base::{Annotatable, ExtCtxt};
   8 use rustc_span::symbol::{sym, Ident};
   9 use rustc_span::{Span, DUMMY_SP};
  10
  11 pub fn expand_deriving_debug(
  12     cx: &mut ExtCtxt<'_>,
  13     span: Span,
  14     mitem: &MetaItem,
  15     item: &Annotatable,
  16     push: &mut dyn FnMut(Annotatable),
  17 ) {
  18     // &mut ::std::fmt::Formatter
  19     let fmtr =
  20         Ptr(Box::new(Literal(path_std!(fmt::Formatter))), Borrowed(None, ast::Mutability::Mut));
  21
  22     let trait_def = TraitDef {
  23         span,
  24         attributes: Vec::new(),
  25         path: path_std!(fmt::Debug),
  26         additional_bounds: Vec::new(),
  27         generics: Bounds::empty(),
  28         is_unsafe: false,
  29         supports_unions: false,
  30         methods: vec![MethodDef {
  31             name: sym::fmt,
  32             generics: Bounds::empty(),
  33             explicit_self: borrowed_explicit_self(),
  34             args: vec![(fmtr, sym::f)],
  35             ret_ty: Literal(path_std!(fmt::Result)),
  36             attributes: Vec::new(),
  37             is_unsafe: false,
  38             unify_fieldless_variants: false,
  39             combine_substructure: combine_substructure(Box::new(|a, b, c| {
  40                 show_substructure(a, b, c)
  41             })),
  42         }],
  43         associated_types: Vec::new(),
  44     };
  45     trait_def.expand(cx, mitem, item, push)
  46 }
  47
  48 /// We use the debug builders to do the heavy lifting here
  49 fn show_substructure(cx: &mut ExtCtxt<'_>, span: Span, substr: &Substructure<'_>) -> P<Expr> {
  50     // build fmt.debug_struct(<name>).field(<fieldname>, &<fieldval>)....build()
  51     // or fmt.debug_tuple(<name>).field(&<fieldval>)....build()
  52     // based on the "shape".
  53     let (ident, vdata, fields) = match substr.fields {
  54         Struct(vdata, fields) => (substr.type_ident, *vdata, fields),
  55         EnumMatching(_, _, v, fields) => (v.ident, &v.data, fields),
  56         EnumNonMatchingCollapsed(..) | StaticStruct(..) | StaticEnum(..) => {
  57             cx.span_bug(span, "nonsensical .fields in `#[derive(Debug)]`")
  58         }
  59     };
  60
  61     // We want to make sure we have the ctxt set so that we can use unstable methods
  62     let span = cx.with_def_site_ctxt(span);
  63     let name = cx.expr_lit(span, ast::LitKind::Str(ident.name, ast::StrStyle::Cooked));
  64     let builder = Ident::new(sym::debug_trait_builder, span);
  65     let builder_expr = cx.expr_ident(span, builder);
  66
  67     let fmt = substr.nonself_args[0].clone();
  68
  69     let mut stmts = vec![];
  70     match vdata {
  71         ast::VariantData::Tuple(..) | ast::VariantData::Unit(..) => {
  72             // tuple struct/"normal" variant
  73             let expr =
  74                 cx.expr_method_call(span, fmt, Ident::new(sym::debug_tuple, span), vec![name]);
  75             stmts.push(cx.stmt_let(span, true, builder, expr));
  76
  77             for field in fields {
  78                 // Use double indirection to make sure this works for unsized types
  79                 let field = cx.expr_addr_of(field.span, field.self_.clone());
  80                 let field = cx.expr_addr_of(field.span, field);
  81
  82                 let expr = cx.expr_method_call(
  83                     span,
  84                     builder_expr.clone(),
  85                     Ident::new(sym::field, span),
  86                     vec![field],
  87                 );
  88
  89                 // Use `let _ = expr;` to avoid triggering the
  90                 // unused_results lint.
  91                 stmts.push(stmt_let_underscore(cx, span, expr));
  92             }
  93         }
  94         ast::VariantData::Struct(..) => {
  95             // normal struct/struct variant
  96             let expr =
  97                 cx.expr_method_call(span, fmt, Ident::new(sym::debug_struct, span), vec![name]);
  98             stmts.push(cx.stmt_let(DUMMY_SP, true, builder, expr));
  99
 100             for field in fields {
 101                 let name = cx.expr_lit(
 102                     field.span,
 103                     ast::LitKind::Str(field.name.unwrap().name, ast::StrStyle::Cooked),
 104                 );
 105
 106                 // Use double indirection to make sure this works for unsized types
 107                 let field = cx.expr_addr_of(field.span, field.self_.clone());
 108                 let field = cx.expr_addr_of(field.span, field);
 109                 let expr = cx.expr_method_call(
 110                     span,
 111                     builder_expr.clone(),
 112                     Ident::new(sym::field, span),
 113                     vec![name, field],
 114                 );
 115                 stmts.push(stmt_let_underscore(cx, span, expr));
 116             }
 117         }
 118     }
 119
 120     let expr = cx.expr_method_call(span, builder_expr, Ident::new(sym::finish, span), vec![]);
 121
 122     stmts.push(cx.stmt_expr(expr));
 123     let block = cx.block(span, stmts);
 124     cx.expr_block(block)
 125 }
 126
 127 fn stmt_let_underscore(cx: &mut ExtCtxt<'_>, sp: Span, expr: P<ast::Expr>) -> ast::Stmt {
 128     let local = P(ast::Local {
 129         pat: cx.pat_wild(sp),
 130         ty: None,
 131         init: Some(expr),
 132         id: ast::DUMMY_NODE_ID,
 133         span: sp,
 134         attrs: ast::AttrVec::new(),
 135     });
 136     ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span: sp, tokens: None }
 137 }