libs/test/doc/html/boost/debug/set_debugger.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Function set_debugger</title>
   5 <link rel="stylesheet" href="../../boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Boost.Test">
   8 <link rel="up" href="../../header/boost/test/debug_hpp.html" title="Header &lt;boost/test/debug.hpp&gt;">
   9 <link rel="prev" href="under_debugger.html" title="Function under_debugger">
  10 <link rel="next" href="attach_debugger.html" title="Function attach_debugger">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="under_debugger.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/debug_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="attach_debugger.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.debug.set_debugger"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Function set_debugger</span></h2>
  29 <p>boost::debug::set_debugger &#8212; Specifies which debugger to use when attaching and optionally what routine to use to start that debugger. </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../header/boost/test/debug_hpp.html" title="Header &lt;boost/test/debug.hpp&gt;">boost/test/debug.hpp</a>&gt;
  33
  34 </span>
  35 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="identifier">set_debugger</span><span class="special">(</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">const_string</span> dbg_id<span class="special">,</span>
  36                          <span class="identifier">dbg_starter</span> s <span class="special">=</span> <span class="identifier">dbg_starter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  37 <div class="refsect1">
  38 <a name="idm45313890898704"></a><h2>Description</h2>
  39 <p>There are many different debuggers available for different platforms. Some of them also can be used in a different setups/configuratins. For example, gdb can be used in plain text mode, inside ddd, inside (x)emacs or in a separate xterm window. Boost.Test identifies each configuration with unique string. Also different debuggers configurations require different routines which is specifically tailored to start that debugger configuration. Boost.Test comes with set of predefined configuration names and corresponding routines for these configurations:</p>
  40 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>TODO</p></li></ul></div>
  41 <p>
  42 </p>
  43 <p>You can use this routine to select which one of the predefined debugger configurations to use in which case you do not need to provide starter routine (the one provided by Boost.Test will be used). You can also use this routine to select your own debugger by providing unique configuration id and starter routine for this configuration.</p>
  44 <p>
  45
  46 </p>
  47 <div class="variablelist"><table border="0" class="variablelist compact">
  48 <colgroup>
  49 <col align="left" valign="top">
  50 <col>
  51 </colgroup>
  52 <tbody>
  53 <tr>
  54 <td><p><span class="term">Parameters:</span></p></td>
  55 <td><div class="variablelist"><table border="0" class="variablelist compact">
  56 <colgroup>
  57 <col align="left" valign="top">
  58 <col>
  59 </colgroup>
  60 <tbody>
  61 <tr>
  62 <td><p><span class="term"><code class="computeroutput">dbg_id</code></span></p></td>
  63 <td><p>Unique id for debugger configuration (for example, gdb) </p></td>
  64 </tr>
  65 <tr>
  66 <td><p><span class="term"><code class="computeroutput">s</code></span></p></td>
  67 <td><p>Optional starter routine for selected configuration (use only you want to define your own configuration) </p></td>
  68 </tr>
  69 </tbody>
  70 </table></div></td>
  71 </tr>
  72 <tr>
  73 <td><p><span class="term">Returns:</span></p></td>
  74 <td><p>Id of previously selected debugger configuration </p></td>
  75 </tr>
  76 </tbody>
  77 </table></div>
  78 </div>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  83       contributors<p>
  84         Distributed under the Boost Software License, Version 1.0. (See accompanying
  85         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  86       </p>
  87 </div></td>
  88 </tr></table>
  89 <hr>
  90 <div class="spirit-nav">
  91 <a accesskey="p" href="under_debugger.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/debug_hpp.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="attach_debugger.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  92 </div>
  93 </body>
  94 </html>