src/channel.h

   1 /* Copyright (C) 2009-2014, Martin Johansson <martin@fatbob.nu>
   2    Copyright (C) 2005-2014, Thorvald Natvig <thorvald@natvig.com>
   3
   4    All rights reserved.
   5
   6    Redistribution and use in source and binary forms, with or without
   7    modification, are permitted provided that the following conditions
   8    are met:
   9
  10    - Redistributions of source code must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    - Redistributions in binary form must reproduce the above copyright notice,
  13      this list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15    - Neither the name of the Developers nor the names of its contributors may
  16      be used to endorse or promote products derived from this software without
  17      specific prior written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
  23    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  26    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  28    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  29    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30 */
  31 #ifndef CHANNEL_H_8939873
  32 #define CHANNEL_H_8939873
  33
  34 #include "log.h"
  35 #include "list.h"
  36 #include "client.h"
  37
  38 typedef struct channel {
  39         int id;
  40         char *name;
  41         char *desc;
  42         char *password;
  43         struct channel *parent;
  44         bool_t temporary, noenter, silent;
  45         int position;
  46         struct dlist node;
  47         struct dlist subs;
  48         struct dlist clients;
  49         struct dlist flatlist_node;
  50         struct dlist channel_links;
  51         int linkcount;
  52 } channel_t;
  53
  54 typedef struct {
  55         channel_t *chan;
  56         struct dlist node;
  57 } channellist_t;
  58
  59 typedef struct {
  60   bool_t CHJOIN_SILENT,
  61         CHJOIN_NOENTER,
  62         CHJOIN_WRONGPW,
  63         CHJOIN_NOTFOUND;
  64 } channelJoinResult_t;
  65
  66 void Chan_init();
  67 void Chan_free();
  68 void Chan_addChannel(channel_t *parent, channel_t *sub);
  69 void Chan_removeChannel(channel_t *c);
  70 void Chan_addClient(channel_t *c, client_t *client);
  71 void Chan_removeClient(channel_t *c, client_t *client);
  72 int Chan_userJoin(channel_t *ch, client_t *client);
  73 int Chan_userJoin_id(int channelid, client_t *client);
  74 int Chan_userLeave(client_t *client);
  75 channelJoinResult_t Chan_userJoin_id_test(int channelid, client_t *client);
  76 channel_t *Chan_iterate(channel_t **channelpptr);
  77 channel_t *Chan_iterate_siblings(channel_t *parent, channel_t **channelpptr);
  78 channel_t *Chan_createChannel(const char *name, const char *desc);
  79 channel_t *Chan_fromId(int channelid);
  80 void Chan_freeChannel(channel_t *ch);
  81 void Chan_buildTreeList(channel_t *ch, struct dlist *head);
  82 void Chan_freeTreeList(struct dlist *head);
  83
  84 #endif