view src/whiteboard.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 <[e-mail]>

/**
 * @file whiteboard.h The GaimWhiteboard core object
 *
 * 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_WHITEBOARD_H_
#define _GAIM_WHITEBOARD_H_

// DEFINES =============================================================================================

typedef struct _GaimWhiteboardPrplOps GaimWhiteboardPrplOps;	// NOTE A nasty compiler dependency fix

#include "account.h"

// INCLUDES ============================================================================================

// DATATYPES ===========================================================================================
typedef struct _GaimWhiteboard
{
	int			state;		// State of whiteboard session
	
	GaimAccount		*account;	// Account associated with this session
	char			*who;		// Name of the remote user
	
	void			*ui_data;	// Graphical user-interface data
	void			*proto_data;	// Protocol specific data
	GaimWhiteboardPrplOps	*prpl_ops;	// Protocol-plugin operations
	
	GList			*draw_list;	// List of drawing elements/deltas to send
} GaimWhiteboard;

typedef struct _GaimWhiteboardUiOps
{
	void ( *create )( GaimWhiteboard *wb );
	void ( *destroy )( GaimWhiteboard *wb );
	void ( *set_dimensions)( GaimWhiteboard *wb, int width, int height );
	void ( *draw_point )( GaimWhiteboard *wb, int x, int y, int color, int size );
	void ( *draw_line )( GaimWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size );
	void ( *clear )( GaimWhiteboard *wb );
} GaimWhiteboardUiOps;

struct _GaimWhiteboardPrplOps
{
	void ( *start )( GaimWhiteboard *wb );
	void ( *end )( GaimWhiteboard *wb );
	void ( *get_dimensions )( GaimWhiteboard *wb, int *width, int *height );
	void ( *set_dimensions )( GaimWhiteboard *wb, int width, int height );
	void ( *send_draw_list )( GaimWhiteboard *wb, GList *draw_list );
	void ( *clear )( GaimWhiteboard *wb );
};

// PROTOTYPES ==========================================================================================

void		gaim_whiteboard_set_ui_ops( GaimWhiteboardUiOps *ops );

GaimWhiteboard	*gaim_whiteboard_create( GaimAccount *account, char *who, int state );
void		gaim_whiteboard_destroy( GaimWhiteboard *wb );
void		gaim_whiteboard_start( GaimWhiteboard *wb );

GaimWhiteboard	*gaim_whiteboard_get_session( GaimAccount *account, char *who );

GList		*gaim_whiteboard_draw_list_destroy( GList *draw_list );

void		gaim_whiteboard_set_dimensions( GaimWhiteboard *wb, int width, int height );
void		gaim_whiteboard_draw_point( GaimWhiteboard *wb, int x, int y, int color, int size );
void		gaim_whiteboard_draw_line( GaimWhiteboard *wb, int x1, int y1, int x2, int y2, int color, int size );
void		gaim_whiteboard_clear( GaimWhiteboard *wb );

#endif // _GAIM_WHITEBOARD_H_