libstdc++-v3/docs/html/documentation.html

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html
   3           PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8  <meta name="KEYWORDS"
   9   content="libstdc++, homepage, home, C++, library, c++, std, g++, ABI, STL" />
  10  <title>GNU C++ Standard Library</title>
  11 <link rel="StyleSheet" href="lib3styles.css" />
  12 </head>
  13 <body>
  14
  15
  16 <p><strong>All of these documents</strong> (in fact, this entire homepage set)
  17    are bundled with the library source, under the <code>docs</code>
  18    subdirectory, for releases and snapshots.  The sole exception is the
  19    automatically-generated source documentation, available separately.
  20 </p>
  21
  22 <hr />
  23 <br />
  24 <h2><a name="1">Introduction</a></h2>
  25    <p>This is a short list of text files pertaining to this implementation of
  26       ISO 14882.  A brief description may follow the name of the file.
  27    </p>
  28       <ul>
  29          <li><a href="17_intro/COPYING">License</a>
  30          - GPL v2 license terms</li>
  31          <li><a href="abi.txt">ABI Policy and Guidelines</a></li>
  32          <li><a href="17_intro/BUGS">BUGS</a></li>
  33          <li><a href="17_intro/PROBLEMS">PROBLEMS</a>
  34          - target-specific known issues</li>
  35          <!-- Linking to "../README" doesn't work; we are at the top level
  36               of the web pages.  Punt.  -->
  37          <li>README - directory structure</li>
  38          <li><a href="17_intro/RELEASE-NOTES">RELEASE-NOTES</a>
  39          - latest version info, recent changes and news</li>
  40          <li><a href="17_intro/TODO">TODO</a>
  41          - tasks yet undone</li>
  42       </ul>
  43
  44 <hr />
  45 <br />
  46 <h2><a name="2">Configuring, Building, Installing</a></h2>
  47 <ul>
  48    <li><a href="configopts.html">Configure options</a></li>
  49    <li><a href="install.html">Getting started: configure, build, install</a>
  50    <li><a href="debug.html">Debugging schemes and strategies</a>
  51    </li>
  52 </ul>
  53
  54
  55 <hr />
  56 <br />
  57 <h2><a name="4">Source-Level Documentation</a></h2>
  58 <p>The library sources have been specially formatted so that with the
  59    proper invocation of another tool (Doxygen), a set of HTML pages
  60    are generated from the sources files themselves.  The resultant
  61    documentation is referred to as Source-Level Documentation, and is
  62    useful for examining the signatures of public member functions for
  63    the library classes, finding out what is in a particular include
  64    file, looking at inheritance diagrams, etc.
  65 </p>
  66 <p>The Source-Level documentation can be viewed online:</p>
  67 <ul>
  68    <li><a href="libstdc++-html-USERS-3.1/index.html">for the 3.1 release</a>
  69    </li>
  70    <li><a href="libstdc++-html-USERS-3.2.1/index.html">for the 3.2.1 release</a>
  71    </li>
  72    <li><a href="latest-doxygen/index.html">&quot;the latest collection&quot;</a>
  73        (for the snapshot or later; see the date on the first page)
  74    </li>
  75 </ul>
  76 <p>This generated HTML collection, as above, is also available for download in
  77    the libstdc++ snapshots directory at
  78    <code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
  79    You will almost certainly need to use one of the <a
  80    href="http://gcc.gnu.org/mirrors.html">mirror sites</a> to download
  81    the tarball.  After unpacking, simply load
  82    libstdc++-html-*/index.html into a browser.  Feedback (and
  83    additional documentation!) is welcome.
  84 </p>
  85 <p>
  86  In addition, an initial set of man pages are also available in the
  87  same place as the HTML collections.  Start with Intro(3).
  88 </p>
  89
  90
  91 <hr />
  92 <br />
  93 <h2><a name="3">Chapter-Specific Documentation</a></h2>
  94 <p>Information, extensions, notes and advice on specific implementation
  95    capabilites and/or liabilities broken down into chapter names based on the
  96    C++ standard.
  97 </p>
  98 <!--
  99   The list below is automatically generated.  To make changes in the text,
 100   edit the appropriate HOWTO file and run "make" in this directory.  In
 101   those files, you may reorder entries as you like, but DO NOT change the
 102   "#number"s in anchors, for they are used elsewhere and in bookmarks.
 103 -->
 104 <!-- beginlist -->
 105   <ul>
 106    <li>Library Introduction (Chapter 17)
 107    <ul>
 108      <li><a href="17_intro/howto.html#2">The Standard C++ header files</a></li>
 109      <li><a href="17_intro/howto.html#3">The Standard C++ library and multithreading</a></li>
 110      <li><a href="17_intro/howto.html#4"><code>&lt;foo&gt;</code> vs <code>&lt;foo.h&gt;</code></a></li>
 111      <li><a href="17_intro/porting-howto.html">Porting HOWTO</a></li>
 112      <li><a href="17_intro/howto.html#5">Behavior specific to libstdc++-v3</a></li>
 113      <li><a href="17_intro/howto.html#6">Preprocessor macros controlling the library</a></li>
 114    </ul>
 115    </li>
 116
 117    <li>Library Support (Chapter 18)
 118    <ul>
 119      <li><a href="18_support/howto.html#1">Types</a></li>
 120      <li><a href="18_support/howto.html#2">Implementation properties</a></li>
 121      <li><a href="18_support/howto.html#3">Start and Termination</a></li>
 122      <li><a href="18_support/howto.html#4">Dynamic memory management</a></li>
 123      <li><a href="18_support/howto.html#5">RTTI, the ABI, and demangling</a></li>
 124    </ul>
 125    </li>
 126
 127    <li>Diagnostics (Chapter 19)
 128    <ul>
 129      <li><a href="19_diagnostics/howto.html#1">Adding data to exceptions</a></li>
 130      <li><a href="19_diagnostics/howto.html#2">Exception class hierarchy diagram</a></li>
 131      <li><a href="19_diagnostics/howto.html#3">Concept checkers -- <strong>new and improved!</strong></a></li>
 132      <li><a href="19_diagnostics/howto.html#4">Verbose <code>terminate</code></a></li>
 133    </ul>
 134    </li>
 135
 136    <li>General Utilities (Chapter 20)
 137    <ul>
 138      <li><a href="20_util/howto.html#1"><code>auto_ptr</code> is not omnipotent</a></li>
 139      <li><a href="20_util/howto.html#2"><code>auto_ptr</code> inside container classes</a></li>
 140      <li><a href="20_util/howto.html#3">Functors</a></li>
 141      <li><a href="20_util/howto.html#4">Pairs</a></li>
 142    </ul>
 143    </li>
 144
 145    <li>Strings (Chapter 21)
 146    <ul>
 147      <li><a href="21_strings/howto.html#1">MFC's CString</a></li>
 148      <li><a href="21_strings/howto.html#2">A case-insensitive string class</a></li>
 149      <li><a href="21_strings/howto.html#3">Breaking a C++ string into tokens</a></li>
 150      <li><a href="21_strings/howto.html#4">Simple transformations</a></li>
 151      <li><a href="21_strings/howto.html#5">Making strings of arbitrary character types</a></li>
 152    </ul>
 153    </li>
 154
 155    <li>Localization (Chapter 22)
 156    <ul>
 157      <li><a href="22_locale/howto.html#1">class locale</a></li>
 158      <li><a href="22_locale/howto.html#2">class codecvt</a></li>
 159      <li><a href="22_locale/howto.html#3">class ctype</a></li>
 160      <li><a href="22_locale/howto.html#4">class messages</a></li>
 161      <li><a href="22_locale/howto.html#5">Bjarne Stroustrup on Locales</a></li>
 162      <li><a href="22_locale/howto.html#6">Nathan Myers on Locales</a></li>
 163      <li><a href="22_locale/howto.html#7">Correct Transformations</a></li>
 164    </ul>
 165    </li>
 166
 167    <li>Containers (Chapter 23)
 168    <ul>
 169      <li><a href="23_containers/howto.html#1">Making code unaware of the container/array difference</a></li>
 170      <li><a href="23_containers/howto.html#2">Variable-sized bitmasks</a></li>
 171      <li><a href="23_containers/howto.html#3">Containers and multithreading</a></li>
 172      <li><a href="23_containers/howto.html#4">&quot;Hinting&quot; during insertion</a></li>
 173      <li><a href="23_containers/howto.html#5">Bitmasks and string arguments</a></li>
 174      <li><a href="23_containers/howto.html#6"><code>std::list::size()</code> is O(n)!</a></li>
 175      <li><a href="23_containers/howto.html#7">Space overhead management for vectors</a></li>
 176    </ul>
 177    </li>
 178
 179    <li>Iterators (Chapter 24)
 180    <ul>
 181      <li><a href="24_iterators/howto.html#1">They ain't pointers!</a></li>
 182      <li><a href="24_iterators/howto.html#2">It ends <em>where?</em></a></li>
 183    </ul>
 184    </li>
 185
 186    <li>Algorithms (Chapter 25)
 187    <ul>
 188      <li><a href="25_algorithms/howto.html#1">Prerequisites</a></li>
 189      <li><a href="25_algorithms/howto.html#2">Special <code>swap</code>s</a></li>
 190    </ul>
 191    </li>
 192
 193    <li>Numerics (Chapter 26)
 194    <ul>
 195      <li><a href="26_numerics/howto.html#1">Complex Number Processing</a></li>
 196      <li><a href="26_numerics/howto.html#2">Array Processing</a></li>
 197      <li><a href="26_numerics/howto.html#3">Numerical Functions</a></li>
 198      <li><a href="26_numerics/howto.html#4">C99</a></li>
 199    </ul>
 200    </li>
 201
 202    <li>Input/Output (Chapter 27)
 203    <ul>
 204      <li><a href="27_io/howto.html#1">Copying a file</a></li>
 205      <li><a href="27_io/howto.html#2">The buffering is screwing up my program!</a></li>
 206      <li><a href="27_io/howto.html#3">Binary I/O</a></li>
 207      <li><a href="27_io/howto.html#5">What is this &lt;sstream&gt;/stringstreams thing?</a></li>
 208      <li><a href="27_io/howto.html#6">Deriving a stream buffer</a></li>
 209      <li><a href="27_io/howto.html#7">More on binary I/O</a></li>
 210      <li><a href="27_io/howto.html#8">Pathetic performance?  Ditch C.</a></li>
 211      <li><a href="27_io/howto.html#9">Threads and I/O</a></li>
 212      <li><a href="27_io/howto.html#10">Which header?</a></li>
 213    </ul>
 214    </li>
 215
 216    <li>Extensions to the Standard Library
 217    <ul>
 218      <li><a href="ext/howto.html#1">Ropes and trees and hashes, oh my!</a></li>
 219      <li><a href="ext/howto.html#2">Added members and types</a></li>
 220      <li><a href="ext/howto.html#3">Allocators (versions 3.0, 3.1, 3.2)</a></li>
 221      <li><a href="ext/howto.html#6">Allocators (version 3.3)</a></li>
 222      <li><a href="ext/howto.html#4">Compile-time checks</a></li>
 223      <li><a href="ext/howto.html#5">LWG Issues</a></li>
 224    </ul>
 225    </li>
 226
 227   </ul>
 228 <!-- endlist -->
 229
 230 <hr />
 231 <br />
 232 <h2><a name="5">Contributor-Specific Information</a></h2>
 233 <ul>
 234    <li><a href="17_intro/contribute.html">Contributor checklist</a></li>
 235    <li><a href="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</a></li>
 236    <li><a href="17_intro/BADNAMES">BADNAMES</a>
 237        - names to avoid because of potential collisions</li>
 238    <li><a href="17_intro/C++STYLE">C++STYLE</a>
 239        - coding style by example</li>
 240    <li><a href="17_intro/CHECKLIST">CHECKLIST</a>
 241        - a list of required features and their status.</li>
 242    <li><a href="17_intro/DESIGN">DESIGN</a>
 243        - overview of the implementation plan</li>
 244    <li><a href="17_intro/HEADER_POLICY">HEADER_POLICY</a>
 245        - header naming and sub-include structure</li>
 246 </ul>
 247
 248 <!-- ####################################################### -->
 249
 250 <p>Return <a href="http://gcc.gnu.org/libstdc++/">to the libstdc++ homepage</a>.</p>
 251
 252 <hr />
 253 <p class="fineprint"><em>
 254 See <a href="17_intro/license.html">license.html</a> for copying conditions.
 255 Comments and suggestions are welcome, and may be sent to
 256 <a href="mailto:libstdc++@gcc.gnu.org">the libstdc++ mailing list</a>.
 257 </em></p>
 258
 259 </body>
 260 </html>