diff options
| author | Allen Winter <allen.winter@kdab.com> | 2014-09-26 17:04:59 -0400 |
|---|---|---|
| committer | Allen Winter <allen.winter@kdab.com> | 2014-09-26 17:04:59 -0400 |
| commit | 783c08bf572924af599e0ab1396a310897924c95 (patch) | |
| tree | 31117798a5fde034e3783024051b45517160344e /apidocs/pvl_8h_source.html | |
| parent | 8364401e95ec796f4c54521969e67a068c85a380 (diff) | |
| download | libical-git-783c08bf572924af599e0ab1396a310897924c95.tar.gz | |
api documentation, first version
Diffstat (limited to 'apidocs/pvl_8h_source.html')
| -rw-r--r-- | apidocs/pvl_8h_source.html | 195 |
1 files changed, 195 insertions, 0 deletions
diff --git a/apidocs/pvl_8h_source.html b/apidocs/pvl_8h_source.html new file mode 100644 index 00000000..c00068cc --- /dev/null +++ b/apidocs/pvl_8h_source.html @@ -0,0 +1,195 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.3.1"/> +<title>Libical: 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Libical +  <span id="projectnumber">1.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.3.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="annotated.html"><span>Data Structures</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>Globals</span></a></li> + </ul> + </div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">pvl.h</div> </div> +</div><!--header--> +<div class="contents"> +<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: pvl.h</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric November, 1995</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"></span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@softwarestudio.org></span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> http://www.softwarestudio.org</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> This program is free software; you can redistribute it and/or modify</span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> it under the terms of either:</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"></span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> 2.1, available at: http://www.fsf.org/copyleft/lesser.html</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"> Or:</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"></span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> The Mozilla Public License Version 1.0. You may obtain a copy of</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> the License at http://www.mozilla.org/MPL/</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> <span class="comment">======================================================================*/</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef __PVL_H__</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define __PVL_H__</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpvl__list__t.html">pvl_list_t</a>* <a class="code" href="structpvl__list__t.html">pvl_list</a>;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpvl__elem__t.html">pvl_elem_t</a>* <a class="code" href="structpvl__elem__t.html">pvl_elem</a>;</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"><a class="code" href="structpvl__elem__t.html"> 35</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structpvl__elem__t.html">pvl_elem_t</a></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div> +<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="structpvl__elem__t.html#a259a4f64c59afeaca3a95aa77f4731d5"> 37</a></span>  <span class="keywordtype">int</span> <a class="code" href="structpvl__elem__t.html#a259a4f64c59afeaca3a95aa77f4731d5">MAGIC</a>; </div> +<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134"> 38</a></span>  <span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>; </div> +<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d"> 39</a></span>  <span class="keyword">struct </span><a class="code" href="structpvl__elem__t.html">pvl_elem_t</a> *<a class="code" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d">next</a>; </div> +<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274"> 40</a></span>  <span class="keyword">struct </span><a class="code" href="structpvl__elem__t.html">pvl_elem_t</a> *<a class="code" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274">prior</a>; </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <a class="code" href="structpvl__elem__t.html">pvl_elem_t</a>;</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> pvl_elem_count;</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">extern</span> <span class="keywordtype">int</span> pvl_list_count;</div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/* Create new lists or elements */</span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> pvl_elem pvl_new_element(<span class="keywordtype">void</span>* <a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>, pvl_elem <a class="code" href="structpvl__elem__t.html#a305009bdcf1759ce8f0d9f896403552d">next</a>,pvl_elem <a class="code" href="structpvl__elem__t.html#a00350aa18847b00658ba476816cb0274">prior</a>);</div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> pvl_list pvl_newlist(<span class="keywordtype">void</span>);</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> pvl_free(pvl_list);</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">/* Add, remove, or get the head of the list */</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">void</span> pvl_unshift(pvl_list l,<span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">void</span>* pvl_shift(pvl_list l);</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> pvl_elem pvl_head(pvl_list);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/* Add, remove or get the tail of the list */</span></div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">void</span> pvl_push(pvl_list l,<span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span>* pvl_pop(pvl_list l);</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> pvl_elem pvl_tail(pvl_list);</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/* Insert elements in random places */</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</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 name="l00070"></a><span class="lineno"> 70</span> <span class="keywordtype">void</span> pvl_insert_ordered(pvl_list l,pvl_comparef f,<span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">void</span> pvl_insert_after(pvl_list l,pvl_elem e,<span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">void</span> pvl_insert_before(pvl_list l,pvl_elem e,<span class="keywordtype">void</span> *<a class="code" href="structpvl__elem__t.html#a6d7a23387d9b7a5fd62bd7ca2478f134">d</a>);</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/* Remove an element, or clear the entire list */</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keywordtype">void</span>* pvl_remove(pvl_list,pvl_elem); <span class="comment">/* Remove element, return data */</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span> pvl_clear(pvl_list); <span class="comment">/* Remove all elements, de-allocate all data */</span></div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keywordtype">int</span> pvl_count(pvl_list);</div> +<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* Navagate the list */</span></div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> pvl_elem pvl_next(pvl_elem e);</div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> pvl_elem pvl_prior(pvl_elem e);</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">/* get the data in the list */</span></div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#ifndef PVL_USE_MACROS</span></div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span><span class="keywordtype">void</span>* pvl_data(pvl_elem);</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#else</span></div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor"></span><span class="preprocessor">#define pvl_data(x) x==0 ? 0 : ((struct pvl_elem_t *)x)->d;</span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/* Find an element for which a function returns true */</span></div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</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 name="l00094"></a><span class="lineno"> 94</span> pvl_elem pvl_find(pvl_list l,pvl_findf f,<span class="keywordtype">void</span>* v);</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> pvl_elem pvl_find_next(pvl_list l,pvl_findf f,<span class="keywordtype">void</span>* v);</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</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 name="l00102"></a><span class="lineno"> 102</span> <span class="keywordtype">void</span> pvl_apply(pvl_list l,pvl_applyf f, <span class="keywordtype">void</span> *v);</div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor">#endif </span><span class="comment">/* __PVL_H__ */</span><span class="preprocessor"></span></div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </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.3.1 +</small></address> +</body> +</html> |