<!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>libannodex: anx_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.2-20100208 -->
<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>anx_list.h</h1><a href="anx__list_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 Commonwealth Scientific and Industrial Research</span>
<a name="l00003"></a>00003 <span class="comment"> Organisation (CSIRO) Australia</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Redistribution and use in source and binary forms, with or without</span>
<a name="l00006"></a>00006 <span class="comment"> modification, are permitted provided that the following conditions</span>
<a name="l00007"></a>00007 <span class="comment"> are met:</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> - Redistributions of source code must retain the above copyright</span>
<a name="l00010"></a>00010 <span class="comment"> notice, this list of conditions and the following disclaimer.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> - Redistributions in binary form must reproduce the above copyright</span>
<a name="l00013"></a>00013 <span class="comment"> notice, this list of conditions and the following disclaimer in the</span>
<a name="l00014"></a>00014 <span class="comment"> documentation and/or other materials provided with the distribution.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> - Neither the name of CSIRO Australia nor the names of its</span>
<a name="l00017"></a>00017 <span class="comment"> contributors may be used to endorse or promote products derived from</span>
<a name="l00018"></a>00018 <span class="comment"> this software without specific prior written permission.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<a name="l00021"></a>00021 <span class="comment"> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<a name="l00022"></a>00022 <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span>
<a name="l00023"></a>00023 <span class="comment"> PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR</span>
<a name="l00024"></a>00024 <span class="comment"> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00025"></a>00025 <span class="comment"> EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00026"></a>00026 <span class="comment"> PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00027"></a>00027 <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span>
<a name="l00028"></a>00028 <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
<a name="l00029"></a>00029 <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
<a name="l00030"></a>00030 <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00031"></a>00031 <span class="comment">*/</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef __ANX_LIST_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __ANX_LIST_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <<a class="code" href="anx__core_8h.html" title="Core datatypes etc.">annodex/anx_core.h</a>></span>
<a name="l00041"></a>00041
<a name="l00045"></a><a class="code" href="anx__list_8h.html#acb46a16dc8f16927f80e4b5679bc2d3f">00045</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__AnxList.html">_AnxList</a> <a class="code" href="struct__AnxList.html">AnxList</a>;
<a name="l00046"></a>00046
<a name="l00047"></a><a class="code" href="struct__AnxList.html">00047</a> <span class="keyword">struct </span><a class="code" href="struct__AnxList.html">_AnxList</a> {
<a name="l00048"></a>00048 <a class="code" href="struct__AnxList.html">AnxList</a> * prev;
<a name="l00049"></a>00049 <a class="code" href="struct__AnxList.html">AnxList</a> * next;
<a name="l00050"></a>00050 <span class="keywordtype">void</span> * data;
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00056"></a>00056 <span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00061"></a>00061 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a084ce7da2a33986ff53ccb7e7f88091b" title="Create a new list.">anx_list_new</a> (<span class="keywordtype">void</span>);
<a name="l00062"></a>00062
<a name="l00068"></a>00068 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a04a335b32a78d6bdfaab84e60cafadc5" title="Clone a list using the default clone function.">anx_list_clone</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00069"></a>00069
<a name="l00076"></a>00076 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#aa580f00e7a8bc2078ea7ca4dc3f4b6da" title="Clone a list using a custom clone function.">anx_list_clone_with</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <a class="code" href="anx__core_8h.html#a60b00aacbbed18e944c4917f532e1fdf" title="Signature of a cloning function.">AnxCloneFunc</a> clone);
<a name="l00077"></a>00077
<a name="l00083"></a>00083 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a0e580d63c81f484d7211fd7ba03aea0d" title="Return the tail element of a list.">anx_list_tail</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00084"></a>00084
<a name="l00091"></a>00091 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a6a0d5fded170fd05611425b70f435817" title="Prepend a new node to a list containing given data.">anx_list_prepend</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <span class="keywordtype">void</span> * data);
<a name="l00092"></a>00092
<a name="l00099"></a>00099 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a55fcd10a82aca8e3d65e3f2c529355a2" title="Append a new node to a list containing given data.">anx_list_append</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <span class="keywordtype">void</span> * data);
<a name="l00100"></a>00100
<a name="l00108"></a>00108 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a6498c0ee724e038fb14b3dcbc23897a6" title="Add a new node containing given data before a given node.">anx_list_add_before</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <span class="keywordtype">void</span> * data, <a class="code" href="struct__AnxList.html">AnxList</a> * node);
<a name="l00109"></a>00109
<a name="l00117"></a>00117 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a88e77b6027cb069d3752fa9a752f65dc" title="Add a new node containing given data after a given node.">anx_list_add_after</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <span class="keywordtype">void</span> * data, <a class="code" href="struct__AnxList.html">AnxList</a> * node);
<a name="l00118"></a>00118
<a name="l00125"></a>00125 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#afac0f0f20e529740996fd28cce458ed6" title="Find the first node containing given data in a list.">anx_list_find</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <span class="keywordtype">void</span> * data);
<a name="l00126"></a>00126
<a name="l00133"></a>00133 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#a34ee52e2aec18b7360f1b08960b6f134" title="Remove a node from a list.">anx_list_remove</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <a class="code" href="struct__AnxList.html">AnxList</a> * node);
<a name="l00134"></a>00134
<a name="l00140"></a>00140 <span class="keywordtype">int</span> <a class="code" href="anx__list_8h.html#a1d8d14dce0cb1d55d983ded4692f2a10" title="Query the number of items in a list.">anx_list_length</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00141"></a>00141
<a name="l00147"></a>00147 <span class="keywordtype">int</span> <a class="code" href="anx__list_8h.html#a49b43788f09d53a624122b664b9020d2" title="Query if a list is empty, ie.">anx_list_is_empty</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00148"></a>00148
<a name="l00154"></a>00154 <span class="keywordtype">int</span> <a class="code" href="anx__list_8h.html#ab84476ae2f54d28d4f7627320f426db9" title="Query if the list is singleton, ie.">anx_list_is_singleton</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00155"></a>00155
<a name="l00162"></a>00162 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#ac0996fe92955e20bb6fb937c4eda0f18" title="Free a list, using a given function to free each data element.">anx_list_free_with</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list, <a class="code" href="anx__core_8h.html#a26f09ad7826e5d8608d0a740fba2674a" title="Signature of a freeing function.">AnxFreeFunc</a> free_func);
<a name="l00163"></a>00163
<a name="l00169"></a>00169 <a class="code" href="struct__AnxList.html">AnxList</a> * <a class="code" href="anx__list_8h.html#acac047782cba0cf38c95537473f0d834" title="Free a list, using anx_free() to free each data element.">anx_list_free</a> (<a class="code" href="struct__AnxList.html">AnxList</a> * list);
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00172"></a>00172 <span class="preprocessor"></span>}
<a name="l00173"></a>00173 <span class="preprocessor">#endif</span>
<a name="l00174"></a>00174 <span class="preprocessor"></span>
<a name="l00175"></a>00175 <span class="preprocessor">#endif </span><span class="comment">/* __ANX_LIST_H__ */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
