blob: 9eb67fac35f8b8298149462b5f77b32b5df3c3ec (
plain)
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
|
/*!The Treasure Box Library
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (C) 2009 - 2017, TBOOX Open Source Group.
*
* @author ruki
* @file queue.h
* @ingroup container
*
*/
#ifndef TB_CONTAINER_QUEUE_H
#define TB_CONTAINER_QUEUE_H
/* //////////////////////////////////////////////////////////////////////////////////////
* includes
*/
#include "prefix.h"
#include "element.h"
#include "iterator.h"
#include "single_list.h"
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_enter__
/* //////////////////////////////////////////////////////////////////////////////////////
* types
*/
/*! the queue ref type
*
* <pre>
* queue: |-----| => |-----| => ... => |-----| => tail
* head last
*
* performance:
*
* put: O(1)
* pop: O(1)
*
* iterator:
*
* next: fast
* prev: fast
*
* </pre>
*/
typedef tb_single_list_ref_t tb_queue_ref_t;
/* //////////////////////////////////////////////////////////////////////////////////////
* interfaces
*/
/*! init queue
*
* @param grow the grow size, using the default grow size if be zero
* @param element the element
*
* @return the queue
*/
tb_queue_ref_t tb_queue_init(tb_size_t grow, tb_element_t element);
/*! exit queue
*
* @param queue the queue
*/
tb_void_t tb_queue_exit(tb_queue_ref_t queue);
/*! the queue head item
*
* @param queue the queue
*
* @return the head item
*/
tb_pointer_t tb_queue_head(tb_queue_ref_t queue);
/*! the queue last item
*
* @param queue the queue
*
* @return the last item
*/
tb_pointer_t tb_queue_last(tb_queue_ref_t queue);
/*! clear the queue
*
* @param queue the queue
*/
tb_void_t tb_queue_clear(tb_queue_ref_t queue);
/*! put the queue item
*
* @param queue the queue
* @param data the item data
*/
tb_void_t tb_queue_put(tb_queue_ref_t queue, tb_cpointer_t data);
/*! pop the queue item
*
* @param queue the queue
*/
tb_void_t tb_queue_pop(tb_queue_ref_t queue);
/*! get the queue item
*
* @param queue the queue
*
* @return the queue item
*/
tb_pointer_t tb_queue_get(tb_queue_ref_t queue);
/*! the queue size
*
* @param queue the queue
*
* @return the queue size
*/
tb_size_t tb_queue_size(tb_queue_ref_t queue);
/*! the queue maxn
*
* @param queue the queue
*
* @return the queue maxn
*/
tb_size_t tb_queue_maxn(tb_queue_ref_t queue);
/*! the queue full?
*
* @param queue the queue
*
* @return tb_true or tb_false
*/
tb_bool_t tb_queue_full(tb_queue_ref_t queue);
/*! the queue null?
*
* @param queue the queue
*
* @return tb_true or tb_false
*/
tb_bool_t tb_queue_null(tb_queue_ref_t queue);
#ifdef __tb_debug__
/*! dump queue
*
* @param queue the queue
*/
tb_void_t tb_queue_dump(tb_queue_ref_t queue);
#endif
/* //////////////////////////////////////////////////////////////////////////////////////
* extern
*/
__tb_extern_c_leave__
#endif
|
