src/third_party/libc++abi/trunk/www/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2           "http://www.w3.org/TR/html4/strict.dtd">
   3 <!-- Material used from: HTML 4.01 specs: http://www.w3.org/TR/html401/ -->
   4 <html>
   5 <head>
   6   <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   7   <title>"libc++abi" C++ Standard Library Support</title>
   8   <link type="text/css" rel="stylesheet" href="menu.css">
   9   <link type="text/css" rel="stylesheet" href="content.css">
  10 </head>
  11
  12 <body>
  13 <div id="menu">
  14   <div>
  15     <a href="http://llvm.org/">LLVM Home</a>
  16   </div>
  17
  18   <div class="submenu">
  19     <label>libc++abi Info</label>
  20     <a href="/index.html">About</a>
  21   </div>
  22
  23   <div class="submenu">
  24     <label>Quick Links</label>
  25     <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a>
  26     <a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits</a>
  27     <a href="http://llvm.org/bugs/">Bug Reports</a>
  28     <a href="http://llvm.org/svn/llvm-project/libcxxabi/trunk/">Browse SVN</a>
  29     <a href="http://llvm.org/viewvc/llvm-project/libcxxabi/trunk/">Browse ViewVC</a>
  30   </div>
  31 </div>
  32
  33 <div id="content">
  34   <!--*********************************************************************-->
  35   <h1>"libc++abi" C++ Standard Library Support</h1>
  36   <!--*********************************************************************-->
  37
  38   <p>libc++abi is a new implementation of low level support for a standard
  39      C++ library.</p>
  40
  41   <p>All of the code in libc++abi is <a
  42      href="http://llvm.org/docs/DeveloperPolicy.html#license">dual licensed</a>
  43      under the MIT license and the UIUC License (a BSD-like license).</p>
  44
  45   <!--=====================================================================-->
  46   <h2 id="goals">Features and Goals</h2>
  47   <!--=====================================================================-->
  48
  49     <ul>
  50         <li>Correctness as defined by the C++11 standard.</li>
  51         <li>Provide a portable sublayer to ease the porting of <a href="http://libcxx.llvm.org/">libc++</a></li>
  52         <li>On Mac OS X, be ABI compatible with the existing low-level support.</li>
  53     </ul>
  54
  55   <!--=====================================================================-->
  56   <h2 id="requirements">Platform Support</h2>
  57   <!--=====================================================================-->
  58
  59    <p>libc++abi is known to work on the following platforms, using clang.</p>
  60
  61     <ul>
  62     <li>Darwin</li>
  63     </ul>
  64
  65   <!--=====================================================================-->
  66   <h2 id="dir-structure">Current Status</h2>
  67   <!--=====================================================================-->
  68
  69    <p>libc++abi is complete.  <a href="spec.html">Here</a> is a
  70    list of functionality.</p>
  71
  72   <!--=====================================================================-->
  73   <h2>Get it and get involved!</h2>
  74   <!--=====================================================================-->
  75
  76   <p>To check out the code, use:</p>
  77
  78   <ul>
  79   <li><code>svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi</code></li>
  80   </ul>
  81
  82   <p>To build:</p>
  83   <ul>
  84   <li>Check out libcxxabi into <code>llvm/projects</code></li>
  85   <li><code>cd llvm</code></li>
  86   <li><code>mkdir build &amp;&amp; cd build</code></li>
  87   <li><code>cmake .. # on linux you may need to prefix with CC=clang CXX=clang++</code></li>
  88   <li><code>make</code></li>
  89   </ul>
  90
  91   <p>To do a standalone build:</p>
  92   <ul>
  93   <li><code>cd libcxxabi</code></li>
  94   <li><code>mkdir build &amp;&amp; cd build</code></li>
  95   <li><code>cmake -DLIBCXXABI_LIBCXX_INCLUDES=path/to/libcxx/include .. # on
  96     linux you may need -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++</code></li>
  97   <li><code>make</code></li>
  98   </ul>
  99
 100   <p>To run the tests:</p>
 101   <ul>
 102   <li><code>make check-libcxxabi</code></li>
 103   </ul>
 104   <p>Note: in a standalone build, the system's libc++ will be used for tests. If
 105   the system's libc++ was statically linked against libc++abi (or linked against
 106   a different ABI library), this may interfere with test results.</p>
 107
 108   <p>Send discussions to the
 109   (<a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">clang mailing list</a>).</p>
 110
 111   <!--=====================================================================-->
 112   <h2>Frequently asked questions</h2>
 113   <!--=====================================================================-->
 114
 115   <p>Q: Why are the destructors for the standard exception classes defined in libc++abi?
 116      They're just empty, can't they be defined inline?</p>
 117   <p>A: The destructors for them live in libc++abi because they are "key" functions.
 118      The Itanium ABI describes a "key" function as the first virtual declared.
 119      And wherever the key function is defined, that is where the <code>type_info</code> gets defined.
 120      And in libc++ types are the same type if and only if they have the same <code>type_info</code>
 121      (as in there must be only one type info per type in the entire application).
 122      And on OS X, libstdc++ and libc++ share these exception types.
 123      So to be able to throw in one dylib and catch in another (a <code>std::exception</code> for example),
 124      there must be only one <code>std::exception type_info</code> in the entire app.
 125      That typeinfo gets laid down beside <code>~exception()</code> in libc++abi (for both libstdc++ and libc++).</p>
 126      <p>--Howard Hinnant</p>
 127
 128 </div>
 129 </body>
 130 </html>