Skip to content

syntax: implement #[deriving(DeepClone)]. Fixes #6514. #6530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/rust.md
Original file line number Diff line number Diff line change
Expand Up @@ -1562,7 +1562,7 @@ Supported traits for `deriving` are:

* Comparison traits: `Eq`, `TotalEq`, `Ord`, `TotalOrd`.
* Serialization: `Encodable`, `Decodable`. These require `std`.
* `Clone`, to perform deep copies.
* `Clone` and `DeepClone`, to perform (deep) copies.
* `IterBytes`, to iterate over the bytes in a data type.
* `Rand`, to create a random instance of a data type.
* `ToStr`, to convert to a string. For a type with this instance,
Expand Down
4 changes: 2 additions & 2 deletions doc/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2308,8 +2308,8 @@ enum ABC { A, B, C }
~~~

The full list of derivable traits is `Eq`, `TotalEq`, `Ord`,
`TotalOrd`, `Encodable` `Decodable`, `Clone`, `IterBytes`, `Rand` and
`ToStr`.
`TotalOrd`, `Encodable` `Decodable`, `Clone`, `DeepClone`,
`IterBytes`, `Rand` and `ToStr`.

# Modules and crates

Expand Down
49 changes: 42 additions & 7 deletions src/libsyntax/ext/deriving/clone.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ pub fn expand_deriving_clone(cx: @ext_ctxt,
args: ~[],
ret_ty: Self,
const_nonmatching: false,
combine_substructure: cs_clone
combine_substructure: |c, s, sub| cs_clone("Clone", c, s, sub)
}
]
};
Expand All @@ -42,8 +42,39 @@ pub fn expand_deriving_clone(cx: @ext_ctxt,
&trait_def)
}

fn cs_clone(cx: @ext_ctxt, span: span,
substr: &Substructure) -> @expr {
pub fn expand_deriving_deep_clone(cx: @ext_ctxt,
span: span,
mitem: @meta_item,
in_items: ~[@item])
-> ~[@item] {
let trait_def = TraitDef {
path: Path::new(~[~"core", ~"clone", ~"DeepClone"]),
additional_bounds: ~[],
generics: LifetimeBounds::empty(),
methods: ~[
MethodDef {
name: ~"deep_clone",
generics: LifetimeBounds::empty(),
explicit_self: borrowed_explicit_self(),
args: ~[],
ret_ty: Self,
const_nonmatching: false,
// cs_clone uses the ident passed to it, i.e. it will
// call deep_clone (not clone) here.
combine_substructure: |c, s, sub| cs_clone("DeepClone", c, s, sub)
}
]
};

expand_deriving_generic(cx, span,
mitem, in_items,
&trait_def)
}

fn cs_clone(
name: &str,
cx: @ext_ctxt, span: span,
substr: &Substructure) -> @expr {
let clone_ident = substr.method_ident;
let ctor_ident;
let all_fields;
Expand All @@ -59,8 +90,12 @@ fn cs_clone(cx: @ext_ctxt, span: span,
ctor_ident = ~[ variant.node.name ];
all_fields = af;
},
EnumNonMatching(*) => cx.span_bug(span, "Non-matching enum variants in `deriving(Clone)`"),
StaticEnum(*) | StaticStruct(*) => cx.span_bug(span, "Static method in `deriving(Clone)`")
EnumNonMatching(*) => cx.span_bug(span,
fmt!("Non-matching enum variants in `deriving(%s)`",
name)),
StaticEnum(*) | StaticStruct(*) => cx.span_bug(span,
fmt!("Static method in `deriving(%s)`",
name))
}

match *all_fields {
Expand All @@ -75,8 +110,8 @@ fn cs_clone(cx: @ext_ctxt, span: span,
let ident = match o_id {
Some(i) => i,
None => cx.span_bug(span,
~"unnamed field in normal struct \
in `deriving(Clone)`")
fmt!("unnamed field in normal struct in `deriving(%s)`",
name))
};
build::Field { ident: ident, ex: subcall(self_f) }
};
Expand Down
1 change: 1 addition & 0 deletions src/libsyntax/ext/deriving/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ pub fn expand_meta_deriving(cx: @ext_ctxt,
titem, in_items)));
match *tname {
~"Clone" => expand!(clone::expand_deriving_clone),
~"DeepClone" => expand!(clone::expand_deriving_deep_clone),

~"IterBytes" => expand!(iter_bytes::expand_deriving_iter_bytes),

Expand Down
7 changes: 5 additions & 2 deletions src/test/run-pass/deriving-clone-enum.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[deriving(Clone)]
#[deriving(Clone, DeepClone)]
enum E {
A,
B(()),
C
}

pub fn main() {}
pub fn main() {
let _ = A.clone();
let _ = B(()).deep_clone();
}
17 changes: 15 additions & 2 deletions src/test/run-pass/deriving-clone-generic-enum.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
#[deriving(Clone)]
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[deriving(Clone, DeepClone)]
enum E<T,U> {
A(T),
B(T,U),
C
}

fn main() {}
fn main() {
let _ = A::<int, int>(1i).clone();
let _ = B(1i, 1.234).deep_clone();
}
6 changes: 4 additions & 2 deletions src/test/run-pass/deriving-clone-generic-struct.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[deriving(Clone)]
#[deriving(Clone, DeepClone)]
struct S<T> {
foo: (),
bar: (),
baz: T,
}

pub fn main() {}
pub fn main() {
let _ = S { foo: (), bar: (), baz: 1i }.clone().deep_clone();
}
16 changes: 14 additions & 2 deletions src/test/run-pass/deriving-clone-generic-tuple-struct.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
#[deriving(Clone)]
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[deriving(Clone, DeepClone)]
struct S<T>(T, ());

fn main() {}
fn main() {
let _ = S(1i, ()).clone().deep_clone();
}
12 changes: 11 additions & 1 deletion src/test/run-pass/deriving-clone-struct.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
#[deriving(Clone)]
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

#[deriving(Clone, DeepClone)]
struct S {
_int: int,
_i8: i8,
Expand Down