aboutsummaryrefslogtreecommitdiff
path: root/odb/wrapper-traits.hxx
blob: 8816f5add3d3264407896e278ec385189f7832f1 (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
// file      : odb/wrapper-traits.hxx
// copyright : Copyright (c) 2009-2012 Code Synthesis Tools CC
// license   : GNU GPL v2; see accompanying LICENSE file

#ifndef ODB_WRAPPER_TRAITS_HXX
#define ODB_WRAPPER_TRAITS_HXX

#include <odb/pre.hxx>

#include <memory> // std::auto_ptr, std::unique_ptr, std::shared_ptr/weak_ptr

#include <odb/nullable.hxx>

#include <odb/details/config.hxx>            // ODB_CXX11
#include <odb/details/meta/remove-const.hxx>

namespace odb
{
  template <typename T>
  class wrapper_traits;

  // Sample specialization for raw pointers. It is not enabled by default
  // since it makes many assumptions that may not always hold true (such
  // as that instances are allocated with new and freed with delete).
  // This makes it too dangerous to be enable unconditionally. If you
  // need this functionality, you can copy the below code into your
  // application. Also consider changing it to only specialize for
  // specific types instead of for any pointer (it will almost always
  // do the wrong thing for char*).
  //
#if 0
  template <typename T>
  class wrapper_traits<T*>
  {
  public:
    typedef T wrapped_type;
    typedef T* wrapper_type;

    // T can be const.
    //
    typedef
    typename details::meta::remove_const<T>::result
    unrestricted_wrapped_type;

    static const bool null_handler = true;
    static const bool null_default = false;

    static bool
    get_null (const wrapper_type& p)
    {
      return p == 0;
    }

    static void
    set_null (wrapper_type& p)
    {
      delete p;
      p = 0;
    }

    static const wrapped_type&
    get_ref (const wrapper_type& p)
    {
      return *p;
    }

    static unrestricted_wrapped_type&
    set_ref (wrapper_type& p)
    {
      if (p == 0)
        p = new unrestricted_wrapped_type;

      return const_cast<unrestricted_wrapped_type&> (*p);
    }
  };
#endif

  // Specialization for std::auto_ptr.
  //
  template <typename T>
  class wrapper_traits< std::auto_ptr<T> >
  {
  public:
    // T can be const.
    //
    typedef T wrapped_type;
    typedef std::auto_ptr<T> wrapper_type;

    // T can be const.
    //
    typedef
    typename odb::details::meta::remove_const<T>::result
    unrestricted_wrapped_type;

    static const bool null_handler = true;
    static const bool null_default = false;

    static bool
    get_null (const wrapper_type& p)
    {
      return p.get () == 0;
    }

    static void
    set_null (wrapper_type& p)
    {
      p.reset ();
    }

    static const wrapped_type&
    get_ref (const wrapper_type& p)
    {
      return *p;
    }

    static unrestricted_wrapped_type&
    set_ref (wrapper_type& p)
    {
      if (p.get () == 0)
        p.reset (new unrestricted_wrapped_type ());

      return const_cast<unrestricted_wrapped_type&> (*p);
    }
  };

#ifdef ODB_CXX11

  // Specialization for C++11 std::unique_ptr.
  //
  template <typename T, typename D>
  class wrapper_traits<std::unique_ptr<T, D>>
  {
  public:
    // T can be const.
    //
    typedef T wrapped_type;
    typedef std::unique_ptr<T, D> wrapper_type;

    // T can be const.
    //
    typedef
    typename odb::details::meta::remove_const<T>::result
    unrestricted_wrapped_type;

    static const bool null_handler = true;
    static const bool null_default = false;

    static bool
    get_null (const wrapper_type& p)
    {
      return !p;
    }

    static void
    set_null (wrapper_type& p)
    {
      p.reset ();
    }

    static const wrapped_type&
    get_ref (const wrapper_type& p)
    {
      return *p;
    }

    static unrestricted_wrapped_type&
    set_ref (wrapper_type& p)
    {
      if (!p)
        p.reset (new unrestricted_wrapped_type ());

      return const_cast<unrestricted_wrapped_type&> (*p);
    }
  };

  // Specialization for C++11 std::shared_ptr.
  //
  template <typename T>
  class wrapper_traits<std::shared_ptr<T>>
  {
  public:
    typedef T wrapped_type;
    typedef std::shared_ptr<T> wrapper_type;

    // T can be const.
    //
    typedef
    typename odb::details::meta::remove_const<T>::result
    unrestricted_wrapped_type;

    static const bool null_handler = true;
    static const bool null_default = false;

    static bool
    get_null (const wrapper_type& p)
    {
      return !p;
    }

    static void
    set_null (wrapper_type& p)
    {
      p.reset ();
    }

    static const wrapped_type&
    get_ref (const wrapper_type& p)
    {
      return *p;
    }

    static unrestricted_wrapped_type&
    set_ref (wrapper_type& p)
    {
      if (!p)
        p.reset (new unrestricted_wrapped_type);

      return const_cast<unrestricted_wrapped_type&> (*p);
    }
  };

#endif // ODB_CXX11

  // Specialization for odb::nullable.
  //
  template <typename T>
  class wrapper_traits< nullable<T> >
  {
  public:
    // T can be const.
    //
    typedef T wrapped_type;
    typedef nullable<T> wrapper_type;

    // T can be const.
    //
    typedef
    typename odb::details::meta::remove_const<T>::result
    unrestricted_wrapped_type;

    static const bool null_handler = true;
    static const bool null_default = true;

    static bool
    get_null (const wrapper_type& n)
    {
      return n.null ();
    }

    static void
    set_null (wrapper_type& n)
    {
      n.reset ();
    }

    static const wrapped_type&
    get_ref (const wrapper_type& n)
    {
      return *n;
    }

    static unrestricted_wrapped_type&
    set_ref (wrapper_type& n)
    {
      if (n.null ())
        n = unrestricted_wrapped_type ();

      return const_cast<unrestricted_wrapped_type&> (*n);
    }
  };
}

#include <odb/post.hxx>

#endif // ODB_WRAPPER_TRAITS_HXX