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

 */

     9

#include "irc_proto.h"

    10

#include "error.h"

    11

    12

/**

    13

 * The maximum length of a line, without terminating CRLF, but including NUL

    14

 */

    15

#define IRC_LINE_MAX (510 + 1)

    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

    27

/**

    28

 * Chars that are invalid inside of the trailing-argument token

    29

 */

    30

#define IRC_TOKEN_TRAILING_INVALID "\r\n\n"

    31

    32

/**

    33

 * Low-level IRC protocol unit. Note that all fields are specifically constant strings, MUST NOT be modified, and 

    34

 * usually point at stack-allocated memory. Hence, if you need to mutate or store these values, you must copy them.

    35

 */

    36

struct irc_line {

    37

    /** The message source as a nickmask, for those messages that have a valid prefix. May be NULL otherwise */

    38

    const struct irc_nm *source;

    39

    40

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

    41

    const char *command;

    42

    43

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

    44

    const char *args[IRC_ARG_MAX];

    45

};

    46

    47

/**

    48

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

    49

 * stores pointers into this memory in the irc_line.

    50

 *

    51

 * If the prefix is a valid nickmask, it will be stored in the given given irc_nm, and irc_line.nm set to this.

    52

 *

    53

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

    54

 *

    55

 * XXX: strip trailing \r\n

    56

 */

    57

err_t irc_line_parse (struct irc_line *line, struct irc_nm *nm, char *data);

    58

    59

/**

    60

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

    61

 *

    62

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

    63

 *

    64

 * 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

    65

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

    66

 *

    67

 * XXX: append trailing \r\n

    68

 */

    69

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

    70

    71

/**

    72

 * Iterate through the arguments in an irc_line

    73

 */

    74

#define FOREACH_IRC_LINE_ARGS(line, arg_ptr) \

    75

    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++)

    76

    77

#endif /* IRC_LINE_H */