hybridgroup-ruby-sdl-ffi 0.4.1

data/lib/ruby-sdl-ffi/sdl/keysyms.rb

@@ -0,0 +1,282 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2009 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#++
+
+
+module SDL
+
+  K_FIRST        = 0
+  K_UNKNOWN      = 0
+  K_BACKSPACE    = 8
+  K_TAB          = 9
+  K_CLEAR        = 12
+  K_RETURN       = 13
+  K_PAUSE        = 19
+  K_ESCAPE       = 27
+  K_SPACE        = 32
+  K_EXCLAIM      = 33
+  K_QUOTEDBL     = 34
+  K_HASH         = 35
+  K_DOLLAR       = 36
+  K_AMPERSAND    = 38
+  K_QUOTE        = 39
+  K_LEFTPAREN    = 40
+  K_RIGHTPAREN   = 41
+  K_ASTERISK     = 42
+  K_PLUS         = 43
+  K_COMMA        = 44
+  K_MINUS        = 45
+  K_PERIOD       = 46
+  K_SLASH        = 47
+  K_0            = 48
+  K_1            = 49
+  K_2            = 50
+  K_3            = 51
+  K_4            = 52
+  K_5            = 53
+  K_6            = 54
+  K_7            = 55
+  K_8            = 56
+  K_9            = 57
+  K_COLON        = 58
+  K_SEMICOLON    = 59
+  K_LESS         = 60
+  K_EQUALS       = 61
+  K_GREATER      = 62
+  K_QUESTION     = 63
+  K_AT           = 64
+  K_LEFTBRACKET  = 91
+  K_BACKSLASH    = 92
+  K_RIGHTBRACKET = 93
+  K_CARET        = 94
+  K_UNDERSCORE   = 95
+  K_BACKQUOTE    = 96
+  K_a            = 97
+  K_b            = 98
+  K_c            = 99
+  K_d            = 100
+  K_e            = 101
+  K_f            = 102
+  K_g            = 103
+  K_h            = 104
+  K_i            = 105
+  K_j            = 106
+  K_k            = 107
+  K_l            = 108
+  K_m            = 109
+  K_n            = 110
+  K_o            = 111
+  K_p            = 112
+  K_q            = 113
+  K_r            = 114
+  K_s            = 115
+  K_t            = 116
+  K_u            = 117
+  K_v            = 118
+  K_w            = 119
+  K_x            = 120
+  K_y            = 121
+  K_z            = 122
+  K_DELETE       = 127
+  K_WORLD_0      = 160
+  K_WORLD_1      = 161
+  K_WORLD_2      = 162
+  K_WORLD_3      = 163
+  K_WORLD_4      = 164
+  K_WORLD_5      = 165
+  K_WORLD_6      = 166
+  K_WORLD_7      = 167
+  K_WORLD_8      = 168
+  K_WORLD_9      = 169
+  K_WORLD_10     = 170
+  K_WORLD_11     = 171
+  K_WORLD_12     = 172
+  K_WORLD_13     = 173
+  K_WORLD_14     = 174
+  K_WORLD_15     = 175
+  K_WORLD_16     = 176
+  K_WORLD_17     = 177
+  K_WORLD_18     = 178
+  K_WORLD_19     = 179
+  K_WORLD_20     = 180
+  K_WORLD_21     = 181
+  K_WORLD_22     = 182
+  K_WORLD_23     = 183
+  K_WORLD_24     = 184
+  K_WORLD_25     = 185
+  K_WORLD_26     = 186
+  K_WORLD_27     = 187
+  K_WORLD_28     = 188
+  K_WORLD_29     = 189
+  K_WORLD_30     = 190
+  K_WORLD_31     = 191
+  K_WORLD_32     = 192
+  K_WORLD_33     = 193
+  K_WORLD_34     = 194
+  K_WORLD_35     = 195
+  K_WORLD_36     = 196
+  K_WORLD_37     = 197
+  K_WORLD_38     = 198
+  K_WORLD_39     = 199
+  K_WORLD_40     = 200
+  K_WORLD_41     = 201
+  K_WORLD_42     = 202
+  K_WORLD_43     = 203
+  K_WORLD_44     = 204
+  K_WORLD_45     = 205
+  K_WORLD_46     = 206
+  K_WORLD_47     = 207
+  K_WORLD_48     = 208
+  K_WORLD_49     = 209
+  K_WORLD_50     = 210
+  K_WORLD_51     = 211
+  K_WORLD_52     = 212
+  K_WORLD_53     = 213
+  K_WORLD_54     = 214
+  K_WORLD_55     = 215
+  K_WORLD_56     = 216
+  K_WORLD_57     = 217
+  K_WORLD_58     = 218
+  K_WORLD_59     = 219
+  K_WORLD_60     = 220
+  K_WORLD_61     = 221
+  K_WORLD_62     = 222
+  K_WORLD_63     = 223
+  K_WORLD_64     = 224
+  K_WORLD_65     = 225
+  K_WORLD_66     = 226
+  K_WORLD_67     = 227
+  K_WORLD_68     = 228
+  K_WORLD_69     = 229
+  K_WORLD_70     = 230
+  K_WORLD_71     = 231
+  K_WORLD_72     = 232
+  K_WORLD_73     = 233
+  K_WORLD_74     = 234
+  K_WORLD_75     = 235
+  K_WORLD_76     = 236
+  K_WORLD_77     = 237
+  K_WORLD_78     = 238
+  K_WORLD_79     = 239
+  K_WORLD_80     = 240
+  K_WORLD_81     = 241
+  K_WORLD_82     = 242
+  K_WORLD_83     = 243
+  K_WORLD_84     = 244
+  K_WORLD_85     = 245
+  K_WORLD_86     = 246
+  K_WORLD_87     = 247
+  K_WORLD_88     = 248
+  K_WORLD_89     = 249
+  K_WORLD_90     = 250
+  K_WORLD_91     = 251
+  K_WORLD_92     = 252
+  K_WORLD_93     = 253
+  K_WORLD_94     = 254
+  K_WORLD_95     = 255
+  K_KP0          = 256
+  K_KP1          = 257
+  K_KP2          = 258
+  K_KP3          = 259
+  K_KP4          = 260
+  K_KP5          = 261
+  K_KP6          = 262
+  K_KP7          = 263
+  K_KP8          = 264
+  K_KP9          = 265
+  K_KP_PERIOD    = 266
+  K_KP_DIVIDE    = 267
+  K_KP_MULTIPLY  = 268
+  K_KP_MINUS     = 269
+  K_KP_PLUS      = 270
+  K_KP_ENTER     = 271
+  K_KP_EQUALS    = 272
+  K_UP           = 273
+  K_DOWN         = 274
+  K_RIGHT        = 275
+  K_LEFT         = 276
+  K_INSERT       = 277
+  K_HOME         = 278
+  K_END          = 279
+  K_PAGEUP       = 280
+  K_PAGEDOWN     = 281
+  K_F1           = 282
+  K_F2           = 283
+  K_F3           = 284
+  K_F4           = 285
+  K_F5           = 286
+  K_F6           = 287
+  K_F7           = 288
+  K_F8           = 289
+  K_F9           = 290
+  K_F10          = 291
+  K_F11          = 292
+  K_F12          = 293
+  K_F13          = 294
+  K_F14          = 295
+  K_F15          = 296
+  K_NUMLOCK      = 300
+  K_CAPSLOCK     = 301
+  K_SCROLLOCK    = 302
+  K_RSHIFT       = 303
+  K_LSHIFT       = 304
+  K_RCTRL        = 305
+  K_LCTRL        = 306
+  K_RALT         = 307
+  K_LALT         = 308
+  K_RMETA        = 309
+  K_LMETA        = 310
+  K_LSUPER       = 311
+  K_RSUPER       = 312
+  K_MODE         = 313
+  K_COMPOSE      = 314
+  K_HELP         = 315
+  K_PRINT        = 316
+  K_SYSREQ       = 317
+  K_BREAK        = 318
+  K_MENU         = 319
+  K_POWER        = 320
+  K_EURO         = 321
+  K_UNDO         = 322
+  K_LAST         = 323
+
+  KMOD_NONE      = 0x0000
+  KMOD_LSHIFT    = 0x0001
+  KMOD_RSHIFT    = 0x0002
+  KMOD_LCTRL     = 0x0040
+  KMOD_RCTRL     = 0x0080
+  KMOD_LALT      = 0x0100
+  KMOD_RALT      = 0x0200
+  KMOD_LMETA     = 0x0400
+  KMOD_RMETA     = 0x0800
+  KMOD_NUM       = 0x1000
+  KMOD_CAPS      = 0x2000
+  KMOD_MODE      = 0x4000
+  KMOD_RESERVED  = 0x8000
+
+end

data/lib/ruby-sdl-ffi/sdl/mac.rb

@@ -0,0 +1,443 @@
+#--
+#
+# This file is one part of:
+#
+# Ruby-SDL-FFI - Ruby-FFI bindings to SDL
+#
+# Copyright (c) 2010 John Croisant
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+#
+# Contributions:
+#
+#  - Bart Leusink, 2011-01-22:
+#    Fixed the display window not gaining focus on Mac OS X 10.6.
+#
+#++
+
+#--
+# Some bindings to Mac OS X system framework to allow Ruby-SDL-FFI
+# to create a window on Mac without a special Ruby interpreter (rsdl).
+# These are for internal use only. They are NOT part of the API.
+#
+# Eternal thanks to erisdiscord and jlnr for pointing the way!
+
+
+# Only define this stuff if running on a Mac and not using rsdl and
+# the RUBYSDLFFI_NOCOCOA environment variable is not true-ish.
+if FFI::Platform.mac? and ($0 != "rsdl") and \
+  not (/^(1|t|true|y|yes)$/i =~ ENV["RUBYSDLFFI_NOCOCOA"])
+
+  module SDL::Mac
+
+    class << self
+      
+      def make_menus( app_name )
+        ptr = FFI.find_type(:pointer)
+        
+        nsapp = Cocoa.NSApp
+        menubar = Cocoa::NSMenu.new.initWithTitle("AMainMenu")
+        nsapp.msg( "setMainMenu:", ptr, menubar )
+        
+        remove_bold_menu( nsapp, menubar )
+        make_app_menu( menubar, app_name )
+        make_window_menu( nsapp, menubar )
+
+        nil
+      end
+      
+      
+      def set_app_name( app_name )
+        ptr = FFI.find_type(:pointer)
+        
+        if @appmenuitem
+          @appmenuitem.title = app_name
+          @hideitem.title = "Hide #{app_name}" if @hideitem
+          @quititem.title = "Quit #{app_name}" if @quititem
+        else
+          make_menus( app_name )
+        end
+        
+        nil
+      end
+      
+      
+      private
+      
+      # Hack to remove the bold "ruby" menu (aka the "Apple" menu).
+      # It's a ghost menu, it haunts us but can't be modified.
+      def remove_bold_menu( nsapp, menubar )
+        item = Cocoa::NSMenuItem.new.initWithTitle("AppleMenu")
+        menu = Cocoa::NSMenu.new.initWithTitle("AppleMenu")
+        item.submenu = menu
+        
+        nsapp.msg("setAppleMenu:", FFI.find_type(:pointer), menu)
+        menubar.addItem(item)
+        menubar.removeItem(item)
+        
+        item.release
+        menu.release
+      end
+      
+      
+      # Create the main menu with the app's name (Hide, Quit, etc.)
+      def make_app_menu( menubar, app_name )
+        item = Cocoa::NSMenuItem.new.initWithTitle( app_name )
+        menu = Cocoa::NSMenu.new.initWithTitle( app_name )
+        item.submenu = menu
+        menubar.addItem(item)
+        
+        @hideitem = menu.addItemWithTitle("Hide #{app_name}", "hide:")
+        menu.addItemWithTitle("Hide Others", "hideOtherApplications:")
+        menu.addItemWithTitle("Show All", "unhideAllApplications:")
+
+        # Can't get the Quit menu item to work right yet.
+        # menu.addItem( Cocoa::NSMenuItem.separatorItem )
+        # @quititem = menu.addItemWithTitle("Quit #{app_name}", "terminate:")
+        
+        @appmenuitem = item
+        menu.release
+      end
+      
+      
+      # Create the "Window" menu (Minimize, etc.)
+      def make_window_menu( nsapp, menubar )
+        ptr = FFI.find_type(:pointer)
+        
+        item = Cocoa::NSMenuItem.new.initWithTitle("Window")
+        menu = Cocoa::NSMenu.new.initWithTitle("Window")
+        item.submenu = menu
+        menubar.addItem(item)
+        nsapp.msg("setWindowsMenu:", ptr, menu)
+        
+        menu.addItemWithTitle("Minimize", "performMiniaturize:")
+        
+        item.release
+        menu.release
+      end
+
+
+      def inspect_menu( menu, indent="" )
+        puts "%s-%s  (%s \"%s\", %d items)"%[indent, menu, menu.classname,
+                                             menu.title, menu.length]
+        menu.each do |ob|
+          if ob.hasSubmenu?
+            inspect_menu( ob.submenu, indent+"  " )
+          else
+            puts "%s  -%s  (%s \"%s\")"%[indent, ob, ob.classname, ob.title]
+          end
+        end
+      end
+
+    end
+
+
+    module ObjC
+      extend NiceFFI::Library
+      load_library 'objc'
+
+      typedef :pointer, :id
+      typedef :pointer, :sel
+      typedef :pointer, :ivar
+      typedef :pointer, :nsclass
+      callback :imp, [:id, :sel, :varargs], :id
+
+
+      class NSObject < NiceFFI::OpaqueStruct
+        def self.nsclassname; name.split("::")[-1]; end
+
+        # define msg, msg_ptr, msg_str, msg_int, msg_bool (and class methods)
+        ["", "_ptr", "_str", "_int", "_bool"].each do |suffix|
+          module_eval("
+            def msg#{suffix}( message, *args )
+              ObjC.msgSend#{suffix}( @pointer, message, *args )
+            end
+
+            def self.msg#{suffix}( message, *args )
+              ObjC.msgSend#{suffix}( ObjC.NSClass(self.nsclassname),
+                                                  message, *args )
+            end")
+        end
+
+        def inspect; msg_str("description").to_s; end
+        def nsclassname; ObjC.object_getClassName(@pointer); end
+        def release; msg("release"); end
+      end
+
+      def self.NSObject( *args )
+        NSObject.new( *args )
+      end
+
+
+      class NSClass < NSObject
+        def initialize( str_or_ptr )
+          if str_or_ptr.is_a? String
+            super( ObjC.getClass(str_or_ptr) )
+          else
+            super
+          end
+        end
+      end
+
+      def self.NSClass( *args )
+        NSClass.new( *args )
+      end
+
+
+      class NSString < NSObject
+        def initialize( str_or_ptr )
+          if str_or_ptr.is_a? String
+            super( ObjC::NSClass("NSString").\
+                     msg_ptr("stringWithUTF8String:",
+                             FFI.find_type(:string), str_or_ptr) )
+          else
+            super
+          end
+        end
+
+        def to_s
+          str = msg_ptr( "UTF8String" )
+          (str.null?) ? "(NULL)" : str.read_string()
+        end
+      end
+
+      def self.NSString( *args )
+        NSString.new( *args )
+      end
+
+
+      func :__msgSend, :objc_msgSend, [:id, :sel, :varargs], :id
+      func :__msgSend_int, :objc_msgSend, [:id, :sel, :varargs], :long
+
+      def self.msgSend( id, selector, *args )
+        selector = self.sel(selector) if selector.is_a? String
+        NSObject.new( __msgSend( id, selector, *args ) )
+      end
+      def self.msgSend_ptr( id, selector, *args )
+        selector = self.sel(selector) if selector.is_a? String
+        __msgSend( id, selector, *args )
+      end
+      def self.msgSend_str( id, selector, *args )
+        selector = self.sel(selector) if selector.is_a? String
+        NSString.new( __msgSend( id, selector, *args ) )
+      end
+      def self.msgSend_int( id, selector, *args )
+        selector = self.sel(selector) if selector.is_a? String
+        __msgSend_int( id, selector, *args )
+      end
+      def self.msgSend_bool( id, selector, *args )
+        selector = self.sel(selector) if selector.is_a? String
+        ( __msgSend_int( id, selector, *args ) == 0 ) ? false : true
+      end
+
+      func :getClass, :objc_getClass, [:string], :id
+      func :class_replaceMethod, [:nsclass, :sel, :imp, :string], :imp
+
+      func :object_getClassName, [:id], :string
+      func :object_getInstanceVariable, [:id, :string, :pointer], :ivar
+      func :object_setInstanceVariable, [:id, :string, :pointer], :ivar
+
+      func :sel_registerName, [:string], :sel
+      func :sel_getName, [:sel], :string
+
+      def self.sel( name )
+        sel_registerName( name.to_s )
+      end
+
+    end
+
+
+    module Cocoa
+      extend NiceFFI::Library
+      load_library '/System/Library/Frameworks/Cocoa.framework/Cocoa'
+
+      func :NSApplicationLoad, [], :bool
+
+      func :NSPushAutoreleasePool, [], :void
+      func :NSPopAutoreleasePool, [], :void
+
+      NSApplicationLoad()
+      NSPushAutoreleasePool()
+
+      def self.NSApp
+        @nsapp ||= ObjC::NSClass("NSApplication").msg("sharedApplication")
+      end
+
+      class NSMenu < ObjC::NSObject
+        include Enumerable
+
+        def initialize( *args )
+          if args.empty?
+            super( ObjC::NSClass("NSMenu").msg_ptr("alloc") )
+          else
+            super( args[0] )
+          end
+        end
+
+        def initWithTitle( title )
+          msg( "initWithTitle:", FFI.find_type(:pointer), ObjC::NSString(title) )
+          self
+        end
+
+        def title
+          msg_str("title")
+        end
+
+        def title=( t )
+          msg("setTitle:", FFI.find_type(:pointer), ObjC::NSString(t))
+        end
+
+        def addItem( item )
+          msg("addItem:", FFI.find_type(:pointer), item)
+          self
+        end
+
+        def addItemWithTitle( title, action=nil, keyEquivalent="" )
+          ptr = FFI.find_type(:pointer)
+          action = ObjC.sel(action) if action.is_a? String
+          item = msg_ptr( "addItemWithTitle:action:keyEquivalent:",
+                      ptr, ObjC::NSString(title),
+                      ptr, action,
+                      ptr, ObjC::NSString(keyEquivalent))
+          NSMenuItem.new(item)
+        end
+
+        def removeItem( item )
+          msg("removeItem:", FFI.find_type(:pointer), item)
+          self
+        end
+
+        def removeItemAtIndex( index )
+          msg("removeItemAtIndex:", FFI.find_type(:long), index)
+          self
+        end
+
+        def length
+          msg_int( "numberOfItems" )
+        end
+
+        def [](index)
+          Cocoa::NSMenuItem( msg_ptr("itemAtIndex:", FFI.find_type(:long), index) )
+        end
+
+        def each
+          length.times{ |i| yield self[i] }
+        end
+      end
+
+      def self.NSMenu( *args )
+        NSMenu.new( *args )
+      end
+
+
+      class NSMenuItem < ObjC::NSObject
+        def self.separatorItem
+          new( msg_ptr("separatorItem") )
+        end
+
+        def initialize( *args )
+          if args.empty?
+            super( ObjC::NSClass("NSMenuItem").msg_ptr("alloc") )
+          else
+            super( args[0] )
+          end
+        end
+
+        def initWithTitle( title, action=nil, keyEquivalent="" )
+          ptr = FFI.find_type(:pointer)
+          action = ObjC.sel(action) if action.is_a? String
+          msg( "initWithTitle:action:keyEquivalent:",
+               ptr, ObjC::NSString(title),
+               ptr, action,
+               ptr, ObjC::NSString(keyEquivalent))
+          self
+        end
+
+        def title
+          msg_str("title")
+        end
+
+        def title=( t )
+          msg("setTitle:", FFI.find_type(:pointer), ObjC::NSString(t))
+        end
+
+        def hasSubmenu?
+          msg_bool("hasSubmenu")
+        end
+
+        def submenu
+          Cocoa::NSMenu( msg_ptr("submenu") ) if hasSubmenu?
+        end
+
+        def submenu=( menu )
+          msg("setSubmenu:", FFI.find_type(:pointer), menu)
+        end
+      end
+
+      def self.NSMenuItem( *args )
+        NSMenuItem.new( *args )
+      end
+
+
+      attach_variable "vNSNibOwner", "NSNibOwner", :pointer
+      NSNibOwner =
+        ObjC::NSString( ObjC::NSString(self.vNSNibOwner).to_s )
+
+      attach_variable "vNSNibTopLevelObjects", "NSNibTopLevelObjects", :pointer
+      NSNibTopLevelObjects =
+        ObjC::NSString( ObjC::NSString(self.vNSNibTopLevelObjects).to_s )
+
+      NSAlphaShiftKeyMask = 1 << 16
+      NSShiftKeyMask      = 1 << 17
+      NSControlKeyMask    = 1 << 18
+      NSAlternateKeyMask  = 1 << 19
+      NSCommandKeyMask    = 1 << 20
+      NSNumericPadKeyMask = 1 << 21
+      NSHelpKeyMask       = 1 << 22
+      NSFunctionKeyMask   = 1 << 23
+    end
+
+
+    module HIServices
+      extend NiceFFI::Library
+      load_library '/System/Library/Frameworks/ApplicationServices.framework/Frameworks/HIServices.framework/HIServices'
+
+      class ProcessSerialNumber < NiceFFI::Struct
+        layout :highLongOfPSN, :ulong, :lowLongOfPSN, :ulong
+      end
+
+      KProcessTransformToForegroundApplication = 1
+
+      func :GetCurrentProcess, [:pointer], :long
+      func :TransformProcessType, [:pointer, :long], :long
+      func :SetFrontProcess, [:pointer], :long
+
+      # Does the magic to make the current process a front process.
+      def self.make_current_front
+        current = ProcessSerialNumber.new( [0, 0] )
+        GetCurrentProcess( current )
+        TransformProcessType(current,KProcessTransformToForegroundApplication)
+        SetFrontProcess( current )
+      end
+    end
+
+  end
+end