?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
fixed: auto_ptr -> unique_ptr
[opensg.git] / Source / Base / FieldContainer / Fields / Handle / OSGFieldContainerSFieldHandle.h
blob21e7003bfd84c2fe09f9bf8d730891fcbf7e2a6b
1 /*---------------------------------------------------------------------------*\
2 * OpenSG *
3 * *
4 * *
5 * Copyright (C) 2003 by the OpenSG Forum *
6 * *
7 * www.opensg.org *
8 * *
9 * contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de *
10 * *
11 \*---------------------------------------------------------------------------*/
12 /*---------------------------------------------------------------------------*\
13 * License *
14 * *
15 * This library is free software; you can redistribute it and/or modify it *
16 * under the terms of the GNU Library General Public License as published *
17 * by the Free Software Foundation, version 2. *
18 * *
19 * This library is distributed in the hope that it will be useful, but *
20 * WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
22 * Library General Public License for more details. *
23 * *
24 * You should have received a copy of the GNU Library General Public *
25 * License along with this library; if not, write to the Free Software *
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. *
27 * *
28 \*---------------------------------------------------------------------------*/
29 /*---------------------------------------------------------------------------*\
30 * Changes *
31 * *
32 * *
33 * *
34 * *
35 * *
36 * *
37 \*---------------------------------------------------------------------------*/
38
39 #ifndef _OSGFIELDCONTAINERSFIELDHANDLE_H_
40 #define _OSGFIELDCONTAINERSFIELDHANDLE_H_
41 #ifdef __sgi
42 #pragma once
43 #endif
44
45 #include <boost/function.hpp>
46 #include <boost/type_traits.hpp>
47
48 OSG_BEGIN_NAMESPACE
49
50 /*! \ingroup GrpBaseFieldContainerFields
51 \ingroup GrpLibOSGBase
52 */
53
54 template <>
55 class OSG_BASE_DLLMAPPING GetSFieldHandle<FieldContainerPtrSFieldBase> :
56 public GetFieldHandle
57 {
58 /*========================= PROTECTED ===============================*/
59
60 protected:
61
62 typedef GetFieldHandle Inherited;
63
64 /*========================== PUBLIC =================================*/
65
66 public:
67
68 /*---------------------------------------------------------------------*/
69 /*! \name Public Types */
70 /*! \{ */
71
72 typedef boost::shared_ptr<GetSFieldHandle> Ptr;
73
74 /*---------------------------------------------------------------------*/
75 /*! \name Constructors */
76 /*! \{ */
77
78 GetSFieldHandle(const GetSFieldHandle &source);
79 GetSFieldHandle(const FieldContainerPtrSFieldBase *pField,
80 const FieldDescriptionBase *pDescription,
81 FieldContainer *pContainer );
82
83 /*! \} */
84 /*---------------------------------------------------------------------*/
85 /*! \name Field Type Query */
86 /*! \{ */
87
88 virtual const FieldType &getType (void) const;
89 virtual bool isPointerField(void) const;
90
91 /*! \} */
92 /*---------------------------------------------------------------------*/
93 /*! \name Stream/String IO */
94 /*! \{ */
95
96 virtual void pushValueToStream (OutStream &str ) const;
97 virtual void pushIndexedValueToStream(OutStream &str,
98 UInt32 index) const;
99 virtual void pushSizeToStream (OutStream &str ) const;
100
101 /*! \} */
102 /*---------------------------------------------------------------------*/
103 /*! \name Comparison */
104 /*! \{ */
105
106 virtual bool equal(Inherited::Ptr rhs) const;
107 virtual SizeT size (void ) const;
108
109 /*! \} */
110 /*---------------------------------------------------------------------*/
111 /*! \name Access */
112 /*! \{ */
113
114 virtual FieldContainer *get(void) const = 0;
115
116 const FieldContainerPtrSFieldBase *getField (void);
117
118 const FieldContainerPtrSFieldBase *operator ->(void);
119 const FieldContainerPtrSFieldBase &operator * (void);
120
121 /*! \} */
122 /*---------------------------------------------------------------------*/
123 };
124
125
126 /*! \ingroup GrpBaseFieldContainerFields
127 \ingroup GrpLibOSGBase
128 */
129
130 template <>
131 class OSG_BASE_DLLMAPPING EditSFieldHandle<FieldContainerPtrSFieldBase> :
132 public EditFieldHandle
133 {
134 /*========================= PROTECTED ===============================*/
135
136 protected:
137
138 typedef EditFieldHandle Inherited;
139
140 typedef GetSFieldHandle<FieldContainerPtrSFieldBase> GetSFHandle;
141 typedef boost::shared_ptr<GetSFHandle> GetSFHandlePtr;
142
143 bool _bStoreless;
144
145 /*========================== PUBLIC =================================*/
146
147 public:
148
149 /*---------------------------------------------------------------------*/
150 /*! \name Public Types */
151 /*! \{ */
152
153 typedef boost::shared_ptr<EditSFieldHandle> Ptr;
154
155 /*! \} */
156 /*---------------------------------------------------------------------*/
157 /*! \name Constructors */
158 /*! \{ */
159
160 EditSFieldHandle(const EditSFieldHandle &source);
161 EditSFieldHandle( FieldContainerPtrSFieldBase *pField,
162 const FieldDescriptionBase *pDescription,
163 FieldContainer *pContainer );
164
165 /*! \} */
166 /*---------------------------------------------------------------------*/
167 /*! \name Field Type Query */
168 /*! \{ */
169
170 virtual bool isValid(void) const;
171
172 /*! \} */
173 /*---------------------------------------------------------------------*/
174 /*! \name Field Type Query */
175 /*! \{ */
176
177 void setStoreless(void);
178
179 /*! \} */
180 /*---------------------------------------------------------------------*/
181 /*! \name Field Type Query */
182 /*! \{ */
183
184 virtual const FieldType &getType (void) const;
185 virtual bool isPointerField(void) const;
186
187 virtual bool supportsSet (void) const = 0;
188
189 /*! \} */
190 /*---------------------------------------------------------------------*/
191 /*! \name Access */
192 /*! \{ */
193
194 virtual FieldContainer *get(void ) const = 0;
195
196 virtual bool set(FieldContainer *newFC) const = 0;
197
198 /*! \} */
199 /*---------------------------------------------------------------------*/
200 /*! \name Stream/String IO */
201 /*! \{ */
202
203 virtual void pushValueToStream ( OutStream &str ) const;
204 virtual void pushIndexedValueToStream( OutStream &str,
205 UInt32 index) const;
206 virtual void pushSizeToStream ( OutStream &str ) const;
207
208 virtual void pushValueFromCString (const Char8 *str );
209 virtual void pushIndexedValueFromCString(const Char8 *str ,
210 UInt32 index);
211
212 /*! \} */
213 /*---------------------------------------------------------------------*/
214 /*! \name Comparison */
215 /*! \{ */
216
217 virtual bool equal(Inherited::Ptr rhs) const;
218 virtual SizeT size (void ) const;
219
220 /*! \} */
221 /*---------------------------------------------------------------------*/
222 /*! \name Copy/Share/Clone */
223 /*! \{ */
224
225 virtual void copyValues (GetFieldHandlePtr source) const;
226 virtual void shareValues(GetFieldHandlePtr source) const;
227
228 virtual void cloneValues(
229 GetFieldHandlePtr pSrc,
230 const TypePtrVector &shareTypes = TypePtrVector(),
231 const TypePtrVector &ignoreTypes = TypePtrVector(),
232 const TypeIdVector &shareGroupIds = TypeIdVector (),
233 const TypeIdVector &ignoreGroupIds = TypeIdVector ()) const;
234
235 /*! \} */
236 /*---------------------------------------------------------------------*/
237 };
238
239
240 /*! \ingroup GrpBaseFieldContainerFields
241 \ingroup GrpLibOSGBase
242 */
243
244 template <class FieldT>
245 class GetFCPtrSFieldHandle :
246 public GetSFieldHandle<FieldContainerPtrSFieldBase>
247 {
248 /*========================= PROTECTED ===============================*/
249
250 protected:
251
252 typedef FieldT HandledField;
253 typedef GetSFieldHandle<FieldContainerPtrSFieldBase> Inherited;
254
255 /*========================== PUBLIC =================================*/
256
257 public:
258
259 /*---------------------------------------------------------------------*/
260 /*! \name Constructors */
261 /*! \{ */
262
263 GetFCPtrSFieldHandle(const GetFCPtrSFieldHandle &source);
264 GetFCPtrSFieldHandle(const FieldT *pField,
265 const FieldDescriptionBase *pDescription,
266 FieldContainer *pContainer );
267
268 /*! \} */
269 /*---------------------------------------------------------------------*/
270 /*! \name Field Type Query */
271 /*! \{ */
272
273 virtual const FieldType &getType(void) const;
274
275 /*! \} */
276 /*---------------------------------------------------------------------*/
277 /*! \name Stream/String IO */
278 /*! \{ */
279
280 virtual void pushValueToStream(OutStream &str) const;
281 virtual void pushSizeToStream (OutStream &str) const;
282
283 /*! \} */
284 /*---------------------------------------------------------------------*/
285 /*! \name Access */
286 /*! \{ */
287
288 virtual FieldContainer *get(void) const;
289
290 const FieldT *getField (void);
291
292 const FieldT *operator ->(void);
293 const FieldT &operator * (void);
294
295 /*! \} */
296 /*========================== PRIVATE ================================*/
297
298 private:
299
300 const HandledField *dcast_const(void) const;
301 };
302
303 /*! \ingroup GrpBaseFieldContainerFields
304 \ingroup GrpLibOSGBase
305 */
306
307 template <class FieldT>
308 class EditFCPtrSFieldHandle :
309 public EditSFieldHandle<FieldContainerPtrSFieldBase>
310 {
311 /*========================= PROTECTED ===============================*/
312
313 protected:
314
315 typedef FieldT HandledField;
316 typedef EditSFieldHandle<FieldContainerPtrSFieldBase> Inherited;
317 typedef EditFCPtrSFieldHandle Self;
318
319 typedef typename FieldT::value_type StoredPtrType;
320
321 typedef typename boost::remove_pointer<StoredPtrType>::type StoredType;
322
323 typedef RefCountPtr<StoredType,
324 UnrecordedRefCountPolicy> StoredUnrecPtr;
325
326 typedef boost::function<void (typename FieldT::const_value)> SetMethod;
327
328 SetMethod _fSetMethod;
329
330 /*========================== PUBLIC =================================*/
331
332 public:
333
334 /*---------------------------------------------------------------------*/
335 /*! \name Constructors */
336 /*! \{ */
337
338 EditFCPtrSFieldHandle(const EditFCPtrSFieldHandle &source );
339 EditFCPtrSFieldHandle( FieldT *pField,
340 const FieldDescriptionBase *pDescription,
341 FieldContainer *pContainer );
342
343 /*! \} */
344 /*---------------------------------------------------------------------*/
345 /*! \name Field Type Query */
346 /*! \{ */
347
348 virtual const FieldType &getType (void) const;
349
350 virtual bool supportsSet(void) const;
351
352 /*! \} */
353 /*---------------------------------------------------------------------*/
354 /*! \name Access */
355 /*! \{ */
356
357 virtual FieldContainer *get(void ) const;
358
359 virtual bool set(FieldContainer *newFC) const;
360
361 /*! \} */
362 /*---------------------------------------------------------------------*/
363 /*! \name Stream/String IO */
364 /*! \{ */
365
366 virtual void pushValueToStream ( OutStream &str) const;
367 virtual void pushSizeToStream ( OutStream &str) const;
368
369 virtual void pushValueFromCString(const Char8 *str);
370
371 /*! \} */
372 /*---------------------------------------------------------------------*/
373 /*! \name Callback Setup */
374 /*! \{ */
375
376 void setSetMethod(SetMethod fMethod);
377
378 /*! \} */
379 /*---------------------------------------------------------------------*/
380 /*! \name Copy/Share/Clone */
381 /*! \{ */
382
383 virtual void copyValues (GetFieldHandlePtr source) const;
384 virtual void shareValues(GetFieldHandlePtr source) const;
385
386 virtual void cloneValues(
387 GetFieldHandlePtr pSrc,
388 const TypePtrVector &shareTypes = TypePtrVector(),
389 const TypePtrVector &ignoreTypes = TypePtrVector(),
390 const TypeIdVector &shareGroupIds = TypeIdVector (),
391 const TypeIdVector &ignoreGroupIds = TypeIdVector ()) const;
392
393 /*! \} */
394 /*========================== PRIVATE ================================*/
395
396 private:
397 HandledField *dcast (void) const;
398 const HandledField *dcast_const(void) const;
399 };
400
401 OSG_END_NAMESPACE
402
403 #include "OSGFieldContainerSFieldHandle.inl"
404
405 #endif /* _OSGFIELDCONTAINERSFIELDHANDLE_H_ */