app-map-tidylib.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html><meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  3. <title>Mapping the HTMLTidy library into the Application - Boost.Outcome documentation</title>
  4. <link rel="stylesheet" href="../../../css/boost.css" type="text/css">
  5. <meta name="generator" content="Hugo 0.52 with Boostdoc theme">
  6. <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
  7. <link rel="icon" href="../../../images/favicon.ico" type="image/ico"/>
  8. <body><div class="spirit-nav">
  9. <a accesskey="p" href="../../../tutorial/advanced/interop/app-map-filelib.html"><img src="../../../images/prev.png" alt="Prev"></a>
  10. <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
  11. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app-go.html"><img src="../../../images/next.png" alt="Next"></a></div><div id="content">
  12. <div class="titlepage"><div><div><h1 style="clear: both">Mapping the HTMLTidy library into the Application</h1></div></div></div>
  13. <p>Once again, we create a custom STL exception type to represent failure
  14. from the HTMLTidy library. We also create an <code>app</code> namespace wrapper
  15. for the C <code>tidy_html()</code> function which is more C++ friendly.</p>
  16. <div class="code-snippet"><div class="highlight"><pre class="chroma"><code class="language-c++" data-lang="c++"><span class="k">namespace</span> <span class="n">app</span>
  17. <span class="p">{</span>
  18. <span class="c1">// Specialise an exception type for tidylib errors
  19. </span><span class="c1"></span> <span class="k">struct</span> <span class="nl">tidylib_error</span> <span class="p">:</span> <span class="n">std</span><span class="o">::</span><span class="n">system_error</span>
  20. <span class="p">{</span>
  21. <span class="c1">// passthrough
  22. </span><span class="c1"></span> <span class="k">using</span> <span class="n">std</span><span class="o">::</span><span class="n">system_error</span><span class="o">::</span><span class="n">system_error</span><span class="p">;</span>
  23. <span class="n">tidylib_error</span><span class="p">()</span> <span class="o">=</span> <span class="k">default</span><span class="p">;</span>
  24. <span class="k">explicit</span> <span class="nf">tidylib_error</span><span class="p">(</span><span class="kt">int</span> <span class="n">c</span><span class="p">)</span>
  25. <span class="o">:</span> <span class="n">std</span><span class="o">::</span><span class="n">system_error</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">generic_category</span><span class="p">())</span>
  26. <span class="p">{</span>
  27. <span class="p">}</span>
  28. <span class="p">};</span>
  29. <span class="c1">// Create a C++ invoking wrapper for the tidylib C API, modifying data with the returned data,
  30. </span><span class="c1"></span> <span class="c1">// returing a unique_ptr to release storage on scope exit.
  31. </span><span class="c1"></span> <span class="k">struct</span> <span class="n">call_free</span>
  32. <span class="p">{</span>
  33. <span class="k">template</span> <span class="o">&lt;</span><span class="k">class</span><span class="err"> </span><span class="nc">T</span><span class="o">&gt;</span> <span class="kt">void</span> <span class="k">operator</span><span class="p">()(</span><span class="n">T</span> <span class="o">*</span><span class="n">p</span><span class="p">)</span> <span class="p">{</span> <span class="o">::</span><span class="n">free</span><span class="p">(</span><span class="n">p</span><span class="p">);</span> <span class="p">}</span>
  34. <span class="p">};</span>
  35. <span class="kr">inline</span> <span class="n">outcome</span><span class="o">&lt;</span><span class="n">std</span><span class="o">::</span><span class="n">unique_ptr</span><span class="o">&lt;</span><span class="kt">char</span><span class="p">,</span> <span class="n">call_free</span><span class="o">&gt;&gt;</span> <span class="n">tidy_html</span><span class="p">(</span><span class="n">string_view</span> <span class="o">&amp;</span><span class="n">data</span><span class="p">)</span>
  36. <span class="p">{</span>
  37. <span class="kt">char</span> <span class="o">*</span><span class="n">out</span> <span class="o">=</span> <span class="k">nullptr</span><span class="p">;</span>
  38. <span class="n">size_t</span> <span class="n">outlen</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
  39. <span class="kt">int</span> <span class="n">errcode</span> <span class="o">=</span> <span class="o">::</span><span class="n">tidy_html</span><span class="p">(</span><span class="o">&amp;</span><span class="n">out</span><span class="p">,</span> <span class="o">&amp;</span><span class="n">outlen</span><span class="p">,</span> <span class="n">data</span><span class="p">.</span><span class="n">data</span><span class="p">(),</span> <span class="n">data</span><span class="p">.</span><span class="n">size</span><span class="p">());</span>
  40. <span class="k">if</span><span class="p">(</span><span class="n">errcode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">)</span>
  41. <span class="p">{</span>
  42. <span class="c1">// If the error code matches a standard STL exception, throw as that.
  43. </span><span class="c1"></span> <span class="n">BOOST_OUTCOME_V2_NAMESPACE</span><span class="o">::</span><span class="n">try_throw_std_exception_from_error</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">error_code</span><span class="p">(</span><span class="n">errcode</span><span class="p">,</span> <span class="n">std</span><span class="o">::</span><span class="n">generic_category</span><span class="p">()));</span>
  44. <span class="c1">// Otherwise wrap the error code into a tidylib_error exception throw
  45. </span><span class="c1"></span> <span class="k">return</span> <span class="n">std</span><span class="o">::</span><span class="n">make_exception_ptr</span><span class="p">(</span><span class="n">tidylib_error</span><span class="p">(</span><span class="n">errcode</span><span class="p">));</span>
  46. <span class="p">}</span>
  47. <span class="c1">// Reset input view to tidied html
  48. </span><span class="c1"></span> <span class="n">data</span> <span class="o">=</span> <span class="n">string_view</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="n">outlen</span><span class="p">);</span>
  49. <span class="c1">// Return a unique ptr to release storage on scope exit
  50. </span><span class="c1"></span> <span class="k">return</span> <span class="n">std</span><span class="o">::</span><span class="n">unique_ptr</span><span class="o">&lt;</span><span class="kt">char</span><span class="p">,</span> <span class="n">call_free</span><span class="o">&gt;</span><span class="p">(</span><span class="n">out</span><span class="p">);</span>
  51. <span class="p">}</span>
  52. <span class="p">}</span> <span class="c1">// namespace app
  53. </span><span class="c1"></span></code></pre></div><a href="https://github.com/boostorg/outcome/tree/master/doc/src/snippets/finale.cpp#L329" class="code-snippet-url" target="_blank">View this code on Github</a></div>
  54. </div><p><small>Last revised: February 08, 2019 at 22:18:08 UTC</small></p>
  55. <hr>
  56. <div class="spirit-nav">
  57. <a accesskey="p" href="../../../tutorial/advanced/interop/app-map-filelib.html"><img src="../../../images/prev.png" alt="Prev"></a>
  58. <a accesskey="u" href="../../../tutorial/advanced/interop.html"><img src="../../../images/up.png" alt="Up"></a>
  59. <a accesskey="h" href="../../../index.html"><img src="../../../images/home.png" alt="Home"></a><a accesskey="n" href="../../../tutorial/advanced/interop/app-go.html"><img src="../../../images/next.png" alt="Next"></a></div></body>
  60. </html>