sdl2_ffi 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8be28ad160c53b7d6a78228b54f51b52cdd3f23f
-  data.tar.gz: 614dda38c426b697ab56834290ac2aea6eff897d
+  metadata.gz: 60ab089f8e71037fce4c4f2a46cf5586db4af65f
+  data.tar.gz: cd50c7524713298ed2ad850d637a46f0c20d6347
 SHA512:
-  metadata.gz: 71725da19c1cd8fa51d6f0fbbbe3ff956beb69b84443539c9935a46935b8ed7f4e07bbd1c4085ba38288ea132a8c7aaff9579168aa0729d86b7c93992120110e
-  data.tar.gz: ba822728cec706ca7a4401e81db8fc6f230d5ce156dee6a8bc40785022b215207b3ace9450c9eebcd5c5bea4f20cc80d629b43d669e0c26ddf7dc606caf3503a
+  metadata.gz: 8322d3174b86096df92c9fd2127b54604c3ef9e99a4f1c055bb56570e0e986bcd93fd8d576bd7d444daac7bca497162b5f0aea94eac8e5c58c113d62797034ea
+  data.tar.gz: 028e8e3b02c672c1fb45796bb21bdc8cb25f369b9cf34f8861e816f099f3a56277d7003ac5256efcbd697f7f88ed96299b41cbe4ebb0c6e1dd89c6ed0ba35d30

data/.gitignore

@@ -19,3 +19,5 @@ tmp
 .buildpath
 *~
 .settings
+.approvals
+spec/fixtures/approvals/**/*received*

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sdl2_ffi.gemspec
 gemspec
+
+# TODO: Once SDL/Image support has been added, migrate to official 
+# gem.
+group :development do
+  gem 'approvals', git:'http://github.com/BadQuanta/approvals', branch: 'feature_binary_formats'
+end

data/Guardfile

@@ -1,33 +1,55 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard :minitest do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)\/?test_(.*)\.rb})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/unit/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb})      { 'test' }
+#guard :minitest do
+#  # with Minitest::Unit
+#  watch(%r{^test/(.*)\/?test_(.*)\.rb})
+#  watch(%r{^lib/(.*/)?([^/]+)\.rb})     { |m| "test/unit/#{m[1]}test_#{m[2]}.rb" }
+#  watch(%r{^test/test_helper\.rb})      { 'test' }
+#
+#  # with Minitest::Spec
+#  watch(%r{^spec/(.*)_spec\.rb})
+#  watch(%r{^lib/(.+)\.rb})         { |m| "spec/unit/#{m[1]}_spec.rb" }
+#  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+#
+#  # Rails 4
+#  # watch(%r{^test/test_helper\.rb}) { 'test' }
+#  # watch(%r{^test/.+_test\.rb})
+#  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
+#  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
+#  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
+#  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+#  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+#
+#  # Rails 3.2
+#  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/controllers/#{m[1]}_test.rb" }
+#  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+#  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+#
+#  # Rails
+#  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
+#  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
+#  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+#end
 
-  # with Minitest::Spec
-  watch(%r{^spec/(.*)_spec\.rb})
-  watch(%r{^lib/(.+)\.rb})         { |m| "spec/unit/#{m[1]}_spec.rb" }
-  watch(%r{^spec/spec_helper\.rb}) { 'spec' }
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
 
-  # Rails 4
-  # watch(%r{^test/test_helper\.rb}) { 'test' }
-  # watch(%r{^test/.+_test\.rb})
-  # watch(%r{^app/(.+)\.rb})                               { |m| "test/#{m[1]}_test.rb" }
-  # watch(%r{^app/controllers/application_controller\.rb}) { 'test/controllers' }
-  # watch(%r{^app/controllers/(.+)_controller\.rb})        { |m| "test/integration/#{m[1]}_test.rb" }
-  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
-  # watch(%r{^lib/(.+)\.rb})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # Rails example
+  #watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  #watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  #watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  #watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  #watch('config/routes.rb')                           { "spec/routing" }
+  #watch('app/controllers/application_controller.rb')  { "spec/controllers" }
 
-  # Rails 3.2
-  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/controllers/#{m[1]}_test.rb" }
-  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
-  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+  # Capybara features specs
+  #watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
 
-  # Rails
-  # watch(%r{^app/controllers/(.*)\.rb}) { |m| "test/functional/#{m[1]}_test.rb" }
-  # watch(%r{^app/helpers/(.*)\.rb})     { |m| "test/helpers/#{m[1]}_test.rb" }
-  # watch(%r{^app/models/(.*)\.rb})      { |m| "test/unit/#{m[1]}_test.rb" }
+  # Turnip features and steps
+  #watch(%r{^spec/acceptance/(.+)\.feature$})
+  #watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
 end
+

data/Rakefile

@@ -1,5 +1,11 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'rspec/core/rake_task.rb'
+
+RSpec::Core::RakeTask.new do |t|
+ 
+  
+end
 
 Rake::TestTask.new do |t|
   t.pattern = 'test/**/test*.rb'

data/bin/approvals

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'approvals' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'approvals')

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'autospec')

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'ldiff')

data/bin/nokogiri

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'nokogiri' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'nokogiri')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sdl2_ffi', 'rspec')

data/lib/enumerable_constants.rb

@@ -6,13 +6,13 @@ require 'ffi'
 # An example:
 #     module MyEnumeration
 #       include EnumerableConstants
-#       MY_FIRST_CONSTANT = next_const_value # defaults to 0
-#       MY_NEXT_CONSTANT = next_const_value # will be 1
-#       MY_THIRD_CONSTANT = next_const_value # will be 2, and the next would be 3 unless
+#       MY_FIRST_CONSTANT # defaults to 0
+#       MY_NEXT_CONSTANT # will be 1
+#       MY_THIRD_CONSTANT # will be 2, and the next would be 3 unless
 #       MY_FOURTH_CONSTANT = 100 # you assign a value.
-#       MY_FIFTH_CONSTANT = next_const_value # will be 101
+#       MY_FIFTH_CONSTANT # will be 101
 #       MY_SIXTH_CONSTANT = MY_THIRD_CONSTANT # There are no rules against duplicate values.
-#       MY_SEVENTH_CONSTANT = next_const_value # will be 3, be careful you don't unintentionally reuse values.
+#       MY_SEVENTH_CONSTANT # will be 3, be careful you don't unintentionally reuse values.
 #     end
 #
 # With this module, you can:
@@ -34,10 +34,14 @@ require 'ffi'
 #
 #     MyEnumeration::MY_EIGTH_CONSTANT = MyEnumeration.next_const_value # 4
 #
+# Or, you could just do:
+#
+#     MyEnumeration::MY_NINTH_CONSTANT #=> Automatically assigned value 5
+#
 # However, successive calls to just `#next_const_value` will just result in
 # the same value.
-#     MyEnumeration.next_const_value # 5
-#     MyEnumeration.next_const_value # 5
+#     MyEnumeration.next_const_value # 6
+#     MyEnumeration.next_const_value # 6
 module EnumerableConstants
 
   # This is the method that injects the new static-scope routines.
@@ -54,6 +58,15 @@ module EnumerableConstants
         return result
       end
       
+      # Return the defined constants in a hash keyed by value.
+      def self.by_value
+        result = {}
+        self.constants.each do |constant|
+          result[self.const_get(constant)] = constant          
+        end
+        return result
+      end
+      
       # This routine returns a flattened array of alternating symbols and values.
       # The symbols are the CONSTANT names and values are the values defined by that constant.
       def self.flatten_consts
@@ -76,7 +89,9 @@ module EnumerableConstants
         last_const_value.next
       end
 
+      def self.const_missing(const)
+        self.const_set(const, next_const_value)
+      end
     end
   end
-
 end

data/lib/sdl2.rb

@@ -2,48 +2,35 @@ require 'sdl2/sdl_module'
 require 'active_support/inflector'
 require 'enumerable_constants'
 require 'sdl2/stdinc'
+
 # libSDL2's prototypes are attached directly to this module.
 #
 module SDL2
   extend FFI::Library
   extend Library
-  ffi_lib SDL_MODULE  
-
-  # FFI::Struct class with some useful additions.
-  class Struct < FFI::Struct
+  ffi_lib SDL_MODULE
 
-    # Allows creation and use within block, automatically freeing pointer after block.
-    def initialize(*args, &block)
-      super(*args)
-      if block_given?
-        throw 'Release must be defined to use block' unless self.class.respond_to?(:release)
-        yield self
-        self.class.release(self.pointer)
-      end
-    end
+  PrintDebug = false
 
-    # A default release scheme is defined, but should be redefined where appropriate.
-    def self.release(pointer)
-      pointer.free
-    end
+  module StructHelper
 
     # Define a set of member readers
     # Ex1: `member_readers [:one, :two, :three]`
     # Ex2: `member_readers *members`
-    def self.member_readers(*members_to_define)
+    def member_readers(*members_to_define)
       #self.class_eval do
       members_to_define.each do |member|
         define_method member do
-          [member]
+          self[member]
         end
       end
       #end
     end
 
     # Define a set of member writers
-  	# Ex1: `member_writers [:one, :two, :three]`
-	  # Ex2: `member_writers *members`
-    def self.member_writers(*members_to_define)
+    # Ex1: `member_writers [:one, :two, :three]`
+    # Ex2: `member_writers *members`
+    def member_writers(*members_to_define)
       members_to_define.each do |member|
         define_method "#{member}=".to_sym do |value|
           self[member]= value
@@ -51,32 +38,121 @@ module SDL2
       end
     end
 
-    # A human-readable representation of the struct and it's values.
-    def inspect
-      return 'nil' if self.null?
+  end
+
+  # Augmented for compares with anything that can be an array
+  class FFI::Struct::InlineArray
+
+    def ==(other)
+      self.to_a == other.to_a
+    end
+  end
 
-      #binding.pry
-      #return self.to_s
+  # FFI::Struct class with some useful additions.
+  class Struct < FFI::Struct
+    extend StructHelper
+
+    # Allows creation and use within block, automatically freeing pointer after block.
+    def initialize(*args, &block)
+      super(*args)
+      if block_given?
+        throw 'Release must be defined to use block' unless self.class.respond_to?(:release)
+        yield self
+        self.class.release(self.pointer)
+      end
+    end
 
-      report = "struct #{self.class.to_s}{"
-      report += self.class.members.collect do |field|
-        "#{field}->#{self[field].inspect}"
-      end.join(' ')
-      report += "}"
+    # A default release scheme is defined, but should be redefined where appropriate.
+    def self.release(pointer)
+      pointer.free
     end
 
+    # A human-readable representation of the struct and it's values.
+    #def inspect
+    #  return 'nil' if self.null?
+    #
+    #  #binding.pry
+    #  #return self.to_s
+    #
+    #      report = "struct #{self.class.to_s}{"
+    #      report += self.class.members.collect do |field|
+    #        "#{field}->#{self[field].inspect}"
+    #      end.join(' ')
+    #      report += "}"
+    #    end
+
     # Compare two structures by class and values.
     def ==(other)
-      return false unless self.class == other.class
-      self.class.members.each do |field|
-        return false unless self[field] == other[field]
+      if PrintDebug
+        @@rec ||= -1
+        @@rec += 1
+        pad = "\t"*@@rec
+
+        puts
+        puts " #{pad}COMPARING #{self} to #{other}"
+      end
+
+      result = catch(:result) do
+        unless self.class == other.class
+          puts "Class Mismatch" if PrintDebug
+          throw :result, false
+        end
+
+        if self.null? or other.null?
+          unless self.null? and other.null?
+            puts "AHHHAOne is null and the other is not" if PrintDebug
+            throw :result, false
+          end
+        else
+          self.class.members.each do |field|
+            print "#{pad} #{field}:#{self[field].class} = " if PrintDebug
+
+            unless self[field] == other[field]
+              binding.pry
+              puts "NO MATCH: #{self[field].to_s} #{other[field].to_s}" if PrintDebug
+              throw :result, false
+            end
+            puts "MATCH" if PrintDebug
+          end
+        end
+
+        true # Everything passed.
+
+      end
+      if PrintDebug
+        @@rec += -1
+        puts
+        puts "#{pad}RESULT = #{result}"
+      end
+      return result
+    end
+
+    # Default cast handler
+    def self.cast(something)
+      if something.kind_of? self
+        return something
+      elsif something.kind_of? Hash
+        common = (self.members & something.keys)
+        if common.empty?
+          raise "#{self} can't cast this Hash: #{something.inspect}"
+        else
+          tmp = self.new
+          common.each do |field|
+            tmp[field] = something[field]
+          end
+          return tmp
+        end        
+      elsif something.nil?
+        return something #TODO: Assume NUL is ok?
+      else
+        raise "#{self} can't cast #{something.insepct}"
       end
-      true # return true if we get this far.
     end
   end
 
   # FFI::ManagedStruct possibly with useful additions.
   class ManagedStruct < FFI::ManagedStruct
+    extend StructHelper
 
     # Allows create and use the struct within a block.
     def initialize(*args, &block)
@@ -88,7 +164,9 @@ module SDL2
 
   end
 
-  
+  class Union < FFI::Union
+    extend StructHelper
+  end
 
   class TypedPointer < Struct
 
@@ -126,7 +204,7 @@ module SDL2
   class UInt8Struct < TypedPointer
     type :uint8
   end
-  
+
   # TODO: Review if this is the best place to put it.
   # BlendMode is defined in a header file that is always included, so I'm
   # defineing again here.
@@ -148,7 +226,6 @@ module SDL2
 
 end
 
-
 require 'sdl2/init'
 
 #TODO: require 'sdl2/assert'