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

    10

#include "irc_line.h"

    11

#include "chain.h"

    12

    13

/**

    14

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

    15

 *

    16

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

    17

 */

    18

struct irc_cmd_handler {

    19

    /** The command name to match */

    20

    const char *command;

    21

    22

    /**

    23

     * The handler function.

    24

     *

    25

     * @param line the irc_line that matched the command

    26

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

    27

     */

    28

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

    29

};

    30

    31

/**

    32

 * A dynamic list of irc_cmd_handler's

    33

 */

    34

typedef struct chain_list irc_cmd_handlers_t;

    35

    36

/**

    37

 * Initialize a irc_cmd_handlers list.

    38

 */

    39

void irc_cmd_init (irc_cmd_handlers_t *handlers);

    40

    41

/**

    42

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

    43

 *

    44

 * @param handlers the irc_cmd_handlers_t

    45

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

    46

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

    47

 */

    48

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

    49

    50

/**

    51

 * Trigger all relevant handlers for the given irc_line.

    52

 *

    53

 * @param handlers the irc_cmd_handlers_t

    54

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

    55

 */

    56

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

    57

    58

/**

    59

 * Remove a previously added handler list.

    60

 *

    61

 * @param handlers the irc_cmd_handlers_t

    62

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

    63

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

    64

 */

    65

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

    66

    67

/**

    68

 * Cleanup an irc_cmd_handlers list, releasing all memory.

    69

 *

    70

 * @param handlers the irc_cmd_handlers_t to cleanup

    71

 */

    72

void irc_cmd_free (irc_cmd_handlers_t *handlers);

    73

    74

#endif /* IRC_CMD_H */