DART  6.10.1
SmartPointer.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_COMMON_SMARTPOINTER_HPP_
34 #define DART_COMMON_SMARTPOINTER_HPP_
35 
36 #include <memory>
37 
38 // -- Standard shared/weak pointers --
39 // Define a typedef for const and non-const version of shared_ptr and weak_ptr
40 // for the class X
41 #define DART_COMMON_DECLARE_SHARED_WEAK(X) \
42  class X; \
43  using X##Ptr = std::shared_ptr<X>; \
44  using Const##X##Ptr = std::shared_ptr<const X>; \
45  using Weak##X##Ptr = std::weak_ptr<X>; \
46  using WeakConst##X##Ptr = std::weak_ptr<const X>;
47 
48 // Deprecated in DART 6.4. Please use DART_COMMON_DECLARE_SHARED_WEAK
49 //
50 // -- Standard shared/weak pointers --
51 // Define a typedef for const and non-const version of shared_ptr and weak_ptr
52 // for the class X
53 #define DART_COMMON_MAKE_SHARED_WEAK(X) DART_COMMON_DECLARE_SHARED_WEAK(X)
54 
55 // -- Standard shared/weak/unique pointers --
56 // Type aliases for const and non-const version of shared_ptr, weak_ptr, and
57 // unique_ptr for the class X
58 #define DART_COMMON_DECLARE_SMART_POINTERS(X) \
59  DART_COMMON_DECLARE_SHARED_WEAK(X) \
60  using Unique##X##Ptr = std::unique_ptr<X>; \
61  using UniqueConst##X##Ptr = std::unique_ptr<const X>;
62 
63 #endif // DART_COMMON_SMARTPOINTER_HPP_