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
|
<!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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: pvl.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(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">pvl.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*======================================================================</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> FILE: pvl.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> CREATOR: eric November, 1995</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"></span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">======================================================================*/</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef ICAL_PVL_H</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define ICAL_PVL_H</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include "libical_ical_export.h"</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structpvl__list__t.html">pvl_list_t</a> *<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem_t</a> *<a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structpvl__elem__t.html"> 25</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem_t</a></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>{</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structpvl__elem__t.html#a259a4f64c59afeaca3a95aa77f4731d5"> 27</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structpvl__elem__t.html#a259a4f64c59afeaca3a95aa77f4731d5">MAGIC</a>; </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134"> 28</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>; </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d"> 29</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem_t</a> *<a class="code hl_variable" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d">next</a>; </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274"> 30</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem_t</a> *<a class="code hl_variable" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274">prior</a>; </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>} <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem_t</a>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">/* Create new lists or elements */</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_new_element(<span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>, <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> <a class="code hl_variable" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d">next</a>, <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> <a class="code hl_variable" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274">prior</a>);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> pvl_newlist(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_free(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment">/* Add, remove, or get the head of the list */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_unshift(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> *pvl_shift(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_head(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/* Add, remove or get the tail of the list */</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_push(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> *pvl_pop(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_tail(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">/* Insert elements in random places */</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keyword">typedef</span> int (*pvl_comparef) (<span class="keywordtype">void</span> *a, <span class="keywordtype">void</span> *b); <span class="comment">/* a, b are of the data type */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_insert_ordered(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, pvl_comparef f, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_insert_after(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> e, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_insert_before(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> e, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">/* Remove an element, or clear the entire list */</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> *pvl_remove(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>, <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a>); <span class="comment">/* Remove element, return data */</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_clear(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>); <span class="comment">/* Remove all elements, de-allocate all data */</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> pvl_count(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a>);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment">/* Navigate the list */</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_next(<a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> e);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_prior(<a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> e);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment">/* get the data in the list */</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#if !defined(PVL_USE_MACROS)</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> *pvl_data(<a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a>);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="preprocessor">#define pvl_data(x) x==0 ? 0 : ((struct pvl_elem_t *)x)->d;</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">/* Find an element for which a function returns true */</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="keyword">typedef</span> int (*pvl_findf) (<span class="keywordtype">void</span> *a, <span class="keywordtype">void</span> *b); <span class="comment">/*a is list elem, b is other data */</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_find(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, pvl_findf f, <span class="keywordtype">void</span> *v);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>LIBICAL_ICAL_EXPORT <a class="code hl_struct" href="structpvl__elem__t.html">pvl_elem</a> pvl_find_next(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, pvl_findf f, <span class="keywordtype">void</span> *v);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="keyword">typedef</span> void (*pvl_applyf) (<span class="keywordtype">void</span> *a, <span class="keywordtype">void</span> *b);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> pvl_apply(<a class="code hl_struct" href="structpvl__list__t.html">pvl_list</a> l, pvl_applyf f, <span class="keywordtype">void</span> *v);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="preprocessor">#endif </span><span class="comment">/* ICAL_PVL_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="astructpvl__elem__t_html"><div class="ttname"><a href="structpvl__elem__t.html">pvl_elem_t</a></div><div class="ttdef"><b>Definition:</b> pvl.h:26</div></div>
<div class="ttc" id="astructpvl__elem__t_html_a00350aa18847b00658ba476816cb0274"><div class="ttname"><a href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274">pvl_elem_t::prior</a></div><div class="ttdeci">struct pvl_elem_t * prior</div><div class="ttdef"><b>Definition:</b> pvl.h:30</div></div>
<div class="ttc" id="astructpvl__elem__t_html_a259a4f64c59afeaca3a95aa77f4731d5"><div class="ttname"><a href="structpvl__elem__t.html#a259a4f64c59afeaca3a95aa77f4731d5">pvl_elem_t::MAGIC</a></div><div class="ttdeci">int MAGIC</div><div class="ttdef"><b>Definition:</b> pvl.h:27</div></div>
<div class="ttc" id="astructpvl__elem__t_html_a305009bdcf1759ce8f0d9f896403552d"><div class="ttname"><a href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d">pvl_elem_t::next</a></div><div class="ttdeci">struct pvl_elem_t * next</div><div class="ttdef"><b>Definition:</b> pvl.h:29</div></div>
<div class="ttc" id="astructpvl__elem__t_html_a6d7a23387d9b7a5fd62bd7ca2478f134"><div class="ttname"><a href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">pvl_elem_t::d</a></div><div class="ttdeci">void * d</div><div class="ttdef"><b>Definition:</b> pvl.h:28</div></div>
<div class="ttc" id="astructpvl__list__t_html"><div class="ttname"><a href="structpvl__list__t.html">pvl_list_t</a></div><div class="ttdef"><b>Definition:</b> pvl.c:59</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 25 2022 08:55:43 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>
|
