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_cmd.h"

    15

#include "error.h"

    16

#include <sys/queue.h>

    17

    18

/**

    19

 * IRC channel info, as required to create an irc_chan

    20

 */

    21

struct irc_chan_info {

    22

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

    23

    const char *channel;

    24

    25

};

    26

    27

/**

    31

 */

    32

struct irc_chan_callbacks {

    33

    /** Joined the channel */

    34

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

    35

    36

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

    38

};

    39

    40

/**

    41

 * Invoke the given callback with the given args

    42

 */

    43

#define IRC_CHAN_INVOKE_CALLBACK(chan, _cb_name_, ...)          \

    44

    do {                                                        \

    45

        struct chain_head *head;                                \

    46

                                                                \

    47

        CHAIN_FOREACH(&(chan)->callbacks, head) {               \

    48

            const struct irc_chan_callbacks *callbacks = head->chain;       \

    49

                                                                \

    50

            if (callbacks->_cb_name_)                           \

    51

                callbacks->_cb_name_((chan), ## __VA_ARGS__, head->arg);    \

    52

        }                                                       \

    53

    } while (0);

    54

    55

/**

    56

 * IRC channel state

    57

 */

    58

struct irc_chan {

    59

    /** The irc_net.channels list */

    60

    TAILQ_ENTRY(irc_chan) node;

    61

    62

    /* The network we're on */

    63

    struct irc_net *net;

    64

    65

    /** Our identifying info */

    66

    struct irc_chan_info info;

    67

    69

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

    70

        bool joining;

    71

    72

        /** Currently joined to channel */

    73

        bool joined;

    74

    77

    /** General command handlers */

    78

    irc_cmd_handlers_t handlers;

    79

    80

    /** High-level user callbacks */

    81

    struct chain_list callbacks;

    82

};

    83

    84

/**

    85

 * Return the channel's name

    86

 */

    87

const char* irc_chan_name (struct irc_chan *chan);

    88

    89

/**

    90

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

    91

 *

    92

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

    93

 *

    94

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

    95

 * @param net the irc_net this channel is on

    96

 * @param info the channel's identifying information

    97

 * @param err error codes are returned via this

    98

 */

    99

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

   100

   101

/**

   102

 * Destroy irc_chan state, without doing anything to the network

   103

 */

   104

void irc_chan_destroy (struct irc_chan *chan);

   105

   106

/**

   107

 * Add high-level irc_chan callbacks

   108

 */

   109

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

   110

   111

/**

   112

 * Send the initial JOIN message.

   113

 *

   114

 * The channel must be in the IRC_CHAN_INIT state, and will transition to the IRC_CHAN_JOINING state.

   115

 *

   116

 * @param chan the channel to JOIN

   117

 */

   118

err_t irc_chan_join (struct irc_chan *chan);

   119

   120

   121

#endif