Dokumentacja pliku userlist.h

#include <time.h>
#include "dynstuff.h"
#include "plugins.h"
#include "sessions.h"
#include "windows.h"

Wykres zależności załączania dla userlist.h:

Ten wykres pokazuje, które pliki bezpośrednio lub pośrednio załączają ten plik:

Idź do kodu źródłowego tego pliku.

Struktury danych
struct	userlist
struct	ekg_group
struct	ignore_label

Definicje
#define	userlist_find_n(a, b)   userlist_find(session_find(a), b)
#define	user_private_item_get_int(user, name)   private_item_get_int(&(user)->priv_list, name)
#define	user_private_item_set(user, name, value)   private_item_set(&(user)->priv_list, name, value)

Definicje typów
typedef struct userlist	userlist_t

Wyliczenia
enum	xstate_t { EKG_XSTATE_BLINK = 1, EKG_XSTATE_TYPING = 2, EKG_XSTATE_BLINK = 1, EKG_XSTATE_TYPING = 2 }
enum	ignore_t {   IGNORE_STATUS = 0x01, IGNORE_STATUS_DESCR = 0x02, IGNORE_MSG = 0x04, IGNORE_DCC = 0x08,   IGNORE_EVENTS = 0x10, IGNORE_NOTIFY = 0x20, IGNORE_XOSD = 0x40, IGNORE_LOG = 0x80,   IGNORE_ALL = 0xFF, IGNORE_STATUS = 0x01, IGNORE_STATUS_DESCR = 0x02, IGNORE_MSG = 0x04,   IGNORE_DCC = 0x08, IGNORE_EVENTS = 0x10, IGNORE_NOTIFY = 0x20, IGNORE_XOSD = 0x40,   IGNORE_LOG = 0x80, IGNORE_ALL = 0xFF }

Funkcje
userlist_t *	remote_userlist_add_entry (userlist_t **userlist, char **__entry, int count)
int	userlist_remove (session_t *session, userlist_t *u)
userlist_t *	userlist_find (session_t *session, const char *uid)
void	userlist_free (session_t *session)
void	userlists_destroy (userlist_t **userlist)
int	ignored_check (session_t *session, const char *uid)
int	ekg_group_member (userlist_t *u, const char *group)
char *	get_uid (session_t *session, const char *text)

Zmienne
struct ignore_label	ignore_labels []

Dokumentacja definicji

user_private_item_get_int

#define user_private_item_get_int	(		user,
			name
	)		private_item_get_int(&(user)->priv_list, name)

user_private_item_set

#define user_private_item_set	(		user,
			name,
			value
	)		private_item_set(&(user)->priv_list, name, value)

userlist_find_n

#define userlist_find_n	(		a,
			b
	)		userlist_find(session_find(a), b)

Dokumentacja definicji typów

userlist_t

typedef struct userlist userlist_t

Dokumentacja typów wyliczanych

ignore_t

enum ignore_t

Wartości wyliczeń
IGNORE_STATUS
IGNORE_STATUS_DESCR
IGNORE_MSG
IGNORE_DCC
IGNORE_EVENTS
IGNORE_NOTIFY
IGNORE_XOSD
IGNORE_LOG
IGNORE_ALL
IGNORE_STATUS
IGNORE_STATUS_DESCR
IGNORE_MSG
IGNORE_DCC
IGNORE_EVENTS
IGNORE_NOTIFY
IGNORE_XOSD
IGNORE_LOG
IGNORE_ALL

xstate_t

enum xstate_t

Wartości wyliczeń
EKG_XSTATE_BLINK
EKG_XSTATE_TYPING
EKG_XSTATE_BLINK
EKG_XSTATE_TYPING

Dokumentacja funkcji

ekg_group_member()

int ekg_group_member	(	userlist_t *	u,
		const char *	group
	)

ekg_group_member()

sprawdza czy użytkownik jest członkiem danej grupy.

Parametry

u	- uzytkownik, ktorego chcemy sprawdzic
group	- grupa ktora chcemy sprawdzic

Zwraca

1 jeśli tak, 0 jeśli nie.

get_uid()

char* get_uid	(	session_t *	session,
		const char *	text
	)

get_uid()

Return and checks if uid passed text is proper for session or it's nickname of smb on session userlist.

Nota

It also work with userlist_find() and if text is nickname of smb in session userlist.. Than it return uid of this user. So you shouldn't call userlist_find() with get_uid() as param, cause it's senseless userlist_find() don't check for "$" target, so you must do it by hand. Rest is the same. If there are such user: userlist_find(s, get_uid(s, target)) return the same as userlist_find(s, target)
If not, even userlist_find(s, get_uid(s, get_uid(s, get_uid(s, target)))) won't help

Parametry

session	- session to check for, if NULL check all sessions (it doesn't look at userlists, in this mode)
text	- uid to check for, if '$' than check current window.

Zobacz również

userlist_find()

get_nickname() - to look for nickname..

get_uid_any() - to do all session searching+specified session userlist search.. This function does only all session searching if session is NULL... and than it doesn't look at userlist. Do you feel difference?

Zwraca

If we found proper uid for text, than return it. Otherwise NULL

ignored_check()

int ignored_check	(	session_t *	session,
		const char *	uid
	)

ignored_check()

czy dany numerek znajduje się na liście ignorowanych.

Parametry

session	- sesja w ktorej mamy szukac uzytkownika
uid	- uid uzytkownika

remote_userlist_add_entry()

userlist_t* remote_userlist_add_entry	(	userlist_t **	userlist,
		char **	__entry,
		int	count
	)

userlist_find()

userlist_t* userlist_find	(	session_t *	session,
		const char *	uid
	)

userlist_free()

void userlist_free

(

session_t *

session

)

userlist_remove()

int userlist_remove	(	session_t *	session,
		userlist_t *	u
	)

userlists_destroy()

void userlists_destroy

(

userlist_t **

userlist

)

Dokumentacja zmiennych

ignore_labels

struct ignore_label ignore_labels[]