]> arthur.barton.de Git - ngircd-alex.git/blob - src/ngircd/lists.h
Add Doxygen @file documentation to each source and header file
[ngircd-alex.git] / src / ngircd / lists.h
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  * Please read the file COPYING, README and AUTHORS for more information.
10  */
11
12
13 #ifndef __lists_h__
14 #define __lists_h__
15
16 /**
17  * @file
18  * Management of IRC lists (header)
19  */
20
21 #include "portab.h"
22 #include "client.h"
23
24 struct list_elem;
25
26 struct list_head {
27         struct list_elem *first;
28 };
29
30
31 GLOBAL struct list_elem *Lists_GetFirst PARAMS((const struct list_head *));
32 GLOBAL struct list_elem *Lists_GetNext PARAMS((const struct list_elem *));
33
34 GLOBAL bool Lists_Check PARAMS((struct list_head *head, CLIENT *client ));
35 GLOBAL bool Lists_CheckDupeMask PARAMS((const struct list_head *head, const char *mask ));
36
37 GLOBAL bool Lists_Add PARAMS((struct list_head *header, const char *Mask, bool OnlyOnce ));
38 GLOBAL void Lists_Del PARAMS((struct list_head *head, const char *Mask ));
39
40 GLOBAL bool Lists_AlreadyRegistered PARAMS(( const struct list_head *head, const char *Mask));
41
42 GLOBAL void Lists_Free PARAMS(( struct list_head *head ));
43
44 GLOBAL const char *Lists_MakeMask PARAMS((const char *Pattern));
45 GLOBAL const char *Lists_GetMask PARAMS(( const struct list_elem *e ));
46
47 #endif
48 /* -eof- */