about summary refs log tree commit diff
path: root/converter/other/fiasco/lib/list.c
blob: 24ba4985177b9da171115dc096571460f5016040 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/*
 *  list.c:             List operations
 *
 *  Written by:         Ullrich Hafner
 *
 *  This file is part of FIASCO (Fractal Image And Sequence COdec)
 *  Copyright (C) 1994-2000 Ullrich Hafner
 */

/*
 *  $Date: 2000/06/14 20:49:37 $
 *  $Author: hafner $
 *  $Revision: 5.1 $
 *  $State: Exp $
 */

#include "config.h"

#include <string.h>

#include "types.h"
#include "macros.h"
#include "error.h"

#include "misc.h"
#include "list.h"

/*****************************************************************************

                                public code

*****************************************************************************/

list_t *
alloc_list (size_t size_of_element)
/*
 *  List constructor:
 *  Allocate a new list.
 *  Size of list element values is given by 'size_of_element'.
 *
 *  Return value:
 *      pointer to an empty list
 */
{
   list_t *new_list = Calloc (1, sizeof (list_t));

   assert (size_of_element > 0);

   new_list->head            = NULL;
   new_list->tail            = NULL;
   new_list->size_of_element = size_of_element;

   return new_list;
}

void
free_list (list_t *list)
/*
 *  List destructor:
 *  Discard list and its elements.
 *
 *  No return value.
 *
 *  Side effects:
 *      struct 'list' is discarded
 */
{
   assert (list);

   while (list_remove (list, HEAD, NULL))
      ;
   Free (list);
}

void
list_insert (list_t *list, pos_e pos, const void *data)
/*
 *  Insert a new 'list' element at head ('pos' = HEAD) or
 *  tail ('pos' = TAIL) of 'list'.
 *  'data' is a pointer to a memory segment of size
 *  'list'->size_of_element containing the value to store.
 *  The value is directly copied - no references are stored.
 *
 *  No return value.
 *
 *  Side effects:
 *      lists current tail or head is replaced by the new element
 */
{
   node_t *element;

   assert (list && data);

   element        = Calloc (1, sizeof (node_t));
   element->value = Calloc (1, list->size_of_element);
   memcpy (element->value, data, list->size_of_element);

   if (pos == TAIL)
   {
      element->next = NULL;
      element->prev = list->tail;
      if (list->tail)
         list->tail->next = element;
      list->tail = element;
      if (!list->head)
         list->head = element;
   }
   else                                 /* pos == HEAD */
   {
      element->prev = NULL;
      element->next = list->head;
      if (list->head)
         list->head->prev = element;
      list->head = element;
      if (!list->tail)
         list->tail = element;
   }
}

bool_t
list_remove (list_t *list, pos_e pos, void *data)
/*
 *  Remove 'list' element from head or tail of 'list'.
 *
 *  Return value:
 *      TRUE on success,
 *      FALSE if list is empty or
 *            if list value data is NULL
 *
 *  Side effects:
 *      lists current head or tail is removed
 *      value of the removed list element (if not NULL) is copied to
 *      'data' (if 'data' is not NULL)
 */
{
   node_t *element;
   void   *valueptr;

   assert (list);

   if (pos == TAIL)
   {
      element = list->tail;
      if (element)
      {
         list->tail = element->prev;
         valueptr   = element->value;
         Free (element);
      }
      else
         valueptr = NULL;
      if (!list->tail)                  /* 'element' was last node */
         list->head = NULL;
   }
   else                                 /* pos == HEAD */
   {
      element = list->head;
      if (element)
      {
         list->head = element->next;
         valueptr   = element->value;
         Free (element);
      }
      else
         valueptr = NULL;
      if (!list->head)                  /* 'element' was last node */
         list->tail = NULL;
   }

   if (valueptr)                        /* copy value of node */
   {
      if (data)
         memcpy (data, valueptr, list->size_of_element);
      Free (valueptr);
   }

   return valueptr ? TRUE : FALSE;
}

bool_t
list_element_n (const list_t *list, pos_e pos, unsigned n, void *data)
/*
 *  Get value of 'list' element number 'n'.
 *  (First element is list head if 'pos' == HEAD
 *                 or list tail if 'pos' == TAIL.
 *   Accordingly, traverse the list in ascending or descending order).
 *
 *  Return value:
 *      TRUE on success, FALSE if there is no element 'n'
 *
 *  Side effects:
 *      value of list element 'n' is copied to 'data'
 */
{
   node_t *element;

   assert (list && data);

   if (pos == HEAD)
      for (element = list->head; element != NULL && n;
           element = element->next, n--)
         ;
   else
      for (element = list->tail; element != NULL && n;
           element = element->prev, n--)
         ;

   if (element)
   {
      memcpy (data, element->value, list->size_of_element);
      return TRUE;
   }
   else
      return FALSE;
}

unsigned
list_sizeof (const list_t *list)
/*
 *  Count number of 'list' elements.
 *
 *  Return value:
 *      number of 'list' elements.
 */
{
   node_t   *element;
   unsigned  n = 0;

   assert (list);

   for (element = list->head; element != NULL; element = element->next)
      n++;

   return n;
}

void
list_foreach (const list_t *list, void (*function)(void *, void *), void *data)
/*
 *  Call 'function' for each element of the 'list'.
 *  Parameters given to 'function' are a pointer to the value of the
 *  current 'list' element and the user pointer 'data'.
 *
 *  No return value.
 */
{
   node_t *element;

   assert (list && function && data);

   for (element = list->head; element; element = element->next)
      function (element->value, data);
}