summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/Qt3DSFoundation/Include/foundation/Qt3DSRefCounted.h
blob: b500b5fc47604bb6815a1b907e77ce2ef07397b5 (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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT3DS_FOUNDATION_QT3DS_REFCOUNTED_H
#define QT3DS_FOUNDATION_QT3DS_REFCOUNTED_H
#include "foundation/Qt3DS.h"
#include "foundation/Qt3DSNoCopy.h"

namespace qt3ds {
namespace foundation {
    /**
            Marker class for objects that have a release method that is expected
            to destroy or release the object.
    */
    class NVReleasable
    {
    protected:
        virtual ~NVReleasable() {}
    public:
        virtual void release() = 0;
    };

    template <typename TObjType>
    inline void NVSafeRelease(TObjType *&item)
    {
        if (item) {
            item->release();
            item = NULL;
        }
    }

    /**Scoped pointer that releases its data
            when it is being destroyed*/
    template <typename TObjType>
    struct NVScopedReleasable : public NoCopy
    {
        TObjType *mPtr;
        NVScopedReleasable()
            : mPtr(NULL)
        {
        }
        NVScopedReleasable(TObjType *item)
            : mPtr(item)
        {
        }
        NVScopedReleasable(TObjType &item)
            : mPtr(&item)
        {
        }
        ~NVScopedReleasable() { NVSafeRelease(mPtr); }

        NVScopedReleasable &operator=(TObjType *inItem)
        {
            if (inItem != mPtr) {
                if (mPtr)
                    mPtr->release();
                mPtr = inItem;
            }
            return *this;
        }

        NVScopedReleasable &operator=(const NVScopedReleasable<TObjType> inItem)
        {
            QT3DS_ASSERT(false);
            // try to do the right thing.
            mPtr = inItem.mPtr;
            const_cast<NVScopedReleasable<TObjType> &>(inItem).mPtr = NULL;
            return *this;
        }

        TObjType *forget_unsafe()
        {
            mPtr = NULL;
            return mPtr;
        }

        TObjType *operator->() { return mPtr; }
        const TObjType *operator->() const { return mPtr; }
        TObjType &operator*() { return *mPtr; }
        const TObjType &operator*() const { return *mPtr; }
        operator TObjType *() { return mPtr; }
        operator const TObjType *() const { return mPtr; }
    };

    // Marker class for objects that are ref counted.
    class NVRefCounted : public NVReleasable
    {
    public:
        virtual void addRef() = 0;
    };

/**Helpers to make implementing ref counted objects as concise as possible*/
#define QT3DS_IMPLEMENT_REF_COUNT_RELEASE(alloc)                                                      \
    QT3DSI32 value = atomicDecrement(&mRefCount);                                                     \
    if (value <= 0)                                                                                \
        NVDelete(alloc, this);

#define QT3DS_IMPLEMENT_REF_COUNT_ADDREF_RELEASE(alloc)                                               \
    void addRef() { atomicIncrement(&mRefCount); }                                                 \
    void release() { QT3DS_IMPLEMENT_REF_COUNT_RELEASE(alloc); }


#define QT3DS_IMPLEMENT_REF_COUNT_ADDREF_RELEASE_OVERRIDE(alloc)                                               \
    void addRef() override { atomicIncrement(&mRefCount); }                                                 \
    void release() override { QT3DS_IMPLEMENT_REF_COUNT_RELEASE(alloc); }

    /**Safe function that checks for null before addrefing the object*/
    template <typename TObjType>
    inline TObjType *NVSafeAddRef(TObjType *item)
    {
        if (item) {
            item->addRef();
        }
        return item;
    }

    /**Scoped pointer that addref's its data upon acquisition and releases its data
            when it is being destroyed*/
    template <typename TObjType>
    struct NVScopedRefCounted
    {
        TObjType *mPtr;
        ~NVScopedRefCounted() { NVSafeRelease(mPtr); }
        NVScopedRefCounted(TObjType *item = NULL)
            : mPtr(item)
        {
            NVSafeAddRef(mPtr);
        }
        NVScopedRefCounted(TObjType &item)
            : mPtr(&item)
        {
            NVSafeAddRef(mPtr);
        }
        NVScopedRefCounted(const NVScopedRefCounted<TObjType> &other)
            : mPtr(const_cast<TObjType *>(other.mPtr))
        {
            NVSafeAddRef(mPtr);
        }
        NVScopedRefCounted<TObjType> &operator=(const NVScopedRefCounted<TObjType> &other)
        {
            if (other.mPtr != mPtr) {
                NVSafeRelease(mPtr);
                mPtr = const_cast<TObjType *>(other.mPtr);
                NVSafeAddRef(mPtr);
            }
            return *this;
        }
        TObjType *forget_unsafe()
        {
            mPtr = NULL;
            return mPtr;
        }

        TObjType *operator->() { return mPtr; }
        const TObjType *operator->() const { return mPtr; }
        TObjType &operator*() { return *mPtr; }
        const TObjType &operator*() const { return *mPtr; }
        operator TObjType *() { return mPtr; }
        operator const TObjType *() const { return mPtr; }
        bool operator==(NVScopedRefCounted<TObjType> &inOther) const
        {
            return mPtr == inOther.mPtr;
        }
        bool operator!=(NVScopedRefCounted<TObjType> &inOther) const
        {
            return mPtr != inOther.mPtr;
        }
    };
}
}

#endif