src/ngircd/channel.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  * $Id: channel.h,v 1.29 2005/09/02 12:50:25 alex Exp $
  12  *
  13  * Channel management (header)
  14  */
  15
  16
  17 #ifndef __channel_h__
  18 #define __channel_h__
  19
  20
  21 #if defined(__channel_c__) | defined(S_SPLINT_S)
  22
  23 #include "defines.h"
  24 #include "array.h"
  25
  26 typedef struct _CHANNEL
  27 {
  28         struct _CHANNEL *next;
  29         char name[CHANNEL_NAME_LEN];    /* Name of the channel */
  30         UINT32 hash;                    /* Hash of the (lowecase!) name */
  31         char modes[CHANNEL_MODE_LEN];   /* Channel modes */
  32         array topic;                    /* Topic of the channel */
  33 #ifndef STRICT_RFC
  34         time_t topic_time;              /* Time when topic was set */
  35         char topic_who[CLIENT_NICK_LEN];/* Nickname of user that set topic */
  36 #endif
  37         char key[CLIENT_PASS_LEN];      /* Channel key ("password", mode "k" ) */
  38         long maxusers;                  /* Maximum number of members (mode "l") */
  39 } CHANNEL;
  40
  41 typedef struct _CLIENT2CHAN
  42 {
  43         struct _CLIENT2CHAN *next;
  44         CLIENT *client;
  45         CHANNEL *channel;
  46         char modes[CHANNEL_MODE_LEN];   /* User-Modes in dem Channel */
  47 } CL2CHAN;
  48
  49 #else
  50
  51 typedef POINTER CHANNEL;
  52 typedef POINTER CL2CHAN;
  53
  54 #endif
  55
  56
  57 GLOBAL void Channel_Init PARAMS(( void ));
  58 GLOBAL void Channel_InitPredefined PARAMS((  void ));
  59 GLOBAL void Channel_Exit PARAMS(( void ));
  60
  61 GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, char *Name ));
  62 GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, char *Name, char *Reason ));
  63
  64 GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, char *Reason ));
  65
  66 GLOBAL void Channel_Kick PARAMS((  CLIENT *Client, CLIENT *Origin, char *Name, char *Reason ));
  67
  68 GLOBAL long Channel_Count PARAMS(( void ));
  69 GLOBAL long Channel_MemberCount PARAMS(( CHANNEL *Chan ));
  70 GLOBAL int Channel_CountForUser PARAMS(( CLIENT *Client ));
  71 GLOBAL int Channel_PCount PARAMS(( void ));
  72
  73 GLOBAL char *Channel_Name PARAMS(( CHANNEL *Chan ));
  74 GLOBAL char *Channel_Modes PARAMS(( CHANNEL *Chan ));
  75 GLOBAL char *Channel_Topic PARAMS(( CHANNEL *Chan ));
  76 GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
  77 GLOBAL long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
  78
  79 GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, char *Topic ));
  80 GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, char *Modes ));
  81 GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, char *Key ));
  82 GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, long Count ));
  83
  84 GLOBAL CHANNEL *Channel_Search PARAMS(( char *Name ));
  85
  86 GLOBAL CHANNEL *Channel_First PARAMS(( void ));
  87 GLOBAL CHANNEL *Channel_Next PARAMS(( CHANNEL *Chan ));
  88
  89 GLOBAL CL2CHAN *Channel_FirstMember PARAMS(( CHANNEL *Chan ));
  90 GLOBAL CL2CHAN *Channel_NextMember PARAMS(( CHANNEL *Chan, CL2CHAN *Cl2Chan ));
  91 GLOBAL CL2CHAN *Channel_FirstChannelOf PARAMS(( CLIENT *Client ));
  92 GLOBAL CL2CHAN *Channel_NextChannelOf PARAMS(( CLIENT *Client, CL2CHAN *Cl2Chan ));
  93
  94 GLOBAL CLIENT *Channel_GetClient PARAMS(( CL2CHAN *Cl2Chan ));
  95 GLOBAL CHANNEL *Channel_GetChannel PARAMS(( CL2CHAN *Cl2Chan ));
  96
  97 GLOBAL bool Channel_IsValidName PARAMS(( char *Name ));
  98
  99 GLOBAL bool Channel_ModeAdd PARAMS(( CHANNEL *Chan, char Mode ));
 100 GLOBAL bool Channel_ModeDel PARAMS(( CHANNEL *Chan, char Mode ));
 101
 102 GLOBAL bool Channel_UserModeAdd PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
 103 GLOBAL bool Channel_UserModeDel PARAMS(( CHANNEL *Chan, CLIENT *Client, char Mode ));
 104 GLOBAL char *Channel_UserModes PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 105
 106 GLOBAL bool Channel_IsMemberOf PARAMS(( CHANNEL *Chan, CLIENT *Client ));
 107
 108 GLOBAL bool Channel_Write PARAMS(( CHANNEL *Chan, CLIENT *From, CLIENT *Client, char *Text ));
 109
 110 GLOBAL CHANNEL *Channel_Create PARAMS(( char *Name ));
 111
 112 #ifndef STRICT_RFC
 113 GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
 114 GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
 115 #endif
 116
 117
 118 #endif
 119
 120
 121 /* -eof- */