ffi 1.9.25 → 1.15.0

data/lib/ffi/struct.rb

@@ -32,72 +32,12 @@
 #
 
 require 'ffi/platform'
+require 'ffi/struct_layout'
 require 'ffi/struct_layout_builder'
+require 'ffi/struct_by_reference'
 
 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
-
-  
   class Struct
 
     # Get struct size
@@ -250,7 +190,7 @@ module FFI
       #             :field2, :pointer, 6,  # set offset to 6 for this field
       #             :field3, :string
       #    end
-      #  @example Creating a layout from a hash +spec+ (Ruby 1.9 only)
+      #  @example Creating a layout from a hash +spec+
       #    class MyStructFromHash < Struct
       #      layout :field1 => :int,
       #             :field2 => :pointer,
@@ -262,9 +202,8 @@ module FFI
       #             :function2, callback([:pointer], :void),
       #             :field3, :string
       #    end
-      #  @note Creating a layout from a hash +spec+ is supported only for Ruby 1.9.
       def layout(*spec)
-        #raise RuntimeError, "struct layout already defined for #{self.inspect}" if defined?(@layout)
+        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)
         return @layout if spec.size == 0
 
         builder = StructLayoutBuilder.new
@@ -289,14 +228,18 @@ module FFI
 
       def callback(params, ret)
         mod = enclosing_module
-        FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) })
+        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
@@ -305,7 +248,9 @@ module FFI
       def enclosing_module
         begin
           mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
-          (mod < FFI::Library || mod < FFI::Struct || mod.respond_to?(:find_type)) ? mod : nil
+          if mod.respond_to?(:find_type) && (mod.is_a?(FFI::Library) || mod < FFI::Struct)
+            mod
+          end
         rescue Exception
           nil
         end

data/lib/ffi/struct_by_reference.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (C) 2010 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.#
+
+module FFI
+  # This class includes the {FFI::DataConverter} module.
+  class StructByReference
+    include DataConverter
+
+    attr_reader :struct_class
+
+    # @param [Struct] struct_class
+    def initialize(struct_class)
+      unless Class === struct_class and struct_class < FFI::Struct
+        raise TypeError, 'wrong type (expected subclass of FFI::Struct)'
+      end
+      @struct_class = struct_class
+    end
+
+    # Always get {FFI::Type}::POINTER.
+    def native_type
+      FFI::Type::POINTER
+    end
+
+    # @param [nil, Struct] value
+    # @param [nil] ctx
+    # @return [AbstractMemory] Pointer on +value+.
+    def to_native(value, ctx)
+      return Pointer::NULL if value.nil?
+
+      unless @struct_class === value
+        raise TypeError, "wrong argument type #{value.class} (expected #{@struct_class})"
+      end
+
+      value.pointer
+    end
+
+    # @param [AbstractMemory] value
+    # @param [nil] ctx
+    # @return [Struct]
+    # Create a struct from content of memory +value+.
+    def from_native(value, ctx)
+      @struct_class.new(value)
+    end
+  end
+end

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