1 <section xmlns="http://docbook.org/ns/docbook" version="5.0"
2 xml:id="appendix.porting.api" xreflabel="api">
3 <?dbhtml filename="api.html"?>
5 <info><title>API Evolution and Deprecation History</title>
7 <keyword>ISO C++</keyword>
9 <keyword>evolution</keyword>
10 <keyword>deprecation</keyword>
11 <keyword>history</keyword>
18 A list of user-visible changes, in chronological order
21 <section xml:id="api.rel_300"><info><title><constant>3.0</constant></title></info>
25 Extensions moved to <filename class="directory">include/ext</filename>.
29 Include files from the SGI/HP sources that pre-date the ISO standard
30 are added. These files are placed into
31 the <filename class="directory">include/backward</filename> directory and a deprecated warning
32 is added that notifies on inclusion (<literal>-Wno-deprecated</literal>
33 deactivates the warning.)
36 <para>Deprecated include <filename class="headerfile">backward/strstream</filename> added.</para>
38 <para>Removal of include <filename class="headerfile">builtinbuf.h</filename>, <filename class="headerfile">indstream.h</filename>, <filename class="headerfile">parsestream.h</filename>, <filename class="headerfile">PlotFile.h</filename>, <filename class="headerfile">SFile.h</filename>, <filename class="headerfile">stdiostream.h</filename>, and <filename class="headerfile">stream.h</filename>.
45 <section xml:id="api.rel_310"><info><title><constant>3.1</constant></title></info>
51 Extensions from SGI/HP moved from <code>namespace std</code>
52 to <code>namespace __gnu_cxx</code>. As part of this, the following
54 added: <filename class="headerfile">ext/algorithm</filename>, <filename class="headerfile">ext/functional</filename>, <filename class="headerfile">ext/iterator</filename>, <filename class="headerfile">ext/memory</filename>, and <filename class="headerfile">ext/numeric</filename>.
58 Extensions to <code>basic_filebuf</code> introduced: <code>__gnu_cxx::enc_filebuf</code>, and <code>__gnu_cxx::stdio_filebuf</code>.
62 Extensions to tree data structures added in <filename class="headerfile">ext/rb_tree</filename>.
66 Removal of <filename class="headerfile">ext/tree</filename>, moved to <filename class="headerfile">backward/tree.h</filename>.
71 <section xml:id="api.rel_320"><info><title><constant>3.2</constant></title></info>
75 <para>Symbol versioning introduced for shared library.</para>
77 <para>Removal of include <filename class="headerfile">backward/strstream.h</filename>.</para>
79 <para>Allocator changes. Change <code>__malloc_alloc</code> to <code>malloc_allocator</code> and <code>__new_alloc</code> to <code>new_allocator</code>. </para>
81 <para> For GCC releases from 2.95 through the 3.1 series, defining
82 <literal>__USE_MALLOC</literal> on the gcc command line would change the
83 default allocation strategy to instead use <code> malloc</code> and
84 <function>free</function>. (This same functionality is now spelled <literal>_GLIBCXX_FORCE_NEW</literal>, see
85 <link linkend="manual.intro.using.macros">this page</link>
90 <para>Error handling in iostreams cleaned up, made consistent. </para>
95 <section xml:id="api.rel_330"><info><title><constant>3.3</constant></title></info>
101 <section xml:id="api.rel_340"><info><title><constant>3.4</constant></title></info>
109 <para> Extensions for generic characters and <code>char_traits</code> added in <filename class="headerfile">ext/pod_char_traits.h</filename>.
113 Support for <code>wchar_t</code> specializations of <code>basic_filebuf</code> enhanced to support <code>UTF-8</code> and <code>Unicode</code>, depending on host. More hosts support basic <code>wchar_t</code> functionality.
117 Support for <code>char_traits</code> beyond builtin types.
121 Conformant <code>allocator</code> class and usage in containers. As
122 part of this, the following extensions are
123 added: <filename class="headerfile">ext/bitmap_allocator.h</filename>, <filename class="headerfile">ext/debug_allocator.h</filename>, <filename class="headerfile">ext/mt_allocator.h</filename>, <filename class="headerfile">ext/malloc_allocator.h</filename>,<filename class="headerfile">ext/new_allocator.h</filename>, <filename class="headerfile">ext/pool_allocator.h</filename>.
127 This is a change from all previous versions, and may require
128 source-level changes due to allocator-related changes to structures
129 names and template parameters, filenames, and file locations. Some,
130 like <code>__simple_alloc, __allocator, __alloc, </code> and <code>
131 _Alloc_traits</code> have been removed.
134 <para>Default behavior of <code>std::allocator</code> has changed.</para>
137 Previous versions prior to 3.4 cache allocations in a memory
138 pool, instead of passing through to call the global allocation
139 operators (i.e., <classname>__gnu_cxx::pool_allocator</classname>). More
140 recent versions default to the
141 simpler <classname>__gnu_cxx::new_allocator</classname>.
144 <para> Previously, all allocators were written to the SGI
145 style, and all STL containers expected this interface. This
146 interface had a traits class called <code>_Alloc_traits</code> that
147 attempted to provide more information for compile-time allocation
148 selection and optimization. This traits class had another allocator
149 wrapper, <code>__simple_alloc<T,A></code>, which was a
150 wrapper around another allocator, A, which itself is an allocator
151 for instances of T. But wait, there's more:
152 <code>__allocator<T,A></code> is another adapter. Many of
153 the provided allocator classes were SGI style: such classes can be
154 changed to a conforming interface with this wrapper:
155 <code>__allocator<T, __alloc></code> is thus the same as
156 <code>allocator<T></code>.
159 <para> The class <classname>allocator</classname> used the typedef
160 <type>__alloc</type> to select an underlying allocator that
161 satisfied memory allocation requests. The selection of this
162 underlying allocator was not user-configurable.
166 <title>Extension Allocators</title>
168 <tgroup cols="4" align="left" colsep="1" rowsep="1">
169 <colspec colname="c1"/>
170 <colspec colname="c2"/>
171 <colspec colname="c3"/>
172 <colspec colname="c4"/>
176 <entry>Allocator (3.4)</entry>
177 <entry>Header (3.4)</entry>
178 <entry>Allocator (3.[0-3])</entry>
179 <entry>Header (3.[0-3])</entry>
185 <entry><classname>__gnu_cxx::new_allocator<T></classname></entry>
186 <entry><filename class="headerfile">ext/new_allocator.h</filename></entry>
187 <entry><classname>std::__new_alloc</classname></entry>
188 <entry><filename class="headerfile">memory</filename></entry>
191 <entry><classname>__gnu_cxx::malloc_allocator<T></classname></entry>
192 <entry><filename class="headerfile">ext/malloc_allocator.h</filename></entry>
193 <entry><classname>std::__malloc_alloc_template<int></classname></entry>
194 <entry><filename class="headerfile">memory</filename></entry>
197 <entry><classname>__gnu_cxx::debug_allocator<T></classname></entry>
198 <entry><filename class="headerfile">ext/debug_allocator.h</filename></entry>
199 <entry><classname>std::debug_alloc<T></classname></entry>
200 <entry><filename class="headerfile">memory</filename></entry>
203 <entry><classname>__gnu_cxx::__pool_alloc<T></classname></entry>
204 <entry><filename class="headerfile">ext/pool_allocator.h</filename></entry>
205 <entry><classname>std::__default_alloc_template<bool,int></classname></entry>
206 <entry><filename class="headerfile">memory</filename></entry>
209 <entry><classname>__gnu_cxx::__mt_alloc<T></classname></entry>
210 <entry><filename class="headerfile">ext/mt_allocator.h</filename></entry>
215 <entry><classname>__gnu_cxx::bitmap_allocator<T></classname></entry>
216 <entry><filename class="headerfile">ext/bitmap_allocator.h</filename></entry>
224 <para> Releases after gcc-3.4 have continued to add to the collection
225 of available allocators. All of these new allocators are
226 standard-style. The following table includes details, along with
227 the first released version of GCC that included the extension allocator.
231 <title>Extension Allocators Continued</title>
233 <tgroup cols="3" align="left" colsep="1" rowsep="1">
234 <colspec colname="c1"/>
235 <colspec colname="c2"/>
236 <colspec colname="c3"/>
240 <entry>Allocator</entry>
241 <entry>Include</entry>
242 <entry>Version</entry>
248 <entry><classname>__gnu_cxx::array_allocator<T></classname></entry>
249 <entry><filename class="headerfile">ext/array_allocator.h</filename></entry>
253 <entry><classname>__gnu_cxx::throw_allocator<T></classname></entry>
254 <entry><filename class="headerfile">ext/throw_allocator.h</filename></entry>
263 Debug mode first appears.
267 Precompiled header support <acronym>PCH</acronym> support.
271 Macro guard for changed, from <literal>_GLIBCPP_</literal> to <literal>_GLIBCXX_</literal>.
275 Extension <filename class="headerfile">ext/stdio_sync_filebuf.h</filename> added.
279 Extension <filename class="headerfile">ext/demangle.h</filename> added.
285 <section xml:id="api.rel_400"><info><title><constant>4.0</constant></title></info>
290 TR1 features first appear.
294 Extension allocator <filename class="headerfile">ext/array_allocator.h</filename> added.
298 Extension <code>codecvt</code> specializations moved to <filename class="headerfile">ext/codecvt_specializations.h</filename>.
302 Removal of <filename class="headerfile">ext/demangle.h</filename>.
308 <section xml:id="api.rel_410"><info><title><constant>4.1</constant></title></info>
315 Removal of <filename class="headerfile">cassert</filename> from all standard headers: now has to be explicitly included for <code>std::assert</code> calls.
318 <para> Extensions for policy-based data structures first added. New includes,
319 types, namespace <code>pb_assoc</code>.
324 <para> Extensions for typelists added in <filename class="headerfile">ext/typelist.h</filename>.
327 <para> Extension for policy-based <code>basic_string</code> first added: <code>__gnu_cxx::__versa_string</code> in <filename class="headerfile">ext/vstring.h</filename>.
332 <section xml:id="api.rel_420"><info><title><constant>4.2</constant></title></info>
338 <para> Default visibility attributes applied to <code>namespace std</code>. Support for <code>-fvisibility</code>.
341 <para>TR1 <filename class="headerfile">random</filename>, <filename class="headerfile">complex</filename>, and C compatibility headers added.</para>
343 <para> Extensions for concurrent programming consolidated
344 into <filename class="headerfile">ext/concurrence.h</filename> and <filename class="headerfile">ext/atomicity.h</filename>,
345 including change of namespace to <code>__gnu_cxx</code> in some
347 include <code>_Lock_policy</code>, <code>__concurrence_lock_error</code>, <code>__concurrence_unlock_error</code>, <code>__mutex</code>, <code>__scoped_lock</code>.</para>
349 <para> Extensions for type traits consolidated
350 into <filename class="headerfile">ext/type_traits.h</filename>. Additional traits are added
351 (<code>__conditional_type</code>, <code>__enable_if</code>, others.)
354 <para> Extensions for policy-based data structures revised. New includes,
355 types, namespace moved to <code>__pb_ds</code>.
358 <para> Extensions for debug mode modified: now nested in <code>namespace
359 std::__debug</code> and extensions in <code>namespace
360 __gnu_cxx::__debug</code>.</para>
362 <para> Extensions added: <filename class="headerfile">ext/typelist.h</filename>
363 and <filename class="headerfile">ext/throw_allocator.h</filename>.
368 <section xml:id="api.rel_430"><info><title><constant>4.3</constant></title></info>
375 C++0X features first appear.
378 <para>TR1 <filename class="headerfile">regex</filename> and <filename class="headerfile">cmath</filename>'s mathematical special function added.
382 Backward include edit.
388 <filename class="headerfile">algobase.h</filename> <filename class="headerfile">algo.h</filename> <filename class="headerfile">alloc.h</filename> <filename class="headerfile">bvector.h</filename> <filename class="headerfile">complex.h</filename>
389 <filename class="headerfile">defalloc.h</filename> <filename class="headerfile">deque.h</filename> <filename class="headerfile">fstream.h</filename> <filename class="headerfile">function.h</filename> <filename class="headerfile">hash_map.h</filename> <filename class="headerfile">hash_set.h</filename>
390 <filename class="headerfile">hashtable.h</filename> <filename class="headerfile">heap.h</filename> <filename class="headerfile">iomanip.h</filename> <filename class="headerfile">iostream.h</filename> <filename class="headerfile">istream.h</filename> <filename class="headerfile">iterator.h</filename>
391 <filename class="headerfile">list.h</filename> <filename class="headerfile">map.h</filename> <filename class="headerfile">multimap.h</filename> <filename class="headerfile">multiset.h</filename> <filename class="headerfile">new.h</filename> <filename class="headerfile">ostream.h</filename> <filename class="headerfile">pair.h</filename> <filename class="headerfile">queue.h</filename> <filename class="headerfile">rope.h</filename> <filename class="headerfile">set.h</filename> <filename class="headerfile">slist.h</filename> <filename class="headerfile">stack.h</filename> <filename class="headerfile">streambuf.h</filename> <filename class="headerfile">stream.h</filename> <filename class="headerfile">tempbuf.h</filename>
392 <filename class="headerfile">tree.h</filename> <filename class="headerfile">vector.h</filename>
398 <filename class="headerfile">hash_map</filename> and <filename class="headerfile">hash_set</filename>
402 <para>Added in C++11</para>
404 <filename class="headerfile">auto_ptr.h</filename> and <filename class="headerfile">binders.h</filename>
411 Header dependency streamlining.
415 <listitem><para><filename class="headerfile">algorithm</filename> no longer includes <filename class="headerfile">climits</filename>, <filename class="headerfile">cstring</filename>, or <filename class="headerfile">iosfwd</filename> </para></listitem>
416 <listitem><para><filename class="headerfile">bitset</filename> no longer includes <filename class="headerfile">istream</filename> or <filename class="headerfile">ostream</filename>, adds <filename class="headerfile">iosfwd</filename> </para></listitem>
417 <listitem><para><filename class="headerfile">functional</filename> no longer includes <filename class="headerfile">cstddef</filename></para></listitem>
418 <listitem><para><filename class="headerfile">iomanip</filename> no longer includes <filename class="headerfile">istream</filename>, <filename class="headerfile">istream</filename>, or <filename class="headerfile">functional</filename>, adds <filename class="headerfile">ioswd</filename> </para></listitem>
419 <listitem><para><filename class="headerfile">numeric</filename> no longer includes <filename class="headerfile">iterator</filename></para></listitem>
420 <listitem><para><filename class="headerfile">string</filename> no longer includes <filename class="headerfile">algorithm</filename> or <filename class="headerfile">memory</filename></para></listitem>
422 <listitem><para><filename class="headerfile">valarray</filename> no longer includes <filename class="headerfile">numeric</filename> or <filename class="headerfile">cstdlib</filename></para></listitem>
423 <listitem><para><filename class="headerfile">tr1/hashtable</filename> no longer includes <filename class="headerfile">memory</filename> or <filename class="headerfile">functional</filename></para></listitem>
424 <listitem><para><filename class="headerfile">tr1/memory</filename> no longer includes <filename class="headerfile">algorithm</filename></para></listitem>
425 <listitem><para><filename class="headerfile">tr1/random</filename> no longer includes <filename class="headerfile">algorithm</filename> or <filename class="headerfile">fstream</filename></para></listitem>
429 Debug mode for <filename class="headerfile">unordered_map</filename> and <filename class="headerfile">unordered_set</filename>.
433 Parallel mode first appears.
436 <para>Variadic template implementations of items in <filename class="headerfile">tuple</filename> and
437 <filename class="headerfile">functional</filename>.
440 <para>Default <code>what</code> implementations give more elaborate
441 exception strings for <code>bad_cast</code>,
442 <code>bad_typeid</code>, <code>bad_exception</code>, and
443 <code>bad_alloc</code>.
447 PCH binary files no longer installed. Instead, the source files are installed.
451 Namespace pb_ds moved to __gnu_pb_ds.
457 <section xml:id="api.rel_440"><info><title><constant>4.4</constant></title></info>
472 <filename class="headerfile">atomic</filename>,
473 <filename class="headerfile">chrono</filename>,
474 <filename class="headerfile">condition_variable</filename>,
475 <filename class="headerfile">forward_list</filename>,
476 <filename class="headerfile">initializer_list</filename>,
477 <filename class="headerfile">mutex</filename>,
478 <filename class="headerfile">ratio</filename>,
479 <filename class="headerfile">thread</filename>
485 Updated and improved.
488 <filename class="headerfile">algorithm</filename>,
489 <filename class="headerfile">system_error</filename>,
490 <filename class="headerfile">type_traits</filename>
496 Use of the GNU extension namespace association converted to inline namespaces.
502 Preliminary support for <classname>initializer_list</classname>
503 and defaulted and deleted constructors in container classes.
509 <classname>unique_ptr</classname>.
515 Support for new character types <type>char16_t</type>
516 and <type>char32_t</type> added
517 to <classname>char_traits</classname>, <classname>basic_string</classname>, <classname>numeric_limits</classname>,
518 and assorted compile-time type traits.
524 Support for string conversions <function>to_string</function>
525 and <function>to_wstring</function>.
531 Member functions taking string arguments were added to iostreams
532 including <classname>basic_filebuf</classname>, <classname>basic_ofstream</classname>,
533 and <classname>basic_ifstream</classname>.
539 Exception propagation support,
540 including <classname>exception_ptr</classname>, <function>current_exception</function>, <function>copy_exception</function>,
541 and <function>rethrow_exception</function>.
548 Uglification of <literal>try</literal> to <literal>__try</literal>
549 and <literal>catch</literal> to <literal>__catch</literal>.
553 Audit of internal mutex usage, conversion to functions returning static
558 added: <filename class="headerfile">ext/pointer.h</filename>
559 and <filename class="headerfile">ext/extptr_allocator.h</filename>. Support
560 for non-standard pointer types has been added
561 to <classname>vector</classname>
562 and <classname>forward_list</classname>.
566 <section xml:id="api.rel_450"><info><title><constant>4.5</constant></title></info>
581 <filename class="headerfile">functional</filename>,
582 <filename class="headerfile">future</filename>,
583 <filename class="headerfile">random</filename>
589 Updated and improved.
592 <filename class="headerfile">atomic</filename>,
593 <filename class="headerfile">system_error</filename>,
594 <filename class="headerfile">type_traits</filename>
600 Add support for explicit operators and standard layout types.
606 Profile mode first appears.
610 Support for decimal floating-point arithmetic, including <classname>decimal32</classname>, <classname>decimal64</classname>, and <classname>decimal128</classname>.
614 Python pretty-printers are added for use with appropriately-advanced versions of <command>gdb</command>.
618 Audit for application of function attributes notrow, const, pure, and noreturn.
622 The default behavior for comparing typeinfo names changed, so
623 in <filename class="headerfile">typeinfo</filename>, <literal>__GXX_MERGED_TYPEINFO_NAMES</literal>
624 now defaults to zero.
627 <para> Extensions modified: <filename class="headerfile">ext/throw_allocator.h</filename>.