Mercurial > pidgin.yaz
view src/gtkblist.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 | cae2fb7e8594 |
children | 03c813a42c76 |
line wrap: on
line source
/** * @file gtkblist.h GTK+ Buddy List API * @ingroup gtkui * * 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_GTKBLIST_H_ #define _GAIM_GTKBLIST_H_ typedef struct _GaimGtkBuddyList GaimGtkBuddyList; enum { STATUS_ICON_COLUMN, STATUS_ICON_VISIBLE_COLUMN, NAME_COLUMN, IDLE_COLUMN, BUDDY_ICON_COLUMN, NODE_COLUMN, BLIST_COLUMNS }; typedef enum { GAIM_STATUS_ICON_LARGE, GAIM_STATUS_ICON_SMALL } GaimStatusIconSize; #include "gtkgaim.h" #include "blist.h" /************************************************************************** * @name Structures **************************************************************************/ /** * Like, everything you need to know about the gtk buddy list */ struct _GaimGtkBuddyList { GtkWidget *window; GtkWidget *vbox; /**< This is the vbox that everything gets packed into. Your plugin might want to pack something in it itself. Go, plugins! */ GtkWidget *treeview; /**< It's a treeview... d'uh. */ GtkTreeStore *treemodel; /**< This is the treemodel. */ GtkTreeViewColumn *idle_column, *warning_column, *buddy_icon_column, *text_column; GtkCellRenderer *text_rend; GtkItemFactory *ift; GtkWidget *bpmenu; /**< The buddy pounce menu. */ guint refresh_timer; /**< The timer for refreshing every 30 seconds */ guint timeout; /**< The timeout for the tooltip. */ guint drag_timeout; /**< The timeout for expanding contacts on drags */ GdkRectangle tip_rect; /**< This is the bounding rectangle of the cell we're currently hovering over. This is used for tooltips. */ GdkRectangle contact_rect; /**< This is the bounding rectangle of the contact node and its children. This is used for auto-expand on mouseover. */ GaimBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */ GtkWidget *tipwindow; /**< The window used by the tooltip */ char *tooltiptext; /**< The text displayed in tipwindow */ GaimBlistNode *selected_node; /**< The currently selected node */ GtkWidget *statusbox; /**< The status selector dropdown */ GdkPixbuf *east, *south; /**< Drop shadow stuff */ GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ }; #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) #define GAIM_IS_GTK_BLIST(list) \ ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) /************************************************************************** * @name GTK+ Buddy List API **************************************************************************/ /** * Get the handle for the GTK+ blist system. * * @return the handle to the blist system */ void *gaim_gtk_blist_get_handle(); /** * Initializes the GTK+ blist system. */ void gaim_gtk_blist_init(void); /** * Uninitializes the GTK+ blist system. */ void gaim_gtk_blist_uninit(void); /** * Returns the UI operations structure for the buddy list. * * @return The GTK+ list operations structure. */ GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); /** * Returns the default gtk buddy list * * There's normally only one buddy list window, but that isn't a necessity. This function * returns the GaimGtkBuddyList we're most likely wanting to work with. This is slightly * cleaner than an externed global. * * @return The default GTK+ buddy list */ GaimGtkBuddyList *gaim_gtk_blist_get_default_gtk_blist(); /** * Returns the base image to represent the account, based on the currently selected theme * * @param account The account. * * @return The icon */ GdkPixbuf *gaim_gtk_create_prpl_icon(GaimAccount *account); /** * Populates a menu with the items shown on the buddy list for a buddy. * * @param menu The menu to populate * @param buddy The buddy who's menu to get * @param sub TRUE if this is a sub-menu, FALSE otherwise */ void gaim_gtk_blist_make_buddy_menu(GtkWidget *menu, GaimBuddy *buddy, gboolean sub); /** * Refreshes all the nodes of the buddy list. * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) * * @param list This is the core list that gets updated from */ void gaim_gtk_blist_refresh(GaimBuddyList *list); /** * Tells the buddy list to update its toolbar based on the preferences * */ void gaim_gtk_blist_update_toolbar(); void gaim_gtk_blist_update_columns(); void gaim_gtk_blist_update_refresh_timeout(); /** * Useful for the buddy ticker */ GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, GaimStatusIconSize size); /** * Returns a boolean indicating if @a node is part of an expanded contact. * * This only makes sense for contact and buddy nodes. @c FALSE is returned * for other types of nodes. * * @param node The node in question. * @return A boolean indicating if @a node is part of an expanded contact. */ gboolean gaim_gtk_blist_node_is_contact_expanded(GaimBlistNode *node); /************************************************************************** * @name GTK+ Buddy List sorting functions **************************************************************************/ typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur); extern GSList *gaim_gtk_blist_sort_methods; struct gaim_gtk_blist_sort_method { char *id; char *name; gaim_gtk_blist_sort_function func; }; /** * Registers a buddy list sorting method. * * @param id The unique ID of the sorting method * @param name The method's name. * @param func A pointer to the function. * */ void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); /** * Unregisters a buddy list sorting method. * * @param id The method's id */ void gaim_gtk_blist_sort_method_unreg(const char *id); /** * Sets a buddy list sorting method. * * @param id The method's id. */ void gaim_gtk_blist_sort_method_set(const char *id); /** * Sets up the programs default sort methods */ void gaim_gtk_blist_setup_sort_methods(); /** * Updates the protocol actions menu on the GTK+ buddy list window. */ void gaim_gtk_blist_update_protocol_actions(); /** * Updates the plugin actions menu on the GTK+ buddy list window. */ void gaim_gtk_blist_update_plugin_actions(); /** * Determines if showing the join chat dialog is a valid action. * * @return Returns TRUE if there are accounts online capable of * joining chat rooms. Otherwise returns FALSE. */ gboolean gaim_gtk_blist_joinchat_is_showable(void); /** * Shows the join chat dialog. */ void gaim_gtk_blist_joinchat_show(void); /** * Appends the protocol specific menu items for a GaimBlistNode */ void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node); /** * Appends the extended menu items for a GaimBlistNode */ void gaim_gtk_append_blist_node_extended_menu(GtkWidget *menu, GaimBlistNode *node); #endif /* _GAIM_GTKBLIST_H_ */