Welcome to mirror list, hosted at ThFree Co, Russian Federation.

PointerSequence.h « system « intern « freestyle « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 72c6aa458fdc0b4ae6bce3c8ab80fd3299543ed1 (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
//
//  Filename         : PointerSequence.h
//  Author(s)        : Alexander Beels
//  Purpose          : Class to define a cell grid surrounding
//                     the projected image of a scene
//  Date of creation : 22/11/2010
//
///////////////////////////////////////////////////////////////////////////////


//
//  Copyright (C) : Please refer to the COPYRIGHT file distributed 
//   with this source distribution. 
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 2
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
///////////////////////////////////////////////////////////////////////////////

//
// Simple RAII wrappers for std:: sequential containers
//
///////////////////////////////////////////////////////////////////////////////

//
// PointerSequence
//
// Produces a wrapped version of a sequence type (std::vector, std::deque, std::list)
// that will take ownership of pointers tht it stores.  Those pointers will be deleted
// in its destructor.
//
// Because the contained pointers are wholly owned by the sequence, you cannot make a
// copy of the sequence.  Making a copy would result in a double free.
//
// This is a no-frills class that provides no additional facilities.  The user is
// responsible for managing any pointers that are removed from the list, and for making 
// sure that any pointers contained in the class are not deleted elsewhere.  Because 
// this class does no reference counting, the user must also make sure that any pointer
// appears only once in the sequence.
//
// If more sophisticated facilities are needed, use tr1::shared_ptr or boost::shared_ptr.
// This class is only intended to allow one to eke by in projects where tr1 or boost are
// not available.
//
// Usage: The template takes two parameters, the standard container, and the class held
// in the container.  This is a limitation of C++ templates, where T::iterator is not a
// type when T is a template parameter.  If anyone knows a way around this
// limitation, then the second parameter can be eliminated.
//
// Example:
//   PointerSequence<vector<Widget*>, Widget*> v;
//   v.push_back(new Widget);
//   cout << v[0] << endl; // operator[] is provided by std::vector, not by PointerSequence
//   v.destroy(); // Deletes all pointers in sequence and sets them to NULL.
//
// The idiom for removing a pointer from a sequence is:
//   Widget* w = v[3];
//   v.erase(v.begin() + 3); // or v[3] = 0;
// The user is now responsible for disposing of w properly.
//
///////////////////////////////////////////////////////////////////////////////

#ifndef  POINTERSEQUENCE_H
# define POINTERSEQUENCE_H

#include <algorithm>

template <typename C, typename T>
class PointerSequence : public C {
	PointerSequence (PointerSequence& other);
	PointerSequence& operator= (PointerSequence& other);
	static void destroyer (T t) {
		delete t;
	}
public:
	PointerSequence () {};
	~PointerSequence () {
		destroy();
	}
	void destroy () {
		for_each (this->begin(), this->end(), destroyer);
	}
};

#endif // POINTERSEQUENCE_H