sdl2_ffi 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb36c1f56cfd2a4ad4920222e9713619e23355a
-  data.tar.gz: ef6c799ffadf4caa0d4d5a443e402f0391a47085
+  metadata.gz: 8dbaffe7bb73a594ee376109bd30462993f4bc57
+  data.tar.gz: edb658af105c6b0a5a97a2671abd027171d89d14
 SHA512:
-  metadata.gz: 8d77dfe92939dab7ae53edb27a8b96c04941a951c0ce8aa6a9578767483becfb08c1ca85bc99c8c072cd3f034a4ebaeb929869f8fa98d2839694574986e73c59
-  data.tar.gz: 9a5b0026a3b60ee4b95af4f6011dc81f6c68c358e254df2c55bc41b000114d09c142f86c81c05d97b8fbedaa40eda30cec7c824363797a75eb31193e2c68f305
+  metadata.gz: 5b232c50359ed505954197784ca922ff61ce4477ae24f8f0759af722aa7bdf095cf4101a5bc80871e008ebdbb1663be24e7b1fce26658cdfb390433317d2d0e2
+  data.tar.gz: 1326ddfc32e471b20c83b3730a6d8fa0166c4745bbb696227b646276aa723d0980aa7a9e472a5fc61aba89a60e0de300805357eb31adaf4c728ce17932cbeb7f

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0-p247
+ruby-2.1.1

data/Gemfile

@@ -2,9 +2,3 @@ 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,55 +1,10 @@
 # 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' }
-#
-#  # 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
 
 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 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" }
-
-  # Capybara features specs
-  #watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.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/README.md

@@ -1,29 +1,21 @@
-# sdl2_ffi
+# sdl2_ffi June, 2014
 
 [![Gem Version](https://badge.fury.io/rb/sdl2_ffi.png)](http://badge.fury.io/rb/sdl2_ffi)
 
-The sdl2_ffi makes SDL2 fun and easy, eventually. This is still a new project
-and I am still implementing major sections of it.  Check out the 
-[approvals](https://github.com/BadQuanta/sdl2_ffi/tree/master/spec/fixtures/approvals)
-to get an idea of how much is working.  These are screen-shots of SDL generated
-content.  Approval testing is used to validate functionality.
-
-
-The "Object Oriented" part of this interface has barely started.
+A Ruby interface to the SDL2 dynamic libraries, with support for SDL2_ttf, SDL2_mixer(with smpeg2), SDL2_image.
 
 # Documentation/API Reference:
 
+The API's functionality [RSpecs](https://github.com/BadQuanta/sdl2_ffi/tree/master/spec) can be used as a reference.
+
 For the latest released gem, [rubydoc.info](http://rubydoc.info/) has the
 [automatically generated documentation](http://rubydoc.info/gems/sdl2_ffi/frames).
 
 Otherwise, you can use RDoc to generate current source documentation.
  
-# How to start:
-
-    
 ## Testing
 
-Minitests are being written to validate functionality. Not SDL's functionality, but that the GEM has been linked properly and that the Object Oriented wrapper functions as intended.
+Specs define the scope of what interfaces have been written and tested.
 
 Run the tests with rake:
 
@@ -35,21 +27,19 @@ Or:
     
 ### Approval Testing
 
-This project now uses Approval testing.  At the moment, I'm using a custom
-'approvals' gem which is specified in the Gemfile, as opposed to the Gemspec.
-This is only temporary.  The approved specifications are in the repository 
-and can act as a repository of screen shots. :)
-
+Parts of the API are verified via "Approvals" which are PNG captures of SDL Surfaces,
+on each run of an "Approved" rendering, the dumped PNGs are compared against each other.
+Feel free to update these tests and "approve" the new PNGs.
    
 ### Testing Under *nix & X11
 
 If you are testing under some kind of unix system with X11 and have Xnest available,
-I'd recommend starting up Xnest and changing your testing terminal DISPLAY value
+I'd recommend starting up Xnest or Xephyr and changing your testing terminal DISPLAY value
 so that the tests do not throw around a bunch of Windows on your screen.
 
 ## Usage
 
-When you `require 'sdl2'`, it should give you the same things that
+When you `require 'sdl2_ffi'`, it should give you the same things that
 include 'SDL.h' would have done.  See the specs for examples.  There are C/C++
 tutorials that have been translated as a means of validating functionality.
 
@@ -64,4 +54,4 @@ libSDL 2.0 is licensed under the 'zlib license', listed as compatible with the G
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-I specifically need help writing the minitest code.  
+New Issues welcome.  

data/lib/bad_sdl.rb

@@ -0,0 +1,4 @@
+
+module BadSdl
+  
+end

data/lib/{sdl2 → bad_sdl}/application.rb

@@ -1,71 +1,83 @@
-require 'sdl2/engine/engines'
-
-module SDL2
+require 'bad_sdl'
+require 'sdl2'
+require 'bad_sdl/engine/engines'
 
+module BadSdl
+  ##
   # A Top-Level SDL Application:
-  # An application 
-  
-  
+  # An application
+  # TODO: Review SDL2::Application for removal
   class Application < Engine::Engines
-
+  
     attr_accessor :window
-    
-    def initialize(opts = {})      
+  
+    def initialize(opts = {})
       super(opts)
-      
-      title = opts[:title] || self.to_s
-      x = opts[:x] || :CENTERED
-      y = opts[:y] || :CENTERED
-      w = opts[:w] || 640
-      h = opts[:h] || 480
-      flags = opts[:flags] || :SHOWN
-
-      @window = Window.create(title, x, y, w, h, flags)
+  
+      opts[:title] ||= self.to_s
+      opts[:width] ||= 640
+      opts[:height] ||= 480
+      opts[:flags] ||= :SHOWN
+  
+      @window = Window.create(opts)
       @window.surface.fill_rect(@window.surface.rect, [0,0,0,SDL2::ALPHA_OPAQUE])
-
+  
       # Default ON handler for :QUIT events:
       self.on({type: :QUIT}) do |event|
         @quit_loop = true
       end
-
+  
     end
-
+  
     def quit()
-      @window.free
-      super()      
+      @window.destroy
+      super()
     end
-
+  
     attr_accessor :poll_count_limit
-
+  
     # What makes an engine an "Application" is that it takes control of event
     # polling.  There should only ever be one "Application"
     def poll(cnt = poll_count_limit)
-      puts "Poll Start" if SDL2::PrintDebug
+      Debug.log(self){"Poll Start"}
       times = 0
       while (event = Event.poll()) and (cnt.nil? or (times+=1 < cnt))
-        puts "GOT: #{event.type}"if SDL2::PrintDebug
+        Debug.log(self){"GOT: #{event.type}"}
         handle_event(event)
       end
-
-      puts "Poll End"if SDL2::PrintDebug
+  
+      Debug.log(self){"Poll End"}
     end
-
+  
     attr_accessor :loop_count_limit
-
-  def loop(cnt = loop_count_limit, opts ={})      
+  
+    def loop(cnt = loop_count_limit, opts ={})
       @quit_loop = false
       times = 0
+  
       while (cnt.nil?) or ((times+=1) <= cnt)
-        puts ">>> Loop##{times}" if SDL2::PrintDebug
+        before_loop.each(&:call)
         poll # Process input
         break if @quit_loop
         # Update the surface when we are painted to
         @window.update_surface if paint_to(@window.surface)
-        puts "<<< Loop##{times}" if SDL2::PrintDebug
         delay(opts[:delay]) if opts.has_key? :delay
+        after_loop.each(&:call)
       end
+  
+    end
+  
+    def before_loop(&block)
+      @before_loop ||= []
+      @before_loop << block unless block.nil?
+      @before_loop
+    end
+  
+    def after_loop(&block)
+      @after_loop ||= []
+      @after_loop << block unless block.nil?
+      @after_loop
     end
-
   end
 
 end

data/lib/{sdl2 → bad_sdl}/engine.rb

@@ -1,7 +1,9 @@
+require 'bad_sdl'
 require 'sdl2'
 
-module SDL2
 
+module BadSdl
+	
   # Input/Output engine.
   class Engine
 
@@ -40,9 +42,24 @@ module SDL2
       return false # if we get to here.
     end
 
-    # This routine should be overriden.
+    # This routine should be overridden.
     def paint_to(surface)
-      false
+      result = false
+            
+      painter.each do |one|
+        
+        result = true if one.call(surface)
+      end
+      
+      return result
+    end
+    
+    def painter(&block)
+      @painter ||= []
+      @painter << block unless block.nil?      
+      
+      @painter
+      
     end
 
     protected

data/lib/{sdl2 → bad_sdl}/engine/block_engine.rb

@@ -1,6 +1,6 @@
-require 'sdl2/engine'
+require 'bad_sdl/engine'
 
-module SDL2
+module BadSdl
 
   class Engine
 

data/lib/bad_sdl/engine/engines.rb

@@ -0,0 +1,51 @@
+require 'bad_sdl/engine'
+require 'sdl2/debug'
+
+module BadSdl
+  class Engine
+    # An engine multiplexor.
+    # Only has one focus, but that focus can change.
+    class Engines < Engine
+  
+      def initialize(opts)
+        super(opts)
+        @engines = [] #opts[:engines] || []
+        @current_idx = 0
+      end
+  
+      attr_reader :engines
+  
+      def current_engine
+        @engines[@current_idx]
+      end
+  
+      def handle_event(event)
+        return true if super(event) # self swallowed event.
+        if current_engine
+          Debug.log(self){"Passing to current engine."}
+          return true if current_engine.handle_event(event)
+        end
+        SDL2::Debug.log(self){"Unable to handle"}
+        return false # if we get to here.
+      end
+  
+      def paint_to(surface)      
+        result = false
+                    
+        result = true if super(surface)
+        
+        if ce = current_engine
+          result = true if ce.paint_to(surface)
+        end
+        return result
+      end
+      
+      def quit()
+        @engines.each(&:quit)
+        super()
+      end
+  
+    end
+  
+  end
+end

data/lib/enumerable_constants.rb

@@ -77,7 +77,7 @@ module EnumerableConstants
       # Get the last defined value.
       def self.last_const_value
         if self.constants.empty?
-          return 0
+          return -1
         else
           return self.const_get(self.constants.last)
         end
@@ -88,7 +88,9 @@ module EnumerableConstants
       def self.next_const_value
         last_const_value.next
       end
-
+      
+      ##
+      # Set the value of undefined constants to the next constant value.
       def self.const_missing(const)
         self.const_set(const, next_const_value)
       end

data/lib/sdl2.rb

@@ -2,267 +2,48 @@ require 'sdl2/sdl_module'
 require 'active_support/inflector'
 require 'enumerable_constants'
 require 'sdl2/stdinc'
-
-# libSDL2's prototypes are attached directly to this module.
-#
+require 'sdl2/debug'
+# The SDL2 Map of API Prototypes
 module SDL2
   extend FFI::Library
   extend Library
   ffi_lib SDL_MODULE
+  
+  ##
+  # StructHelper defines a couple of handy macros, useful in structures and unions.
+  autoload(:StructHelper, 'sdl2/struct_helper')  
 
-  PrintDebug = false
-
-  module StructHelper
-
-    # Define a set of member readers
-    # Ex1: `member_readers [:one, :two, :three]`
-    # Ex2: `member_readers *members`
-    def member_readers(*members_to_define)
-      #self.class_eval do
-      members_to_define.each do |member|
-        define_method member do
-          self[member]
-        end
-      end
-      #end
-    end
-
-    # Define a set of member writers
-    # 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
-        end
-      end
-    end
-
-  end
-
-  # Augmented for compares with anything that can be an array
+  ##
+  # FFI::Struct::InlineArray is modified to allow == operations, may not be effecient but seems to work.
   class FFI::Struct::InlineArray
-
     def ==(other)
       self.to_a == other.to_a
     end
   end
-
-  # 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
-    
-    # Placeholder for Structs that need to initialize values.
-    def self.create(values = {})
-      created = self.new
-      created.update_members(values)
-      created
-    end
-
-    # A default release scheme is defined, but should be redefined where appropriate.
-    def self.release(pointer)
-      pointer.free
-    end
-
-    def free()
-      self.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.
-    # This will return true if compared to a "partial hash",
-    # if all the keys the hash defines equal
-    def ==(other)
-      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 or other.kind_of? Hash
-          puts "Class Mismatch" if PrintDebug
-          throw :result, false
-        end
-
-        if (other.kind_of? Hash) and (other.keys - members).any?
-          puts "Extra Keys: #{other.keys-members}"
-          thorw :result, false
-        end
-
-        if (other.respond_to?:null?) and (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
-          fields = other.kind_of?(Hash) ? members & other.keys : members
-          fields.each do |field|
-            print "#{pad} #{field}:#{self[field].class} = " if PrintDebug
-
-            unless self[field] == other[field]
-
-              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
-
-        return self.create(something)
-
-      elsif something.nil?
-      
-        return something #TODO: Assume NUL is ok?
-      
-      else
-        
-        raise "#{self} can't cast #{something.insepct}"
-      
-      end
-    end
-
-    # Set members to values contained within hash.
-    def update_members(values)
-      if values.kind_of? Array
-        raise "#{self} has less fields then #{values.inspect}" if values.count > members.count
-        members.first(values.count).each_with_index do |field, idx|
-          self[field] = values[idx]
-        end
-
-      elsif values.kind_of? Hash
-        common = (self.members & values.keys)
-        common.each do |field|
-          self[field] = values[field]
-        end
-      else
-        raise "#{self}#update_members unable to update from #{values.inspect}"
-      end
-    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)
-      super(*args)
-      if block_given?
-        yield self
-      end
-    end
-
-  end
-
-  class Union < FFI::Union
-    extend StructHelper
-  end
-
-  class TypedPointer < Struct
-
-    def self.type(kind)
-      layout :value, kind
-    end
-
-    def value
-      self[value]
-    end
-
-    alias_method :deref, :value
-  end
-
-  # Simple Type Structures to interface 'typed-pointers'
-  # TODO: Research if this is the best way to handle 'typed-pointers'
-  class FloatPointer < TypedPointer
-    type :float
-  end
-
-  # Int-typed pointer
-  class IntStruct < TypedPointer
-    type :int
-  end
-
-  #
-  class UInt16Struct < TypedPointer
-    type :uint16
-  end
-
-  class UInt32Struct < TypedPointer
-    type :uint32
-  end
-
-  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.
-  enum :blend_mode, [
-    :none, 0x00000000,
-    :blend, 0x00000001,
-    :add, 0x00000002,
-    :mod, 0x00000004
-  ]
-
-  class BlendModeStruct < Struct
-    layout :value, :blend_mode
-  end
-
-  typedef :uint32, :pixel_format
+  
+  ##
+  # Struct is locally defined, inheriting from FFI::Struct
+  # The original FFI::Struct is unmodified
+  autoload(:Struct, 'sdl2/struct')  
+  ##
+  # StructArray is a helper for Pointer of Structs.
+  autoload(:StructArray, File.expand_path('../struct_array.rb', __FILE__))
+  ##
+  # TOOD: ManagedStruct is currently unused, and may not be.
+  # I have run into trouble using FFI::Struct.auto_ptr
+  autoload(:ManagedStruct, 'sdl2/managed_struct')
+  autoload(:Union, 'sdl2/union')
+  autoload(:TypedPointer, 'sdl2/typed_pointer')
+  
+  autoload(:BLENDMODE, 'sdl2/blendmode')
+  
 
   # Simple typedef to represent array sizes.
   typedef :int, :count
 
 end
 
+require 'sdl2/blendmode'
 require 'sdl2/init'
 
 #TODO: require 'sdl2/assert'
@@ -278,8 +59,6 @@ require 'sdl2/joystick'
 require 'sdl2/gamecontroller'
 require 'sdl2/haptic'
 require 'sdl2/hints'
-
-#TODO?: require 'sdl2/loadso'
 require 'sdl2/log'
 
 #TODO: require 'sdl2/messagebox'