diff src/pounce.h @ 5032:cb700c07ee07

[gaim-migrate @ 5375] Rewrote the buddy pounce code. It's now core/UI split, and may allow for more advanced stuff later. Pounce actions are now a UI thing, and the backend logic for registering, unregistering, and activating pouncs is now in core. Also, the buddy pounce dialog was redesigned. Oh, and there are new pounce types. You can now choose from: * Sign on * Sign off * Away * Return from away * Idle * Return from idle * Buddy starts typing * Buddy stops typing Should work. I've been using it for some time. If you find a bug, though, let me know. committer: Tailor Script <[e-mail]>

--- a/src/pounce.h	Sat Apr 05 08:03:10 2003 +0000
+++ b/src/pounce.h	Sat Apr 05 10:14:21 2003 +0000
@@ -1,8 +1,10 @@
-/*
+/**
+ * @file pounce.h Buddy pounce API
+ *
  * gaim
  *
- * Copyright (C) 1998-2003, Mark Spencer <[e-mail]>
- *
+ * Copyright (C) 2003, Christian Hammond <[e-mail]>
+ * 
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
@@ -18,48 +20,184 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  *
  */
+#ifndef _GAIM_POUNCE_H_
+#define _GAIM_POUNCE_H_
 
-#ifndef _POUNCE_H_
-#define _POUNCE_H_
+/**
+ * Events that trigger buddy pounces.
+ */
+typedef enum
+{
+	GAIM_POUNCE_NONE           = 0x00, /**< No events.                    */
+	GAIM_POUNCE_SIGNON         = 0x01, /**< The buddy signed on.          */
+	GAIM_POUNCE_SIGNOFF        = 0x02, /**< The buddy signed off.         */
+	GAIM_POUNCE_AWAY           = 0x04, /**< The buddy went away.          */
+	GAIM_POUNCE_AWAY_RETURN    = 0x08, /**< The buddy returned from away. */
+	GAIM_POUNCE_IDLE           = 0x10, /**< The buddy became idle.        */
+	GAIM_POUNCE_IDLE_RETURN    = 0x20, /**< The buddy is no longer idle.  */
+	GAIM_POUNCE_TYPING         = 0x40, /**< The buddy started typing.     */
+	GAIM_POUNCE_TYPING_STOPPED = 0x80  /**< The buddy stopped typing.     */
+
+} GaimPounceEvent;
+
+struct gaim_pounce;
 
-struct buddy_pounce {
-        char name[80];
-        char message[2048];
-        char command[2048];
-        char sound[2048];
-        
-        char pouncer[80];
-        int protocol;
+/** A pounce callback. */
+typedef void (*gaim_pounce_cb)(struct gaim_pounce *, GaimPounceEvent, void *);
 
-        int options;
+/**
+ * A buddy pounce structure.
+ *
+ * Buddy pounces are actions triggered by a buddy-related event. For
+ * example, a sound can be played or an IM window opened when a buddy
+ * signs on or returns from away. Such responses are handled in the
+ * UI. The events themselves are done in the core.
+ */
+struct gaim_pounce
+{
+	GaimPounceEvent events;       /**< The event(s) to pounce on. */
+	struct gaim_account *pouncer; /**< The user who is pouncing.  */
+
+	char *pouncee;                /**< The buddy to pounce on.    */
+
+	gaim_pounce_cb callback;      /**< The callback function to call when the
+	                                   event is triggered. */
+	void (*free)(void *data);     /**< The data free function. */
+	void *data;                   /**< Pounce-specific data. */
 };
 
-struct addbp {
-	GtkWidget *window;
-	GtkWidget *nameentry;
-	GtkWidget *messentry;
-	GtkWidget *commentry;
-	GtkWidget *command;
-	GtkWidget *sendim;
-	GtkWidget *openwindow;
-	GtkWidget *popupnotify;
-	GtkWidget *p_signon;
-	GtkWidget *p_unaway;
-	GtkWidget *p_unidle;
-	GtkWidget *p_typing;
-	GtkWidget *save;
-	GtkWidget *menu;
-	GtkWidget *sound;
-	GtkWidget *soundentry;
+/**
+ * Creates a new buddy pounce.
+ *
+ * @param pouncer The account that will pounce.
+ * @param pouncee The buddy to pounce on.
+ * @param event   The event(s) to pounce on.
+ * @param cb      The callback function to call when the pounce is triggered.
+ * @param data    Pounce-specific data.
+ * @param free    The function to free the pounce-specific data.
+ *
+ * @return The new buddy pounce structure.
+ */
+struct gaim_pounce *gaim_pounce_new(struct gaim_account *pouncer,
+									const char *pouncee,
+									GaimPounceEvent event,
+									gaim_pounce_cb cb, void *data,
+									void (*free)(void *));
+
+/**
+ * Destroys a buddy pounce.
+ *
+ * @param pounce The buddy pounce.
+ */
+void gaim_pounce_destroy(struct gaim_pounce *pounce);
+
+/**
+ * Sets the events a pounce should watch for.
+ *
+ * @param pounce The buddy pounce.
+ * @param events The events to watch for.
+ */
+void gaim_pounce_set_events(struct gaim_pounce *pounce,
+							GaimPounceEvent events);
+
+/**
+ * Sets the account that will do the pouncing.
+ *
+ * @param pounce  The buddy pounce.
+ * @param pouncer The account that will pounce.
+ */
+void gaim_pounce_set_pouncer(struct gaim_pounce *pounce,
+							 struct gaim_account *pouncer);
+
+/**
+ * Sets the buddy a pounce should pounce on.
+ *
+ * @param pounce  The buddy pounce.
+ * @param pouncee The buddy to pounce on.
+ */
+void gaim_pounce_set_pouncee(struct gaim_pounce *pounce, const char *buddy);
+
+/**
+ * Sets the callback function to call when the pounce event is triggered.
+ *
+ * @param pounce The buddy pounce.
+ * @param cb     The callback function.
+ */
+void gaim_pounce_set_callback(struct gaim_pounce *pounce, gaim_pounce_cb cb);
+
+/**
+ * Sets the pounce-specific data.
+ *
+ * @param pounce The buddy pounce.
+ * @param data   Data specific to the pounce.
+ */
+void gaim_pounce_set_data(struct gaim_pounce *pounce, void *data);
 
-	struct gaim_account *account;
-	struct buddy_pounce *buddy_pounce;
-};
+/**
+ * Returns the events a pounce should watch for.
+ *
+ * @param pounce The buddy pounce.
+ *
+ * @return The events the pounce is watching for.
+ */
+GaimPounceEvent gaim_pounce_get_events(const struct gaim_pounce *pounce);
 
-void rem_bp(GtkWidget *w, struct buddy_pounce *b);
+/**
+ * Returns the account that will do the pouncing.
+ *
+ * @param pounce The buddy pounce.
+ *
+ * @return The account that will pounce.
+ */
+struct gaim_account *gaim_pounce_get_pouncer(const struct gaim_pounce *pounce);
+
+/**
+ * Returns the buddy a pounce should pounce on.
+ *
+ * @param pounce The buddy pounce.
+ *
+ * @return The buddy to pounce on.
+ */
+const char *gaim_pounce_get_pouncee(const struct gaim_pounce *pounce);
 
-void do_pounce(struct gaim_connection *gc, char *name, int when);
+/**
+ * Returns the pounce-specific data.
+ *
+ * @param pounce The buddy pounce.
+ *
+ * @return The data specific to a buddy pounce.
+ */
+void *gaim_pounce_get_data(const struct gaim_pounce *pounce);
+
+/**
+ * Executes a pounce with the specified pouncer, pouncee, and event type.
+ *
+ * @param pouncer The account that will do the pouncing.
+ * @param pouncee The buddy that is being pounced.
+ * @param events  The events that triggered the pounce.
+ */
+void gaim_pounce_execute(const struct gaim_account *pouncer,
+						 const char *pouncee,
+						 GaimPounceEvent events);
 
-void do_bp_menu();
+/**
+ * Finds a pounce with the specified event(s) and buddy.
+ *
+ * @param pouncer The account to match against.
+ * @param buddy   The buddy to match against.
+ * @param events  The event(s) to match against.
+ *
+ * @return The pounce if found, or @c NULL otherwise.
+ */
+struct gaim_pounce *gaim_find_pounce(const struct gaim_account *pouncer,
+									 const char *pouncee,
+									 GaimPounceEvent events);
 
-#endif /* _POUNCE_H_ */
+/**
+ * Returns a list of all registered buddy pounces.
+ *
+ * @return The list of buddy pounces.
+ */
+GList *gaim_get_pounces(void);
+
+#endif /* _GAIM_POUNCE_H_ */