diff options
Diffstat (limited to 'apidocs/icalmemory_8c.html')
| -rw-r--r-- | apidocs/icalmemory_8c.html | 362 |
1 files changed, 362 insertions, 0 deletions
diff --git a/apidocs/icalmemory_8c.html b/apidocs/icalmemory_8c.html new file mode 100644 index 00000000..1f5eeb62 --- /dev/null +++ b/apidocs/icalmemory_8c.html @@ -0,0 +1,362 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<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.3.1"/> +<title>Libical: 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Libical +  <span id="projectnumber">1.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<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> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <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> + <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 <stdio.h></code><br/> +<code>#include <stdlib.h></code><br/> +<code>#include <string.h></code><br/> +</div><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> +<tr class="separator:"><td class="memSeparator" colspan="2"> </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="separator:af3bf1c77cd63373bfec5de0ab595c0da"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8226f1c74c3bed4b20cde9b7df5d91e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8226f1c74c3bed4b20cde9b7df5d91e"></a> +#define </td><td class="memItemRight" valign="bottom"><b>ICALMEMORY_C</b></td></tr> +<tr class="separator:ad8226f1c74c3bed4b20cde9b7df5d91e"><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="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="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="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="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="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="separator:a2a5f97e68688bcaac234db8fc9e4b240"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afecc2d4e9c78dbd0fa87595af2f6aca4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalmemory_8c.html#afecc2d4e9c78dbd0fa87595af2f6aca4">icalmemory_free_ring_byval</a> (<a class="el" href="structbuffer__ring.html">buffer_ring</a> *br)</td></tr> +<tr class="separator:afecc2d4e9c78dbd0fa87595af2f6aca4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6ece01cccd3aa21f21d1a040f6ad51a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ece01cccd3aa21f21d1a040f6ad51a4"></a> +void </td><td class="memItemRight" valign="bottom"><b>icalmemory_free_tmp_buffer</b> (void *buf)</td></tr> +<tr class="separator:a6ece01cccd3aa21f21d1a040f6ad51a4"><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="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="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="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="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="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> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_add_tmp_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>Add an existing buffer to the buffer ring </p> + +</div> +</div> +<a class="anchor" id="addac122edb16bc41a193895c86bd5ff5"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_append_char </td> + <td>(</td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t * </td> + <td class="paramname"><em>buf_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char </td> + <td class="paramname"><em>ch</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>icalmemory_append_char is similar, but is appends a character instead of a string </p> + +</div> +</div> +<a class="anchor" id="a647bf5dab81fc5b83a0ed8f8ad769ea6"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_append_string </td> + <td>(</td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>buf</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>pos</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">size_t * </td> + <td class="paramname"><em>buf_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>string</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></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> + +</div> +</div> +<a class="anchor" id="a2a5f97e68688bcaac234db8fc9e4b240"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_free_ring </td> + <td>(</td> + <td class="paramtype">void </td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Free all memory used in the ring </p> + +</div> +</div> +<a class="anchor" id="afecc2d4e9c78dbd0fa87595af2f6aca4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalmemory_free_ring_byval </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></td> + </tr> + </table> +</div><div class="memdoc"> +<p>get rid of this buffer ring </p> + +</div> +</div> +<a class="anchor" id="aeae6b906a9fcba61eb725d060361b180"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* icalmemory_strdup </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>s</em></td><td>)</td> + <td></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> + +</div> +</div> +<a class="anchor" id="ad73fe2ed5791e8d4d4513b1e23f7b86e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* icalmemory_tmp_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>Create a new temporary buffer on the ring. Libical owns these and will deallocate them. </p> + +</div> +</div> +<a class="anchor" id="a3f5eccaa6b37d176a970b7d3a9f7aa66"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* icalmemory_tmp_copy </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Like strdup, but the buffer is on the ring. </p> + +</div> +</div> +</div><!-- contents --> +<!-- start footer part --> +<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.3.1 +</small></address> +</body> +</html> |