?  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 / PointerFields / OSGPointerMField.h
blob85682375a6521087d54237f4a27ede993b20ff03
1 /*---------------------------------------------------------------------------*\
2 * OpenSG *
3 * *
4 * *
5 * Copyright (C) 2008 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 _OSGPOINTERMFIELD_H_
40 #define _OSGPOINTERMFIELD_H_
41
42 #ifdef __sgi
43 #pragma once
44 #endif
45
46 #include "OSGPointerMFieldCommon.h"
47 #include "OSGPointerAccessHandler.h"
48
49 OSG_BEGIN_NAMESPACE
50
51 // forward declarations
52 template <class PtrTypeT,
53 typename RefCountPolicy,
54 Int32 NamespaceI>
55 class PointerMField;
56
57 #ifndef OSG_CLEAN_FCFIELDS
58 template <class PtrTypeT,
59 typename RefCountPolicy,
60 Int32 NamespaceI>
61 class PointerMFieldReferenceProxy;
62 #endif
63
64 template <class PtrTypeT,
65 typename RefCountPolicy,
66 Int32 NamespaceI>
67 class PointerMFieldConstIterator;
68
69 /*---------------------------------------------------------------------------*/
70 /* PointerMFieldIterator<PtrTypeT> */
71 /*---------------------------------------------------------------------------*/
72
73 /*! \ingroup GrpBaseFieldContainerFields
74 \ingroup GrpLibOSGBase
75 \nohierarchy
76 */
77
78 template <class PtrTypeT, typename RefCountPolicy, Int32 NamespaceI>
79 class PointerMFieldIterator :
80 protected PointerMField<PtrTypeT,
81 RefCountPolicy,
82 NamespaceI >::PtrStoreItType
83 {
84 /*========================== PUBLIC =================================*/
85
86 public:
87
88 /*---------------------------------------------------------------------*/
89 /*! \name Public Types */
90 /*! \{ */
91
92 typedef PointerMFieldIterator Self;
93
94 typedef PointerMField<PtrTypeT,
95 RefCountPolicy,
96 NamespaceI > MFieldType;
97
98 typedef typename MFieldType::PtrStoreItType Inherited;
99
100 typedef typename MFieldType::AccessHandler AccessHandler;
101
102 typedef PtrTypeT const const_value;
103
104 // store types
105 typedef typename MFieldType::StoredType StoredType;
106 typedef typename MFieldType::PtrStoreType PtrStoreType;
107 typedef typename MFieldType::PtrStoreItType PtrStoreItType;
108
109 typedef typename MFieldType::const_iterator const_iterator;
110
111 // std library typedefs
112
113 typedef typename Inherited::iterator_category iterator_category;
114 typedef typename Inherited::difference_type difference_type;
115 typedef PtrTypeT value_type;
116 typedef PtrTypeT * pointer;
117
118 #ifndef OSG_CLEAN_FCFIELDS
119 typedef PointerMFieldReferenceProxy<
120 PtrTypeT,
121 RefCountPolicy,
122 NamespaceI > reference;
123 #else
124 typedef typename Inherited::reference reference;
125 #endif
126
127 #if defined(WIN32) && _SECURE_SCL == 1 && _MSC_VER < 1600
128 typedef typename Inherited::_Checked_iterator_base_type
129 _Checked_iterator_base_type;
130 #endif
131
132 /*! \} */
133 /*---------------------------------------------------------------------*/
134 /*! \name Constructors */
135 /*! \{ */
136
137 PointerMFieldIterator( void );
138 PointerMFieldIterator(const Self &source );
139
140 PointerMFieldIterator(const PtrStoreItType &storeIter,
141 MFieldType *pField );
142
143 /*! \} */
144 /*---------------------------------------------------------------------*/
145 /*! \name Destructor */
146 /*! \{ */
147
148 ~PointerMFieldIterator(void);
149
150 /*! \} */
151 /*---------------------------------------------------------------------*/
152 /*! \name Operators */
153 /*! \{ */
154
155 #ifndef OSG_CLEAN_FCFIELDS
156 reference operator *( void ) const;
157 reference operator [](const difference_type offset) const;
158 #else
159 const_value operator *( void ) const;
160 const_value operator [](const difference_type offset) const;
161 #endif
162
163 /*! \} */
164 /*---------------------------------------------------------------------*/
165 /*! \name Operators */
166 /*! \{ */
167
168 Self &operator ++( void );
169 Self operator ++( int );
170
171 Self &operator --( void );
172 Self operator --( int );
173
174 Self &operator +=(const difference_type offset);
175 Self operator + (const difference_type offset) const;
176
177 Self &operator -=(const difference_type offset);
178 Self operator - (const difference_type offset) const;
179
180
181 bool operator == (const Self &rhs ) const;
182 bool operator != (const Self &rhs ) const;
183
184 bool operator == (const const_iterator &rhs ) const;
185 bool operator != (const const_iterator &rhs ) const;
186
187 /*! \} */
188 /*---------------------------------------------------------------------*/
189 /*! \name Operators */
190 /*! \{ */
191
192 const Self &operator =(const Self &other);
193
194 /*! \} */
195 /*---------------------------------------------------------------------*/
196 /*! \name Base */
197 /*! \{ */
198
199 const PtrStoreItType &base(void) const;
200
201 /*! \} */
202 /*========================= PROTECTED ===============================*/
203
204 protected:
205
206 /*========================== PRIVATE ================================*/
207
208 private:
209
210 MFieldType *_pField;
211
212 template <class AccessHandlerT, Int32 NI>
213 friend class PointerMFieldCommon;
214
215 template <class PT, typename RC, Int32 NI>
216 friend class PointerMFieldConstIterator;
217
218 template <class PT, typename RC, Int32 NI>
219 friend class PointerMField;
220
221 };
222
223 template <class PtrTypeT, class RefCountPolicyT, Int32 NamespaceI>
224 typename PointerMFieldIterator<PtrTypeT,
225 RefCountPolicyT,
226 NamespaceI >::difference_type
227 operator-(PointerMFieldIterator<PtrTypeT,
228 RefCountPolicyT,
229 NamespaceI > const &lhs,
230
231 PointerMFieldIterator<PtrTypeT,
232 RefCountPolicyT,
233 NamespaceI > const &rhs );
234
235 template <class PtrTypeT, class RefCountPolicyT, Int32 NamespaceI>
236 PointerMFieldIterator<PtrTypeT,
237 RefCountPolicyT,
238 NamespaceI >
239
240 operator+(
241 typename PointerMFieldIterator<
242 PtrTypeT,
243 RefCountPolicyT,
244 NamespaceI >::differece_type const offset,
245
246 PointerMFieldIterator<
247 PtrTypeT,
248 RefCountPolicyT,
249 NamespaceI > const &rhs );
250
251
252 /*---------------------------------------------------------------------------*/
253 /* PointerMFieldConstIterator<PtrTypeT> */
254 /*---------------------------------------------------------------------------*/
255
256 /*! \ingroup GrpBaseFieldContainerFields
257 \ingroup GrpLibOSGBase
258 \nohierarchy
259 */
260
261 template <class PtrTypeT, typename RefCountPolicy, Int32 NamespaceI>
262 class PointerMFieldConstIterator :
263 protected PointerMField<PtrTypeT,
264 RefCountPolicy,
265 NamespaceI >::PtrStoreConstItType
266 {
267 /*========================== PUBLIC =================================*/
268
269 public:
270
271 /*---------------------------------------------------------------------*/
272 /*! \name Public Types */
273 /*! \{ */
274
275 typedef PointerMFieldConstIterator Self;
276
277 typedef PointerMField<PtrTypeT,
278 RefCountPolicy,
279 NamespaceI > MFieldType;
280
281 typedef typename MFieldType::PtrStoreConstItType Inherited;
282
283 typedef typename MFieldType::AccessHandler AccessHandler;
284
285 typedef PtrTypeT const const_value;
286
287 // store types
288 typedef typename MFieldType::StoredType StoredType;
289 typedef typename MFieldType::PtrStoreType PtrStoreType;
290 typedef typename MFieldType::PtrStoreConstItType PtrStoreConstItType;
291
292 typedef typename MFieldType::iterator iterator;
293
294 // std library types
295 typedef typename Inherited::iterator_category iterator_category;
296 typedef typename Inherited::difference_type difference_type;
297 typedef typename Inherited::value_type value_type;
298 typedef typename Inherited::pointer pointer;
299 typedef typename Inherited::reference reference;
300
301 /*! \} */
302 /*---------------------------------------------------------------------*/
303 /*! \name Constructors */
304 /*! \{ */
305
306 PointerMFieldConstIterator( void );
307 PointerMFieldConstIterator(const Self &source );
308 PointerMFieldConstIterator(const iterator &fieldIter);
309 explicit PointerMFieldConstIterator(const PtrStoreConstItType &storeIter);
310
311 /*! \} */
312 /*---------------------------------------------------------------------*/
313 /*! \name Destructor */
314 /*! \{ */
315
316 ~PointerMFieldConstIterator(void);
317
318 /*! \} */
319 /*---------------------------------------------------------------------*/
320 /*! \name Operators */
321 /*! \{ */
322
323 const_value operator * ( void ) const;
324 const_value operator [](const difference_type offset) const;
325
326 /*! \} */
327 /*---------------------------------------------------------------------*/
328 /*! \name Operators */
329 /*! \{ */
330
331 Self &operator ++( void );
332 Self operator ++( int );
333
334 Self &operator --( void );
335 Self operator --( int );
336
337 Self &operator +=(const difference_type offset);
338 Self operator + (const difference_type offset) const;
339
340 Self &operator -=(const difference_type offset);
341 Self operator - (const difference_type offset) const;
342
343
344 bool operator == (const Self &rhs ) const;
345 bool operator != (const Self &rhs ) const;
346
347 bool operator == (const iterator &rhs ) const;
348 bool operator != (const iterator &rhs ) const;
349
350 /*! \} */
351 /*---------------------------------------------------------------------*/
352 /*! \name Base */
353 /*! \{ */
354
355 const PtrStoreConstItType &base(void) const;
356
357 /*! \} */
358 /*========================= PROTECTED ===============================*/
359
360 protected:
361
362 /*========================== PRIVATE ================================*/
363
364 private:
365
366 template <class AccessHandlerT, Int32 NI>
367 friend class PointerMFieldCommon;
368
369 template <class PT, typename RC, Int32 NI>
370 friend class PointerMFieldIterator;
371
372 template <class PT, typename RC, Int32 NI>
373 friend class PointerMField;
374 };
375
376 template <class PtrTypeT, class RefCountPolicyT, Int32 iNamespace>
377 typename PointerMFieldConstIterator<PtrTypeT,
378 RefCountPolicyT,
379 iNamespace >::difference_type
380 operator-(PointerMFieldConstIterator<PtrTypeT,
381 RefCountPolicyT,
382 iNamespace > const &lhs,
383 PointerMFieldConstIterator<PtrTypeT,
384 RefCountPolicyT,
385 iNamespace > const &rhs );
386
387 template <class PtrTypeT, class RefCountPolicyT, Int32 iNamespace>
388 typename PointerMFieldConstIterator<PtrTypeT,
389 RefCountPolicyT,
390 iNamespace >::difference_type
391 operator-(PointerMFieldIterator <PtrTypeT,
392 RefCountPolicyT,
393 iNamespace > const &lhs,
394 PointerMFieldConstIterator<PtrTypeT,
395 RefCountPolicyT,
396 iNamespace > const &rhs );
397
398 template <class PtrTypeT, class RefCountPolicyT, Int32 iNamespace>
399 typename PointerMFieldConstIterator<PtrTypeT,
400 RefCountPolicyT,
401 iNamespace >::difference_type
402 operator-(PointerMFieldConstIterator<PtrTypeT,
403 RefCountPolicyT,
404 iNamespace > const &lhs,
405 PointerMFieldIterator <PtrTypeT,
406 RefCountPolicyT,
407 iNamespace > const &rhs );
408
409 template <class PtrTypeT, class RefCountPolicyT, Int32 iNamespace>
410 PointerMFieldConstIterator<PtrTypeT, RefCountPolicyT, iNamespace>
411 operator+(
412 typename PointerMFieldConstIterator<
413 PtrTypeT,
414 RefCountPolicyT,
415 iNamespace >::difference_type const offset,
416
417 PointerMFieldConstIterator<
418 PtrTypeT,
419 RefCountPolicyT,
420 iNamespace > const &rhs );
421
422
423 #ifndef OSG_CLEAN_FCFIELDS
424 /*-------------------------------------------------------------------------*/
425 /* WeakMFieldReferenceProxy<PtrTypeT> */
426 /*-------------------------------------------------------------------------*/
427
428 /*! \ingroup GrpBaseFieldContainerFields
429 \ingroup GrpLibOSGBase
430 \nohierarchy
431 */
432
433 template <class PtrTypeT, typename RefCountPolicy, Int32 NamespaceI>
434 class PointerMFieldReferenceProxy
435 {
436 /*========================== PUBLIC =================================*/
437
438 public:
439
440 /*---------------------------------------------------------------------*/
441 /*! \name Public Types */
442 /*! \{ */
443
444 typedef PointerMFieldReferenceProxy Self;
445
446 typedef PointerMField<PtrTypeT,
447 RefCountPolicy,
448 NamespaceI > MFieldType;
449
450 typedef typename MFieldType::AccessHandler AccessHandler;
451
452 // store types
453 typedef typename MFieldType::StoredType StoredType;
454 typedef typename MFieldType::PtrStoreType PtrStoreType;
455 typedef typename MFieldType::PtrStoreItType PtrStoreItType;
456 typedef typename MFieldType::PtrStoreConstItType PtrStoreConstItType;
457
458 // std library types
459 typedef PtrTypeT value_type;
460
461 /*! \} */
462 /*---------------------------------------------------------------------*/
463 /*! \name Constructors */
464 /*! \{ */
465
466 PointerMFieldReferenceProxy(const PtrStoreItType &storeIter,
467 MFieldType *pField );
468
469 PointerMFieldReferenceProxy(const Self &source );
470
471 /*! \} */
472 /*---------------------------------------------------------------------*/
473 /*! \name Destructor */
474 /*! \{ */
475
476 ~PointerMFieldReferenceProxy(void);
477
478 /*! \} */
479 /*---------------------------------------------------------------------*/
480 /*! \name Operators */
481 /*! \{ */
482
483 operator value_type(void) const;
484 value_type operator-> (void) const;
485
486 void operator=(value_type newValue);
487
488 /*! \} */
489 /*========================== PRIVATE ================================*/
490
491 private:
492
493 PtrStoreItType _storeIter;
494 MFieldType *_pField;
495 };
496 #endif
497
498 /*---------------------------------------------------------------------------*/
499 /* WeakPointerMField<FieldConfigT> */
500 /*---------------------------------------------------------------------------*/
501
502 /*! \ingroup GrpBaseFieldContainerFields
503 \ingroup GrpLibOSGBase
504 */
505
506 template <class PtrTypeT,
507 typename RefCountPolicy,
508 Int32 NamespaceI = 0>
509 class PointerMField :
510 public PointerMFieldCommon<PointerAccessHandler<RefCountPolicy>,
511 NamespaceI >
512 {
513 /*========================== PUBLIC =================================*/
514
515 public:
516
517 /*---------------------------------------------------------------------*/
518 /*! \name Public Types */
519 /*! \{ */
520
521 typedef PointerMFieldCommon <
522 PointerAccessHandler<RefCountPolicy>,
523 NamespaceI > Inherited;
524
525 typedef PointerMField Self;
526
527 typedef PtrTypeT const const_value;
528 typedef PtrTypeT value_type;
529 typedef value_type StoredType;
530
531 typedef typename Inherited::size_type size_type;
532 typedef typename Inherited::difference_type difference_type;
533
534 typedef PointerMFieldIterator <PtrTypeT,
535 RefCountPolicy,
536 NamespaceI > iterator;
537
538 typedef PointerMFieldConstIterator <PtrTypeT,
539 RefCountPolicy,
540 NamespaceI > const_iterator;
541
542 typedef std::reverse_iterator <iterator > reverse_iterator;
543 typedef std::reverse_iterator <const_iterator> const_reverse_iterator;
544
545
546 typedef FieldTraits <value_type,
547 NamespaceI > MFieldTraits;
548 typedef FieldDescription <
549 MFieldTraits,
550 FieldType::MultiField,
551 RefCountPolicy,
552 FieldType::PtrField > Description;
553
554 #ifndef OSG_CLEAN_FCFIELDS
555 typedef PointerMFieldReferenceProxy<PtrTypeT,
556 RefCountPolicy,
557 NamespaceI > reference;
558 #endif
559
560 // handles
561 typedef EditFCPtrMFieldHandle <Self > EditHandle;
562 typedef boost::shared_ptr <EditHandle > EditHandlePtr;
563
564 typedef GetFCPtrMFieldHandle <Self > GetHandle;
565 typedef boost::shared_ptr <GetHandle > GetHandlePtr;
566
567 // handles for dynamic fields -- XXX TODO
568 // typedef EditPointerMFieldHandle<Self> DynamicEditHandle;
569 // typedef typename EditPointerMFieldHandle<Self>::Ptr DynamicEditHandlePtr;
570
571 // typedef GetPointerMFieldHandle <Self> DynamicGetHandle;
572 // typedef typename GetPointerMFieldHandle <Self>::Ptr DynamicGetHandlePtr;
573
574 /*! \} */
575 /*---------------------------------------------------------------------*/
576 /*! \name Constants */
577 /*! \{ */
578
579 static FieldType::Cardinality const fieldCard = FieldType::MultiField;
580 static FieldType::Class const Class = FieldType::PtrField;
581
582 /*! \} */
583 /*---------------------------------------------------------------------*/
584 /*! \name Class Type */
585 /*! \{ */
586
587 static FieldType const &getClassType(void);
588
589 /*! \} */
590 /*---------------------------------------------------------------------*/
591 /*! \name Constructors */
592 /*! \{ */
593
594 PointerMField( void );
595 PointerMField(const Self &other );
596 explicit PointerMField(const UInt32 initSize);
597
598 /*! \} */
599 /*---------------------------------------------------------------------*/
600 /*! \name Destructor */
601 /*! \{ */
602
603 ~PointerMField(void);
604
605 /*! \} */
606 /*---------------------------------------------------------------------*/
607 /*! \name String/Stream IO (Input) */
608 /*! \{ */
609
610 /*! \} */
611 /*---------------------------------------------------------------------*/
612 /*! \name Set */
613 /*! \{ */
614
615 #ifdef OSG_FIELD_TOCHECK
616 void setValues(const StorageType &value);
617 void setValues(const StorageTypeParent &value);
618 void setValues(const Self &obj );
619 #endif
620
621 /*! \} */
622 /*---------------------------------------------------------------------*/
623 /*! \name Binary Interface */
624 /*! \{ */
625
626 void copyFromBin(BinaryDataHandler &pMem);
627
628 /*! \} */
629 /*---------------------------------------------------------------------*/
630 /*! \name STL Interface */
631 /*! \{ */
632
633 iterator begin_nc(void );
634 iterator end_nc (void );
635
636 #ifndef OSG_CLEAN_FCFIELDS
637 reference front_nc(void );
638 reference back_nc (void );
639 #endif
640
641 iterator find_nc (const_value value);
642
643 /*! \} */
644 /*---------------------------------------------------------------------*/
645 /*! \name Std Library Interface */
646 /*! \{ */
647
648 #ifndef OSG_CLEAN_FCFIELDS
649 iterator begin (void );
650 iterator end (void );
651
652 reverse_iterator rbegin (void );
653 reverse_iterator rend (void );
654 #endif
655
656 const_iterator begin (void ) const;
657 const_iterator end (void ) const;
658
659 const_reverse_iterator rbegin (void ) const;
660 const_reverse_iterator rend (void ) const;
661
662 #ifndef OSG_CLEAN_FCFIELDS
663 reference front (void );
664 reference back (void );
665 #endif
666
667 const_value front (void ) const;
668 const_value back (void ) const;
669
670 iterator insert (iterator pos,
671 const_value value );
672
673 void insert (iterator pos,
674 size_type n,
675 const_value value );
676
677 template <class InputIteratorT>
678 void insert (iterator pos,
679 InputIteratorT first,
680 InputIteratorT last );
681
682 void erase (size_type index );
683 #ifndef OSG_CLEAN_FCFIELDS
684 iterator erase (iterator pos );
685 iterator erase (iterator first,
686 iterator last );
687 #endif
688
689 #ifndef OSG_CLEAN_FCFIELDS
690 iterator find (const_value value );
691 #endif
692 const_iterator find (const_value value ) const;
693
694 void push_back(const_value value );
695
696 void resize (size_t newSize,
697 const_value value = NULL );
698
699 void reserve (size_type newSize );
700
701 void clear (void );
702
703 #ifdef OSG_1_COMPAT
704 void addValue (const_value value );
705 #endif
706
707 void assign (size_type newSize,
708 const_value value = NULL );
709
710 template <class InputIteratorT>
711 void assign (InputIteratorT first,
712 InputIteratorT last );
713
714 void replace (UInt32 uiIdx,
715 const_value value );
716
717 void replace (iterator pos,
718 const_value value );
719
720 /*! \} */
721 /*---------------------------------------------------------------------*/
722 /*! \name Index Operator */
723 /*! \{ */
724
725 #ifndef OSG_CLEAN_FCFIELDS
726 reference operator [](size_type const index);
727 #endif
728 const_value operator [](size_type const index) const;
729
730 /*! \} */
731 /*---------------------------------------------------------------------*/
732 /*! \name Compare */
733 /*! \{ */
734
735 bool operator ==(const Self &source) const;
736
737 /*! \} */
738 /*---------------------------------------------------------------------*/
739 /*! \name Assignment */
740 /*! \{ */
741
742 Self &operator =(Self const &source);
743
744 /*! \} */
745 /*---------------------------------------------------------------------*/
746 /*! \name MT Sync */
747 /*! \{ */
748
749 #ifdef OSG_MT_CPTR_ASPECT
750 void syncWith(Self &source,
751 ConstFieldMaskArg syncMode,
752 UInt32 uiSyncInfo,
753 AspectOffsetStore &oOffsets );
754 #endif
755
756 /*! \} */
757 /*========================= PROTECTED ===============================*/
758
759 protected:
760
761 /*---------------------------------------------------------------------*/
762 /*! \name Members */
763 /*! \{ */
764
765 static FieldType _fieldType;
766
767 /*! \} */
768 /*---------------------------------------------------------------------*/
769 /*! \name FieldDesc creation */
770 /*! \{ */
771
772 static FieldDescriptionBase *
773 createFieldDescription (const Char8 *szFieldname,
774 UInt32 uiFieldFlags,
775 FieldEditMethod fEditMethod,
776 FieldGetMethod fGetMethod );
777
778 static FieldDescriptionBase *
779 createIdxFieldDescription(const Char8 *szFieldname,
780 UInt32 uiFieldFlags,
781 FieldIndexEditMethod fEditMethod,
782 FieldIndexGetMethod fGetMethod );
783
784 /*! \} */
785 /*========================== PRIVATE ================================*/
786
787 private:
788 };
789
790 OSG_END_NAMESPACE
791
792 #include "OSGPointerMField.inl"
793
794 #endif // _OSGPOINTERMFIELD_H_