Dokumentacja pliku stuff.h

#include <sys/types.h>
#include <sys/time.h>
#include <time.h>
#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include "plugins.h"
#include "sessions.h"

Wykres zależności załączania dla stuff.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	binding
struct	binding_added
struct	timer

Definicje
#define	BINDING_FUNCTION(x)   void x(const char *arg)
#define	TIMER(x)   int x(int type, void *data)
#define	xisxdigit(c)   isxdigit((int) (unsigned char) c)
#define	xisdigit(c)   isdigit((int) (unsigned char) c)
#define	xisalpha(c)   isalpha_pl((int) (unsigned char) c)
#define	xisalnum(c)   isalnum((int) (unsigned char) c)
#define	xisspace(c)   isspace((int) (unsigned char) c)
#define	xtolower(c)   tolower((int) (unsigned char) c)
#define	xtoupper(c)   toupper((int) (unsigned char) c)

Definicje typów
typedef struct binding_added	binding_added_t

Funkcje
void	binding_free ()
void	changed_theme (const char *var)
const char *	compile_time ()
void	iso_to_ascii (unsigned char *buf)
char *	saprintf (const char *format,...)
const char *	timestamp (const char *format)
const char *	timestamp_time (const char *format, time_t t)
int	isalpha_pl (unsigned char c)
struct timer *	timer_add (plugin_t *plugin, const char *name, unsigned int period, int persist, int(*function)(int, void *), void *data)
struct timer *	timer_add_ms (plugin_t *plugin, const char *name, unsigned int period, int persist, int(*function)(int, void *), void *data)
int	timer_remove (plugin_t *plugin, const char *name)
struct timer *	timers_removei (struct timer *t)
void	timers_destroy ()
const char *	ekg_status_string (const int status, const int cmd)
void	ekg_exit ()
void	ekg_debug_handler (int level, const char *format, va_list ap)
int	ekg_write (int fd, const char *buf, int len)
int	remote_request (char *what,...)

Zmienne
char *	config_console_charset
char *	server_console_charset
int	config_use_unicode
int	config_use_iso
struct binding *	bindings
struct timer *	timers
binding_added_t *	bindings_added
int	config_debug
int	config_display_welcome
int	config_query_commands
int	config_slash_messages
int	config_display_color
int	config_display_pl_chars
int	config_display_crap
int	config_default_status_window
char *	config_timestamp
int	config_timestamp_show
int	config_history_savedups
int	config_make_window
int	config_sort_windows
int	config_send_white_lines
char *	config_tab_command
int	config_save_quit
int	config_lastlog_noitems
int	config_lastlog_case
int	config_lastlog_display_all
char *	config_completion_char
int	config_changed
int	no_mouse
int	old_stderr
int	in_autoexec

Dokumentacja definicji

BINDING_FUNCTION

#define BINDING_FUNCTION

(

x

)

void x(const char *arg)

TIMER

#define TIMER

(

x

)

int x(int type, void *data)

xisalnum

#define xisalnum

(

c

)

isalnum((int) (unsigned char) c)

xisalpha

#define xisalpha

(

c

)

isalpha_pl((int) (unsigned char) c)

xisdigit

#define xisdigit

(

c

)

isdigit((int) (unsigned char) c)

xisspace

#define xisspace

(

c

)

isspace((int) (unsigned char) c)

xisxdigit

#define xisxdigit

(

c

)

isxdigit((int) (unsigned char) c)

xtolower

#define xtolower

(

c

)

tolower((int) (unsigned char) c)

xtoupper

#define xtoupper

(

c

)

toupper((int) (unsigned char) c)

Dokumentacja definicji typów

binding_added_t

typedef struct binding_added binding_added_t

Dokumentacja funkcji

binding_free()

void binding_free

(

)

binding_free()

Free memory allocated for key bindings.

changed_theme()

void changed_theme

(

const char *

var

)

compile_time()

const char* compile_time

(

)

compile_time()

Return compilation date, and time..
Used by /version command and ekg2 –version

Zwraca

DATE" "__TIME__
For example: "Jun 21 1987" " " "22:06:47"

ekg_debug_handler()

void ekg_debug_handler	(	int	level,
		const char *	format,
		va_list	ap
	)

ekg_debug_handler()

debug message [if config_debug set] coming direct from libgadu (by libgadu_debug_handler()) or by debug() or by debug_ext()
XXX, doc more. But function now is ok.

Zobacz również

debug_ext()

Błąd:

It can happen than internal string_t line will be not freed.

Parametry

level
format
ap

ekg_exit()

void ekg_exit

(

)

ekg_status_string()

const char* ekg_status_string	(	const int	status,
		const int	cmd
	)

ekg_write()

int ekg_write	(	int	fd,
		const char *	buf,
		int	len
	)

ekg_write()

write data to given fd, if it cannot be done [because system buffer is too small. it'll create watch, and write as soon as possible] XXX, for now it'll always create watch. (You can be notified about state of buffer when you call ekg_write(fd, NULL, -1))

Nota

This should be used as replacement for write()

isalpha_pl()

int isalpha_pl

(

unsigned char

c

)

iso_to_ascii()

void iso_to_ascii

(

unsigned char *

buf

)

remote_request()

int remote_request	(	char *	what,
			...
	)

saprintf()

char* saprintf	(	const char *	format,
			...
	)

timer_add()

struct timer* timer_add	(	plugin_t *	plugin,
		const char *	name,
		unsigned int	period,
		int	persist,
		int(*)(int, void *)	function,
		void *	data
	)

timer_add_ms()

struct timer* timer_add_ms	(	plugin_t *	plugin,
		const char *	name,
		unsigned int	period,
		int	persist,
		int(*)(int, void *)	function,
		void *	data
	)

timer_remove()

int timer_remove	(	plugin_t *	plugin,
		const char *	name
	)

timers_destroy()

void timers_destroy

(

)

timers_removei()

struct timer* timers_removei

(

struct timer *

t

)

timestamp()

const char* timestamp

(

const char *

format

)

timestamp()

It returns static buffer with formated current time.

Parametry

format

- format to pass to strftime() [man 3 strftime]

Zwraca

if format is NULL or format == '\0' than it return ""
else it returns strftime()'d value, or "TOOLONG" if buf (sizeof(buf) == 100) was too small..

timestamp_time()

const char* timestamp_time	(	const char *	format,
		time_t	t
	)

Dokumentacja zmiennych

bindings

struct binding* bindings

bindings_added

binding_added_t* bindings_added

config_changed

int config_changed

config_completion_char

char* config_completion_char

config_console_charset

char* config_console_charset

config_debug

int config_debug

config_default_status_window

int config_default_status_window

config_display_color

int config_display_color

config_display_crap

int config_display_crap

config_display_pl_chars

int config_display_pl_chars

config_display_welcome

int config_display_welcome

config_history_savedups

int config_history_savedups

config_lastlog_case

int config_lastlog_case

config_lastlog_display_all

int config_lastlog_display_all

config_lastlog_noitems

int config_lastlog_noitems

config_make_window

int config_make_window

config_query_commands

int config_query_commands

config_save_quit

int config_save_quit

config_send_white_lines

int config_send_white_lines

config_slash_messages

int config_slash_messages

config_sort_windows

int config_sort_windows

config_tab_command

char* config_tab_command

config_timestamp

char* config_timestamp

config_timestamp_show

int config_timestamp_show

config_use_iso

int config_use_iso

config_use_unicode

int config_use_unicode

in_autoexec

int in_autoexec

no_mouse

int no_mouse

old_stderr

int old_stderr

server_console_charset

char* server_console_charset

timers

struct timer* timers