]>
Commit | Line | Data |
---|---|---|
db137867 AC |
1 | /* |
2 | * ircd-ratbox: A slightly useful ircd. | |
3 | * tools.h: Header for the various tool functions. | |
4 | * | |
5 | * Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center | |
6 | * Copyright (C) 1996-2002 Hybrid Development Team | |
7 | * Copyright (C) 2002-2005 ircd-ratbox development team | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation; either version 2 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 | |
22 | * USA | |
23 | * | |
db137867 AC |
24 | */ |
25 | ||
26 | #ifndef RB_LIB_H | |
3202e249 | 27 | # error "Do not use tools.h directly" |
db137867 AC |
28 | #endif |
29 | ||
30 | #ifndef __TOOLS_H__ | |
31 | #define __TOOLS_H__ | |
32 | ||
508e25a8 EM |
33 | int rb_strcasecmp(const char *s1, const char *s2); |
34 | int rb_strncasecmp(const char *s1, const char *s2, size_t n); | |
35 | char *rb_strcasestr(const char *s, const char *find); | |
db137867 AC |
36 | size_t rb_strlcpy(char *dst, const char *src, size_t siz); |
37 | size_t rb_strlcat(char *dst, const char *src, size_t siz); | |
38 | size_t rb_strnlen(const char *s, size_t count); | |
e5c434a2 SA |
39 | int rb_snprintf_append(char *str, size_t len, const char *format, ...) AFP(3,4); |
40 | int rb_snprintf_try_append(char *str, size_t len, const char *format, ...) AFP(3,4); | |
5203cba5 | 41 | |
3202e249 VY |
42 | char *rb_basename(const char *); |
43 | char *rb_dirname(const char *); | |
db137867 AC |
44 | |
45 | int rb_string_to_array(char *string, char **parv, int maxpara); | |
46 | ||
47 | /* | |
48 | * double-linked-list stuff | |
49 | */ | |
50 | typedef struct _rb_dlink_node rb_dlink_node; | |
51 | typedef struct _rb_dlink_list rb_dlink_list; | |
52 | ||
53 | struct _rb_dlink_node | |
54 | { | |
55 | void *data; | |
56 | rb_dlink_node *prev; | |
57 | rb_dlink_node *next; | |
58 | ||
59 | }; | |
60 | ||
61 | struct _rb_dlink_list | |
62 | { | |
63 | rb_dlink_node *head; | |
64 | rb_dlink_node *tail; | |
65 | unsigned long length; | |
66 | }; | |
67 | ||
68 | rb_dlink_node *rb_make_rb_dlink_node(void); | |
3202e249 | 69 | void rb_free_rb_dlink_node(rb_dlink_node *lp); |
db137867 AC |
70 | void rb_init_rb_dlink_nodes(size_t dh_size); |
71 | ||
72 | /* This macros are basically swiped from the linux kernel | |
73 | * they are simple yet effective | |
74 | */ | |
75 | ||
76 | /* | |
55abcbb2 | 77 | * Walks forward of a list. |
db137867 AC |
78 | * pos is your node |
79 | * head is your list head | |
80 | */ | |
81 | #define RB_DLINK_FOREACH(pos, head) for (pos = (head); pos != NULL; pos = pos->next) | |
82 | ||
83 | /* | |
55abcbb2 | 84 | * Walks forward of a list safely while removing nodes |
db137867 AC |
85 | * pos is your node |
86 | * n is another list head for temporary storage | |
87 | * head is your list head | |
88 | */ | |
89 | #define RB_DLINK_FOREACH_SAFE(pos, n, head) for (pos = (head), n = pos ? pos->next : NULL; pos != NULL; pos = n, n = pos ? pos->next : NULL) | |
90 | ||
91 | #define RB_DLINK_FOREACH_PREV(pos, head) for (pos = (head); pos != NULL; pos = pos->prev) | |
92 | ||
93 | ||
94 | /* Returns the list length */ | |
95 | #define rb_dlink_list_length(list) (list)->length | |
96 | ||
97 | #define rb_dlinkAddAlloc(data, list) rb_dlinkAdd(data, rb_make_rb_dlink_node(), list) | |
98 | #define rb_dlinkAddTailAlloc(data, list) rb_dlinkAddTail(data, rb_make_rb_dlink_node(), list) | |
99 | #define rb_dlinkDestroy(node, list) do { rb_dlinkDelete(node, list); rb_free_rb_dlink_node(node); } while(0) | |
100 | ||
101 | ||
55abcbb2 | 102 | /* |
db137867 AC |
103 | * dlink_ routines are stolen from squid, except for rb_dlinkAddBefore, |
104 | * which is mine. | |
105 | * -- adrian | |
106 | */ | |
107 | ||
108 | static inline void | |
3202e249 | 109 | rb_dlinkMoveNode(rb_dlink_node *m, rb_dlink_list *oldlist, rb_dlink_list *newlist) |
db137867 AC |
110 | { |
111 | /* Assumption: If m->next == NULL, then list->tail == m | |
112 | * and: If m->prev == NULL, then list->head == m | |
113 | */ | |
114 | assert(m != NULL); | |
115 | assert(oldlist != NULL); | |
116 | assert(newlist != NULL); | |
117 | ||
118 | if(m->next) | |
119 | m->next->prev = m->prev; | |
120 | else | |
121 | oldlist->tail = m->prev; | |
122 | ||
123 | if(m->prev) | |
124 | m->prev->next = m->next; | |
125 | else | |
126 | oldlist->head = m->next; | |
127 | ||
128 | m->prev = NULL; | |
129 | m->next = newlist->head; | |
130 | if(newlist->head != NULL) | |
131 | newlist->head->prev = m; | |
132 | else if(newlist->tail == NULL) | |
133 | newlist->tail = m; | |
134 | newlist->head = m; | |
135 | ||
136 | oldlist->length--; | |
137 | newlist->length++; | |
138 | } | |
139 | ||
140 | static inline void | |
3202e249 | 141 | rb_dlinkAdd(void *data, rb_dlink_node *m, rb_dlink_list *list) |
db137867 AC |
142 | { |
143 | assert(data != NULL); | |
144 | assert(m != NULL); | |
145 | assert(list != NULL); | |
146 | ||
147 | m->data = data; | |
148 | m->prev = NULL; | |
149 | m->next = list->head; | |
150 | ||
151 | /* Assumption: If list->tail != NULL, list->head != NULL */ | |
152 | if(list->head != NULL) | |
153 | list->head->prev = m; | |
154 | else if(list->tail == NULL) | |
155 | list->tail = m; | |
156 | ||
157 | list->head = m; | |
158 | list->length++; | |
159 | } | |
160 | ||
161 | static inline void | |
3202e249 | 162 | rb_dlinkAddBefore(rb_dlink_node *b, void *data, rb_dlink_node *m, rb_dlink_list *list) |
db137867 AC |
163 | { |
164 | assert(b != NULL); | |
165 | assert(data != NULL); | |
166 | assert(m != NULL); | |
167 | assert(list != NULL); | |
168 | ||
169 | /* Shortcut - if its the first one, call rb_dlinkAdd only */ | |
170 | if(b == list->head) | |
171 | { | |
172 | rb_dlinkAdd(data, m, list); | |
173 | } | |
174 | else | |
175 | { | |
176 | m->data = data; | |
177 | b->prev->next = m; | |
178 | m->prev = b->prev; | |
179 | b->prev = m; | |
180 | m->next = b; | |
181 | list->length++; | |
182 | } | |
183 | } | |
184 | ||
185 | static inline void | |
186 | rb_dlinkMoveTail(rb_dlink_node *m, rb_dlink_list *list) | |
187 | { | |
188 | if(list->tail == m) | |
189 | return; | |
3202e249 | 190 | |
55abcbb2 | 191 | /* From here assume that m->next != NULL as that can only |
db137867 AC |
192 | * be at the tail and assume that the node is on the list |
193 | */ | |
3202e249 | 194 | |
db137867 AC |
195 | m->next->prev = m->prev; |
196 | ||
197 | if(m->prev != NULL) | |
198 | m->prev->next = m->next; | |
199 | else | |
200 | list->head = m->next; | |
201 | ||
202 | list->tail->next = m; | |
203 | m->prev = list->tail; | |
204 | m->next = NULL; | |
205 | list->tail = m; | |
206 | } | |
207 | ||
208 | static inline void | |
3202e249 | 209 | rb_dlinkAddTail(void *data, rb_dlink_node *m, rb_dlink_list *list) |
db137867 AC |
210 | { |
211 | assert(m != NULL); | |
212 | assert(list != NULL); | |
213 | assert(data != NULL); | |
214 | ||
215 | m->data = data; | |
216 | m->next = NULL; | |
217 | m->prev = list->tail; | |
218 | ||
219 | /* Assumption: If list->tail != NULL, list->head != NULL */ | |
220 | if(list->tail != NULL) | |
221 | list->tail->next = m; | |
222 | else if(list->head == NULL) | |
223 | list->head = m; | |
224 | ||
225 | list->tail = m; | |
226 | list->length++; | |
227 | } | |
228 | ||
229 | /* Execution profiles show that this function is called the most | |
230 | * often of all non-spontaneous functions. So it had better be | |
231 | * efficient. */ | |
232 | static inline void | |
3202e249 | 233 | rb_dlinkDelete(rb_dlink_node *m, rb_dlink_list *list) |
db137867 AC |
234 | { |
235 | assert(m != NULL); | |
236 | assert(list != NULL); | |
237 | /* Assumption: If m->next == NULL, then list->tail == m | |
238 | * and: If m->prev == NULL, then list->head == m | |
239 | */ | |
240 | if(m->next) | |
241 | m->next->prev = m->prev; | |
242 | else | |
243 | list->tail = m->prev; | |
244 | ||
245 | if(m->prev) | |
246 | m->prev->next = m->next; | |
247 | else | |
248 | list->head = m->next; | |
249 | ||
250 | m->next = m->prev = NULL; | |
251 | list->length--; | |
252 | } | |
253 | ||
254 | static inline rb_dlink_node * | |
255 | rb_dlinkFindDelete(void *data, rb_dlink_list *list) | |
256 | { | |
257 | rb_dlink_node *m; | |
258 | assert(list != NULL); | |
259 | assert(data != NULL); | |
260 | RB_DLINK_FOREACH(m, list->head) | |
261 | { | |
262 | if(m->data != data) | |
263 | continue; | |
264 | ||
265 | if(m->next) | |
266 | m->next->prev = m->prev; | |
267 | else | |
268 | list->tail = m->prev; | |
269 | ||
270 | if(m->prev) | |
271 | m->prev->next = m->next; | |
272 | else | |
273 | list->head = m->next; | |
274 | ||
275 | m->next = m->prev = NULL; | |
276 | list->length--; | |
277 | return m; | |
278 | } | |
279 | return NULL; | |
280 | } | |
281 | ||
282 | static inline int | |
283 | rb_dlinkFindDestroy(void *data, rb_dlink_list *list) | |
284 | { | |
285 | void *ptr; | |
286 | ||
287 | assert(list != NULL); | |
288 | assert(data != NULL); | |
289 | ptr = rb_dlinkFindDelete(data, list); | |
290 | ||
291 | if(ptr != NULL) | |
292 | { | |
293 | rb_free_rb_dlink_node(ptr); | |
294 | return 1; | |
295 | } | |
296 | return 0; | |
297 | } | |
298 | ||
299 | /* | |
300 | * rb_dlinkFind | |
55abcbb2 | 301 | * inputs - list to search |
db137867 AC |
302 | * - data |
303 | * output - pointer to link or NULL if not found | |
304 | * side effects - Look for ptr in the linked listed pointed to by link. | |
305 | */ | |
306 | static inline rb_dlink_node * | |
307 | rb_dlinkFind(void *data, rb_dlink_list *list) | |
308 | { | |
309 | rb_dlink_node *ptr; | |
310 | assert(list != NULL); | |
311 | assert(data != NULL); | |
3202e249 | 312 | |
db137867 AC |
313 | RB_DLINK_FOREACH(ptr, list->head) |
314 | { | |
315 | if(ptr->data == data) | |
316 | return (ptr); | |
317 | } | |
318 | return (NULL); | |
319 | } | |
320 | ||
321 | static inline void | |
3202e249 | 322 | rb_dlinkMoveList(rb_dlink_list *from, rb_dlink_list *to) |
db137867 AC |
323 | { |
324 | assert(from != NULL); | |
325 | assert(to != NULL); | |
326 | ||
327 | /* There are three cases */ | |
328 | /* case one, nothing in from list */ | |
329 | if(from->head == NULL) | |
330 | return; | |
331 | ||
332 | /* case two, nothing in to list */ | |
333 | if(to->head == NULL) | |
334 | { | |
335 | to->head = from->head; | |
336 | to->tail = from->tail; | |
337 | from->head = from->tail = NULL; | |
338 | to->length = from->length; | |
339 | from->length = 0; | |
340 | return; | |
341 | } | |
342 | ||
343 | /* third case play with the links */ | |
344 | from->tail->next = to->head; | |
345 | to->head->prev = from->tail; | |
346 | to->head = from->head; | |
347 | from->head = from->tail = NULL; | |
348 | to->length += from->length; | |
349 | from->length = 0; | |
350 | } | |
351 | ||
4b1cce65 SA |
352 | |
353 | typedef int (*rb_strf_func_t)(char *buf, size_t len, void *args); | |
354 | ||
355 | typedef struct _rb_strf { | |
356 | size_t length; /* length limit to apply to this string (and following strings if their length is 0) */ | |
357 | const char *format; /* string or format string */ | |
358 | rb_strf_func_t func; /* function to print to string */ | |
359 | union { | |
360 | va_list *format_args; /* non-NULL if this is a format string */ | |
361 | void *func_args; /* args for a function */ | |
362 | }; | |
363 | const struct _rb_strf *next; /* next string to append */ | |
364 | } rb_strf_t; | |
365 | ||
366 | int rb_fsnprint(char *buf, size_t len, const rb_strf_t *strings); | |
367 | int rb_fsnprintf(char *buf, size_t len, const rb_strf_t *strings, const char *format, ...) AFP(4, 5); | |
368 | ||
369 | ||
790e4dce | 370 | const char *rb_path_to_self(void); |
5225f83d | 371 | |
db137867 | 372 | #endif /* __TOOLS_H__ */ |