summaryrefslogtreecommitdiffstats
path: root/src/bluetooth/osx/btraii_p.h
blob: 6053d63b7d01f486fd1d9ae579dff3a1483cf33b (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
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtBluetooth module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or 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.GPL2 and 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef BTRAII_P_H
#define BTRAII_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/qglobal.h>

#include <utility>

QT_BEGIN_NAMESPACE

namespace DarwinBluetooth {

enum class RetainPolicy
{
    noInitialRetain,
    doInitialRetain
};

// The class StrongReference and its descendant ScopedGuard
// are RAII classes dealing with raw pointers to NSObject class
// and its descendants (and thus hiding Objective-C's retain/
// release semantics). The header itself is meant to be included
// into *.cpp files so it's a pure C++ code without any Objective-C
// syntax. Thus it's a bit clunky - the type information is 'erased'
// and has to be enforced by the code using these smart pointers.
// That's because these types are Objective-C classes - thus require
// Objective-C compiler to work. Member-function template 'getAs' is
// a convenience shortcut giving the desired pointer type in
// Objective-C++ files (*.mm).

// TODO: on top of these classes I can build ObjCStrongReference (it's
// now inside osxbtutils_p.h, a template class that does have type
// information needed but works only in Objective-C++ environment.
class StrongReference
{
public:
    StrongReference() = default;
    StrongReference(void *object, RetainPolicy policy);
    StrongReference(const StrongReference &other);
    StrongReference(StrongReference &&other);

    ~StrongReference();

    StrongReference &operator = (const StrongReference &other) noexcept;
    StrongReference &operator = (StrongReference &&other) noexcept;

    void swap(StrongReference &other) noexcept
    {
        std::swap(objCInstance, other.objCInstance);
    }

    void reset();
    void reset(void *newInstance, RetainPolicy policy);

    template<class ObjCType>
    ObjCType *getAs() const
    {
        return static_cast<ObjCType *>(objCInstance);
    }

    operator bool() const
    {
        return !!objCInstance;
    }

private:
    void *objCInstance = nullptr;
};

class ScopedPointer final : public StrongReference
{
public:
    ScopedPointer() = default;
    ScopedPointer(void *instance, RetainPolicy policy)
        : StrongReference(instance, policy)
    {
    }

private:
    Q_DISABLE_COPY_MOVE(ScopedPointer)
};

} // namespace DarwinBluetooth

QT_END_NAMESPACE

#endif // BTRAII_P_H