ffi 1.17.0.rc1-x86_64-darwin

data/lib/ffi/platform.rb

@@ -0,0 +1,187 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+#
+# This file is part of ruby-ffi.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Ruby FFI project nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.#
+
+require 'rbconfig'
+require_relative 'compat'
+
+module FFI
+  class PlatformError < LoadError; end
+
+  # This module defines different constants and class methods to play with
+  # various platforms.
+  module Platform
+    OS = FFI.make_shareable(case RbConfig::CONFIG['host_os'].downcase
+    when /linux/
+      "linux"
+    when /darwin/
+      "darwin"
+    when /freebsd/
+      "freebsd"
+    when /netbsd/
+      "netbsd"
+    when /openbsd/
+      "openbsd"
+    when /dragonfly/
+      "dragonflybsd"
+    when /sunos|solaris/
+      "solaris"
+    when /mingw|mswin/
+      "windows"
+    else
+      RbConfig::CONFIG['host_os'].downcase
+    end)
+
+    OSVERSION = RbConfig::CONFIG['host_os'].gsub(/[^\d]/, '').to_i
+
+    CPU = FFI.make_shareable(RbConfig::CONFIG['host_cpu'])
+
+    ARCH = FFI.make_shareable(case CPU.downcase
+    when /amd64|x86_64|x64/
+      "x86_64"
+    when /i\d86|x86|i86pc/
+      "i386"
+    when /ppc64|powerpc64/
+      "powerpc64"
+    when /ppc|powerpc/
+      "powerpc"
+    when /sparcv9|sparc64/
+      "sparcv9"
+    when /arm64|aarch64/  # MacOS calls it "arm64", other operating systems "aarch64"
+      "aarch64"
+    when /^arm/
+      if OS == "darwin"   # Ruby before 3.0 reports "arm" instead of "arm64" as host_cpu on darwin
+        "aarch64"
+      else
+        "arm"
+      end
+    else
+      RbConfig::CONFIG['host_cpu']
+    end)
+
+    private
+    # @param [String) os
+    # @return [Boolean]
+    # Test if current OS is +os+.
+    def self.is_os(os)
+      OS == os
+    end
+
+    IS_GNU = defined?(GNU_LIBC)
+    IS_LINUX = is_os("linux")
+    IS_MAC = is_os("darwin")
+    IS_FREEBSD = is_os("freebsd")
+    IS_NETBSD = is_os("netbsd")
+    IS_OPENBSD = is_os("openbsd")
+    IS_DRAGONFLYBSD = is_os("dragonfly")
+    IS_SOLARIS = is_os("solaris")
+    IS_WINDOWS = is_os("windows")
+    IS_BSD = IS_MAC || IS_FREEBSD || IS_NETBSD || IS_OPENBSD || IS_DRAGONFLYBSD
+
+    # Add the version for known ABI breaks
+    name_version = "12" if IS_FREEBSD && OSVERSION >= 12 # 64-bit inodes
+
+    NAME = FFI.make_shareable("#{ARCH}-#{OS}#{name_version}")
+    CONF_DIR = FFI.make_shareable(File.join(File.dirname(__FILE__), 'platform', NAME))
+
+    public
+
+    LIBPREFIX = FFI.make_shareable(case OS
+    when /windows|msys/
+      ''
+    when /cygwin/
+      'cyg'
+    else
+      'lib'
+    end)
+
+    LIBSUFFIX = FFI.make_shareable(case OS
+    when /darwin/
+      'dylib'
+    when /linux|bsd|solaris/
+      'so'
+    when /windows|cygwin|msys/
+      'dll'
+    else
+      # Punt and just assume a sane unix (i.e. anything but AIX)
+      'so'
+    end)
+
+    LIBC = FFI.make_shareable(if IS_WINDOWS
+      crtname = RbConfig::CONFIG["RUBY_SO_NAME"][/msvc\w+/] || 'ucrtbase'
+      "#{crtname}.dll"
+    elsif IS_GNU
+      GNU_LIBC
+    elsif OS == 'cygwin'
+      "cygwin1.dll"
+    elsif OS == 'msys'
+      # Not sure how msys 1.0 behaves, tested on MSYS2.
+      "msys-2.0.dll"
+    else
+      "#{LIBPREFIX}c.#{LIBSUFFIX}"
+    end)
+
+    LITTLE_ENDIAN = 1234 unless defined?(LITTLE_ENDIAN)
+    BIG_ENDIAN = 4321 unless defined?(BIG_ENDIAN)
+    unless defined?(BYTE_ORDER)
+      BYTE_ORDER = [0x12345678].pack("I") == [0x12345678].pack("N") ? BIG_ENDIAN : LITTLE_ENDIAN
+    end
+
+    # Test if current OS is a *BSD (include MAC)
+    # @return [Boolean]
+    def self.bsd?
+      IS_BSD
+    end
+
+    # Test if current OS is Windows
+    # @return [Boolean]
+    def self.windows?
+      IS_WINDOWS
+    end
+
+    # Test if current OS is Mac OS
+    # @return [Boolean]
+    def self.mac?
+      IS_MAC
+    end
+
+    # Test if current OS is Solaris (Sun OS)
+    # @return [Boolean]
+    def self.solaris?
+      IS_SOLARIS
+    end
+
+    # Test if current OS is a unix OS
+    # @return [Boolean]
+    def self.unix?
+      !IS_WINDOWS
+    end
+  end
+end
+

data/lib/ffi/pointer.rb

@@ -0,0 +1,167 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# Copyright (c) 2007, 2008 Evan Phoenix
+#
+# This file is part of ruby-ffi.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Ruby FFI project nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+require 'ffi/platform'
+
+# NOTE: all method definitions in this file are conditional on
+# whether they are not already defined. This is needed because
+# some Ruby implementations (e.g., TruffleRuby) might already
+# provide these methods due to using FFI internally, and we
+# should not override them to avoid warnings.
+
+module FFI
+  class Pointer
+
+    # Pointer size
+    SIZE = Platform::ADDRESS_SIZE / 8 unless const_defined?(:SIZE)
+
+    # Return the size of a pointer on the current platform, in bytes
+    # @return [Integer]
+    def self.size
+      SIZE
+    end unless respond_to?(:size)
+
+    # @param [nil,Integer] len length of string to return
+    # @return [String]
+    # Read pointer's contents as a string, or the first +len+ bytes of the
+    # equivalent string if +len+ is not +nil+.
+    def read_string(len=nil)
+      if len
+        return ''.b if len == 0
+        get_bytes(0, len)
+      else
+        get_string(0)
+      end
+    end unless method_defined?(:read_string)
+
+    # @param [Integer] len length of string to return
+    # @return [String]
+    # Read the first +len+ bytes of pointer's contents as a string.
+    #
+    # Same as:
+    #  ptr.read_string(len)  # with len not nil
+    def read_string_length(len)
+      get_bytes(0, len)
+    end unless method_defined?(:read_string_length)
+
+    # @return [String]
+    # Read pointer's contents as a string.
+    #
+    # Same as:
+    #  ptr.read_string  # with no len
+    def read_string_to_null
+      get_string(0)
+    end unless method_defined?(:read_string_to_null)
+
+    # @param [String] str string to write
+    # @param [Integer] len length of string to return
+    # @return [self]
+    # Write +len+ first bytes of +str+ in pointer's contents.
+    #
+    # Same as:
+    #  ptr.write_string(str, len)   # with len not nil
+    def write_string_length(str, len)
+      put_bytes(0, str, 0, len)
+    end unless method_defined?(:write_string_length)
+
+    # @param [String] str string to write
+    # @param [Integer] len length of string to return
+    # @return [self]
+    # Write +str+ in pointer's contents, or first +len+ bytes if
+    # +len+ is not +nil+.
+    def write_string(str, len=nil)
+      len = str.bytesize unless len
+      # Write the string data without NUL termination
+      put_bytes(0, str, 0, len)
+    end unless method_defined?(:write_string)
+
+    # @param [Type] type type of data to read from pointer's contents
+    # @param [Symbol] reader method to send to +self+ to read +type+
+    # @param [Integer] length
+    # @return [Array]
+    # Read an array of +type+ of length +length+.
+    # @example
+    #  ptr.read_array_of_type(TYPE_UINT8, :read_uint8, 4) # -> [1, 2, 3, 4]
+    def read_array_of_type(type, reader, length)
+      ary = []
+      size = FFI.type_size(type)
+      tmp = self
+      length.times { |j|
+        ary << tmp.send(reader)
+        tmp += size unless j == length-1 # avoid OOB
+      }
+      ary
+    end unless method_defined?(:read_array_of_type)
+
+    # @param [Type] type type of data to write to pointer's contents
+    # @param [Symbol] writer method to send to +self+ to write +type+
+    # @param [Array] ary
+    # @return [self]
+    # Write +ary+ in pointer's contents as +type+.
+    # @example
+    #  ptr.write_array_of_type(TYPE_UINT8, :put_uint8, [1, 2, 3 ,4])
+    def write_array_of_type(type, writer, ary)
+      size = FFI.type_size(type)
+      ary.each_with_index { |val, i|
+        break unless i < self.size
+        self.send(writer, i * size, val)
+      }
+      self
+    end unless method_defined?(:write_array_of_type)
+
+    # @return [self]
+    def to_ptr
+      self
+    end unless method_defined?(:to_ptr)
+
+    # @param [Symbol,Type] type of data to read
+    # @return [Object]
+    # Read pointer's contents as +type+
+    #
+    # Same as:
+    #  ptr.get(type, 0)
+    def read(type)
+      get(type, 0)
+    end unless method_defined?(:read)
+
+    # @param [Symbol,Type] type of data to read
+    # @param [Object] value to write
+    # @return [nil]
+    # Write +value+ of type +type+ to pointer's content
+    #
+    # Same as:
+    #  ptr.put(type, 0)
+    def write(type, value)
+      put(type, 0, value)
+    end unless method_defined?(:write)
+  end
+end

data/lib/ffi/struct.rb

@@ -0,0 +1,317 @@
+#
+# Copyright (C) 2008-2010 Wayne Meissner
+# Copyright (C) 2008, 2009 Andrea Fazzi
+# Copyright (C) 2008, 2009 Luc Heinrich
+#
+# This file is part of ruby-ffi.
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Ruby FFI project nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+require 'ffi/platform'
+require 'ffi/struct_layout'
+require 'ffi/struct_layout_builder'
+require 'ffi/struct_by_reference'
+
+module FFI
+
+  class Struct
+
+    # Get struct size
+    # @return [Integer]
+    def size
+      self.class.size
+    end
+
+    # @return [Integer] Struct alignment
+    def alignment
+      self.class.alignment
+    end
+    alias_method :align, :alignment
+
+    # (see FFI::StructLayout#offset_of)
+    def offset_of(name)
+      self.class.offset_of(name)
+    end
+
+    # (see FFI::StructLayout#members)
+    def members
+      self.class.members
+    end
+
+    # @return [Array]
+    # Get array of values from Struct fields.
+    def values
+      members.map { |m| self[m] }
+    end
+
+    # (see FFI::StructLayout#offsets)
+    def offsets
+      self.class.offsets
+    end
+
+    # Clear the struct content.
+    # @return [self]
+    def clear
+      pointer.clear
+      self
+    end
+
+    # Get {Pointer} to struct content.
+    # @return [AbstractMemory]
+    def to_ptr
+      pointer
+    end
+
+    # Get struct size
+    # @return [Integer]
+    def self.size
+      defined?(@layout) ? @layout.size : defined?(@size) ? @size : 0
+    end
+
+    # set struct size
+    # @param [Integer] size
+    # @return [size]
+    def self.size=(size)
+      raise ArgumentError, "Size already set" if defined?(@size) || defined?(@layout)
+      @size = size
+    end
+
+    # @return (see Struct#alignment)
+    def self.alignment
+      @layout.alignment
+    end
+
+    # (see FFI::Type#members)
+    def self.members
+      @layout.members
+    end
+
+    # (see FFI::StructLayout#offsets)
+    def self.offsets
+      @layout.offsets
+    end
+
+    # (see FFI::StructLayout#offset_of)
+    def self.offset_of(name)
+      @layout.offset_of(name)
+    end
+
+    def self.in
+      ptr(:in)
+    end
+
+    def self.out
+      ptr(:out)
+    end
+
+    def self.ptr(flags = :inout)
+      @ref_data_type ||= Type::Mapped.new(StructByReference.new(self))
+    end
+
+    def self.val
+      @val_data_type ||= StructByValue.new(self)
+    end
+
+    def self.by_value
+      self.val
+    end
+
+    def self.by_ref(flags = :inout)
+      self.ptr(flags)
+    end
+
+    class ManagedStructConverter < StructByReference
+
+      # @param [Struct] struct_class
+      def initialize(struct_class)
+        super(struct_class)
+
+        raise NoMethodError, "release() not implemented for class #{struct_class}" unless struct_class.respond_to? :release
+        @method = struct_class.method(:release)
+      end
+
+      # @param [Pointer] ptr
+      # @param [nil] ctx
+      # @return [Struct]
+      def from_native(ptr, ctx)
+        struct_class.new(AutoPointer.new(ptr, @method))
+      end
+    end
+
+    def self.auto_ptr
+      @managed_type ||= Type::Mapped.new(ManagedStructConverter.new(self))
+    end
+
+
+    class << self
+      public
+
+      # @return [StructLayout]
+      # @overload layout
+      #  @return [StructLayout]
+      #  Get struct layout.
+      # @overload layout(*spec)
+      #  @param [Array<Symbol, Integer>,Array(Hash)] spec
+      #  @return [StructLayout]
+      #  Create struct layout from +spec+.
+      #  @example Creating a layout from an array +spec+
+      #    class MyStruct < Struct
+      #      layout :field1, :int,
+      #             :field2, :pointer,
+      #             :field3, :string
+      #    end
+      #  @example Creating a layout from an array +spec+ with offset
+      #    class MyStructWithOffset < Struct
+      #      layout :field1, :int,
+      #             :field2, :pointer, 6,  # set offset to 6 for this field
+      #             :field3, :string
+      #    end
+      #  @example Creating a layout from a hash +spec+
+      #    class MyStructFromHash < Struct
+      #      layout :field1 => :int,
+      #             :field2 => :pointer,
+      #             :field3 => :string
+      #    end
+      #  @example Creating a layout with pointers to functions
+      #    class MyFunctionTable < Struct
+      #      layout :function1, callback([:int, :int], :int),
+      #             :function2, callback([:pointer], :void),
+      #             :field3, :string
+      #    end
+      def layout(*spec)
+        return @layout if spec.size == 0
+
+        warn "[DEPRECATION] Struct layout is already defined for class #{self.inspect}. Redefinition as in #{caller[0]} will be disallowed in ffi-2.0." if defined?(@layout)
+
+        builder = StructLayoutBuilder.new
+        builder.union = self < Union
+        builder.packed = @packed if defined?(@packed)
+        builder.alignment = @min_alignment if defined?(@min_alignment)
+
+        if spec[0].kind_of?(Hash)
+          hash_layout(builder, spec)
+        else
+          array_layout(builder, spec)
+        end
+        builder.size = @size if defined?(@size) && @size > builder.size
+        cspec = builder.build
+        @layout = cspec unless self == Struct
+        @size = cspec.size
+        return cspec
+      end
+
+
+      protected
+
+      def callback(params, ret)
+        mod = enclosing_module
+        ret_type = find_type(ret, mod)
+        if ret_type == Type::STRING
+          raise TypeError, ":string is not allowed as return type of callbacks"
+        end
+        FFI::CallbackInfo.new(ret_type, params.map { |e| find_type(e, mod) })
+      end
+
+      def packed(packed = 1)
+        @packed = packed
+      end
+      alias :pack :packed
+
+      def aligned(alignment = 1)
+        @min_alignment = alignment
+      end
+      alias :align :aligned
+
+      def enclosing_module
+        begin
+          mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
+          if mod.respond_to?(:find_type) && (mod.is_a?(FFI::Library) || mod < FFI::Struct)
+            mod
+          end
+        rescue Exception
+          nil
+        end
+      end
+
+
+      def find_field_type(type, mod = enclosing_module)
+        if type.kind_of?(Class) && type < Struct
+          FFI::Type::Struct.new(type)
+
+        elsif type.kind_of?(Class) && type < FFI::StructLayout::Field
+          type
+
+        elsif type.kind_of?(::Array)
+          FFI::Type::Array.new(find_field_type(type[0]), type[1])
+
+        else
+          find_type(type, mod)
+        end
+      end
+
+      def find_type(type, mod = enclosing_module)
+        if mod
+          mod.find_type(type)
+        end || FFI.find_type(type)
+      end
+
+      private
+
+      # @param [StructLayoutBuilder] builder
+      # @param [Hash] spec
+      # @return [builder]
+      # Add hash +spec+ to +builder+.
+      def hash_layout(builder, spec)
+        spec[0].each do |name, type|
+          builder.add name, find_field_type(type), nil
+        end
+      end
+
+      # @param [StructLayoutBuilder] builder
+      # @param [Array<Symbol, Integer>] spec
+      # @return [builder]
+      # Add array +spec+ to +builder+.
+      def array_layout(builder, spec)
+        i = 0
+        while i < spec.size
+          name, type = spec[i, 2]
+          i += 2
+
+          # If the next param is a Integer, it specifies the offset
+          if spec[i].kind_of?(Integer)
+            offset = spec[i]
+            i += 1
+          else
+            offset = nil
+          end
+
+          builder.add name, find_field_type(type), offset
+        end
+      end
+    end
+  end
+end