Dokumentacja pliku rivchat.c

#include "ekg2.h"
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <pwd.h>
#include <sys/utsname.h>
#include "rivchat.h"

Wykres zależności załączania dla rivchat.c:

Struktury danych
struct	rivchat_private_t
struct	rivchat_userlist_private_t
struct	rivchat_place_t

Definicje
#define	DEFQUITMSG   "EKG2 - It's better than sex!"
#define	SGQUITMSG(x)   session_get(x, "QUIT_MSG")
#define	QUITMSG(x)   (SGQUITMSG(x)?SGQUITMSG(x):DEFQUITMSG)
#define	rivchat_fix32(x)   x
#define	rivchat_userlist_priv_get(u)   ((rivchat_userlist_private_t *) userlist_private_get(&rivchat_plugin, u))
#define	MAX_BYTES_PER_LINE   16
#define	RIVCHAT_VAR_HOSTNAME   3
#define	RIVCHAT_VAR_NICKNAME   5
#define	RIVCHAT_VAR_USERNAME   7
#define	RIVCHAT_ONLY   SESSION_MUSTBELONG | SESSION_MUSTHASPRIVATE
#define	RIVCHAT_FLAGS   RIVCHAT_ONLY | SESSION_MUSTBECONNECTED

Funkcje
static int	rivchat_theme_init ()
static int	rivchat_plugin_destroy ()
static int	rivchat_send_packet (session_t *s, guint32 type, userlist_t *user, const char *buf, size_t buflen)
static int	rivchat_send_packet_string (session_t *s, guint32 type, userlist_t *user, const char *str)
static int	rivchat_validate_uid (void *data, va_list ap)
static int	rivchat_session_init (void *data, va_list ap)
static int	rivchat_session_deinit (void *data, va_list ap)
static int	rivchat_print_version (void *data, va_list ap)
static int	rivchat_userlist_info_handle (void *data, va_list ap)
static int	rivchat_userlist_priv_handler (void *data, va_list ap)
static int	rivchat_topic_header (void *data, va_list ap)
static void	rivchat_print_payload (unsigned char *payload, size_t len)
static char *	rivchat_packet_name (int type)
static char *	rivchat_make_window (unsigned int port)
static char *	rivchat_make_formatname (int type, int is_our, int is_priv)
static userlist_t *	rivchat_find_user (session_t *s, const char *target)
static void	rivchat_dcc_close (struct dcc_s *dcc)
static void	memncpy (char *dest, const char *src, size_t len)
static char *	rivchat_generate_data (session_t *s)
static void	rivchat_parse_packet (session_t *s, rivchat_header_t *_hdr, const char *ip)
static int	rivchat_handle_stream (int type, int fd, watch_type_t watch, session_t *s)
static gint	rivchat_pingpong (gint type, session_t *s)
static int	rivchat_command_connect (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_disconnect (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_reconnect (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_inline_msg (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_me (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_nick (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_topic (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_command_dcc (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	rivchat_places_sort (const rivchat_place_t *data1, const rivchat_place_t *data2)
static int	rivchat_command_places (const char *name, const char **params, session_t *session, const char *target, int quiet)
static void	rivchat_changed_nick (session_t *s, const char *var)
static void	rivchat_notify_reconnect (session_t *s, const char *var)
static void	rivchat_resend_ping (session_t *s, const char *var)
	__attribute__ ((visibility("default")))

Zmienne
plugin_t	rivchat_plugin = { .name = "rivchat", .pclass = PLUGIN_PROTOCOL , .destroy = rivchat_plugin_destroy, .theme_init = rivchat_theme_init }
static plugins_params_t	rivchat_plugin_vars []

Dokumentacja definicji

DEFQUITMSG

#define DEFQUITMSG   "EKG2 - It's better than sex!"

MAX_BYTES_PER_LINE

#define MAX_BYTES_PER_LINE   16

QUITMSG

#define QUITMSG

(

x

)

(SGQUITMSG(x)?SGQUITMSG(x):DEFQUITMSG)

rivchat_fix32

#define rivchat_fix32

(

x

)

x

RIVCHAT_FLAGS

#define RIVCHAT_FLAGS   RIVCHAT_ONLY | SESSION_MUSTBECONNECTED

RIVCHAT_ONLY

#define RIVCHAT_ONLY   SESSION_MUSTBELONG | SESSION_MUSTHASPRIVATE

rivchat_userlist_priv_get

#define rivchat_userlist_priv_get

(

u

)

((rivchat_userlist_private_t *) userlist_private_get(&rivchat_plugin, u))

RIVCHAT_VAR_HOSTNAME

#define RIVCHAT_VAR_HOSTNAME   3

RIVCHAT_VAR_NICKNAME

#define RIVCHAT_VAR_NICKNAME   5

RIVCHAT_VAR_USERNAME

#define RIVCHAT_VAR_USERNAME   7

SGQUITMSG

#define SGQUITMSG

(

x

)

session_get(x, "QUIT_MSG")

Dokumentacja funkcji

__attribute__()

__attribute__

(

(visibility("default"))

)

memncpy()

static void memncpy ( char *  dest, const char *  src, size_t  len  )

static

rivchat_changed_nick()

static void rivchat_changed_nick ( session_t *  s, const char *  var  )

static

rivchat_command_connect()

static int rivchat_command_connect ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_dcc()

static int rivchat_command_dcc ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_disconnect()

static int rivchat_command_disconnect ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_inline_msg()

static int rivchat_command_inline_msg ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_me()

static int rivchat_command_me ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_nick()

static int rivchat_command_nick ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_places()

static int rivchat_command_places ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_reconnect()

static int rivchat_command_reconnect ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_command_topic()

static int rivchat_command_topic ( const char *  name, const char **  params, session_t *  session, const char *  target, int  quiet  )

static

rivchat_dcc_close()

static void rivchat_dcc_close ( struct dcc_s *  dcc )

static

rivchat_find_user()

static userlist_t* rivchat_find_user ( session_t *  s, const char *  target  )

static

rivchat_generate_data()

static char* rivchat_generate_data ( session_t *  s )

static

rivchat_handle_stream()

static int rivchat_handle_stream ( int  type, int  fd, watch_type_t  watch, session_t *  s  )

static

rivchat_make_formatname()

static char* rivchat_make_formatname ( int  type, int  is_our, int  is_priv  )

static

rivchat_make_window()

static char* rivchat_make_window ( unsigned int  port )

static

rivchat_notify_reconnect()

static void rivchat_notify_reconnect ( session_t *  s, const char *  var  )

static

rivchat_packet_name()

static char* rivchat_packet_name ( int  type )

static

rivchat_parse_packet()

static void rivchat_parse_packet ( session_t *  s, rivchat_header_t *  _hdr, const char *  ip  )

static

rivchat_pingpong()

static gint rivchat_pingpong ( gint  type, session_t *  s  )

static

rivchat_places_sort()

static int rivchat_places_sort ( const rivchat_place_t *  data1, const rivchat_place_t *  data2  )

static

rivchat_plugin_destroy()

static int rivchat_plugin_destroy ( )

static

rivchat_print_payload()

static void rivchat_print_payload ( unsigned char *  payload, size_t  len  )

static

rivchat_print_version()

static int rivchat_print_version ( void *  data, va_list  ap  )

static

rivchat_resend_ping()

static void rivchat_resend_ping ( session_t *  s, const char *  var  )

static

rivchat_send_packet()

static int rivchat_send_packet ( session_t *  s, guint32  type, userlist_t *  user, const char *  buf, size_t  buflen  )

static

rivchat_send_packet_string()

static int rivchat_send_packet_string ( session_t *  s, guint32  type, userlist_t *  user, const char *  str  )

static

rivchat_session_deinit()

static int rivchat_session_deinit ( void *  data, va_list  ap  )

static

rivchat_session_init()

static int rivchat_session_init ( void *  data, va_list  ap  )

static

rivchat_theme_init()

static int rivchat_theme_init ( )

static

rivchat_topic_header()

static int rivchat_topic_header ( void *  data, va_list  ap  )

static

rivchat_userlist_info_handle()

static int rivchat_userlist_info_handle ( void *  data, va_list  ap  )

static

rivchat_userlist_priv_handler()

static int rivchat_userlist_priv_handler ( void *  data, va_list  ap  )

static

rivchat_validate_uid()

static int rivchat_validate_uid ( void *  data, va_list  ap  )

static

Dokumentacja zmiennych

rivchat_plugin

plugin_t rivchat_plugin = { .name = "rivchat", .pclass = PLUGIN_PROTOCOL , .destroy = rivchat_plugin_destroy, .theme_init = rivchat_theme_init }

rivchat_plugin_vars

plugins_params_t rivchat_plugin_vars[]

static

Wartość początkowa:

= {
    {  "alias" ,  NULL ,  0 ,  VAR_STR ,  NULL , NULL },                
    {  "auto_connect" ,  "0" ,  0 ,  VAR_BOOL ,  NULL , NULL },             
    {  "auto_reconnect" ,  "0" ,  0 ,  VAR_INT ,  NULL , NULL },                    
#define RIVCHAT_VAR_HOSTNAME
    {  "hostname" ,  NULL ,  0 ,  VAR_STR ,  rivchat_resend_ping , NULL },          
    {  "log_formats" ,  "irssi" ,  0 ,  VAR_STR ,  NULL , NULL },               
#define RIVCHAT_VAR_NICKNAME
    {  "nickname" ,  NULL ,  0 ,  VAR_STR ,  rivchat_changed_nick , NULL },     
    {  "port" ,  "16127" ,  0 ,  VAR_STR ,  rivchat_notify_reconnect , NULL },      
#define RIVCHAT_VAR_USERNAME
    {  "username" ,  NULL ,  0 ,  VAR_STR ,  rivchat_resend_ping , NULL },          
    {  "VERSION_NAME" ,  0 ,  0 ,  VAR_STR ,  rivchat_resend_ping , NULL },         
    {  "VERSION_NO" ,  0 ,  0 ,  VAR_STR ,  rivchat_resend_ping , NULL },           
    {  "VERSION_SYS" ,  0 ,  0 ,  VAR_STR ,  rivchat_resend_ping , NULL },          
    { NULL, NULL, 0, -1, NULL }
}