ffi 1.16.3 → 1.17.0-java

data/sig/ffi/struct.rbs

@@ -0,0 +1,76 @@
+module FFI
+  class Struct[out P < AbstractMemory, unchecked out E]
+    type layout = Library::ffi_lib_type | singleton(StructLayout::Field) | [layout, Integer]
+
+    type ptr = Type::Mapped[
+      StructByReference[Struct[AbstractMemory, untyped], AbstractMemory],
+      AbstractMemory, instance, untyped
+    ]
+    def self.ptr: (?untyped flags) -> ptr # https://github.com/ffi/ffi/issues/1073
+    alias self.by_ref self.ptr
+    def self.in: () -> ptr
+    def self.out: () -> ptr
+    def self.val: () -> StructByValue[singleton(Struct)]
+    alias self.by_value self.val
+
+    alias self.alloc_inout self.new
+    alias self.alloc_in self.new
+    alias self.alloc_out self.new
+    alias self.new_inout self.new
+    alias self.new_in self.new
+    alias self.new_out self.new
+
+    def self.auto_ptr: () -> Type::Mapped[
+        ManagedStructConverter[ManagedStruct[AutoPointer, untyped], AutoPointer],
+        Pointer, instance, untyped
+      ]
+    def self.layout: (*layout | Integer) -> StructLayout
+              | (Hash[Symbol, layout]) -> StructLayout
+    def self.size=: (Integer size) -> Integer
+
+    def self?.alignment: () -> Integer
+    def self?.members: () -> Array[Symbol]
+    def self?.offset_of: (Symbol name) -> Integer
+    def self?.offsets: () -> Array[[Symbol, Integer]]
+    def self?.size: -> Integer
+
+    def initialize: (?P pointer, *layout args) -> void
+    def []: (Symbol field_name) -> E
+    def []=: (Symbol field_name, E value) -> E
+    alias align alignment
+    def clear: () -> self
+    def layout: () -> StructLayout
+    def null?: () -> bool
+    def order: (AbstractMemory::order_in order) -> Struct[P, E]
+              | () -> AbstractMemory::order_out
+    def pointer: () -> P
+    alias to_ptr pointer
+    def values: () -> Array[E]
+
+    class InlineArray[out P < AbstractMemory, unchecked out E]
+      include Enumerable[E]
+      include AbstractMemory::_Size
+
+      def initialize: (P memory, StructLayout::Field field) -> self
+      def []: (Integer index) -> E
+      def []=: (Integer index, E value) -> E
+      def each: () { (E) -> void } -> self
+      def to_a: () -> Array[E]
+      def to_ptr: () -> P
+    end
+
+    class ManagedStructConverter[S < ManagedStruct[P, untyped], P < AutoPointer] < StructByReference[S, P]
+      def initialize: ...
+      def from_native: (Pointer ptr, untyped ctx) -> S
+    end
+  end
+
+  class ManagedStruct[out P < AutoPointer, unchecked out E] < Struct[P, E]
+    def self.release: (AbstractMemory ptr) -> void
+    def initialize: (Pointer pointer) -> self
+  end
+
+  class Union[out P < AbstractMemory, unchecked out E] < Struct[P, E]
+    def self.builder: () -> StructLayoutBuilder
+  end
+end

data/sig/ffi/struct_by_reference.rbs

@@ -0,0 +1,11 @@
+module FFI
+  class StructByReference[S < Struct[P, untyped], P < AbstractMemory]
+    include DataConverter[P, S, untyped]
+    attr_reader struct_class: Struct[P, untyped]
+
+    def initialize: (S struct_class) -> void
+    def from_native: (P value, untyped ctx) -> S
+    def native_type: () -> Type::Builtin
+    def to_native: (S? value, untyped ctx) -> P
+  end
+end

data/sig/ffi/struct_by_value.rbs

@@ -0,0 +1,7 @@
+module FFI
+  class StructByValue[C < singleton(Struct)] < Type
+    def initialize: (C) -> self
+    def layout: () -> StructLayout
+    def struct_class: () -> C
+  end
+end

data/sig/ffi/struct_layout.rbs

@@ -0,0 +1,9 @@
+module FFI
+  class StructLayout
+    #TODO
+
+    class Field
+      #TODO
+    end
+  end
+end

data/sig/ffi/struct_layout_builder.rbs

@@ -0,0 +1,5 @@
+module FFI
+  class StructLayoutBuilder
+    #TODO
+  end
+end

data/sig/ffi/type.rbs

@@ -0,0 +1,39 @@
+module FFI
+  class Type
+    class Array = ArrayType
+    class Function = FunctionType
+    class Struct = StructByValue
+
+    include AbstractMemory::_Size
+    def initialize: (Integer | Type value) -> self
+    def alignment: () -> Integer
+    def inspect: ...
+
+    class Builtin < Type
+      def inspect: ...
+    end
+
+    class Mapped[X < _DataConverter[N, R, C], N, R, C]
+      include _DataConverter[N, R, C]
+
+      def initialize: (X converter) -> self
+      def converter: () -> X
+    end
+  end
+
+  class ArrayType
+    def initialize: (Type component_type, Integer length) -> self
+    def element_type: -> Type
+    def length: -> Integer
+  end
+
+  class FunctionType < Type
+    def initialize:
+      (
+        ffi_type return_type, Array[ffi_type] param_types,
+        ?blocking: boolish, ?convention: Library::convention, ?enums: Enums
+      ) -> self
+    def param_types: () -> Array[Type]
+    def return_type: () -> Type
+  end
+end

data/sig/ffi.rbs

@@ -0,0 +1,26 @@
+module FFI
+  type ffi_type = Type | Symbol
+  type ffi_auto_type = ffi_type | DataConverter[untyped, untyped, untyped]
+  type type_map = Hash[Symbol | DataConverter[untyped, untyped, untyped], Type]
+
+  class CallbackInfo = FunctionType
+  class FunctionInfo = FunctionType
+  class NativeLibrary = DynamicLibrary
+
+  VERSION: String
+  TypeDefs: type_map
+
+  type current_process = Object
+  CURRENT_PROCESS: current_process
+  USE_THIS_PROCESS_AS_LIBRARY: current_process
+
+  private def self.custom_typedefs: () -> type_map
+  def self.errno: () -> Integer
+  def self.errno=: (Integer) -> nil
+  def self.find_type: (ffi_auto_type name, ?type_map? type_map) -> Type
+  def self.make_shareable: [T] (T obj) -> T
+  def self.map_library_name: (_ToS lib) -> String
+  def self.type_size: (ffi_auto_type type) -> Integer
+  def self.typedef: (ffi_auto_type old, Symbol add) -> Type
+  alias self.add_typedef self.typedef
+end