Add a generic CClosure marshaller based on ffi. This makes it possible to

2007-04-29  Johan Dahlin  <jdahlin@async.com.br>

    * README: 
    * configure.ac:
    * gobject/Makefile.am:
    * gobject/ffi-marshaller.c: (g_value_to_ffi_type),
    (g_value_from_ffi_type), (g_cclosure_marshal_generic_ffi):
    * gobject/ffi-marshaller.h:
    * gobject/gobjectmodule.c: (create_signal), (init_gobject):
    * pygobject-2.0.pc.in:
    * tests/test_signal.py:
    * tests/testhelpermodule.c: (test1_callback),
    (test1_callback_swapped), (test2_callback), (test3_callback),
    (test4_callback), (test_float_callback), (test_double_callback),
    (test_string_callback), (test_object_callback), (connectcallbacks),
    (_wrap_connectcallbacks), (inittesthelper):

    Add a generic CClosure marshaller based on ffi. 
    This makes it possible to connect to signals on PyGObjects from C.
    libffi is now an optional dependency
    Fixes #353816 (Edward Hervey)

svn path=/trunk/; revision=651

4 files changed, 249 insertions, 4 deletions

diff --git a/gobject/Makefile.am b/gobject/Makefile.am
index eba8e6c..6c4f242 100644
--- a/gobject/Makefile.am
+++ b/gobject/Makefile.am
@@ -21,7 +21,7 @@ endif
 
 _gobject_la_CFLAGS = $(GLIB_CFLAGS)
 _gobject_la_LDFLAGS = $(common_ldflags) -export-symbols-regex init_gobject
-_gobject_la_LIBADD = $(GLIB_LIBS)
+_gobject_la_LIBADD = $(GLIB_LIBS) $(FFI_LIBS)
 _gobject_la_SOURCES = \
 	gobjectmodule.c \
 	pygboxed.c \
@@ -40,6 +40,10 @@ _gobject_la_SOURCES = \
 	pygoptioncontext.c \
 	pygoptiongroup.c
 
+if HAVE_LIBFFI
+_gobject_la_SOURCES += ffi-marshaller.c
+endif
+
 if PLATFORM_WIN32
 _gobject_la_CFLAGS += -DPLATFORM_WIN32
 endif
diff --git a/gobject/ffi-marshaller.c b/gobject/ffi-marshaller.c
new file mode 100644
index 0000000..177f7c1
--- /dev/null
+++ b/gobject/ffi-marshaller.c
@@ -0,0 +1,194 @@
+/* -*- Mode: C; c-basic-offset: 4 -*-
+ * pygtk- Python bindings for the GTK toolkit.
+ * Copyright (C) 2007 Johan Dahlin
+ *
+ *   ffi-marshaller: Generic CMarshaller using libffi
+ *
+ * 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.1 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
+ */
+
+#include <glib-object.h>
+#include <ffi.h>
+
+static ffi_type *
+g_value_to_ffi_type (const GValue *gvalue, gpointer *value)
+{
+  ffi_type *rettype = NULL;
+  GType type = g_type_fundamental (G_VALUE_TYPE (gvalue));
+  g_assert (type != G_TYPE_INVALID);
+
+  switch (type) {
+  case G_TYPE_BOOLEAN:
+  case G_TYPE_CHAR:
+  case G_TYPE_INT:
+    rettype = &ffi_type_sint;
+    *value = (gpointer)&(gvalue->data[0].v_int);
+    break;
+  case G_TYPE_UCHAR:
+  case G_TYPE_UINT:
+    rettype = &ffi_type_uint;
+    *value = (gpointer)&(gvalue->data[0].v_uint);
+    break;
+  case G_TYPE_STRING:
+  case G_TYPE_OBJECT:
+  case G_TYPE_BOXED:
+  case G_TYPE_POINTER:
+    rettype = &ffi_type_pointer;
+    *value = (gpointer)&(gvalue->data[0].v_pointer);
+    break;
+  case G_TYPE_FLOAT:
+    rettype = &ffi_type_float;
+    *value = (gpointer)&(gvalue->data[0].v_float);
+    break;
+  case G_TYPE_DOUBLE:
+    rettype = &ffi_type_double;
+    *value = (gpointer)&(gvalue->data[0].v_double);
+    break;
+  case G_TYPE_LONG:
+    rettype = &ffi_type_slong;
+    *value = (gpointer)&(gvalue->data[0].v_long);
+    break;
+  case G_TYPE_ULONG:
+    rettype = &ffi_type_ulong;
+    *value = (gpointer)&(gvalue->data[0].v_ulong);
+    break;
+  case G_TYPE_INT64:
+    rettype = &ffi_type_sint64;
+    *value = (gpointer)&(gvalue->data[0].v_int64);
+    break;
+  case G_TYPE_UINT64:
+    rettype = &ffi_type_uint64;
+    *value = (gpointer)&(gvalue->data[0].v_uint64);
+    break;
+  default:
+    rettype = &ffi_type_pointer;
+    *value = NULL;
+    g_warning ("Unsupported fundamental type: %s", g_type_name (type));
+    break;
+  }
+  return rettype;
+}
+
+static void
+g_value_from_ffi_type (GValue *gvalue, gpointer *value)
+{
+  switch (g_type_fundamental (G_VALUE_TYPE (gvalue))) {
+  case G_TYPE_INT:
+      g_value_set_int (gvalue, *(gint*)value);
+      break;
+  case G_TYPE_FLOAT:
+      g_value_set_float (gvalue, *(gfloat*)value);
+      break;
+  case G_TYPE_DOUBLE:
+      g_value_set_double (gvalue, *(gdouble*)value);
+      break;
+  case G_TYPE_BOOLEAN:
+      g_value_set_boolean (gvalue, *(gboolean*)value);
+      break;
+  case G_TYPE_STRING:
+      g_value_set_string (gvalue, *(gchar**)value);
+      break;
+  case G_TYPE_CHAR:
+      g_value_set_char (gvalue, *(gchar*)value);
+      break;
+  case G_TYPE_UCHAR:
+      g_value_set_uchar (gvalue, *(guchar*)value);
+      break;
+  case G_TYPE_UINT:
+      g_value_set_uint (gvalue, *(guint*)value);
+      break;
+  case G_TYPE_POINTER:
+      g_value_set_pointer (gvalue, *(gpointer*)value);
+      break;
+  case G_TYPE_LONG:
+      g_value_set_long (gvalue, *(glong*)value);
+      break;
+  case G_TYPE_ULONG:
+      g_value_set_ulong (gvalue, *(gulong*)value);
+      break;
+  case G_TYPE_INT64:
+      g_value_set_int64 (gvalue, *(gint64*)value);
+      break;
+  case G_TYPE_UINT64:
+      g_value_set_uint64 (gvalue, *(guint64*)value);
+      break;
+  case G_TYPE_BOXED:
+      g_value_set_boxed (gvalue, *(gpointer*)value);
+      break;
+  default:
+    g_warning ("Unsupported fundamental type: %s",
+	       g_type_name (g_type_fundamental (G_VALUE_TYPE (gvalue))));
+  }
+
+}
+
+void
+g_cclosure_marshal_generic_ffi (GClosure *closure,
+				GValue *return_gvalue,
+				guint n_param_values,
+				const GValue *param_values,
+				gpointer invocation_hint,
+				gpointer marshal_data)
+{
+  ffi_type *rtype;
+  void *rvalue;
+  int n_args;
+  ffi_type **atypes;
+  void **args;
+  int i;
+  ffi_cif cif;
+  GCClosure *cc = (GCClosure*) closure;
+
+  if (return_gvalue && G_VALUE_TYPE (return_gvalue)) 
+    {
+      rtype = g_value_to_ffi_type (return_gvalue, &rvalue);
+    }
+  else 
+    {
+      rtype = &ffi_type_void;
+    }
+
+  rvalue = g_alloca (MAX (rtype->size, sizeof (ffi_arg)));
+  
+  n_args = n_param_values + 1;
+  atypes = g_alloca (sizeof (ffi_type *) * n_args);
+  args =  g_alloca (sizeof (gpointer) * n_args);
+
+  if (G_CCLOSURE_SWAP_DATA (closure))
+    {
+      atypes[n_args-1] = g_value_to_ffi_type (param_values + 0,  
+					      &args[n_args-1]);
+      atypes[0] = &ffi_type_pointer;
+      args[0] = &closure->data;
+    }
+  else
+    {
+      atypes[0] = g_value_to_ffi_type (param_values + 0, &args[0]);
+      atypes[n_args-1] = &ffi_type_pointer;
+      args[n_args-1] = &closure->data;
+    }
+
+  for (i = 1; i < n_args - 1; i++)
+    atypes[i] = g_value_to_ffi_type (param_values + i, &args[i]);
+
+  if (ffi_prep_cif (&cif, FFI_DEFAULT_ABI, n_args, rtype, atypes) != FFI_OK)
+    return;
+
+  ffi_call (&cif, marshal_data ? marshal_data : cc->callback, rvalue, args);
+
+  if (return_gvalue && G_VALUE_TYPE (return_gvalue))
+    g_value_from_ffi_type (return_gvalue, rvalue);
+}
diff --git a/gobject/ffi-marshaller.h b/gobject/ffi-marshaller.h
new file mode 100644
index 0000000..81404b0
--- /dev/null
+++ b/gobject/ffi-marshaller.h
@@ -0,0 +1,31 @@
+/* -*- Mode: C; c-basic-offset: 4 -*-
+ * pygtk- Python bindings for the GTK toolkit.
+ * Copyright (C) 2007 Johan Dahlin
+ *
+ * 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.1 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 _FFI_MARSHALLER_H_
+#define _FFI_MARSHALLER_H_
+
+void g_cclosure_marshal_generic_ffi (GClosure *closure,
+				     GValue *return_gvalue,
+				     guint n_param_values,
+				     const GValue *param_values,
+				     gpointer invocation_hint,
+				     gpointer marshal_data);
+
+#endif /* _FFI_MARSHALLER_H_ */
diff --git a/gobject/gobjectmodule.c b/gobject/gobjectmodule.c
index 32256a6..8316a20 100644
--- a/gobject/gobjectmodule.c
+++ b/gobject/gobjectmodule.c
@@ -28,6 +28,13 @@
 #include "pythread.h"
 #include <gobject/gvaluecollector.h>
 
+#ifdef HAVE_FFI_H
+#include "ffi-marshaller.h"
+static GSignalCMarshaller marshal_generic = g_cclosure_marshal_generic_ffi;
+#else
+static GSignalCMarshaller marshal_generic = 0;
+#endif
+
 static PyObject *gerror_exc = NULL;
 static gboolean use_gil_state_api = FALSE;
 static PyObject *_pyg_signal_accumulator_true_handled_func;
@@ -594,7 +601,7 @@ create_signal (GType instance_type, const gchar *signal_name, PyObject *tuple)
     signal_id = g_signal_newv(signal_name, instance_type, signal_flags,
 			      pyg_signal_class_closure_get(),
 			      accumulator, accum_data,
-			      (GSignalCMarshaller)0,
+			      marshal_generic,
 			      return_type, n_params, param_types);
     g_free(param_types);
 
@@ -3452,7 +3459,7 @@ struct _PyGObject_Functions pygobject_api_functions = {
 DL_EXPORT(void)
 init_gobject(void)
 {
-    PyObject *m, *d, *o, *tuple;
+    PyObject *m, *d, *o, *tuple, *features;
     PyObject *descr;
     PyObject *warning;
     
@@ -3556,7 +3563,16 @@ init_gobject(void)
     PyDict_SetItemString(d, "_PyGObject_API",
 			 o=PyCObject_FromVoidPtr(&pygobject_api_functions,NULL));
     Py_DECREF(o);
-	
+
+
+    /* features */
+    features = PyDict_New();
+#ifdef HAVE_FFI_H
+    PyDict_SetItemString(features, "generic-c-marshaller", Py_True);
+#endif
+    PyDict_SetItemString(d, "features", features);
+    Py_DECREF(features);
+
     /* some constants */
     PyModule_AddIntConstant(m, "SIGNAL_RUN_FIRST", G_SIGNAL_RUN_FIRST);
     PyModule_AddIntConstant(m, "SIGNAL_RUN_LAST", G_SIGNAL_RUN_LAST);