summaryrefslogtreecommitdiff
path: root/indra/llcommon/llptrto.h
blob: 9ef279fdbfd973f93b778b29dfe31df91734b163 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/**
 * @file   llptrto.h
 * @author Nat Goodspeed
 * @date   2008-08-19
 * @brief  LLPtrTo<TARGET> is a template helper to pick either TARGET* or -- when
 *         TARGET is a subclass of LLRefCount or LLThreadSafeRefCount --
 *         LLPointer<TARGET>. LLPtrTo<> chooses whichever pointer type is best.
 * 
 * $LicenseInfo:firstyear=2008&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#if ! defined(LL_LLPTRTO_H)
#define LL_LLPTRTO_H

#include "llpointer.h"
#include "llrefcount.h"             // LLRefCount
#include <boost/intrusive_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/type_traits/is_base_of.hpp>
#include <boost/type_traits/remove_pointer.hpp>
#include <memory>                   // std::shared_ptr, std::unique_ptr
#include <type_traits>

/**
 * LLPtrTo<TARGET>::type is either of two things:
 *
 * * When TARGET is a subclass of either LLRefCount or LLThreadSafeRefCount,
 *   LLPtrTo<TARGET>::type is LLPointer<TARGET>.
 * * Otherwise, LLPtrTo<TARGET>::type is TARGET*.
 *
 * This way, a class template can use LLPtrTo<TARGET>::type to select an
 * appropriate pointer type to store.
 */
template <class T, class ENABLE=void>
struct LLPtrTo
{
    typedef T* type;
};

/// specialize for subclasses of LLRefCount
template <class T>
struct LLPtrTo<T, typename std::enable_if< boost::is_base_of<LLRefCount, T>::value >::type>
{
    typedef LLPointer<T> type;
};

/// specialize for subclasses of LLThreadSafeRefCount
template <class T>
struct LLPtrTo<T, typename std::enable_if< boost::is_base_of<LLThreadSafeRefCount, T>::value >::type>
{
    typedef LLPointer<T> type;
};

/**
 * LLRemovePointer<PTRTYPE>::type gets you the underlying (pointee) type.
 */
template <typename PTRTYPE>
struct LLRemovePointer
{
    typedef typename boost::remove_pointer<PTRTYPE>::type type;
};

/// specialize for LLPointer<SOMECLASS>
template <typename SOMECLASS>
struct LLRemovePointer< LLPointer<SOMECLASS> >
{
    typedef SOMECLASS type;
};

namespace LL
{

/*****************************************************************************
*   get_ref()
*****************************************************************************/
    template <typename T>
    struct GetRef
    {
        // return const ref or non-const ref, depending on whether we can bind
        // a non-const lvalue ref to the argument
        const auto& operator()(const T& obj) const { return obj; }
        auto& operator()(T& obj) const { return obj; }
    };

    template <typename T>
    struct GetRef<const T*>
    {
        const auto& operator()(const T* ptr) const { return *ptr; }
    };

    template <typename T>
    struct GetRef<T*>
    {
        auto& operator()(T* ptr) const { return *ptr; }
    };

    template <typename T>
    struct GetRef< LLPointer<T> >
    {
        auto& operator()(LLPointer<T> ptr) const { return *ptr; }
    };

    /// whether we're passed a pointer or a reference, return a reference
    template <typename T>
    auto& get_ref(T& ptr_or_ref)
    {
        return GetRef<typename std::decay<T>::type>()(ptr_or_ref);
    }

    template <typename T>
    const auto& get_ref(const T& ptr_or_ref)
    {
        return GetRef<typename std::decay<T>::type>()(ptr_or_ref);
    }

/*****************************************************************************
*   get_ptr()
*****************************************************************************/
    // if T is any pointer type we recognize, return it unchanged
    template <typename T>
    const T* get_ptr(const T* ptr) { return ptr; }

    template <typename T>
    T* get_ptr(T* ptr) { return ptr; }

    template <typename T>
    const std::shared_ptr<T>& get_ptr(const std::shared_ptr<T>& ptr) { return ptr; }

    template <typename T>
    const std::unique_ptr<T>& get_ptr(const std::unique_ptr<T>& ptr) { return ptr; }

    template <typename T>
    const boost::shared_ptr<T>& get_ptr(const boost::shared_ptr<T>& ptr) { return ptr; }

    template <typename T>
    const boost::intrusive_ptr<T>& get_ptr(const boost::intrusive_ptr<T>& ptr) { return ptr; }

    template <typename T>
    const LLPointer<T>& get_ptr(const LLPointer<T>& ptr) { return ptr; }

    // T is not any pointer type we recognize, take a pointer to the parameter
    template <typename T>
    const T* get_ptr(const T& obj) { return &obj; }

    template <typename T>
    T* get_ptr(T& obj) { return &obj; }
} // namespace LL

#endif /* ! defined(LL_LLPTRTO_H) */