[email protected] | c9dfa2c | 2011-06-28 02:20:02 | [diff] [blame] | 1 | // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 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_AUTO_RESET_H_ | ||||
6 | #define BASE_AUTO_RESET_H_ | ||||
7 | |||||
Sam McNally | 54bc028 | 2017-12-13 02:42:29 | [diff] [blame] | 8 | #include <utility> |
9 | |||||
avi | 9b6f4293 | 2015-12-26 22:15:14 | [diff] [blame] | 10 | #include "base/macros.h" |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 11 | |
[email protected] | 997ec9f | 2012-11-21 04:44:14 | [diff] [blame] | 12 | // base::AutoReset<> is useful for setting a variable to a new value only within |
13 | // a particular scope. An base::AutoReset<> object resets a variable to its | ||||
14 | // original value upon destruction, making it an alternative to writing | ||||
15 | // "var = false;" or "var = old_val;" at all of a block's exit points. | ||||
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 16 | // |
[email protected] | 997ec9f | 2012-11-21 04:44:14 | [diff] [blame] | 17 | // This should be obvious, but note that an base::AutoReset<> instance should |
18 | // have a shorter lifetime than its scoped_variable, to prevent invalid memory | ||||
19 | // writes when the base::AutoReset<> object is destroyed. | ||||
20 | |||||
21 | namespace base { | ||||
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 22 | |
[email protected] | 0fbd7033 | 2010-06-01 19:28:34 | [diff] [blame] | 23 | template<typename T> |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 24 | class AutoReset { |
25 | public: | ||||
[email protected] | 0fbd7033 | 2010-06-01 19:28:34 | [diff] [blame] | 26 | AutoReset(T* scoped_variable, T new_value) |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 27 | : scoped_variable_(scoped_variable), |
Sam McNally | 54bc028 | 2017-12-13 02:42:29 | [diff] [blame] | 28 | original_value_(std::move(*scoped_variable)) { |
29 | *scoped_variable_ = std::move(new_value); | ||||
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 30 | } |
[email protected] | 0fbd7033 | 2010-06-01 19:28:34 | [diff] [blame] | 31 | |
Sam McNally | 54bc028 | 2017-12-13 02:42:29 | [diff] [blame] | 32 | ~AutoReset() { *scoped_variable_ = std::move(original_value_); } |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 33 | |
34 | private: | ||||
[email protected] | 0fbd7033 | 2010-06-01 19:28:34 | [diff] [blame] | 35 | T* scoped_variable_; |
36 | T original_value_; | ||||
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 37 | |
38 | DISALLOW_COPY_AND_ASSIGN(AutoReset); | ||||
39 | }; | ||||
40 | |||||
danakj | c3762b9 | 2015-03-07 01:51:42 | [diff] [blame] | 41 | } // namespace base |
[email protected] | 997ec9f | 2012-11-21 04:44:14 | [diff] [blame] | 42 | |
[email protected] | 5be7da24 | 2009-11-20 23:16:26 | [diff] [blame] | 43 | #endif // BASE_AUTO_RESET_H_ |