path: root/src/common/hexchat-plugin.h

/* You can distribute this header with your plugins for easy compilation */
#ifndef HEXCHAT_PLUGIN_H
#define HEXCHAT_PLUGIN_H

#include <time.h>

#define XCHAT_IFACE_MAJOR	1
#define XCHAT_IFACE_MINOR	9
#define XCHAT_IFACE_MICRO	11
#define XCHAT_IFACE_VERSION	((XCHAT_IFACE_MAJOR * 10000) + \
				 (XCHAT_IFACE_MINOR * 100) + \
				 (XCHAT_IFACE_MICRO))

#define XCHAT_PRI_HIGHEST	127
#define XCHAT_PRI_HIGH		64
#define XCHAT_PRI_NORM		0
#define XCHAT_PRI_LOW		(-64)
#define XCHAT_PRI_LOWEST	(-128)

#define XCHAT_FD_READ		1
#define XCHAT_FD_WRITE		2
#define XCHAT_FD_EXCEPTION	4
#define XCHAT_FD_NOTSOCKET	8

#define XCHAT_EAT_NONE		0	/* pass it on through! */
#define XCHAT_EAT_XCHAT		1	/* don't let xchat see this event */
#define XCHAT_EAT_PLUGIN	2	/* don't let other plugins see this event */
#define XCHAT_EAT_ALL		(XCHAT_EAT_XCHAT|XCHAT_EAT_PLUGIN)	/* don't let anything see this event */

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _xchat_plugin xchat_plugin;
typedef struct _xchat_list xchat_list;
typedef struct _xchat_hook xchat_hook;
#ifndef PLUGIN_C
typedef struct _xchat_context xchat_context;
#endif

#ifndef PLUGIN_C
struct _xchat_plugin
{
	/* these are only used on win32 */
#ifdef XCHAT_PLUGIN_COMPAT
	xchat_hook *(*xchat_hook_command) (xchat_plugin *ph,
		    const char *name,
		    int pri,
		    int (*callback) (char *word[], char *word_eol[], void *user_data),
		    const char *help_text,
		    void *userdata);
	xchat_hook *(*xchat_hook_server) (xchat_plugin *ph,
		   const char *name,
		   int pri,
		   int (*callback) (char *word[], char *word_eol[], void *user_data),
		   void *userdata);
	xchat_hook *(*xchat_hook_print) (xchat_plugin *ph,
		  const char *name,
		  int pri,
		  int (*callback) (char *word[], void *user_data),
		  void *userdata);
	xchat_hook *(*xchat_hook_timer) (xchat_plugin *ph,
		  int timeout,
		  int (*callback) (void *user_data),
		  void *userdata);
	xchat_hook *(*xchat_hook_fd) (xchat_plugin *ph,
		   int fd,
		   int flags,
		   int (*callback) (int fd, int flags, void *user_data),
		   void *userdata);
	void *(*xchat_unhook) (xchat_plugin *ph,
	      xchat_hook *hook);
	void (*xchat_print) (xchat_plugin *ph,
	     const char *text);
	void (*xchat_printf) (xchat_plugin *ph,
	      const char *format, ...);
	void (*xchat_command) (xchat_plugin *ph,
	       const char *command);
	void (*xchat_commandf) (xchat_plugin *ph,
		const char *format, ...);
	int (*xchat_nickcmp) (xchat_plugin *ph,
	       const char *s1,
	       const char *s2);
	int (*xchat_set_context) (xchat_plugin *ph,
		   xchat_context *ctx);
	xchat_context *(*xchat_find_context) (xchat_plugin *ph,
		    const char *servname,
		    const char *channel);
	xchat_context *(*xchat_get_context) (xchat_plugin *ph);
	const char *(*xchat_get_info) (xchat_plugin *ph,
		const char *id);
	int (*xchat_get_prefs) (xchat_plugin *ph,
		 const char *name,
		 const char **string,
		 int *integer);
	xchat_list * (*xchat_list_get) (xchat_plugin *ph,
		const char *name);
	void (*xchat_list_free) (xchat_plugin *ph,
		 xchat_list *xlist);
	const char * const * (*xchat_list_fields) (xchat_plugin *ph,
		   const char *name);
	int (*xchat_list_next) (xchat_plugin *ph,
		 xchat_list *xlist);
	const char * (*xchat_list_str) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	int (*xchat_list_int) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	void * (*xchat_plugingui_add) (xchat_plugin *ph,
		     const char *filename,
		     const char *name,
		     const char *desc,
		     const char *version,
		     char *reserved);
	void (*xchat_plugingui_remove) (xchat_plugin *ph,
			void *handle);
	int (*xchat_emit_print) (xchat_plugin *ph,
			const char *event_name, ...);
	int (*xchat_read_fd) (xchat_plugin *ph,
			void *src,
			char *buf,
			int *len);
	time_t (*xchat_list_time) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	char *(*xchat_gettext) (xchat_plugin *ph,
		const char *msgid);
	void (*xchat_send_modes) (xchat_plugin *ph,
		  const char **targets,
		  int ntargets,
		  int modes_per_line,
		  char sign,
		  char mode);
	char *(*xchat_strip) (xchat_plugin *ph,
	     const char *str,
	     int len,
	     int flags);
	void (*xchat_free) (xchat_plugin *ph,
	    void *ptr);
#endif /* XCHAT_PLUGIN_COMPAT */
	xchat_hook *(*hexchat_hook_command) (xchat_plugin *ph,
		    const char *name,
		    int pri,
		    int (*callback) (char *word[], char *word_eol[], void *user_data),
		    const char *help_text,
		    void *userdata);
	xchat_hook *(*hexchat_hook_server) (xchat_plugin *ph,
		   const char *name,
		   int pri,
		   int (*callback) (char *word[], char *word_eol[], void *user_data),
		   void *userdata);
	xchat_hook *(*hexchat_hook_print) (xchat_plugin *ph,
		  const char *name,
		  int pri,
		  int (*callback) (char *word[], void *user_data),
		  void *userdata);
	xchat_hook *(*hexchat_hook_timer) (xchat_plugin *ph,
		  int timeout,
		  int (*callback) (void *user_data),
		  void *userdata);
	xchat_hook *(*hexchat_hook_fd) (xchat_plugin *ph,
		   int fd,
		   int flags,
		   int (*callback) (int fd, int flags, void *user_data),
		   void *userdata);
	void *(*hexchat_unhook) (xchat_plugin *ph,
	      xchat_hook *hook);
	void (*hexchat_print) (xchat_plugin *ph,
	     const char *text);
	void (*hexchat_printf) (xchat_plugin *ph,
	      const char *format, ...);
	void (*hexchat_command) (xchat_plugin *ph,
	       const char *command);
	void (*hexchat_commandf) (xchat_plugin *ph,
		const char *format, ...);
	int (*hexchat_nickcmp) (xchat_plugin *ph,
	       const char *s1,
	       const char *s2);
	int (*hexchat_set_context) (xchat_plugin *ph,
		   xchat_context *ctx);
	xchat_context *(*hexchat_find_context) (xchat_plugin *ph,
		    const char *servname,
		    const char *channel);
	xchat_context *(*hexchat_get_context) (xchat_plugin *ph);
	const char *(*hexchat_get_info) (xchat_plugin *ph,
		const char *id);
	int (*hexchat_get_prefs) (xchat_plugin *ph,
		 const char *name,
		 const char **string,
		 int *integer);
	xchat_list * (*hexchat_list_get) (xchat_plugin *ph,
		const char *name);
	void (*hexchat_list_free) (xchat_plugin *ph,
		 xchat_list *xlist);
	const char * const * (*hexchat_list_fields) (xchat_plugin *ph,
		   const char *name);
	int (*hexchat_list_next) (xchat_plugin *ph,
		 xchat_list *xlist);
	const char * (*hexchat_list_str) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	int (*hexchat_list_int) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	void * (*hexchat_plugingui_add) (xchat_plugin *ph,
		     const char *filename,
		     const char *name,
		     const char *desc,
		     const char *version,
		     char *reserved);
	void (*hexchat_plugingui_remove) (xchat_plugin *ph,
			void *handle);
	int (*hexchat_emit_print) (xchat_plugin *ph,
			const char *event_name, ...);
	int (*hexchat_read_fd) (xchat_plugin *ph,
			void *src,
			char *buf,
			int *len);
	time_t (*hexchat_list_time) (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);
	char *(*hexchat_gettext) (xchat_plugin *ph,
		const char *msgid);
	void (*hexchat_send_modes) (xchat_plugin *ph,
		  const char **targets,
		  int ntargets,
		  int modes_per_line,
		  char sign,
		  char mode);
	char *(*hexchat_strip) (xchat_plugin *ph,
	     const char *str,
	     int len,
	     int flags);
	void (*hexchat_free) (xchat_plugin *ph,
	    void *ptr);
	int (*hexchat_pluginpref_set_str) (xchat_plugin *ph,
		const char *var,
		const char *value);
	int (*hexchat_pluginpref_get_str) (xchat_plugin *ph,
		const char *var,
		char *dest);
	int (*hexchat_pluginpref_set_int) (xchat_plugin *ph,
		const char *var,
		int value);
	int (*hexchat_pluginpref_get_int) (xchat_plugin *ph,
		const char *var);
	int (*hexchat_pluginpref_delete) (xchat_plugin *ph,
		const char *var);
	int (*hexchat_pluginpref_list) (xchat_plugin *ph,
		char *dest);
};
#endif


#ifdef XCHAT_PLUGIN_COMPAT
xchat_hook *
xchat_hook_command (xchat_plugin *ph,
		    const char *name,
		    int pri,
		    int (*callback) (char *word[], char *word_eol[], void *user_data),
		    const char *help_text,
		    void *userdata);

xchat_hook *
xchat_hook_server (xchat_plugin *ph,
		   const char *name,
		   int pri,
		   int (*callback) (char *word[], char *word_eol[], void *user_data),
		   void *userdata);

xchat_hook *
xchat_hook_print (xchat_plugin *ph,
		  const char *name,
		  int pri,
		  int (*callback) (char *word[], void *user_data),
		  void *userdata);

xchat_hook *
xchat_hook_timer (xchat_plugin *ph,
		  int timeout,
		  int (*callback) (void *user_data),
		  void *userdata);

xchat_hook *
xchat_hook_fd (xchat_plugin *ph,
		int fd,
		int flags,
		int (*callback) (int fd, int flags, void *user_data),
		void *userdata);

void *
xchat_unhook (xchat_plugin *ph,
	      xchat_hook *hook);

void
xchat_print (xchat_plugin *ph,
	     const char *text);

void
xchat_printf (xchat_plugin *ph,
	      const char *format, ...);

void
xchat_command (xchat_plugin *ph,
	       const char *command);

void
xchat_commandf (xchat_plugin *ph,
		const char *format, ...);

int
xchat_nickcmp (xchat_plugin *ph,
	       const char *s1,
	       const char *s2);

int
xchat_set_context (xchat_plugin *ph,
		   xchat_context *ctx);

xchat_context *
xchat_find_context (xchat_plugin *ph,
		    const char *servname,
		    const char *channel);

xchat_context *
xchat_get_context (xchat_plugin *ph);

const char *
xchat_get_info (xchat_plugin *ph,
		const char *id);

int
xchat_get_prefs (xchat_plugin *ph,
		 const char *name,
		 const char **string,
		 int *integer);

xchat_list *
xchat_list_get (xchat_plugin *ph,
		const char *name);

void
xchat_list_free (xchat_plugin *ph,
		 xchat_list *xlist);

const char * const *
xchat_list_fields (xchat_plugin *ph,
		   const char *name);

int
xchat_list_next (xchat_plugin *ph,
		 xchat_list *xlist);

const char *
xchat_list_str (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);

int
xchat_list_int (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);

time_t
xchat_list_time (xchat_plugin *ph,
		 xchat_list *xlist,
		 const char *name);

void *
xchat_plugingui_add (xchat_plugin *ph,
		     const char *filename,
		     const char *name,
		     const char *desc,
		     const char *version,
		     char *reserved);

void
xchat_plugingui_remove (xchat_plugin *ph,
			void *handle);

int 
xchat_emit_print (xchat_plugin *ph,
		  const char *event_name, ...);

char *
xchat_gettext (xchat_plugin *ph,
	       const char *msgid);

void
xchat_send_modes (xchat_plugin *ph,
		  const char **targets,
		  int ntargets,
		  int modes_per_line,
		  char sign,
		  char mode);

char *
xchat_strip (xchat_plugin *ph,
	     const char *str,
	     int len,
	     int flags);

void
xchat_free (xchat_plugin *ph,
	    void *ptr);
#endif /* XCHAT_PLUGIN_COMPAT */

xchat_hook *
hexchat_hook_command (xchat_plugin *ph,
		    const char *name,
		    int pri,
		    int (*callback) (char *word[], char *word_eol[], void *user_data),
		    const char *help_text,
		    void *userdata);

xchat_hook *
hexchat_hook_server (xchat_plugin *ph,
		   const char *name,
		   int pri,
		   int (*callback) (char *word[], char *word_eol[], void *user_data),
		   void *userdata);

xchat_hook *
hexchat_hook_print (xchat_plugin *ph,
		  const char *name,
		  int pri,
		  int (*callback) (char *word[], void *user_data),
		  void *userdata);

xchat_hook *
hexchat_hook_timer (xchat_plugin *ph,
		  int timeout,
		  int (*callback) (void *user_data),
		  void *userdata);

xchat_hook *
hexchat_hook_fd (xchat_plugin *ph,
		int fd,
		int flags,
		int (*callback) (int fd, int flags, void *user_data),
		void *userdata);

void *
hexchat_unhook (xchat_plugin *ph,
	      xchat_hook *hook);

void
hexchat_print (xchat_plugin *ph,
	     const char *text);

void
hexchat_printf (xchat_plugin *ph,
	      const char *format, ...);

void
hexchat_command (xchat_plugin *ph,
	       const char *command);

void
hexchat_commandf (xchat_plugin *ph,
		const char *format, ...);

int
hexchat_nickcmp (xchat_plugin *ph,
	       const char *s1,
	       const char *s2);

int
hexchat_set_context (xchat_plugin *ph,
		   xchat_context *ctx);

xchat_context *
hexchat_find_context (xchat_plugin *ph,
		    const char *servname,
		    const char *channel);

xchat_context *
hexchat_get_context (xchat_plugin *ph);

const char *
hexchat_get_info (xchat_plugin *ph,
		const char *id);

int
hexchat_get_prefs (xchat_plugin *ph,
		 const char *name,
		 const char **string,
		 int *integer);

xchat_list *
hexchat_list_get (xchat_plugin *ph,
		const char *name);

void
hexchat_list_free (xchat_plugin *ph,
		 xchat_list *xlist);

const char * const *
hexchat_list_fields (xchat_plugin *ph,
		   const char *name);

int
hexchat_list_next (xchat_plugin *ph,
		 xchat_list *xlist);

const char *
hexchat_list_str (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);

int
hexchat_list_int (xchat_plugin *ph,
		xchat_list *xlist,
		const char *name);

time_t
hexchat_list_time (xchat_plugin *ph,
		 xchat_list *xlist,
		 const char *name);

void *
hexchat_plugingui_add (xchat_plugin *ph,
		     const char *filename,
		     const char *name,
		     const char *desc,
		     const char *version,
		     char *reserved);

void
hexchat_plugingui_remove (xchat_plugin *ph,
			void *handle);

int 
hexchat_emit_print (xchat_plugin *ph,
		  const char *event_name, ...);

char *
hexchat_gettext (xchat_plugin *ph,
	       const char *msgid);

void
hexchat_send_modes (xchat_plugin *ph,
		  const char **targets,
		  int ntargets,
		  int modes_per_line,
		  char sign,
		  char mode);

char *
hexchat_strip (xchat_plugin *ph,
	     const char *str,
	     int len,
	     int flags);

void
hexchat_free (xchat_plugin *ph,
	    void *ptr);

int
hexchat_pluginpref_set_str (xchat_plugin *ph,
		const char *var,
		const char *value);

int
hexchat_pluginpref_get_str (xchat_plugin *ph,
		const char *var,
		char *dest);

int
hexchat_pluginpref_set_int (xchat_plugin *ph,
		const char *var,
		int value);
int
hexchat_pluginpref_get_int (xchat_plugin *ph,
		const char *var);

int
hexchat_pluginpref_delete (xchat_plugin *ph,
		const char *var);

int
hexchat_pluginpref_list (xchat_plugin *ph,
		char *dest);

#if !defined(PLUGIN_C) && defined(WIN32)
#ifndef XCHAT_PLUGIN_HANDLE
#define XCHAT_PLUGIN_HANDLE (ph)
#endif
#ifdef XCHAT_PLUGIN_COMPAT
#define xchat_hook_command ((XCHAT_PLUGIN_HANDLE)->xchat_hook_command)
#define xchat_hook_server ((XCHAT_PLUGIN_HANDLE)->xchat_hook_server)
#define xchat_hook_print ((XCHAT_PLUGIN_HANDLE)->xchat_hook_print)
#define xchat_hook_timer ((XCHAT_PLUGIN_HANDLE)->xchat_hook_timer)
#define xchat_hook_fd ((XCHAT_PLUGIN_HANDLE)->xchat_hook_fd)
#define xchat_unhook ((XCHAT_PLUGIN_HANDLE)->xchat_unhook)
#define xchat_print ((XCHAT_PLUGIN_HANDLE)->xchat_print)
#define xchat_printf ((XCHAT_PLUGIN_HANDLE)->xchat_printf)
#define xchat_command ((XCHAT_PLUGIN_HANDLE)->xchat_command)
#define xchat_commandf ((XCHAT_PLUGIN_HANDLE)->xchat_commandf)
#define xchat_nickcmp ((XCHAT_PLUGIN_HANDLE)->xchat_nickcmp)
#define xchat_set_context ((XCHAT_PLUGIN_HANDLE)->xchat_set_context)
#define xchat_find_context ((XCHAT_PLUGIN_HANDLE)->xchat_find_context)
#define xchat_get_context ((XCHAT_PLUGIN_HANDLE)->xchat_get_context)
#define xchat_get_info ((XCHAT_PLUGIN_HANDLE)->xchat_get_info)
#define xchat_get_prefs ((XCHAT_PLUGIN_HANDLE)->xchat_get_prefs)
#define xchat_list_get ((XCHAT_PLUGIN_HANDLE)->xchat_list_get)
#define xchat_list_free ((XCHAT_PLUGIN_HANDLE)->xchat_list_free)
#define xchat_list_fields ((XCHAT_PLUGIN_HANDLE)->xchat_list_fields)
#define xchat_list_next ((XCHAT_PLUGIN_HANDLE)->xchat_list_next)
#define xchat_list_str ((XCHAT_PLUGIN_HANDLE)->xchat_list_str)
#define xchat_list_int ((XCHAT_PLUGIN_HANDLE)->xchat_list_int)
#define xchat_plugingui_add ((XCHAT_PLUGIN_HANDLE)->xchat_plugingui_add)
#define xchat_plugingui_remove ((XCHAT_PLUGIN_HANDLE)->xchat_plugingui_remove)
#define xchat_emit_print ((XCHAT_PLUGIN_HANDLE)->xchat_emit_print)
#define xchat_list_time ((XCHAT_PLUGIN_HANDLE)->xchat_list_time)
#define xchat_gettext ((XCHAT_PLUGIN_HANDLE)->xchat_gettext)
#define xchat_send_modes ((XCHAT_PLUGIN_HANDLE)->xchat_send_modes)
#define xchat_strip ((XCHAT_PLUGIN_HANDLE)->xchat_strip)
#define xchat_free ((XCHAT_PLUGIN_HANDLE)->xchat_free)
#endif /* XCHAT_PLUGIN_COMPAT */
#define hexchat_hook_command ((XCHAT_PLUGIN_HANDLE)->hexchat_hook_command)
#define hexchat_hook_server ((XCHAT_PLUGIN_HANDLE)->hexchat_hook_server)
#define hexchat_hook_print ((XCHAT_PLUGIN_HANDLE)->hexchat_hook_print)
#define hexchat_hook_timer ((XCHAT_PLUGIN_HANDLE)->hexchat_hook_timer)
#define hexchat_hook_fd ((XCHAT_PLUGIN_HANDLE)->hexchat_hook_fd)
#define hexchat_unhook ((XCHAT_PLUGIN_HANDLE)->hexchat_unhook)
#define hexchat_print ((XCHAT_PLUGIN_HANDLE)->hexchat_print)
#define hexchat_printf ((XCHAT_PLUGIN_HANDLE)->hexchat_printf)
#define hexchat_command ((XCHAT_PLUGIN_HANDLE)->hexchat_command)
#define hexchat_commandf ((XCHAT_PLUGIN_HANDLE)->hexchat_commandf)
#define hexchat_nickcmp ((XCHAT_PLUGIN_HANDLE)->hexchat_nickcmp)
#define hexchat_set_context ((XCHAT_PLUGIN_HANDLE)->hexchat_set_context)
#define hexchat_find_context ((XCHAT_PLUGIN_HANDLE)->hexchat_find_context)
#define hexchat_get_context ((XCHAT_PLUGIN_HANDLE)->hexchat_get_context)
#define hexchat_get_info ((XCHAT_PLUGIN_HANDLE)->hexchat_get_info)
#define hexchat_get_prefs ((XCHAT_PLUGIN_HANDLE)->hexchat_get_prefs)
#define hexchat_list_get ((XCHAT_PLUGIN_HANDLE)->hexchat_list_get)
#define hexchat_list_free ((XCHAT_PLUGIN_HANDLE)->hexchat_list_free)
#define hexchat_list_fields ((XCHAT_PLUGIN_HANDLE)->hexchat_list_fields)
#define hexchat_list_next ((XCHAT_PLUGIN_HANDLE)->hexchat_list_next)
#define hexchat_list_str ((XCHAT_PLUGIN_HANDLE)->hexchat_list_str)
#define hexchat_list_int ((XCHAT_PLUGIN_HANDLE)->hexchat_list_int)
#define hexchat_plugingui_add ((XCHAT_PLUGIN_HANDLE)->hexchat_plugingui_add)
#define hexchat_plugingui_remove ((XCHAT_PLUGIN_HANDLE)->hexchat_plugingui_remove)
#define hexchat_emit_print ((XCHAT_PLUGIN_HANDLE)->hexchat_emit_print)
#define hexchat_list_time ((XCHAT_PLUGIN_HANDLE)->hexchat_list_time)
#define hexchat_gettext ((XCHAT_PLUGIN_HANDLE)->hexchat_gettext)
#define hexchat_send_modes ((XCHAT_PLUGIN_HANDLE)->hexchat_send_modes)
#define hexchat_strip ((XCHAT_PLUGIN_HANDLE)->hexchat_strip)
#define hexchat_free ((XCHAT_PLUGIN_HANDLE)->hexchat_free)
#define hexchat_pluginpref_set_str ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_set_str)
#define hexchat_pluginpref_get_str ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_get_str)
#define hexchat_pluginpref_set_int ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_set_int)
#define hexchat_pluginpref_get_int ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_get_int)
#define hexchat_pluginpref_delete ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_delete)
#define hexchat_pluginpref_list ((XCHAT_PLUGIN_HANDLE)->hexchat_pluginpref_list)
#endif

#ifdef __cplusplus
}
#endif
#endif