ffi_dry 0.1.4 → 0.1.5

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 rdoc
 pkg
+.yardoc

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.5 / 2010-1-4
+  * Added p_struct dsl directive sugar for creating FFI::Struct accessors to 
+    handle pointers to structs.
+
 === 0.1.4 / 2010-1-1
   * Support for FFI 0.5.0 final and up.
   * Added NetStructHelper with accessors to provide automatic network byte 

data/README.rdoc

@@ -5,14 +5,14 @@ things and add support for some uncommon ones.
 
 == Requirements
  
-* ffi-ffi (>= 0.5.0) - github.com/ffi/ffi
+* ffi (>= 0.5.0) - github.com/ffi/ffi
 
 
 == Synopsis
 
 (samples/ in the package for code)
 
-A major feature is a DSL"-like" syntax for declaring structure members
+One major feature is a DSL"-like" syntax for declaring structure members
 in FFI::Struct or FFI::ManagedStruct definitions.
     
     require 'rubygems'
@@ -34,16 +34,14 @@ in FFI::Struct or FFI::ManagedStruct definitions.
 
     ss0=SomeStruct.new
 
-With the declarations above, we specified :desc hash value in metadata
-Let's check out in our instance.
+With the declarations above, we specified :desc hash value in metadata. Extra
+metadata can have arbitrary keys and is accessible in every instance and class.
 
     pp ss0.dsl_metadata 
     [{:type=>:uint16, :name=>:field1, :desc=>"this is field 1"},
      {:type=>:uint16, :name=>:field2, :desc=>"this is field 2"}]
     # => nil
 
-Or class.
-
     pp SomeStruct.dsl_metadata
     #...
 
@@ -57,13 +55,10 @@ during initialization. (The FFI standard ways still work too)
     ss3=SomeStruct.new {|x| x.field1=1 }
     ss4=SomeStruct.new(:raw => raw_data) {|x| x.field1=1 }
 
-    [ ss0, 
-      ss1, 
-      ss2, 
-      ss3, 
-      ss4 ].each_with_index {|x,i| p ["ss#{i}",[x.field1, x.field2]]}
+    [ ss0, ss1, ss2, ss3, ss4 
+    ].each_with_index {|x,i| p ["ss#{i}",[x.field1, x.field2]]}
 
-    # which will produce...
+    # which produces...
     # ["ss0", [0, 0]]
     # ["ss1", [0, 65535]]
     # ["ss2", [1, 2]]
@@ -72,8 +67,8 @@ during initialization. (The FFI standard ways still work too)
 
 
 Here's a broader example which utilizes that arbitrary ':desc' parameter in a 
-"neighborly" way. This also demonstrates superclasses to add common struct
-features, declaring array fields, as well as nesting other structs.
+"neighborly" way. This also demonstrates using superclasses to add common 
+struct features, declaring array fields, as well as nesting other structs.
 
     require 'rubygems'
     require 'ffi'
@@ -190,9 +185,10 @@ features, declaring array fields, as well as nesting other structs.
     #   type:  :uint8
     #   desc:  test field 2
 
-There's also some helpers for collecting lookup maps for constants, a common
-and handy thing when porting various libraries. We use Socket here just for
-example purposes, you can 'slurp' constants form any namespace this way.
+There's also some helper modules for collecting lookup maps for constants, a 
+common and handy thing when porting various libraries. We use the Ruby Socket 
+socket namespace here for demonstration  purposes. You can 'slurp' constants 
+from any namespace this way.
 
     require 'ffi/dry'
     require 'socket'

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/ffi_dry.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ffi_dry}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Eric Monti"]
-  s.date = %q{2010-01-02}
+  s.date = %q{2010-01-15}
   s.description = %q{Provides some useful modules, classes, and methods for FFI bindings  as well as a DSL-like syntax for FFI::Struct layouts}
   s.email = %q{emonti@matasano.com}
   s.extra_rdoc_files = [

data/lib/ffi/dry.rb

@@ -108,7 +108,7 @@ module FFI::DRY
     # the layout.
     #
     # This method is called automatically if you are using the initialize() 
-    # method provided in the DryStruct class and passing it a Hash as its only
+    # method provided in the Struct class and passing it a Hash as its only
     # argument.
     def set_fields(params=nil)
       (params || {}).keys.each do |p|
@@ -169,13 +169,20 @@ module FFI::DRY
       def _class_meths_from_dsl_metadata(meta)
         (@dsl_metadata = meta).each do |spec|
           name = spec[:name]
-          type = spec[:type]
-          define_method(:"#{name}") do 
-            self[name]
-          end unless instance_methods.include?(:"#{name}")
-          define_method(:"#{name}=") do |val|
-            self[name]=val
-          end unless instance_methods.include?(:"#{name}=")
+          ftype = spec[:type]
+          unless instance_methods.include?(:"#{name}")
+            if p=spec[:p_struct] and p.kind_of?(Class)
+              define_method(:"#{name}") do
+                p.new(self[name]) unless self[name].null?
+              end
+            else
+              define_method(:"#{name}") { self[name] }
+            end
+          end
+
+          unless instance_methods.include?(:"#{name}=")
+            define_method(:"#{name}=") {|val| self[name]=val }
+          end 
         end
       end
     end
@@ -183,6 +190,19 @@ module FFI::DRY
     def self.included(base)
       base.extend(ClassMethods)
     end
+
+    alias inspect_orig inspect
+
+    # Overrides inspect to show field names and values
+    def inspect
+      ret = "#<#{self.class}"
+      if not @_inspecting_in_progress
+        @_inspecting_in_progress = true
+        ret << " " << members.map {|m| "#{m}=#{self[m].inspect}"}.join(', ')
+        @_inspecting_in_progress = nil
+      end
+      ret << ">"
+    end
   end # class StructHelper
 
   # This is a wrapper around the FFI::StructLayoutBuilder. Its goal is to 
@@ -235,6 +255,18 @@ module FFI::DRY
       return ret
     end
 
+    # A pointer to a structure. The structure does not allocate the entire
+    # space for the structure, just a pointer. When calling the accessors for
+    # a p_struct field, a new instance of the FFI::Struct will be returned.
+    def p_struct(name, klass, o={})
+      unless klass.kind_of?(Class)
+        raise(::ArgumentError, "klass must be a Class")
+      end
+      opts = o.merge(:p_struct => klass)
+      offset = opts[:offset]
+      field(name, :pointer, opts)
+    end
+
     # Calls StructLayoutBuider.add_array() on the builder and stores 
     # a metadata hash entry (the opts hash with name and type overridden)
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ffi_dry
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Eric Monti
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-02 00:00:00 -06:00
+date: 2010-01-15 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency