1

#ifndef IRC_CHAN_H

     2

#define IRC_CHAN_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Support for IRC channels, including tracking their state and actions on them.

     8

 */

     9

struct irc_chan_info;

    10

struct irc_chan;

    11

    12

#include "irc_net.h"

    13

#include "irc_user.h"

    14

#include "irc_cmd.h"

    15

#include "irc_proto.h"

    16

#include "error.h"

    17

#include <sys/queue.h>

    18

    19

/**

    20

 * IRC channel info, as required to create an irc_chan

    21

 */

    22

struct irc_chan_info {

    23

    /** Channel name, with the [#&!] prefix */

    24

    const char *channel;

    25

    26

};

    27

    28

/**

    35

 *

    36

 * Where callbacks have irc_nm arguments, these are MAY be given as NULL if the prefix could not be parsed.

    37

 */

    38

struct irc_chan_callbacks {

    39

    /** Joined the channel */

    40

    void (*on_self_join) (struct irc_chan *chan, void *arg);

    41

    42

    /** We parted the channel */

    43

    void (*on_self_part) (struct irc_chan *chan, void *arg);

    44

    45

    /** Someone joined the channel */

    46

    void (*on_join) (struct irc_chan *chan, const struct irc_nm *source, void *arg);

    47

    48

    /** Someone parted the channel. The irc_chan_user is still present */

    49

    void (*on_part) (struct irc_chan *chan, const struct irc_nm *source, const char *msg, void *arg);

    50

    51

    /** Someone quit the channel. The irc_chan_user is still present */

    52

    void (*on_quit) (struct irc_chan *chan, const struct irc_nm *source, const char *msg, void *arg);

    53

    54

    /** Someone sent a message to the channel */

    55

    void (*on_msg) (struct irc_chan *chan, const struct irc_nm *source, const char *msg, void *arg);

    56

};

    57

    58

/**

    62

 */

    63

struct irc_chan_user {

    64

    /** The per-network user info */

    65

    struct irc_user *user;

    66

    67

    /** The irc_chan list */

    68

    LIST_ENTRY(irc_chan_user) chan_users;

    69

};

    70

    71

/**

    80

 */

    81

struct irc_chan {

    83

    struct irc_net *net;

    84

    85

    /** Our identifying info */

    86

    struct irc_chan_info info;

    87

    88

    /** 

    90

     * @{ 

    91

     */

    92

    /** JOIN request sent, waiting for reply */

    93

    bool joining;

    94

    95

    /** Currently joined to channel */

    96

    bool joined;

    97

    98

    /** We PART'd the channel */

    99

    bool parted;

   100

   101

    // @}

   102

   103

    /** List of users on channel */

   104

    LIST_HEAD(irc_chan_users_list, irc_chan_user) users;

   105

   106

    /** General command handlers */

   107

    irc_cmd_handlers_t handlers;

   108

   109

    /** High-level user callbacks */

   110

    struct chain_list callbacks;

   114

};

   115

   116

/**

   117

 * Return the channel's name

   118

 */

   119

const char* irc_chan_name (struct irc_chan *chan);

   120

   121

/**

   122

 * Build/initialize a new irc_chan struct. This does not have any external side-effects.

   123

 *

   124

 * The channel will be in the IRC_CHAN_INIT state after this.

   125

 *

   126

 * @param chan_ptr the new irc_chan is returned via this pointer

   127

 * @param net the irc_net this channel is on

   128

 * @param info the channel's identifying information

   129

 * @param err error codes are returned via this

   130

 */

   131

err_t irc_chan_create (struct irc_chan **chan_ptr, struct irc_net *net, const struct irc_chan_info *info, struct error_info *err);

   132

   133

/**

   134

 * Destroy irc_chan state, without doing anything to the network

   135

 */

   136

void irc_chan_destroy (struct irc_chan *chan);

   137

   138

/**

   140

 */

   141

err_t irc_chan_add_callbacks (struct irc_chan *chan, const struct irc_chan_callbacks *callbacks, void *arg);

   142

   143

/**

   144

 * Remove high-level irc_chan callbacks.

   145

 */

   146

void irc_chan_remove_callbacks (struct irc_chan *chan, const struct irc_chan_callbacks *callbacks, void *arg);

   147

   148

/**

   149

 * Look up an irc_chan_user struct by nickname for this channel, returning NULL if no such chan_user exists.

   150

 *

   153

 * @param chan the channel context

   154

 * @param nickname the user's current nickname

   156

 */

   157

struct irc_chan_user* irc_chan_get_user (struct irc_chan *chan, const char *nickname);

   158

   159

/**

   160

 * Send the initial JOIN message.

   161

 *

   162

 * @param chan the channel to JOIN

   163

 */

   164

err_t irc_chan_join (struct irc_chan *chan);

   165

   166

#endif