libstdc++-v3/doc/xml/manual/diagnostics.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
   4 [ ]>
   5
   6 <part id="manual.diagnostics" xreflabel="Diagnostics">
   7 <?dbhtml filename="diagnostics.html"?>
   8
   9 <partinfo>
  10   <keywordset>
  11     <keyword>
  12       ISO C++
  13     </keyword>
  14     <keyword>
  15       library
  16     </keyword>
  17   </keywordset>
  18 </partinfo>
  19
  20 <title>Diagnostics</title>
  21
  22 <chapter id="manual.diagnostics.exceptions" xreflabel="Exceptions">
  23   <title>Exceptions</title>
  24
  25   <sect1 id="manual.diagnostics.exceptions.hierarchy" xreflabel="Exception Classes">
  26     <title>Exception Classes</title>
  27     <para>
  28       All exception objects are defined in one of the standard header
  29       files: <filename>exception</filename>,
  30       <filename>stdexcept</filename>, <filename>new</filename>, and
  31       <filename>typeinfo</filename>.
  32     </para>
  33
  34     <para>
  35       The base exception object is <classname>exception</classname>,
  36       located in <filename>exception</filename>. This object has no
  37       <classname>string</classname> member.
  38     </para>
  39
  40     <para>
  41       Derived from this are several classes that may have a
  42       <classname>string</classname> member: a full hierarchy can be
  43       found in the <ulink url="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00233.html">source documentation</ulink>.
  44     </para>
  45
  46   </sect1>
  47   <sect1 id="manual.diagnostics.exceptions.data" xreflabel="Adding Data to Exceptions">
  48     <title>Adding Data to Exceptions</title>
  49     <para>
  50       The standard exception classes carry with them a single string as
  51       data (usually describing what went wrong or where the 'throw' took
  52     place).  It's good to remember that you can add your own data to
  53     these exceptions when extending the hierarchy:
  54    </para>
  55    <programlisting>
  56    struct My_Exception : public std::runtime_error
  57    {
  58      public:
  59        My_Exception (const string&amp; whatarg)
  60            : std::runtime_error(whatarg), e(errno), id(GetDataBaseID()) { }
  61        int  errno_at_time_of_throw() const { return e; }
  62        DBID id_of_thing_that_threw() const { return id; }
  63      protected:
  64        int    e;
  65        DBID   id;     // some user-defined type
  66    };
  67    </programlisting>
  68
  69   </sect1>
  70   <sect1 id="manual.diagnostics.exceptions.cancellation" xreflabel="Cancellation">
  71     <title>Cancellation</title>
  72     <para>
  73     </para>
  74   </sect1>
  75 </chapter>
  76
  77 <chapter id="manual.diagnostics.concept_checking" xreflabel="Concept Checking">
  78   <title>Concept Checking</title>
  79   <para>
  80     In 1999, SGI added <quote>concept checkers</quote> to their
  81     implementation of the STL: code which checked the template
  82     parameters of instantiated pieces of the STL, in order to insure
  83     that the parameters being used met the requirements of the
  84     standard.  For example, the Standard requires that types passed as
  85     template parameters to <classname>vector</classname> be
  86     &quot;Assignable&quot; (which means what you think it means).  The
  87     checking was done during compilation, and none of the code was
  88     executed at runtime.
  89    </para>
  90    <para>
  91      Unfortunately, the size of the compiler files grew significantly
  92      as a result.  The checking code itself was cumbersome.  And bugs
  93      were found in it on more than one occasion.
  94    </para>
  95    <para>
  96      The primary author of the checking code, Jeremy Siek, had already
  97      started work on a replacement implementation.  The new code has been
  98      formally reviewed and accepted into
  99    <ulink url="http://www.boost.org/libs/concept_check/concept_check.htm">the
 100    Boost libraries</ulink>, and we are pleased to incorporate it into the
 101    GNU C++ library.
 102  </para>
 103  <para>
 104    The new version imposes a much smaller space overhead on the generated
 105    object file.  The checks are also cleaner and easier to read and
 106    understand.
 107  </para>
 108
 109  <para>
 110    They are off by default for all versions of GCC.
 111    They can be enabled at configure time with
 112    <ulink url="../configopts.html"><literal>--enable-concept-checks</literal></ulink>.
 113    You can enable them on a per-translation-unit basis with
 114      <literal>-D_GLIBCXX_CONCEPT_CHECKS</literal>.
 115  </para>
 116
 117  <para>
 118    Please note that the upcoming C++ standard has first-class
 119    support for template parameter constraints based on concepts in the core
 120    language. This will obviate the need for the library-simulated concept
 121    checking described above.
 122  </para>
 123
 124 </chapter>
 125
 126 </part>