Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(150)

Side by Side Diff: base/move.h

Issue 9207021: Transfer the C++03 move-only type emulation into base/move.h and also make ScopedVector move-only. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Fixed nit and ran through spell check. Created 8 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
(Empty)
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #ifndef BASE_MOVE_H_
6 #define BASE_MOVE_H_
7
8 // Macro with the boilerplate that makes a type move-only in C++03.
9 //
10 // USAGE
11 //
12 // This macro should be used instead of DISALLOW_COPY_AND_ASSIGN to create
13 // a "move-only" type. Unlike, this macro should be the first line in a
darin (slow to review) 2012/01/19 05:17:30 Unlike [what]?
awong 2012/01/19 20:13:13 Done. (Unlike DISALLOW_COPY_AND_ASSIGN)
14 // class declaration.
15 //
16 // A class using this macro must call .Pass() (or somehow be an r-value already)
17 // before it can be:
18 //
19 // * Passed as a function argument
20 // * Used as the right-hand side of an assignment
21 // * Return from a function
22 //
23 // Each class will still need to define their own "move constructor" and "move
24 // operator=" to make this useful. Here's an example of both from the
25 // scoped_ptr class.
26 //
27 // scoped_ptr(RValue& other) : ptr_(other.release()) { }
28 // scoped_ptr& operator=(RValue& other) {
29 // swap(other);
30 // return *this;
31 // }
32 //
33 // Note that the constructor must NOT be marked explicit.
34 //
35 //
36 // HOW THIS WORKS
37 //
38 // For a thorough explanation of this technique, see:
39 //
40 // http://en.wikibooks.org/wiki/More_C%2B%2B_Idioms/Move_Constructor
41 //
42 // The summary is that we take advantage of 2 properties:
43 //
44 // 1) non-const references will not bind to r-values.
45 // 2) C++ can apply one user-defined conversion when initializing a
46 // variable.
47 //
48 // The first lets us disable the copy constructor and assignment operator
49 // by declaring private version of them with a non-const reference parameter.
50 //
51 // For l-values, direct initialization still fails like in
52 // DISALLOW_COPY_AND_ASSIGN because the copy constructor and assignment
53 // operators are private.
54 //
55 // For r-values, the situation is different. The copy constructor and
56 // assignment operator are not viable due to (1), so we are trying to call
57 // a non-existent constructor and non-existing operator= rather than a private
58 // one. Since we have not committed an error quite yet, we can provide an
59 // alternate conversion sequence and a constructor. We add
60 //
61 // * a private struct named "RValue"
62 // * a user-defined conversion "operator RValue&()"
63 // * a "move constructor" and "move operator=" that take the RValue& as
64 // their sole parameter.
65 //
66 // Only r-values will trigger this sequence and execute our "move constructor"
67 // or "move operator=." L-values will match the private copy constructor and
68 // operator= first giving a "private in this context" error. This combination
69 // gives us a move-only type.
70 //
71 // For signaling a destructive transfer of data from an l-value, we provide a
72 // method named Pass() which creates an r-value for the current instance
73 // triggering the move constructor or move operator=.
74 //
75 // Other ways to get r-values is to use the result of an expression like a
76 // function call.
77 //
78 // Here's an example with comments explaining what gets triggered where:
79 //
80 // class Foo {
81 // MOVE_ONLY_TYPE_FOR_CPP_03(Foo);
82 //
83 // public:
84 // ... API ...
85 // Foo(RValue& other); // Move constructor.
86 // Foo& operator=(RValue& rhs); // Move operator=
87 // };
88 //
89 // Foo MakeFoo(); // Function that returns a Foo.
90 //
91 // Foo f;
92 // Foo f_copy(f); // ERROR: Foo(Foo&) is private in this context.
93 // Foo f_assign;
94 // f_assign = f; // ERROR: operator=(Foo&) is private in this context.
95 //
96 //
97 // Foo f(MakeFoo()); // R-value so alternate conversion executed.
98 // Foo f_copy(f.Pass()); // R-value so alternate conversion executed.
99 // f = f_copy.Pass(); // R-value so alternate conversion executed.
100 //
101 //
102 // IMPLEMENTATION SUBTLETIES WITH RValue
103 //
104 // The RValue struct has subtle properties:
105 //
106 // 1) All its methods are declared, but intentionally not defined.
107 // 2) It is *never* instantiated.
108 // 3) It is a child of the move-only type.
109 //
110 // (1) is a guard against accidental violation of (2). If an instance of
111 // RValue were ever created, either as a temporary, or as a copy to some
112 // function parameter or field of a class, the binary will not link.
113 //
114 // This ensures that RValue can only exist as a temporary which is important
115 // to avoid accidental danging references.
116 //
117 // (3) allows us to get around instantiations because our user-defined
118 // conversion can return a downcast of this pointer.
119 //
120 // operator RValue&() { return *reinterpret_cast<RValue*>(this); }
121 //
122 // Because RValue does not extend the object size or add any virtual methods,
123 // this type-pun is safe.
124 //
125 // An alternative implementation would be to make RValue into a concrete
126 // struct that holds a reference to the type. But in the non-optimized build,
127 // this causes unnecessary temporaries to be made bloating the object files.
128 // Also, it would then be possible to accidentally persist an RValue instance.
129 //
130 //
131 // COMPARED TO C++11
132 //
133 // In C++11, you would implement this functionality using an r-value reference
134 // and our .Pass() method would be replaced with a call to std::move().
135 //
136 // This emulation also has a deficiency where it uses up the single
137 // user-defined conversion allowed by C++ during initialization. This can
138 // cause problems in some API edge cases. For instance, in scoped_ptr, it is
139 // impossible to make an function "void Foo(scoped_ptr<Parent> p)" accept a
darin (slow to review) 2012/01/19 05:17:30 this makes me a little sad, but ok :)
awong 2012/01/19 20:13:13 Yes. Makes me sad too. This stack overflow has a
140 // value of type scoped_ptr<Child> even if you add a constructor to
141 // scoped_ptr<> that would make it look like it should work. C++11 does not
142 // have this deficiency.
143 //
144 //
145 // COMPARED TO Boost.Move
146 //
147 // Our implementation is based on Boost.Move, but we keep the RValue struct
148 // private to the move-only type.
149 //
150 // In Boost.Move, RValue is the boost::rv<> template. This type can be used
151 // when writing APIs like:
152 //
153 // void MyFunc(boost::rv<Foo>& f)
154 //
155 // that can take advantage of rv<> to avoid extra copies of a type. However you
156 // would still be able to call this version of MyFunc with an l-value:
157 //
158 // Foo f;
159 // MyFunc(f); // Uh oh, we probably just destroyed |f| w/o calling Pass().
160 //
161 // unless someone is very careful to also declare a parallel override like:
162 //
163 // void MyFunc(const Foo& f)
164 //
165 // that would catch the l-values first. This was declared unsafe in C++11 and
166 // a C++11 compiler will explicitly fail MyFunc(f). Unfortunately, we cannot
167 // ensure this in C++03.
168 //
169 // Since we have no need for writing such APIs yet, our implementation keeps
170 // RValue private and uses a .Pass() method to do the conversion instead of
171 // trying to write a version of "std::move()." Writing an API like std::move()
172 // would require the RValue structs to be public.
173 //
174 //
175 // CAVEATS
176 //
177 // If you include a move-only type as a field inside a class that does not
178 // explicitly declare a copy constructor, the containing class's implicit
179 // copy constructor will change from Containing(const Containing&) to
180 // Containing(Containing&). This can cause some unexpected errors.
181 //
182 // http://llvm.org/bugs/show_bug.cgi?id=11528
183 //
184 // The workaround is to explicitly declare your copy constructor.
185 //
186 #define MOVE_ONLY_TYPE_FOR_CPP_03(type) \
187 private: \
188 struct RValue : public type { \
189 RValue(); \
190 ~RValue(); \
191 RValue(const RValue&); \
192 void operator=(const RValue&); \
193 }; \
194 type(type&); \
195 void operator=(type&); \
196 public: \
197 operator RValue&() { return *reinterpret_cast<RValue*>(this); } \
198 type Pass() { return type(*reinterpret_cast<RValue*>(this)); } \
199 private:
200
201 #endif // BASE_MOVE_H_
OLDNEW
« base/memory/scoped_vector.h ('K') | « base/memory/scoped_vector_unittest.cc ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698