0f5f4e8645
We've had complaints that our Cogl code/headers are a bit "special" so
this is a first pass at tidying things up by giving them some
consistency. These changes are all consistent with how new code in Cogl
is being written, but the style isn't consistently applied across all
code yet.
There are two parts to this patch; but since each one required a large
amount of effort to maintain tidy indenting it made sense to combine the
changes to reduce the time spent re indenting the same lines.
The first change is to use a consistent style for declaring function
prototypes in headers. Cogl headers now consistently use this style for
prototypes:
return_type
cogl_function_name (CoglType arg0,
CoglType arg1);
Not everyone likes this style, but it seems that most of the currently
active Cogl developers agree on it.
The second change is to constrain the use of redundant glib data types
in Cogl. Uses of gint, guint, gfloat, glong, gulong and gchar have all
been replaced with int, unsigned int, float, long, unsigned long and char
respectively. When talking about pixel data; use of guchar has been
replaced with guint8, otherwise unsigned char can be used.
The glib types that we continue to use for portability are gboolean,
gint{8,16,32,64}, guint{8,16,32,64} and gsize.
The general intention is that Cogl should look palatable to the widest
range of C programmers including those outside the Gnome community so
- especially for the public API - we want to minimize the number of
foreign looking typedefs.
158 lines
6.1 KiB
C
158 lines
6.1 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* An object oriented GL/GLES Abstraction/Utility Layer
|
|
*
|
|
* Copyright (C) 2008,2009 Intel Corporation.
|
|
*
|
|
* This 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 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This 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 library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __COGL_HANDLE_H
|
|
#define __COGL_HANDLE_H
|
|
|
|
typedef struct _CoglHandleClass
|
|
{
|
|
GQuark type;
|
|
void *virt_free;
|
|
} CoglHandleClass;
|
|
|
|
/* All Cogl objects inherit from this base object by adding a member:
|
|
*
|
|
* CoglHandleObject _parent;
|
|
*
|
|
* at the top of its main structure. This structure is initialized
|
|
* when you call _cogl_#type_name#_handle_new (new_object);
|
|
*/
|
|
typedef struct _CoglHandleObject
|
|
{
|
|
unsigned int ref_count;
|
|
CoglHandleClass *klass;
|
|
} CoglHandleObject;
|
|
|
|
/* Helper macro to encapsulate the common code for COGL reference
|
|
counted handles */
|
|
|
|
#ifdef COGL_HANDLE_DEBUG
|
|
|
|
#define _COGL_HANDLE_DEBUG_NEW(type_name, obj) \
|
|
COGL_NOTE (HANDLE, "COGL " G_STRINGIFY (type_name) " NEW %p %i", \
|
|
(obj), (obj)->ref_count)
|
|
|
|
#define _COGL_HANDLE_DEBUG_REF(type_name, handle) G_STMT_START { \
|
|
CoglHandleObject *__obj = (CoglHandleObject *)handle; \
|
|
COGL_NOTE (HANDLE, "COGL %s REF %p %i", \
|
|
g_quark_to_string ((__obj)->klass->type), \
|
|
(__obj), (__obj)->ref_count); } G_STMT_END
|
|
|
|
#define _COGL_HANDLE_DEBUG_UNREF(type_name, handle) G_STMT_START { \
|
|
CoglHandleObject *__obj = (CoglHandleObject *)handle; \
|
|
COGL_NOTE (HANDLE, "COGL %s UNREF %p %i", \
|
|
g_quark_to_string ((__obj)->klass->type), \
|
|
(__obj), (__obj)->ref_count - 1); } G_STMT_END
|
|
|
|
#define COGL_HANDLE_DEBUG_FREE(obj) \
|
|
COGL_NOTE (HANDLE, "COGL %s FREE %p", \
|
|
g_quark_to_string ((obj)->klass->type), (obj))
|
|
|
|
#else /* !COGL_HANDLE_DEBUG */
|
|
|
|
#define _COGL_HANDLE_DEBUG_NEW(type_name, obj)
|
|
#define _COGL_HANDLE_DEBUG_REF(type_name, obj)
|
|
#define _COGL_HANDLE_DEBUG_UNREF(type_name, obj)
|
|
#define COGL_HANDLE_DEBUG_FREE(obj)
|
|
|
|
#endif /* COGL_HANDLE_DEBUG */
|
|
|
|
#define COGL_HANDLE_DEFINE(TypeName, type_name) \
|
|
\
|
|
static CoglHandleClass _cogl_##type_name##_class; \
|
|
\
|
|
GQuark \
|
|
_cogl_handle_##type_name##_get_type (void) \
|
|
{ \
|
|
static GQuark type = 0; \
|
|
if (!type) \
|
|
type = g_quark_from_static_string ("Cogl"#TypeName); \
|
|
return type; \
|
|
} \
|
|
\
|
|
static CoglHandle \
|
|
_cogl_##type_name##_handle_new (Cogl##TypeName *new_obj) \
|
|
{ \
|
|
CoglHandleObject *obj = (CoglHandleObject *)&new_obj->_parent;\
|
|
obj->ref_count = 1; \
|
|
\
|
|
obj->klass = &_cogl_##type_name##_class; \
|
|
if (!obj->klass->type) \
|
|
{ \
|
|
obj->klass->type = _cogl_handle_##type_name##_get_type ();\
|
|
obj->klass->virt_free = _cogl_##type_name##_free; \
|
|
} \
|
|
\
|
|
_COGL_HANDLE_DEBUG_NEW (TypeName, obj); \
|
|
return (CoglHandle) new_obj; \
|
|
} \
|
|
\
|
|
Cogl##TypeName * \
|
|
_cogl_##type_name##_pointer_from_handle (CoglHandle handle) \
|
|
{ \
|
|
return (Cogl##TypeName *) handle; \
|
|
} \
|
|
\
|
|
gboolean \
|
|
cogl_is_##type_name (CoglHandle handle) \
|
|
{ \
|
|
CoglHandleObject *obj = (CoglHandleObject *)handle; \
|
|
\
|
|
if (handle == COGL_INVALID_HANDLE) \
|
|
return FALSE; \
|
|
\
|
|
return (obj->klass->type == \
|
|
_cogl_handle_##type_name##_get_type ()); \
|
|
} \
|
|
\
|
|
CoglHandle G_GNUC_DEPRECATED \
|
|
cogl_##type_name##_ref (CoglHandle handle) \
|
|
{ \
|
|
if (!cogl_is_##type_name (handle)) \
|
|
return COGL_INVALID_HANDLE; \
|
|
\
|
|
_COGL_HANDLE_DEBUG_REF (TypeName, handle); \
|
|
\
|
|
cogl_handle_ref (handle); \
|
|
\
|
|
return handle; \
|
|
} \
|
|
\
|
|
void G_GNUC_DEPRECATED \
|
|
cogl_##type_name##_unref (CoglHandle handle) \
|
|
{ \
|
|
if (!cogl_is_##type_name (handle)) \
|
|
{ \
|
|
g_warning (G_STRINGIFY (cogl_##type_name##_unref) \
|
|
": Ignoring unref of Cogl handle " \
|
|
"due to type mismatch"); \
|
|
return; \
|
|
} \
|
|
\
|
|
_COGL_HANDLE_DEBUG_UNREF (TypeName, handle); \
|
|
\
|
|
cogl_handle_unref (handle); \
|
|
}
|
|
|
|
#endif /* __COGL_HANDLE_H */
|