annotate src/stringref.c @ 7786:203a18e56dc6

[gaim-migrate @ 8431] * Documentation is good. Not that I have any idea if any of my documentation works, because I haven't checked... I totally made up @note, but it sure seems reasonable to me. * A couple of stringref utility functions which seem useful in any case, like len and cmp. * I'm going ahead and pushing a stringref creation function which creates a zero-refcount stringref into CVS... Nothing uses it yet, but I think that it is useful even in the absence of major stringref conversion ... because it's garbage collected! If no one refs it before the next iteration of the mainloop, it will be freed ... if it is ref'd, of course, it will have to be freed normally by an unref at some later point. committer: Tailor Script <[e-mail]>

/**
 * @file stringref.c Reference-counted immutable strings
 * @ingroup core
 *
 * gaim
 *
 * Copyright (C) 2003 Ethan Blanton <[e-mail]>
 *
 * 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 "stringref.h"

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) + 1);
	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) + 1);
	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)
{
	g_return_if_fail(stringref != NULL);
	if ((--(stringref->ref) & 0x7fffffff) == 0) {
		if (stringref->ref & 0x80000000)
			gclist = g_list_remove(gclist, stringref);
		g_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 (stringref->ref != 0) {
		gaim_debug(GAIM_DEBUG_ERROR, "stringref", "Free of nonzero (%d) ref stringref!\n", 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;
		ref->ref &= 0x7fffffff;
		if (ref->ref == 0) {
			stringref_free(ref);
		}
		del = gclist;
		gclist = gclist->next;
		g_list_free_1(del);
	}

	return FALSE;
}