sdl2_ffi 0.0.6 → 0.0.7

data/lib/sdl2/joystick/components.rb

@@ -0,0 +1,23 @@
+module SDL2
+  ##
+  # A Joystick has all kinds of components, such as
+  class Joystick
+    ##
+    # Abstract component enumerator
+    # Requires :count and :[] to be defined
+    class Components
+      ##
+      # Initialize an enumeration
+      def initialize(for_joystick)
+        @joystick = for_joystick
+        raise "Must be an SDL2::Joystick, not a #{@joystick.class.to_s}" unless @joystick.kind_of?(SDL2::Joystick)
+      end
+      
+      ##
+      # Generate enumerator, captures all at call time
+      def each(&block)
+        count.times.map{|idx|self[idx]}.each(&block)
+      end
+    end
+  end
+end

data/lib/sdl2/joystick/hats.rb

@@ -0,0 +1,22 @@
+require 'sdl2/joystick/components'
+module SDL2
+  ##
+  # A Joystick may have many hats.
+  class Joystick
+    ##
+    # Enumerates hats on a joystick.
+    class Hats < Components
+      ##
+      # How many hats are there?
+      def count
+        SDL2::joystick_num_hats(@joystick)
+      end
+      ##
+      # Hat accessor via index
+      # @returns Integer (See: SDL2::HAT constants)
+      def [](idx)
+        SDL2::joystick_get_hat(@joystick,idx)       
+      end
+    end
+  end
+end

data/lib/sdl2/keyboard.rb

@@ -27,10 +27,12 @@ module SDL2
   #   get_keyboard_focus!
 	api :SDL_GetKeyboardFocus, [], Window.by_ref
 	  
+	  
+	  
   ##
 	#  brief Get a snapshot of the current state of the keyboard.
   #
-  #  @param numkeys if non-NULL, receives the length of the returned array.
+  #    *  numkeys if non-NULL, receives the length of the returned array.
   #
   #  @return An array of key states. 
 	#   Indexes into this array are obtained by using ::SDL_Scancode values.
@@ -43,9 +45,8 @@ module SDL2
   #    if state[SDL2::SCANCODE::RETURN]
   #      puts("<RETURN> is pressed.\n");
 	#    end
-	api :SDL_GetKeyboardState, [:pointer], :pointer
-	  
-  
+	api :SDL_GetKeyboardState, [TypedPointer::Int.by_ref], :pointer
+	
   ##
 	#
 	api :SDL_GetModState, [], :keymod
@@ -97,9 +98,11 @@ module SDL2
 	  
 	  # Get a snapshot of the current state of the keyboard.  
     def self.get_state()      
-      count = FFI::MemoryPointer.new :int, 1
-      state = FFI::Pointer.new :uint8, SDL2::get_keyboard_state(count)
-      result = state.get_array_of_int(0, count.get_int(0))      
+      count = SDL2::TypedPointer::Int.new
+      
+      state = SDL2::get_keyboard_state(count)
+      #binding.pry
+      result = state.get_array_of_uint8(:uint8, :get_uint8, count.value)      
       count.free
       state.free
       return result
@@ -114,8 +117,6 @@ module SDL2
     # @note This does not change the keyboard state, only the key modifier flags.
     def self.set_mod(modstate)
       SDL2::set_mod_state(modstate)
-    end
-    
-   
+    end 
 	end
 end

data/lib/sdl2/keycode.rb

@@ -17,76 +17,76 @@ module SDL2
     include EnumerableConstants
     UNKNOWN  =  0
 
-    RETURN  =  '\r'.codepoints()[0]
-    ESCAPE  =  '\033'.codepoints()[0]
-    BACKSPACE  =  '\b'.codepoints()[0]
-    TAB  =  '\t'.codepoints()[0]
-    SPACE  =  ' '.codepoints()[0]
-    EXCLAIM  =  '!'.codepoints()[0]
-    QUOTEDBL  =  '"'.codepoints()[0]
-    HASH  =  '#'.codepoints()[0]
-    PERCENT  =  '%'.codepoints()[0]
-    DOLLAR  =  '$'.codepoints()[0]
-    AMPERSAND  =  '&'.codepoints()[0]
-    QUOTE  =  '\''.codepoints()[0]
-    LEFTPAREN  =  '('.codepoints()[0]
-    RIGHTPAREN  =  ')'.codepoints()[0]
-    ASTERISK  =  '*'.codepoints()[0]
-    PLUS  =  '+'.codepoints()[0]
-    COMMA  =  ','.codepoints()[0]
-    MINUS  =  '-'.codepoints()[0]
-    PERIOD  =  '.'.codepoints()[0]
-    SLASH  =  '/'.codepoints()[0]
-    N0  =  '0'.codepoints()[0]
-    N1  =  '1'.codepoints()[0]
-    N2  =  '2'.codepoints()[0]
-    N3  =  '3'.codepoints()[0]
-    N4  =  '4'.codepoints()[0]
-    N5  =  '5'.codepoints()[0]
-    N6  =  '6'.codepoints()[0]
-    N7  =  '7'.codepoints()[0]
-    N8  =  '8'.codepoints()[0]
-    N9  =  '9'.codepoints()[0]
-    COLON  =  ':'.codepoints()[0]
-    SEMICOLON  =  ';'.codepoints()[0]
-    LESS  =  '<'.codepoints()[0]
-    EQUALS  =  '='.codepoints()[0]
-    GREATER  =  '>'.codepoints()[0]
-    QUESTION  =  '?'.codepoints()[0]
-    AT  =  '@'.codepoints()[0]
+    RETURN  =  "\r".bytes[0]
+    ESCAPE  =  "\033".bytes[0]
+    BACKSPACE  =  "\b".bytes[0]
+    TAB  =  "\t".bytes[0]
+    SPACE  =  ' '.bytes[0]
+    EXCLAIM  =  '!'.bytes[0]
+    QUOTEDBL  =  '"'.bytes[0]
+    HASH  =  '#'.bytes[0]
+    PERCENT  =  '%'.bytes[0]
+    DOLLAR  =  '$'.bytes[0]
+    AMPERSAND  =  '&'.bytes[0]
+    QUOTE  =  '\''.bytes[0]
+    LEFTPAREN  =  '('.bytes[0]
+    RIGHTPAREN  =  ')'.bytes[0]
+    ASTERISK  =  '*'.bytes[0]
+    PLUS  =  '+'.bytes[0]
+    COMMA  =  ','.bytes[0]
+    MINUS  =  '-'.bytes[0]
+    PERIOD  =  '.'.bytes[0]
+    SLASH  =  '/'.bytes[0]
+    N0  =  '0'.bytes[0]
+    N1  =  '1'.bytes[0]
+    N2  =  '2'.bytes[0]
+    N3  =  '3'.bytes[0]
+    N4  =  '4'.bytes[0]
+    N5  =  '5'.bytes[0]
+    N6  =  '6'.bytes[0]
+    N7  =  '7'.bytes[0]
+    N8  =  '8'.bytes[0]
+    N9  =  '9'.bytes[0]
+    COLON  =  ':'.bytes[0]
+    SEMICOLON  =  ';'.bytes[0]
+    LESS  =  '<'.bytes[0]
+    EQUALS  =  '='.bytes[0]
+    GREATER  =  '>'.bytes[0]
+    QUESTION  =  '?'.bytes[0]
+    AT  =  '@'.bytes[0]
 
-    LEFTBRACKET  =  '['.codepoints()[0]
-    BACKSLASH  =  '\\'.codepoints()[0]
-    RIGHTBRACKET  =  ']'.codepoints()[0]
-    CARET  =  '^'.codepoints()[0]
-    UNDERSCORE  =  '_'.codepoints()[0]
-    BACKQUOTE  =  '`'.codepoints()[0]
-    A  =  'a'.codepoints()[0]
-    B  =  'b'.codepoints()[0]
-    C  =  'c'.codepoints()[0]
-    D  =  'd'.codepoints()[0]
-    E  =  'e'.codepoints()[0]
-    F  =  'f'.codepoints()[0]
-    G  =  'g'.codepoints()[0]
-    H  =  'h'.codepoints()[0]
-    I  =  'i'.codepoints()[0]
-    J  =  'j'.codepoints()[0]
-    K  =  'k'.codepoints()[0]
-    L  =  'l'.codepoints()[0]
-    M  =  'm'.codepoints()[0]
-    N  =  'n'.codepoints()[0]
-    O  =  'o'.codepoints()[0]
-    P  =  'p'.codepoints()[0]
-    Q  =  'q'.codepoints()[0]
-    R  =  'r'.codepoints()[0]
-    S  =  's'.codepoints()[0]
-    T  =  't'.codepoints()[0]
-    U  =  'u'.codepoints()[0]
-    V  =  'v'.codepoints()[0]
-    W  =  'w'.codepoints()[0]
-    X  =  'x'.codepoints()[0]
-    Y  =  'y'.codepoints()[0]
-    Z  =  'z'.codepoints()[0]
+    LEFTBRACKET  =  '['.bytes[0]
+    BACKSLASH  =  "\\".bytes[0]
+    RIGHTBRACKET  =  ']'.bytes[0]
+    CARET  =  '^'.bytes[0]
+    UNDERSCORE  =  '_'.bytes[0]
+    BACKQUOTE  =  '`'.bytes[0]
+    A  =  'a'.bytes[0]
+    B  =  'b'.bytes[0]
+    C  =  'c'.bytes[0]
+    D  =  'd'.bytes[0]
+    E  =  'e'.bytes[0]
+    F  =  'f'.bytes[0]
+    G  =  'g'.bytes[0]
+    H  =  'h'.bytes[0]
+    I  =  'i'.bytes[0]
+    J  =  'j'.bytes[0]
+    K  =  'k'.bytes[0]
+    L  =  'l'.bytes[0]
+    M  =  'm'.bytes[0]
+    N  =  'n'.bytes[0]
+    O  =  'o'.bytes[0]
+    P  =  'p'.bytes[0]
+    Q  =  'q'.bytes[0]
+    R  =  'r'.bytes[0]
+    S  =  's'.bytes[0]
+    T  =  't'.bytes[0]
+    U  =  'u'.bytes[0]
+    V  =  'v'.bytes[0]
+    W  =  'w'.bytes[0]
+    X  =  'x'.bytes[0]
+    Y  =  'y'.bytes[0]
+    Z  =  'z'.bytes[0]
 
     CAPSLOCK  =  SDL2.scancode_to_keycode(SCANCODE::CAPSLOCK)
 
@@ -109,7 +109,7 @@ module SDL2
     INSERT  =  SDL2.scancode_to_keycode(SCANCODE::INSERT)
     HOME  =  SDL2.scancode_to_keycode(SCANCODE::HOME)
     PAGEUP  =  SDL2.scancode_to_keycode(SCANCODE::PAGEUP)
-    DELETE  =  '\177'.codepoints()[0]
+    DELETE  =  "\177".bytes[0]
     END_  =  SDL2.scancode_to_keycode(SCANCODE::END_)
     PAGEDOWN  =  SDL2.scancode_to_keycode(SCANCODE::PAGEDOWN)
     RIGHT  =  SDL2.scancode_to_keycode(SCANCODE::RIGHT)

data/lib/sdl2/library.rb

@@ -9,11 +9,7 @@ module SDL2
     # "xxx_yyyy_zzz" convetion
     def api(func_name, args, type, options = {})
 
-      options = {
-        :error => false,
-        :filter => type == :bool ? TRUE_WHEN_TRUE : TRUE_WHEN_ZERO
-      }.merge(options)
-
+      
       # TODO: Review ugly hack:
       remove_part = case self.to_s
       when "SDL2"
@@ -29,8 +25,13 @@ module SDL2
         /[A-Z][A-Z|0-9]*_/
       end
 
-      camelCaseName = func_name.to_s.gsub(remove_part,'')
-      methodName = ActiveSupport::Inflector.underscore(camelCaseName).to_sym
+      options = {
+        :error => false,
+        :filter => type == :bool ? OK_WHEN_TRUE : OK_WHEN_ZERO,
+        :method_name => ActiveSupport::Inflector.underscore(func_name.to_s.gsub(remove_part,'')).to_sym,
+      }.merge(options)
+
+      methodName = options[:method_name]
 
       attach_function methodName, func_name, args, type
             

data/lib/sdl2/log.rb

@@ -39,6 +39,7 @@ module SDL2
       RESERVED10    = next_const_value      
       CUSTOM        = next_const_value
     end
+    
     def self.<<(msg, *args)
       SDL2.log(msg, *args)
     end
@@ -70,6 +71,11 @@ module SDL2
     def self.get_priority(category)
       SDL2.log_get_priority(category)
     end
+    
+    def self.with_temp_priority(level)
+      raise "Block required" unless block_given?
+      old_cat = self.get_priority(category)
+    end
   end
 
   enum :log_priority, Log::PRIORITY.flatten_consts

data/lib/sdl2/managed_struct.rb

@@ -0,0 +1,17 @@
+module SDL2
+  ##
+  # 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)
+      SDL2::Debug.log(self){"Initializing with: #{args.inspect}"}
+      super(*args)
+      if block_given?
+        yield self
+      end
+    end
+
+    
+  end
+end

data/lib/sdl2/mixer.rb

@@ -35,7 +35,7 @@ module SDL2
     ##
     # This function gets the version of the dynamically linked SDL_mixer library.
     # :method: linked_version
-    api :Mix_Linked_Version, [], Version.auto_ptr
+    api :Mix_Linked_Version, [], Version.ptr
 
     enum :init_flags, INIT.flatten_consts
 
@@ -47,7 +47,7 @@ module SDL2
     #   Mix_Init(flags)
     #   init(flags)
     #   init!(flags)
-    api :Mix_Init, [:init_flags], :int, {error: true, filter: TRUE_WHEN_NOT_ZERO}
+    api :Mix_Init, [:init_flags], :int, {error: true, filter: OK_WHEN_NOT_ZERO}
 
     ##
     # Unloads libraries loaded with Mix_Init
@@ -110,6 +110,10 @@ module SDL2
       def self.pause
         Mixer::pause_music
       end
+      
+      def self.release(pointer)
+        Mixer::free_music(pointer)
+      end
     end
 
     ##
@@ -140,7 +144,7 @@ module SDL2
     # Load a wave file
     # :call-seq:
     #   load_wav_rw(src_rwops, freesrc)
-    api :Mix_LoadWAV_RW, [RWops.by_ref, :int], Chunk.auto_ptr
+    api :Mix_LoadWAV_RW, [RWops.by_ref, :int], Chunk.ptr
 
     ##
     # Load a wave file or a music (.mod .s3m .it .xm) file
@@ -148,30 +152,30 @@ module SDL2
       Mixer::load_wav_rw(RWops.from_file(filename, "rb"), 1)
     end
 
-    returns_error :load_wav, TRUE_WHEN_NOT_NULL
+    returns_error :load_wav, OK_WHEN_NOT_NULL
 
     ##
     # Load a wave file or a music (.mod .s3m .it .xm) file
     # :call-seq:
     #   load_mus(filepath)
-    api :Mix_LoadMUS, [:string], Music.auto_ptr, {error: true, filter: TRUE_WHEN_NOT_NULL}
+    api :Mix_LoadMUS, [:string], Music.ptr, {error: true, filter: OK_WHEN_NOT_NULL}
 
     ##
     # Load a music file from an SDL_RWop object (Ogg and MikMod specific currently)
     # Matt Campbell (matt@campbellhome.dhs.org) April 2000
-    api :Mix_LoadMUS_RW, [RWops.by_ref, :int], Music.auto_ptr
+    api :Mix_LoadMUS_RW, [RWops.by_ref, :int], Music.ptr
 
     ##
     # Load a music file from an SDL_RWop object assuming a specific format
-    api :Mix_LoadMUSType_RW, [RWops.by_ref, :music_type, :int], Music.auto_ptr
+    api :Mix_LoadMUSType_RW, [RWops.by_ref, :music_type, :int], Music.ptr
 
     ##
     # Load a wave file of the mixer format from a memory buffer
-    api :Mix_QuickLoad_WAV, [:pointer], Chunk.auto_ptr
+    api :Mix_QuickLoad_WAV, [:pointer], Chunk.ptr
 
     ##
     # Load raw audio data of the mixer format from a memory buffer
-    api :Mix_QuickLoad_RAW, [:pointer, :uint32], Chunk.auto_ptr
+    api :Mix_QuickLoad_RAW, [:pointer, :uint32], Chunk.ptr
 
     ##
     # Free an audio chunk previously loaded
@@ -597,7 +601,7 @@ module SDL2
     api :Mix_ResumeMusic, [], :void
     api :Mix_RewindMusic, [], :void
     api :Mix_PausedMusic, [], :int
-    boolean? :paused_music, TRUE_WHEN_NOT_ZERO
+    boolean? :paused_music, OK_WHEN_NOT_ZERO
     
 
     ##
@@ -612,10 +616,10 @@ module SDL2
     # Check the status of a specific channel.
     # If the specified channel is -1, check all channels.
     api :Mix_Playing, [:int], :int
-    boolean? :playing, TRUE_WHEN_ONE
+    boolean? :playing, OK_WHEN_ONE
 
     api :Mix_PlayingMusic, [], :int
-    boolean? :playing_music, TRUE_WHEN_ONE
+    boolean? :playing_music, OK_WHEN_ONE
 
     ##
     # Stop music and set external music playback command

data/lib/sdl2/mixer/chunk.rb

@@ -4,6 +4,7 @@ module SDL2
   
   module Mixer
     
+    ##
     # The internal format for an audio chunk
     #
     #  * allocated - :int
@@ -20,14 +21,17 @@ module SDL2
       member_readers *members
       member_writers *members
       
+      ##
+      # Load a chunk from a wave file path (string)
       def self.load_wav(filepath)
         Mixer.load_wav!(filepath)
       end
       
+      ##
       # Plays chunk
-      # @param opts[:channel]: defaults to -1
-      # @param opts[:loop]: defaults to 0
-      # @param opts[:ms]: defaults to -1
+      #   opts[:channel]: defaults to -1
+      #   opts[:loop]: defaults to 0
+      #   opts[:ms]: defaults to -1
       def play(opts = {})
         channel = opts[:channel] || -1
         loop = opts[:loop] || 0
@@ -35,11 +39,18 @@ module SDL2
         Mixer::play_channel_timed(channel, self, loop, ms)
       end
       
+      ##
       # Check if anything is playing?
       def self.playing?
         Mixer::playing?(-1)
       end
       
+      ## 
+      # Release this structure with Mixer::free_chunk
+      def self.release(pointer)
+        Mixer::free_chunk(pointer)
+      end
+      
     end
     
   end