/
zlist.h
87 lines (66 loc) · 2.25 KB
/
zlist.h
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
/* =========================================================================
zlist - singly-linked list container
-------------------------------------------------------------------------
Copyright (c) 1991-2011 iMatix Corporation <www.imatix.com>
Copyright other contributors as noted in the AUTHORS file.
This file is part of czmq, the high-level C binding for 0MQ:
http://czmq.zeromq.org.
This is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or (at
your option) any later version.
This software is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this program. If not, see
<http://www.gnu.org/licenses/>.
=========================================================================
*/
#ifndef __ZFL_LIST_H_INCLUDED__
#define __ZFL_LIST_H_INCLUDED__
#ifdef __cplusplus
extern "C" {
#endif
// Opaque class structure
typedef struct _zlist zlist_t;
// @interface
// Create a new list container
zlist_t *
zlist_new (void);
// Destroy a list container
void
zlist_destroy (zlist_t **self_p);
// Return first item in the list, or null
void *
zlist_first (zlist_t *self);
// Return next item in the list, or null
void *
zlist_next (zlist_t *self);
// Append an item to the end of the list
void
zlist_append (zlist_t *self, void *item);
// Push an item to the start of the list
void
zlist_push (zlist_t *self, void *item);
// Pop the item off the start of the list, if any
void *
zlist_pop (zlist_t *self);
// Remove the specified item from the list if present
void
zlist_remove (zlist_t *self, void *item);
// Copy the entire list, return the copy
zlist_t *
zlist_copy (zlist_t *self);
// Return number of items in the list
size_t
zlist_size (zlist_t *self);
// Self test of this class
void
zlist_test (int verbose);
// @end
#ifdef __cplusplus
}
#endif
#endif