gir_ffi 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca3636ea5b78e4f09c583690ad160c4a2e739cb1
-  data.tar.gz: 8a4d243567cc87cc00d18783931c97a35635c6c1
+  metadata.gz: 32348b4646865dc62bc64b2138a2e2103a6e1260
+  data.tar.gz: d62d4d20fd485c6c67e245850e76838b2efd1065
 SHA512:
-  metadata.gz: 6994483aa5dd9df51ef778c97de12698abf57fa436527370c404e7e53e711f5febbe56bd34d1765e2efed09622d81ffbb3da8bb45d3b68048956a61d45562d68
-  data.tar.gz: 0092e6fb91d2cfa3e1f6f70e4d601b8a1ac617d817675f3c1ad5930c0b3e0989c5b93a3b56601b2e6f1939c15cb1016485baff82635781af01e5099936232df8
+  metadata.gz: 75e7375073038d8189f15cc7b1c30209beedde82144f6eb50fbb794be81b3be2689de49f5b3db9322a875c81bfdda22f8a4260cadb4f59e9b0c957e19bb16582
+  data.tar.gz: a932d8198cc5fbed0418e658fda7b4031ae3373642228139c6b1645557e8e4192d706b6fe0f5c21ac5e65d29558a1b1e35a7032b2eec033f479d7d508d558806

data/Changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.9.3 / 2016-02-20
+
+* Make allow-none arguments optional in Ruby
+* Add Clutter example
+* Clean up mainloop example
+* Use bit masks for relevant functions in GObjectIntrospection
+
 ## 0.9.2 / 2016-02-05
 
 * Do not create a property accessor when a corresponding getter method exists

data/Gemfile

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # The gem's dependencies are specified in gir_ffi.gemspec
 gemspec
 
-gem 'rubocop', '~> 0.36.0', type: :development
+gem 'rubocop', '~> 0.37.0', type: :development
 
 if ENV['CI']
   if ENV['TRAVIS_RUBY_VERSION'] == '2.2'

data/README.md

@@ -42,6 +42,11 @@ Ruby bindings for GNOME using the GObject Introspection Repository.
 
 See the [documentation](docs/Documentation.md) for more usage information.
 
+## Examples
+
+Have a look in the `examples/` directory for some simple examples. More
+examples can be found in `gir_ffi-gtk` and `gir_ffi-gst`.
+
 ## Install
 
     gem install gir_ffi
@@ -81,6 +86,7 @@ already exist:
 * `gir_ffi-cairo`: overrides for Cairo
 * `gir_ffi-pango`: overrides for Pango
 * `gir_ffi-tracker`: overrides for Tracker
+* `gir_ffi-gst`: overrides for GStreamer
 
 ## Hacking and contributing
 

data/TODO.md

@@ -104,6 +104,7 @@ For how to handle objects, see https://bugzilla.gnome.org/show_bug.cgi?id=657202
 
 * Move GObjectIntrospection to GIRepository, and allow generating its own
   members.
+* Do something useful with the versioning info in the GIR
 
 ## External dependencies
 

data/examples/clutter.rb

@@ -0,0 +1,106 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'gir_ffi'
+
+GirFFI.setup :Clutter
+GirFFI.setup :GdkPixbuf
+
+class PhotoWall < Clutter::Stage
+  STAGE_WIDTH  = 800
+  STAGE_HEIGHT = 600
+
+  THUMBNAIL_SIZE = 200
+  ROW_COUNT      = STAGE_HEIGHT / THUMBNAIL_SIZE
+  COLUMN_COUNT   = STAGE_WIDTH / THUMBNAIL_SIZE
+
+  FOCUS_DEPTH   = 100.0
+  UNFOCUS_DEPTH = 0.0
+
+  def self.create_for path
+    stage = PhotoWall.new
+
+    stage.instance_eval do
+      @path = path
+
+      @bricks = []
+      @images = Dir["#{@path}/**/*.{jpg,png}"]
+      @focus = nil
+
+      set_title "A PhotoWall"
+      set_size STAGE_WIDTH, STAGE_HEIGHT
+
+      ROW_COUNT.times do |row|
+        COLUMN_COUNT.times do |column|
+          break unless @images[row*COLUMN_COUNT + column]
+          puts "Adding #{@images[row*COLUMN_COUNT + column]}"
+          brick = LittleBrick.new_from_file(@images[row*COLUMN_COUNT + column], row, column)
+          add_actor brick
+          @bricks << brick
+        end
+      end
+
+      show_all
+    end
+
+    GObject.signal_connect(stage, "destroy") { Clutter.main_quit }
+
+    stage
+  end
+
+  class LittleBrick < Clutter::Actor
+    attr_accessor :row, :col
+
+    def self.new_from_file fname, row = 0, col = 0
+      brick = new
+      image = Clutter::Image.new
+      picture = GdkPixbuf::Pixbuf.new_from_file fname
+      image.set_data(picture.get_pixels,
+                     picture.has_alpha ? :rgba_8888 : :rgb_888,
+                     picture.width,
+                     picture.height,
+                     picture.rowstride)
+      brick.set_content image
+
+      brick.instance_eval do
+        @row = row
+        @col = col
+
+        set_size THUMBNAIL_SIZE, THUMBNAIL_SIZE
+        set_position col * THUMBNAIL_SIZE, row * THUMBNAIL_SIZE
+        set_reactive true
+      end
+
+      @@focus = nil
+
+      GObject.signal_connect brick, "button-press-event" do |a_brick|
+        if @@focus
+          @@focus.unfocus
+        else
+          brick.focus
+        end
+      end
+
+      brick
+    end
+
+    def focus
+      @@focus = self
+      set_position 0, 0
+      set_size STAGE_WIDTH, STAGE_HEIGHT
+      raise_top
+    end
+
+    def unfocus
+      set_position @col * THUMBNAIL_SIZE, @row * THUMBNAIL_SIZE
+      set_size THUMBNAIL_SIZE, THUMBNAIL_SIZE
+      @@focus = nil
+    end
+  end
+end
+
+Clutter.init []
+
+picture_directory = GLib.get_user_special_dir :directory_pictures
+
+PhotoWall.create_for picture_directory
+
+Clutter.main

data/examples/main_loop.rb

@@ -1,12 +1,4 @@
 require 'gir_ffi'
 
 main_loop = GLib::MainLoop.new nil, false
-
-Signal.trap("INT") do
-  if main_loop.is_running
-    main_loop.quit
-  end
-  exit
-end
-
 main_loop.run

data/lib/ffi-glib/array.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/container_class_methods'
 require 'ffi-glib/array_methods'
 

data/lib/ffi-glib/array_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GLib
   # Common methods for GLib::Array and GLib::PtrArray
   module ArrayMethods

data/lib/ffi-glib/byte_array.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :ByteArray
 
 module GLib

data/lib/ffi-glib/bytes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :Bytes
 
 module GLib

data/lib/ffi-glib/container_class_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GLib
   # Common methods for container classes: Array, PtrArray, List, SList and
   # HashTable.

data/lib/ffi-glib/destroy_notify.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :DestroyNotify
 
 module GLib

data/lib/ffi-glib/error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :Error
 
 module GLib

data/lib/ffi-glib/hash_table.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/container_class_methods'
 
 GLib.load_class :HashTable
@@ -28,7 +29,7 @@ module GLib
     end
 
     def each
-      prc = proc do|keyptr, valptr, _userdata|
+      prc = proc do |keyptr, valptr, _userdata|
         key = GirFFI::ArgHelper.cast_from_pointer key_type, keyptr
         val = GirFFI::ArgHelper.cast_from_pointer value_type, valptr
         yield key, val

data/lib/ffi-glib/iconv.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :IConv
 
 module GLib

data/lib/ffi-glib/list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/list_methods'
 
 GLib.load_class :List

data/lib/ffi-glib/list_methods.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/container_class_methods'
 
 module GLib

data/lib/ffi-glib/main_loop.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'singleton'
 
 GLib.load_class :MainLoop

data/lib/ffi-glib/ptr_array.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/container_class_methods'
 require 'ffi-glib/array_methods'
 

data/lib/ffi-glib/s_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-glib/list_methods'
 
 GLib.load_class :SList

data/lib/ffi-glib/strv.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GLib
   # Extra methods for GLib::Strv. The bulk is defined in `gir_ffi-base/glib/strv.rb`
   class Strv

data/lib/ffi-glib/variant.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GLib.load_class :Variant
 
 module GLib

data/lib/ffi-glib.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/core'
 
 GirFFI.setup :GLib

data/lib/ffi-gobject/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Preload type contants
 module GObject
   TYPE_INVALID = type_from_name('invalid')

data/lib/ffi-gobject/closure.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GObject.load_class :Closure
 
 module GObject

data/lib/ffi-gobject/initially_unowned.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GObject.load_class :InitiallyUnowned
 
 module GObject

data/lib/ffi-gobject/object.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/property_not_found_error'
 
 GObject.load_class :Object

data/lib/ffi-gobject/object_class.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GObject.load_class :ObjectClass
 
 module GObject

data/lib/ffi-gobject/ruby_closure.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-gobject/closure'
 
 module GObject

data/lib/ffi-gobject/value.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 GObject.load_class :Value
 
 module GObject

data/lib/ffi-gobject.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/core'
 
 GirFFI.setup :GObject

data/lib/ffi-gobject_introspection/g_error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps GLib's GError struct.
   class GError

data/lib/ffi-gobject_introspection/i_arg_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-gobject_introspection/i_base_info'
 module GObjectIntrospection
   # Wraps a GIArgInfo struct.

data/lib/ffi-gobject_introspection/i_base_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps GIBaseInfo struct, the base \type for all info types.
   # Decendant types will be implemented as needed.

data/lib/ffi-gobject_introspection/i_callable_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-gobject_introspection/i_base_info'
 require 'ffi-gobject_introspection/i_type_info'
 require 'ffi-gobject_introspection/i_arg_info'
@@ -18,6 +19,10 @@ module GObjectIntrospection
       Lib.g_callable_info_may_return_null @gobj
     end
 
+    def can_throw_gerror?
+      Lib.g_callable_info_can_throw_gerror @gobj
+    end
+
     def n_args
       Lib.g_callable_info_get_n_args @gobj
     end

data/lib/ffi-gobject_introspection/i_callback_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GICallbackInfo struct. Has no methods in addition to the ones
   # inherited from ICallableInfo.

data/lib/ffi-gobject_introspection/i_constant_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIConstantInfo struct; represents a constant.
   class IConstantInfo < IBaseInfo

data/lib/ffi-gobject_introspection/i_enum_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIEnumInfo struct if it represents an enum.
   # If it represents a flag, an IFlagsInfo object is used instead.

data/lib/ffi-gobject_introspection/i_field_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIFieldInfo struct.
   # Represents a field of an IStructInfo or an IUnionInfo.
@@ -19,11 +20,11 @@ module GObjectIntrospection
     end
 
     def readable?
-      flags & 1 != 0
+      flags[:readable]
     end
 
     def writable?
-      flags & 2 != 0
+      flags[:writable]
     end
   end
 end

data/lib/ffi-gobject_introspection/i_flags_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIEnumInfo struct, if it represents a flag type.
   class IFlagsInfo < IEnumInfo

data/lib/ffi-gobject_introspection/i_function_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIFunctionInfo struct.
   # Represents a function or method.
@@ -10,29 +11,28 @@ module GObjectIntrospection
       Lib.g_function_info_get_flags @gobj
     end
 
-    # TODO: Use some sort of bitfield
     def method?
-      flags & 1 != 0
+      flags[:is_method]
     end
 
     def constructor?
-      flags & 2 != 0
+      flags[:is_constructor]
     end
 
     def getter?
-      flags & 4 != 0
+      flags[:is_getter]
     end
 
     def setter?
-      flags & 8 != 0
+      flags[:is_setter]
     end
 
     def wraps_vfunc?
-      flags & 16 != 0
+      flags[:wraps_vfunc]
     end
 
     def throws?
-      flags & 32 != 0
+      flags[:throws]
     end
   end
 end

data/lib/ffi-gobject_introspection/i_interface_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a IInterfaceInfo struct.
   # Represents an interface.

data/lib/ffi-gobject_introspection/i_object_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIObjectInfo struct.
   # Represents an object.

data/lib/ffi-gobject_introspection/i_property_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIPropertyInfo struct.
   # Represents a property of an IObjectInfo or an IInterfaceInfo.
@@ -11,19 +12,19 @@ module GObjectIntrospection
     end
 
     def readable?
-      flags & 1 != 0
+      flags[:readable]
     end
 
     def writeable?
-      flags & 2 != 0
+      flags[:writable]
     end
 
     def construct?
-      flags & 4 != 0
+      flags[:construct]
     end
 
     def construct_only?
-      flags & 8 != 0
+      flags[:construct_only]
     end
   end
 end

data/lib/ffi-gobject_introspection/i_registered_type_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIRegisteredTypeInfo struct.
   # Represents a registered type.

data/lib/ffi-gobject_introspection/i_repository.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'singleton'
 
 require 'ffi-gobject_introspection/lib'

data/lib/ffi-gobject_introspection/i_signal_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GISignalInfo struct.
   # Represents a signal.

data/lib/ffi-gobject_introspection/i_struct_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIStructInfo struct.
   # Represents a struct.

data/lib/ffi-gobject_introspection/i_type_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GITypeInfo struct.
   # Represents type information, direction, transfer etc.

data/lib/ffi-gobject_introspection/i_union_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIUnionInfo struct.
   # Represents a union.

data/lib/ffi-gobject_introspection/i_unresolved_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ffi-gobject_introspection/i_base_info'
 
 module GObjectIntrospection

data/lib/ffi-gobject_introspection/i_value_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIValueInfo struct.
   # Represents one of the enum values of an IEnumInfo.

data/lib/ffi-gobject_introspection/i_vfunc_info.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module GObjectIntrospection
   # Wraps a GIVFuncInfo struct.
   # Represents a virtual function.

data/lib/ffi-gobject_introspection/lib.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
 require 'ffi'
+require 'ffi/bit_masks'
 
 module GObjectIntrospection
   # Module for attaching functions from the girepository library
   module Lib
     extend FFI::Library
+    extend FFI::BitMasks
     ffi_lib 'girepository-1.0'
 
     # Helper class to support guessing the gobject-introspection version.
@@ -77,9 +80,16 @@ module GObjectIntrospection
     attach_function :g_base_info_equal, [:pointer, :pointer], :bool
 
     # IFunctionInfo
+    bit_mask :IFunctionInfoFlags,
+             is_method:      (1 << 0),
+             is_constructor: (1 << 1),
+             is_getter:      (1 << 2),
+             is_setter:      (1 << 3),
+             wraps_vfunc:    (1 << 4),
+             throws:         (1 << 5)
+
     attach_function :g_function_info_get_symbol, [:pointer], :string
-    # TODO: return type is bitfield
-    attach_function :g_function_info_get_flags, [:pointer], :int
+    attach_function :g_function_info_get_flags, [:pointer], :IFunctionInfoFlags
 
     # ICallableInfo
     enum :ITransfer, [
@@ -91,6 +101,7 @@ module GObjectIntrospection
     attach_function :g_callable_info_get_return_type, [:pointer], :pointer
     attach_function :g_callable_info_get_caller_owns, [:pointer], :ITransfer
     attach_function :g_callable_info_may_return_null, [:pointer], :bool
+    attach_function :g_callable_info_can_throw_gerror, [:pointer], :bool
     attach_function :g_callable_info_get_n_args, [:pointer], :int
     attach_function :g_callable_info_get_arg, [:pointer, :int], :pointer
     attach_function :g_callable_info_skip_return, [:pointer], :bool
@@ -176,12 +187,11 @@ module GObjectIntrospection
     attach_function :g_value_info_get_value, [:pointer], :long
 
     # IFieldInfo
-    enum :IFieldInfoFlags, [
-      :readable, (1 << 0),
-      :writable, (1 << 1)
-    ]
-    # TODO: return type is bitfield :IFieldInfoFlags
-    attach_function :g_field_info_get_flags, [:pointer], :int
+    bit_mask :IFieldInfoFlags,
+             readable: (1 << 0),
+             writable: (1 << 1)
+
+    attach_function :g_field_info_get_flags, [:pointer], :IFieldInfoFlags
     attach_function :g_field_info_get_size, [:pointer], :int
     attach_function :g_field_info_get_offset, [:pointer], :int
     attach_function :g_field_info_get_type, [:pointer], :pointer
@@ -290,8 +300,15 @@ module GObjectIntrospection
     # IPropertyInfo
     #
     attach_function :g_property_info_get_type, [:pointer], :pointer
-    # TODO: return type is bitfield
-    attach_function :g_property_info_get_flags, [:pointer], :int
+
+    # NOTE: This type has more values, but these are the ones used
+    bit_mask :ParamFlags,
+             readable:       (1 << 0),
+             writable:       (1 << 1),
+             construct:      (1 << 2),
+             construct_only: (1 << 3)
+
+    attach_function :g_property_info_get_flags, [:pointer], :ParamFlags
 
     ::GObjectIntrospection::VERSION = version_guesser.best_guess
   end

data/lib/ffi-gobject_introspection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi-base'
 
 GObject.type_init

data/lib/gir_ffi/allocation_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'gir_ffi/lib_c'
 
 module GirFFI