1

#ifndef IRC_PROTO_H

     2

#define IRC_PROTO_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * General IRC protocol things, such as prefix/nickmask/nickname parsing

     8

 */

     9

#include "error.h"

    10

#include <stddef.h>

    11

    12

/**

    14

 */

    15

#define IRC_NICK_MAX 31

    16

    17

/**

    25

 * Parsed nickmask

    26

 */

    27

struct irc_nm {

    28

    /** Nickname, not normalized */

    29

    const char *nickname;

    30

    31

    /** Username, including any ident-related prefix from the network */

    32

    const char *username;

    33

    34

    /** Hostname, either reverse DNS hostname, literal IPv4 or literal IPv6 */

    35

    const char *hostname;

    36

};

    37

    38

/**

    39

 * Parse a full nickmask from a prefix. This fails if the prefix is a server name.

    40

 *

    43

 */

    45

    46

/**

    47

 * Compare two nicknames for equality, with standard strcmp() semantics.

    48

 */

    49

int irc_cmp_nick (const char *nick1, const char *nick2);

    50

    51

/**

    52

 * Compare up to the first n chars of the two nickname strings for equality, with standard strcmp() semantics.

    53

 */

    54

int irc_ncmp_nick (const char *nick1, const char *nick2, size_t n);

    55

    56

/**

    57

 * Parse the nickname portion of a prefix, storing it in the given buffer of IRC_NICK_MAX bytes.

    58

 */

    59

err_t irc_prefix_parse_nick (const char *prefix, char nick[IRC_NICK_MAX]);

    60

    61

/**

    62

 * Compare the nickname in the given prefix and with the given nickname for equality.

    63

 *

    64

 * @return -err for invalid prefix, 0 for match, >0 for non-match.

    65

 */

    66

int irc_prefix_cmp_nick (const char *prefix, const char *nick);

    67

    68

/**

    69

 * @group IRC command numerics

    70

 * @{

    71

 */

    72

    73

/**

    74

 * 001 <nick> :Welcome to the Internet Relay Network <nick>!<user>@<host>

    75

 */

    76

#define IRC_RPL_WELCOME         "001"

    77

    78

// @}

    79

    80

#endif