libstdc++-v3/libsupc++/new

   1 // The -*- C++ -*- dynamic memory management header.
   2
   3 // Copyright (C) 1994, 1996, 1997, 1998, 2000, 2001, 2002
   4 // Free Software Foundation
   5
   6 // This file is part of GNU CC.
   7 //
   8 // GNU CC is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2, or (at your option)
  11 // any later version.
  12 //
  13 // GNU CC is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with GNU CC; see the file COPYING.  If not, write to
  20 // the Free Software Foundation, 59 Temple Place - Suite 330,
  21 // Boston, MA 02111-1307, USA.
  22
  23 // As a special exception, you may use this file as part of a free software
  24 // library without restriction.  Specifically, if other files instantiate
  25 // templates or use macros or inline functions from this file, or you compile
  26 // this file and link it with other files to produce an executable, this
  27 // file does not by itself cause the resulting executable to be covered by
  28 // the GNU General Public License.  This exception does not however
  29 // invalidate any other reasons why the executable file might be covered by
  30 // the GNU General Public License.
  31
  32 /** @file new
  33  *  This header defines several functions to manage dynamic memory and
  34  *  handling memory allocation errors; see
  35  *  http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#4 for more.
  36  */
  37
  38 #ifndef __NEW__
  39 #define __NEW__
  40
  41 #include <cstddef>
  42 #include <exception>
  43
  44 extern "C++" {
  45
  46 namespace std
  47 {
  48   /** @c bad_alloc (or classes derived from it) is used to report allocation
  49    *  errors from the throwing forms of @c new.  */
  50   class bad_alloc : public exception
  51   {
  52   public:
  53     bad_alloc() throw() { }
  54     // This declaration is not useless:
  55     // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
  56     virtual ~bad_alloc() throw();
  57   };
  58
  59   struct nothrow_t { };
  60   extern const nothrow_t nothrow;
  61   /** If you write your own error handler to be called by @c new, it must
  62    *  be of this type.  */
  63   typedef void (*new_handler)();
  64   /// Takes a replacement handler as the argument, returns the previous handler.
  65   new_handler set_new_handler(new_handler);
  66 } // namespace std
  67
  68 //@{
  69 /** These are replaceable signatures:
  70  *  - normal single new and delete (no arguments, throw @c bad_alloc on error)
  71  *  - normal array new and delete (same)
  72  *  - @c nothrow single new and delete (take a @c nothrow argument, return
  73  *    @c NULL on error)
  74  *  - @c nothrow array new and delete (same)
  75  *
  76  *  Placement new and delete signatures (take a memory address argument,
  77  *  does nothing) may not be replaced by a user's program.
  78 */
  79 void *operator new(std::size_t) throw (std::bad_alloc);
  80 void *operator new[](std::size_t) throw (std::bad_alloc);
  81 void operator delete(void *) throw();
  82 void operator delete[](void *) throw();
  83 void *operator new(std::size_t, const std::nothrow_t&) throw();
  84 void *operator new[](std::size_t, const std::nothrow_t&) throw();
  85 void operator delete(void *, const std::nothrow_t&) throw();
  86 void operator delete[](void *, const std::nothrow_t&) throw();
  87
  88 // Default placement versions of operator new.
  89 inline void *operator new(std::size_t, void *place) throw() { return place; }
  90 inline void *operator new[](std::size_t, void *place) throw() { return place; }
  91 //@}
  92 } // extern "C++"
  93
  94 #endif