From 0f9bef055788c60cd4f6621a46b047abb86bc193 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Mon, 16 May 2011 16:42:35 -0600 Subject: Consolidate reference counting code. --- libdimension/dimension/refcount.h | 55 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 libdimension/dimension/refcount.h (limited to 'libdimension/dimension/refcount.h') diff --git a/libdimension/dimension/refcount.h b/libdimension/dimension/refcount.h new file mode 100644 index 0000000..14f31ab --- /dev/null +++ b/libdimension/dimension/refcount.h @@ -0,0 +1,55 @@ +/************************************************************************* + * Copyright (C) 2011 Tavian Barnes * + * * + * This file is part of The Dimension Library. * + * * + * The Dimension Library is free software; you can redistribute it and/ * + * or modify it under the terms of the GNU Lesser General Public License * + * as published by the Free Software Foundation; either version 3 of the * + * License, or (at your option) any later version. * + * * + * The Dimension Library 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this program. If not, see * + * . * + *************************************************************************/ + +/** + * @file + * Generic reference count implementation. + */ + +/** + * Increment a reference count. + * @param[in,out] object The reference-counted object to acquire. + */ +#define DMNSN_INCREF(obj) ((void)++(*(obj)->refcount)) + +/** + * Decrement a reference count. + * @param[in,out] object The reference-counted object to release. + * @return Whether the object is now garbage. + */ +#define DMNSN_DECREF(obj) (*(obj)->refcount == 0 || --(*(obj)->refcount) == 0) + +/** + * Reference counter. + */ +typedef unsigned int dmnsn_refcount; + +/** + * Create a reference count. + * @return A new reference counter, initialized to zero (a "borrowed" reference, + * which will be garbage-collected the first time it is deleted). + */ +dmnsn_refcount *dmnsn_new_refcount(void); + +/** + * Delete a reference count. Raises an error if the reference count wasn't + * zero. + */ +void dmnsn_delete_refcount(dmnsn_refcount *refcount); -- cgit v1.2.3