1

#ifndef IRC_USER_H

     2

#define IRC_USER_H

     3

     4

/**

     5

 * @file

     6

 *

     7

 * Minimal state for tracking per-user state for an irc_net. Mainly, the purpose of this module is to support the

     8

 * irc_chan::users implementation, such that when a user's nickname is changed, one does not need to modify all

     9

 * irc_chan lists, but rather, just replace the nickname field here.

    10

 *

    11

 * XXX: should this tie in to irc_net to register its own NICK/QUIT handlers?

    12

 */

    13

#include "irc_net.h"

    14

#include "error.h"

    15

    16

/**

    17

 * Basic per-network user info. The lifetime of an irc_user struct is strictly for the duration between the user

    18

 * JOIN'ing onto the first irc_chan we are on (or us JOIN'ing onto it while they are on it), and them PART'ing the

    19

 * last channel we see them on, or QUIT'ing.

    20

 */

    21

struct irc_user {

    22

    /** The user's nickname */

    23

    char *nickname;

    24

    25

    /** Refcount for irc_chan.users lists */

    26

    size_t refcount;

    27

    28

    /** Our entry in the irc_net list */

    29

    LIST_ENTRY(irc_user) net_users;

    30

};

    31

    32

/**

    33

 * Create a new irc_user with the given nickname. The nickname is copied for storage.

    34

 *

    35

 * XXX: this is a private function for use by irc_net

    36

 */

    37

err_t irc_user_create (struct irc_user **user_ptr, struct irc_net *net, const char *nickname);

    38

    39

/**

    40

 * Rename the irc_user with a new nickname

    41

 */

    42

err_t irc_user_rename (struct irc_user *user, const char *new_nickname);

    43

    44

/**

    45

 * Destroy an irc_user, releasing memory

    46

 */

    47

void irc_user_destroy (struct irc_user *user);

    48

    49

#endif