Update to version 2.33.1
[profile/ivi/glib2.git] / docs / reference / glib / html / glib-Doubly-Linked-Lists.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Doubly-Linked Lists</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GLib Reference Manual">
8 <link rel="up" href="glib-data-types.html" title="GLib Data Types">
9 <link rel="prev" href="glib-data-types.html" title="GLib Data Types">
10 <link rel="next" href="glib-Singly-Linked-Lists.html" title="Singly-Linked Lists">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="glib-data-types.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="glib-data-types.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GLib Reference Manual</th>
21 <td><a accesskey="n" href="glib-Singly-Linked-Lists.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#glib-Doubly-Linked-Lists.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#glib-Doubly-Linked-Lists.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="glib-Doubly-Linked-Lists"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="glib-Doubly-Linked-Lists.top_of_page"></a>Doubly-Linked Lists</span></h2>
34 <p>Doubly-Linked Lists — linked lists that can be iterated over in both directions</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="glib-Doubly-Linked-Lists.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;glib.h&gt;
42
43 struct              <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList">GList</a>;
44
45 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-append" title="g_list_append ()">g_list_append</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
46                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);
47 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-prepend" title="g_list_prepend ()">g_list_prepend</a>                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
48                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);
49 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert" title="g_list_insert ()">g_list_insert</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
50                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
51                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="type">gint</span></a> position</code></em>);
52 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert-before" title="g_list_insert_before ()">g_list_insert_before</a>                (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
53                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *sibling</code></em>,
54                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);
55 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert-sorted" title="g_list_insert_sorted ()">g_list_insert_sorted</a>                (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
56                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
57                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> func</code></em>);
58 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove" title="g_list_remove ()">g_list_remove</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
59                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);
60 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove-link" title="g_list_remove_link ()">g_list_remove_link</a>                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
61                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *llink</code></em>);
62 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-delete-link" title="g_list_delete_link ()">g_list_delete_link</a>                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
63                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *link_</code></em>);
64 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove-all" title="g_list_remove_all ()">g_list_remove_all</a>                   (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
65                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);
66 <span class="returnvalue">void</span>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free" title="g_list_free ()">g_list_free</a>                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
67 <span class="returnvalue">void</span>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free-full" title="g_list_free_full ()">g_list_free_full</a>                    (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
68                                                          <em class="parameter"><code><a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()"><span class="type">GDestroyNotify</span></a> free_func</code></em>);
69
70 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-alloc" title="g_list_alloc ()">g_list_alloc</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
71 <span class="returnvalue">void</span>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free-1" title="g_list_free_1 ()">g_list_free_1</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
72 #define             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free1" title="g_list_free1">g_list_free1</a>
73
74 <a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-length" title="g_list_length ()">g_list_length</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
75 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-copy" title="g_list_copy ()">g_list_copy</a>                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
76 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-reverse" title="g_list_reverse ()">g_list_reverse</a>                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
77 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-sort" title="g_list_sort ()">g_list_sort</a>                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
78                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> compare_func</code></em>);
79 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()">*GCompareFunc</a>)                     (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> a</code></em>,
80                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> b</code></em>);
81 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert-sorted-with-data" title="g_list_insert_sorted_with_data ()">g_list_insert_sorted_with_data</a>      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
82                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
83                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareDataFunc" title="GCompareDataFunc ()"><span class="type">GCompareDataFunc</span></a> func</code></em>,
84                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
85 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-sort-with-data" title="g_list_sort_with_data ()">g_list_sort_with_data</a>               (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
86                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareDataFunc" title="GCompareDataFunc ()"><span class="type">GCompareDataFunc</span></a> compare_func</code></em>,
87                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
88 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (<a class="link" href="glib-Doubly-Linked-Lists.html#GCompareDataFunc" title="GCompareDataFunc ()">*GCompareDataFunc</a>)                 (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> a</code></em>,
89                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> b</code></em>,
90                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
91 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-concat" title="g_list_concat ()">g_list_concat</a>                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list1</code></em>,
92                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list2</code></em>);
93 <span class="returnvalue">void</span>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-foreach" title="g_list_foreach ()">g_list_foreach</a>                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
94                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GFunc" title="GFunc ()"><span class="type">GFunc</span></a> func</code></em>,
95                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
96 <span class="returnvalue">void</span>                (<a class="link" href="glib-Doubly-Linked-Lists.html#GFunc" title="GFunc ()">*GFunc</a>)                            (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
97                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
98
99 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-first" title="g_list_first ()">g_list_first</a>                        (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
100 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-last" title="g_list_last ()">g_list_last</a>                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);
101 #define             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-previous" title="g_list_previous()">g_list_previous</a>                     (list)
102 #define             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-next" title="g_list_next()">g_list_next</a>                         (list)
103 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-nth" title="g_list_nth ()">g_list_nth</a>                          (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
104                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);
105 <a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-nth-data" title="g_list_nth_data ()">g_list_nth_data</a>                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
106                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);
107 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-nth-prev" title="g_list_nth_prev ()">g_list_nth_prev</a>                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
108                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);
109
110 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-find" title="g_list_find ()">g_list_find</a>                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
111                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);
112 <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-find-custom" title="g_list_find_custom ()">g_list_find_custom</a>                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
113                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>,
114                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> func</code></em>);
115 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-position" title="g_list_position ()">g_list_position</a>                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
116                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *llink</code></em>);
117 <a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-index" title="g_list_index ()">g_list_index</a>                        (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
118                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);
119 </pre>
120 </div>
121 <div class="refsect1">
122 <a name="glib-Doubly-Linked-Lists.description"></a><h2>Description</h2>
123 <p>
124 The <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> structure and its associated functions provide a standard
125 doubly-linked list data structure.
126 </p>
127 <p>
128 Each element in the list contains a piece of data, together with
129 pointers which link to the previous and next elements in the list.
130 Using these pointers it is possible to move through the list in both
131 directions (unlike the <a class="link" href="glib-Singly-Linked-Lists.html" title="Singly-Linked Lists">Singly-Linked Lists</a> which
132 only allows movement through the list in the forward direction).
133 </p>
134 <p>
135 The data contained in each element can be either integer values, by
136 using one of the <a class="link" href="glib-Type-Conversion-Macros.html" title="Type Conversion Macros">Type
137 Conversion Macros</a>, or simply pointers to any type of data.
138 </p>
139 <p>
140 List elements are allocated from the <a class="link" href="glib-Memory-Slices.html" title="Memory Slices">slice allocator</a>, which is more
141 efficient than allocating elements individually.
142 </p>
143 <p>
144 Note that most of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> functions expect to be passed a pointer
145 to the first element in the list. The functions which insert
146 elements return the new start of the list, which may have changed.
147 </p>
148 <p>
149 There is no function to create a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>. <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> is considered to be
150 the empty list so you simply set a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>* to <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>.
151 </p>
152 <p>
153 To add elements, use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-append" title="g_list_append ()"><code class="function">g_list_append()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-prepend" title="g_list_prepend ()"><code class="function">g_list_prepend()</code></a>,
154 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert" title="g_list_insert ()"><code class="function">g_list_insert()</code></a> and <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert-sorted" title="g_list_insert_sorted ()"><code class="function">g_list_insert_sorted()</code></a>.
155 </p>
156 <p>
157 To remove elements, use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove" title="g_list_remove ()"><code class="function">g_list_remove()</code></a>.
158 </p>
159 <p>
160 To find elements in the list use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-first" title="g_list_first ()"><code class="function">g_list_first()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-last" title="g_list_last ()"><code class="function">g_list_last()</code></a>,
161 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-next" title="g_list_next()"><code class="function">g_list_next()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-previous" title="g_list_previous()"><code class="function">g_list_previous()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-nth" title="g_list_nth ()"><code class="function">g_list_nth()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-nth-data" title="g_list_nth_data ()"><code class="function">g_list_nth_data()</code></a>,
162 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-find" title="g_list_find ()"><code class="function">g_list_find()</code></a> and <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-find-custom" title="g_list_find_custom ()"><code class="function">g_list_find_custom()</code></a>.
163 </p>
164 <p>
165 To find the index of an element use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-position" title="g_list_position ()"><code class="function">g_list_position()</code></a> and
166 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-index" title="g_list_index ()"><code class="function">g_list_index()</code></a>.
167 </p>
168 <p>
169 To call a function for each element in the list use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-foreach" title="g_list_foreach ()"><code class="function">g_list_foreach()</code></a>.
170 </p>
171 <p>
172 To free the entire list, use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free" title="g_list_free ()"><code class="function">g_list_free()</code></a>.
173 </p>
174 </div>
175 <div class="refsect1">
176 <a name="glib-Doubly-Linked-Lists.details"></a><h2>Details</h2>
177 <div class="refsect2">
178 <a name="GList"></a><h3>struct GList</h3>
179 <pre class="programlisting">struct GList {
180   gpointer data;
181   GList *next;
182   GList *prev;
183 };
184 </pre>
185 <p>
186 The <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> struct is used for each element in a doubly-linked list.
187 </p>
188 <div class="variablelist"><table border="0">
189 <col align="left" valign="top">
190 <tbody>
191 <tr>
192 <td><p><span class="term"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GList.data"></a>data</code></em>;</span></p></td>
193 <td>holds the element's data, which can be a pointer to any kind
194 of data, or any integer value using the <a class="link" href="glib-Type-Conversion-Macros.html" title="Type Conversion Macros">Type Conversion
195 Macros</a>.</td>
196 </tr>
197 <tr>
198 <td><p><span class="term"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GList.next"></a>next</code></em>;</span></p></td>
199 <td>contains the link to the next element in the list.</td>
200 </tr>
201 <tr>
202 <td><p><span class="term"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *<em class="structfield"><code><a name="GList.prev"></a>prev</code></em>;</span></p></td>
203 <td>contains the link to the previous element in the list.</td>
204 </tr>
205 </tbody>
206 </table></div>
207 </div>
208 <hr>
209 <div class="refsect2">
210 <a name="g-list-append"></a><h3>g_list_append ()</h3>
211 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_append                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
212                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
213 <p>
214 Adds a new element on to the end of the list.
215 </p>
216 <p>
217 </p>
218 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
219 <h3 class="title">Note</h3>
220 <p>
221 The return value is the new start of the list, which 
222 may have changed, so make sure you store the new value.
223 </p>
224 </div>
225 <p>
226 </p>
227 <p>
228 </p>
229 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
230 <h3 class="title">Note</h3>
231 <p>
232 Note that <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-append" title="g_list_append ()"><code class="function">g_list_append()</code></a> has to traverse the entire list 
233 to find the end, which is inefficient when adding multiple 
234 elements. A common idiom to avoid the inefficiency is to prepend 
235 the elements and reverse the list when all elements have been added.
236 </p>
237 </div>
238 <p>
239 </p>
240 <p>
241 </p>
242 <div class="informalexample"><pre class="programlisting">
243 /* Notice that these are initialized to the empty list. */
244 GList *list = NULL, *number_list = NULL;
245
246 /* This is a list of strings. */
247 list = g_list_append (list, "first");
248 list = g_list_append (list, "second");
249
250 /* This is a list of integers. */
251 number_list = g_list_append (number_list, GINT_TO_POINTER (27));
252 number_list = g_list_append (number_list, GINT_TO_POINTER (14));
253 </pre></div>
254 <p>
255 </p>
256 <div class="variablelist"><table border="0">
257 <col align="left" valign="top">
258 <tbody>
259 <tr>
260 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
261 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
262 </td>
263 </tr>
264 <tr>
265 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
266 <td>the data for the new element</td>
267 </tr>
268 <tr>
269 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
270 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
271 </td>
272 </tr>
273 </tbody>
274 </table></div>
275 </div>
276 <hr>
277 <div class="refsect2">
278 <a name="g-list-prepend"></a><h3>g_list_prepend ()</h3>
279 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_prepend                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
280                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
281 <p>
282 Adds a new element on to the start of the list.
283 </p>
284 <p>
285 </p>
286 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
287 <h3 class="title">Note</h3>
288 <p>
289 The return value is the new start of the list, which 
290 may have changed, so make sure you store the new value.
291 </p>
292 </div>
293 <p>
294 </p>
295 <p>
296 </p>
297 <div class="informalexample"><pre class="programlisting"> 
298 /* Notice that it is initialized to the empty list. */
299 GList *list = NULL;
300 list = g_list_prepend (list, "last");
301 list = g_list_prepend (list, "first");
302 </pre></div>
303 <p>
304 </p>
305 <div class="variablelist"><table border="0">
306 <col align="left" valign="top">
307 <tbody>
308 <tr>
309 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
310 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
311 </td>
312 </tr>
313 <tr>
314 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
315 <td>the data for the new element</td>
316 </tr>
317 <tr>
318 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
319 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
320 </td>
321 </tr>
322 </tbody>
323 </table></div>
324 </div>
325 <hr>
326 <div class="refsect2">
327 <a name="g-list-insert"></a><h3>g_list_insert ()</h3>
328 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_insert                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
329                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
330                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="type">gint</span></a> position</code></em>);</pre>
331 <p>
332 Inserts a new element into the list at the given position.
333 </p>
334 <div class="variablelist"><table border="0">
335 <col align="left" valign="top">
336 <tbody>
337 <tr>
338 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
339 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
340 </td>
341 </tr>
342 <tr>
343 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
344 <td>the data for the new element</td>
345 </tr>
346 <tr>
347 <td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
348 <td>the position to insert the element. If this is
349 negative, or is larger than the number of elements in the
350 list, the new element is added on to the end of the list.</td>
351 </tr>
352 <tr>
353 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
354 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
355 </td>
356 </tr>
357 </tbody>
358 </table></div>
359 </div>
360 <hr>
361 <div class="refsect2">
362 <a name="g-list-insert-before"></a><h3>g_list_insert_before ()</h3>
363 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_insert_before                (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
364                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *sibling</code></em>,
365                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
366 <p>
367 Inserts a new element into the list before the given position.
368 </p>
369 <div class="variablelist"><table border="0">
370 <col align="left" valign="top">
371 <tbody>
372 <tr>
373 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
374 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
375 </td>
376 </tr>
377 <tr>
378 <td><p><span class="term"><em class="parameter"><code>sibling</code></em> :</span></p></td>
379 <td>the list element before which the new element
380 is inserted or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> to insert at the end of the list</td>
381 </tr>
382 <tr>
383 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
384 <td>the data for the new element</td>
385 </tr>
386 <tr>
387 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
388 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
389 </td>
390 </tr>
391 </tbody>
392 </table></div>
393 </div>
394 <hr>
395 <div class="refsect2">
396 <a name="g-list-insert-sorted"></a><h3>g_list_insert_sorted ()</h3>
397 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_insert_sorted                (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
398                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
399                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> func</code></em>);</pre>
400 <p>
401 Inserts a new element into the list, using the given comparison 
402 function to determine its position.
403 </p>
404 <div class="variablelist"><table border="0">
405 <col align="left" valign="top">
406 <tbody>
407 <tr>
408 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
409 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
410 </td>
411 </tr>
412 <tr>
413 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
414 <td>the data for the new element</td>
415 </tr>
416 <tr>
417 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
418 <td>the function to compare elements in the list. It should
419 return a number &gt; 0 if the first parameter comes after the
420 second parameter in the sort order.</td>
421 </tr>
422 <tr>
423 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
424 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
425 </td>
426 </tr>
427 </tbody>
428 </table></div>
429 </div>
430 <hr>
431 <div class="refsect2">
432 <a name="g-list-remove"></a><h3>g_list_remove ()</h3>
433 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_remove                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
434                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);</pre>
435 <p>
436 Removes an element from a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
437 If two elements contain the same data, only the first is removed.
438 If none of the elements contain the data, the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> is unchanged.
439 </p>
440 <div class="variablelist"><table border="0">
441 <col align="left" valign="top">
442 <tbody>
443 <tr>
444 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
445 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
446 </td>
447 </tr>
448 <tr>
449 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
450 <td>the data of the element to remove</td>
451 </tr>
452 <tr>
453 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
454 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
455 </td>
456 </tr>
457 </tbody>
458 </table></div>
459 </div>
460 <hr>
461 <div class="refsect2">
462 <a name="g-list-remove-link"></a><h3>g_list_remove_link ()</h3>
463 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_remove_link                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
464                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *llink</code></em>);</pre>
465 <p>
466 Removes an element from a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>, without freeing the element.
467 The removed element's prev and next links are set to <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a>, so 
468 that it becomes a self-contained list with one element.
469 </p>
470 <div class="variablelist"><table border="0">
471 <col align="left" valign="top">
472 <tbody>
473 <tr>
474 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
475 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
476 </td>
477 </tr>
478 <tr>
479 <td><p><span class="term"><em class="parameter"><code>llink</code></em> :</span></p></td>
480 <td>an element in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
481 </td>
482 </tr>
483 <tr>
484 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
485 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>, without the element</td>
486 </tr>
487 </tbody>
488 </table></div>
489 </div>
490 <hr>
491 <div class="refsect2">
492 <a name="g-list-delete-link"></a><h3>g_list_delete_link ()</h3>
493 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_delete_link                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
494                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *link_</code></em>);</pre>
495 <p>
496 Removes the node link_ from the list and frees it. 
497 Compare this to <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove-link" title="g_list_remove_link ()"><code class="function">g_list_remove_link()</code></a> which removes the node 
498 without freeing it.
499 </p>
500 <div class="variablelist"><table border="0">
501 <col align="left" valign="top">
502 <tbody>
503 <tr>
504 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
505 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
506 </td>
507 </tr>
508 <tr>
509 <td><p><span class="term"><em class="parameter"><code>link_</code></em> :</span></p></td>
510 <td>node to delete from <em class="parameter"><code>list</code></em>
511 </td>
512 </tr>
513 <tr>
514 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
515 <td>the new head of <em class="parameter"><code>list</code></em>
516 </td>
517 </tr>
518 </tbody>
519 </table></div>
520 </div>
521 <hr>
522 <div class="refsect2">
523 <a name="g-list-remove-all"></a><h3>g_list_remove_all ()</h3>
524 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_remove_all                   (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
525                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);</pre>
526 <p>
527 Removes all list nodes with data equal to <em class="parameter"><code>data</code></em>. 
528 Returns the new head of the list. Contrast with 
529 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove" title="g_list_remove ()"><code class="function">g_list_remove()</code></a> which removes only the first node 
530 matching the given data.
531 </p>
532 <div class="variablelist"><table border="0">
533 <col align="left" valign="top">
534 <tbody>
535 <tr>
536 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
537 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
538 </td>
539 </tr>
540 <tr>
541 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
542 <td>data to remove</td>
543 </tr>
544 <tr>
545 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
546 <td>new head of <em class="parameter"><code>list</code></em>
547 </td>
548 </tr>
549 </tbody>
550 </table></div>
551 </div>
552 <hr>
553 <div class="refsect2">
554 <a name="g-list-free"></a><h3>g_list_free ()</h3>
555 <pre class="programlisting"><span class="returnvalue">void</span>                g_list_free                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
556 <p>
557 Frees all of the memory used by a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
558 The freed elements are returned to the slice allocator.
559 </p>
560 <p>
561 </p>
562 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
563 <h3 class="title">Note</h3>
564 <p>
565 If list elements contain dynamically-allocated memory, 
566 you should either use <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free-full" title="g_list_free_full ()"><code class="function">g_list_free_full()</code></a> or free them manually
567 first.
568 </p>
569 </div>
570 <p>
571 </p>
572 <div class="variablelist"><table border="0">
573 <col align="left" valign="top">
574 <tbody><tr>
575 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
576 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
577 </td>
578 </tr></tbody>
579 </table></div>
580 </div>
581 <hr>
582 <div class="refsect2">
583 <a name="g-list-free-full"></a><h3>g_list_free_full ()</h3>
584 <pre class="programlisting"><span class="returnvalue">void</span>                g_list_free_full                    (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
585                                                          <em class="parameter"><code><a class="link" href="glib-Datasets.html#GDestroyNotify" title="GDestroyNotify ()"><span class="type">GDestroyNotify</span></a> free_func</code></em>);</pre>
586 <p>
587 Convenience method, which frees all the memory used by a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>, and
588 calls the specified destroy function on every element's data.
589 </p>
590 <div class="variablelist"><table border="0">
591 <col align="left" valign="top">
592 <tbody>
593 <tr>
594 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
595 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
596 </td>
597 </tr>
598 <tr>
599 <td><p><span class="term"><em class="parameter"><code>free_func</code></em> :</span></p></td>
600 <td>the function to be called to free each element's data</td>
601 </tr>
602 </tbody>
603 </table></div>
604 <p class="since">Since 2.28</p>
605 </div>
606 <hr>
607 <div class="refsect2">
608 <a name="g-list-alloc"></a><h3>g_list_alloc ()</h3>
609 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_alloc                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
610 <p>
611 Allocates space for one <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element. It is called by
612 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-append" title="g_list_append ()"><code class="function">g_list_append()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-prepend" title="g_list_prepend ()"><code class="function">g_list_prepend()</code></a>, <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert" title="g_list_insert ()"><code class="function">g_list_insert()</code></a> and
613 <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-insert-sorted" title="g_list_insert_sorted ()"><code class="function">g_list_insert_sorted()</code></a> and so is rarely used on its own.
614 </p>
615 <div class="variablelist"><table border="0">
616 <col align="left" valign="top">
617 <tbody><tr>
618 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
619 <td>a pointer to the newly-allocated <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element.</td>
620 </tr></tbody>
621 </table></div>
622 </div>
623 <hr>
624 <div class="refsect2">
625 <a name="g-list-free-1"></a><h3>g_list_free_1 ()</h3>
626 <pre class="programlisting"><span class="returnvalue">void</span>                g_list_free_1                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
627 <p>
628 Frees one <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element.
629 It is usually used after <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-remove-link" title="g_list_remove_link ()"><code class="function">g_list_remove_link()</code></a>.
630 </p>
631 <div class="variablelist"><table border="0">
632 <col align="left" valign="top">
633 <tbody><tr>
634 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
635 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element</td>
636 </tr></tbody>
637 </table></div>
638 </div>
639 <hr>
640 <div class="refsect2">
641 <a name="g-list-free1"></a><h3>g_list_free1</h3>
642 <pre class="programlisting">#define             g_list_free1</pre>
643 <p>
644 Another name for <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-free-1" title="g_list_free_1 ()"><code class="function">g_list_free_1()</code></a>.
645 </p>
646 </div>
647 <hr>
648 <div class="refsect2">
649 <a name="g-list-length"></a><h3>g_list_length ()</h3>
650 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="returnvalue">guint</span></a>               g_list_length                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
651 <p>
652 Gets the number of elements in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
653 </p>
654 <p>
655 </p>
656 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
657 <h3 class="title">Note</h3>
658 <p>
659 This function iterates over the whole list to 
660 count its elements.
661 </p>
662 </div>
663 <p>
664 </p>
665 <div class="variablelist"><table border="0">
666 <col align="left" valign="top">
667 <tbody>
668 <tr>
669 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
670 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
671 </td>
672 </tr>
673 <tr>
674 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
675 <td>the number of elements in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
676 </td>
677 </tr>
678 </tbody>
679 </table></div>
680 </div>
681 <hr>
682 <div class="refsect2">
683 <a name="g-list-copy"></a><h3>g_list_copy ()</h3>
684 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_copy                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
685 <p>
686 Copies a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
687 </p>
688 <p>
689 </p>
690 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
691 <h3 class="title">Note</h3>
692 <p>
693 Note that this is a "shallow" copy. If the list elements 
694 consist of pointers to data, the pointers are copied but 
695 the actual data is not.
696 </p>
697 </div>
698 <p>
699 </p>
700 <div class="variablelist"><table border="0">
701 <col align="left" valign="top">
702 <tbody>
703 <tr>
704 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
705 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
706 </td>
707 </tr>
708 <tr>
709 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
710 <td>a copy of <em class="parameter"><code>list</code></em>
711 </td>
712 </tr>
713 </tbody>
714 </table></div>
715 </div>
716 <hr>
717 <div class="refsect2">
718 <a name="g-list-reverse"></a><h3>g_list_reverse ()</h3>
719 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_reverse                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
720 <p>
721 Reverses a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
722 It simply switches the next and prev pointers of each element.
723 </p>
724 <div class="variablelist"><table border="0">
725 <col align="left" valign="top">
726 <tbody>
727 <tr>
728 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
729 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
730 </td>
731 </tr>
732 <tr>
733 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
734 <td>the start of the reversed <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
735 </td>
736 </tr>
737 </tbody>
738 </table></div>
739 </div>
740 <hr>
741 <div class="refsect2">
742 <a name="g-list-sort"></a><h3>g_list_sort ()</h3>
743 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_sort                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
744                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> compare_func</code></em>);</pre>
745 <p>
746 Sorts a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> using the given comparison function. The algorithm 
747 used is a stable sort.
748 </p>
749 <div class="variablelist"><table border="0">
750 <col align="left" valign="top">
751 <tbody>
752 <tr>
753 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
754 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
755 </td>
756 </tr>
757 <tr>
758 <td><p><span class="term"><em class="parameter"><code>compare_func</code></em> :</span></p></td>
759 <td>the comparison function used to sort the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
760 This function is passed the data from 2 elements of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
761 and should return 0 if they are equal, a negative value if the
762 first element comes before the second, or a positive value if
763 the first element comes after the second.</td>
764 </tr>
765 <tr>
766 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
767 <td>the start of the sorted <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
768 </td>
769 </tr>
770 </tbody>
771 </table></div>
772 </div>
773 <hr>
774 <div class="refsect2">
775 <a name="GCompareFunc"></a><h3>GCompareFunc ()</h3>
776 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (*GCompareFunc)                     (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> a</code></em>,
777                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> b</code></em>);</pre>
778 <p>
779 Specifies the type of a comparison function used to compare two
780 values.  The function should return a negative integer if the first
781 value comes before the second, 0 if they are equal, or a positive
782 integer if the first value comes after the second.
783 </p>
784 <div class="variablelist"><table border="0">
785 <col align="left" valign="top">
786 <tbody>
787 <tr>
788 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
789 <td>a value.</td>
790 </tr>
791 <tr>
792 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
793 <td>a value to compare with.</td>
794 </tr>
795 <tr>
796 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
797 <td>negative value if <em class="parameter"><code>a</code></em> &lt; <em class="parameter"><code>b</code></em>; zero if <em class="parameter"><code>a</code></em> = <em class="parameter"><code>b</code></em>; positive
798 value if <em class="parameter"><code>a</code></em> &gt; <em class="parameter"><code>b</code></em>.</td>
799 </tr>
800 </tbody>
801 </table></div>
802 </div>
803 <hr>
804 <div class="refsect2">
805 <a name="g-list-insert-sorted-with-data"></a><h3>g_list_insert_sorted_with_data ()</h3>
806 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_insert_sorted_with_data      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
807                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
808                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareDataFunc" title="GCompareDataFunc ()"><span class="type">GCompareDataFunc</span></a> func</code></em>,
809                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
810 <p>
811 Inserts a new element into the list, using the given comparison 
812 function to determine its position.
813 </p>
814 <div class="variablelist"><table border="0">
815 <col align="left" valign="top">
816 <tbody>
817 <tr>
818 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
819 <td>a pointer to a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
820 </td>
821 </tr>
822 <tr>
823 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
824 <td>the data for the new element</td>
825 </tr>
826 <tr>
827 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
828 <td>the function to compare elements in the list.
829 It should return a number &gt; 0 if the first parameter
830 comes after the second parameter in the sort order.</td>
831 </tr>
832 <tr>
833 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
834 <td>user data to pass to comparison function.</td>
835 </tr>
836 <tr>
837 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
838 <td>the new start of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
839 </td>
840 </tr>
841 </tbody>
842 </table></div>
843 <p class="since">Since 2.10</p>
844 </div>
845 <hr>
846 <div class="refsect2">
847 <a name="g-list-sort-with-data"></a><h3>g_list_sort_with_data ()</h3>
848 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_sort_with_data               (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
849                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareDataFunc" title="GCompareDataFunc ()"><span class="type">GCompareDataFunc</span></a> compare_func</code></em>,
850                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
851 <p>
852 Like <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-sort" title="g_list_sort ()"><code class="function">g_list_sort()</code></a>, but the comparison function accepts 
853 a user data argument.
854 </p>
855 <div class="variablelist"><table border="0">
856 <col align="left" valign="top">
857 <tbody>
858 <tr>
859 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
860 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
861 </td>
862 </tr>
863 <tr>
864 <td><p><span class="term"><em class="parameter"><code>compare_func</code></em> :</span></p></td>
865 <td>comparison function</td>
866 </tr>
867 <tr>
868 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
869 <td>user data to pass to comparison function</td>
870 </tr>
871 <tr>
872 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
873 <td>the new head of <em class="parameter"><code>list</code></em>
874 </td>
875 </tr>
876 </tbody>
877 </table></div>
878 </div>
879 <hr>
880 <div class="refsect2">
881 <a name="GCompareDataFunc"></a><h3>GCompareDataFunc ()</h3>
882 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                (*GCompareDataFunc)                 (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> a</code></em>,
883                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> b</code></em>,
884                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
885 <p>
886 Specifies the type of a comparison function used to compare two
887 values.  The function should return a negative integer if the first
888 value comes before the second, 0 if they are equal, or a positive
889 integer if the first value comes after the second.
890 </p>
891 <div class="variablelist"><table border="0">
892 <col align="left" valign="top">
893 <tbody>
894 <tr>
895 <td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
896 <td>a value.</td>
897 </tr>
898 <tr>
899 <td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
900 <td>a value to compare with.</td>
901 </tr>
902 <tr>
903 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
904 <td>user data to pass to comparison function.</td>
905 </tr>
906 <tr>
907 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
908 <td>negative value if <em class="parameter"><code>a</code></em> &lt; <em class="parameter"><code>b</code></em>; zero if <em class="parameter"><code>a</code></em> = <em class="parameter"><code>b</code></em>; positive
909 value if <em class="parameter"><code>a</code></em> &gt; <em class="parameter"><code>b</code></em>.</td>
910 </tr>
911 </tbody>
912 </table></div>
913 </div>
914 <hr>
915 <div class="refsect2">
916 <a name="g-list-concat"></a><h3>g_list_concat ()</h3>
917 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_concat                       (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list1</code></em>,
918                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list2</code></em>);</pre>
919 <p>
920 Adds the second <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> onto the end of the first <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
921 Note that the elements of the second <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> are not copied.
922 They are used directly.
923 </p>
924 <div class="variablelist"><table border="0">
925 <col align="left" valign="top">
926 <tbody>
927 <tr>
928 <td><p><span class="term"><em class="parameter"><code>list1</code></em> :</span></p></td>
929 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
930 </td>
931 </tr>
932 <tr>
933 <td><p><span class="term"><em class="parameter"><code>list2</code></em> :</span></p></td>
934 <td>the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> to add to the end of the first <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
935 </td>
936 </tr>
937 <tr>
938 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
939 <td>the start of the new <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
940 </td>
941 </tr>
942 </tbody>
943 </table></div>
944 </div>
945 <hr>
946 <div class="refsect2">
947 <a name="g-list-foreach"></a><h3>g_list_foreach ()</h3>
948 <pre class="programlisting"><span class="returnvalue">void</span>                g_list_foreach                      (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
949                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GFunc" title="GFunc ()"><span class="type">GFunc</span></a> func</code></em>,
950                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
951 <p>
952 Calls a function for each element of a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
953 </p>
954 <div class="variablelist"><table border="0">
955 <col align="left" valign="top">
956 <tbody>
957 <tr>
958 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
959 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
960 </td>
961 </tr>
962 <tr>
963 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
964 <td>the function to call with each element's data</td>
965 </tr>
966 <tr>
967 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
968 <td>user data to pass to the function</td>
969 </tr>
970 </tbody>
971 </table></div>
972 </div>
973 <hr>
974 <div class="refsect2">
975 <a name="GFunc"></a><h3>GFunc ()</h3>
976 <pre class="programlisting"><span class="returnvalue">void</span>                (*GFunc)                            (<em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> data</code></em>,
977                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
978 <p>
979 Specifies the type of functions passed to <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-foreach" title="g_list_foreach ()"><code class="function">g_list_foreach()</code></a> and
980 <a class="link" href="glib-Singly-Linked-Lists.html#g-slist-foreach" title="g_slist_foreach ()"><code class="function">g_slist_foreach()</code></a>.
981 </p>
982 <div class="variablelist"><table border="0">
983 <col align="left" valign="top">
984 <tbody>
985 <tr>
986 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
987 <td>the element's data.</td>
988 </tr>
989 <tr>
990 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
991 <td>user data passed to <a class="link" href="glib-Doubly-Linked-Lists.html#g-list-foreach" title="g_list_foreach ()"><code class="function">g_list_foreach()</code></a> or
992 <a class="link" href="glib-Singly-Linked-Lists.html#g-slist-foreach" title="g_slist_foreach ()"><code class="function">g_slist_foreach()</code></a>.</td>
993 </tr>
994 </tbody>
995 </table></div>
996 </div>
997 <hr>
998 <div class="refsect2">
999 <a name="g-list-first"></a><h3>g_list_first ()</h3>
1000 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_first                        (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
1001 <p>
1002 Gets the first element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
1003 </p>
1004 <div class="variablelist"><table border="0">
1005 <col align="left" valign="top">
1006 <tbody>
1007 <tr>
1008 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1009 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1010 </td>
1011 </tr>
1012 <tr>
1013 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1014 <td>the first element in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>,
1015 or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> has no elements</td>
1016 </tr>
1017 </tbody>
1018 </table></div>
1019 </div>
1020 <hr>
1021 <div class="refsect2">
1022 <a name="g-list-last"></a><h3>g_list_last ()</h3>
1023 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_last                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>);</pre>
1024 <p>
1025 Gets the last element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
1026 </p>
1027 <div class="variablelist"><table border="0">
1028 <col align="left" valign="top">
1029 <tbody>
1030 <tr>
1031 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1032 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1033 </td>
1034 </tr>
1035 <tr>
1036 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1037 <td>the last element in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>,
1038 or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> has no elements</td>
1039 </tr>
1040 </tbody>
1041 </table></div>
1042 </div>
1043 <hr>
1044 <div class="refsect2">
1045 <a name="g-list-previous"></a><h3>g_list_previous()</h3>
1046 <pre class="programlisting">#define             g_list_previous(list)</pre>
1047 <p>
1048 A convenience macro to get the previous element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
1049 </p>
1050 <div class="variablelist"><table border="0">
1051 <col align="left" valign="top">
1052 <tbody>
1053 <tr>
1054 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1055 <td>an element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.</td>
1056 </tr>
1057 <tr>
1058 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1059 <td>the previous element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if there are no previous
1060 elements.</td>
1061 </tr>
1062 </tbody>
1063 </table></div>
1064 </div>
1065 <hr>
1066 <div class="refsect2">
1067 <a name="g-list-next"></a><h3>g_list_next()</h3>
1068 <pre class="programlisting">#define             g_list_next(list)</pre>
1069 <p>
1070 A convenience macro to get the next element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
1071 </p>
1072 <div class="variablelist"><table border="0">
1073 <col align="left" valign="top">
1074 <tbody>
1075 <tr>
1076 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1077 <td>an element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.</td>
1078 </tr>
1079 <tr>
1080 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1081 <td>the next element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if there are no more elements.</td>
1082 </tr>
1083 </tbody>
1084 </table></div>
1085 </div>
1086 <hr>
1087 <div class="refsect2">
1088 <a name="g-list-nth"></a><h3>g_list_nth ()</h3>
1089 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_nth                          (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1090                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);</pre>
1091 <p>
1092 Gets the element at the given position in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>.
1093 </p>
1094 <div class="variablelist"><table border="0">
1095 <col align="left" valign="top">
1096 <tbody>
1097 <tr>
1098 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1099 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1100 </td>
1101 </tr>
1102 <tr>
1103 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
1104 <td>the position of the element, counting from 0</td>
1105 </tr>
1106 <tr>
1107 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1108 <td>the element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the position is off
1109 the end of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1110 </td>
1111 </tr>
1112 </tbody>
1113 </table></div>
1114 </div>
1115 <hr>
1116 <div class="refsect2">
1117 <a name="g-list-nth-data"></a><h3>g_list_nth_data ()</h3>
1118 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gpointer" title="gpointer"><span class="returnvalue">gpointer</span></a>            g_list_nth_data                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1119                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);</pre>
1120 <p>
1121 Gets the data of the element at the given position.
1122 </p>
1123 <div class="variablelist"><table border="0">
1124 <col align="left" valign="top">
1125 <tbody>
1126 <tr>
1127 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1128 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1129 </td>
1130 </tr>
1131 <tr>
1132 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
1133 <td>the position of the element</td>
1134 </tr>
1135 <tr>
1136 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1137 <td>the element's data, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the position
1138 is off the end of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1139 </td>
1140 </tr>
1141 </tbody>
1142 </table></div>
1143 </div>
1144 <hr>
1145 <div class="refsect2">
1146 <a name="g-list-nth-prev"></a><h3>g_list_nth_prev ()</h3>
1147 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_nth_prev                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1148                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#guint" title="guint"><span class="type">guint</span></a> n</code></em>);</pre>
1149 <p>
1150 Gets the element <em class="parameter"><code>n</code></em> places before <em class="parameter"><code>list</code></em>.
1151 </p>
1152 <div class="variablelist"><table border="0">
1153 <col align="left" valign="top">
1154 <tbody>
1155 <tr>
1156 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1157 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1158 </td>
1159 </tr>
1160 <tr>
1161 <td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
1162 <td>the position of the element, counting from 0</td>
1163 </tr>
1164 <tr>
1165 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1166 <td>the element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if the position is
1167 off the end of the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1168 </td>
1169 </tr>
1170 </tbody>
1171 </table></div>
1172 </div>
1173 <hr>
1174 <div class="refsect2">
1175 <a name="g-list-find"></a><h3>g_list_find ()</h3>
1176 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_find                         (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1177                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);</pre>
1178 <p>
1179 Finds the element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> which 
1180 contains the given data.
1181 </p>
1182 <div class="variablelist"><table border="0">
1183 <col align="left" valign="top">
1184 <tbody>
1185 <tr>
1186 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1187 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1188 </td>
1189 </tr>
1190 <tr>
1191 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1192 <td>the element data to find</td>
1193 </tr>
1194 <tr>
1195 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1196 <td>the found <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element,
1197 or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if it is not found</td>
1198 </tr>
1199 </tbody>
1200 </table></div>
1201 </div>
1202 <hr>
1203 <div class="refsect2">
1204 <a name="g-list-find-custom"></a><h3>g_list_find_custom ()</h3>
1205 <pre class="programlisting"><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="returnvalue">GList</span></a> *             g_list_find_custom                  (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1206                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>,
1207                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GCompareFunc" title="GCompareFunc ()"><span class="type">GCompareFunc</span></a> func</code></em>);</pre>
1208 <p>
1209 Finds an element in a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>, using a supplied function to 
1210 find the desired element. It iterates over the list, calling 
1211 the given function which should return 0 when the desired 
1212 element is found. The function takes two <a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> arguments, 
1213 the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element's data as the first argument and the 
1214 given user data.
1215 </p>
1216 <div class="variablelist"><table border="0">
1217 <col align="left" valign="top">
1218 <tbody>
1219 <tr>
1220 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1221 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1222 </td>
1223 </tr>
1224 <tr>
1225 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1226 <td>user data passed to the function</td>
1227 </tr>
1228 <tr>
1229 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
1230 <td>the function to call for each element.
1231 It should return 0 when the desired element is found</td>
1232 </tr>
1233 <tr>
1234 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1235 <td>the found <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> element, or <a class="link" href="glib-Standard-Macros.html#NULL:CAPS" title="NULL"><code class="literal">NULL</code></a> if it is not found</td>
1236 </tr>
1237 </tbody>
1238 </table></div>
1239 </div>
1240 <hr>
1241 <div class="refsect2">
1242 <a name="g-list-position"></a><h3>g_list_position ()</h3>
1243 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                g_list_position                     (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1244                                                          <em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *llink</code></em>);</pre>
1245 <p>
1246 Gets the position of the given element 
1247 in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> (starting from 0).
1248 </p>
1249 <div class="variablelist"><table border="0">
1250 <col align="left" valign="top">
1251 <tbody>
1252 <tr>
1253 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1254 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1255 </td>
1256 </tr>
1257 <tr>
1258 <td><p><span class="term"><em class="parameter"><code>llink</code></em> :</span></p></td>
1259 <td>an element in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1260 </td>
1261 </tr>
1262 <tr>
1263 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1264 <td>the position of the element in the <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>,
1265 or -1 if the element is not found</td>
1266 </tr>
1267 </tbody>
1268 </table></div>
1269 </div>
1270 <hr>
1271 <div class="refsect2">
1272 <a name="g-list-index"></a><h3>g_list_index ()</h3>
1273 <pre class="programlisting"><a class="link" href="glib-Basic-Types.html#gint" title="gint"><span class="returnvalue">gint</span></a>                g_list_index                        (<em class="parameter"><code><a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a> *list</code></em>,
1274                                                          <em class="parameter"><code><a class="link" href="glib-Basic-Types.html#gconstpointer" title="gconstpointer"><span class="type">gconstpointer</span></a> data</code></em>);</pre>
1275 <p>
1276 Gets the position of the element containing 
1277 the given data (starting from 0).
1278 </p>
1279 <div class="variablelist"><table border="0">
1280 <col align="left" valign="top">
1281 <tbody>
1282 <tr>
1283 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
1284 <td>a <a class="link" href="glib-Doubly-Linked-Lists.html#GList" title="struct GList"><span class="type">GList</span></a>
1285 </td>
1286 </tr>
1287 <tr>
1288 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1289 <td>the data to find</td>
1290 </tr>
1291 <tr>
1292 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1293 <td>the index of the element containing the data,
1294 or -1 if the data is not found</td>
1295 </tr>
1296 </tbody>
1297 </table></div>
1298 </div>
1299 </div>
1300 </div>
1301 <div class="footer">
1302 <hr>
1303           Generated by GTK-Doc V1.18</div>
1304 </body>
1305 </html>