Mercurial > pidgin.yaz
view src/prefs.h @ 11719:109ee3bfeac5
[gaim-migrate @ 14010]
SF Patch #1333770 from corfe83
"Many times in gaim we use the function
g_slist_remove(list,node->data) to remove an element
from a GSList. If we already have the pointer to the
node we want to delete, it is faster to send it the
pointer to the node to delete rather than the data of
the node (we can do this by calling
g_slist_delete_link(list,node)). This change was made
while looking at glib's documentation and the code in
glib's gslist.c.
This is because as the remove/delete function traverses
each node in the list, it doesn't need to spend an
extra memory access to retrieve the data for each
element in the node it is traversing and then compare,
it can simply compare the pointer. In my tests outside
of gaim, this makes a big difference if the node you
are deleting is at a high index in the list. However,
even if you're deleting the first node, it about breaks
even.
So, I've found each case in gaim where we are calling
g_slist_remove, and we already have the pointer to the
appropriate node to delete (this is often the case when
we're doing a for or while loop on a GSList). I've then
replaced it with the appropriate call to
g_slist_delete_link. I, however, didn't do this in
situations where we are explicitly removing the first
element in the list, because in those situations it is
an unnecessary change.
There should be no difference in behavior, but just in
case I've tried running it with valgrind, which reports
the same number of memory leaks after my patch as
before my patch. Of course, I can't guarantee that my
normal behavior on gaim is hitting all the functions
I've changed, but in general testing it Works For Me (tm)."
As with the last patch, this one may not have a practical performance impact (or maybe it does, I have no idea), but it's not worse for any case. Given two ways of doing things where one is always at least as fast and may be faster under some cases, I like to prefer that faster way. This doesn't make the code any uglier, so I'm applying.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sat, 22 Oct 2005 20:48:18 +0000 |
parents | b6ca0e1b19d0 |
children | fc464a0abccc |
line wrap: on
line source
/** * @file prefs.h Prefs 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_PREFS_H_ #define _GAIM_PREFS_H_ #include <glib.h> /** * Pref data types. */ typedef enum _GaimPrefType { GAIM_PREF_NONE, GAIM_PREF_BOOLEAN, GAIM_PREF_INT, GAIM_PREF_STRING, GAIM_PREF_STRING_LIST } GaimPrefType; /** * Pref change callback type */ typedef void (*GaimPrefCallback) (const char *name, GaimPrefType type, gpointer val, gpointer data); #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Prefs API */ /**************************************************************************/ /*@{*/ /** * Returns the prefs subsystem handle. * * @return The prefs subsystem handle. */ void *gaim_prefs_get_handle(void); /** * Initialize core prefs */ void gaim_prefs_init(); /** * Uninitializes the prefs subsystem. */ void gaim_prefs_uninit(void); /** * Add a new typeless pref. * * @param name The name of the pref */ void gaim_prefs_add_none(const char *name); /** * Add a new boolean pref. * * @param name The name of the pref * @param value The initial value to set */ void gaim_prefs_add_bool(const char *name, gboolean value); /** * Add a new integer pref. * * @param name The name of the pref * @param value The initial value to set */ void gaim_prefs_add_int(const char *name, int value); /** * Add a new string pref. * * @param name The name of the pref * @param value The initial value to set */ void gaim_prefs_add_string(const char *name, const char *value); /** * Add a new string list pref. * * @param name The name of the pref * @param value The initial value to set */ void gaim_prefs_add_string_list(const char *name, GList *value); /** * Remove a pref. * * @param name The name of the pref */ void gaim_prefs_remove(const char *name); /** * Rename a pref * * @param oldname The old name of the pref * @param newname The new name for the pref */ void gaim_prefs_rename(const char *oldname, const char *newname); /** * Rename a boolean pref, toggling it's value * * @param oldname The old name of the pref * @param newname The new name for the pref */ void gaim_prefs_rename_boolean_toggle(const char *oldname, const char *newname); /** * Remove all prefs. */ void gaim_prefs_destroy(); /** * Set raw pref value * * @param name The name of the pref * @param value The value to set */ void gaim_prefs_set_generic(const char *name, gpointer value); /** * Set boolean pref value * * @param name The name of the pref * @param value The value to set */ void gaim_prefs_set_bool(const char *name, gboolean value); /** * Set integer pref value * * @param name The name of the pref * @param value The value to set */ void gaim_prefs_set_int(const char *name, int value); /** * Set string pref value * * @param name The name of the pref * @param value The value to set */ void gaim_prefs_set_string(const char *name, const char *value); /** * Set string pref value * * @param name The name of the pref * @param value The value to set */ void gaim_prefs_set_string_list(const char *name, GList *value); /** * Check if a pref exists * * @param name The name of the pref * @return TRUE if the pref exists. Otherwise FALSE. */ gboolean gaim_prefs_exists(const char *name); /** * Get pref type * * @param name The name of the pref * @return The type of the pref */ GaimPrefType gaim_prefs_get_type(const char *name); /** * Get boolean pref value * * @param name The name of the pref * @return The value of the pref */ gboolean gaim_prefs_get_bool(const char *name); /** * Get integer pref value * * @param name The name of the pref * @return The value of the pref */ int gaim_prefs_get_int(const char *name); /** * Get string pref value * * @param name The name of the pref * @return The value of the pref */ const char *gaim_prefs_get_string(const char *name); /** * Get string list pref value * * @param name The name of the pref * @return The value of the pref */ GList *gaim_prefs_get_string_list(const char *name); /** * Add a callback to a pref (and its children) */ guint gaim_prefs_connect_callback(void *handle, const char *name, GaimPrefCallback cb, gpointer data); /** * Remove a callback to a pref */ void gaim_prefs_disconnect_callback(guint callback_id); /** * Remove all pref callbacks by handle */ void gaim_prefs_disconnect_by_handle(void *handle); /** * Trigger callbacks as if the pref changed */ void gaim_prefs_trigger_callback(const char *name); /** * Read preferences */ gboolean gaim_prefs_load(); /** * Rename legacy prefs and delete some that no longer exist. */ void gaim_prefs_update_old(); /*@}*/ #ifdef __cplusplus } #endif #endif /* _GAIM_PREFS_H_ */