Add Doxygen @file documentation to each source and header file
[ngircd-alex.git] / src / ngircd / channel.h
1 /*
2  * ngIRCd -- The Next Generation IRC Daemon
3  * Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors.
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 __channel_h__
14 #define __channel_h__
15
16 /**
17  * @file
18  * Channel management (header)
19  */
20
21 #if defined(__channel_c__) | defined(S_SPLINT_S)
22
23 #include "lists.h"
24 #include "defines.h"
25 #include "array.h"
26
27 typedef struct _CHANNEL
28 {
29         struct _CHANNEL *next;
30         char name[CHANNEL_NAME_LEN];    /* Name of the channel */
31         UINT32 hash;                    /* Hash of the (lowecase!) name */
32         char modes[CHANNEL_MODE_LEN];   /* Channel modes */
33         array topic;                    /* Topic of the channel */
34 #ifndef STRICT_RFC
35         time_t creation_time;           /* Channel creation time */
36         time_t topic_time;              /* Time when topic was set */
37         char topic_who[CLIENT_NICK_LEN];/* Nickname of user that set topic */
38 #endif
39         char key[CLIENT_PASS_LEN];      /* Channel key ("password", mode "k" ) */
40         unsigned long maxusers;         /* Maximum number of members (mode "l") */
41         struct list_head list_bans;     /* list head of banned users */
42         struct list_head list_invites;  /* list head of invited users */
43         array keyfile;                  /* Name of the channel key file */
44 } CHANNEL;
45
46 typedef struct _CLIENT2CHAN
47 {
48         struct _CLIENT2CHAN *next;
49         CLIENT *client;
50         CHANNEL *channel;
51         char modes[CHANNEL_MODE_LEN];   /* User-Modes in Channel */
52 } CL2CHAN;
53
54 #else
55
56 typedef POINTER CHANNEL;
57 typedef POINTER CL2CHAN;
58
59 #endif
60
61 GLOBAL struct list_head *Channel_GetListBans PARAMS((CHANNEL *c));
62 GLOBAL struct list_head *Channel_GetListInvites PARAMS((CHANNEL *c));
63
64 GLOBAL void Channel_Init PARAMS(( void ));
65 GLOBAL void Channel_InitPredefined PARAMS((  void ));
66 GLOBAL void Channel_Exit PARAMS(( void ));
67
68 GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, const char *Name ));
69 GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason ));
70
71 GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, const char *Reason ));
72
73 GLOBAL void Channel_Kick PARAMS((CLIENT *Peer, CLIENT *Target, CLIENT *Origin,
74                                  const char *Name, const char *Reason));
75
76 GLOBAL unsigned long Channel_Count PARAMS(( void ));
77 GLOBAL unsigned long Channel_MemberCount PARAMS(( CHANNEL *Chan ));
78 GLOBAL int Channel_CountForUser PARAMS(( CLIENT *Client ));
79
80 GLOBAL const char *Channel_Name PARAMS(( const CHANNEL *Chan ));
81 GLOBAL char *Channel_Modes PARAMS(( CHANNEL *Chan ));
82 GLOBAL char *Channel_Topic PARAMS(( CHANNEL *Chan ));
83 GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
84 GLOBAL unsigned long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
85
86 GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, const char *Topic ));
87 GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, const char *Modes ));
88 GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, const char *Key ));
89 GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, unsigned long Count ));
90
91 GLOBAL CHANNEL *Channel_Search PARAMS(( const char *Name ));
92
93 GLOBAL CHANNEL *Channel_First PARAMS(( void ));
94 GLOBAL CHANNEL *Channel_Next PARAMS(( CHANNEL *Chan ));
95
96 GLOBAL CL2CHAN *Channel_FirstMember PARAMS(( CHANNEL *Chan ));
97 GLOBAL CL2CHAN *Channel_NextMember PARAMS(( CHANNEL *Chan, CL2CHAN *Cl2Chan ));
98 GLOBAL CL2CHAN *Channel_FirstChannelOf PARAMS(( CLIENT *Client ));
99 GLOBAL CL2CHAN *Channel_NextChannelOf PARAMS(( CLIENT *Client, CL2CHAN *Cl2Chan ));
100
101 GLOBAL CLIENT *Channel_GetClient PARAMS(( CL2CHAN *Cl2Chan ));
102 GLOBAL CHANNEL *Channel_GetChannel PARAMS(( CL2CHAN *Cl2Chan ));
103
104 GLOBAL bool Channel_IsValidName PARAMS(( const char *Name ));
105
106 GLOBAL bool Channel_ModeAdd PARAMS(( CHANNEL *Chan, char Mode ));
107 GLOBAL bool Channel_ModeDel PARAMS(( CHANNEL *Chan, char Mode ));
108
109 GLOBAL bool Channel_UserModeAdd PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
110 GLOBAL bool Channel_UserModeDel PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
111 GLOBAL char *Channel_UserModes PARAMS(( CHANNEL *Chan, CLIENT *Client ));
112
113 GLOBAL bool Channel_IsMemberOf PARAMS(( CHANNEL *Chan, CLIENT *Client ));
114
115 GLOBAL bool Channel_Write PARAMS((CHANNEL *Chan, CLIENT *From, CLIENT *Client,
116                                   const char *Command, bool SendErrors,
117                                   const char *Text));
118
119 GLOBAL CHANNEL *Channel_Create PARAMS(( const char *Name ));
120
121 #ifndef STRICT_RFC
122 GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
123 GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
124 GLOBAL unsigned int Channel_CreationTime PARAMS(( CHANNEL *Chan ));
125 #endif
126
127 GLOBAL bool Channel_AddInvite PARAMS((CHANNEL *c, const char *Mask, bool OnlyOnce ));
128 GLOBAL bool Channel_AddBan PARAMS((CHANNEL *c, const char *Mask ));
129
130 GLOBAL bool Channel_ShowBans PARAMS((CLIENT *client, CHANNEL *c));
131 GLOBAL bool Channel_ShowInvites PARAMS((CLIENT *client, CHANNEL *c));
132
133 GLOBAL void Channel_LogServer PARAMS((const char *msg));
134
135 GLOBAL bool Channel_CheckKey PARAMS((CHANNEL *Chan, CLIENT *Client,
136                                      const char *Key));
137
138 GLOBAL void Channel_CheckAdminRights PARAMS((CHANNEL *Chan, CLIENT *Client,
139                                              CLIENT *Origin, bool *OnChannel,
140                                              bool *AdminOk, bool *UseServerMode));
141
142 #define Channel_IsLocal(c) (Channel_Name(c)[0] == '&')
143 #define Channel_IsModeless(c) (Channel_Name(c)[0] == '+')
144
145 #endif
146
147 /* -eof- */