File: list.c

package info (click to toggle)
prayer 1.3.5-dfsg1-8
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,596 kB
  • sloc: ansic: 43,163; makefile: 817; sh: 445; perl: 166
file content (468 lines) | stat: -rw-r--r-- 12,725 bytes parent folder | download | duplicates (6)
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
/* $Cambridge: hermes/src/prayer/lib/list.c,v 1.3 2008/09/16 09:59:57 dpc22 Exp $ */
/************************************************
 *    Prayer - a Webmail Interface              *
 ************************************************/

/* Copyright (c) University of Cambridge 2000 - 2008 */
/* See the file NOTICE for conditions of use and distribution. */

#include "lib.h"

/* list_create() *********************************************************
 *
 * Create a fresh list structure
 *      pool: Target pool for list and all list elements
 *  use_case: T => case is significant in _by_name operations.
 ************************************************************************/

struct list *list_create(struct pool *pool, BOOL use_case)
{
    struct list *result = pool_alloc(pool, sizeof(struct list));

    result->pool = pool;
    result->use_case = use_case;
    result->head = NIL;
    result->tail = NIL;
    result->length = 0L;

    return (result);
}

/* list_free() ***********************************************************
 *
 * Free a list structure, including all list nodes. NOOP unless list
 * has been allocated in the NIL pool.
 ************************************************************************/

void list_free(struct list *list)
{
    struct list_item *current, *next;

    if (list->pool)             /* NOOP if pool */
        return;

    for (current = list->head; current; current = next) {
        next = current->next;
        free(current);
    }
    free(list);
}

/* list_length() *********************************************************
 *
 * Return current length of the list.
 ************************************************************************/

unsigned long list_length(struct list *list)
{
    return (list->length);
}

/* ====================================================================== */

/* list_unshift() ********************************************************
 *
 * Add new entry to start of a list
 *     list:
 *     item: List item to add
 *     name: Name for this list item, if any
 ************************************************************************/

void list_unshift(struct list *list, struct list_item *item, char *name)
{
    if (item == NIL)
        item = pool_alloc(list->pool, sizeof(struct list_item));

    item->next = NIL;

    if (name)
        item->name = pool_strdup(list->pool, name);
    else
        item->name = NIL;

    if (list->head) {
        item->next = list->head;
        list->head = item;
    } else {
        item->next = NIL;
        list->head = list->tail = item;
    }

    list->length++;
}

/* list_shift() **********************************************************
 *
 * Removes (but doesn't free) entry from the start of the list
 *   list:
 *
 * Returns: Ptr to list item which was removed.
 ************************************************************************/

struct list_item *list_shift(struct list *list)
{
    struct list_item *item;

    if (list->head == NIL)
        return (NIL);

    item = list->head;

    if (list->head == list->tail)
        list->head = list->tail = NIL;  /* Remove single item from list */
    else
        list->head = list->head->next;  /* Remove first item from list */

    list->length--;

    return (item);
}

/* ====================================================================== */

/* list_push() ***********************************************************
 *
 * Add an entry to the end of a list
 *    list:
 *    item: List item to push
 *    name: Name for new list item, if any.
 ************************************************************************/

void list_push(struct list *list, struct list_item *item, char *name)
{
    if (item == NIL)
        item = pool_alloc(list->pool, sizeof(struct list_item));

    item->next = NIL;

    if (name)
        item->name = pool_strdup(list->pool, name);
    else
        item->name = NIL;

    if (list->tail)
        list->tail = list->tail->next = item;
    else
        list->head = list->tail = item;

    list->length++;
}

/* list_pop() ************************************************************
 *
 * Removes (but doesn't free) entry from the end of a list
 *   list:
 *
 * Returns: Ptr to list item which was removed.
 ************************************************************************/

struct list_item *list_pop(struct list *list)
{
    struct list_item *item;

    if (list->head == NIL)
        return (NIL);

    if (list->head == list->tail) {
        /* Remove single item from list */
        item = list->head;
        list->head = NIL;
        list->tail = NIL;
    } else {
        struct list_item *last = list->head;

        /* Find penultimate item on list: inefficient with single linked list! */
        while (last->next)
            last = last->next;

        item = last->next;
        last->next = NIL;
    }

    list->length--;
    return (item);
}

/* ====================================================================== */

BOOL
list_insert_sorted(struct list * list, struct list_item * item, char *name)
{
    struct list_item *last, *next;

    if (item == NIL)
        item = pool_alloc(list->pool, sizeof(struct list_item));

    item->next = NIL;

    if (name)
        item->name = pool_strdup(list->pool, name);
    else
        item->name = NIL;

    if (list->use_case) {
        if (((next = list->head) == NIL) || (strcmp(next->name, name) > 0)) {
            item->next = list->head;    /* Insert at start of list */
            list->head = item;
        } else {
            do {
                last = next;    /* (next != NIL) */
                next = next->next;
            }
            while (next && (strcmp(next->name, name) < 0));

            /* Add to this position in list */
            item->next = next;
            last->next = item;
        }
    } else {
        if (((next = list->head) == NIL)
            || (strcasecmp(next->name, name) > 0)) {
            item->next = list->head;    /* Insert at start of list */
            list->head = item;
        } else {
            do {
                last = next;    /* (next != NIL) */
                next = next->next;
            }
            while (next && (strcasecmp(next->name, name) < 0));

            /* Add to this position in list */
            item->next = next;
            last->next = item;
        }
    }
    list->length++;
    return (T);
}

/* ====================================================================== */

/* list_lookup_byname() **************************************************
 *
 * List lookup by name
 *    list:
 *    name: Name to look up.
 *
 * Returns: list item or NIL if not found
 ************************************************************************/

struct list_item *list_lookup_byname(struct list *list, char *name)
{
    struct list_item *item;

    if (list->use_case) {
        for (item = list->head; item; item = item->next) {
            if (item->name && !strcmp(item->name, name))
                return (item);
        }
    } else {
        for (item = list->head; item; item = item->next) {
            if (item->name && !strcasecmp(item->name, name))
                return (item);
        }
    }

    return (NIL);
}

/* list_lookup_byoffset() ***********************************************
 *
 * List lookup by offset
 *    list:
 *  offset: Offset into list
 *
 * Returns: list item or NIL if offset is out of range
 ************************************************************************/

struct list_item *list_lookup_byoffset(struct list *list,
                                       unsigned long offset)
{
    struct list_item *item;

    for (item = list->head; item; item = item->next) {
        if (offset == 0)
            return (item);
        offset--;
    }
    return (NIL);
}

/* ====================================================================== */

/* list_free_item() ******************************************************
 *
 * Free single list item
 *   list:
 *   item: Item to remove
 ************************************************************************/

static void list_free_item(struct list *list, struct list_item *item)
{
    if (list->pool)
        return;

    if (item->name)
        free(item->name);

    free(item);
}

/* list_remove_byname() **************************************************
 *
 * Remove named entry from list
 *    list:
 *    name: Name of entry to remove
 *
 * Returns: T on sucess, NIL otherwise
 ************************************************************************/

BOOL list_remove_byname(struct list *list, char *name)
{
    struct list_item *last, *current;

    /* Check for empty list? */
    if (list->head == NIL)
        return (NIL);

    /* Remove from start of list? */
    if (list->use_case) {
        if ((list->head->name) && !strcmp(name, list->head->name)) {
            current = list->head;
            list->head = current->next;

            /* Removed sole entry from list? */
            if (current->next == NIL)
                list->tail = NIL;

            list_free_item(list, current);
            list->length--;
            return (T);
        }

        /* Remove from middle or end of list */
        for (last = list->head; (current = last->next); last = current) {
            if (current->name && !strcmp(current->name, name)) {
                if ((last->next = current->next) == NIL)
                    list->tail = last;  /* Removed last item in list */

                list_free_item(list, current);
                list->length--;
                return (T);
            }
        }
        return (NIL);
    }

    if ((list->head->name) && !strcasecmp(name, list->head->name)) {
        current = list->head;
        list->head = current->next;

        /* Removed sole entry from list? */
        if (current->next == NIL)
            list->tail = NIL;

        list_free_item(list, current);
        list->length--;
        return (T);
    }

    /* Remove from middle or end of list */
    for (last = list->head; (current = last->next); last = current) {
        if (current->name && !strcasecmp(current->name, name)) {
            if ((last->next = current->next) == NIL)
                list->tail = last;      /* Removed last item in list */

            list_free_item(list, current);
            list->length--;
            return (T);
        }
    }
    return (NIL);
}

/* list_remove_byoffset() ************************************************
 *
 * Remove list entry by offset
 *    list:
 *  offset: List offset to remove
 *
 * Returns: T on success, NIl otherwise
 ************************************************************************/

BOOL list_remove_byoffset(struct list * list, unsigned long offset)
{
    struct list_item *current, *last;

    /* Check for empty list? */
    if (list->head == NIL)
        return (NIL);

    /* Remove from start of list? */
    if (offset == 0) {
        current = list->head;
        list->head = current->next;

        /* Removed sole entry from list? */
        if (list->head == NIL)
            list->tail = NIL;

        list_free_item(list, current);
        list->length--;
        return (T);
    }

    offset--;

    /* Remove from middle or end of list */
    for (last = list->head; (current = last->next); last = current) {
        if (offset == 0) {
            if ((last->next = current->next) == NIL)
                list->tail = last;      /* Removed last item in list */

            list_free_item(list, current);
            list->length--;
            return (T);
        }
        offset--;
    }

    return (NIL);
}

/* ====================================================================== */

/* list_rename_item() ****************************************************
 *
 * Rename a list item
 *    list:
 * oldname: Name of entry to rename
 * newname: New name for entry
 *
 * Returns: T on success, NIL otherwise
 ************************************************************************/

BOOL list_rename_item(struct list * list, char *oldname, char *newname)
{
    struct list_item *current;

    if (list->use_case) {
        for (current = list->head; current; current = current->next) {
            if (!strcmp(current->name, oldname)) {
                free(current->name);
                current->name = pool_strdup(NIL, newname);
                return (T);
            }
        }
        return (NIL);
    }

    for (current = list->head; current; current = current->next) {
        if (!strcasecmp(current->name, oldname)) {
            free(current->name);
            current->name = pool_strdup(NIL, newname);
            return (T);
        }
    }
    return (NIL);
}