mvz/ruby-gir-ffi

View on GitHub
lib/gir_ffi/builders/user_defined_builder.rb

Summary

Maintainability
A
3 hrs
Test Coverage
# frozen_string_literal: true

require "gir_ffi/builders/object_builder"
require "gir_ffi/g_type"

module GirFFI
  module Builders
    # Implements the creation of GObject subclasses from Ruby.
    class UserDefinedBuilder < ObjectBuilder
      def initialize(info)
        @info = info
      end

      def setup_class
        check_ancestry
        setup_layout
        register_type
        setup_constants
        setup_property_accessors
        setup_initializer
        TypeBuilder::CACHE[@gtype] = klass
      end

      def target_gtype
        @gtype ||= klass.gtype
      end

      private

      def check_ancestry
        unless klass < GirFFI::ObjectBase
          raise ArgumentError, "#{klass} is not a GObject class"
        end
      end

      def register_type
        @gtype = GObject.type_register_static(parent_gtype.to_i,
                                              info.g_name,
                                              gobject_type_info, 0)
        included_interfaces.each do |interface|
          ifinfo = gobject_interface_info interface
          GObject.type_add_interface_static @gtype, interface.gtype, ifinfo
        end
      end

      def parent_info
        @info.parent
      end

      def parent_gtype
        @info.parent_gtype
      end

      def interface_gtypes
        included_interfaces.map { |interface| GType.new(interface.gtype) }
      end

      def included_interfaces
        klass.included_interfaces
      end

      def klass
        @klass ||= @info.described_class
      end

      def gobject_type_info
        GObject::TypeInfo.new.tap do |type_info|
          type_info.class_size = class_size
          type_info.instance_size = instance_size
          type_info.class_init = class_init_proc
        end
      end

      def gobject_interface_info(interface)
        GObject::InterfaceInfo.new.tap do |interface_info|
          interface_info.interface_init = interface_init_proc(interface)
        end
      end

      def class_init_proc
        proc do |type_class, _data|
          class_struct_ptr = type_class.to_ptr
          setup_properties class_struct_ptr
          setup_vfuncs class_struct_ptr
        end
      end

      def interface_init_proc(interface)
        proc do |type_interface, _data|
          interface_struct_ptr = type_interface.to_ptr
          setup_interface_vfuncs interface, interface_struct_ptr
        end
      end

      def instance_size
        if property_fields.any?
          last_property = property_fields.last
          size = last_property.offset
          type_size = FFI.type_size(last_property.ffi_type)
          size += [type_size, field_alignment].max
        else
          size = parent_gtype.instance_size
        end
        size
      end

      def class_size
        parent_gtype.class_size + interface_gtypes.sum(&:class_size)
      end

      def setup_properties(class_struct_ptr)
        class_struct = GObject::ObjectClass.wrap class_struct_ptr

        class_struct.struct[:get_property] = property_getter_func
        class_struct.struct[:set_property] = property_setter_func

        property_fields.each_with_index do |property, index|
          class_struct.install_property index + 1, property.param_spec
        end
      end

      def property_getter_func
        getter = proc do |object, _property_id, value, pspec|
          value.set_value object.send(pspec.accessor_name)
        end
        GObject::ObjectGetPropertyFunc.from getter
      end

      def property_setter_func
        setter = proc do |object, _property_id, value, pspec|
          object.send(:"#{pspec.accessor_name}=", value.get_value)
        end
        GObject::ObjectSetPropertyFunc.from setter
      end

      def setup_vfuncs(class_struct_ptr)
        super_class_struct =
          superclass.gir_ffi_builder.class_struct_class.wrap(class_struct_ptr)

        info.vfunc_implementations.each do |impl|
          setup_vfunc parent_info, super_class_struct, impl
        end
      end

      def setup_interface_vfuncs(interface, interface_struct_ptr)
        interface_builder = interface.gir_ffi_builder

        interface_struct = interface_builder.interface_struct.wrap(interface_struct_ptr)
        interface_info = interface_builder.info

        info.vfunc_implementations.each do |impl|
          setup_vfunc interface_info, interface_struct, impl
        end
      end

      def setup_vfunc(ancestor_info, ancestor_struct, impl)
        vfunc_name = impl.name
        vfunc_info = ancestor_info.find_vfunc vfunc_name.to_s
        return unless vfunc_info

        vfunc_class = VFuncBuilder.new(vfunc_info).build_class
        ancestor_struct.struct[vfunc_name] = vfunc_class.from(impl.implementation)
      end

      def properties
        @properties ||= info.properties
      end

      def layout_specification
        parent_spec = [:parent, superclass::Struct]

        fields_spec = property_fields.flat_map do |property_info|
          [property_info.field_symbol, property_info.ffi_type, property_info.offset]
        end

        parent_spec + fields_spec
      end

      def field_alignment
        @field_alignment ||= superclass::Struct.alignment
      end

      def setup_property_accessors
        property_fields.each do |field_info|
          FieldBuilder.new(field_info, klass).build
        end
      end

      def property_fields
        @property_fields ||=
          begin
            offset = parent_gtype.instance_size
            properties.map do |param_spec|
              field_info = UserDefinedPropertyInfo.new(param_spec, info, offset)
              type_size = FFI.type_size(field_info.ffi_type)
              offset += [type_size, field_alignment].max
              field_info
            end
          end
      end

      def method_introspection_data(_method)
        nil
      end
    end
  end
end