1 // The -*- C++ -*- dynamic memory management header.
3 // Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 // 2003, 2004, 2005, 2006, 2007, 2009
5 // Free Software Foundation
7 // This file is part of GCC.
9 // GCC is free software; you can redistribute it and/or modify
10 // it under the terms of the GNU General Public License as published by
11 // the Free Software Foundation; either version 2, or (at your option)
14 // GCC is distributed in the hope that it will be useful,
15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 // GNU General Public License for more details.
19 // You should have received a copy of the GNU General Public License
20 // along with GCC; see the file COPYING. If not, write to
21 // the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 // Boston, MA 02110-1301, USA.
24 // As a special exception, you may use this file as part of a free software
25 // library without restriction. Specifically, if other files instantiate
26 // templates or use macros or inline functions from this file, or you compile
27 // this file and link it with other files to produce an executable, this
28 // file does not by itself cause the resulting executable to be covered by
29 // the GNU General Public License. This exception does not however
30 // invalidate any other reasons why the executable file might be covered by
31 // the GNU General Public License.
34 * This is a Standard C++ Library header.
36 * The header @c new defines several functions to manage dynamic memory and
37 * handling memory allocation errors; see
38 * http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#4 for more.
47 #pragma GCC visibility push(default)
54 * @brief Exception possibly thrown by @c new.
57 * @c bad_alloc (or classes derived from it) is used to report allocation
58 * errors from the throwing forms of @c new. */
59 class bad_alloc : public exception
62 bad_alloc() throw() { }
64 // This declaration is not useless:
65 // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
66 virtual ~bad_alloc() throw();
68 // See comment in eh_exception.cc.
69 virtual const char* what() const throw();
74 extern const nothrow_t nothrow;
76 /** If you write your own error handler to be called by @c new, it must
78 typedef void (*new_handler)();
80 /// Takes a replacement handler as the argument, returns the
82 new_handler set_new_handler(new_handler) throw();
86 /** These are replaceable signatures:
87 * - normal single new and delete (no arguments, throw @c bad_alloc on error)
88 * - normal array new and delete (same)
89 * - @c nothrow single new and delete (take a @c nothrow argument, return
91 * - @c nothrow array new and delete (same)
93 * Placement new and delete signatures (take a memory address argument,
94 * does nothing) may not be replaced by a user's program.
96 void* operator new(std::size_t) throw (std::bad_alloc);
97 void* operator new[](std::size_t) throw (std::bad_alloc);
98 void operator delete(void*) throw();
99 void operator delete[](void*) throw();
100 void* operator new(std::size_t, const std::nothrow_t&) throw();
101 void* operator new[](std::size_t, const std::nothrow_t&) throw();
102 void operator delete(void*, const std::nothrow_t&) throw();
103 void operator delete[](void*, const std::nothrow_t&) throw();
105 // Default placement versions of operator new.
106 inline void* operator new(std::size_t, void* __p) throw() { return __p; }
107 inline void* operator new[](std::size_t, void* __p) throw() { return __p; }
109 // Default placement versions of operator delete.
110 inline void operator delete (void*, void*) throw() { }
111 inline void operator delete[](void*, void*) throw() { }
115 #pragma GCC visibility pop