allocator.h revision 132720 
1// Allocators -*- C++ -*-
2
3// Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library.  This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 2, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14// GNU General Public License for more details.
15
16// You should have received a copy of the GNU General Public License along
17// with this library; see the file COPYING.  If not, write to the Free
18// Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
19// USA.
20
21// As a special exception, you may use this file as part of a free software
22// library without restriction.  Specifically, if other files instantiate
23// templates or use macros or inline functions from this file, or you compile
24// this file and link it with other files to produce an executable, this
25// file does not by itself cause the resulting executable to be covered by
26// the GNU General Public License.  This exception does not however
27// invalidate any other reasons why the executable file might be covered by
28// the GNU General Public License.
29
30/*
31 * Copyright (c) 1996-1997
32 * Silicon Graphics Computer Systems, Inc.
33 *
34 * Permission to use, copy, modify, distribute and sell this software
35 * and its documentation for any purpose is hereby granted without fee,
36 * provided that the above copyright notice appear in all copies and
37 * that both that copyright notice and this permission notice appear
38 * in supporting documentation.  Silicon Graphics makes no
39 * representations about the suitability of this software for any
40 * purpose.  It is provided "as is" without express or implied warranty.
41 */
42
43/** @file allocator.h
44 *  This is an internal header file, included by other library headers.
45 *  You should not attempt to use it directly.
46 */
47
48#ifndef _ALLOCATOR_H
49#define _ALLOCATOR_H 1
50
51// Define the base class to std::allocator.
52#include <bits/c++allocator.h>
53
54namespace std
55{
56  template<typename _Tp>
57    class allocator;
58
59  template<>
60    class allocator<void>
61    {
62    public:
63      typedef size_t      size_type;
64      typedef ptrdiff_t   difference_type;
65      typedef void*       pointer;
66      typedef const void* const_pointer;
67      typedef void        value_type;
68
69      template<typename _Tp1>
70        struct rebind
71        { typedef allocator<_Tp1> other; };
72    };
73
74  /**
75   *  @brief  The "standard" allocator, as per [20.4].
76   *
77   *  (See @link Allocators allocators info @endlink for more.)
78   */
79  template<typename _Tp>
80    class allocator: public ___glibcxx_base_allocator<_Tp>
81    {
82   public:
83      typedef size_t     size_type;
84      typedef ptrdiff_t  difference_type;
85      typedef _Tp*       pointer;
86      typedef const _Tp* const_pointer;
87      typedef _Tp&       reference;
88      typedef const _Tp& const_reference;
89      typedef _Tp        value_type;
90
91      template<typename _Tp1>
92        struct rebind
93        { typedef allocator<_Tp1> other; };
94
95      allocator() throw() { }
96
97      allocator(const allocator& a) throw()
98      : ___glibcxx_base_allocator<_Tp>(a) { }
99
100      template<typename _Tp1>
101        allocator(const allocator<_Tp1>&) throw() { }
102
103      ~allocator() throw() { }
104
105      // Inherit everything else.
106    };
107
108  template<typename _T1, typename _T2>
109    inline bool
110    operator==(const allocator<_T1>&, const allocator<_T2>&)
111    { return true; }
112
113  template<typename _T1, typename _T2>
114    inline bool
115    operator!=(const allocator<_T1>&, const allocator<_T2>&)
116    { return false; }
117
118  // Inhibit implicit instantiations for required instantiations,
119  // which are defined via explicit instantiations elsewhere.
120  // NB: This syntax is a GNU extension.
121#if _GLIBCXX_EXTERN_TEMPLATE
122  extern template class allocator<char>;
123  extern template class allocator<wchar_t>;
124#endif
125
126  // Undefine.
127#undef ___glibcxx_base_allocator
128} // namespace std
129
130#endif
131