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

/**

    29

 * Per-channel-user state. This is used to store the list of irc_user's on an irc_chan.

    30

 *

    31

 * The nickname is accessible via user->nickname.

    32

 */

    33

struct irc_chan_user {

    34

    /** The per-network user info */

    35

    struct irc_user *user;

    36

    37

    /** The irc_chan list */

    38

    LIST_ENTRY(irc_chan_user) chan_users;

    39

};

    40

    41

/**

    42

 * High-level IRC channel callbacks for convenience.

    43

 *

    44

 * These are based on the normal irc_chan::handlers interface, and you can use both freely.

    45

 *

    46

 * The on_self_* handlers are for actions that affect our own status on the channel, the rest are only for actions

    47

 * done by other users.

    48

 *

    49

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

    50

 */

    51

struct irc_chan_callbacks {

    52

    /** Joined the channel */

    53

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

    54

    55

    /** We parted the channel */

    56

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

    57

    58

    /** We were kicked from the channel */

    59

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

    60

    61

    /** We sent a message to the channel using irc_chan_PRIVMSG */

    62

    void (*on_self_msg) (struct irc_chan *chan, const char *msg, void *arg);

    63

    64

    /** We sent a notice to the channel using irc_chan_NOTICE */

    65

    void (*on_self_notice) (struct irc_chan *chan, const char *msg, void *arg);

    66

    67

    /** Someone joined the channel */

    68

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

    69

    70

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

    71

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

    72

    73

    /** Someone was kicked from the channel. The irc_chan_user is still present */

    74

    void (*on_kick)  (struct irc_chan *chan, const struct irc_nm *source, struct irc_chan_user *target, const char *msg, void *arg);

    75

    76

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

    77

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

    78

    79

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

    80

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

    81

};

    82

    83

/**

    84

 * Callback storage struct

    85

 */

    86

struct irc_chan_callback_item {

    87

    CHAIN_ITEM_HEADER(irc_chan_callback_item);

    88

    89

    const struct irc_chan_callbacks *callbacks;

    90

    91

    void *arg;

    92

};

    93

    94

/**

    95

 * Persistent IRC channel state, part of irc_net.

    96

 *

    97

 * This stores the channel's info, status flags, users list, and handlers/callbacks.

    98

 *

    99

 * Create/get channels using the irc_net_add_chan()/irc_net_get_chan() interface, and then attach your own

   100

 * callbacks/handlers using irc_chan_add_callbacks()/irc_chan::handlers and irc_cmd_add().

   101

 *

   102

 * Note that irc_net will propagate all relevant events for each channel.

   103

 */

   104

struct irc_chan {

   105

    /** The network we're part of */

   106

    struct irc_net *net;

   107

   108

    /** Our identifying info */

   109

    struct irc_chan_info info;

   110

   111

    /** 

   112

     * @defgroup irc_chan_state State flags 

   113

     * @{ 

   114

     */

   115

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

   116

    bool joining;

   117

   118

    /** Currently joined to channel */

   119

    bool joined;

   120

   121

    /** We PART'd the channel */

   122

    bool parted;

   123

   124

    /** We were KICK'd from the channel */

   125

    bool kicked;

   126

   127

    // @}

   128

   129

    /** List of users on channel */

   130

    LIST_HEAD(irc_chan_users_list, irc_chan_user) users;

   131

   132

    /** General command handlers */

   133

    struct irc_cmd_handlers handlers;

   134

   135

    /** High-level user callbacks */

   136

    CHAIN_HEAD_TYPE(irc_chan_callback_list, irc_chan_callback_item) callbacks;

   137

   138

    /** The irc_net::channels list */

   139

    TAILQ_ENTRY(irc_chan) net_channels;

   140

};

   141

   142

/**

   143

 * Return the channel's name

   144

 */

   145

const char* irc_chan_name (struct irc_chan *chan);

   146

   147

/**

   148

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

   149

 *

   150

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

   151

 *

   152

 * The contents of \a info will be copied.

   153

 *

   154

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

   155

 * @param net the irc_net this channel is on

   156

 * @param info the channel's identifying information

   157

 * @param err error codes are returned via this

   158

 */

   160

   161

/**

   162

 * Destroy irc_chan state, without doing anything to the network

   163

 */

   164

void irc_chan_destroy (struct irc_chan *chan);

   165

   166

/**

   167

 * Add a set of high-level irc_chan callbacks. Not all callbacks need to be implemented.

   168

 */

   169

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

   170

   171

/**

   172

 * Remove high-level irc_chan callbacks.

   173

 */

   174

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

   175

   176

/**

   177

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

   178

 *

   179

 * Be careful not to hold on to this, as the irc_chan_user struct may be released if the user leaves the channel.

   180

 *

   181

 * @param chan the channel context

   182

 * @param nickname the user's current nickname

   183

 * @return the irc_chan_user state, or NULL if nickname not found

   184

 */

   185

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

   186

   187

/**

   188

 * Send the initial JOIN message.

   189

 *

   190

 * @param chan the channel to JOIN

   191

 */

   192

err_t irc_chan_join (struct irc_chan *chan);

   193

   194

/**

   195

 * Send a normal PRIVMSG to the channel. If we're being pedantic, one should use NOTICE instead for messages sent in

   196

 * reply to PRIVMSG's, but the real world is different.

   197

 *

   198

 * This also invokes any self_msg callbacks.

   199

 *

   200

 * @param chan the IRC channel

   201

 * @param message the message to send

   202

 */

   203

err_t irc_chan_PRIVMSG (struct irc_chan *chan, const char *message);

   204

   205

/**

   206

 * Send a NOTICE message to the channel.

   207

 *

   208

 * This also invokes any self_notice callbacks.

   209

 *

   210

 * @param chan the IRC channel

   211

 * @param message the message to send

   212

 */

   213

err_t irc_chan_NOTICE (struct irc_chan *chan, const char *message);

   214

   215

#endif