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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
<!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.9.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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<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">2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.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)">
</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 "libical_ical_export.h"</code><br />
<code>#include "icalcomponent.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"><a class="anchor" id="aeec42cd09dd789c699d7b6741cbec3e7"></a>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:a33dc55b48e35654202ce4301f917d6c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33dc55b48e35654202ce4301f917d6c0"></a>
LIBICAL_ICAL_EXPORT <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:a33dc55b48e35654202ce4301f917d6c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad328179de5c8d840e7e46b7bfa506e4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad328179de5c8d840e7e46b7bfa506e4f"></a>
LIBICAL_ICAL_EXPORT <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:ad328179de5c8d840e7e46b7bfa506e4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dfa761efd7591d6dffc58c5cd624c97"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3dfa761efd7591d6dffc58c5cd624c97"></a>
LIBICAL_ICAL_EXPORT 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:a3dfa761efd7591d6dffc58c5cd624c97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff556d8d1bf3e40138784952f3224694"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#aff556d8d1bf3e40138784952f3224694">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:aff556d8d1bf3e40138784952f3224694"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7129f088fd7792e2403f5bf33631e46"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7129f088fd7792e2403f5bf33631e46"></a>
LIBICAL_ICAL_EXPORT 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:ac7129f088fd7792e2403f5bf33631e46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa069149b0e0c90bea2550542a24052b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa069149b0e0c90bea2550542a24052b7"></a>
LIBICAL_ICAL_EXPORT <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:aa069149b0e0c90bea2550542a24052b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b26d0c78f32f2dba98ba0f5e3964b95"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a6b26d0c78f32f2dba98ba0f5e3964b95">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:a6b26d0c78f32f2dba98ba0f5e3964b95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f87e5b1634f8e9bcfa3da92d40e5141"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f87e5b1634f8e9bcfa3da92d40e5141"></a>
LIBICAL_ICAL_EXPORT <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:a4f87e5b1634f8e9bcfa3da92d40e5141"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0ff4b966acb5b59457f76b8c0fd37d99"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT icalvalue * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a0ff4b966acb5b59457f76b8c0fd37d99">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:a0ff4b966acb5b59457f76b8c0fd37d99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59b26d9689ab616233130ef5265f0cb1"><td class="memItemLeft" align="right" valign="top">LIBICAL_ICAL_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparser_8h.html#a59b26d9689ab616233130ef5265f0cb1">icalparser_set_gen_data</a> (<a class="el" href="structicalparser__impl.html">icalparser</a> *parser, void *data)</td></tr>
<tr class="separator:a59b26d9689ab616233130ef5265f0cb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05dd18025e64a8e2db948ac05b68daf6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05dd18025e64a8e2db948ac05b68daf6"></a>
LIBICAL_ICAL_EXPORT 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:a05dd18025e64a8e2db948ac05b68daf6"><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="aff556d8d1bf3e40138784952f3224694"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBICAL_ICAL_EXPORT 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="a6b26d0c78f32f2dba98ba0f5e3964b95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBICAL_ICAL_EXPORT <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 5545 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="a0ff4b966acb5b59457f76b8c0fd37d99"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBICAL_ICAL_EXPORT 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="a59b26d9689ab616233130ef5265f0cb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBICAL_ICAL_EXPORT 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.9.1
</small></address>
</body>
</html>
|
