libstdc++
new
Go to the documentation of this file.
1 // The -*- C++ -*- dynamic memory management header.
2 
3 // Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 // 2003, 2004, 2005, 2006, 2007, 2009
5 // Free Software Foundation
6 
7 // This file is part of GCC.
8 //
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 3, or (at your option)
12 // any later version.
13 //
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.
18 //
19 // Under Section 7 of GPL version 3, you are granted additional
20 // permissions described in the GCC Runtime Library Exception, version
21 // 3.1, as published by the Free Software Foundation.
22 
23 // You should have received a copy of the GNU General Public License and
24 // a copy of the GCC Runtime Library Exception along with this program;
25 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
26 // <http://www.gnu.org/licenses/>.
27 
28 /** @file new
29  * This is a Standard C++ Library header.
30  *
31  * The header @c new defines several functions to manage dynamic memory and
32  * handling memory allocation errors; see
33  * http://gcc.gnu.org/onlinedocs/libstdc++/18_support/howto.html#4 for more.
34  */
35 
36 #ifndef _NEW
37 #define _NEW
38 
39 #include <cstddef>
40 #include <exception>
41 
42 #pragma GCC visibility push(default)
43 
44 extern "C++" {
45 
46 namespace std
47 {
48  /**
49  * @brief Exception possibly thrown by @c new.
50  * @ingroup exceptions
51  *
52  * @c bad_alloc (or classes derived from it) is used to report allocation
53  * errors from the throwing forms of @c new. */
54  class bad_alloc : public exception
55  {
56  public:
57  bad_alloc() throw() { }
58 
59  // This declaration is not useless:
60  // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
61  virtual ~bad_alloc() throw();
62 
63  // See comment in eh_exception.cc.
64  virtual const char* what() const throw();
65  };
66 
67  struct nothrow_t { };
68 
69  extern const nothrow_t nothrow;
70 
71  /** If you write your own error handler to be called by @c new, it must
72  * be of this type. */
73  typedef void (*new_handler)();
74 
75  /// Takes a replacement handler as the argument, returns the
76  /// previous handler.
78 } // namespace std
79 
80 //@{
81 /** These are replaceable signatures:
82  * - normal single new and delete (no arguments, throw @c bad_alloc on error)
83  * - normal array new and delete (same)
84  * - @c nothrow single new and delete (take a @c nothrow argument, return
85  * @c NULL on error)
86  * - @c nothrow array new and delete (same)
87  *
88  * Placement new and delete signatures (take a memory address argument,
89  * does nothing) may not be replaced by a user's program.
90 */
91 void* operator new(std::size_t) throw (std::bad_alloc);
92 void* operator new[](std::size_t) throw (std::bad_alloc);
93 void operator delete(void*) throw();
94 void operator delete[](void*) throw();
95 void* operator new(std::size_t, const std::nothrow_t&) throw();
96 void* operator new[](std::size_t, const std::nothrow_t&) throw();
97 void operator delete(void*, const std::nothrow_t&) throw();
98 void operator delete[](void*, const std::nothrow_t&) throw();
99 
100 // Default placement versions of operator new.
101 inline void* operator new(std::size_t, void* __p) throw() { return __p; }
102 inline void* operator new[](std::size_t, void* __p) throw() { return __p; }
103 
104 // Default placement versions of operator delete.
105 inline void operator delete (void*, void*) throw() { }
106 inline void operator delete[](void*, void*) throw() { }
107 //@}
108 } // extern "C++"
109 
110 #pragma GCC visibility pop
111 
112 #endif
new_handler set_new_handler(new_handler)
Takes a replacement handler as the argument, returns the previous handler.
virtual const char * what() const
Exception possibly thrown by new.bad_alloc (or classes derived from it) is used to report allocation ...
Definition: new:54
void(* new_handler)()
Definition: new:73
Base class for all library exceptions.
Definition: exception:59