Dokumentacja pliku plugins/ncurses/main.c

#include "ekg2-config.h"
#include <stdlib.h>
#include <string.h>
#include <signal.h>
#include <unistd.h>
#include <ekg/debug.h>
#include <ekg/plugins.h>
#include <ekg/windows.h>
#include <ekg/vars.h>
#include <ekg/stuff.h>
#include <ekg/themes.h>
#include <ekg/xmalloc.h>
#include <ekg/queries.h>
#include "ecurses.h"
#include "bindings.h"
#include "old.h"
#include "contacts.h"
#include "mouse.h"
#include "notify.h"

Funkcje
static int	ncurses_theme_init ()
	PLUGIN_DEFINE (ncurses, PLUGIN_UI, ncurses_theme_init)
int	ncurses_password_input (void *data, va_list ap)
static int	ncurses_beep (void *data, va_list ap)
static int	dd_contacts (const char *name)
static int	ncurses_statusbar_timer (int type, void *data)
static int	ncurses_statusbar_query (void *data, va_list ap)
static int	ncurses_ui_is_initialized (void *data, va_list ap)
static int	ncurses_ui_window_switch (void *data, va_list ap)
static int	ncurses_ui_window_print (void *data, va_list ap)
static int	ncurses_ui_window_new (void *data, va_list ap)
static int	ncurses_ui_window_kill (void *data, va_list ap)
static int	ncurses_ui_window_act_changed (void *data, va_list ap)
static int	ncurses_ui_window_target_changed (void *data, va_list ap)
static int	ncurses_ui_window_refresh (void *data, va_list ap)
static int	ncurses_ui_refresh (void *data, va_list ap)
static int	ncurses_ui_window_clear (void *data, va_list ap)
static int	ncurses_all_contacts_changed (void *data, va_list ap)
static int	ncurses_variable_changed (void *data, va_list ap)
static int	ncurses_conference_renamed (void *data, va_list ap)
static void	ncurses_changed_aspell (const char *var)
static int	ncurses_postinit (void *data, va_list ap)
static int	ncurses_binding_set_query (void *data, va_list ap)
static int	ncurses_binding_adddelete_query (void *data, va_list ap)
static int	ncurses_lastlog_changed (void *data, va_list ap)
static int	ncurses_ui_window_lastlog (void *data, va_list ap)
static int	ncurses_setvar_default (void *data, va_list ap)
static void	ncurses_display_transparent_changed (const char *var)
static void	ncurses_sigint_handler (int s)
static void	ncurses_typing_retimer (const char *dummy)
static int	ncurses_cmd_dump (const char *name, const char **params, session_t *session, const char *target, int quiet)
EXPORT int	ncurses_plugin_init (int prio)
static int	ncurses_plugin_destroy ()
Zmienne
int	config_aspell
char *	config_aspell_lang
int	config_backlog_size
int	config_display_transparent
int	config_enter_scrolls
int	config_header_size
int	config_margin_size
int	config_mark_on_window_change = 0
int	config_kill_irc_window = 1
int	config_statusbar_size
int	config_lastlog_size
int	config_lastlog_lock
int	config_text_bottomalign = 0
int	config_typing_interval = 1
int	config_typing_timeout = 10
int	config_typing_timeout_empty = 5
static int	config_traditional_clear = 1
int	ncurses_initialized
int	ncurses_plugin_destroyed
const char *	ncurses_settitle_formats [3] = { NULL, "\e]0;%s%s%s\a", "\e_%s%s%s\e\\" }
static int	ncurses_settitle = 0
volatile int	sigint_count = 0

---

Dokumentacja funkcji

static int dd_contacts

(

const char *

name

)

[static]

static int ncurses_all_contacts_changed	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_beep	(	void *	data,
		va_list	ap
	)			[static]

ncurses_beep()

Handler for: UI_BEEP
do curses beep()

Do zrobienia:

Check result of beep()

What about curses flash() ? :>

Zwraca:

-1 [We don't want to hear other beeps]

static int ncurses_binding_adddelete_query	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_binding_set_query	(	void *	data,
		va_list	ap
	)			[static]

static void ncurses_changed_aspell

(

const char *

var

)

[static]

static int ncurses_cmd_dump	(	const char *	name,
		const char **	params,
		session_t *	session,
		const char *	target,
		int	quiet
	)			[static]

static int ncurses_conference_renamed	(	void *	data,
		va_list	ap
	)			[static]

static void ncurses_display_transparent_changed

(

const char *

var

)

[static]

static int ncurses_lastlog_changed	(	void *	data,
		va_list	ap
	)			[static]

int ncurses_password_input	(	void *	data,
		va_list	ap
	)

static int ncurses_plugin_destroy

(

)

[static]

EXPORT int ncurses_plugin_init

(

int

prio

)

static int ncurses_postinit	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_setvar_default	(	void *	data,
		va_list	ap
	)			[static]

static void ncurses_sigint_handler

(

int

s

)

[static]

static int ncurses_statusbar_query	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_statusbar_timer	(	int	type,
		void *	data
	)			[static]

ncurses_statusbar_timer()

Timer, executed every second. It call update_statusbar(1)

Zobacz również:

update_statusbar()

Zwraca:

0 [permanent timer]

static int ncurses_theme_init

(

)

[static]

static void ncurses_typing_retimer

(

const char *

dummy

)

[static]

static int ncurses_ui_is_initialized	(	void *	data,
		va_list	ap
	)			[static]

ncurses_ui_is_initialized()

Handler for: UI_IS_INITIALIZED
Set tmp to ncurses_initialized [0/1]

Nota:

UI_IS_INITIALIZED is used to check if we can display debug info by emiting UI_PRINT_WINDOW or not. It also used by other UI-PLUGINS to check if another UI-plugin is in use. [Becasuse we have only one priv_data struct in window_t]

Parametry:

	ap	1st param: (int) tmp - place to put ncurses_initialized variable.
	data	NULL

Zwraca:

-1 If ncurses is initialized, else 0

static int ncurses_ui_refresh	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_act_changed	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_clear	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_kill	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_lastlog	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_new	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_print	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_refresh	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_switch	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_ui_window_target_changed	(	void *	data,
		va_list	ap
	)			[static]

static int ncurses_variable_changed	(	void *	data,
		va_list	ap
	)			[static]

PLUGIN_DEFINE	(	ncurses	,
		PLUGIN_UI	,
		ncurses_theme_init
	)

---

Dokumentacja zmiennych

int config_aspell

char* config_aspell_lang

int config_backlog_size

int config_display_transparent

int config_enter_scrolls

int config_header_size

int config_kill_irc_window = 1

int config_lastlog_lock

int config_lastlog_size

int config_margin_size

int config_mark_on_window_change = 0

int config_statusbar_size

int config_text_bottomalign = 0

int config_traditional_clear = 1 [static]

int config_typing_interval = 1

int config_typing_timeout = 10

int config_typing_timeout_empty = 5

int ncurses_initialized

int ncurses_plugin_destroyed

int ncurses_settitle = 0 [static]

const char* ncurses_settitle_formats[3] = { NULL, "\e]0;%s%s%s\a", "\e_%s%s%s\e\\" }

volatile int sigint_count = 0