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

    /** Command name to match */

    22

    const char *command;

    23

    24

    /**

    25

     * 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 registered list of irc_cmd_handlers

    35

 */

    36

struct irc_cmd_table {

    37

    CHAIN_ITEM_HEADER(irc_cmd_table);

    38

    39

    /** NULL-terminated array of handlers */

    40

    const struct irc_cmd_handler *list;

    41

    42

    /** Context argument*/

    43

    void *arg;

    44

};

    45

    46

CHAIN_HEAD_TYPE(irc_cmd_handlers, irc_cmd_table);

    47

    48

/**

    49

 * Initialize a irc_cmd_handlers.

    50

 */

    51

void irc_cmd_init (struct irc_cmd_handlers *handlers);

    52

    53

/**

    54

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

    55

 *

    56

 * @param list the { NULL, NULL } termianted array of irc_cmd_handler's

    57

 * @param arg the context argument

    58

 */

    59

err_t irc_cmd_add (struct irc_cmd_handlers *handlers, const struct irc_cmd_handler list[], void *arg);

    60

    61

/**

    62

 * Trigger all relevant handlers for the given irc_line.

    63

 *

    64

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

    65

 */

    66

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

    67

    68

/**

    69

 * Remove a previously added handler handlers.

    70

 *

    71

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

    72

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

    73

 */

    74

void irc_cmd_remove (struct irc_cmd_handlers *handlers, const struct irc_cmd_handler list[], void *arg);

    75

    76

/**

    77

 * Clears an irc_cmd_list, releasing all memory allocated by the.

    78

 */

    79

void irc_cmd_clear (struct irc_cmd_handlers *handlers);

    80

    81

#endif /* IRC_CMD_H */