Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2019 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtBluetooth module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef BTRAII_P_H
41#define BTRAII_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/qglobal.h>
55
56#include <utility>
57
58QT_BEGIN_NAMESPACE
59
60namespace DarwinBluetooth {
61
62enum class RetainPolicy
63{
64 noInitialRetain,
65 doInitialRetain
66};
67
68// The class StrongReference and its descendant ScopedGuard
69// are RAII classes dealing with raw pointers to NSObject class
70// and its descendants (and thus hiding Objective-C's retain/
71// release semantics). The header itself is meant to be included
72// into *.cpp files so it's a pure C++ code without any Objective-C
73// syntax. Thus it's a bit clunky - the type information is 'erased'
74// and has to be enforced by the code using these smart pointers.
75// That's because these types are Objective-C classes - thus require
76// Objective-C compiler to work. Member-function template 'getAs' is
77// a convenience shortcut giving the desired pointer type in
78// Objective-C++ files (*.mm).
79
80// TODO: on top of these classes I can build ObjCStrongReference (it's
81// now inside osxbtutils_p.h, a template class that does have type
82// information needed but works only in Objective-C++ environment.
83class StrongReference
84{
85public:
86 StrongReference() = default;
87 StrongReference(void *object, RetainPolicy policy);
88 StrongReference(const StrongReference &other);
89 StrongReference(StrongReference &&other);
90
91 ~StrongReference();
92
93 StrongReference &operator = (const StrongReference &other) noexcept;
94 StrongReference &operator = (StrongReference &&other) noexcept;
95
96 void swap(StrongReference &other) noexcept
97 {
98 std::swap(objCInstance, other.objCInstance);
99 }
100
101 void reset();
102 void reset(void *newInstance, RetainPolicy policy);
103
104 template<class ObjCType>
105 ObjCType *getAs() const
106 {
107 return static_cast<ObjCType *>(objCInstance);
108 }
109
110 operator bool() const
111 {
112 return !!objCInstance;
113 }
114
115private:
116 void *objCInstance = nullptr;
117};
118
119class ScopedPointer final : public StrongReference
120{
121public:
122 ScopedPointer() = default;
123 ScopedPointer(void *instance, RetainPolicy policy)
124 : StrongReference(instance, policy)
125 {
126 }
127
128private:
129 Q_DISABLE_COPY_MOVE(ScopedPointer)
130};
131
132} // namespace DarwinBluetooth
133
134QT_END_NAMESPACE
135
136#endif // BTRAII_P_H
137

Warning: That file was not part of the compilation database. It may have many parsing errors.