init_func.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Customizing the module's initialization function</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="../shared_lib_customizations.html" title="Shared-library variant customizations">
  9. <link rel="prev" href="entry_point.html" title="Customizing the module's entry point">
  10. <link rel="next" href="../external_test_runner.html" title="The external test runner usage variant">
  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="entry_point.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shared_lib_customizations.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="../external_test_runner.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h4 class="title">
  27. <a name="boost_test.adv_scenarios.shared_lib_customizations.init_func"></a><a class="link" href="init_func.html" title="Customizing the module's initialization function">Customizing
  28. the module's initialization function</a>
  29. </h4></div></div></div>
  30. <p>
  31. In the shared-library variant, it is impossible to customize the initialization
  32. function without <a class="link" href="entry_point.html" title="Customizing the module's entry point">customizing
  33. the entry point</a>. We have to customize both. In one of the source
  34. files, you now have to define your custom entry point and <a class="link" href="../test_module_init_overview.html" title="Test module's initialization">initialization
  35. function</a> <code class="computeroutput"><span class="identifier">init_unit_test</span></code>;
  36. next invoke the default <a class="link" href="../test_module_runner_overview.html" title="Test module runner">test
  37. runner</a> <code class="computeroutput"><span class="identifier">unit_test_main</span></code>
  38. manually with <code class="computeroutput"><span class="identifier">init_unit_test</span></code>
  39. as argument. You <span class="emphasis"><em>do not</em></span> define <a class="link" href="../../utf_reference/link_references/link_boost_test_module_macro.html" title="BOOST_TEST_MODULE"><code class="computeroutput"><span class="identifier">BOOST_TEST_MODULE</span></code></a> in the main
  40. file:
  41. </p>
  42. <div class="informaltable"><table class="table">
  43. <colgroup>
  44. <col>
  45. <col>
  46. </colgroup>
  47. <thead><tr>
  48. <th>
  49. <p>
  50. In <span class="bold"><strong>exactly one</strong></span> file
  51. </p>
  52. </th>
  53. <th>
  54. <p>
  55. In all other files
  56. </p>
  57. </th>
  58. </tr></thead>
  59. <tbody><tr>
  60. <td>
  61. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_DYN_LINK</span>
  62. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  63. <span class="comment">// initialization function:</span>
  64. <span class="keyword">bool</span> <span class="identifier">init_unit_test</span><span class="special">()</span>
  65. <span class="special">{</span>
  66. <span class="keyword">return</span> <span class="keyword">true</span><span class="special">;</span>
  67. <span class="special">}</span>
  68. <span class="comment">// entry point:</span>
  69. <span class="keyword">int</span> <span class="identifier">main</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">argc</span><span class="special">,</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">argv</span><span class="special">[])</span>
  70. <span class="special">{</span>
  71. <span class="keyword">return</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">unit_test</span><span class="special">::</span><span class="identifier">unit_test_main</span><span class="special">(</span> <span class="special">&amp;</span><span class="identifier">init_unit_test</span><span class="special">,</span> <span class="identifier">argc</span><span class="special">,</span> <span class="identifier">argv</span> <span class="special">);</span>
  72. <span class="special">}</span>
  73. </pre>
  74. </td>
  75. <td>
  76. <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#define</span> <span class="identifier">BOOST_TEST_DYN_LINK</span>
  77. <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">test</span><span class="special">/</span><span class="identifier">unit_test</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  78. <span class="comment">//</span>
  79. <span class="comment">// test cases</span>
  80. <span class="comment">//</span>
  81. <span class="comment">//</span>
  82. <span class="comment">// test cases</span>
  83. <span class="comment">//</span>
  84. <span class="comment">//</span>
  85. <span class="comment">// test cases</span>
  86. <span class="comment">//</span>
  87. </pre>
  88. </td>
  89. </tr></tbody>
  90. </table></div>
  91. <p>
  92. For reporting errors that may occur during the initialization,
  93. </p>
  94. <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  95. <li class="listitem">
  96. either you return <code class="computeroutput"><span class="keyword">false</span></code>
  97. (valid only for the new API only, see <a class="link" href="../../utf_reference/link_references/link_boost_test_alternative_init_macro.html" title="BOOST_TEST_ALTERNATIVE_INIT_API"><code class="computeroutput"><span class="identifier">BOOST_TEST_ALTERNATIVE_INIT_API</span></code></a>)
  98. </li>
  99. <li class="listitem">
  100. or you raise an exception such as <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">runtime_error</span></code>
  101. or <code class="computeroutput"><a class="link" href="../../../boost/unit_test/framework/setup_error.html" title="Struct setup_error">boost::unit_test::framework::setup_error</a></code>
  102. </li>
  103. </ul></div>
  104. <p>
  105. An error reported in this function aborts the execution of the test module.
  106. </p>
  107. </div>
  108. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  109. <td align="left"></td>
  110. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  111. contributors<p>
  112. Distributed under the Boost Software License, Version 1.0. (See accompanying
  113. 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>)
  114. </p>
  115. </div></td>
  116. </tr></table>
  117. <hr>
  118. <div class="spirit-nav">
  119. <a accesskey="p" href="entry_point.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../shared_lib_customizations.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="../external_test_runner.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  120. </div>
  121. </body>
  122. </html>