ffi 1.10.0 → 1.11.1

data/lib/ffi/struct_layout.rb

@@ -0,0 +1,96 @@
+#
+# 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.
+#
+
+module FFI
+
+  class StructLayout
+
+    # @return [Array<Array(Symbol, Numeric)>
+    # Get an array of tuples (field name, offset of the field).
+    def offsets
+      members.map { |m| [ m, self[m].offset ] }
+    end
+
+    # @return [Numeric]
+    # Get the offset of a field.
+    def offset_of(field_name)
+      self[field_name].offset
+    end
+
+    # An enum {Field} in a {StructLayout}.
+    class Enum < Field
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @return [Object]
+      # Get an object of type {#type} from memory pointed by +ptr+.
+      def get(ptr)
+        type.find(ptr.get_int(offset))
+      end
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @param  value
+      # @return [nil]
+      # Set +value+ into memory pointed by +ptr+.
+      def put(ptr, value)
+        ptr.put_int(offset, type.find(value))
+      end
+
+    end
+
+    class InnerStruct < Field
+      def get(ptr)
+        type.struct_class.new(ptr.slice(self.offset, self.size))
+      end
+
+     def put(ptr, value)
+       raise TypeError, "wrong value type (expected #{type.struct_class})" unless value.is_a?(type.struct_class)
+       ptr.slice(self.offset, self.size).__copy_from__(value.pointer, self.size)
+     end
+    end
+
+    class Mapped < Field
+      def initialize(name, offset, type, orig_field)
+        super(name, offset, type)
+        @orig_field = orig_field
+      end
+
+      def get(ptr)
+        type.from_native(@orig_field.get(ptr), nil)
+      end
+
+      def put(ptr, value)
+        @orig_field.put(ptr, type.to_native(value, nil))
+      end
+    end
+  end
+end

data/lib/ffi/tools/const_generator.rb

@@ -6,6 +6,7 @@ module FFI
   # ConstGenerator turns C constants into ruby values.
   #
   # @example a simple example for stdio
+  #  require 'ffi/tools/const_generator'
   #  cg = FFI::ConstGenerator.new('stdio') do |gen|
   #    gen.const(:SEEK_SET)
   #    gen.const('SEEK_CUR')
@@ -25,10 +26,10 @@ module FFI
     #
     # The only option is +:required+, which if set to +true+ raises an error if a
     # constant you have requested was not found.
-    # 
+    #
     # @param [#to_s] prefix
     # @param [Hash] options
-    # @return 
+    # @return
     # @option options [Boolean] :required
     # @overload initialize(prefix, options)
     # @overload initialize(prefix, options) { |gen| ... }
@@ -79,7 +80,7 @@ module FFI
     #  @param [#call] converter convert the value from a string to the appropriate
     #   type for {#to_ruby}.
     # @overload const(name, format=nil, cast='', ruby_name=nil) { |value| ... }
-    #  Use a converter block. This block convert the value from a string to the 
+    #  Use a converter block. This block convert the value from a string to the
     #  appropriate type for {#to_ruby}.
     #  @yieldparam value constant value
     def const(name, format = nil, cast = '', ruby_name = nil, converter = nil,
@@ -224,6 +225,6 @@ module FFI
       "#{ruby_name} = #{converted_value}"
     end
 
-  end  
+  end
 
 end

data/lib/ffi/tools/generator.rb

@@ -1,6 +1,51 @@
+require 'ffi/tools/struct_generator'
+require 'ffi/tools/const_generator'
+
 module FFI
 
-  # @private
+  ##
+  # Generate files with C structs for FFI::Struct and C constants.
+  #
+  # == A simple example
+  #
+  # In file +zlib.rb.ffi+:
+  #   module Zlib
+  #     @@@
+  #     constants do |c|
+  #       c.include "zlib.h"
+  #       c.const :ZLIB_VERNUM
+  #     end
+  #     @@@
+  #
+  #     class ZStream < FFI::Struct
+  #
+  #       struct do |s|
+  #         s.name "struct z_stream_s"
+  #         s.include "zlib.h"
+  #
+  #         s.field :next_in,   :pointer
+  #         s.field :avail_in,  :uint
+  #         s.field :total_in,  :ulong
+  #       end
+  #       @@@
+  #     end
+  #   end
+  #
+  # Translate the file:
+  #   require "ffi/tools/generator"
+  #   FFI::Generator.new "zlib.rb.ffi", "zlib.rb"
+  #
+  # Generates the file +zlib.rb+ with constant values and offsets:
+  #   module Zlib
+  #   ZLIB_VERNUM = 4784
+  #
+  #   class ZStream < FFI::Struct
+  #     layout :next_in, :pointer, 0,
+  #            :avail_in, :uint, 8,
+  #            :total_in, :ulong, 16
+  #   end
+  #
+  # @see FFI::Generator::Task for easy integration in a Rakefile
   class Generator
 
     def initialize(ffi_name, rb_name, options = {})
@@ -34,7 +79,7 @@ module FFI
       end
 
       open @rb_name, 'w' do |f|
-        f.puts "# This file is generated by rake. Do not edit."
+        f.puts "# This file is generated from `#{@ffi_name}'. Do not edit."
         f.puts
         f.puts new_file
       end

data/lib/ffi/tools/generator_task.rb

@@ -1,25 +1,21 @@
-begin
-  require 'ffi/struct_generator'
-  require 'ffi/const_generator'
-  require 'ffi/generator'
-rescue LoadError
-  # from Rakefile
-  require 'lib/ffi/struct_generator'
-  require 'lib/ffi/const_generator'
-  require 'lib/ffi/generator'
-end
-
+require 'ffi/tools/generator'
 require 'rake'
 require 'rake/tasklib'
-require 'tempfile'
 
 ##
-# Rake task that calculates C structs for FFI::Struct.
-
-# @private
+# Add Rake tasks that generate files with C structs for FFI::Struct and C constants.
+#
+# @example a simple example for your Rakefile
+#   require "ffi/tools/generator_task"
+#   # Add a task to generate my_object.rb out of my_object.rb.ffi
+#   FFI::Generator::Task.new ["my_object.rb"], cflags: "-I/usr/local/mylibrary"
+#
+# The generated files are also added to the 'clear' task.
+#
+# @see FFI::Generator for a description of the file content
 class FFI::Generator::Task < Rake::TaskLib
 
-  def initialize(rb_names)
+  def initialize(rb_names, options={})
     task :clean do rm_f rb_names end
 
     rb_names.each do |rb_name|
@@ -28,7 +24,7 @@ class FFI::Generator::Task < Rake::TaskLib
       file rb_name => ffi_name do |t|
         puts "Generating #{rb_name}..." if Rake.application.options.trace
 
-        FFI::Generator.new ffi_name, rb_name
+        FFI::Generator.new ffi_name, rb_name, options
       end
     end
   end

data/lib/ffi/tools/struct_generator.rb

@@ -7,15 +7,15 @@ module FFI
   #
   # Given the @@@ portion in:
   #
-  #   module Zlib::ZStream < FFI::Struct
+  #   class Zlib::ZStream < FFI::Struct
   #     @@@
   #     name "struct z_stream_s"
   #     include "zlib.h"
-  #   
+  #
   #     field :next_in,   :pointer
   #     field :avail_in,  :uint
   #     field :total_in,  :ulong
-  #   
+  #
   #     # ...
   #     @@@
   #   end
@@ -90,7 +90,7 @@ module FFI
           raise "Compilation error generating struct #{@name} (#{@struct_name}):\n#{output}"
         end
       end
-      
+
       output = `#{binary}`.split "\n"
       File.unlink(binary + (FFI::Platform.windows? ? ".exe" : ""))
       sizeof = output.shift

data/lib/ffi/types.rb

@@ -152,7 +152,7 @@ module FFI
   # also allow to work with the pointer itself. This is useful when you want
   # a Ruby string already containing a copy of the data, but also the pointer
   # to the data for you to do something with it, like freeing it, in case the
-  # library handed the memory to off to the caller (Ruby-FFI).
+  # library handed the memory off to the caller (Ruby-FFI).
   #
   # It's {typedef}'d as +:strptr+.
   class StrPtrConverter

data/lib/ffi/version.rb

@@ -1,3 +1,3 @@
 module FFI
-  VERSION = '1.10.0'
+  VERSION = '1.11.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Wayne Meissner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,6 @@ files:
 - ext/ffi_c/Call.h
 - ext/ffi_c/ClosurePool.c
 - ext/ffi_c/ClosurePool.h
-- ext/ffi_c/DataConverter.c
 - ext/ffi_c/DynamicLibrary.c
 - ext/ffi_c/DynamicLibrary.h
 - ext/ffi_c/Function.c
@@ -130,8 +129,6 @@ files:
 - ext/ffi_c/Pointer.h
 - ext/ffi_c/Struct.c
 - ext/ffi_c/Struct.h
-- ext/ffi_c/StructByReference.c
-- ext/ffi_c/StructByReference.h
 - ext/ffi_c/StructByValue.c
 - ext/ffi_c/StructByValue.h
 - ext/ffi_c/StructLayout.c
@@ -557,6 +554,7 @@ files:
 - lib/ffi/autopointer.rb
 - lib/ffi/buffer.rb
 - lib/ffi/callback.rb
+- lib/ffi/data_converter.rb
 - lib/ffi/enum.rb
 - lib/ffi/errno.rb
 - lib/ffi/ffi.rb
@@ -611,6 +609,8 @@ files:
 - lib/ffi/platform/x86_64-windows/types.conf
 - lib/ffi/pointer.rb
 - lib/ffi/struct.rb
+- lib/ffi/struct_by_reference.rb
+- lib/ffi/struct_layout.rb
 - lib/ffi/struct_layout_builder.rb
 - lib/ffi/tools/const_generator.rb
 - lib/ffi/tools/generator.rb
@@ -632,7 +632,13 @@ files:
 homepage: http://wiki.github.com/ffi/ffi
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/ffi/ffi/issues
+  changelog_uri: https://github.com/ffi/ffi/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/ffi/ffi/wiki
+  wiki_uri: https://github.com/ffi/ffi/wiki
+  source_code_uri: https://github.com/ffi/ffi/
+  mailing_list_uri: http://groups.google.com/group/ruby-ffi
 post_install_message: 
 rdoc_options:
 - "--exclude=ext/ffi_c/.*\\.o$"
@@ -643,15 +649,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby FFI

data/ext/ffi_c/DataConverter.c

@@ -1,91 +0,0 @@
-
-#include <ruby.h>
-
-#include <ffi.h>
-#include "rbffi.h"
-
-#include "Type.h"
-#include "MappedType.h"
-
-
-VALUE rbffi_DataConverterClass = Qnil;
-static ID id_native_type_ivar;
-
-/*
- * Get native type.
- * @overload native_type(type)
- *  @param [String, Symbol, Type] type
- *  @return [Type]
- *  Get native type from +type+.
- * @overload native_type
- *  @raise {NotImplementedError} This method must be overriden.
- */
-static VALUE
-conv_native_type(int argc, VALUE* argv, VALUE self)
-{
-    if (argc == 0) {
-        if (!rb_ivar_defined(self, id_native_type_ivar)) {
-            rb_raise(rb_eNotImpError, "native_type method not overridden and no native_type set");
-        }
-
-        return rb_ivar_get(self, id_native_type_ivar);
-
-    } else if (argc == 1) {
-        VALUE type = rbffi_Type_Find(argv[0]);
-
-        rb_ivar_set(self, id_native_type_ivar, type);
-
-        return type;
-
-    } else {
-        rb_raise(rb_eArgError, "incorrect arguments");
-    }
-}
-
-/*
- * call-seq: to_native(value, ctx)
- * @param value
- * @param ctx
- * @return [value]
- * Convert to a native type.
- */
-static VALUE
-conv_to_native(VALUE self, VALUE value, VALUE ctx)
-{
-    return value;
-}
-
-/*
- * call-seq: from_native(value, ctx)
- * @param value
- * @param ctx
- * @return [value]
- * Convert from a native type.
- */
-static VALUE
-conv_from_native(VALUE self, VALUE value, VALUE ctx)
-{
-    return value;
-}
-
-
-
-void
-rbffi_DataConverter_Init(VALUE moduleFFI)
-{
-    /*
-     * Document-module: FFI::DataConverter
-     * This module is used to extend somes classes and give then a common API.
-     *
-     * Most of methods defined here must be overriden.
-     */
-    rbffi_DataConverterClass = rb_define_module_under(moduleFFI, "DataConverter");
-
-    rb_define_method(rbffi_DataConverterClass, "native_type", conv_native_type, -1);
-    rb_define_method(rbffi_DataConverterClass, "to_native", conv_to_native, 2);
-    rb_define_method(rbffi_DataConverterClass, "from_native", conv_from_native, 2);
-
-    id_native_type_ivar = rb_intern("@native_type");
-}
-
-