sdl2_ffi 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60ab089f8e71037fce4c4f2a46cf5586db4af65f
-  data.tar.gz: cd50c7524713298ed2ad850d637a46f0c20d6347
+  metadata.gz: bcb36c1f56cfd2a4ad4920222e9713619e23355a
+  data.tar.gz: ef6c799ffadf4caa0d4d5a443e402f0391a47085
 SHA512:
-  metadata.gz: 8322d3174b86096df92c9fd2127b54604c3ef9e99a4f1c055bb56570e0e986bcd93fd8d576bd7d444daac7bca497162b5f0aea94eac8e5c58c113d62797034ea
-  data.tar.gz: 028e8e3b02c672c1fb45796bb21bdc8cb25f369b9cf34f8861e816f099f3a56277d7003ac5256efcbd697f7f88ed96299b41cbe4ebb0c6e1dd89c6ed0ba35d30
+  metadata.gz: 8d77dfe92939dab7ae53edb27a8b96c04941a951c0ce8aa6a9578767483becfb08c1ca85bc99c8c072cd3f034a4ebaeb929869f8fa98d2839694574986e73c59
+  data.tar.gz: 9a5b0026a3b60ee4b95af4f6011dc81f6c68c358e254df2c55bc41b000114d09c142f86c81c05d97b8fbedaa40eda30cec7c824363797a75eb31193e2c68f305

data/README.md

@@ -2,11 +2,12 @@
 
 [![Gem Version](https://badge.fury.io/rb/sdl2_ffi.png)](http://badge.fury.io/rb/sdl2_ffi)
 
-This is a simple interface to SDL2 for Ruby using FFI.  
-It also supports SDL_image and SDL_ttf.
-While a lot of the SDLlib, SDL_image, and SDL_ttf are linked, not all prototypes
-have been tested.  Large sections, such as "SDL_opengl<x>.h" have not been translated
-at all.
+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.
 
@@ -19,47 +20,6 @@ Otherwise, you can use RDoc to generate current source documentation.
  
 # How to start:
 
-The GEM is organized to the same structure as the SDL header files.  Where in C/C++ you would need to:
-
-    include 'SDL'
-    include 'SDL_image'
-    include 'SDL_ttf'
-    
-with this rubygem, you would instead:
-
-    require 'sdl2'
-    require 'sdl2/image'
-    require 'sdl2/ttf'
-    
-The SDL2 module is defined and it is where the raw SDL API is loaded and linked.  The Raw API can be called like so:
-
-    SDL2.init!(:EVERYTHING)
-	SDL2.was_init?(:EVERYTHING)
-    
-## More Examples:
-
-As a means of validating functionality, I am in the process of translating
-existing SDL Examples into Minitest [functional tests](https://github.com/BadQuanta/sdl2_ffi/tree/master/test/functional/examples).  
-
-
-## Dependencies
-
-* Obviously, ruby
-* SDL2 Runtime (Development files are not needed.)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'sdl2_ffi'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sdl2_ffi
     
 ## Testing
 
@@ -67,30 +27,32 @@ Minitests are being written to validate functionality. Not SDL's functionality,
 
 Run the tests with rake:
 
-    $ rake test
+    $ rake spec
+    
+Or:
+
+    $ ./bin/rspec ./spec -fd
     
-Verbose options are nice:
+### Approval Testing
 
-    $ rake test TESTOPTS="--verbose"
+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. :)
 
    
 ### 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
-so that the tests do not throw around a bunch of Windows on your scren.
-
-
-    
-### I need your help!
-
-I'm just starting to implement the Object Oriented Wrapper.  I'll need help identifying mistakes, especially in memory management.  Bug-reports submitted with tests will be looked at before bug-reports without tests, as a way to encourage tests being written.
-
-Thanks for reading this!
+so that the tests do not throw around a bunch of Windows on your screen.
 
 ## Usage
 
-The interface is intended to be modular and follows (roughly) SDL's header files.
+When you `require 'sdl2'`, 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.
+
 
 ## Contributing
 

data/lib/sdl2.rb

@@ -51,7 +51,7 @@ module SDL2
   # 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)
@@ -61,12 +61,23 @@ module SDL2
         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?
@@ -82,6 +93,8 @@ module SDL2
     #    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
@@ -93,22 +106,28 @@ module SDL2
       end
 
       result = catch(:result) do
-        unless self.class == other.class
+        unless self.class == other.class or other.kind_of? Hash
           puts "Class Mismatch" if PrintDebug
           throw :result, false
         end
 
-        if self.null? or other.null?
+        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
-          self.class.members.each do |field|
+          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]
-              binding.pry
+
               puts "NO MATCH: #{self[field].to_s} #{other[field].to_s}" if PrintDebug
               throw :result, false
             end
@@ -129,23 +148,41 @@ module SDL2
 
     # 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        
+
+        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

data/lib/sdl2/application.rb

@@ -0,0 +1,71 @@
+require 'sdl2/engine/engines'
+
+module SDL2
+
+  # A Top-Level SDL Application:
+  # An application 
+  
+  
+  class Application < Engine::Engines
+
+    attr_accessor :window
+    
+    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)
+      @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()      
+    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
+      times = 0
+      while (event = Event.poll()) and (cnt.nil? or (times+=1 < cnt))
+        puts "GOT: #{event.type}"if SDL2::PrintDebug
+        handle_event(event)
+      end
+
+      puts "Poll End"if SDL2::PrintDebug
+    end
+
+    attr_accessor :loop_count_limit
+
+  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
+        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
+      end
+    end
+
+  end
+
+end

data/lib/sdl2/audio.rb

@@ -98,45 +98,93 @@ module SDL2
   callback :audio_callback, [:pointer, :pointer, :int], :void
   callback :audio_filter, [Audio::CVT.by_ref, :audio_format], :void
 
-  api :SDL_GetNumAudioDrivers, [], :int
-  api :SDL_GetAudioDriver, [:int], :string
-  api :SDL_AudioInit, [:string], :int
-  api :SDL_AudioQuit, [], :void
-  api :SDL_GetCurrentAudioDriver, [], :string
-  api :SDL_OpenAudio, [Audio::Spec.by_ref, Audio::Spec.by_ref], :int
+  ##
+	#
+	api :SDL_GetNumAudioDrivers, [], :int
+  ##
+	#
+	api :SDL_GetAudioDriver, [:int], :string
+  ##
+	#
+	api :SDL_AudioInit, [:string], :int
+  ##
+	#
+	api :SDL_AudioQuit, [], :void
+  ##
+	#
+	api :SDL_GetCurrentAudioDriver, [], :string
+  ##
+	#
+	api :SDL_OpenAudio, [Audio::Spec.by_ref, Audio::Spec.by_ref], :int
 
   typedef :uint32, :audio_device_id
 
-  api :SDL_GetNumAudioDevices, [:int], :int
-  api :SDL_GetAudioDeviceName, [:int, :int], :string
-  api :SDL_OpenAudioDevice, [:string, :int, Audio::Spec.by_ref, Audio::Spec.by_ref, :int], :audio_device_id
+  ##
+	#
+	api :SDL_GetNumAudioDevices, [:int], :int
+  ##
+	#
+	api :SDL_GetAudioDeviceName, [:int, :int], :string
+  ##
+	#
+	api :SDL_OpenAudioDevice, [:string, :int, Audio::Spec.by_ref, Audio::Spec.by_ref, :int], :audio_device_id
 
   enum :audio_status, [:STOPPED, 0, :PLAYING, :PAUSED]
 
-  api :SDL_GetAudioStatus, [], :audio_status
-  api :SDL_PauseAudio, [:int], :void
-  api :SDL_PauseAudioDevice, [:audio_device_id, :int], :void
-  api :SDL_LoadWAV_RW, [RWops.by_ref, :int, Audio::Spec.by_ref, :pointer, :pointer], Audio::Spec.by_ref
+  ##
+	#
+	api :SDL_GetAudioStatus, [], :audio_status
+  ##
+	#
+	api :SDL_PauseAudio, [:int], :void
+  ##
+	#
+	api :SDL_PauseAudioDevice, [:audio_device_id, :int], :void
+  ##
+	#
+	api :SDL_LoadWAV_RW, [RWops.by_ref, :int, Audio::Spec.by_ref, :pointer, :pointer], Audio::Spec.by_ref
 
   def self.load_wav(file, spec, audio_buf, audio_len)
     load_wav_rw(rw_from_file)
   end
   
-  api :SDL_FreeWAV, [:pointer], :void
-  api :SDL_BuildAudioCVT, [Audio::CVT.by_ref, :audio_format, :uint8, :int, :audio_format, :uint8, :int], :int
-  api :SDL_ConvertAudio, [Audio::CVT.by_ref], :int
+  ##
+	#
+	api :SDL_FreeWAV, [:pointer], :void
+  ##
+	#
+	api :SDL_BuildAudioCVT, [Audio::CVT.by_ref, :audio_format, :uint8, :int, :audio_format, :uint8, :int], :int
+  ##
+	#
+	api :SDL_ConvertAudio, [Audio::CVT.by_ref], :int
   
   MIX_MAXVOLUME = 128
   
-  api :SDL_MixAudio, [:pointer, :pointer, :uint32, :int], :void
-  api :SDL_MixAudioFormat, [:pointer, :pointer, :audio_format, :uint32, :int], :void
-  api :SDL_LockAudio, [], :void
-  api :SDL_LockAudioDevice, [:audio_device_id], :void
-  api :SDL_UnlockAudio, [], :void
-  api :SDL_UnlockAudioDevice, [:audio_device_id], :void
+  ##
+	#
+	api :SDL_MixAudio, [:pointer, :pointer, :uint32, :int], :void
+  ##
+	#
+	api :SDL_MixAudioFormat, [:pointer, :pointer, :audio_format, :uint32, :int], :void
+  ##
+	#
+	api :SDL_LockAudio, [], :void
+  ##
+	#
+	api :SDL_LockAudioDevice, [:audio_device_id], :void
+  ##
+	#
+	api :SDL_UnlockAudio, [], :void
+  ##
+	#
+	api :SDL_UnlockAudioDevice, [:audio_device_id], :void
     
-  api :SDL_CloseAudio, [], :void
-  api :SDL_CloseAudioDevice, [:audio_device_id], :void
+  ##
+	#
+	api :SDL_CloseAudio, [], :void
+  ##
+	#
+	api :SDL_CloseAudioDevice, [:audio_device_id], :void
   
 
 end

data/lib/sdl2/clipboard.rb

@@ -21,7 +21,13 @@ module SDL2
     end
   end
 
-  api :SDL_SetClipboardText, [:string], :int
-  api :SDL_GetClipboardText, [], :string
-  api :SDL_HasClipboardText, [], :bool
+  ##
+	#
+	api :SDL_SetClipboardText, [:string], :int
+  ##
+	#
+	api :SDL_GetClipboardText, [], :string
+  ##
+	#
+	api :SDL_HasClipboardText, [], :bool
 end