ffi 1.17.0.rc1-x86_64-darwin

data/sig/ffi/data_converter.rbs

@@ -0,0 +1,10 @@
+module FFI
+  interface _DataConverter[N, R, in C]
+    def from_native: (N value, C ctx) -> R
+    def native_type: (?ffi_auto_type? type) -> Type
+    def to_native: (R value, C ctx) -> N
+  end
+  module DataConverter[N, R, in C]
+    include _DataConverter[N, R, C]
+  end
+end

data/sig/ffi/dynamic_library.rbs

@@ -0,0 +1,9 @@
+module FFI
+  class DynamicLibrary
+    # TODO
+
+    class Symbol < Pointer
+      # TODO
+    end
+  end
+end

data/sig/ffi/enum.rbs

@@ -0,0 +1,38 @@
+module FFI
+  class Enums
+    def initialize: () -> void
+
+    def <<: (Enum enum) -> void
+    def __map_symbol: (Symbol symbol) -> Integer?
+    def find: (Symbol query) -> Enum
+  end
+
+  class Enum
+    include DataConverter[Integer, Symbol | Integer, untyped]
+
+    attr_reader native_type: Type
+    attr_reader tag: Symbol?
+    def initialize: (Enumerable[Symbol | Integer], ?Symbol? tag, *untyped) -> void
+                  | (Type native_type, Enumerable[Symbol | Integer], ?Symbol? tag, *untyped) -> void
+
+    def []: (Symbol query) -> Integer?
+          | (Integer query) -> Symbol?
+    def symbol_map: () -> Hash[Symbol, Integer]
+    alias to_h symbol_map
+    alias to_hash symbol_map
+    def symbols: () -> Array[Symbol]
+    def to_native: (Symbol | int value, untyped ctx) -> Integer
+  end
+
+  class Bitmask < Enum
+    def initialize: ...
+
+    def []: (*Symbol query) -> Integer
+          | (Array[Symbol] query) -> Integer
+          | (*Integer query) -> Array[Symbol]
+          | (Array[Integer] query) -> Array[Symbol]
+    def from_native: (Integer, untyped ctx) -> Array[Symbol | Integer]
+    def to_native: (Array[Symbol | int] value, untyped ctx) -> Integer
+                 | ...
+  end
+end

data/sig/ffi/function.rbs

@@ -0,0 +1,39 @@
+module FFI
+  interface _Function
+    # TODO: leads to a endless recursion when used with -rrbs/test/setup
+    # def attach: (Module mod, String name) -> self
+    def call: (*untyped args) -> untyped
+    def param_types: () -> Array[Type]
+    def return_type: () -> Type
+  end
+
+  class Function < Pointer
+    include _Function
+    # ?blocking: boolish?, ?convention: Library::convention?, ?enums: Enums?
+    def initialize:
+      (
+        ffi_type return_type, Array[ffi_type] param_types,
+        ?Hash[Symbol, untyped] options
+      ) { (*untyped) -> untyped } -> self
+    | (
+        ffi_type return_type, Array[ffi_type] param_types, Proc | Pointer proc,
+        ?Hash[Symbol, untyped] options
+      ) -> self
+
+    def autorelease?: ...
+    alias autorelease autorelease?
+    def autorelease=: ...
+    def free: () -> self
+  end
+
+  class VariadicInvoker
+    include _Function
+    def initialize:
+      (
+        Pointer function, Array[ffi_type] parameter_types, ffi_type return_type,
+        Hash[Symbol, untyped] options #TODO
+      ) -> void
+
+    def invoke: (Array[Type] parameter_types, Array[untyped] parameter_values) -> untyped
+  end
+end

data/sig/ffi/library.rbs

@@ -0,0 +1,42 @@
+module FFI
+  module Library
+    type convention = :default | :stdcall
+    type ffi_lib_flag = :global | :local | :lazy | :now
+    type ffi_lib_type = ffi_auto_type | singleton(Struct)
+
+    CURRENT_PROCESS: current_process
+    LIBC: String
+    FlagsMap: Hash[ffi_lib_flag, Integer]
+
+    def self.extended: ...
+
+    def attach_function: (           _ToS func, Array[ffi_lib_type] args,  ffi_lib_type? returns, ?blocking: boolish, ?convention: convention, ?enums: Enums, ?type_map: type_map) -> (Function | VariadicInvoker)
+                       | (_ToS name, _ToS func, Array[ffi_lib_type] args, ?ffi_lib_type? returns, ?blocking: boolish, ?convention: convention, ?enums: Enums, ?type_map: type_map) -> (Function | VariadicInvoker)
+    def attach_variable: (?_ToS mname, _ToS cname, ffi_lib_type type) -> DynamicLibrary::Symbol
+    def attached_functions: () -> Hash[Symbol, Function | VariadicInvoker]
+    def attached_variables: () -> Hash[Symbol, Type | singleton(Struct)]
+
+    def bitmask: (?Type native_type, Symbol name, Array[Symbol | Integer] values) -> Bitmask
+               | (?Type native_type, *Symbol | Integer args) -> Bitmask
+               | (?Type native_type, Array[Symbol | Integer] values) -> Bitmask
+    def enum: (?Type native_type, Symbol name, Array[Symbol | Integer] values) -> Enum
+            | (?Type native_type, *Symbol | Integer args) -> Enum
+            | (?Type native_type, Array[Symbol | Integer] values) -> Enum
+    def enum_type: (Symbol name) -> Enum?
+    def enum_for: (Symbol name) -> Integer?
+
+    def callback: (?Symbol name, Array[ffi_lib_type] params, ffi_lib_type ret) -> CallbackInfo
+    def ffi_convention: (?convention? convention) -> convention
+    def ffi_lib: (*_ToS names) -> Array[DynamicLibrary]
+    def ffi_lib_flags: (*ffi_lib_flag flags) -> Integer
+    def ffi_libraries: () -> Array[DynamicLibrary]
+    def find_type: (ffi_lib_type t) -> Type
+    def freeze: () -> void
+    def function_names: (_ToS name, Array[Type | singleton(Struct)] arg_types) -> Array[String]
+    def typedef: [T < Type] (T old, Symbol | DataConverter add, ?untyped) -> T
+               | (Symbol old, Symbol add, ?untyped) -> (Type | Enum)
+               | [X < DataConverter[N, R, C], N, R, C] (X old, Symbol add, ?untyped) -> Type::Mapped[X, N, R, C]
+               | (:enum old, Array[Symbol | Integer] add, ?untyped) -> Enum
+               | (:enum old, Symbol | Type add, Array[Symbol | Integer] info) -> Enum
+  end
+end

data/sig/ffi/native_type.rbs

@@ -0,0 +1,86 @@
+module FFI
+  class Type
+    INT8: Builtin
+    SCHAR: Builtin
+    CHAR: Builtin
+    UINT8: Builtin
+    UCHAR: Builtin
+    INT16: Builtin
+    SHORT: Builtin
+    SSHORT: Builtin
+    UINT16: Builtin
+    USHORT: Builtin
+    INT32: Builtin
+    INT: Builtin
+    SINT: Builtin
+    UINT32: Builtin
+    UINT: Builtin
+    INT64: Builtin
+    LONG_LONG: Builtin
+    SLONG_LONG: Builtin
+    UINT64: Builtin
+    ULONG_LONG: Builtin
+    LONG: Builtin
+    SLONG: Builtin
+    ULONG: Builtin
+    FLOAT32: Builtin
+    FLOAT: Builtin
+    FLOAT64: Builtin
+    DOUBLE: Builtin
+    LONGDOUBLE: Builtin
+    POINTER: Builtin
+    BOOL: Builtin
+    STRING: Builtin
+    BUFFER_IN: Builtin
+    BUFFER_OUT: Builtin
+    BUFFER_INOUT: Builtin
+    VARARGS: Builtin
+    VOID: Builtin
+  end
+
+  module NativeType
+    INT8: Type::Builtin
+    UINT8: Type::Builtin
+    INT16: Type::Builtin
+    UINT16: Type::Builtin
+    INT32: Type::Builtin
+    UINT32: Type::Builtin
+    INT64: Type::Builtin
+    UINT64: Type::Builtin
+    LONG: Type::Builtin
+    ULONG: Type::Builtin
+    FLOAT32: Type::Builtin
+    FLOAT64: Type::Builtin
+    LONGDOUBLE: Type::Builtin
+    POINTER: Type::Builtin
+    BOOL: Type::Builtin
+    STRING: Type::Builtin
+    BUFFER_IN: Type::Builtin
+    BUFFER_OUT: Type::Builtin
+    BUFFER_INOUT: Type::Builtin
+    VARARGS: Type::Builtin
+    VOID: Type::Builtin
+  end
+
+  TYPE_INT8: Type::Builtin
+  TYPE_UINT8: Type::Builtin
+  TYPE_INT16: Type::Builtin
+  TYPE_UINT16: Type::Builtin
+  TYPE_INT32: Type::Builtin
+  TYPE_UINT32: Type::Builtin
+  TYPE_INT64: Type::Builtin
+  TYPE_UINT64: Type::Builtin
+  TYPE_LONG: Type::Builtin
+  TYPE_ULONG: Type::Builtin
+  TYPE_FLOAT32: Type::Builtin
+  TYPE_FLOAT64: Type::Builtin
+  TYPE_LONGDOUBLE: Type::Builtin
+  TYPE_POINTER: Type::Builtin
+  TYPE_BOOL: Type::Builtin
+  TYPE_STRING: Type::Builtin
+  TYPE_BUFFER_IN: Type::Builtin
+  TYPE_BUFFER_OUT: Type::Builtin
+  TYPE_BUFFER_INOUT: Type::Builtin
+  TYPE_VARARGS: Type::Builtin
+  TYPE_VOID: Type::Builtin
+end

data/sig/ffi/pointer.rbs

@@ -0,0 +1,42 @@
+module FFI
+  type pointer = Pointer::_ToPtr? | Integer
+  class Pointer < AbstractMemory
+    interface _ToPtr
+      def to_ptr: () -> Pointer
+    end
+    include _ToPtr
+
+    SIZE: Integer
+    NULL: Pointer
+    def self.size: () -> Integer
+
+    def initialize: (?AbstractMemory::type_size type, (Pointer | Integer) address) -> void
+    def +: (Integer offset) -> Pointer
+    def ==: (Pointer? other) -> bool
+    def address: () -> Integer
+    alias to_i address
+    def autorelease?: () -> bool
+    def autorelease=: (boolish autorelease) -> boolish
+    def free: () -> self
+    def inspect: ...
+    def null?: () -> bool
+    def order: () -> AbstractMemory::order_out
+             | (AbstractMemory::order_in) -> Pointer
+    def read: (ffi_type type) -> top
+    def read_array_of_type: (ffi_auto_type type, Symbol reader, Integer length) -> Array[top]
+    def read_string: (?Integer? len) -> String
+    def read_string_length: (Integer len) -> String
+    def read_string_to_null: () -> String
+    def slice: (Integer offset, Integer length) -> Pointer
+    def type_size: () -> Integer
+    def write: (ffi_type type, top value) -> nil
+    def write_array_of_type: (ffi_auto_type type, Symbol writer, Array[top]) -> self
+    def write_string: (String str, ?Integer? len) -> self
+    def write_string_length: (String str, Integer len) -> self
+  end
+
+  class MemoryPointer < Pointer
+    def initialize: (AbstractMemory::type_size size, ?Integer count, ?boolish clear) -> self
+    def self.from_string: (String s) -> instance
+  end
+end

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