new revision 169691 
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
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 2, 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// 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.
23
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.
32
33/** @file new
34 *  This is a Standard C++ Library header.
35 *
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.
39 */
40
41#ifndef _NEW
42#define _NEW
43
44#include <cstddef>
45#include <exception>
46
47#pragma GCC visibility push(default)
48
49extern "C++" {
50
51namespace std 
52{
53  /**
54   *  @brief  Exception possibly thrown by @c new.
55   *
56   *  @c bad_alloc (or classes derived from it) is used to report allocation
57   *  errors from the throwing forms of @c new.  */
58  class bad_alloc : public exception 
59  {
60  public:
61    bad_alloc() throw() { }
62    // This declaration is not useless:
63    // http://gcc.gnu.org/onlinedocs/gcc-3.0.2/gcc_6.html#SEC118
64    virtual ~bad_alloc() throw();
65    // See comment in eh_exception.cc.
66    virtual const char* what() const throw();
67  };
68
69  struct nothrow_t { };
70  extern const nothrow_t nothrow;
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  /// Takes a replacement handler as the argument, returns the previous handler.
75  new_handler set_new_handler(new_handler) throw();
76} // namespace std
77
78//@{
79/** These are replaceable signatures:
80 *  - normal single new and delete (no arguments, throw @c bad_alloc on error)
81 *  - normal array new and delete (same)
82 *  - @c nothrow single new and delete (take a @c nothrow argument, return
83 *    @c NULL on error)
84 *  - @c nothrow array new and delete (same)
85 *
86 *  Placement new and delete signatures (take a memory address argument,
87 *  does nothing) may not be replaced by a user's program.
88*/
89void* operator new(std::size_t) throw (std::bad_alloc);
90void* operator new[](std::size_t) throw (std::bad_alloc);
91void operator delete(void*) throw();
92void operator delete[](void*) throw();
93void* operator new(std::size_t, const std::nothrow_t&) throw();
94void* operator new[](std::size_t, const std::nothrow_t&) throw();
95void operator delete(void*, const std::nothrow_t&) throw();
96void operator delete[](void*, const std::nothrow_t&) throw();
97
98// Default placement versions of operator new.
99inline void* operator new(std::size_t, void* __p) throw() { return __p; }
100inline void* operator new[](std::size_t, void* __p) throw() { return __p; }
101
102// Default placement versions of operator delete.
103inline void  operator delete  (void*, void*) throw() { }
104inline void  operator delete[](void*, void*) throw() { }
105//@}
106} // extern "C++"
107
108#pragma GCC visibility pop
109
110#endif
111