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