1

#ifndef IRC_CMD_H

     2

#define IRC_CMD_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Command handlers callback lists for use with irc_line's

     8

 *

     9

 * XXX: irc_cmd_remove called from iniside irc_cmd_invoke?

    10

 */

    11

    12

#include "irc_line.h"

    13

#include "chain.h"

    14

    15

/**

    16

 * A single command name + handler function lookup entry. This defines the irc_line::command to handle, and the function used to handle it.

    17

 *

    18

 * Note that when an irc_line is matched against an array of these, only the *first* matching handler is invoked.

    19

 */

    20

struct irc_cmd_handler {

    21

    /** The command name to match */

    22

    const char *command;

    23

    24

    /**

    25

     * The handler function.

    26

     *

    27

     * @param line the irc_line that matched the command

    28

     * @param arg the context arg, as given to irc_cmd_add.

    29

     */

    30

    void (*func) (const struct irc_line *line, void *arg);

    31

};

    32

    33

/**

    34

 * A dynamic list of irc_cmd_handler's

    35

 */

    36

typedef struct chain_list irc_cmd_handlers_t;

    37

    38

/**

    39

 * Initialize a irc_cmd_handlers list.

    40

 */

    41

void irc_cmd_init (irc_cmd_handlers_t *handlers);

    42

    43

/**

    44

 * Append the given NULL-termianted array of irc_cmd_handler's to the irc_cmd_handlers list, without copying it.

    45

 *

    46

 * @param handlers the irc_cmd_handlers_t

    47

 * @param list the { NULL, NULL } termianted array of irc_cmd_handlers

    48

 * @param arg the opaque context argument, will be passed to the func's of the given list when invoked

    49

 */

    50

err_t irc_cmd_add (irc_cmd_handlers_t *handlers, const struct irc_cmd_handler *list, void *arg);

    51

    52

/**

    53

 * Trigger all relevant handlers for the given irc_line.

    54

 *

    55

 * @param handlers the irc_cmd_handlers_t

    56

 * @param line the line to match against the handlers and invoke the func with

    57

 */

    58

void irc_cmd_invoke (irc_cmd_handlers_t *handlers, const struct irc_line *line);

    59

    60

/**

    61

 * Remove a previously added handler list.

    62

 *

    63

 * @param handlers the irc_cmd_handlers_t

    64

 * @param list the list given to irc_cmd_add, compared as pointer value

    65

 * @param arg the context arg given to irc_cmd_add, compared as pointer value

    66

 */

    67

void irc_cmd_remove (irc_cmd_handlers_t *handlers, const struct irc_cmd_handler *list, void *arg);

    68

    69

/**

    70

 * Cleanup an irc_cmd_handlers list, releasing all memory.

    71

 *

    72

 * @param handlers the irc_cmd_handlers_t to cleanup

    73

 */

    74

void irc_cmd_free (irc_cmd_handlers_t *handlers);

    75

    76

#endif /* IRC_CMD_H */