gir_ffi 0.6.7 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4030d6c4cfb00268801490cc1bb1ea0fcecfd533
+  data.tar.gz: 36be619abbb6889c67c7ab2726c6eaa3708f7946
+SHA512:
+  metadata.gz: ae9124773e81ce3c8ce21882fa164296f40c06d14c3032f57b121a4026967fb0e6e210d60dacaa171f21997f34a19855e407ed425c7fba0d1d2dbc47fa47e4e9
+  data.tar.gz: 0b647b4e8bec822e25f96a249efc0ea0ce4b9177b17de87d18d3f17f384d5f70480f7986ff920697a6e06709b752d0407ed3d88f485b43a290081e2ffecee01e

data/{History.txt → Changelog.md}

@@ -1,4 +1,36 @@
-== 0.6.7 / 2013-09-28
+# Changelog
+
+## 0.7.0 / 2014-01-11
+
+* Type handling:
+  * Handle c arrays with separate length argument for signals
+  * Handle GHashTable values of type :gint8 and :guint32
+  * Handle signals with int64, Strv, uint64 arguments
+  * Handle arrays of integers cast as pointers
+  * Handle fields of callback type
+  * Handle nested GHashTable
+* Argument handling:
+  * Refactor argument builder system
+  * Improve handling of user data arguments
+  * Handle signal and callback arguments with direction :out
+  * Handle aliases of container types by making the element type optional
+  * Handle signal and callback return values that need conversion
+* User defined types:
+  * Pass explicit receiver to initialization block for UserDefinedTypeInfo
+  * Allow user defined types that are anonymous Ruby classes
+  * Register defined properties in a subclass
+  * Support setting virtual function implementations in a subclass
+  * Support adding an interface to a subclass
+  * Support implementing an interface's virtual functions in a subclass 
+* Use FFI's DataConvertor system to handle enums and callbacks
+* Stop using deprecated GValueArray to construct argument array for signal_emit
+* Make ITypeInfo#g_type return correct value for c arrays
+* Make get_property and set_property less smart, moving conversion into the
+  property accessor definitions
+* Make GObject::Value#get_value handle enums and flags
+* Clean up deprecated methods
+
+## 0.6.7 / 2013-09-28
 
 * Uniform handling of callback, signal and method arguments
 * Automatically convert array elements to GValue
@@ -12,18 +44,18 @@
 * Deprecate several methods
 * Lots of refactoring
 
-== 0.6.6 / 2013-08-05
+## 0.6.6 / 2013-08-05
 
 * Handle GArrays of booleans and structs
 * Improve handling of gbooleans
 
-== 0.6.5 / 2013-08-03
+## 0.6.5 / 2013-08-03
 
 * Handle inline arrays of structs
 * Implement equality operator for container types
 * Fix element size calculation for GArray
 
-== 0.6.4 / 2013-06-30
+## 0.6.4 / 2013-06-30
 
 * Represent enum types by modules wrapping FFI::Enum
 * Support functions on enums
@@ -34,25 +66,25 @@
 * Handle caller-allocated arguments of type GArray
 * Deprecate GObject::Value#ruby_value, replacing it with #get_value
 
-== 0.6.3 / 2013-06-15
+## 0.6.3 / 2013-06-15
 
 * Make use of enums as element type for GHashTable and other containers
-  work
+work
 
-== 0.6.2 / 2013-06-14
+## 0.6.2 / 2013-06-14
 
 * Handle introspectable types with introspectable parent types
 
-== 0.6.1 / 2013-06-09
+## 0.6.1 / 2013-06-09
 
 * Handle SizedArray containing enums
 
-== 0.6.0 / 2013-06-07
+## 0.6.0 / 2013-06-07
 
 * Support Rubinius
 * Lots of refactoring
 
-== 0.5.2 / 2013-04-23
+## 0.5.2 / 2013-04-23
 
 * Handle signal details in GObject.signal_connect and .signal_emit
 * Make GValue#set_value check object GType compatibility
@@ -60,12 +92,12 @@
 * Handle more argument types
 * Support Ruby 2.0.0
 
-== 0.5.1 / 2013-02-01
+## 0.5.1 / 2013-02-01
 
 * Properly handle zero-terminated arrays of :filename
 * Loosen dependencies on ffi and minitest
 
-== 0.5.0 / 2013-01-19
+## 0.5.0 / 2013-01-19
 
 * Update ffi dependency
 * Add finalizer to release memory for IBaseInfo and descendents
@@ -73,38 +105,38 @@
 * Remove pretty-printing functionality
 * Refactor argument handling
 
-== 0.4.3 / 2012-11-02
+## 0.4.3 / 2012-11-02
 
 * Remove gobject-introspection version check
 * Make tests pass with gobject-introspection 1.34
 * Ongoing refactoring
 
-== 0.4.2 / 2012-09-22
+## 0.4.2 / 2012-09-22
 
 * Make objects and interfaces wrap poiners in the class that matches
-  their GType.
+their GType.
 
-== 0.4.1 / 2012-09-18
+## 0.4.1 / 2012-09-18
 
 * Remove workarounds for older versions of gobject-introspection
 * Mark certain methods as deprecated. These will be removed in 0.5.0
 * Handle :filename type arguments in InPointer
 * Refactoring
 
-== 0.4.0 / 2012-08-24
+## 0.4.0 / 2012-08-24
 
 * Move Gtk+ bindings to their own gem (gir_ffi-gtk).
 
-== 0.3.2 / 2012-08-24
+## 0.3.2 / 2012-08-24
 
 * Correctly set FFI return type when callbacks that return GObjects have
-  incomplete type specification.
+incomplete type specification.
 
-== 0.3.1 / 2012-05-13
+## 0.3.1 / 2012-05-13
 
 * Correctly map Interface types in callbacks.
 
-== 0.3.0 / 2012-04-09
+## 0.3.0 / 2012-04-09
 
 * Improve process of defining initializers in derived classes.
 * Make interfaces know their GType.
@@ -116,68 +148,68 @@
 * Improve unintrospectable type handling.
 * Bug fixes and refactorings.
 * Start implementing #define_type, for creating descendent types that
-  the GObject system knows about.
+the GObject system knows about.
 
-== 0.2.3 / 2011-12-31
+## 0.2.3 / 2011-12-31
 
 * Fix issue #7: methods that take GValues will autoconvert other values.
 * Fix method lookup when include'ing a module that is an Interface.
 * Various refactorings.
 
-== 0.2.2 / 2011-12-07
+## 0.2.2 / 2011-12-07
 
 * Fix issue #19: Check if a GLib::PtrArray.add method was generated
-  before attempting to remove it.
+before attempting to remove it.
 * Fix two issues with pretty printing that made output for GLib have syntax
-  errors.
+errors.
 
-== 0.2.1 / 2011-11-20
+## 0.2.1 / 2011-11-20
 
 * Fix handling of output parameters that are arrays of pointers to
-  structures (i.e., of type Foo***).
+structures (i.e., of type Foo***).
 
-== 0.2.0 / 2011-11-19
+## 0.2.0 / 2011-11-19
 
 * Add support for properties, with #get_property and #set_property.
 * Add support for fields.
-  - Create field accessor methods.
-  - Get rid of #[] and #[]=.
+- Create field accessor methods.
+- Get rid of #[] and #[]=.
 * Explicitely load libgirepository with ABI version 1.
 * Improve implementation of GLib container classes (GList etc.):
-  - Real constructors.
-  - #append and friends are instance methods now.
-  - Conversion methods to cast Ruby containers to GLib containers.
+- Real constructors.
+- #append and friends are instance methods now.
+- Conversion methods to cast Ruby containers to GLib containers.
 * Start implementing pretty printing.
 * Various refactorings.
 
-== 0.1.0 / 2011-10-28
+## 0.1.0 / 2011-10-28
 
 * Put bindings for GObjectIntrospection in their own namespace.
 * GirFFI.setup no longer loads overrides.
 * Add ffi-gtk2 and ffi-gtk3 files for loading Gtk+ overrides.
 
-== 0.0.14 / 2011-10-28
+## 0.0.14 / 2011-10-28
 
 * Support GObject Introspection version 1.30:
-  - Add support for layouts with fixed-length arrays.
-  - Handle type names starting with underscores.
-  - Call g_signal_emitv directly to avoid conflict in introspection info
-    with earlier versions of GObject Introspection.
+- Add support for layouts with fixed-length arrays.
+- Handle type names starting with underscores.
+- Call g_signal_emitv directly to avoid conflict in introspection info
+  with earlier versions of GObject Introspection.
 
-== 0.0.13 / 2011-09-09
+## 0.0.13 / 2011-09-09
 
 * Remove IErrorDomain related code. This functinality was removed from
-  GObject Introspection in version 1.29.17
+GObject Introspection in version 1.29.17
 
-== 0.0.12 / 2011-09-04
+## 0.0.12 / 2011-09-04
 
-* No longer use _id2ref to locate objects past as user data pointers.
+* No longer use `_id2ref` to locate objects past as user data pointers.
 * Fix failing tests on JRuby.
 
-== 0.0.11 / 2011-08-22
+## 0.0.11 / 2011-08-22
 
 * Change interface to the underlying builder in generated modules and
-  classes.
+classes.
 * Handle string, enum, union, flags signal arguments.
 * Handle string arguments in GObject.signal_emit.
 * Handle enum signal arguments.
@@ -185,13 +217,13 @@
 * Fix method setup in non-introspectable types.
 * Refactoring.
 
-== 0.0.10 / 2011-05-18
+## 0.0.10 / 2011-05-18
 
 * Handle GObject interfaces properly.
 * Create types only defined by the GType system.
 * Support GType array return values.
 
-== 0.0.9 / 2011-05-02
+## 0.0.9 / 2011-05-02
 
 * More complete support for the basic types.
 * Improved support for GList, GSList, GStrv, and GValue.
@@ -202,28 +234,28 @@
 * Use minitest/spec for testing.
 * Various bug fixes and internal improvements.
 
-== 0.0.8 / 2011-04-08
+## 0.0.8 / 2011-04-08
 
 * Generate modules with names starting with a lowercase letter (like
-  cairo).
+cairo).
 * Allow specifying the typelib version on setup.
 * Rename methods #methods and #type of the introspection classes to avoid
-  clashing with standard Ruby methods.
+clashing with standard Ruby methods.
 * Refactoring.
 
-== 0.0.7 / 2011-04-01
+## 0.0.7 / 2011-04-01
 
 * Support gobject-introspection 0.10, drop support for earlier versions.
-  - Use Regress, not Everything, for testing.
-  - Deal with functions that are no longer introspectable.
+- Use Regress, not Everything, for testing.
+- Deal with functions that are no longer introspectable.
 * Correctly handle constructors that declare their return type different
-  from their class.
+from their class.
 * Implement RubyClosure, a GObject::Closure for handling ruby callbacks.
 * Handle GLib's singly and doubly linked lists.
 * Handle callback types defined in-place (like Closure's marshal).
 * Refactoring.
 
-== 0.0.6 / 2011-03-01
+## 0.0.6 / 2011-03-01
 
 * Cast returned GObjects to their actual type.
 * Properly cast callback arguments.
@@ -231,7 +263,7 @@
 * Make sure Gtk::Window has the correct number of references after creation.
 * Refactoring and some small fixes.
 
-== 0.0.5 / 2010-12-30
+## 0.0.5 / 2010-12-30
 
 * Don't create instance methods out of functions and vice versa.
 * Find signals on interfaces, too.
@@ -240,7 +272,7 @@
 * Handle most other argument types.
 * Various internal changes and other fixes.
 
-== 0.0.4 / 2010-12-14
+## 0.0.4 / 2010-12-14
 
 * Lots of changes to the internals.
 * Handle out-only arguments.
@@ -251,16 +283,16 @@
 * Implement Union type.
 * Many small bug fixes.
 
-== 0.0.3 / 2010-11-19
+## 0.0.3 / 2010-11-19
 
 * Update to restore Ruby 1.9 support.
 * Handle functions with the 'throws' property set.
 * Handle classes without specified fields.
 
-== 0.0.2 / 2010-11-14
+## 0.0.2 / 2010-11-14
 
 * Several fixes to method creation.
 
-== 0.0.1 / 2010-10-25
+## 0.0.1 / 2010-10-25
 
 * Initial release.

data/{DESIGN.rdoc → DESIGN.md}

@@ -1,11 +1,11 @@
-= Design of Gir-FFI
+# Design of Gir-FFI
 
-== Basic Idea
+## Basic Idea
 
 Gir-FFI uses FFI to read information from the GObject Introspection
 Repository. Based on that it creates bindings for the information read.
 
-== Class and method creation
+## Class and method creation
 
 GirFFI::Builder creates classes and modules at runtime and adds appropriate
 method_missing methods to them to generate methods and perhaps other
@@ -22,7 +22,7 @@ The following options were discarded, at least for now.
   still in interesting idea, but off-line source code generation is not
   really the Ruby way.
 
-== Method Naming
+## Method Naming
 
 Probably, get_x/set_x pairs should become x and x= to be more Ruby-like.
 This should be done either by defining them as such directly, or by
@@ -35,7 +35,7 @@ Boolean-valued methods could get a ? at the end.
 This requires a lot more thought. For now, the full method names as
 defined in the GIR are used.
 
-== Ruby-GNOME Compatibility
+## Ruby-GNOME Compatibility
 
 Full Ruby-GNOME compatibility cannot be achieved automatically, since its
 object hierarchy differs from that of standard GObject: It puts Object in
@@ -45,7 +45,7 @@ GLib::Instantiable; In standard GObject they are functions.
 Possibly, compatibility enhancing code can be added for these specific
 exceptions.
 
-== Reference Counting
+## Reference Counting
 
 Because we can always make sure GObjects are unref'd when the Ruby object
 is GC'd, the mechanism of floating references actually gets in the way a
@@ -54,7 +54,7 @@ them. All GObjects can then safely be unref'd using a Ruby finalizer.
 GObjects obtained through other mechanisms than with a constructor will be
 ref'd once when wrapping them in a ruby object.
 
-== Bootstrapping Class Design
+## Bootstrapping Class Design
 
 The interface to the GObject Introspection Repository itself is also
 introspectable. The interface is specified in terms of structs and

data/README.md

@@ -2,8 +2,6 @@
 
 by Matijs van Zuijlen
 
-[![Build Status](https://secure.travis-ci.org/mvz/ruby-gir-ffi.png)](http://travis-ci.org/mvz/ruby-gir-ffi)
-
 ## Description
 
 Ruby bindings for GNOME using the GObject Introspection Repository.
@@ -13,7 +11,7 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 * Create bindings to any GObject-based library.
 * Bindings generated at runtime.
 * Provides overridden bindings for selected methods.
-* Install 'gir_ffi-gtk' and require 'gir_ffi-gtk2' or 'gir_ffi-gtk3' to
+* Install `gir_ffi-gtk` and require `gir_ffi-gtk2` or `gir_ffi-gtk3` to
   load overrides for Gtk2 or Gtk3.
 
 ## Usage
@@ -39,8 +37,8 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 
 ## Requirements
 
-GirFFI should work on MRI 1.8, 1.9 and 2.0, JRuby in both 1.8 and 1.9
-modes, and on Rubinius in both 1.8 and 1.9 modes.
+GirFFI should work on MRI 1.8, 1.9, 2.0, and 2.1, JRuby in both 1.8 and 1.9
+modes, and on Rubinius.
 
 You will also need gobject-introspection installed with some
 introspection data.
@@ -73,7 +71,7 @@ already exist:
 
 ## Hacking and contributing
 
-If you want to help out, have a look at TODO.rdoc, and check the notes
+If you want to help out, have a look at TODO.md, and check the notes
 in the code (e.g., using `dnote`). Feel free to file bugs or send pull
 requests.
 
@@ -90,7 +88,7 @@ If you want to send pull requests or patches, please:
 
 ## License
 
-Copyright © 2009–2013 [Matijs van Zuijlen](http://www.matijs.net)
+Copyright © 2009–2014 [Matijs van Zuijlen](http://www.matijs.net)
 
 GirFFI is free software, distributed under the terms of the GNU Lesser
 General Public License, version 2.1 or later. See the file COPYING.LIB for

data/TODO.md

@@ -0,0 +1,90 @@
+# TODO
+
+## Memory managment
+
+GirFFI does not attempt to free any memory at the moment, or lower the
+reference count of any objects it gets from GObject. This task therefore involves two parts:
+
+- Free non-GObject pointers as needed (at garbage-collection time)
+- Lower reference count of GObjects (at garbage-collection time)
+
+## Refactorings
+
+These in the order they occured to me, and may therefore be fixed in any order.
+
+- Create Type objects for all FFI types, including the ones currently
+  represented by a single symbol, so we can always do stuff like
+
+  > `GirFFI::Types::UInt8.get_value_from_pointer(ptr)`
+
+  rather than having awkward dynamic method dispatch inside GirFFI::InOutPointer.
+
+- Move to a single Pointer class, rather than InPointer, InOutPointer and
+  Pointer monkeypatching.
+
+- Move special types like SizedArray to sane namespaces. Types (like
+  GLib::List) that have actual GLib implementations go to the GLib namespace.
+  Other types go to the GirFFI namespace.
+
+## Derived types
+
+Derived classes can now be registered with GObject, but the way to do this is
+not very nice:
+
+    class Derived < Base
+    end
+
+    GirFFI.define_type Derived do |info|
+      info.install_property GObject.param_spec_int("foo", "foo bar",
+                                                   "The Foo Bar Property",
+                                                   10, 20, 15, 3)
+      # assume Base defines a virtual function called 'some_vfunc'
+      info.install_vfunc_implementation :some_vfunc, proc {|obj|
+        #implementation goes here
+      }
+    end
+
+It would be good to replace this with something that's easier to use:
+* Perhaps auto-register types, like Gtk# does
+* Perhaps automagically find vfunc implementations, like PyGObject and
+  Ruby-GNOME do
+* What about properties?
+
+## Persistent Ruby GObject identity
+
+GirFFI should make sure that if it gets a pointer to a GObject for which a Ruby
+object already exists, the existing object is returned. This involves the use
+of WeakRef, no doubt.
+
+## Handle fundamental objects that are not GObject.
+
+This is a big one. See commit 1e9822c7817062a9b853269b9418fd78782090b5 in
+gobject-introspection, and TestFundamentalObject in Regress.
+
+The tests for TestFundamentalObject accidentally pass, but there may be
+hidden issues.
+
+## Check binding of GObject:
+
+    (11:37:03 PM) walters: the basic story is that GObject should be manually bound
+    (11:47:02 PM) ebassi: the really necessary bits are: GObject/GInitiallyUnowned memory management; properties accessors; GSignal connection API
+    (11:47:15 PM) ebassi: the rest is "nice to have"
+    (11:47:37 PM) ebassi: oh, and probably GBinding - but that's just because I wrote it ;-)
+
+## Use FFI::DataConverter to automatically convert GObject types
+
+GirFFI now generates loads of Something.wrap(ptr) calls; Perhaps these can be
+replace by implementing to_native and from_native in ClassBase and including
+FFI::DataConverter.
+
+## Handle Variants more nicely
+
+Currently, GirFFI requires the user to create GVariant objects by hand, and
+retrieve values from them by hand as well. Ideally, we would have `.from_ruby` and
+`#to_ruby` methods or somesuch that do this for us. Some classes, like GAction,
+require a specifice VariantType to be used consistently. Special logic will have
+to be put in place for that.
+
+## See Also
+
+  dnote