diff options
Diffstat (limited to 'apidocs/icalparser_8h.html')
| -rw-r--r-- | apidocs/icalparser_8h.html | 112 |
1 files changed, 50 insertions, 62 deletions
diff --git a/apidocs/icalparser_8h.html b/apidocs/icalparser_8h.html index 5894878a..bf5eefa4 100644 --- a/apidocs/icalparser_8h.html +++ b/apidocs/icalparser_8h.html @@ -21,7 +21,7 @@ <tbody> <tr id="projectrow"> <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.0</span> + <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> </div> </td> </tr> @@ -81,56 +81,62 @@ $(function() { <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a> Typedefs</h2></td></tr> -<tr class="memitem:a9332da05cc4922f68ae2b07f442c06fa"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structicalparser__impl.html">icalparser_impl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a></td></tr> -<tr class="separator:a9332da05cc4922f68ae2b07f442c06fa"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a268240cde8363f3f669ff87d4a40a5d4"><td class="memItemLeft" align="right" valign="top"><a id="a268240cde8363f3f669ff87d4a40a5d4" name="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:a69220c4ae4e2d8b576334ac8049f6a32"><td class="memItemLeft" align="right" valign="top"><a id="a69220c4ae4e2d8b576334ac8049f6a32" name="a69220c4ae4e2d8b576334ac8049f6a32"></a> typedef char *(* </td><td class="memItemRight" valign="bottom"><b>icalparser_line_gen_func</b>) (char *s, size_t size, void *d)</td></tr> <tr class="separator:a69220c4ae4e2d8b576334ac8049f6a32"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af8b34b2ce5d2982022e34e8a0ef32be0"><td class="memItemLeft" align="right" valign="top"><a id="af8b34b2ce5d2982022e34e8a0ef32be0" name="af8b34b2ce5d2982022e34e8a0ef32be0"></a> -typedef enum <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> </td><td class="memItemRight" valign="bottom"><b>icalparser_state</b></td></tr> +typedef enum icalparser_state </td><td class="memItemRight" valign="bottom"><b>icalparser_state</b></td></tr> <tr class="separator:af8b34b2ce5d2982022e34e8a0ef32be0"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" 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"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> { <br /> -  <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> +  <a class="el" href="ical_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> +, <a class="el" href="ical_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090">ICALPARSER_SUCCESS</a> +, <a class="el" href="ical_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e">ICALPARSER_BEGIN_COMP</a> +, <a class="el" href="ical_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2">ICALPARSER_END_COMP</a> +, <br /> +  <a class="el" href="ical_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2">ICALPARSER_IN_PROGRESS</a> +, <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> , <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090">ICALPARSER_SUCCESS</a> , <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e">ICALPARSER_BEGIN_COMP</a> -, <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2">ICALPARSER_END_COMP</a> , <br /> -  <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2">ICALPARSER_IN_PROGRESS</a> +  <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2">ICALPARSER_END_COMP</a> +, <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2">ICALPARSER_IN_PROGRESS</a> <br /> }</td></tr> -<tr class="memdesc:aeec42cd09dd789c699d7b6741cbec3e7"><td class="mdescLeft"> </td><td class="mdescRight">Represents the current state of the parser. <a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">More...</a><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 id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:a987113ea951dc55e37a764af168caaca"><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#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, char *str)</td></tr> +<tr class="memitem:a987113ea951dc55e37a764af168caaca"><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#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, char *str)</td></tr> <tr class="memdesc:a987113ea951dc55e37a764af168caaca"><td class="mdescLeft"> </td><td class="mdescRight">Adds a single line to be parsed by the icalparser. <a href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">More...</a><br /></td></tr> <tr class="separator:a987113ea951dc55e37a764af168caaca"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa6e4c9c494345c51adf49a7e30255fb7"><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#aa6e4c9c494345c51adf49a7e30255fb7">icalparser_clean</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> +<tr class="memitem:aa6e4c9c494345c51adf49a7e30255fb7"><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#aa6e4c9c494345c51adf49a7e30255fb7">icalparser_clean</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> <tr class="memdesc:aa6e4c9c494345c51adf49a7e30255fb7"><td class="mdescLeft"> </td><td class="mdescRight">Cleans out an icalparser and returns whatever it has parsed so far. <a href="icalparser_8h.html#aa6e4c9c494345c51adf49a7e30255fb7">More...</a><br /></td></tr> <tr class="separator:aa6e4c9c494345c51adf49a7e30255fb7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> +<tr class="memitem:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> <tr class="memdesc:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="mdescLeft"> </td><td class="mdescRight">Frees an icalparser object. <a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">More...</a><br /></td></tr> <tr class="separator:a1cb8b8678b781d3d2ede0fbce613b90d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ada2de638b68de5146ae860631709f4a3"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> +<tr class="memitem:ada2de638b68de5146ae860631709f4a3"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> <tr class="memdesc:ada2de638b68de5146ae860631709f4a3"><td class="mdescLeft"> </td><td class="mdescRight">Given a line generator function, returns a single iCal content line. <a href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">More...</a><br /></td></tr> <tr class="separator:ada2de638b68de5146ae860631709f4a3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser)</td></tr> +<tr class="memitem:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser)</td></tr> <tr class="memdesc:a9a27d19ac53219bb65aeb9a031dbf027"><td class="mdescLeft"> </td><td class="mdescRight">Returns current state of the icalparser. <a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">More...</a><br /></td></tr> <tr class="separator:a9a27d19ac53219bb65aeb9a031dbf027"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9848e4dc69f814f49a5ece028c43be57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a> (void)</td></tr> +<tr class="memitem:a9848e4dc69f814f49a5ece028c43be57"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a> (void)</td></tr> <tr class="memdesc:a9848e4dc69f814f49a5ece028c43be57"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icalparser. <a href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">More...</a><br /></td></tr> <tr class="separator:a9848e4dc69f814f49a5ece028c43be57"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a00330df647417bb017a7daaaffafddec"><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#a00330df647417bb017a7daaaffafddec">icalparser_parse</a> (<a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> +<tr class="memitem:a00330df647417bb017a7daaaffafddec"><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#a00330df647417bb017a7daaaffafddec">icalparser_parse</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, icalparser_line_gen_func line_gen_func)</td></tr> <tr class="memdesc:a00330df647417bb017a7daaaffafddec"><td class="mdescLeft"> </td><td class="mdescRight">Message oriented parsing. <a href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">More...</a><br /></td></tr> <tr class="separator:a00330df647417bb017a7daaaffafddec"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e1268344c61e44a0ec18085688f07fd"><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#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a> (const char *str)</td></tr> <tr class="memdesc:a5e1268344c61e44a0ec18085688f07fd"><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and returns the parsed icalcomponent. <a href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">More...</a><br /></td></tr> <tr class="separator:a5e1268344c61e44a0ec18085688f07fd"><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="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> *parser, void *data)</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="memdesc:aae6d08b4084610e225621a25dddd7689"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'. <a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">More...</a><br /></td></tr> <tr class="separator:aae6d08b4084610e225621a25dddd7689"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6429fdd3d61babc95a3851d78c16ae66"><td class="memItemLeft" align="right" valign="top"><a id="a6429fdd3d61babc95a3851d78c16ae66" name="a6429fdd3d61babc95a3851d78c16ae66"></a> @@ -141,23 +147,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="textblock"><p >Line-oriented parsing. </p> <p >This file provides methods to parse iCalendar-formatted data into the structures provided by this library.</p> <dl class="section user"><dt>Usage</dt><dd>Create a new parser via icalparser_new_parser(), then add lines one at a time with <a class="el" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a>. <a class="el" href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca" title="Adds a single line to be parsed by the icalparser.">icalparser_add_line()</a> will return non-zero when it has finished with a component. </dd></dl> -</div><h2 class="groupheader">Typedef Documentation</h2> -<a id="a9332da05cc4922f68ae2b07f442c06fa" name="a9332da05cc4922f68ae2b07f442c06fa"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a9332da05cc4922f68ae2b07f442c06fa">◆ </a></span>icalparser</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a></td> - </tr> - </table> -</div><div class="memdoc"> -<p >Implementation of the icalparser struct, which holds the state for the current parsing operation. </p> - -</div> -</div> -<h2 class="groupheader">Enumeration Type Documentation</h2> +</div><h2 class="groupheader">Enumeration Type Documentation</h2> <a id="aeec42cd09dd789c699d7b6741cbec3e7" name="aeec42cd09dd789c699d7b6741cbec3e7"></a> <h2 class="memtitle"><span class="permalink"><a href="#aeec42cd09dd789c699d7b6741cbec3e7">◆ </a></span>icalparser_state</h2> @@ -165,12 +155,10 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="memproto"> <table class="memname"> <tr> - <td class="memname">enum <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a></td> + <td class="memname">enum icalparser_state</td> </tr> </table> </div><div class="memdoc"> - -<p>Represents the current state of the parser. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8" name="aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"></a>ICALPARSER_ERROR </td><td class="fielddoc"><p >An error occurred while parsing. </p> </td></tr> @@ -196,7 +184,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_add_line </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> @@ -226,8 +214,8 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <dl class="section user"><dt>Error handling</dt><dd><ul> <li>If <em>parser</em> is <code>NULL</code>, it returns <code>NULL</code> and 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>.</li> <li>If <em>line</em> is empty, if returns <code>NULL</code></li> -<li>If <em>line</em> is <code>NULL</code>, it returns <code>NULL</code> and sets the <em>parser's</em> <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>.</li> -<li>For errors during parsing, the functions can set the <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> and/or return components of the type ICAL_XLICINVALID_COMPONENT, or components with properties of the type ICAL_XLICERROR_PROPERTY.</li> +<li>If <em>line</em> is <code>NULL</code>, it returns <code>NULL</code> and sets the <em>parser's</em> <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>.</li> +<li>For errors during parsing, the functions can set the <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> and/or return components of the type ICAL_XLICINVALID_COMPONENT, or components with properties of the type ICAL_XLICERROR_PROPERTY.</li> </ul> </dd></dl> <dl class="section user"><dt>Ownership</dt><dd>Ownership of the <em>str</em> is transferred to libical upon calling this method. The returned icalcomponent is owned by the caller and needs to be <code>free()</code>d with the appropriate method after it's no longer needed.</dd></dl> @@ -263,13 +251,13 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line"> </div> <div class="line"> <a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a1cb8b8678b781d3d2ede0fbce613b90d"><div class="ttname"><a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a></div><div class="ttdeci">void icalparser_free(icalparser *parser)</div><div class="ttdoc">Frees an icalparser object.</div><div class="ttdef"><b>Definition:</b> icalparser.c:121</div></div> -<div class="ttc" id="aicalparser_8h_html_a9848e4dc69f814f49a5ece028c43be57"><div class="ttname"><a href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a></div><div class="ttdeci">icalparser * icalparser_new(void)</div><div class="ttdoc">Creates a new icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:99</div></div> -<div class="ttc" id="aicalparser_8h_html_a987113ea951dc55e37a764af168caaca"><div class="ttname"><a href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a></div><div class="ttdeci">icalcomponent * icalparser_add_line(icalparser *parser, char *str)</div><div class="ttdoc">Adds a single line to be parsed by the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:685</div></div> -<div class="ttc" id="aicalparser_8h_html_aae6d08b4084610e225621a25dddd7689"><div class="ttname"><a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a></div><div class="ttdeci">void icalparser_set_gen_data(icalparser *parser, void *data)</div><div class="ttdoc">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.</div><div class="ttdef"><b>Definition:</b> icalparser.c:138</div></div> -<div class="ttc" id="aicalparser_8h_html_ada2de638b68de5146ae860631709f4a3"><div class="ttname"><a href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a></div><div class="ttdeci">char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Given a line generator function, returns a single iCal content line.</div><div class="ttdef"><b>Definition:</b> icalparser.c:476</div></div> -<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:36</div></div> -<div class="ttc" id="astructicalparser__impl_html"><div class="ttname"><a href="structicalparser__impl.html">icalparser_impl</a></div><div class="ttdef"><b>Definition:</b> icalparser.c:51</div></div> +<div class="ttc" id="aicalparser_8h_html_a1cb8b8678b781d3d2ede0fbce613b90d"><div class="ttname"><a href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a></div><div class="ttdeci">void icalparser_free(icalparser *parser)</div><div class="ttdoc">Frees an icalparser object.</div><div class="ttdef"><b>Definition:</b> icalparser.c:104</div></div> +<div class="ttc" id="aicalparser_8h_html_a9848e4dc69f814f49a5ece028c43be57"><div class="ttname"><a href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a></div><div class="ttdeci">icalparser * icalparser_new(void)</div><div class="ttdoc">Creates a new icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:81</div></div> +<div class="ttc" id="aicalparser_8h_html_a987113ea951dc55e37a764af168caaca"><div class="ttname"><a href="icalparser_8h.html#a987113ea951dc55e37a764af168caaca">icalparser_add_line</a></div><div class="ttdeci">icalcomponent * icalparser_add_line(icalparser *parser, char *str)</div><div class="ttdoc">Adds a single line to be parsed by the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:682</div></div> +<div class="ttc" id="aicalparser_8h_html_aae6d08b4084610e225621a25dddd7689"><div class="ttname"><a href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a></div><div class="ttdeci">void icalparser_set_gen_data(icalparser *parser, void *data)</div><div class="ttdoc">Sets the data that icalparser_parse will give to the line_gen_func as the parameter 'd'.</div><div class="ttdef"><b>Definition:</b> icalparser.c:121</div></div> +<div class="ttc" id="aicalparser_8h_html_ada2de638b68de5146ae860631709f4a3"><div class="ttname"><a href="icalparser_8h.html#ada2de638b68de5146ae860631709f4a3">icalparser_get_line</a></div><div class="ttdeci">char * icalparser_get_line(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Given a line generator function, returns a single iCal content line.</div><div class="ttdef"><b>Definition:</b> icalparser.c:467</div></div> +<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:28</div></div> +<div class="ttc" id="astructicalparser__impl_html"><div class="ttname"><a href="structicalparser__impl.html">icalparser_impl</a></div><div class="ttdef"><b>Definition:</b> icalparser.c:32</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -283,7 +271,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * icalparser_clean </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> <td></td> </tr> @@ -313,7 +301,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname">void icalparser_free </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> <td></td> </tr> @@ -345,7 +333,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname">char * icalparser_get_line </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> @@ -384,7 +372,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname"><a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> icalparser_get_state </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em></td><td>)</td> <td></td> </tr> @@ -398,7 +386,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </table> </dd> </dl> -<dl class="section return"><dt>Returns</dt><dd>The current state of the icalparser, as an <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a></dd></dl> +<dl class="section return"><dt>Returns</dt><dd>The current state of the icalparser, as an <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a></dd></dl> <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code hl_struct" href="structicalparser__impl.html">icalparser</a> *parser = <a class="code hl_function" href="icalparser_8h.html#a9848e4dc69f814f49a5ece028c43be57">icalparser_new</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// use icalparser...</span></div> @@ -408,8 +396,8 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line">} <span class="keywordflow">else</span> {</div> <div class="line"> <span class="comment">// ...</span></div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a9a27d19ac53219bb65aeb9a031dbf027"><div class="ttname"><a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a></div><div class="ttdeci">icalparser_state icalparser_get_state(icalparser *parser)</div><div class="ttdoc">Returns current state of the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1237</div></div> -<div class="ttc" id="aicalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a></div><div class="ttdeci">@ ICALPARSER_ERROR</div><div class="ttdef"><b>Definition:</b> icalparser.h:58</div></div> +<div class="ttc" id="aicalparser_8h_html_a9a27d19ac53219bb65aeb9a031dbf027"><div class="ttname"><a href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a></div><div class="ttdeci">icalparser_state icalparser_get_state(icalparser *parser)</div><div class="ttdoc">Returns current state of the icalparser.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1238</div></div> +<div class="ttc" id="aicalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a></div><div class="ttdeci">@ ICALPARSER_ERROR</div><div class="ttdef"><b>Definition:</b> icalparser.h:49</div></div> </div><!-- fragment --></dd></dl> <p>icalparser_free(parser); </p> @@ -422,7 +410,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * icalparser_new </td> + <td class="memname"><a class="el" href="structicalparser__impl.html">icalparser</a> * icalparser_new </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> @@ -455,7 +443,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <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="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> @@ -486,8 +474,8 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <dl class="section user"><dt>Error handling</dt><dd><ul> <li>If <em>parser</em> is <code>NULL</code>, it returns <code>NULL</code> and 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>.</li> <li>If data read by <em>line_gen_func</em> is empty, if returns <code>NULL</code></li> -<li>If data read by <em>line_gen_func</em> is <code>NULL</code>, it returns <code>NULL</code> and sets the <em>parser's</em> <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>.</li> -<li>For errors during parsing, the functions can set the <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7" title="Represents the current state of the parser.">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> and/or return components of the type ICAL_XLICINVALID_COMPONENT, or components with properties of the type ICAL_XLICERROR_PROPERTY.</li> +<li>If data read by <em>line_gen_func</em> is <code>NULL</code>, it returns <code>NULL</code> and sets the <em>parser's</em> <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>.</li> +<li>For errors during parsing, the functions can set the <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> to <a class="el" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a> and/or return components of the type ICAL_XLICINVALID_COMPONENT, or components with properties of the type ICAL_XLICERROR_PROPERTY.</li> </ul> </dd></dl> <dl class="section user"><dt>Ownership</dt><dd>The returned icalcomponent is owned by the caller of the function, and needs to be <code>free()</code>d with the appropriate method when no longer needed.</dd></dl> @@ -516,7 +504,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line"> </div> <div class="line"> <a class="code hl_function" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(parser);</div> <div class="line">}</div> -<div class="ttc" id="aicalparser_8h_html_a00330df647417bb017a7daaaffafddec"><div class="ttname"><a href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">icalparser_parse</a></div><div class="ttdeci">icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Message oriented parsing.</div><div class="ttdef"><b>Definition:</b> icalparser.c:625</div></div> +<div class="ttc" id="aicalparser_8h_html_a00330df647417bb017a7daaaffafddec"><div class="ttname"><a href="icalparser_8h.html#a00330df647417bb017a7daaaffafddec">icalparser_parse</a></div><div class="ttdeci">icalcomponent * icalparser_parse(icalparser *parser, icalparser_line_gen_func line_gen_func)</div><div class="ttdoc">Message oriented parsing.</div><div class="ttdef"><b>Definition:</b> icalparser.c:622</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -558,8 +546,8 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <div class="line"> </div> <div class="line"><span class="comment">// release component</span></div> <div class="line">icalcomponent_free(component);</div> -<div class="ttc" id="aicalerror_8h_html_ad2562706150f5c5a4d9b0ca149d78e37"><div class="ttname"><a href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a></div><div class="ttdeci">#define icalerrno</div><div class="ttdoc">Access the current icalerrno value.</div><div class="ttdef"><b>Definition:</b> icalerror.h:144</div></div> -<div class="ttc" id="aicalparser_8h_html_a5e1268344c61e44a0ec18085688f07fd"><div class="ttname"><a href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a></div><div class="ttdeci">icalcomponent * icalparser_parse_string(const char *str)</div><div class="ttdoc">Parses a string and returns the parsed icalcomponent.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1335</div></div> +<div class="ttc" id="aicalerror_8h_html_ad2562706150f5c5a4d9b0ca149d78e37"><div class="ttname"><a href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37">icalerrno</a></div><div class="ttdeci">#define icalerrno</div><div class="ttdoc">Access the current icalerrno value.</div><div class="ttdef"><b>Definition:</b> icalerror.h:135</div></div> +<div class="ttc" id="aicalparser_8h_html_a5e1268344c61e44a0ec18085688f07fd"><div class="ttname"><a href="icalparser_8h.html#a5e1268344c61e44a0ec18085688f07fd">icalparser_parse_string</a></div><div class="ttdeci">icalcomponent * icalparser_parse_string(const char *str)</div><div class="ttdoc">Parses a string and returns the parsed icalcomponent.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1336</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -573,7 +561,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l <tr> <td class="memname">void icalparser_set_gen_data </td> <td>(</td> - <td class="paramtype"><a class="el" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa">icalparser</a> * </td> + <td class="paramtype"><a class="el" href="structicalparser__impl.html">icalparser</a> * </td> <td class="paramname"><em>parser</em>, </td> </tr> <tr> @@ -605,7 +593,7 @@ char * </td><td class="memItemRight" valign="bottom"><b>icalparser_string_l </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Fri Jun 10 2022 08:27:16 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +Generated on Sat Jun 18 2022 10:19:41 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 </small></address> </body> </html> |