1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalparser.h Source File</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>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Libical API Documentation
 <span id="projectnumber">3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="headertitle">
<div class="title">icalparser.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="icalparser_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*======================================================================</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icalparser.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 20 April 1999</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> it under the terms of either:</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Or:</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> The Mozilla Public License Version 2.0. You may obtain a copy of</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> the License at https://www.mozilla.org/MPL/</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> The original code is icalparser.h</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">======================================================================*/</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#ifndef ICALPARSER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define ICALPARSER_H</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "libical_ical_export.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "icalcomponent.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="icalparser_8h.html#a9332da05cc4922f68ae2b07f442c06fa"> 48</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicalparser__impl.html">icalparser_impl</a> <a class="code" href="structicalparser__impl.html">icalparser</a>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7"> 55</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"> 58</a></span>  <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a>,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090"> 61</a></span>  <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090">ICALPARSER_SUCCESS</a>,</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e"> 64</a></span>  <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e">ICALPARSER_BEGIN_COMP</a>,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2"> 67</a></span>  <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2">ICALPARSER_END_COMP</a>,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2"> 70</a></span>  <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2">ICALPARSER_IN_PROGRESS</a></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a>;</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">typedef</span> <span class="keywordtype">char</span> *(*icalparser_line_gen_func) (<span class="keywordtype">char</span> *s, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *d);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> LIBICAL_ICAL_EXPORT <a class="code" href="structicalparser__impl.html">icalparser</a> *<a class="code" href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">icalparser_new</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> LIBICAL_ICAL_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code" href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">icalparser_add_line</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser, <span class="keywordtype">char</span> *str);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> LIBICAL_ICAL_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code" href="icalparser_8h.html#aa184343e374e5a201d8079df827597b2">icalparser_clean</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> LIBICAL_ICAL_EXPORT <a class="code" href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a> <a class="code" href="icalparser_8h.html#a9a27d19ac53219bb65aeb9a031dbf027">icalparser_get_state</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalparser_8h.html#a1cb8b8678b781d3d2ede0fbce613b90d">icalparser_free</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser);</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> </div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> LIBICAL_ICAL_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code" href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">icalparser_parse</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser,</div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>  icalparser_line_gen_func line_gen_func);</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> </div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalparser_8h.html#aae6d08b4084610e225621a25dddd7689">icalparser_set_gen_data</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser, <span class="keywordtype">void</span> *data);</div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> </div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> LIBICAL_ICAL_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *<a class="code" href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">icalparser_parse_string</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> </div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment">/***********************************************************************</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * Parser support functions</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> ***********************************************************************/</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *<a class="code" href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">icalparser_get_line</a>(<a class="code" href="structicalparser__impl.html">icalparser</a> *parser,</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>  icalparser_line_gen_func line_gen_func);</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *icalparser_string_line_generator(<span class="keywordtype">char</span> *out, <span class="keywordtype">size_t</span> buf_size, <span class="keywordtype">void</span> *d);</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> </div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="preprocessor">#endif </span><span class="comment">/* !ICALPARSE_H */</span><span class="preprocessor"></span></div><div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a0bfd41070e190cb87f0e8385e0c8031e">ICALPARSER_BEGIN_COMP</a></div><div class="ttdef"><b>Definition:</b> icalparser.h:64</div></div>
<div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7">icalparser_state</a></div><div class="ttdeci">icalparser_state</div><div class="ttdoc">Represents the current state of the parser.</div><div class="ttdef"><b>Definition:</b> icalparser.h:55</div></div>
<div class="ttc" id="icalparser_8h_html_aab80e10c3636d6476bc4920ae72d4b70"><div class="ttname"><a href="icalparser_8h.html#aab80e10c3636d6476bc4920ae72d4b70">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:629</div></div>
<div class="ttc" id="icalparser_8h_html_a3a7a45307a9ff90ec23d632501c0bd00"><div class="ttname"><a href="icalparser_8h.html#a3a7a45307a9ff90ec23d632501c0bd00">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="icalparser_8h_html_a966f6fd4bc931c06b2c596daeadb692f"><div class="ttname"><a href="icalparser_8h.html#a966f6fd4bc931c06b2c596daeadb692f">icalparser_parse_string</a></div><div class="ttdeci">icalcomponent * icalparser_parse_string(const char *str)</div><div class="ttdoc">Parse a string and return the parsed ::icalcomponent.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1339</div></div>
<div class="ttc" id="icalparser_8h_html_a1e9b165c1aa2ba82605bcccadf85f74c"><div class="ttname"><a href="icalparser_8h.html#a1e9b165c1aa2ba82605bcccadf85f74c">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, return a single iCal content line.</div><div class="ttdef"><b>Definition:</b> icalparser.c:480</div></div>
<div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7adc8fd0c6d697007e6b3fa12bd118a9c8">ICALPARSER_ERROR</a></div><div class="ttdef"><b>Definition:</b> icalparser.h:58</div></div>
<div class="ttc" id="structicalparser__impl_html"><div class="ttname"><a href="structicalparser__impl.html">icalparser_impl</a></div><div class="ttdef"><b>Definition:</b> icalparser.c:50</div></div>
<div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a2dc67ce9b2811c477a462025a9ed9090">ICALPARSER_SUCCESS</a></div><div class="ttdef"><b>Definition:</b> icalparser.h:61</div></div>
<div class="ttc" id="icalparser_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:1241</div></div>
<div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a5a29afa239e509cc9f45a61a2c10feb2">ICALPARSER_END_COMP</a></div><div class="ttdef"><b>Definition:</b> icalparser.h:67</div></div>
<div class="ttc" id="icalparser_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="icalparser_8h_html_a1138735cde70554bcdfc17dc8a595a6a"><div class="ttname"><a href="icalparser_8h.html#a1138735cde70554bcdfc17dc8a595a6a">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:689</div></div>
<div class="ttc" id="structicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:35</div></div>
<div class="ttc" id="icalparser_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="icalparser_8h_html_aa184343e374e5a201d8079df827597b2"><div class="ttname"><a href="icalparser_8h.html#aa184343e374e5a201d8079df827597b2">icalparser_clean</a></div><div class="ttdeci">icalcomponent * icalparser_clean(icalparser *parser)</div><div class="ttdoc">Cleans out an icalparser and returns whatever it has parsed so far.</div><div class="ttdef"><b>Definition:</b> icalparser.c:1246</div></div>
<div class="ttc" id="icalparser_8h_html_aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2"><div class="ttname"><a href="icalparser_8h.html#aeec42cd09dd789c699d7b6741cbec3e7a927206f107dfdc62cfd33a9115a997b2">ICALPARSER_IN_PROGRESS</a></div><div class="ttdef"><b>Definition:</b> icalparser.h:70</div></div>
</div><!-- fragment --></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.15
</small></address>
</body>
</html>
|
