Module: GirFFI::InfoExt::ITypeInfo

Included in:
Builders::UserDefinedBuilder::UserDefinedPropertyFieldInfo::FieldTypeInfo, ErrorTypeInfo, ReceiverTypeInfo
Defined in:
lib/gir_ffi/info_ext/i_type_info.rb

Overview

Extensions for GObjectIntrospection::ITypeInfo needed by GirFFI

Constant Summary collapse

TAG_TO_WRAPPER_CLASS_MAP = 
{
  array:           'GLib::Array',
  byte_array:      'GLib::ByteArray',
  c:               'GirFFI::SizedArray',
  error:           'GLib::Error',
  ghash:           'GLib::HashTable',
  glist:           'GLib::List',
  gslist:          'GLib::SList',
  ptr_array:       'GLib::PtrArray',
  strv:            'GLib::Strv',
  utf8:            'GirFFI::InPointer', # TODO: Create a string-like class
  void:            'GirFFI::InPointer', # TODO: Create a void-pointer class
  zero_terminated: 'GirFFI::ZeroTerminated'
}.freeze
TAGS_NEEDING_RUBY_TO_C_CONVERSION = 
[
  :array, :c, :callback, :error, :ghash, :glist, :gslist, :object,
  :ptr_array, :struct, :strv, :utf8, :zero_terminated
].freeze
TAGS_NEEDING_C_TO_RUBY_CONVERSION = 
[
  :array, :byte_array, :c, :error, :filename, :ghash, :glist, :gslist,
  :interface, :object, :ptr_array, :struct, :strv, :union, :utf8,
  :zero_terminated
].freeze
GOBJECT_VALUE_NAME = 
'GObject::Value'.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.flattened_tag_to_gtype_map ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 9

def self.flattened_tag_to_gtype_map
  @flattened_tag_to_gtype_map ||= {
    [:array, true]     => GObject::TYPE_ARRAY,
    [:c, true]         => GObject::TYPE_POINTER,
    [:gboolean, false] => GObject::TYPE_BOOLEAN,
    [:ghash, true]     => GObject::TYPE_HASH_TABLE,
    [:glist, true]     => GObject::TYPE_POINTER,
    [:gint32, false]   => GObject::TYPE_INT,
    [:gint64, false]   => GObject::TYPE_INT64,
    [:guint64, false]  => GObject::TYPE_UINT64,
    [:strv, true]      => GObject::TYPE_STRV,
    [:utf8, true]      => GObject::TYPE_STRING,
    [:void, true]      => GObject::TYPE_POINTER,
    [:void, false]     => GObject::TYPE_NONE
  }.freeze
end

Instance Method Details

#argument_class_name ⇒ Object

TODO: Use class rather than class name



99
100
101
102
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 99

def argument_class_name
  interface_class_name ||
    TAG_TO_WRAPPER_CLASS_MAP[flattened_tag]
end

#element_type ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 35

def element_type
  case tag
  when :glist, :gslist, :array, :c
    enumerable_element_type
  when :ghash
    dictionary_element_type
  end
end

#extra_conversion_arguments ⇒ Object 



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 186

def extra_conversion_arguments
  case flattened_tag
  when :c
    [element_type, array_fixed_size]
  when :array, :ghash, :glist, :gslist, :ptr_array, :zero_terminated
    [element_type]
  else
    []
  end
end

#flattened_tag ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 44

def flattened_tag
  case tag
  when :interface
    interface_type
  when :array
    flattened_array_type
  else
    tag
  end
end

#gtype ⇒ Object 



26
27
28
29
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 26

def gtype
  return interface.gtype if tag == :interface
  ITypeInfo.flattened_tag_to_gtype_map.fetch [flattened_tag, pointer?]
end

#gvalue? ⇒ Boolean

Returns:



199
200
201
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 199

def gvalue?
  argument_class_name == GOBJECT_VALUE_NAME
end

#hidden_struct_type? ⇒ Boolean

Returns:



59
60
61
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 59

def hidden_struct_type?
  flattened_tag == :struct && interface.size.zero?
end

#interface_class ⇒ Object 



79
80
81
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 79

def interface_class
  Builder.build_class interface if tag == :interface
end

#interface_class_name ⇒ Object 



104
105
106
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 104

def interface_class_name
  interface.full_type_name if tag == :interface
end

#interface_type ⇒ Object 



55
56
57
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 55

def interface_type
  tag == :interface && interface.info_type
end

#make_g_value ⇒ Object 



31
32
33
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 31

def make_g_value
  GObject::Value.for_gtype gtype
end

#needs_c_to_ruby_conversion_for_callbacks? ⇒ Boolean

Returns:



165
166
167
168
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 165

def needs_c_to_ruby_conversion_for_callbacks?
  [:callback, :enum].include?(flattened_tag) ||
    needs_c_to_ruby_conversion_for_functions?
end

#needs_c_to_ruby_conversion_for_closures? ⇒ Boolean

Returns:



170
171
172
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 170

def needs_c_to_ruby_conversion_for_closures?
  [:array, :c, :ghash, :glist, :struct, :strv].include?(flattened_tag)
end

#needs_c_to_ruby_conversion_for_functions? ⇒ Boolean

Returns:



156
157
158
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 156

def needs_c_to_ruby_conversion_for_functions?
  TAGS_NEEDING_C_TO_RUBY_CONVERSION.include?(flattened_tag)
end

#needs_c_to_ruby_conversion_for_properties? ⇒ Boolean

Returns:



182
183
184
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 182

def needs_c_to_ruby_conversion_for_properties?
  [:glist, :ghash, :callback].include?(flattened_tag)
end

#needs_ruby_to_c_conversion_for_callbacks? ⇒ Boolean

Returns:



160
161
162
163
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 160

def needs_ruby_to_c_conversion_for_callbacks?
  [:enum].include?(flattened_tag) ||
    needs_ruby_to_c_conversion_for_functions?
end

#needs_ruby_to_c_conversion_for_closures? ⇒ Boolean

Returns:



174
175
176
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 174

def needs_ruby_to_c_conversion_for_closures?
  [:array].include?(flattened_tag)
end

#needs_ruby_to_c_conversion_for_functions? ⇒ Boolean

Returns:



152
153
154
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 152

def needs_ruby_to_c_conversion_for_functions?
  TAGS_NEEDING_RUBY_TO_C_CONVERSION.include?(flattened_tag)
end

#needs_ruby_to_c_conversion_for_properties? ⇒ Boolean

Returns:



178
179
180
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 178

def needs_ruby_to_c_conversion_for_properties?
  [:glist, :ghash, :strv, :callback].include?(flattened_tag)
end

#tag_or_class ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 63

def tag_or_class
  base = case tag
         when :interface
           interface_class
         when :ghash
           [tag, *element_type]
         else
           flattened_tag
         end
  if pointer? && tag != :utf8 && tag != :filename
    [:pointer, base]
  else
    base
  end
end

#to_callback_ffi_type ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 121

def to_callback_ffi_type
  return :pointer if pointer?

  case tag
  when :interface
    # TODO: Move this logic into interface
    case interface.info_type
    when :enum, :flags
      :int32
    else
      :pointer
    end
  when :gboolean
    # TODO: Move this logic into TypeMap
    :bool
  else
    TypeMap.map_basic_type tag
  end
end

#to_ffi_type ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/gir_ffi/info_ext/i_type_info.rb', line 108

def to_ffi_type
  return :pointer if pointer?

  case tag
  when :interface
    interface.to_ffi_type
  when :array
    [subtype_ffi_type(0), array_fixed_size]
  else
    TypeMap.map_basic_type tag
  end
end