doxygen: intern/memutil tagged
[blender.git] / intern / memutil / MEM_Allocator.h
1 /*
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file memutil/MEM_Allocator.h
25  *  \ingroup memutil
26  */
27
28
29 #ifndef MEM_ALLOCATOR_H
30 #define MEM_ALLOCATOR_H
31
32 #include "guardedalloc/MEM_guardedalloc.h"
33 #include "guardedalloc/MEM_sys_types.h"
34
35 template<typename _Tp>
36 struct MEM_Allocator
37 {
38         typedef size_t    size_type;
39         typedef ptrdiff_t difference_type;
40         typedef _Tp*       pointer;
41         typedef const _Tp* const_pointer;
42         typedef _Tp&       reference;
43         typedef const _Tp& const_reference;
44         typedef _Tp        value_type;
45
46         template<typename _Tp1>
47         struct rebind { 
48                 typedef MEM_Allocator<_Tp1> other; 
49         };
50
51         MEM_Allocator() throw() {}
52         MEM_Allocator(const MEM_Allocator&) throw() {}
53
54         template<typename _Tp1>
55         MEM_Allocator(const MEM_Allocator<_Tp1>) throw() { }
56
57         ~MEM_Allocator() throw() {}
58
59         pointer address(reference __x) const { return &__x; }
60
61         const_pointer address(const_reference __x) const { return &__x; }
62
63         // NB: __n is permitted to be 0.  The C++ standard says nothing
64         // about what the return value is when __n == 0.
65         _Tp* allocate(size_type __n, const void* = 0) {
66                 _Tp* __ret = 0;
67                 if (__n)
68                         __ret = static_cast<_Tp*>(
69                                 MEM_mallocN(__n * sizeof(_Tp),
70                                             "STL MEM_Allocator"));
71                 return __ret;
72         }
73
74         // __p is not permitted to be a null pointer.
75         void deallocate(pointer __p, size_type){ 
76                 MEM_freeN(__p);
77         }
78
79         size_type max_size() const throw() { 
80                 return size_t(-1) / sizeof(_Tp); 
81         }
82
83         void construct(pointer __p, const _Tp& __val) { 
84                 new(__p) _Tp(__val); 
85         }
86
87         void destroy(pointer __p) { 
88                 __p->~_Tp(); 
89         }
90 };
91
92 #endif // MEM_ALLOCATOR_H