view src/eventloop.h @ 10787:c932d96a7c69

[gaim-migrate @ 12428] " Autocorrect in gaim... um... sucks. The problem is that the correction only happens AFTER you send a message. This means that you don't actually know what message you are sending until it is sent. Horrible. My new patch works AS YOU TYPE with the following rules: * You must be typing, not pasting in text. If you paste in the and there is a rule to correct the to the, it won't be corrected. This is because it would be impossible to go back and check all the text. * Check whole words ONLY. Partial words don't count. * If the dictionary word has capital letters in it, match only words with that capitalization. (FPT -> FTP doesn't match ftp.) * If the dictionary word doesn't have capital letters, preserve the capitalization the user used. (The code assumes three possible capitalization schemes: ALLCAPS, lowercase, and Proper.) Unless the solution has capital letters. In that case, force the capitalization used in the solution. * A word may have quote characters in it and still be a word. * If the user immediately hits the backspace key after a correction, undo the correction." --xkan " This patch is based off xkahn's work available at: http://sf.net/support/tracker.php?aid=300235 Most of the changes are his. I just changed his formatting to match the rest of Gaim more closely. Also, I made a couple coding style changes. The two biggest changes I made were: 1) I added some hash stuff to load_config. This removes duplicates. 2) I imported my list of text replacement strings as the default list in addition to xkahn's list. My list consisted primarily of the autocorrect entries from my copy of OpenOffice.org Writer. There were a few things I've added by hand. (For those familiar with my comments in #gaim, this list does NOT include anything like a pwn -> own replacement. If people want to talk like that, I'm not going to stop them. This list should be useful to anyone.) I also fixed a memory leak in load_config. A GtkListStore stores its own copy of strings, so there is no need to g_strdup them when appending to the GtkListStore. When I get a chance, I need to make it give an error if you try to set a duplicate "You type" word in the preferences. Otherwise, this patch should take care of everything. I would recommend considering this patch over xkahn's because it's a direct superset of his patches. However, I want to be very clear that most of the changes in this patch are his and he deserves the credit for them. " --rlaager committer: Tailor Script <[e-mail]>

/**
 * @file eventloop.h Gaim Event Loop API
 * @ingroup core
 *
 * gaim
 *
 * Gaim is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * 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
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _GAIM_EVENTLOOP_H_
#define _GAIM_EVENTLOOP_H_

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * An input condition.
 */
typedef enum
{
	GAIM_INPUT_READ  = 1 << 0,  /**< A read condition.  */
	GAIM_INPUT_WRITE = 1 << 1   /**< A write condition. */

} GaimInputCondition;

typedef void (*GaimInputFunction)(gpointer, gint, GaimInputCondition);

typedef struct _GaimEventLoopUiOps GaimEventLoopUiOps;

struct _GaimEventLoopUiOps
{
	/**
	 * Creates a callback timer.
	 * @see g_timeout_add, gaim_timeout_add
	 **/
	guint (*timeout_add)(guint interval, GSourceFunc function, gpointer data);

	/**
	 * Removes a callback timer.
	 * @see gaim_timeout_remove, g_source_remove
	 */
	guint (*timeout_remove)(guint handle);

	/**
	 * Adds an input handler.
	 * @see gaim_input_add, g_io_add_watch_full
	 */
	guint (*input_add)(int fd, GaimInputCondition cond,
					   GaimInputFunction func, gpointer user_data);

	/**
	 * Removes an input handler.
	 * @see gaim_input_remove, g_source_remove
	 */
	guint (*input_remove)(guint handle);
};

/**************************************************************************/
/** @name Event Loop API                                                  */
/**************************************************************************/
/*@{*/
/**
 * Creates a callback timer.
 * The timer will repeat until the function returns @c FALSE. The
 * first call will be at the end of the first interval.
 * @param interval	The time between calls of the function, in
 *					milliseconds.
 * @param function	The function to call.
 * @param data		data to pass to @a function.
 * @return A handle to the timer which can be passed to 
 *         gaim_timeout_remove to remove the timer.
 */
guint gaim_timeout_add(guint interval, GSourceFunc function, gpointer data);

/**
 * Removes a timeout handler.
 *
 * @param handle The handle, as returned by gaim_timeout_add.
 *
 * @return Something.
 */
guint gaim_timeout_remove(guint handle);

/**
 * Adds an input handler.
 *
 * @param fd        The input file descriptor.
 * @param cond      The condition type.
 * @param func      The callback function for data.
 * @param user_data User-specified data.
 *
 * @return The resulting handle.
 * @see g_io_add_watch_full
 */
guint gaim_input_add(int fd, GaimInputCondition cond,
					 GaimInputFunction func, gpointer user_data);

/**
 * Removes an input handler.
 *
 * @param handle The handle of the input handler. Note that this is the return
 * value from gaim_input_add, <i>not</i> the file descriptor.
 */
guint gaim_input_remove(guint handle);

/*@}*/


/**************************************************************************/
/** @name UI Registration Functions                                       */
/**************************************************************************/
/*@{*/
/**
 * Sets the UI operations structure to be used for accounts.
 *
 * @param ops The UI operations structure.
 */
void gaim_eventloop_set_ui_ops(GaimEventLoopUiOps *ops);

/**
 * Returns the UI operations structure used for accounts.
 *
 * @return The UI operations structure in use.
 */
GaimEventLoopUiOps *gaim_eventloop_get_ui_ops(void);

/*@}*/

#ifdef __cplusplus
}
#endif

#endif /* _GAIM_EVENTLOOP_H_ */