summaryrefslogtreecommitdiff
path: root/gobject/gobject.h
diff options
context:
space:
mode:
authorTim Janik <timj@gtk.org>2000-12-12 07:32:00 +0000
committerTim Janik <timj@src.gnome.org>2000-12-12 07:32:00 +0000
commite773d7dba66cf51c7d6ad7d1973ab3635e986e2e (patch)
tree3f33265caa708a76577fb14996b2b304c64cf94a /gobject/gobject.h
parentcbd74878d1ff8d218e9854fe5b42bfdad3397aca (diff)
downloadglib-e773d7dba66cf51c7d6ad7d1973ab3635e986e2e.tar.gz
fixed dealing with collection/lcopy of NULL values.
Mon Dec 11 04:44:11 2000 Tim Janik <timj@gtk.org> * gboxed.c: fixed dealing with collection/lcopy of NULL values. * gclosure.h: removed insane ramblings, added G_CALLBACK() a casting convenience macro. * Makefile.am: cleanups, marshaller generation rules. * gmarshal.[hc]: new files with GRuntime standard marshallers. * glib-genmarshal.c: fix log domain, support gruntime standard marshallers, suport G_TYPE_PARAM, come with extern "C" and #include gmarshal.h. * glib-genmarshal.1: reflect glib-genmarshal.c updates. * gobject.[hc]: implement object constructor. rework parameter changed notification queueing, we support queue freezes now and don't dispatch from an idle handler anymore. parameter->property rename hassle. implemented ::properties_changed and ::notify::* signals for property change notification (the later supports property names as details). added signal connection and named data properties. (g_signal_connect_object): new function to setup while_alive connections. (g_object_class_install_property): sink properties now, since they are initially floating. (g_object_steal_data): (g_object_set_data_full): (g_object_set_data): (g_object_get_data): set/get data by using g_datalist_*() functions directly. (g_object_queue_param_changed): nuked. (g_object_freeze_notify): start queueing of property changes (freeze/ thaw calls stack). (g_object_notify): announce changes of a certain property directly. (g_object_thaw_notify): process queue of property changes, therefore emitting GObject::notify::detail with detail being the changed properties names. (G_OBJECT_WARN_INVALID_PROPERTY_ID): saner macro variant of former G_WARN_INVALID_PARAM_ID(). * gparam.[hc]: param specs are now initially floating and need to be sunken with g_param_spec_sink(), support G_TYPE_PARAM values. added G_PARAM_CONSTRUCT and G_PARAM_CONSTRUCT_ONLY parameter flags, required by GObjectClass.constructor(). * gparamspecs.[hc]: added GParamSpecParam, GParamSpecPointer and GParamSpecCCallback, param specs for G_TYPE_PARAM, G_TYPE_POINTER and G_TYPE_CCALLBACK respectively. * gsignal.[hc]: cleanups. (signal_id_lookup): after walking the anchestry, try interfaces as well. (g_signal_new): new function to create signals from varargs type list. (g_signal_connect_closure): closure connection variant that works from signal name+detail. (g_signal_connect_data): c handler connection variant that works from signal name+detail. (g_signal_emit_valist): emit signal for an instance with paraneters collected from a va_list. (g_signal_emit): emit signal, taking parameters from varargs list. (g_signal_emit_by_name): same as g_signal_emit, working from signal name+detail. (signal_emit_R): return whether return_value needs to be altered. * gtype.[hc]: set log-domain to GRuntime, i'm slowly getting to all the points that need to reflect the upcoming rename. melt g_type_conforms_to() functionality into g_type_is_a(), as that is what we really want (liskov substitution principle). assorted changes to other files due to conforms_to->is_a. * gvalue.[hc]: implemented g_value_set_instance() that sets a value from an instantiatable type via the value_table's collect_value() function (based on an idea from James Henstridge <james@daa.com.au>). cleanups/fixes. * gvaluetypes.[hc]: implement G_TYPE_CCALLBACK and G_TYPE_PARAM.
Diffstat (limited to 'gobject/gobject.h')
-rw-r--r--gobject/gobject.h274
1 files changed, 145 insertions, 129 deletions
diff --git a/gobject/gobject.h b/gobject/gobject.h
index 7c31d6af4..462583094 100644
--- a/gobject/gobject.h
+++ b/gobject/gobject.h
@@ -8,7 +8,7 @@
*
* 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
+ * 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
@@ -19,10 +19,10 @@
#ifndef __G_OBJECT_H__
#define __G_OBJECT_H__
-#include <gobject/gtype.h>
-#include <gobject/gvalue.h>
-#include <gobject/gparam.h>
-#include <gobject/gclosure.h>
+#include <gobject/gtype.h>
+#include <gobject/gvalue.h>
+#include <gobject/gparam.h>
+#include <gobject/gclosure.h>
#ifdef __cplusplus
@@ -31,161 +31,177 @@ extern "C" {
/* --- type macros --- */
-#define G_TYPE_IS_OBJECT(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
-#define G_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
-#define G_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
-#define G_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
+#define G_TYPE_IS_OBJECT(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
+#define G_OBJECT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
+#define G_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
+#define G_IS_OBJECT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
#define G_IS_OBJECT_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_OBJECT))
#define G_OBJECT_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_OBJECT, GObjectClass))
-#define G_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
+#define G_OBJECT_TYPE(object) (G_TYPE_FROM_INSTANCE (object))
#define G_OBJECT_TYPE_NAME(object) (g_type_name (G_OBJECT_TYPE (object)))
#define G_OBJECT_CLASS_TYPE(class) (G_TYPE_FROM_CLASS (class))
#define G_OBJECT_CLASS_NAME(class) (g_type_name (G_OBJECT_CLASS_TYPE (class)))
#define G_IS_VALUE_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
-#define G_NOTIFY_PRIORITY (G_PRIORITY_HIGH_IDLE + 20)
-
/* --- typedefs & structures --- */
-typedef struct _GObject GObject;
-typedef struct _GObjectClass GObjectClass;
-typedef struct _GObjectConstructParam GObjectConstructParam;
-typedef void (*GObjectGetParamFunc) (GObject *object,
- guint param_id,
- GValue *value,
- GParamSpec *pspec,
- const gchar *trailer);
-typedef void (*GObjectSetParamFunc) (GObject *object,
- guint param_id,
- const GValue *value,
- GParamSpec *pspec,
- const gchar *trailer);
-typedef void (*GObjectFinalizeFunc) (GObject *object);
-struct _GObject
+typedef struct _GObject GObject;
+typedef struct _GObjectClass GObjectClass;
+typedef struct _GObjectConstructParam GObjectConstructParam;
+typedef void (*GObjectGetPropertyFunc) (GObject *object,
+ guint property_id,
+ GValue *value,
+ GParamSpec *pspec,
+ const gchar *trailer);
+typedef void (*GObjectSetPropertyFunc) (GObject *object,
+ guint property_id,
+ const GValue *value,
+ GParamSpec *pspec,
+ const gchar *trailer);
+typedef void (*GObjectFinalizeFunc) (GObject *object);
+struct _GObject
{
GTypeInstance g_type_instance;
/*< private >*/
- guint ref_count;
- GData *qdata;
+ guint ref_count;
+ GData *qdata;
};
-struct _GObjectClass
+struct _GObjectClass
{
GTypeClass g_type_class;
- guint n_param_specs;
- GParamSpec **param_specs;
-
- GObject* (*constructor) (GType type, // FIXME!!!
- guint n_construct_params,
- GObjectConstructParam *construct_params);
- void (*get_param) (GObject *object,
- guint param_id,
- GValue *value,
- GParamSpec *pspec,
- const gchar *trailer);
- void (*set_param) (GObject *object,
- guint param_id,
- const GValue *value,
- GParamSpec *pspec,
- const gchar *trailer);
- void (*queue_param_changed) (GObject *object,
- GParamSpec *pspec);
- void (*dispatch_param_changed) (GObject *object,
+ /* private, these fields might vanish */
+ guint n_property_specs;
+ GParamSpec **property_specs;
+
+ /* public overridable methods */
+ GObject* (*constructor) (GType type,
+ guint n_construct_properties,
+ GObjectConstructParam *construct_params);
+ void (*get_property) (GObject *object,
+ guint property_id,
+ GValue *value,
+ GParamSpec *pspec,
+ const gchar *trailer);
+ void (*set_property) (GObject *object,
+ guint property_id,
+ const GValue *value,
+ GParamSpec *pspec,
+ const gchar *trailer);
+ void (*shutdown) (GObject *object);
+ void (*finalize) (GObject *object);
+
+ /*< private >*/
+ void (*dispatch_properties_changed) (GObject *object,
+ guint n_pspecs,
+ GParamSpec **pspecs);
+
+ /* signals */
+ void (*properties_changed) (GObject *object,
+ guint n_pspecs,
+ GParamSpec **pspecs);
+ void (*notify) (GObject *object,
GParamSpec *pspec);
- void (*shutdown) (GObject *object);
- void (*finalize) (GObject *object);
};
struct _GObjectConstructParam
{
- GParamSpec *pspec;
- GValue *value;
- gchar *trailer;
+ GParamSpec *pspec;
+ GValue *value;
+ const gchar *trailer;
};
/* --- prototypes --- */
-void g_object_class_install_param (GObjectClass *oclass,
- guint param_id,
- GParamSpec *pspec /* +1 ref */);
-GParamSpec* g_object_class_find_param_spec (GObjectClass *oclass,
- const gchar *param_name);
-gpointer g_object_new (GType object_type,
- const gchar *first_param_name,
- ...);
-gpointer g_object_new_valist (GType object_type,
- const gchar *first_param_name,
- va_list var_args);
-void g_object_set (GObject *object,
- const gchar *first_param_name,
- ...);
-void g_object_get (GObject *object,
- const gchar *first_param_name,
- ...);
-void g_object_set_valist (GObject *object,
- const gchar *first_param_name,
- va_list var_args);
-void g_object_get_valist (GObject *object,
- const gchar *first_param_name,
- va_list var_args);
-void g_object_set_param (GObject *object,
- const gchar *param_name,
- const GValue *value);
-void g_object_get_param (GObject *object,
- const gchar *param_name,
- GValue *value);
-void g_object_queue_param_changed (GObject *object,
- const gchar *param_name);
-GObject* g_object_ref (GObject *object);
-void g_object_unref (GObject *object);
-gpointer g_object_get_qdata (GObject *object,
- GQuark quark);
-void g_object_set_qdata (GObject *object,
- GQuark quark,
- gpointer data);
-void g_object_set_qdata_full (GObject *object,
- GQuark quark,
- gpointer data,
- GDestroyNotify destroy);
-gpointer g_object_steal_qdata (GObject *object,
- GQuark quark);
-gpointer g_object_get_data (GObject *object,
- const gchar *key);
-void g_object_set_data (GObject *object,
- const gchar *key,
- gpointer data);
-void g_object_set_data_full (GObject *object,
- const gchar *key,
- gpointer data,
- GDestroyNotify destroy);
-gpointer g_object_steal_data (GObject *object,
- const gchar *key);
-void g_object_watch_closure (GObject *object,
- GClosure *closure);
-GClosure* g_cclosure_new_object (GCallback callback_func,
- gpointer object);
-GClosure* g_cclosure_new_object_swap (GCallback callback_func,
- gpointer object);
-GClosure* g_closure_new_object (guint sizeof_closure,
- GObject *object);
-void g_value_set_object (GValue *value,
- GObject *v_object);
-GObject* g_value_get_object (const GValue *value);
-GObject* g_value_dup_object (const GValue *value);
+void g_object_class_install_property (GObjectClass *oclass,
+ guint property_id,
+ GParamSpec *pspec);
+GParamSpec* g_object_class_find_property (GObjectClass *oclass,
+ const gchar *property_name);
+gpointer g_object_new (GType object_type,
+ const gchar *first_property_name,
+ ...);
+gpointer g_object_new_valist (GType object_type,
+ const gchar *first_property_name,
+ va_list var_args);
+void g_object_set (GObject *object,
+ const gchar *first_property_name,
+ ...);
+void g_object_get (GObject *object,
+ const gchar *first_property_name,
+ ...);
+void g_object_set_valist (GObject *object,
+ const gchar *first_property_name,
+ va_list var_args);
+void g_object_get_valist (GObject *object,
+ const gchar *first_property_name,
+ va_list var_args);
+void g_object_set_property (GObject *object,
+ const gchar *property_name,
+ const GValue *value);
+void g_object_get_property (GObject *object,
+ const gchar *property_name,
+ GValue *value);
+void g_object_freeze_notify (GObject *object);
+void g_object_notify (GObject *object,
+ const gchar *property_name);
+void g_object_thaw_notify (GObject *object);
+GObject* g_object_ref (GObject *object);
+void g_object_unref (GObject *object);
+gpointer g_object_get_qdata (GObject *object,
+ GQuark quark);
+void g_object_set_qdata (GObject *object,
+ GQuark quark,
+ gpointer data);
+void g_object_set_qdata_full (GObject *object,
+ GQuark quark,
+ gpointer data,
+ GDestroyNotify destroy);
+gpointer g_object_steal_qdata (GObject *object,
+ GQuark quark);
+gpointer g_object_get_data (GObject *object,
+ const gchar *key);
+void g_object_set_data (GObject *object,
+ const gchar *key,
+ gpointer data);
+void g_object_set_data_full (GObject *object,
+ const gchar *key,
+ gpointer data,
+ GDestroyNotify destroy);
+gpointer g_object_steal_data (GObject *object,
+ const gchar *key);
+void g_object_watch_closure (GObject *object,
+ GClosure *closure);
+GClosure* g_cclosure_new_object (GCallback callback_func,
+ gpointer object);
+GClosure* g_cclosure_new_object_swap (GCallback callback_func,
+ gpointer object);
+GClosure* g_closure_new_object (guint sizeof_closure,
+ GObject *object);
+void g_value_set_object (GValue *value,
+ GObject *v_object);
+GObject* g_value_get_object (const GValue *value);
+GObject* g_value_dup_object (const GValue *value);
+guint g_signal_connect_object (gpointer instance,
+ const gchar *detailed_signal,
+ GCallback c_handler,
+ gpointer gobject,
+ gboolean swapped,
+ gboolean after);
/* --- implementation macros --- */
-#define G_WARN_INVALID_PARAM_ID(object, param_id, pspec) \
+#define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
G_STMT_START { \
GObject *_object = (GObject*) (object); \
GParamSpec *_pspec = (GParamSpec*) (pspec); \
- guint _param_id = (param_id); \
- g_warning ("%s: invalid parameter id %u for \"%s\" of type `%s' in `%s'", \
- G_STRLOC, \
- _param_id, \
- _pspec->name, \
- g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
- G_OBJECT_TYPE_NAME (_object)); \
+ guint _property_id = (property_id); \
+ g_warning ("%s: invalid property id %u for \"%s\" of type `%s' in `%s'", \
+ G_STRLOC, \
+ _property_id, \
+ _pspec->name, \
+ g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
+ G_OBJECT_TYPE_NAME (_object)); \
} G_STMT_END