diff libpurple/stringref.c @ 15374:5fe8042783c1

Rename gtk/ and libgaim/ to pidgin/ and libpurple/
author Sean Egan <seanegan@gmail.com>
date Sat, 20 Jan 2007 02:32:10 +0000
parents
children 32c366eeeb99
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/stringref.c	Sat Jan 20 02:32:10 2007 +0000
@@ -0,0 +1,173 @@
+/**
+ * @file stringref.c Reference-counted immutable strings
+ * @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
+ *
+ */
+
+#include "internal.h"
+
+#include <string.h>
+#include <stdarg.h>
+
+#include "debug.h"
+#include "stringref.h"
+
+/**
+ * The internal representation of a stringref.
+ *
+ * @note For this structure to be useful, the string contained within
+ * it must be immutable -- for this reason, do _not_ access it
+ * directly!
+ */
+struct _GaimStringref {
+	guint32 ref;	/**< The reference count of this string.
+					 *   Note that reference counts are only
+					 *   31 bits, and the high-order bit
+					 *   indicates whether this string is up
+					 *   for GC at the next idle handler...
+					 *   But you aren't going to touch this
+					 *   anyway, right? */
+	char value[1];	/**< The string contained in this ref.
+					 *   Notice that it is simply "hanging
+					 *   off the end" of the ref ... this
+					 *   is to save an allocation. */
+};
+
+#define REFCOUNT(x) ((x) & 0x7fffffff)
+
+static GList *gclist = NULL;
+
+static void stringref_free(GaimStringref *stringref);
+static gboolean gs_idle_cb(gpointer data);
+
+GaimStringref *gaim_stringref_new(const char *value)
+{
+	GaimStringref *newref;
+
+	if (value == NULL)
+		return NULL;
+
+	newref = g_malloc(sizeof(GaimStringref) + strlen(value));
+	strcpy(newref->value, value);
+	newref->ref = 1;
+
+	return newref;
+}
+
+GaimStringref *gaim_stringref_new_noref(const char *value)
+{
+	GaimStringref *newref;
+
+	if (value == NULL)
+		return NULL;
+
+	newref = g_malloc(sizeof(GaimStringref) + strlen(value));
+	strcpy(newref->value, value);
+	newref->ref = 0x80000000;
+
+	if (gclist == NULL)
+		g_idle_add(gs_idle_cb, NULL);
+	gclist = g_list_prepend(gclist, newref);
+
+	return newref;
+}
+
+GaimStringref *gaim_stringref_printf(const char *format, ...)
+{
+	GaimStringref *newref;
+	va_list ap;
+
+	if (format == NULL)
+		return NULL;
+
+	va_start(ap, format);
+	newref = g_malloc(sizeof(GaimStringref) + g_printf_string_upper_bound(format, ap));
+	vsprintf(newref->value, format, ap);
+	va_end(ap);
+	newref->ref = 1;
+
+	return newref;
+}
+
+GaimStringref *gaim_stringref_ref(GaimStringref *stringref)
+{
+	if (stringref == NULL)
+		return NULL;
+	stringref->ref++;
+	return stringref;
+}
+
+void gaim_stringref_unref(GaimStringref *stringref)
+{
+	if (stringref == NULL)
+		return;
+	if (REFCOUNT(--(stringref->ref)) == 0) {
+		if (stringref->ref & 0x80000000)
+			gclist = g_list_remove(gclist, stringref);
+		stringref_free(stringref);
+	}
+}
+
+const char *gaim_stringref_value(const GaimStringref *stringref)
+{
+	return (stringref == NULL ? NULL : stringref->value);
+}
+
+int gaim_stringref_cmp(const GaimStringref *s1, const GaimStringref *s2)
+{
+	return (s1 == s2 ? 0 : strcmp(gaim_stringref_value(s1), gaim_stringref_value(s2)));
+}
+
+size_t gaim_stringref_len(const GaimStringref *stringref)
+{
+	return strlen(gaim_stringref_value(stringref));
+}
+
+static void stringref_free(GaimStringref *stringref)
+{
+#ifdef DEBUG
+	if (REFCOUNT(stringref->ref) != 0) {
+		gaim_debug(GAIM_DEBUG_ERROR, "stringref", "Free of nonzero (%d) ref stringref!\n", REFCOUNT(stringref->ref));
+		return;
+	}
+#endif /* DEBUG */
+	g_free(stringref);
+}
+
+static gboolean gs_idle_cb(gpointer data)
+{
+	GaimStringref *ref;
+	GList *del;
+
+	while (gclist != NULL) {
+		ref = gclist->data;
+		if (REFCOUNT(ref->ref) == 0) {
+			stringref_free(ref);
+		}
+		del = gclist;
+		gclist = gclist->next;
+		g_list_free_1(del);
+	}
+
+	return FALSE;
+}