Dokumentacja pliku jogger.c

#include <ekg/commands.h>
#include <ekg/debug.h>
#include <ekg/plugins.h>
#include <ekg/recode.h>
#include <ekg/queries.h>
#include <ekg/sessions.h>
#include <ekg/stuff.h>
#include <ekg/themes.h>
#include <ekg/userlist.h>
#include <ekg/xmalloc.h>
#include <ekg/vars.h>

Definicje
#define	JOGGER_DATE   "2007-05-04"
#define	JOGGER_CMDFLAGS   SESSION_MUSTBELONG
#define	JOGGER_CMDFLAGS_TARGET   SESSION_MUSTBELONG|COMMAND_ENABLEREQPARAMS|COMMAND_PARAMASTARGET

Funkcje
static int	jogger_theme_init (void)
int	jogger_plugin_init (int prio)
static int	jogger_plugin_destroy (void)
void	jogger_localize_texts ()
void	jogger_free_texts (int real_free)
int	jogger_msghandler (void *data, va_list ap)
int	jogger_msg (const char *name, const char **params, session_t *session, const char *target, int quiet)
int	jogger_subscribe (const char *name, const char **params, session_t *session, const char *target, int quiet)
void	jogger_localize_headers ()
void	jogger_free_headers (int real_free)
int	jogger_prepare (const char *name, const char **params, session_t *session, const char *target, int quiet)
int	jogger_publish (const char *name, const char **params, session_t *session, const char *target, int quiet)
	PLUGIN_DEFINE (jogger, PLUGIN_PROTOCOL, jogger_theme_init)
session_t *	jogger_session_find_uid (session_t *s, const char *uid)
static int	jogger_validate_uid (void *data, va_list ap)
static int	jogger_statuschanged (void *data, va_list ap)
static int	jogger_statuscleanup (void *data, va_list ap)
static void	jogger_usedchanged (session_t *s, const char *varname)
static int	jogger_null (const char *name, const char **params, session_t *session, const char *target, int quiet)
static int	jogger_print_version (void *data, va_list ap)
static int	jogger_newsession (void *data, va_list ap)
static int	jogger_postconfig (void *data, va_list ap)

Zmienne
static plugins_params_t	jogger_plugin_vars []
static const char *	jogger_protocols [] = { "jogger:", NULL }
static struct protocol_plugin_priv	jogger_priv

Dokumentacja definicji

#define JOGGER_CMDFLAGS   SESSION_MUSTBELONG

#define JOGGER_CMDFLAGS_TARGET   SESSION_MUSTBELONG|COMMAND_ENABLEREQPARAMS|COMMAND_PARAMASTARGET

#define JOGGER_DATE   "2007-05-04"

Dokumentacja funkcji

void jogger_free_headers

(

int

real_free

)

void jogger_free_texts

(

int

real_free

)

void jogger_localize_headers

(

)

void jogger_localize_texts

(

)

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

int jogger_msghandler	(	void *	data,
		va_list	ap
	)

static int jogger_newsession ( void *  data, va_list  ap  )

static

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

static

static int jogger_plugin_destroy ( void  )

static

int jogger_plugin_init

(

int

prio

)

static int jogger_postconfig ( void *  data, va_list  ap  )

static

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

static int jogger_print_version ( void *  data, va_list  ap  )

static

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

session_t* jogger_session_find_uid	(	session_t *	s,
		const char *	uid
	)

jogger_session_find_uid() tries to find Jogger session connected with given session (s) and uid.

Zwraca

Session pointer or NULL if none match.

static int jogger_statuschanged ( void *  data, va_list  ap  )

static

static int jogger_statuscleanup ( void *  data, va_list  ap  )

static

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

static int jogger_theme_init ( void  )

static

static void jogger_usedchanged ( session_t *  s, const char *  varname  )

static

static int jogger_validate_uid ( void *  data, va_list  ap  )

static

PLUGIN_DEFINE	(	jogger	,
		PLUGIN_PROTOCOL	,
		jogger_theme_init
	)

Dokumentacja zmiennych

plugins_params_t jogger_plugin_vars[]

static

Wartość początkowa:

 {
        PLUGIN_VAR_ADD("entry_file",            VAR_STR, NULL, 0, NULL),
        PLUGIN_VAR_ADD("entry_hash",            VAR_STR, NULL, 0, NULL),
        PLUGIN_VAR_ADD("ignore_outgoing_entries",VAR_BOOL, "0", 0, NULL),
        PLUGIN_VAR_ADD("log_formats",           VAR_STR, "simple,sqlite", 0, NULL),
        PLUGIN_VAR_ADD("newentry_open_query",   VAR_BOOL, "1", 0, NULL),
        PLUGIN_VAR_ADD("own_commentformat",     VAR_STR, NULL, 0, NULL),
        PLUGIN_VAR_ADD("own_commentformat_autodetect",  VAR_BOOL, "1", 0, NULL),
        PLUGIN_VAR_ADD("used_session",          VAR_STR, NULL, 0, jogger_usedchanged),
        PLUGIN_VAR_ADD("used_uid",              VAR_STR, NULL, 0, jogger_usedchanged),
        PLUGIN_VAR_ADD("userlist_keep",         VAR_BOOL, "0", 0, NULL),


}

struct protocol_plugin_priv jogger_priv

static

Wartość początkowa:

 {
        .protocols      = jogger_protocols
}

const char* jogger_protocols[] = { "jogger:", NULL }

static