libstdc++-v3/include/bits/allocator.h

   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
  53 #include <ext/new_allocator.h>
  54 #define __glibcxx_default_allocator  __gnu_cxx::new_allocator
  55
  56 //#include <ext/mt_allocator.h>
  57 //#define __glibcxx_default_allocator  __gnu_cxx::__mt_alloc
  58
  59 namespace std
  60 {
  61   template<typename _Tp>
  62     class allocator;
  63
  64   template<>
  65     class allocator<void>
  66     {
  67     public:
  68       typedef size_t      size_type;
  69       typedef ptrdiff_t   difference_type;
  70       typedef void*       pointer;
  71       typedef const void* const_pointer;
  72       typedef void        value_type;
  73
  74       template<typename _Tp1>
  75         struct rebind
  76         { typedef allocator<_Tp1> other; };
  77     };
  78
  79   /**
  80    *  @brief  The "standard" allocator, as per [20.4].
  81    *
  82    *  (See @link Allocators allocators info @endlink for more.)
  83    */
  84   template<typename _Tp>
  85     class allocator: public __glibcxx_default_allocator<_Tp>
  86     {
  87    public:
  88       typedef size_t     size_type;
  89       typedef ptrdiff_t  difference_type;
  90       typedef _Tp*       pointer;
  91       typedef const _Tp* const_pointer;
  92       typedef _Tp&       reference;
  93       typedef const _Tp& const_reference;
  94       typedef _Tp        value_type;
  95
  96       template<typename _Tp1>
  97         struct rebind
  98         { typedef allocator<_Tp1> other; };
  99
 100       allocator() throw() { }
 101
 102       allocator(const allocator& a) throw()
 103       : __glibcxx_default_allocator<_Tp>(a) { }
 104
 105       template<typename _Tp1>
 106         allocator(const allocator<_Tp1>&) throw() { }
 107
 108       ~allocator() throw() { }
 109
 110       // Inherit everything else.
 111     };
 112
 113   template<typename _T1, typename _T2>
 114     inline bool
 115     operator==(const allocator<_T1>&, const allocator<_T2>&)
 116     { return true; }
 117
 118   template<typename _T1, typename _T2>
 119     inline bool
 120     operator!=(const allocator<_T1>&, const allocator<_T2>&)
 121     { return false; }
 122
 123   // Inhibit implicit instantiations for required instantiations,
 124   // which are defined via explicit instantiations elsewhere.
 125   // NB: This syntax is a GNU extension.
 126 #if _GLIBCXX_EXTERN_TEMPLATE
 127   extern template class allocator<char>;
 128   extern template class allocator<wchar_t>;
 129 #endif
 130
 131   // Undefine.
 132 #undef __glibcxx_default_allocator
 133 } // namespace std
 134
 135 #endif