Merge pull request #177 from saxbophone/develop

v0.27 - Measure CPU Time not Wall Clock Time

.gitignore

@@ -42,3 +42,8 @@ Makefile
 cmake_install.cmake
 CTestTestfile.cmake
 install_manifest.txt
+
+# CMake build directory
+build/*
+# explicitly allow build directory .gitkeep file
+!build/.gitkeep

CMakeLists.txt

@@ -15,7 +15,7 @@
 # begin basic metadata
 cmake_minimum_required(VERSION 3.0)
 
-project(sxbp VERSION 0.26.1 LANGUAGES C)
+project(sxbp VERSION 0.27.0 LANGUAGES C)
 
 # set default C standard to use (C99) if not already set
 if(NOT DEFINED LIBSXBP_C_STANDARD)

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = libsxbp
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = v0.26
+PROJECT_NUMBER         = v0.27
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -60,10 +60,12 @@ There are no compulsory library dependencies beyond the C99 standard library. *Y
 
 ### Recommended Library Build
 
-Invoke CMake within the root of this repository, with these arguments to make CMake build the library in release mode (with full optimisation) and as a shared library:
+> An **out of source build** is recommended, as CMake clutters the directory it is executed in with many files which are awkward to remove.
+
+Invoke CMake within the `build` directory of this repository, with these arguments to make CMake build the library in release mode (with full optimisation) and as a shared library:
 
 ```sh
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
 make
 ```
 
@@ -73,12 +75,12 @@ You can build in C11 mode if you want with either of the following:
 
 ```sh
 # using CMake variable
-cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DLIBSXBP_C_STANDARD=11 .
+cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON -DLIBSXBP_C_STANDARD=11 ..
 ```
 
 ```sh
 # using environment variable
-LIBSXBP_C_STANDARD=11 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON .
+LIBSXBP_C_STANDARD=11 cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=ON ..
 ```
 
 Also, by default the CMake build script will look for libpng. If it cannot find it then it will disable support for PNG output.
@@ -87,12 +89,12 @@ You may choose to explicitly disable or enable PNG support with the `LIBSXBP_PNG
 
 ```sh
 # PNG support is required, build will fail if libpng can't be found
-cmake -DLIBSXBP_PNG_SUPPORT=ON .
+cmake -DLIBSXBP_PNG_SUPPORT=ON ..
 ```
 
 ```sh
 # PNG support is not included, even if libpng can be found
-cmake -DLIBSXBP_PNG_SUPPORT=OFF .
+cmake -DLIBSXBP_PNG_SUPPORT=OFF ..
 ```
 
 > ### Note:

docs/annotated.html

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>

docs/backend__pbm_8h.html

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>
@@ -104,8 +104,8 @@
 <div class="dyncontent">
 <div class="center"><img src="backend__pbm_8h__incl.png" border="0" usemap="#sxbp_2render__backends_2backend__pbm_8h" alt=""/></div>
 <map name="sxbp_2render__backends_2backend__pbm_8h" id="sxbp_2render__backends_2backend__pbm_8h">
-<area shape="rect" id="node2" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="27,169,138,196"/>
-<area shape="rect" id="node6" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="131,95,213,121"/>
+<area shape="rect" id="node2" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="78,169,189,196"/>
+<area shape="rect" id="node7" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="182,95,263,121"/>
 </map>
 </div>
 </div>

docs/backend__pbm_8h__incl.map

@@ -1,4 +1,4 @@
 <map id="sxbp/render_backends/backend_pbm.h" name="sxbp/render_backends/backend_pbm.h">
-<area shape="rect" id="node2" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="27,169,138,196"/>
-<area shape="rect" id="node6" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="131,95,213,121"/>
+<area shape="rect" id="node2" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="78,169,189,196"/>
+<area shape="rect" id="node7" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="182,95,263,121"/>
 </map>

docs/backend__pbm_8h__incl.md5

@@ -1 +1 @@
-3dfb6ae624b8e29e3b0371a593b57e64
+ae0da03ff880d26982d479c9613fcf06

docs/backend__pbm_8h_source.html

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>
@@ -94,8 +94,8 @@
 <div class="contents">
 <a href="backend__pbm_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * This source file forms part of libsxbp, a library which generates</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * experimental 2D spiral-like shapes based on input binary data.</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef SAXBOPHONE_SAXBOSPIRAL_BACKEND_PBM_H</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define SAXBOPHONE_SAXBOSPIRAL_BACKEND_PBM_H</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;../saxbospiral.h&quot;</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;../render.h&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span>{</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<a class="code" href="saxbospiral_8h.html#aaf3547c499b3c2c5909819d6790533e7">sxbp_status_t</a> <a class="code" href="backend__pbm_8h.html#a5d36e5bbb54b1d681b8d1cf8beb3c96d">sxbp_render_backend_pbm</a>(</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <a class="code" href="structsxbp__bitmap__t.html">sxbp_bitmap_t</a> bitmap, <a class="code" href="structsxbp__buffer__t.html">sxbp_buffer_t</a>* buffer</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;);</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;} <span class="comment">// extern &quot;C&quot;</span></div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">// end of header file</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="backend__pbm_8h_html_a5d36e5bbb54b1d681b8d1cf8beb3c96d"><div class="ttname"><a href="backend__pbm_8h.html#a5d36e5bbb54b1d681b8d1cf8beb3c96d">sxbp_render_backend_pbm</a></div><div class="ttdeci">sxbp_status_t sxbp_render_backend_pbm(sxbp_bitmap_t bitmap, sxbp_buffer_t *buffer)</div><div class="ttdoc">Renders a bitmap image to a PBM image. </div><div class="ttdef"><b>Definition:</b> backend_pbm.c:29</div></div>
 <div class="ttc" id="structsxbp__bitmap__t_html"><div class="ttname"><a href="structsxbp__bitmap__t.html">sxbp_bitmap_t</a></div><div class="ttdoc">Used to represent a basic 1-bit, pure black/white bitmap image. </div><div class="ttdef"><b>Definition:</b> render.h:40</div></div>
-<div class="ttc" id="structsxbp__buffer__t_html"><div class="ttname"><a href="structsxbp__buffer__t.html">sxbp_buffer_t</a></div><div class="ttdoc">A simple buffer type for storing arrays of bytes. </div><div class="ttdef"><b>Definition:</b> saxbospiral.h:217</div></div>
-<div class="ttc" id="saxbospiral_8h_html_aaf3547c499b3c2c5909819d6790533e7"><div class="ttname"><a href="saxbospiral_8h.html#aaf3547c499b3c2c5909819d6790533e7">sxbp_status_t</a></div><div class="ttdeci">sxbp_status_t</div><div class="ttdoc">Represents the success or failure status of an executed function. </div><div class="ttdef"><b>Definition:</b> saxbospiral.h:86</div></div>
+<div class="ttc" id="structsxbp__buffer__t_html"><div class="ttname"><a href="structsxbp__buffer__t.html">sxbp_buffer_t</a></div><div class="ttdoc">A simple buffer type for storing arrays of bytes. </div><div class="ttdef"><b>Definition:</b> saxbospiral.h:236</div></div>
+<div class="ttc" id="saxbospiral_8h_html_aaf3547c499b3c2c5909819d6790533e7"><div class="ttname"><a href="saxbospiral_8h.html#aaf3547c499b3c2c5909819d6790533e7">sxbp_status_t</a></div><div class="ttdeci">sxbp_status_t</div><div class="ttdoc">Represents the success or failure status of an executed function. </div><div class="ttdef"><b>Definition:</b> saxbospiral.h:87</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/backend__png_8h.html

@@ -25,7 +25,7 @@
   <td id="projectlogo"><img alt="Logo" src="libsxbp.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">libsxbp
-   &#160;<span id="projectnumber">v0.26</span>
+   &#160;<span id="projectnumber">v0.27</span>
    </div>
    <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div>
   </td>
@@ -106,8 +106,8 @@
 <div class="dyncontent">
 <div class="center"><img src="backend__png_8h__incl.png" border="0" usemap="#sxbp_2render__backends_2backend__png_8h" alt=""/></div>
 <map name="sxbp_2render__backends_2backend__png_8h" id="sxbp_2render__backends_2backend__png_8h">
-<area shape="rect" id="node3" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="6,169,117,196"/>
-<area shape="rect" id="node6" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="114,95,195,121"/>
+<area shape="rect" id="node3" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="131,169,242,196"/>
+<area shape="rect" id="node7" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="146,95,227,121"/>
 </map>
 </div>
 </div>

docs/backend__png_8h__incl.map

@@ -1,4 +1,4 @@
 <map id="sxbp/render_backends/backend_png.h" name="sxbp/render_backends/backend_png.h">
-<area shape="rect" id="node3" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="6,169,117,196"/>
-<area shape="rect" id="node6" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="114,95,195,121"/>
+<area shape="rect" id="node3" href="$saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="131,169,242,196"/>
+<area shape="rect" id="node7" href="$render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="146,95,227,121"/>
 </map>

docs/backend__png_8h__incl.md5

@@ -1 +1 @@
-345ff278d8996f4f2b0d5ace273373ba
+77f8ac611d6e68ce7a6a2277ccf1bec7