gir_ffi 0.6.6 → 0.6.7

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -0,0 +1,50 @@
+require 'gir_ffi/builders/base_type_builder'
+require 'gir_ffi/class_base'
+
+module GirFFI
+  module Builders
+    # Base class for type builders building types specified by subtypes
+    # of IRegisteredTypeInfo. These are types whose C representation is
+    # complex, i.e., a struct or a union.
+    class RegisteredTypeBuilder < BaseTypeBuilder
+      private
+
+      def target_gtype
+        info.g_type
+      end
+
+      # TODO: Rename the created method, or use a constant.
+      # FIXME: Only used in some of the subclases. Make mixin?
+      def setup_gtype_getter
+        gtype = target_gtype
+        return if gtype.nil?
+        @klass.instance_eval "
+          def self.get_gtype
+            #{gtype}
+          end
+        "
+      end
+
+      # FIXME: Only used in some of the subclases. Make mixin?
+      def provide_constructor
+        return if info.find_method 'new'
+
+        (class << @klass; self; end).class_eval {
+          alias_method :new, :_allocate
+        }
+      end
+
+      def parent
+        nil
+      end
+
+      def fields
+        info.fields
+      end
+
+      def superclass
+        ClassBase
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -0,0 +1,68 @@
+require 'gir_ffi/builders/base_argument_builder'
+
+module GirFFI
+  module Builders
+    # Implements building post-processing statements for return values.
+    class ReturnValueBuilder < BaseArgumentBuilder
+      def initialize var_gen, type_info, is_constructor = false, skip = false
+        super var_gen, nil, type_info, :return
+        @is_constructor = is_constructor
+        @skip = skip
+      end
+
+      def post
+        if has_conversion?
+          [ "#{retname} = #{post_conversion}" ]
+        else
+          []
+        end
+      end
+
+      def inarg
+        nil
+      end
+
+      def retval
+        if has_conversion?
+          super
+        elsif is_relevant?
+          callarg
+        else
+          nil
+        end
+      end
+
+      def is_relevant?
+        !is_void_return_value? && !@skip
+      end
+
+      private
+
+      def has_conversion?
+        is_closure || needs_outgoing_parameter_conversion? || needs_constructor_wrap?
+      end
+
+      def post_conversion
+        if is_closure
+          "GirFFI::ArgHelper::OBJECT_STORE[#{callarg}.address]"
+        elsif needs_constructor_wrap?
+          "self.constructor_wrap(#{callarg})"
+        else
+          outgoing_conversion callarg
+        end
+      end
+
+      def retname
+        @retname ||= @var_gen.new_var
+      end
+
+      def needs_constructor_wrap?
+        @is_constructor && [ :interface, :object ].include?(specialized_type_tag)
+      end
+
+      def is_void_return_value?
+        specialized_type_tag == :void && !type_info.pointer?
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/signal_builder.rb

@@ -0,0 +1,91 @@
+require 'gir_ffi/builders/base_type_builder'
+require 'gir_ffi/builders/mapping_method_builder'
+require 'gir_ffi/signal_base'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a signal module for handling a particular
+    # signal. The type will be attached to the appropriate class.
+    class SignalBuilder < BaseTypeBuilder
+      class SignalReceiverTypeInfo
+        include InfoExt::ITypeInfo
+
+        def initialize interface_info
+          @interface_info = interface_info
+        end
+
+        def interface
+          @interface_info
+        end
+
+        def tag
+          :interface
+        end
+      end
+
+      class SignalReceiverArgumentInfo
+        attr_reader :argument_type
+
+        def initialize type
+          @argument_type = type
+        end
+
+        def closure
+          -1
+        end
+      end
+
+      class UserDataTypeInfo
+        include InfoExt::ITypeInfo
+
+        def tag
+          :void
+        end
+
+        def pointer?
+          true
+        end
+      end
+
+      class UserDataArgumentInfo
+        attr_reader :argument_type
+        attr_reader :closure
+        def initialize type, position
+          @argument_type = type
+          @closure = position
+        end
+      end
+
+      def instantiate_class
+        @klass ||= get_or_define_module container_class, @classname
+        unless already_set_up
+          @klass.extend SignalBase
+          setup_constants
+          @klass.class_eval mapping_method_definition
+        end
+        @klass
+      end
+
+      def mapping_method_definition
+        arg_infos = info.args
+
+        container_type_info = SignalReceiverTypeInfo.new(container_info)
+        arg_infos.unshift SignalReceiverArgumentInfo.new(container_type_info)
+
+        user_data_type_info = UserDataTypeInfo.new
+        user_data_argument_info = UserDataArgumentInfo.new(user_data_type_info, arg_infos.length)
+        arg_infos.push user_data_argument_info
+
+        MappingMethodBuilder.new(arg_infos, info.return_type).method_definition
+      end
+
+      def container_class
+        @container_class ||= Builder.build_class(container_info)
+      end
+
+      def container_info
+        @container_info ||= info.container
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/struct_builder.rb

@@ -0,0 +1,35 @@
+require 'gir_ffi/builders/registered_type_builder'
+require 'gir_ffi/builders/with_layout'
+require 'gir_ffi/builders/with_methods'
+require 'gir_ffi/struct_base'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a class representing a Struct.
+    class StructBuilder < RegisteredTypeBuilder
+      include WithMethods
+      include WithLayout
+
+      private
+
+      def setup_class
+        setup_layout
+        setup_constants
+        stub_methods
+        setup_gtype_getter
+        setup_field_accessors
+        provide_constructor
+      end
+
+      # FIXME: Private method only in subclass
+      def layout_superclass
+        # FIXME: Is this needed now that StructBase is a DataConverter?
+        GirFFI::Struct
+      end
+
+      def superclass
+        StructBase
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/type_builder.rb

@@ -0,0 +1,40 @@
+require 'gir_ffi/builders/callback_builder'
+require 'gir_ffi/builders/constant_builder'
+require 'gir_ffi/builders/enum_builder'
+require 'gir_ffi/builders/interface_builder'
+require 'gir_ffi/builders/object_builder'
+require 'gir_ffi/builders/struct_builder'
+require 'gir_ffi/builders/signal_builder'
+require 'gir_ffi/builders/unintrospectable_builder'
+require 'gir_ffi/builders/union_builder'
+
+module GirFFI
+  module Builders
+    # Builds a class based on information found in the introspection
+    # repository.
+    module TypeBuilder
+      CACHE = {}
+
+      TYPE_MAP = {
+        :callback => CallbackBuilder,
+        :constant => ConstantBuilder,
+        :enum => EnumBuilder,
+        :flags => EnumBuilder,
+        :interface => InterfaceBuilder,
+        :object => ObjectBuilder,
+        :struct => StructBuilder,
+        :union => UnionBuilder,
+        :unintrospectable => UnintrospectableBuilder
+      }
+
+      def self.build info
+        TYPE_MAP[info.info_type].new(info).build_class
+      end
+
+      # TODO: Pull up to include :function and :module
+      def self.builder_for info
+        TYPE_MAP[info.info_type].new(info)
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/unintrospectable_builder.rb

@@ -0,0 +1,35 @@
+require 'gir_ffi/builders/object_builder'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a class representing an object type for
+    # which no data is found in the GIR. Typically, these are created to
+    # cast objects returned by a function that returns an interface.
+    class UnintrospectableBuilder < ObjectBuilder
+      def instantiate_class
+        gtype = target_gtype
+        TypeBuilder::CACHE[gtype] ||= Class.new(superclass)
+        @klass = TypeBuilder::CACHE[gtype]
+        @structklass = get_or_define_class @klass, :Struct, layout_superclass
+        setup_class unless already_set_up
+      end
+
+      def setup_class
+        setup_constants
+        setup_layout
+        setup_interfaces
+        setup_gtype_getter
+      end
+
+      def setup_instance_method method
+        false
+      end
+
+      private
+
+      def signal_definers
+        info.interfaces
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/union_builder.rb

@@ -0,0 +1,34 @@
+require 'gir_ffi/builders/registered_type_builder'
+require 'gir_ffi/builders/with_layout'
+require 'gir_ffi/builders/with_methods'
+require 'gir_ffi/union_base'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a class representing union type. The
+    # class will have a nested FFI::Union class to represent its C union.
+    class UnionBuilder < RegisteredTypeBuilder
+      include WithMethods
+      include WithLayout
+
+      def layout_superclass
+        FFI::Union
+      end
+
+      private
+
+      def setup_class
+        setup_layout
+        setup_constants
+        stub_methods
+        setup_gtype_getter
+        setup_field_accessors
+        provide_constructor
+      end
+
+      def superclass
+        UnionBase
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -0,0 +1,103 @@
+require 'gir_ffi/builders/object_builder'
+
+module GirFFI
+  module Builders
+    # Implements the creation of GObject subclasses from Ruby.
+    class UserDefinedBuilder < ObjectBuilder
+      def initialize info
+        @info = info
+      end
+
+      def instantiate_class
+        @klass = @info.described_class
+
+        parent_type = @klass.get_gtype
+        @parent = gir.find_by_gtype(parent_type)
+
+        query_result = GObject.type_query parent_type
+        type_info = GObject::TypeInfo.new
+        type_info.class_size = query_result.class_size
+        type_info.instance_size = query_result.instance_size
+        properties.each do
+          type_info.instance_size += FFI.type_size(:int32)
+        end
+
+        @gtype = GObject.type_register_static(parent_type, @klass.name,
+                                              type_info, 0)
+
+        @structklass = get_or_define_class @klass, :Struct, layout_superclass
+        setup_class unless already_set_up
+        TypeBuilder::CACHE[@gtype] = @klass
+      end
+
+      def setup_class
+        setup_layout
+        setup_constants
+        #stub_methods
+        setup_gtype_getter
+        setup_property_accessors
+        #setup_vfunc_invokers
+        #setup_interfaces
+        setup_constructor
+      end
+
+      private
+
+      def target_gtype
+        @gtype
+      end
+
+      def parent
+        @parent
+      end
+
+      def properties
+        info.properties
+      end
+
+      def layout_specification
+        parent_spec = [:parent, superclass::Struct, 0]
+        offset = superclass::Struct.size
+        fields_spec = properties.map do |pinfo|
+          spec = [pinfo.name.to_sym, :int32, offset]
+          offset += FFI.type_size(:int32)
+          spec
+        end.flatten(1)
+        parent_spec + fields_spec
+      end
+
+      def setup_property_accessors
+        properties.each do |pinfo|
+          setup_accessors_for_param_info pinfo
+        end
+      end
+
+      def setup_accessors_for_param_info pinfo
+        code = <<-CODE
+        def #{pinfo.name}
+          @struct[:#{pinfo.name}]
+        end
+        def #{pinfo.name}= val
+          @struct[:#{pinfo.name}] = val
+        end
+        CODE
+
+        @klass.class_eval code
+      end
+
+      def method_introspection_data method
+        nil
+      end
+
+      def setup_constructor
+        code = <<-CODE
+        def self.new
+          gptr = GObject::Lib.g_object_newv #{@gtype}, 0, nil
+          self.wrap(gptr)
+        end
+        CODE
+        @klass.class_eval code
+      end
+    end
+  end
+end