libstdc++-v3/libsupc++/new

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