we need signal.h for G_BREAKPOINT().
[platform/upstream/glib.git] / gobject / gobject.h
index 4625830..5d34232 100644 (file)
@@ -1,5 +1,5 @@
 /* GObject - GLib Type, Object, Parameter and Signal Library
- * Copyright (C) 1998, 1999, 2000 Tim Janik and Red Hat, Inc.
+ * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
 #include        <gobject/gvalue.h>
 #include        <gobject/gparam.h>
 #include        <gobject/gclosure.h>
+#include        <gobject/gsignal.h>
+#include        <signal.h>
 
-
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
+G_BEGIN_DECLS
 
 /* --- 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_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_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_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_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_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
 
 
 /* --- typedefs & structures --- */
@@ -51,14 +49,14 @@ typedef struct _GObjectConstructParam    GObjectConstructParam;
 typedef void (*GObjectGetPropertyFunc)  (GObject      *object,
                                          guint         property_id,
                                          GValue       *value,
-                                         GParamSpec   *pspec,
-                                         const gchar  *trailer);
+                                         GParamSpec   *pspec);
 typedef void (*GObjectSetPropertyFunc)  (GObject      *object,
                                          guint         property_id,
                                          const GValue *value,
-                                         GParamSpec   *pspec,
-                                         const gchar  *trailer);
+                                         GParamSpec   *pspec);
 typedef void (*GObjectFinalizeFunc)     (GObject      *object);
+typedef void (*GWeakNotify)            (gpointer      data,
+                                        GObject      *where_the_object_was);
 struct  _GObject
 {
   GTypeInstance g_type_instance;
@@ -71,44 +69,37 @@ struct  _GObjectClass
 {
   GTypeClass   g_type_class;
 
-  /* private, these fields might vanish */
-  guint        n_property_specs;
-  GParamSpec **property_specs;
+  /*< private >*/
+  GSList      *construct_properties;
 
   /* 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,
+                                 GObjectConstructParam *construct_properties);
+  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 >*/
+                                         GParamSpec     *pspec);
+  void       (*get_property)           (GObject        *object,
+                                         guint           property_id,
+                                         GValue         *value,
+                                         GParamSpec     *pspec);
+  void       (*dispose)                        (GObject        *object);
+  void       (*finalize)               (GObject        *object);
+  
+  /* seldomly overidden */
   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);
 };
 struct _GObjectConstructParam
 {
-  GParamSpec  *pspec;
-  GValue      *value;
-  const gchar *trailer;
+  GParamSpec *pspec;
+  GValue     *value;
 };
 
 
@@ -118,18 +109,29 @@ void        g_object_class_install_property   (GObjectClass   *oclass,
                                               GParamSpec     *pspec);
 GParamSpec* g_object_class_find_property      (GObjectClass   *oclass,
                                               const gchar    *property_name);
+GParamSpec**g_object_class_list_properties    (GObjectClass   *oclass,
+                                              guint          *n_properties);
 gpointer    g_object_new                      (GType           object_type,
                                               const gchar    *first_property_name,
                                               ...);
-gpointer    g_object_new_valist               (GType           object_type,
+gpointer    g_object_newv                    (GType           object_type,
+                                              guint           n_parameters,
+                                              GParameter     *parameters);
+GObject*    g_object_new_valist               (GType           object_type,
                                               const gchar    *first_property_name,
                                               va_list         var_args);
-void        g_object_set                      (GObject        *object,
+void       g_object_set                      (gpointer        object,
                                               const gchar    *first_property_name,
                                               ...);
-void        g_object_get                      (GObject        *object,
+void        g_object_get                      (gpointer        object,
                                               const gchar    *first_property_name,
                                               ...);
+gpointer    g_object_connect                  (gpointer               object,
+                                              const gchar    *signal_spec,
+                                              ...);
+void       g_object_disconnect               (gpointer        object,
+                                              const gchar    *signal_spec,
+                                              ...);
 void        g_object_set_valist               (GObject        *object,
                                               const gchar    *first_property_name,
                                               va_list         var_args);
@@ -146,8 +148,18 @@ 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_ref                      (gpointer        object);
+void        g_object_unref                    (gpointer        object);
+void       g_object_weak_ref                 (GObject        *object,
+                                              GWeakNotify     notify,
+                                              gpointer        data);
+void       g_object_weak_unref               (GObject        *object,
+                                              GWeakNotify     notify,
+                                              gpointer        data);
+void        g_object_add_weak_pointer         (GObject        *object, 
+                                               gpointer       *weak_pointer_location);
+void        g_object_remove_weak_pointer      (GObject        *object, 
+                                               gpointer       *weak_pointer_location);
 gpointer    g_object_get_qdata                (GObject        *object,
                                               GQuark          quark);
 void        g_object_set_qdata                (GObject        *object,
@@ -173,41 +185,43 @@ gpointer    g_object_steal_data               (GObject        *object,
 void        g_object_watch_closure            (GObject        *object,
                                               GClosure       *closure);
 GClosure*   g_cclosure_new_object             (GCallback       callback_func,
-                                              gpointer        object);
+                                              GObject        *object);
 GClosure*   g_cclosure_new_object_swap        (GCallback       callback_func,
-                                              gpointer        object);
+                                              GObject        *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);
+                                              gpointer        v_object);
+gpointer    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);
+                                              GConnectFlags   connect_flags);
+
+
+/*< protected >*/
+void        g_object_run_dispose             (GObject        *object);
 
 
 /* --- implementation macros --- */
-#define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
+#define G_OBJECT_WARN_INVALID_PSPEC(object, pname, property_id, pspec) \
 G_STMT_START { \
   GObject *_object = (GObject*) (object); \
   GParamSpec *_pspec = (GParamSpec*) (pspec); \
   guint _property_id = (property_id); \
-  g_warning ("%s: invalid property id %u for \"%s\" of type `%s' in `%s'", \
+  g_warning ("%s: invalid %s id %u for \"%s\" of type `%s' in `%s'", \
              G_STRLOC, \
+             (pname), \
              _property_id, \
              _pspec->name, \
              g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
              G_OBJECT_TYPE_NAME (_object)); \
 } G_STMT_END
+#define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
+    G_OBJECT_WARN_INVALID_PSPEC ((object), "property id", (property_id), (pspec))
 
-
-
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
 
 #endif /* __G_OBJECT_H__ */