aboutsummaryrefslogtreecommitdiff
path: root/odb/qt/smart-ptr/lazy-ptr.hxx
blob: e22dc3ee3b02ea2e8ca546a39683dd7087ead188 (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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
// file      : odb/qt/smart-ptr/lazy-ptr.hxx
// author    : Constantin Michael <constantin@codesynthesis.com>
// copyright : Copyright (c) 2009-2011 Code Synthesis Tools CC
// license   : GNU GPL v2; see accompanying LICENSE file

#ifndef ODB_QT_SMART_PTR_LAZY_PTR_HXX
#define ODB_QT_SMART_PTR_LAZY_PTR_HXX

#include <odb/pre.hxx>

#include <QtCore/QSharedPointer>
#include <QtCore/QWeakPointer>
#include <QtCore/QGlobalStatic>

#include <odb/forward.hxx> // odb::database
#include <odb/traits.hxx>
#include <odb/lazy-ptr-impl.hxx>

template <class T>
class QLazyWeakPointer;

//
// QLazySharedPointer declaration.
//

template <class T>
class QLazySharedPointer
{
  // The standard QSharedPointer interface.
  //
public:
  // These typedefs are inherited by QSharedPointer indirectly from
  // QtSharedPointer::Basic<T>
  //
  typedef T Type;
  typedef T element_type;
  typedef T value_type;
  typedef value_type* pointer;
  typedef const value_type* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;
  typedef qptrdiff difference_type;

  QLazySharedPointer ();

  explicit
  QLazySharedPointer (T*);

  template <class Deleter>
  QLazySharedPointer (T*, Deleter);

  QLazySharedPointer (const QLazySharedPointer&);

  template <class X>
  QLazySharedPointer (const QLazySharedPointer<X>&);

  template <class X>
  QLazySharedPointer (const QLazyWeakPointer<X>&);

  ~QLazySharedPointer ();

  QLazySharedPointer&
  operator= (const QLazySharedPointer&);

  template <class X>
  QLazySharedPointer&
  operator= (const QLazySharedPointer<X>&);

  template <class X>
  QLazySharedPointer&
  operator= (const QLazyWeakPointer<X>&);

  typedef QSharedPointer<T> QLazySharedPointer<T>::*unspecified_bool_type;
  operator unspecified_bool_type () const
  {
    return isNull () ? 0 : &QLazySharedPointer::p_;
  }

  bool
  operator! () const;

  T&
  operator* () const;

  T*
  operator-> () const;

  void
  swap (QLazySharedPointer&);

  bool
  isNull () const;

  T*
  data () const;

  QLazyWeakPointer<T>
  toWeakRef () const;

  void
  clear ();

  template <class X>
  QLazySharedPointer<X>
  staticCast () const;

  template <class X>
  QLazySharedPointer<X>
  dynamicCast () const;

  template <class X>
  QLazySharedPointer<X>
  constCast () const;

  // Initialization and assignment from QSharedPointer and QWeakPointer.
  //
public:
  template <class X>
  QLazySharedPointer (const QSharedPointer<X>&);

  template <class X>
  explicit
  QLazySharedPointer (const QWeakPointer<X>&);

  template <class X>
  QLazySharedPointer&
  operator= (const QSharedPointer<X>&);

  template <class X>
  QLazySharedPointer&
  operator= (const QWeakPointer<X>&);

  // Lazy loading interface.
  //
public:
  typedef odb::database database_type;

  // isNull()   loaded()
  //
  //  true       true      NULL pointer to transient object
  //  false      true      valid pointer to persistent object
  //  true       false     unloaded pointer to persistent object
  //  false      false     valid pointer to transient object
  //
  bool
  loaded () const;

  QSharedPointer<T>
  load () const;

  // Unload the pointer. For transient objects this function is
  // equivalent to clear().
  //
  void unload () const;

  template <class ID>
  QLazySharedPointer (database_type&, const ID&);

  QLazySharedPointer (database_type&, T*);

  template <class Deleter>
  QLazySharedPointer (database_type&, T*, Deleter);

  template <class X>
  QLazySharedPointer (database_type&, const QSharedPointer<X>&);

  template <class X>
  QLazySharedPointer (database_type&, const QWeakPointer<X>&);

  template <class O /* = T */>
  typename odb::object_traits<O>::id_type
  objectId () const;

  database_type&
  database () const;

  // Helpers.
  //
public:
  template <class X>
  bool
  equal (const QLazySharedPointer<X>&) const;

private:
  template <class X> friend class QLazySharedPointer;
  template <class X> friend class QLazyWeakPointer;

  mutable QSharedPointer<T> p_;
  mutable odb::lazy_ptr_impl<T> i_;
};

//
// QLazySharedPointer related non-members.
//

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerCast (const QLazySharedPointer<T>&);

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerConstCast (const QLazySharedPointer<T>&);

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerDynamicCast (const QLazySharedPointer<T>&);

template <class T, class X>
bool
operator== (const QLazySharedPointer<T>&, const QLazySharedPointer<X>&);

template <class T, class X>
bool
operator!= (const QLazySharedPointer<T>&, const QLazySharedPointer<T>&);

//
// QLazyWeakPointer declaration
//

template <class T>
class QLazyWeakPointer
{
  // The standard QWeakPointer interface
  //
public:
  typedef T element_type;
  typedef T value_type;
  typedef value_type* pointer;
  typedef const value_type* const_pointer;
  typedef value_type& reference;
  typedef const value_type& const_reference;
  typedef qptrdiff difference_type;

  QLazyWeakPointer ();

  QLazyWeakPointer (const QLazyWeakPointer&);

  template <class X>
  QLazyWeakPointer (const QLazyWeakPointer<X>&);

  template <class X>
  QLazyWeakPointer (const QLazySharedPointer<X>&);

  ~QLazyWeakPointer ();

  QLazyWeakPointer&
  operator= (const QLazyWeakPointer&);

  template <class X>
  QLazyWeakPointer&
  operator= (const QLazyWeakPointer<X>&);

  template <class X>
  QLazyWeakPointer&
  operator= (const QLazySharedPointer<X>&);

  typedef QWeakPointer<T> QLazyWeakPointer<T>::*unspecified_bool_type;
  operator unspecified_bool_type () const
  {
    return isNull () ? 0 : &QLazyWeakPointer<T>::p_;
  }

  bool
  operator! () const;

#ifdef QWEAKPOINTER_ENABLE_ARROW
  T*
  operator-> () const;
#endif

  void
  clear ();

  T*
  data () const;

  bool
  isNull () const;

  QLazySharedPointer<T>
  toStrongRef () const;

  // Initialization/assignment from QSharedPointer and QWeakPointer.
  //
public:
  template <class X>
  QLazyWeakPointer (const QWeakPointer<X>&);

  template <class X>
  QLazyWeakPointer (const QSharedPointer<X>&);

  template <class X>
  QLazyWeakPointer&
  operator= (const QWeakPointer<X>&);

  template <class X>
  QLazyWeakPointer&
  operator= (const QSharedPointer<X>&);

  // Lazy loading interface.
  //
public:
  typedef odb::database database_type;

  // toStrongRef().isNull()  loaded()
  //
  //          true             true      expired pointer to transient object
  //          false            true      valid pointer to persistent object
  //          true             false     expired pointer to persistent object
  //          false            false     valid pointer to transient object
  //
  bool
  loaded () const;

  // Create a strong reference using toStrongRef() and load.
  //
  QSharedPointer<T>
  load () const;

  // Unload the pointer. For transient objects this function is equivalent
  // to clear().
  //
  void
  unload () const;

  template <class ID>
  QLazyWeakPointer (database_type&, const ID&);

  template <class X>
  QLazyWeakPointer (database_type&, const QSharedPointer<X>&);

  template <class X>
  QLazyWeakPointer (database_type&, const QWeakPointer<X>&);

  // The objectId() function can only be called when the object is persistent,
  // or: toStrongRef().isNull() XOR loaded() (can use != for XOR).
  //
  template <class O /* = T */>
  typename odb::object_traits<O>::id_type
  objectId () const;

  database_type&
  database () const;

  // Helpers.
  //
public:
  template <class X>
  bool
  equal (const QLazyWeakPointer<X>&) const;

  template <class X>
  bool
  equal (const QLazySharedPointer<X>&) const;

private:
  template <class X> friend class QLazySharedPointer;
  template <class X> friend class QLazyWeakPointer;

  mutable QWeakPointer<T> p_;
  mutable odb::lazy_ptr_impl<T> i_;
};

//
// QLazyWeakPointer related non-members.
//

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerCast (const QLazyWeakPointer<T>&);

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerConstCast (const QLazyWeakPointer<T>&);

template <class T, class X>
QLazySharedPointer<X>
qSharedPointerDynamicCast (const QLazyWeakPointer<T>&);

template <class T, class X>
QLazyWeakPointer<X>
qWeakPointerCast (const QLazyWeakPointer<T>&);

template <class T, class X>
bool
operator== (const QLazyWeakPointer<T>&, const QLazyWeakPointer<X>&);

template <class T, class X>
bool
operator== (const QLazyWeakPointer<T>&, const QLazySharedPointer<X>&);

template <class T, class X>
bool
operator== (const QLazySharedPointer<T>&, const QLazyWeakPointer<X>&);

template <class T, class X>
bool
operator!= (const QLazyWeakPointer<T>&, const QLazyWeakPointer<X>&);

template <class T, class X>
bool
operator!= (const QLazyWeakPointer<T>&, const QLazySharedPointer<X>&);

template <class T, class X>
bool
operator!= (const QLazySharedPointer<T>&, const QLazyWeakPointer<X>&);

#include <odb/qt/smart-ptr/lazy-ptr.ixx>
#include <odb/qt/smart-ptr/lazy-ptr.txx>

#include <odb/qt/smart-ptr/lazy-pointer-traits.hxx>

#include <odb/post.hxx>

#endif // ODB_QT_SMART_PTR_LAZY_PTR_HXX