diff options
Diffstat (limited to 'apidocs/icalparser_8h.html')
| -rw-r--r-- | apidocs/icalparser_8h.html | 287 |
1 files changed, 287 insertions, 0 deletions
diff --git a/apidocs/icalparser_8h.html b/apidocs/icalparser_8h.html new file mode 100644 index 00000000..d6d0e3c3 --- /dev/null +++ b/apidocs/icalparser_8h.html @@ -0,0 +1,287 @@ +<!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: icalparser.h 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="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">icalparser.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Line-oriented parsing. +<a href="#details">More...</a></p> +<div class="textblock"><code>#include "icalenums.h"</code><br/> +<code>#include "icaltypes.h"</code><br/> +<code>#include "icalcomponent.h"</code><br/> +<code>#include <stdio.h></code><br/> +</div> +<p><a href="icalparser_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a268240cde8363f3f669ff87d4a40a5d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a268240cde8363f3f669ff87d4a40a5d4"></a> +typedef struct <a class="el" href="structicalparser__impl.html">icalparser_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalparser</b></td></tr> +<tr class="separator:a268240cde8363f3f669ff87d4a40a5d4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5afd4208f14438ea171119a3d20f4875"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5afd4208f14438ea171119a3d20f4875"></a> +typedef enum icalparser_state </td><td class="memItemRight" valign="bottom"><b>icalparser_state</b></td></tr> +<tr class="separator:a5afd4208f14438ea171119a3d20f4875"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:aeec42cd09dd789c699d7b6741cbec3e7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>icalparser_state</b> { <br/> +  <b>ICALPARSER_ERROR</b>, +<b>ICALPARSER_SUCCESS</b>, +<b>ICALPARSER_BEGIN_COMP</b>, +<b>ICALPARSER_END_COMP</b>, +<br/> +  <b>ICALPARSER_IN_PROGRESS</b> +<br/> + }</td></tr> +<tr class="separator:aeec42cd09dd789c699d7b6741cbec3e7"><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:a1138735cde70554bcdfc17dc8a595a6a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1138735cde70554bcdfc17dc8a595a6a"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalparser_add_line</b> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, char *str)</td></tr> +<tr class="separator:a1138735cde70554bcdfc17dc8a595a6a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa184343e374e5a201d8079df827597b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa184343e374e5a201d8079df827597b2"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalparser_clean</b> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> +<tr class="separator:aa184343e374e5a201d8079df827597b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cb8b8678b781d3d2ede0fbce613b90d"></a> +void </td><td class="memItemRight" valign="bottom"><b>icalparser_free</b> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> +<tr class="separator:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a42de1b41c738ef5fb56cafe2a0453f6c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a42de1b41c738ef5fb56cafe2a0453f6c">icalparser_get_line</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, char *(*line_gen_func)(char *s, size_t size, void *d))</td></tr> +<tr class="separator:a42de1b41c738ef5fb56cafe2a0453f6c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a27d19ac53219bb65aeb9a031dbf027"></a> +icalparser_state </td><td class="memItemRight" valign="bottom"><b>icalparser_get_state</b> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> +<tr class="separator:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3a7a45307a9ff90ec23d632501c0bd00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a7a45307a9ff90ec23d632501c0bd00"></a> +<a class="el" href="structicalparser__impl.html">icalparser</a> * </td><td class="memItemRight" valign="bottom"><b>icalparser_new</b> (void)</td></tr> +<tr class="separator:a3a7a45307a9ff90ec23d632501c0bd00"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a089ac94c0ce97aa60dcb0b52031b0c05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a089ac94c0ce97aa60dcb0b52031b0c05">icalparser_parse</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, char *(*line_gen_func)(char *s, size_t size, void *d))</td></tr> +<tr class="separator:a089ac94c0ce97aa60dcb0b52031b0c05"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a966f6fd4bc931c06b2c596daeadb692f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a966f6fd4bc931c06b2c596daeadb692f"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><b>icalparser_parse_string</b> (const char *str)</td></tr> +<tr class="separator:a966f6fd4bc931c06b2c596daeadb692f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae5f61c9ad479bf4f2867d586000b8853"><td class="memItemLeft" align="right" valign="top">icalvalue * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#ae5f61c9ad479bf4f2867d586000b8853">icalparser_parse_value</a> (icalvalue_kind kind, const char *str, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> **errors)</td></tr> +<tr class="separator:ae5f61c9ad479bf4f2867d586000b8853"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aae6d08b4084610e225621a25dddd7689"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, void *data)</td></tr> +<tr class="separator:aae6d08b4084610e225621a25dddd7689"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7c0eb0a99b21f94b4d5009cd660382e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c0eb0a99b21f94b4d5009cd660382e7"></a> +char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_line_generator</b> (char *out, size_t buf_size, void *d)</td></tr> +<tr class="separator:a7c0eb0a99b21f94b4d5009cd660382e7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Line-oriented parsing. </p> +<p>Create a new parser via icalparse_new_parser, then add lines one at a time with icalparse_add_line(). icalparser_add_line() will return non-zero when it has finished with a component. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="a42de1b41c738ef5fb56cafe2a0453f6c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* icalparser_get_line </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> + <td class="paramname"><em>parser</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char *(*)(char *s, size_t size, void *d) </td> + <td class="paramname"><em>line_gen_func</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Given a line generator function, return a single iCal content line.</p> +<p>Get a single property line, from the property name through the final new line, and include any continuation lines </p> + +</div> +</div> +<a class="anchor" id="a089ac94c0ce97aa60dcb0b52031b0c05"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalparser_parse </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> + <td class="paramname"><em>parser</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char *(*)(char *s, size_t size, void *d) </td> + <td class="paramname"><em>line_gen_func</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Message oriented parsing. icalparser_parse takes a string that holds the text ( in RFC 2445 format ) and returns a pointer to an icalcomponent. The caller owns the memory. line_gen_func is a pointer to a function that returns one content line per invocation </p> + +</div> +</div> +<a class="anchor" id="ae5f61c9ad479bf4f2867d586000b8853"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">icalvalue* icalparser_parse_value </td> + <td>(</td> + <td class="paramtype">icalvalue_kind </td> + <td class="paramname"><em>kind</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> ** </td> + <td class="paramname"><em>errors</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Use the flex/bison parser to turn a string into a value type </p> + +</div> +</div> +<a class="anchor" id="aae6d08b4084610e225621a25dddd7689"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalparser_set_gen_data </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> + <td class="paramname"><em>parser</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Set the data that icalparser_parse will give to the line_gen_func as the parameter 'd' </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> |