<!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"/>
<title>Open SCAP Library: /home/pvrabec/openscap/openscap-0.5.7/src/common/list.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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="modules.html"><span>Modules</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>/home/pvrabec/openscap/openscap-0.5.7/src/common/list.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright 2009 Red Hat Inc., Durham, North Carolina.</span>
<a name="l00003"></a>00003 <span class="comment"> * All Rights Reserved.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00007"></a>00007 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful, </span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free Software </span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * Authors:</span>
<a name="l00020"></a>00020 <span class="comment"> * Lukas Kuklinek <lkuklinek@redhat.com></span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * @file</span>
<a name="l00025"></a>00025 <span class="comment"> * @internal</span>
<a name="l00026"></a>00026 <span class="comment"> * @{</span>
<a name="l00027"></a>00027 <span class="comment"> */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef OSCAP_LIST_</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define OSCAP_LIST_</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdlib.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <stdbool.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="util_8h.html" title="Common openscap utilities.">util.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="oscap_8h.html" title="General OpenScap functions and types.">public/oscap.h</a>"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 OSCAP_HIDDEN_START;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">typedef</span> void (*oscap_dump_func) ();
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">/*</span>
<a name="l00042"></a>00042 <span class="comment"> * Linear linked list.</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="structoscap__list__item.html">00045</a> <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> {
<a name="l00046"></a>00046 <span class="keywordtype">void</span> *data;
<a name="l00047"></a>00047 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *next;
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00050"></a><a class="code" href="structoscap__list.html">00050</a> <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> {
<a name="l00051"></a>00051 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *first;
<a name="l00052"></a>00052 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *last;
<a name="l00053"></a>00053 <span class="keywordtype">size_t</span> itemcount;
<a name="l00054"></a>00054 };
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *oscap_list_new(<span class="keywordtype">void</span>);
<a name="l00057"></a>00057 <span class="keywordtype">bool</span> oscap_list_add(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <span class="keywordtype">void</span> *value);
<a name="l00058"></a>00058 <span class="keywordtype">void</span> oscap_list_free(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, <a class="code" href="util_8h.html#ad2a4648e28ae682b86489ac8be3a22fc" title="Function pointer to an object destructor.">oscap_destruct_func</a> destructor);
<a name="l00059"></a>00059 <span class="keywordtype">void</span> oscap_list_free0(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);
<a name="l00060"></a>00060 <span class="keywordtype">void</span> oscap_list_dump(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_dump_func dumper, <span class="keywordtype">int</span> depth);
<a name="l00061"></a>00061 <span class="keywordtype">int</span> oscap_list_get_itemcount(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">/* Linked List iterator. */</span>
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">typedef</span> bool(*oscap_filter_func) (<span class="keywordtype">void</span> *, <span class="keywordtype">void</span> *);
<a name="l00066"></a>00066
<a name="l00067"></a><a class="code" href="structoscap__iterator.html">00067</a> <span class="keyword">struct </span><a class="code" href="structoscap__iterator.html">oscap_iterator</a> {
<a name="l00068"></a>00068 <span class="keyword">struct </span><a class="code" href="structoscap__list__item.html">oscap_list_item</a> *cur;
<a name="l00069"></a>00069 <span class="keyword">struct </span><a class="code" href="structoscap__list.html">oscap_list</a> *list;
<a name="l00070"></a>00070 oscap_filter_func filter;
<a name="l00071"></a>00071 <span class="keywordtype">void</span> *user_data;
<a name="l00072"></a>00072 };
<a name="l00073"></a>00073
<a name="l00074"></a>00074 <span class="keywordtype">void</span> *oscap_iterator_new(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list);
<a name="l00075"></a>00075 <span class="keywordtype">void</span> *oscap_iterator_new_filter(<span class="keyword">struct</span> <a class="code" href="structoscap__list.html">oscap_list</a> *list, oscap_filter_func filter, <span class="keywordtype">void</span> *user_data);
<a name="l00076"></a>00076 <span class="keywordtype">void</span> *oscap_iterator_next(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00077"></a>00077 <span class="keywordtype">size_t</span> oscap_iterator_get_itemcount(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> oscap_iterator_has_more(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00079"></a>00079 <span class="keywordtype">void</span> *oscap_iterator_detach(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00080"></a>00080 <span class="keywordtype">void</span> oscap_iterator_free(<span class="keyword">struct</span> <a class="code" href="structoscap__iterator.html">oscap_iterator</a> *it);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="comment">/*</span>
<a name="l00083"></a>00083 <span class="comment"> * Hash table</span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// Comparison function.</span>
<a name="l00087"></a>00087 <span class="keyword">typedef</span> int (*oscap_compare_func) (<span class="keyword">const</span> <span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00088"></a>00088 <span class="comment">// Hash table item.</span>
<a name="l00089"></a><a class="code" href="structoscap__htable__item.html">00089</a> <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> {
<a name="l00090"></a>00090 <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> *next; <span class="comment">// Next item.</span>
<a name="l00091"></a>00091 <span class="keywordtype">char</span> *key; <span class="comment">// Item key.</span>
<a name="l00092"></a>00092 <span class="keywordtype">void</span> *value; <span class="comment">// Item value.</span>
<a name="l00093"></a>00093 };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">// Hash table.</span>
<a name="l00096"></a><a class="code" href="structoscap__htable.html">00096</a> <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> {
<a name="l00097"></a>00097 <span class="keywordtype">size_t</span> hsize; <span class="comment">// Size of the hash table.</span>
<a name="l00098"></a>00098 <span class="keywordtype">size_t</span> itemcount; <span class="comment">// Number of elements in the hash table.</span>
<a name="l00099"></a>00099 <span class="keyword">struct </span><a class="code" href="structoscap__htable__item.html">oscap_htable_item</a> **table; <span class="comment">// The table itself.</span>
<a name="l00100"></a>00100 oscap_compare_func cmp; <span class="comment">// Funcion used to compare keys (e.g. strcmp).</span>
<a name="l00101"></a>00101 };
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">/*</span>
<a name="l00104"></a>00104 <span class="comment"> * Create a new hash table.</span>
<a name="l00105"></a>00105 <span class="comment"> * @param cmp Pointer to a function used as the key comparator.</span>
<a name="l00106"></a>00106 <span class="comment"> * @hsize Size of the hash table.</span>
<a name="l00107"></a>00107 <span class="comment"> * @internal</span>
<a name="l00108"></a>00108 <span class="comment"> * @return new hash table</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> *oscap_htable_new1(oscap_compare_func cmp, <span class="keywordtype">size_t</span> hsize);
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">/*</span>
<a name="l00113"></a>00113 <span class="comment"> * Create a new hash table.</span>
<a name="l00114"></a>00114 <span class="comment"> *</span>
<a name="l00115"></a>00115 <span class="comment"> * The table will use strcmp() as the comparison function and will have default table size.</span>
<a name="l00116"></a>00116 <span class="comment"> * @see oscap_htable_new1()</span>
<a name="l00117"></a>00117 <span class="comment"> * @return new hash table</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 <span class="keyword">struct </span><a class="code" href="structoscap__htable.html">oscap_htable</a> *oscap_htable_new(<span class="keywordtype">void</span>);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">/*</span>
<a name="l00122"></a>00122 <span class="comment"> * Add an item to the hash table.</span>
<a name="l00123"></a>00123 <span class="comment"> * @return True on success, false if the key already exists.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="keywordtype">bool</span> oscap_htable_add(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key, <span class="keywordtype">void</span> *item);
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">/*</span>
<a name="l00128"></a>00128 <span class="comment"> * Get a hash table item.</span>
<a name="l00129"></a>00129 <span class="comment"> * @return An item, NULL if item with specified key is not present in the hash table.</span>
<a name="l00130"></a>00130 <span class="comment"> */</span>
<a name="l00131"></a>00131 <span class="keywordtype">void</span> *oscap_htable_get(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="keywordtype">void</span> *oscap_htable_detach(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <span class="keyword">const</span> <span class="keywordtype">char</span> *key);
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keywordtype">void</span> oscap_htable_dump(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, oscap_dump_func dumper, <span class="keywordtype">int</span> depth);
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="comment">/*</span>
<a name="l00138"></a>00138 <span class="comment"> * Delete the hash table.</span>
<a name="l00139"></a>00139 <span class="comment"> * @param htable Hash table to be deleted.</span>
<a name="l00140"></a>00140 <span class="comment"> * @param destructor Function used to delete individual items.</span>
<a name="l00141"></a>00141 <span class="comment"> */</span>
<a name="l00142"></a>00142 <span class="keywordtype">void</span> oscap_htable_free(<span class="keyword">struct</span> <a class="code" href="structoscap__htable.html">oscap_htable</a> *htable, <a class="code" href="util_8h.html#ad2a4648e28ae682b86489ac8be3a22fc" title="Function pointer to an object destructor.">oscap_destruct_func</a> destructor);
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <span class="keywordtype">void</span> oscap_print_depth(<span class="keywordtype">int</span> depth);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 OSCAP_HIDDEN_END;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 26 Feb 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
