annotate libpurple/circbuffer.h @ 29228:ee1ed5d16235

Save the event source ID for search_find_cb so that it's removed when the log dialog is closed. This fixes a double free which might be caused by having a large logset (and maybe pressing Close multiple times). It looks something like this, with a few variations: == Invalid read of size 8 == at 0x483001: search_find_cb (gtklog.c:425) == by 0xBB91E50: g_main_context_dispatch (gmain.c:1824) == by 0xBB953E7: g_main_context_iterate (gmain.c:2455) == by 0xBB958BC: g_main_loop_run (gmain.c:2663) == by 0x63AF606: gtk_main (gtkmain.c:1205) == by 0x485ADF: main (gtkmain.c:978) == Address 0x1b469860 is 56 bytes inside a block of size 72 free'd == at 0x4C239EF: free (vg_replace_malloc.c:323) == by 0x483A6C: destroy_cb (gtklog.c:223) == by 0xAB9B12C: g_closure_invoke (gclosure.c:767) == by 0xABB02B1: signal_emit_unlocked_R (gsignal.c:3247) == by 0xABB1806: g_signal_emit_valist (gsignal.c:2980) == by 0xABB1CD2: g_signal_emit (gsignal.c:3037) == by 0xAB9B12C: g_closure_invoke (gclosure.c:767) == by 0xABB02B1: signal_emit_unlocked_R (gsignal.c:3247) == by 0xABB1806: g_signal_emit_valist (gsignal.c:2980) == by 0xABB1CD2: g_signal_emit (gsignal.c:3037) == by 0x630ECB4: gtk_real_button_released (gtkbutton.c:1707) == by 0xAB9B12C: g_closure_invoke (gclosure.c:767) == Fixes #11071.

/**
 * @file circbuffer.h Buffer Utility Functions
 * @ingroup core
 */

/* Purple 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., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _CIRCBUFFER_H
#define _CIRCBUFFER_H

#include <glib.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _PurpleCircBuffer {

	/** A pointer to the starting address of our chunk of memory. */
	gchar *buffer;

	/** The incremental amount to increase this buffer by when
	 *  the buffer is not big enough to hold incoming data, in bytes. */
	gsize growsize;

	/** The length of this buffer, in bytes. */
	gsize buflen;

	/** The number of bytes of this buffer that contain unread data. */
	gsize bufused;

	/** A pointer to the next byte where new incoming data is
	 *  buffered to. */
	gchar *inptr;

	/** A pointer to the next byte of buffered data that should be
	 *  read by the consumer. */
	gchar *outptr;

} PurpleCircBuffer;

/**
 * Creates a new circular buffer.  This will not allocate any memory for the
 * actual buffer until data is appended to it.
 *
 * @param growsize The amount that the buffer should grow the first time data
 *                 is appended and every time more space is needed.  Pass in
 *                 "0" to use the default of 256 bytes.
 *
 * @return The new PurpleCircBuffer. This should be freed with
 *         purple_circ_buffer_destroy when you are done with it
 */
PurpleCircBuffer *purple_circ_buffer_new(gsize growsize);

/**
 * Dispose of the PurpleCircBuffer and free any memory used by it (including any
 * memory used by the internal buffer).
 *
 * @param buf The PurpleCircBuffer to free
 */
void purple_circ_buffer_destroy(PurpleCircBuffer *buf);

/**
 * Append data to the PurpleCircBuffer.  This will grow the internal
 * buffer to fit the added data, if needed.
 *
 * @param buf The PurpleCircBuffer to which to append the data
 * @param src pointer to the data to copy into the buffer
 * @param len number of bytes to copy into the buffer
 */
void purple_circ_buffer_append(PurpleCircBuffer *buf, gconstpointer src, gsize len);

/**
 * Determine the maximum number of contiguous bytes that can be read from the
 * PurpleCircBuffer.
 * Note: This may not be the total number of bytes that are buffered - a
 * subsequent call after calling purple_circ_buffer_mark_read() may indicate more
 * data is available to read.
 *
 * @param buf the PurpleCircBuffer for which to determine the maximum contiguous
 *            bytes that can be read.
 *
 * @return the number of bytes that can be read from the PurpleCircBuffer
 */
gsize purple_circ_buffer_get_max_read(const PurpleCircBuffer *buf);

/**
 * Mark the number of bytes that have been read from the buffer.
 *
 * @param buf The PurpleCircBuffer to mark bytes read from
 * @param len The number of bytes to mark as read
 *
 * @return TRUE if we successfully marked the bytes as having been read, FALSE
 *         otherwise.
 */
gboolean purple_circ_buffer_mark_read(PurpleCircBuffer *buf, gsize len);

#ifdef __cplusplus
}
#endif

#endif /* _CIRCBUFFER_H */