<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en" xml:lang="en">
<head>
<title>lomoco: lomoco/lomoco_list.h Source File</title>
<style type="text/css">
.cp-doNotDisplay { display: none; }
@media aural, braille, handheld, tty { .cp-doNotDisplay { display: inline; speak: normal; }}
.cp-edit { text-align: right; }
@media print, embossed { .cp-edit { display: none; }}
</style>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="stylesheet" type="text/css" href="doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" href="csync.css" />
<link rel="stylesheet" media="print, embossed" type="text/css" href="print.css" />
</head>
<body>
<ul class="cp-doNotDisplay">
<li><a href="#cp-content" accesskey="2">Skip to content</a></li>
<li><a href="#cp-menu" accesskey="5">Skip to link menu</a></li>
</ul>
<div id="container">
<div id="header">
<div id="header_top"><div><div style="padding: 10px 30px;">
<!-- <img alt ="" src="top-kde.jpg"/> -->
csync API Reference </div></div></div>
<div id="header_bottom">
<div id="location">
<ul>
<li><a href="index.html">csync</a></li>
</ul>
</div>
<div id="menu">
<ul><li><a href="http://www.csync.org/">Sitemap</a></li>
<li><a href="http://www.csync.org/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<!-- End page header -->
<div id="body_wrapper">
<div id="body">
<!-- begin main content -->
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<!-- <h2><a name="content"></a>lomoco</h2> -->
<!-- BC -->
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="dir_77ee8add767687b3d3811ff476d1a4f3.html">lomoco</a>
</div>
<div class="contents">
<h1>lomoco_list.h</h1><a href="lomoco__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"> * lomoco -- a doubly-linked list</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This code is based on glist.{h,c} from glib</span>
<a name="l00005"></a>00005 <span class="comment"> * ftp://ftp.gtk.org/pub/gtk/</span>
<a name="l00006"></a>00006 <span class="comment"> * Copyright (c) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald</span>
<a name="l00007"></a>00007 <span class="comment"> * Copyright (c) 2006 by Andreas Schneider <mail@lomocoapses.org></span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This program is free software; you can redistribute it and/or</span>
<a name="l00010"></a>00010 <span class="comment"> * modify it under the terms of the GNU General Public License</span>
<a name="l00011"></a>00011 <span class="comment"> * as published by the Free Software Foundation; either version 2</span>
<a name="l00012"></a>00012 <span class="comment"> * of the License, or (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00017"></a>00017 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00020"></a>00020 <span class="comment"> * along with this program; if not, write to the Free Software Foundation,</span>
<a name="l00021"></a>00021 <span class="comment"> * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</span>
<a name="l00022"></a>00022 <span class="comment"> *</span>
<a name="l00023"></a>00023 <span class="comment"> * vim: ts=2 sw=2 et cindent</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef LOMOCO_LIST_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define LOMOCO_LIST_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment">/**</span>
<a name="l00030"></a>00030 <span class="comment"> * lomoco_list_t -- a doubly-linked list.</span>
<a name="l00031"></a>00031 <span class="comment"> *</span>
<a name="l00032"></a>00032 <span class="comment"> * The lomoco_list_t structure and its associated functions provide a standard</span>
<a name="l00033"></a>00033 <span class="comment"> * doubly-linked list data structure. Each node has two links: one points to</span>
<a name="l00034"></a>00034 <span class="comment"> * the previous node, or points to a null value or empty list if it is the</span>
<a name="l00035"></a>00035 <span class="comment"> * first node; and one points to the next, or points to a null value or empty</span>
<a name="l00036"></a>00036 <span class="comment"> * list if it is the final node.</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * The data contained in each element can be simply pointers to any type of</span>
<a name="l00039"></a>00039 <span class="comment"> * data. You are the owner of the data, this means you have to free the memory</span>
<a name="l00040"></a>00040 <span class="comment"> * you have allocated for the data.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * @file lomoco_list.h</span>
<a name="l00043"></a>00043 <span class="comment"> */</span>
<a name="l00044"></a>00044 <span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/**</span>
<a name="l00046"></a>00046 <span class="comment"> * An untyped pointer.</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a><a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8">00048</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> *<a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a>;
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">/**</span>
<a name="l00051"></a>00051 <span class="comment"> * An untyped pointer to constant data. The data pointed to should not be</span>
<a name="l00052"></a>00052 <span class="comment"> * changed.</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * This is typically used in function prototypes to indicate that the data</span>
<a name="l00055"></a>00055 <span class="comment"> * pointed to will not be altered by the function.</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a><a class="code" href="lomoco__list_8h.html#1b5b50e6684b4d04d6a1829bbf55aa9a">00057</a> <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code" href="lomoco__list_8h.html#1b5b50e6684b4d04d6a1829bbf55aa9a" title="An untyped pointer to constant data.">lomoco_const_pointer</a>;
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">/**</span>
<a name="l00060"></a>00060 <span class="comment"> * Specifies the type of a comparison function used to compare two values. The</span>
<a name="l00061"></a>00061 <span class="comment"> * value which should be returned depends on the context in which the</span>
<a name="l00062"></a>00062 <span class="comment"> * lomoco_compare_func is used.</span>
<a name="l00063"></a>00063 <span class="comment"> *</span>
<a name="l00064"></a>00064 <span class="comment"> * @param a First parameter to compare with.</span>
<a name="l00065"></a>00065 <span class="comment"> *</span>
<a name="l00066"></a>00066 <span class="comment"> * @param b Second parameter to compare with.</span>
<a name="l00067"></a>00067 <span class="comment"> *</span>
<a name="l00068"></a>00068 <span class="comment"> * @return The function should return a number > 0 if the first</span>
<a name="l00069"></a>00069 <span class="comment"> * parameter comes after the second parameter in the sort</span>
<a name="l00070"></a>00070 <span class="comment"> * order.</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a><a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40">00072</a> <span class="keyword">typedef</span> int (*<a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40" title="Specifies the type of a comparison function used to compare two values.">lomoco_compare_func</a>) (<a class="code" href="lomoco__list_8h.html#1b5b50e6684b4d04d6a1829bbf55aa9a" title="An untyped pointer to constant data.">lomoco_const_pointer</a> a, <a class="code" href="lomoco__list_8h.html#1b5b50e6684b4d04d6a1829bbf55aa9a" title="An untyped pointer to constant data.">lomoco_const_pointer</a> b);
<a name="l00073"></a>00073 <span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">/**</span>
<a name="l00075"></a>00075 <span class="comment"> * Used for each element in a doubly-linked list. The data field holds the</span>
<a name="l00076"></a>00076 <span class="comment"> * element's data, which can be a pointer to any kind of data.</span>
<a name="l00077"></a>00077 <span class="comment"> * The next and prev pointers are the links to the next and previous elements</span>
<a name="l00078"></a>00078 <span class="comment"> * in the list.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a><a class="code" href="structlomoco__list__s.html">00080</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_s</a> {
<a name="l00081"></a><a class="code" href="structlomoco__list__s.html#446d47aefd0f9916743aacf78775a634">00081</a> <span class="keyword">struct </span><a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_s</a> *<a class="code" href="structlomoco__list__s.html#446d47aefd0f9916743aacf78775a634">next</a>;
<a name="l00082"></a><a class="code" href="structlomoco__list__s.html#3256fca5295df98b0188309443df979f">00082</a> <span class="keyword">struct </span><a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_s</a> *<a class="code" href="structlomoco__list__s.html#3256fca5295df98b0188309443df979f">prev</a>;
<a name="l00083"></a>00083
<a name="l00084"></a><a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">00084</a> <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>;
<a name="l00085"></a>00085 } <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a>;
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment">/**</span>
<a name="l00089"></a>00089 <span class="comment"> * Adds a new element on to the end of the list.</span>
<a name="l00090"></a>00090 <span class="comment"> *</span>
<a name="l00091"></a>00091 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00092"></a>00092 <span class="comment"> *</span>
<a name="l00093"></a>00093 <span class="comment"> * @param data The data for the new element.</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00096"></a>00096 <span class="comment"> * sure you store the new value.</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#dea5c72eeb00ee2f827f7d7e5dbc6545" title="Adds a new element on to the end of the list.">lomoco_list_append</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>);
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment">/**</span>
<a name="l00101"></a>00101 <span class="comment"> * Adds a new element on at the beginning of the list.</span>
<a name="l00102"></a>00102 <span class="comment"> *</span>
<a name="l00103"></a>00103 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * @param data The data for the new element.</span>
<a name="l00106"></a>00106 <span class="comment"> *</span>
<a name="l00107"></a>00107 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00108"></a>00108 <span class="comment"> * sure you store the new value.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#e806ac25a57dae4a979949e3b46684c1" title="Adds a new element on at the beginning of the list.">lomoco_list_prepend</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>);
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment">/**</span>
<a name="l00113"></a>00113 <span class="comment"> * Inserts a new element into the list at the given position. If the position</span>
<a name="l00114"></a>00114 <span class="comment"> * is lesser than 0, the new element gets appended to the list, if the position</span>
<a name="l00115"></a>00115 <span class="comment"> * is 0, we prepend the element and if the given position is greater than the</span>
<a name="l00116"></a>00116 <span class="comment"> * length of the list, the element gets appended too.</span>
<a name="l00117"></a>00117 <span class="comment"> *</span>
<a name="l00118"></a>00118 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00119"></a>00119 <span class="comment"> *</span>
<a name="l00120"></a>00120 <span class="comment"> * @param data The data for the new element.</span>
<a name="l00121"></a>00121 <span class="comment"> *</span>
<a name="l00122"></a>00122 <span class="comment"> * @param position The position to insert the element.</span>
<a name="l00123"></a>00123 <span class="comment"> *</span>
<a name="l00124"></a>00124 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00125"></a>00125 <span class="comment"> * sure you store the new value.</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#ba8c805904ac4c15be1d428f844c775d" title="Inserts a new element into the list at the given position.">lomoco_list_insert</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>, <span class="keywordtype">long</span> position);
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/**</span>
<a name="l00130"></a>00130 <span class="comment"> * Inserts a new element into the list, using the given comparison function to</span>
<a name="l00131"></a>00131 <span class="comment"> * determine its position.</span>
<a name="l00132"></a>00132 <span class="comment"> *</span>
<a name="l00133"></a>00133 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * @param data The data for the new element.</span>
<a name="l00136"></a>00136 <span class="comment"> *</span>
<a name="l00137"></a>00137 <span class="comment"> * @param func The function to compare elements in the list. It</span>
<a name="l00138"></a>00138 <span class="comment"> * should return a number > 0 if the first parameter comes</span>
<a name="l00139"></a>00139 <span class="comment"> * after the second parameter in the sort order.</span>
<a name="l00140"></a>00140 <span class="comment"> *</span>
<a name="l00141"></a>00141 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00142"></a>00142 <span class="comment"> * sure you store the new value.</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#e27f42d7be044ca4d0fc63abd034b82d" title="Inserts a new element into the list, using the given comparison function to determine...">lomoco_list_insert_sorted</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>, <a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40" title="Specifies the type of a comparison function used to compare two values.">lomoco_compare_func</a> func);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * Allocates space for one lomoco_list_t element.</span>
<a name="l00148"></a>00148 <span class="comment"> *</span>
<a name="l00149"></a>00149 <span class="comment"> * @return A pointer to the newly-allocated element.</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#e2f9215a66d4b0f98453fdc4249cd0a1" title="Allocates space for one lomoco_list_t element.">lomoco_list_alloc</a>(<span class="keywordtype">void</span>);
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">/**</span>
<a name="l00154"></a>00154 <span class="comment"> * Removes an element from a lomoco_list. If two elements contain the same data,</span>
<a name="l00155"></a>00155 <span class="comment"> * only the first is removed.</span>
<a name="l00156"></a>00156 <span class="comment"> *</span>
<a name="l00157"></a>00157 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00158"></a>00158 <span class="comment"> *</span>
<a name="l00159"></a>00159 <span class="comment"> * @param data The data of the element to remove.</span>
<a name="l00160"></a>00160 <span class="comment"> */</span>
<a name="l00161"></a>00161 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#c32fc5ab851732c141296f2636ce08a2" title="Removes an element from a lomoco_list.">lomoco_list_remove</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>);
<a name="l00162"></a>00162 <span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">/**</span>
<a name="l00164"></a>00164 <span class="comment"> * Frees all elements from a lomoco_list.</span>
<a name="l00165"></a>00165 <span class="comment"> *</span>
<a name="l00166"></a>00166 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00167"></a>00167 <span class="comment"> */</span>
<a name="l00168"></a>00168 <span class="keywordtype">void</span> <a class="code" href="lomoco__list_8h.html#302d352faf582b4ae5ef050b8f69b725" title="Frees all elements from a lomoco_list.">lomoco_list_free</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00169"></a>00169 <span class="comment"></span>
<a name="l00170"></a>00170 <span class="comment">/**</span>
<a name="l00171"></a>00171 <span class="comment"> * Gets the previous element in a lomoco_list.</span>
<a name="l00172"></a>00172 <span class="comment"> *</span>
<a name="l00173"></a>00173 <span class="comment"> * @param An element in a lomoco_list.</span>
<a name="l00174"></a>00174 <span class="comment"> *</span>
<a name="l00175"></a>00175 <span class="comment"> * @return The previous element, or NULL if there are no more</span>
<a name="l00176"></a>00176 <span class="comment"> * elements.</span>
<a name="l00177"></a>00177 <span class="comment"> */</span>
<a name="l00178"></a>00178 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#af2a71b8c35bbf24d6bb9e3b9a6df565" title="Gets the previous element in a lomoco_list.">lomoco_list_previous</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00179"></a>00179 <span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment">/**</span>
<a name="l00181"></a>00181 <span class="comment"> * Gets the next element in a lomoco_list.</span>
<a name="l00182"></a>00182 <span class="comment"> *</span>
<a name="l00183"></a>00183 <span class="comment"> * @param An element in a lomoco_list.</span>
<a name="l00184"></a>00184 <span class="comment"> *</span>
<a name="l00185"></a>00185 <span class="comment"> * @return The next element, or NULL if there are no more</span>
<a name="l00186"></a>00186 <span class="comment"> * elements.</span>
<a name="l00187"></a>00187 <span class="comment"> */</span>
<a name="l00188"></a>00188 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#c11630087f831eea5b3448f5aa087dc9" title="Gets the next element in a lomoco_list.">lomoco_list_next</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">/**</span>
<a name="l00191"></a>00191 <span class="comment"> * Gets the number of elements in a lomoco_list</span>
<a name="l00192"></a>00192 <span class="comment"> *</span>
<a name="l00193"></a>00193 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00194"></a>00194 <span class="comment"> *</span>
<a name="l00195"></a>00195 <span class="comment"> * @return The number of elements</span>
<a name="l00196"></a>00196 <span class="comment"> */</span>
<a name="l00197"></a>00197 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="lomoco__list_8h.html#47ea0bf672152082a9a057f84e325812" title="Gets the number of elements in a lomoco_list.">lomoco_list_length</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00198"></a>00198 <span class="comment"></span>
<a name="l00199"></a>00199 <span class="comment">/**</span>
<a name="l00200"></a>00200 <span class="comment"> * Gets the first element in a lomoco_list</span>
<a name="l00201"></a>00201 <span class="comment"> *</span>
<a name="l00202"></a>00202 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00203"></a>00203 <span class="comment"> *</span>
<a name="l00204"></a>00204 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00205"></a>00205 <span class="comment"> * sure you store the new value.</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#a162e38b57ccd5b278091f8bb5532f5e" title="Gets the first element in a lomoco_list.">lomoco_list_first</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00208"></a>00208 <span class="comment"></span>
<a name="l00209"></a>00209 <span class="comment">/**</span>
<a name="l00210"></a>00210 <span class="comment"> * Gets the last element in a lomoco_list</span>
<a name="l00211"></a>00211 <span class="comment"> *</span>
<a name="l00212"></a>00212 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00213"></a>00213 <span class="comment"> *</span>
<a name="l00214"></a>00214 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00215"></a>00215 <span class="comment"> * sure you store the new value.</span>
<a name="l00216"></a>00216 <span class="comment"> */</span>
<a name="l00217"></a>00217 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#edb48d5a0deb561bf271942aa1577cba" title="Gets the last element in a lomoco_list.">lomoco_list_last</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00218"></a>00218 <span class="comment"></span>
<a name="l00219"></a>00219 <span class="comment">/**</span>
<a name="l00220"></a>00220 <span class="comment"> * Gets the element at the given positon in a lomoco_list.</span>
<a name="l00221"></a>00221 <span class="comment"> *</span>
<a name="l00222"></a>00222 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00223"></a>00223 <span class="comment"> *</span>
<a name="l00224"></a>00224 <span class="comment"> * @param position The position of the element, counting from 0.</span>
<a name="l00225"></a>00225 <span class="comment"> *</span>
<a name="l00226"></a>00226 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00227"></a>00227 <span class="comment"> * sure you store the new value.</span>
<a name="l00228"></a>00228 <span class="comment"> */</span>
<a name="l00229"></a>00229 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#2a84083076eb138b5ca820e3c8074deb" title="Gets the element at the given positon in a lomoco_list.">lomoco_list_position</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <span class="keywordtype">long</span> position);
<a name="l00230"></a>00230 <span class="comment"></span>
<a name="l00231"></a>00231 <span class="comment">/**</span>
<a name="l00232"></a>00232 <span class="comment"> * Finds the element in a lomoco_list_t which contains the given data.</span>
<a name="l00233"></a>00233 <span class="comment"> *</span>
<a name="l00234"></a>00234 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00235"></a>00235 <span class="comment"> *</span>
<a name="l00236"></a>00236 <span class="comment"> * @param data The data of the element to remove.</span>
<a name="l00237"></a>00237 <span class="comment"> *</span>
<a name="l00238"></a>00238 <span class="comment"> * @return The found element or NULL if it is not found.</span>
<a name="l00239"></a>00239 <span class="comment"> */</span>
<a name="l00240"></a>00240 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#674042fddab4d1da1a13cccdae761157" title="Finds the element in a lomoco_list_t which contains the given data.">lomoco_list_find</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>);
<a name="l00241"></a>00241 <span class="comment"></span>
<a name="l00242"></a>00242 <span class="comment">/**</span>
<a name="l00243"></a>00243 <span class="comment"> * Finds an element, using a supplied function to find the desired</span>
<a name="l00244"></a>00244 <span class="comment"> * element.</span>
<a name="l00245"></a>00245 <span class="comment"> *</span>
<a name="l00246"></a>00246 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00247"></a>00247 <span class="comment"> *</span>
<a name="l00248"></a>00248 <span class="comment"> * @param data The data of the element to remove.</span>
<a name="l00249"></a>00249 <span class="comment"> *</span>
<a name="l00250"></a>00250 <span class="comment"> * @param func The function to call for each element. It should</span>
<a name="l00251"></a>00251 <span class="comment"> * return 0 when the desired element is found.</span>
<a name="l00252"></a>00252 <span class="comment"> *</span>
<a name="l00253"></a>00253 <span class="comment"> * @return The found element or NULL if it is not found.</span>
<a name="l00254"></a>00254 <span class="comment"> */</span>
<a name="l00255"></a>00255 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#58f8271d8724d4958c9b009d8592b0a5" title="Finds an element, using a supplied function to find the desired element.">lomoco_list_find_custom</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#78f904678284f1d9f398a957b11684c8" title="An untyped pointer.">lomoco_pointer</a> <a class="code" href="structlomoco__list__s.html#a2bb203ee9a2c91f06e8a9e4cfc27d52">data</a>, <a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40" title="Specifies the type of a comparison function used to compare two values.">lomoco_compare_func</a> func);
<a name="l00256"></a>00256 <span class="comment"></span>
<a name="l00257"></a>00257 <span class="comment">/**</span>
<a name="l00258"></a>00258 <span class="comment"> * Sorts the elements of a lomoco_list.</span>
<a name="l00259"></a>00259 <span class="comment"> * The algorithm used is Mergesort, because that works really well</span>
<a name="l00260"></a>00260 <span class="comment"> * on linked lists, without requiring the O(N) extra space it needs</span>
<a name="l00261"></a>00261 <span class="comment"> * when you do it on arrays.</span>
<a name="l00262"></a>00262 <span class="comment"> *</span>
<a name="l00263"></a>00263 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00264"></a>00264 <span class="comment"> *</span>
<a name="l00265"></a>00265 <span class="comment"> * @param func The comparison function used to sort the lomoco_list. This</span>
<a name="l00266"></a>00266 <span class="comment"> * function is passed 2 elements of the GList and should</span>
<a name="l00267"></a>00267 <span class="comment"> * return 0 if they are equal, a negative value if the first</span>
<a name="l00268"></a>00268 <span class="comment"> * element comes before the second, or a positive value if the</span>
<a name="l00269"></a>00269 <span class="comment"> * first element comes after the second.</span>
<a name="l00270"></a>00270 <span class="comment"> *</span>
<a name="l00271"></a>00271 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00272"></a>00272 <span class="comment"> * sure you store the new value.</span>
<a name="l00273"></a>00273 <span class="comment"> */</span>
<a name="l00274"></a>00274 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#a8e49e4d41892395fb08b13c9b90103d" title="Sorts the elements of a lomoco_list.">lomoco_list_sort</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list, <a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40" title="Specifies the type of a comparison function used to compare two values.">lomoco_compare_func</a> func);
<a name="l00275"></a>00275 <span class="comment"></span>
<a name="l00276"></a>00276 <span class="comment">/**</span>
<a name="l00277"></a>00277 <span class="comment"> * Internal used function to merge 2 lists using a compare function</span>
<a name="l00278"></a>00278 <span class="comment"> *</span>
<a name="l00279"></a>00279 <span class="comment"> * @param list1 A pointer to lomoco_list.</span>
<a name="l00280"></a>00280 <span class="comment"> *</span>
<a name="l00281"></a>00281 <span class="comment"> * @param list2 A pointer to lomoco_list.</span>
<a name="l00282"></a>00282 <span class="comment"> *</span>
<a name="l00283"></a>00283 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00284"></a>00284 <span class="comment"> * sure you store the new value.</span>
<a name="l00285"></a>00285 <span class="comment"> */</span>
<a name="l00286"></a>00286 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#9c8b03aeb96446c0612fc31b0df63df1" title="Internal used function to merge 2 lists using a compare function.">lomoco_list_merge</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list1, <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list2, <a class="code" href="lomoco__list_8h.html#c3e660de6acd020fa598311abb5a5d40" title="Specifies the type of a comparison function used to compare two values.">lomoco_compare_func</a> func);
<a name="l00287"></a>00287 <span class="comment"></span>
<a name="l00288"></a>00288 <span class="comment">/**</span>
<a name="l00289"></a>00289 <span class="comment"> * Internally used function to split 2 lists.</span>
<a name="l00290"></a>00290 <span class="comment"> *</span>
<a name="l00291"></a>00291 <span class="comment"> * @param list A pointer to lomoco_list.</span>
<a name="l00292"></a>00292 <span class="comment"> *</span>
<a name="l00293"></a>00293 <span class="comment"> * @return New start of the list, which may have changed, so make</span>
<a name="l00294"></a>00294 <span class="comment"> * sure you store the new value.</span>
<a name="l00295"></a>00295 <span class="comment"> */</span>
<a name="l00296"></a>00296 <a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *<a class="code" href="lomoco__list_8h.html#c3c297e7fab9916848c7656e9bcf9974" title="Internally used function to split 2 lists.">lomoco_list_split</a>(<a class="code" href="structlomoco__list__s.html" title="Used for each element in a doubly-linked list.">lomoco_list_t</a> *list);
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="preprocessor">#endif </span><span class="comment">/* LOMOCO_LIST_H */</span>
<a name="l00299"></a>00299
</pre></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">lomoco</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "lomoco"</a>
</div></div>
<!-- menu -->
<div class="menu_box">
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">API Documentation</h2>
<a href="#cp-skip-project" class="cp-doNotDisplay">Skip menu "@topname@"</a>
</div></div>
<div class="nav_list">
<ul>
<!-- gmenu -->
</ul></div></div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="clearer"></div>
</div>
<div id="end_body"></div>
<div id="footer"><div id="footer_text">
Generated with <a href="http://www.stack.nl/~dimitri/doxygen/" target="_blank">Doxygen</a>
</div></div>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
48aebc76604d00e261fd2a64f42d7eb8
>
files
>
78
