diff options
Diffstat (limited to 'apidocs/icalmemory_8c.html')
| -rw-r--r-- | apidocs/icalmemory_8c.html | 340 |
1 files changed, 232 insertions, 108 deletions
diff --git a/apidocs/icalmemory_8c.html b/apidocs/icalmemory_8c.html index 89f9904a..66b3319d 100644 --- a/apidocs/icalmemory_8c.html +++ b/apidocs/icalmemory_8c.html @@ -3,17 +3,15 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.9.1"/> -<title>Libical: icalmemory.c File Reference</title> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: icalmemory.c File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> -<script type="text/javascript"> - $(document).ready(function() { init_search(); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -22,9 +20,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Libical -  <span id="projectnumber">2.0</span> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">2.99</span> </div> </td> </tr> @@ -32,40 +30,19 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.9.1 --> +<!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="pages.html"><span>Related Pages</span></a></li> - <li><a href="annotated.html"><span>Data Structures</span></a></li> - <li class="current"><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="files.html"><span>File List</span></a></li> - <li><a href="globals.html"><span>Globals</span></a></li> - </ul> - </div> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" @@ -89,19 +66,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <div class="summary"> <a href="#nested-classes">Data Structures</a> | <a href="#define-members">Macros</a> | -<a href="#func-members">Functions</a> | -<a href="#var-members">Variables</a> </div> +<a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">icalmemory.c File Reference</div> </div> </div><!--header--> <div class="contents"> - -<p>Common memory management routines. -<a href="#details">More...</a></p> -<div class="textblock"><code>#include "icalmemory.h"</code><br /> -<code>#include "icalerror.h"</code><br /> -<code>#include <stdlib.h></code><br /> -</div><table class="memberdecls"> +<table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbuffer__ring.html">buffer_ring</a></td></tr> @@ -109,62 +79,52 @@ Data Structures</h2></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:af3bf1c77cd63373bfec5de0ab595c0da"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af3bf1c77cd63373bfec5de0ab595c0da"></a> -#define </td><td class="memItemRight" valign="bottom"><b>BUFFER_RING_SIZE</b>   2500</td></tr> +<tr class="memitem:af3bf1c77cd63373bfec5de0ab595c0da"><td class="memItemLeft" align="right" valign="top"><a id="af3bf1c77cd63373bfec5de0ab595c0da"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#af3bf1c77cd63373bfec5de0ab595c0da">BUFFER_RING_SIZE</a>   2500</td></tr> +<tr class="memdesc:af3bf1c77cd63373bfec5de0ab595c0da"><td class="mdescLeft"> </td><td class="mdescRight">Determines the size of the ring buffer used for keeping track of temporary buffers. <br /></td></tr> <tr class="separator:af3bf1c77cd63373bfec5de0ab595c0da"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a01464ed9cb0292540d7e0fb3d16d3844"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01464ed9cb0292540d7e0fb3d16d3844"></a> -#define </td><td class="memItemRight" valign="bottom"><b>MIN_BUFFER_SIZE</b>   200</td></tr> +<tr class="memitem:a01464ed9cb0292540d7e0fb3d16d3844"><td class="memItemLeft" align="right" valign="top"><a id="a01464ed9cb0292540d7e0fb3d16d3844"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a01464ed9cb0292540d7e0fb3d16d3844">MIN_BUFFER_SIZE</a>   200</td></tr> +<tr class="memdesc:a01464ed9cb0292540d7e0fb3d16d3844"><td class="mdescLeft"> </td><td class="mdescRight">Determines the minimal size of buffers in the ring that are created with <a class="el" href="icalmemory_8c.html#ad73fe2ed5791e8d4d4513b1e23f7b86e" title="Creates a new temporary buffer on the ring and returns it. ">icalmemory_tmp_buffer()</a>. <br /></td></tr> <tr class="separator:a01464ed9cb0292540d7e0fb3d16d3844"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:a26290be94708a0fc437f158b360eff10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26290be94708a0fc437f158b360eff10"></a> -static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td><td class="memItemRight" valign="bottom"><b>buffer_ring_new</b> (void)</td></tr> -<tr class="separator:a26290be94708a0fc437f158b360eff10"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a97f18ec29746ae6fd42811d7ae3794ca"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97f18ec29746ae6fd42811d7ae3794ca"></a> -static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td><td class="memItemRight" valign="bottom"><b>get_buffer_ring</b> (void)</td></tr> -<tr class="separator:a97f18ec29746ae6fd42811d7ae3794ca"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7f9087b63cf34ab26bc917bd578896e4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f9087b63cf34ab26bc917bd578896e4"></a> -static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td><td class="memItemRight" valign="bottom"><b>get_buffer_ring_global</b> (void)</td></tr> -<tr class="separator:a7f9087b63cf34ab26bc917bd578896e4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9f1799733a1577748a028181098be48"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#ae9f1799733a1577748a028181098be48">icalmemory_add_tmp_buffer</a> (void *buf)</td></tr> +<tr class="memdesc:ae9f1799733a1577748a028181098be48"><td class="mdescLeft"> </td><td class="mdescRight">Add an externally allocated buffer to the ring. <a href="#ae9f1799733a1577748a028181098be48">More...</a><br /></td></tr> <tr class="separator:ae9f1799733a1577748a028181098be48"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:addac122edb16bc41a193895c86bd5ff5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#addac122edb16bc41a193895c86bd5ff5">icalmemory_append_char</a> (char **buf, char **pos, size_t *buf_size, char ch)</td></tr> +<tr class="memdesc:addac122edb16bc41a193895c86bd5ff5"><td class="mdescLeft"> </td><td class="mdescRight">Append a character to a buffer. <a href="#addac122edb16bc41a193895c86bd5ff5">More...</a><br /></td></tr> <tr class="separator:addac122edb16bc41a193895c86bd5ff5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a647bf5dab81fc5b83a0ed8f8ad769ea6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a647bf5dab81fc5b83a0ed8f8ad769ea6">icalmemory_append_string</a> (char **buf, char **pos, size_t *buf_size, const char *string)</td></tr> +<tr class="memdesc:a647bf5dab81fc5b83a0ed8f8ad769ea6"><td class="mdescLeft"> </td><td class="mdescRight">Append a string to a buffer. <a href="#a647bf5dab81fc5b83a0ed8f8ad769ea6">More...</a><br /></td></tr> <tr class="separator:a647bf5dab81fc5b83a0ed8f8ad769ea6"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2f164cb87c67f06b5dc04a5f21384879"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f164cb87c67f06b5dc04a5f21384879"></a> -void </td><td class="memItemRight" valign="bottom"><b>icalmemory_free_buffer</b> (void *buf)</td></tr> +<tr class="memitem:a2f164cb87c67f06b5dc04a5f21384879"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a> (void *buf)</td></tr> +<tr class="memdesc:a2f164cb87c67f06b5dc04a5f21384879"><td class="mdescLeft"> </td><td class="mdescRight">Releases a buffer. <a href="#a2f164cb87c67f06b5dc04a5f21384879">More...</a><br /></td></tr> <tr class="separator:a2f164cb87c67f06b5dc04a5f21384879"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a5f97e68688bcaac234db8fc9e4b240"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a2a5f97e68688bcaac234db8fc9e4b240">icalmemory_free_ring</a> ()</td></tr> +<tr class="memdesc:a2a5f97e68688bcaac234db8fc9e4b240"><td class="mdescLeft"> </td><td class="mdescRight">Free all memory used in the ring. <a href="#a2a5f97e68688bcaac234db8fc9e4b240">More...</a><br /></td></tr> <tr class="separator:a2a5f97e68688bcaac234db8fc9e4b240"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a3171598df5ffa8ff703bfcac4c90f830"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a3171598df5ffa8ff703bfcac4c90f830">icalmemory_free_ring_byval</a> (<a class="el" href="structbuffer__ring.html">buffer_ring</a> *br)</td></tr> -<tr class="separator:a3171598df5ffa8ff703bfcac4c90f830"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a44986d86c778125a313d423b70cd2b54"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44986d86c778125a313d423b70cd2b54"></a> -void * </td><td class="memItemRight" valign="bottom"><b>icalmemory_new_buffer</b> (size_t size)</td></tr> +<tr class="memitem:a44986d86c778125a313d423b70cd2b54"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a44986d86c778125a313d423b70cd2b54">icalmemory_new_buffer</a> (size_t size)</td></tr> +<tr class="memdesc:a44986d86c778125a313d423b70cd2b54"><td class="mdescLeft"> </td><td class="mdescRight">Creates new buffer with the specified size. <a href="#a44986d86c778125a313d423b70cd2b54">More...</a><br /></td></tr> <tr class="separator:a44986d86c778125a313d423b70cd2b54"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a4e657ee861bf1f00ed4e6eb03cd4a0a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e657ee861bf1f00ed4e6eb03cd4a0a5"></a> -void * </td><td class="memItemRight" valign="bottom"><b>icalmemory_resize_buffer</b> (void *buf, size_t size)</td></tr> +<tr class="memitem:a4e657ee861bf1f00ed4e6eb03cd4a0a5"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a4e657ee861bf1f00ed4e6eb03cd4a0a5">icalmemory_resize_buffer</a> (void *buf, size_t size)</td></tr> +<tr class="memdesc:a4e657ee861bf1f00ed4e6eb03cd4a0a5"><td class="mdescLeft"> </td><td class="mdescRight">Resizes a buffer created with <a class="el" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54" title="Creates new buffer with the specified size. ">icalmemory_new_buffer()</a>. <a href="#a4e657ee861bf1f00ed4e6eb03cd4a0a5">More...</a><br /></td></tr> <tr class="separator:a4e657ee861bf1f00ed4e6eb03cd4a0a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aeae6b906a9fcba61eb725d060361b180"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#aeae6b906a9fcba61eb725d060361b180">icalmemory_strdup</a> (const char *s)</td></tr> +<tr class="memdesc:aeae6b906a9fcba61eb725d060361b180"><td class="mdescLeft"> </td><td class="mdescRight">Create a duplicate of a string. <a href="#aeae6b906a9fcba61eb725d060361b180">More...</a><br /></td></tr> <tr class="separator:aeae6b906a9fcba61eb725d060361b180"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad73fe2ed5791e8d4d4513b1e23f7b86e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#ad73fe2ed5791e8d4d4513b1e23f7b86e">icalmemory_tmp_buffer</a> (size_t size)</td></tr> +<tr class="memdesc:ad73fe2ed5791e8d4d4513b1e23f7b86e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new temporary buffer on the ring and returns it. <a href="#ad73fe2ed5791e8d4d4513b1e23f7b86e">More...</a><br /></td></tr> <tr class="separator:ad73fe2ed5791e8d4d4513b1e23f7b86e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f5eccaa6b37d176a970b7d3a9f7aa66"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#a3f5eccaa6b37d176a970b7d3a9f7aa66">icalmemory_tmp_copy</a> (const char *str)</td></tr> +<tr class="memdesc:a3f5eccaa6b37d176a970b7d3a9f7aa66"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of the given string, stored on the ring buffer, and returns it. <a href="#a3f5eccaa6b37d176a970b7d3a9f7aa66">More...</a><br /></td></tr> <tr class="separator:a3f5eccaa6b37d176a970b7d3a9f7aa66"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> -Variables</h2></td></tr> -<tr class="memitem:a25a694130112f5d3c6c5010e2e260365"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25a694130112f5d3c6c5010e2e260365"></a> -static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td><td class="memItemRight" valign="bottom"><b>global_buffer_ring</b> = 0</td></tr> -<tr class="separator:a25a694130112f5d3c6c5010e2e260365"><td class="memSeparator" colspan="2"> </td></tr> </table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Common memory management routines. </p> -<p>libical often passes strings back to the caller. To make these interfaces simple, I did not want the caller to have to pass in a memory buffer, but having libical pass out newly allocated memory makes it difficult to de-allocate the memory.</p> -<p>The ring buffer in this scheme makes it possible for libical to pass out references to memory which the caller does not own, and be able to de-allocate the memory later. The ring allows libical to have several buffers active simultaneously, which is handy when creating string representations of components. </p> -</div><h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="ae9f1799733a1577748a028181098be48"></a> +<h2 class="groupheader">Function Documentation</h2> +<a id="ae9f1799733a1577748a028181098be48"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae9f1799733a1577748a028181098be48">◆ </a></span>icalmemory_add_tmp_buffer()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -177,11 +137,24 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>Add an existing buffer to the buffer ring </p> +<p>Add an externally allocated buffer to the ring. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>The externally allocated buffer to add to the ring</td></tr> + </table> + </dd> +</dl> +<p>Adds an externally allocated buffer to the ring. This ensures that libical will <code>free()</code> the buffer automatically, either after <a class="el" href="icalmemory_8c.html#af3bf1c77cd63373bfec5de0ab595c0da" title="Determines the size of the ring buffer used for keeping track of temporary buffers. ">BUFFER_RING_SIZE</a> other buffers have been created or added, or after <a class="el" href="icalmemory_8h.html#a175daa67f089bae6aefd4360fcd0d664" title="Free all memory used in the ring. ">icalmemory_free_ring()</a> has been called.</p> +<dl class="section user"><dt>Error handling</dt><dd>No error is raised if <em>buf</em> is <code>NULL</code>.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>After adding <em>buf</em> to the ring, it becomes owned by icalmemory and must not be <code>free()</code>d manually anymore, it leads to a double-<code>free()</code> when icalmemory reclaims the memory.</dd></dl> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="keywordtype">char</span> *buf = calloc(256, <span class="keyword">sizeof</span>(<span class="keywordtype">char</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalmemory_8h.html#ae9f1799733a1577748a028181098be48">icalmemory_add_tmp_buffer</a>(buf);</div></div><!-- fragment --> </div> </div> -<a class="anchor" id="addac122edb16bc41a193895c86bd5ff5"></a> +<a id="addac122edb16bc41a193895c86bd5ff5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#addac122edb16bc41a193895c86bd5ff5">◆ </a></span>icalmemory_append_char()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -216,11 +189,26 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>icalmemory_append_char is similar, but is appends a character instead of a string </p> +<p>Append a character to a buffer. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>The buffer to append the character to. </td></tr> + <tr><td class="paramname">pos</td><td>The position to append the character at. </td></tr> + <tr><td class="paramname">buf_size</td><td>The size of the buffer (will be changed if buffer is reallocated) </td></tr> + <tr><td class="paramname">ch</td><td>The character to append to the buffer. This method may not be used for temporary buffers (buffers allocated with <a class="el" href="icalmemory_8h.html#ad73fe2ed5791e8d4d4513b1e23f7b86e" title="Creates a new temporary buffer on the ring and returns it. ">icalmemory_tmp_buffer()</a> and related functions)!</td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Error handling</dt><dd>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> if <em>buf</em>, <code>*buf</code>, <em>pos</em>, <code>* pos</code>, or <em>buf_size</em> <code>NULL</code>.</dd></dl> +<p>This method will copy the character <em>ch</em> and a `'\0'` character after it to the buffer <em>buf</em> starting at position <em>pos</em>, reallocing <em>buf</em> if it is too small. <em>buf_size</em> is the size of <em>buf</em> and will be changed if <em>buf</em> is reallocated. <em>pos</em> will point to the new terminating `'\0'` character <em>buf</em>.</p> +<h3>Example</h3> +<div class="fragment"><div class="line"><span class="comment">// creates a new buffer</span></div><div class="line"><span class="keywordtype">int</span> buffer_len = 15;</div><div class="line"><span class="keywordtype">char</span> *buffer = <a class="code" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54">icalmemory_new_buffer</a>(buffer_len);</div><div class="line">strcpy(buffer, <span class="stringliteral">"My number is: "</span>);</div><div class="line"></div><div class="line"><span class="comment">// append a char to the buffer</span></div><div class="line"><span class="keywordtype">int</span> buffer_end = strlen(buffer);</div><div class="line"><span class="keywordtype">char</span> *buffer_end_pos = buffer[buffer_str_end];</div><div class="line"><a class="code" href="icalmemory_8h.html#addac122edb16bc41a193895c86bd5ff5">icalmemory_append_char</a>(&buffer, &buffer_end_pos, &buffer_len, <span class="charliteral">'7'</span>);</div><div class="line"></div><div class="line"><span class="comment">// print string</span></div><div class="line">printf(<span class="stringliteral">"%s\n"</span>, buffer);</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(buffer);</div></div><!-- fragment --> </div> </div> -<a class="anchor" id="a647bf5dab81fc5b83a0ed8f8ad769ea6"></a> +<a id="a647bf5dab81fc5b83a0ed8f8ad769ea6"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a647bf5dab81fc5b83a0ed8f8ad769ea6">◆ </a></span>icalmemory_append_string()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -255,11 +243,54 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>icalmemory_append_string will copy the string 'string' to the buffer 'buf' starting at position 'pos', reallocing 'buf' if it is too small. 'buf_size' is the size of 'buf' and will be changed if 'buf' is reallocated. 'pos' will point to the last byte of the new string in 'buf', usually a '\0' </p> + +<p>Append a string to a buffer. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>The buffer to append the string to. </td></tr> + <tr><td class="paramname">pos</td><td>The position to append the string at. </td></tr> + <tr><td class="paramname">buf_size</td><td>The size of the buffer (will be changed if buffer is reallocated) </td></tr> + <tr><td class="paramname">string</td><td>The string to append to the buffer. This method may not be used for temporary buffers (buffers allocated with <a class="el" href="icalmemory_8h.html#ad73fe2ed5791e8d4d4513b1e23f7b86e" title="Creates a new temporary buffer on the ring and returns it. ">icalmemory_tmp_buffer()</a> and related functions)!</td></tr> + </table> + </dd> +</dl> +<dl class="section user"><dt>Error handling</dt><dd>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> if <em>buf</em>, <code>*buf</code>, <em>pos</em>, <code>* pos</code>, <em>buf_size</em> or <em>string</em> are <code>NULL</code>.</dd></dl> +<p>This method will copy the string <em>string</em> to the buffer <em>buf</em> starting at position <em>pos</em>, reallocing <em>buf</em> if it is too small. <em>buf_size</em> is the size of <em>buf</em> and will be changed if <em>buf</em> is reallocated. <em>pos</em> will point to the last byte of the new string in <em>buf</em>, usually a `'\0'`</p> +<h3>Example</h3> +<div class="fragment"><div class="line"><span class="comment">// creates a new buffer</span></div><div class="line"><span class="keywordtype">int</span> buffer_len = 15;</div><div class="line"><span class="keywordtype">char</span> *buffer = <a class="code" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54">icalmemory_new_buffer</a>(buffer_len);</div><div class="line">strcpy(buffer, <span class="stringliteral">"My name is: "</span>);</div><div class="line"></div><div class="line"><span class="comment">// append a string to the buffer</span></div><div class="line"><span class="keywordtype">int</span> buffer_end = strlen(buffer);</div><div class="line"><span class="keywordtype">char</span> *buffer_end_pos = buffer[buffer_str_end];</div><div class="line"><a class="code" href="icalmemory_8h.html#a647bf5dab81fc5b83a0ed8f8ad769ea6">icalmemory_append_string</a>(&buffer, &buffer_end_pos, &buffer_len, <span class="stringliteral">"John Doe"</span>);</div><div class="line"></div><div class="line"><span class="comment">// print string</span></div><div class="line">printf(<span class="stringliteral">"%s\n"</span>, buffer);</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(buffer);</div></div><!-- fragment --> +</div> +</div> +<a id="a2f164cb87c67f06b5dc04a5f21384879"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2f164cb87c67f06b5dc04a5f21384879">◆ </a></span>icalmemory_free_buffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_free_buffer </td> + <td>(</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>buf</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Releases a buffer. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>The buffer to release </td></tr> + </table> + </dd> +</dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54" title="Creates new buffer with the specified size. ">icalmemory_new_buffer()</a></dd></dl> +<p>Releases the memory of the buffer. </p> </div> </div> -<a class="anchor" id="a2a5f97e68688bcaac234db8fc9e4b240"></a> +<a id="a2a5f97e68688bcaac234db8fc9e4b240"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2a5f97e68688bcaac234db8fc9e4b240">◆ </a></span>icalmemory_free_ring()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -272,36 +303,90 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>Free all memory used in the ring </p> +<p>Free all memory used in the ring. </p> +<p>Frees all memory used in the ring. Depending on if ::HAVE_PTHREAD is set or not, the ring buffer is allocated on a per-thread basis, meaning that if all rings are to be released, it must be called once in every thread.</p> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="keywordtype">void</span> *buf = <a class="code" href="icalmemory_8h.html#ad73fe2ed5791e8d4d4513b1e23f7b86e">icalmemory_tmp_buffer</a>(256);</div><div class="line"></div><div class="line"><span class="comment">// use buf</span></div><div class="line"></div><div class="line"><span class="comment">// release buf and all other memory in the ring buffer</span></div><div class="line"><a class="code" href="icalmemory_8h.html#a175daa67f089bae6aefd4360fcd0d664">icalmemory_free_ring</a>();</div></div><!-- fragment --> +</div> +</div> +<a id="a44986d86c778125a313d423b70cd2b54"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a44986d86c778125a313d423b70cd2b54">◆ </a></span>icalmemory_new_buffer()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* icalmemory_new_buffer </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates new buffer with the specified size. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">size</td><td>The size of the buffer that is to be created. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the newly-created buffer. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879" title="Releases a buffer. ">icalmemory_free_buffer()</a></dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>If there is a problem allocating memory, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a> and returns <code>NULL</code>.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>Buffers created with this method are owned by the caller. The must be released with the appropriate <a class="el" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879" title="Releases a buffer. ">icalmemory_free_buffer()</a> method.</dd></dl> +<p>This creates a new (non-temporary) buffer of the specified <em>size</em>. All buffers returned by this method are zeroed-out.</p> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="comment">// create buffer</span></div><div class="line"><span class="keywordtype">char</span> *buffer = <a class="code" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54">icalmemory_new_buffer</a>(50);</div><div class="line"></div><div class="line"><span class="comment">// fill buffer</span></div><div class="line">strcpy(buffer, <span class="stringliteral">"some data"</span>);</div><div class="line"></div><div class="line"><span class="comment">// release buffer</span></div><div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(buffer);</div></div><!-- fragment --> </div> </div> -<a class="anchor" id="a3171598df5ffa8ff703bfcac4c90f830"></a> +<a id="a4e657ee861bf1f00ed4e6eb03cd4a0a5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e657ee861bf1f00ed4e6eb03cd4a0a5">◆ </a></span>icalmemory_resize_buffer()</h2> + <div class="memitem"> <div class="memproto"> -<table class="mlabels"> - <tr> - <td class="mlabels-left"> <table class="memname"> <tr> - <td class="memname">static void icalmemory_free_ring_byval </td> + <td class="memname">void* icalmemory_resize_buffer </td> <td>(</td> - <td class="paramtype"><a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> - <td class="paramname"><em>br</em></td><td>)</td> + <td class="paramtype">void * </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> - </td> - <td class="mlabels-right"> -<span class="mlabels"><span class="mlabel">static</span></span> </td> - </tr> -</table> </div><div class="memdoc"> -<p>get rid of this buffer ring </p> +<p>Resizes a buffer created with <a class="el" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54" title="Creates new buffer with the specified size. ">icalmemory_new_buffer()</a>. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">buf</td><td>The buffer to be resized. </td></tr> + <tr><td class="paramname">size</td><td>The new size of the buffer. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The new, resized buffer. </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54" title="Creates new buffer with the specified size. ">icalmemory_new_buffer()</a> This method may not be used for temporary buffers (buffers allocated with <a class="el" href="icalmemory_8h.html#ad73fe2ed5791e8d4d4513b1e23f7b86e" title="Creates a new temporary buffer on the ring and returns it. ">icalmemory_tmp_buffer()</a> and related functions)!</dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>If there is a problem while reallocating the buffer, the method sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a> and returns <code>NULL</code>.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>The returned buffer is owned by the caller and needs to be released with the appropriate <a class="el" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879" title="Releases a buffer. ">icalmemory_free_buffer()</a> method. The old buffer, <em>buf</em>, can not be used anymore after calling this method.</dd></dl> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="comment">// create new buffer</span></div><div class="line"><span class="keywordtype">char</span> *buffer = <a class="code" href="icalmemory_8h.html#a44986d86c778125a313d423b70cd2b54">icalmemory_new_buffer</a>(10);</div><div class="line"></div><div class="line"><span class="comment">// fill buffer</span></div><div class="line">strcpy(buffer, <span class="stringliteral">"some data"</span>);</div><div class="line"></div><div class="line"><span class="comment">// expand buffer</span></div><div class="line">buffer = <a class="code" href="icalmemory_8h.html#a4e657ee861bf1f00ed4e6eb03cd4a0a5">icalmemory_resize_buffer</a>(buffer, 20);</div><div class="line"></div><div class="line"><span class="comment">// fill with more data</span></div><div class="line">strcpy(buffer, <span class="stringliteral">"a lot more data"</span>);</div><div class="line"></div><div class="line"><span class="comment">// release</span></div><div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(buffer);</div></div><!-- fragment --> </div> </div> -<a class="anchor" id="aeae6b906a9fcba61eb725d060361b180"></a> +<a id="aeae6b906a9fcba61eb725d060361b180"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aeae6b906a9fcba61eb725d060361b180">◆ </a></span>icalmemory_strdup()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -314,11 +399,25 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims that strdup is undeclared </p> +<p>Create a duplicate of a string. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>The string to duplicate. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to a string containing the same data as <em>s</em> </dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>The string <em>s</em> must not be <code>NULL</code>, otherwise depending on the <code>libc</code> used, it might lead to undefined behaviour (read: segfaults).</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>The returned string is owned by the caller and needs to be released with the appropriate <code>free()</code> method.</dd></dl> +<p>A wrapper around <code>strdup()</code>. Partly to trap calls to <code>strdup()</code>, partly because in <code>-ansi</code>, <code>gcc</code> on Red Hat claims that <code>strdup()</code> is undeclared.</p> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *my_str = <span class="stringliteral">"LibIcal"</span>;</div><div class="line"><span class="keywordtype">char</span> *dup = <a class="code" href="icalmemory_8h.html#aeae6b906a9fcba61eb725d060361b180">icalmemory_strdup</a>(my_str);</div><div class="line">printf(<span class="stringliteral">"%s\n"</span>, dup);</div><div class="line">free(dup);</div></div><!-- fragment --> </div> </div> -<a class="anchor" id="ad73fe2ed5791e8d4d4513b1e23f7b86e"></a> +<a id="ad73fe2ed5791e8d4d4513b1e23f7b86e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ad73fe2ed5791e8d4d4513b1e23f7b86e">◆ </a></span>icalmemory_tmp_buffer()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -331,11 +430,25 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>Create a new temporary buffer on the ring. Libical owns these and will deallocate them. </p> +<p>Creates a new temporary buffer on the ring and returns it. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">size</td><td>How big (in bytes) the buffer should be </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to the newly created buffer on the ring</dd></dl> +<p>Creates a temporary buffer on the ring. Regardless of what <em>size</em> you specify, the buffer will always be at least <a class="el" href="icalmemory_8c.html#a01464ed9cb0292540d7e0fb3d16d3844" title="Determines the minimal size of buffers in the ring that are created with icalmemory_tmp_buffer(). ">MIN_BUFFER_SIZE</a> big, and it will be zeroed out.</p> +<dl class="section user"><dt>Error handling</dt><dd>If there is a problem allocating memory for the buffer, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a> and returns <code>NULL</code>.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>The returned buffer is owned by icalmemory. It must not be freed by the caller and the returned memory will be automatically reclaimed as more items are added to the ring buffer.</dd></dl> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="keywordtype">char</span> *str = <a class="code" href="icalmemory_8h.html#ad73fe2ed5791e8d4d4513b1e23f7b86e">icalmemory_tmp_buffer</a>(256);</div><div class="line">strcpy(str, <span class="stringliteral">"some data"</span>);</div><div class="line"></div><div class="line"><span class="comment">// use str</span></div></div><!-- fragment --> </div> </div> -<a class="anchor" id="a3f5eccaa6b37d176a970b7d3a9f7aa66"></a> +<a id="a3f5eccaa6b37d176a970b7d3a9f7aa66"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3f5eccaa6b37d176a970b7d3a9f7aa66">◆ </a></span>icalmemory_tmp_copy()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -348,8 +461,19 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> </tr> </table> </div><div class="memdoc"> -<p>Like strdup, but the buffer is on the ring. </p> +<p>Creates a copy of the given string, stored on the ring buffer, and returns it. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>The string to copy </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A copy of <em>str</em>, which has been placed on the ring buffer for automatic reclamation.</dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>The passed string <em>str</em> must not be <code>NULL</code>, otherwise a segfault might ensue, since the routine calls <code>strlen()</code> on it.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>The returned string is owned by icalmemory. It must not be freed by the caller, and it will be automatically reclaimed as more items are added to the buffer.</dd></dl> +<h3>Usage</h3> +<div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *str = <span class="stringliteral">"Example string"</span>;</div><div class="line"><span class="keywordtype">char</span> *tmp_copy = <a class="code" href="icalmemory_8h.html#a3f5eccaa6b37d176a970b7d3a9f7aa66">icalmemory_tmp_copy</a>(str);</div></div><!-- fragment --> </div> </div> </div><!-- contents --> @@ -357,7 +481,7 @@ static <a class="el" href="structbuffer__ring.html">buffer_ring</a> * </td> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.9.1 +</a> 1.8.13 </small></address> </body> </html> |