1

#ifndef IRC_LINE_H

     2

#define IRC_LINE_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * The low-level IRC protocol unit is a line, with prefix, command and arguments

     8

 */

    10

#include "error.h"

    11

    12

/**

    13

 * The maximum length of a line, without terminating CRLF

    14

 */

    15

#define IRC_LINE_MAX 510

    16

    17

/**

    18

 * The maximum number of arguments for a single command

    19

 */

    20

#define IRC_ARG_MAX 15

    21

    22

/**

    23

 * Chars that are invalid inside of tokens

    24

 */

    25

#define IRC_TOKEN_INVALID "\r\n\n "

    26

#define IRC_TOKEN_TRAILING_INVALID "\r\n\n"

    27

    28

/**

    29

 * Low-level IRC protocol unit

    30

 */

    31

struct irc_line {

    34

    35

    /** The command, either a numeric or a primary command */

    36

    const char *command;

    37

    38

    /** The arguments, with unused ones set to NULL */

    39

    const char *args[IRC_ARG_MAX];

    40

};

    41

    42

/**

    43

 * Parse an IRC message to fill in an irc_line. This mutates the value of data (to insert NULs between tokens), and

    44

 * stores pointers into this data into the irc_line.

    45

 *

    48

 * The irc_line will have the first N args values set to valid values, and all the rest set to NULL.

    49

 */

    51

    52

/**

    53

 * Formats an irc_line as a protocol line into the given buffer (which should hold at least IRC_LINE_MAX bytes).

    54

 *

    55

 * The irc_line.args are ignored from the first NULL argument onwards.

    56

 *

    57

 * An error is returned if a token has an invalid value (e.g. a space in the command or an argument other than the last

    58

 * one), or if the resulting line is too long.

    59

 */

    60

err_t irc_line_build (const struct irc_line *line, char *buf);

    61

    62

/**

    63

 * Iterate through the arguments in an irc_line

    64

 */

    65

#define FOREACH_IRC_LINE_ARGS(line, arg_ptr) \

    66

    for (size_t _irc_line_arg_idx = 0; _irc_line_arg_idx < IRC_ARG_MAX && (arg_ptr = line->args[_irc_line_arg_idx]); _irc_line_arg_idx++)

    67

    68

#endif /* IRC_LINE_H */