rubygame 2.3.0-x86-mswin32-60

data/lib/rubygame/constants.rb

@@ -0,0 +1,238 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2004-2007  John Croisant
+#
+#	This library is free software; you can redistribute it and/or
+#	modify it under the terms of the GNU Lesser General Public
+#	License as published by the Free Software Foundation; either
+#	version 2.1 of the License, or (at your option) any later version.
+#
+#	This library is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+module Rubygame
+
+	module Mouse
+		# Hash to translate mouse button sym to string
+		MOUSE2STR = {
+			MOUSE_LEFT => "left",
+			MOUSE_MIDDLE => "middle",
+			MOUSE_RIGHT => "right"
+		}
+		# And to translate the other way...
+		STR2MOUSE = MOUSE2STR.invert()
+		# And allow numbers too (1 = left, so on)...
+		STR2MOUSE[1] = MOUSE_LEFT
+		STR2MOUSE[2] = MOUSE_MIDDLE
+		STR2MOUSE[3] = MOUSE_RIGHT
+	end # module Mouse
+
+	module Key
+		# All the keys which have ASCII print values
+		# It is 87 lines from here to the closing }, if you want to skip it...
+		KEY2ASCII = {
+			K_BACKSPACE => "\b",
+			K_TAB => "\t",
+			K_RETURN => "\n", #SDL docs: "\r". Win vs *nix? What about Mac?
+			K_ESCAPE => "^[",
+			K_SPACE => " ",
+			K_EXCLAIM => "!",
+			K_QUOTEDBL => "\"",
+			K_HASH => "#",
+			K_DOLLAR => "$",
+			K_AMPERSAND => "&",
+			K_QUOTE => "\'",
+			K_LEFTPAREN => "(",
+			K_RIGHTPAREN => ")",
+			K_ASTERISK => "*",
+			K_PLUS => "+",
+			K_COMMA => ",",
+			K_MINUS => "-",
+			K_PERIOD => ".",
+			K_SLASH => "/",
+			K_0 => "0",
+			K_1 => "1",
+			K_2 => "2",
+			K_3 => "3",
+			K_4 => "4",
+			K_5 => "5",
+			K_6 => "6",
+			K_7 => "7",
+			K_8 => "8",
+			K_9 => "9",
+			K_COLON => ":",
+			K_SEMICOLON => ";",
+			K_LESS => "<",
+			K_EQUALS => "=",
+			K_GREATER => ">",
+			K_QUESTION => "?",
+			K_AT => "@",
+			K_LEFTBRACKET => "[",
+			K_BACKSLASH => "\\",
+			K_RIGHTBRACKET => "]",
+			K_CARET => "^",
+			K_UNDERSCORE => "_",
+			K_BACKQUOTE => "`",
+			K_A => "a",
+			K_B => "b",
+			K_C => "c",
+			K_D => "d",
+			K_E => "e",
+			K_F => "f",
+			K_G => "g",
+			K_H => "h",
+			K_I => "i",
+			K_J => "j",
+			K_K => "k",
+			K_L => "l",
+			K_M => "m",
+			K_N => "n",
+			K_O => "o",
+			K_P => "p",
+			K_Q => "q",
+			K_R => "r",
+			K_S => "s",
+			K_T => "t",
+			K_U => "u",
+			K_V => "v",
+			K_W => "w",
+			K_X => "x",
+			K_Y => "y",
+			K_Z => "z",
+			K_KP0 => "0",
+			K_KP1 => "1",
+			K_KP2 => "2",
+			K_KP3 => "3",
+			K_KP4 => "4",
+			K_KP5 => "5",
+			K_KP6 => "6",
+			K_KP7 => "7",
+			K_KP8 => "8",
+			K_KP9 => "9",
+			K_KP_PERIOD => ".",
+			K_KP_DIVIDE => "/",
+			K_KP_MULTIPLY => "*",
+			K_KP_MINUS => "-",
+			K_KP_PLUS => "+",
+			K_KP_ENTER => "\n", #again, SDL docs say "\r"
+			K_KP_EQUALS => "=",
+		}
+
+		# And to translate the other way...
+		ASCII2KEY = KEY2ASCII.invert()
+		# accept uppercase letters too, return same as lowercase version:
+		("a".."z").each{ |letter| ASCII2KEY[letter.upcase] = ASCII2KEY[letter] }
+
+		# All the keys that are affected by the Shift key, in lower case
+		# 49 lines from here to the end of the hash
+		KEY2LOWER = {
+			K_QUOTE => "\'",
+			K_COMMA => ",",
+			K_MINUS => "-",
+			K_PERIOD => ".",
+			K_SLASH => "/",
+			K_0 => "0",
+			K_1 => "1",
+			K_2 => "2",
+			K_3 => "3",
+			K_4 => "4",
+			K_5 => "5",
+			K_6 => "6",
+			K_7 => "7",
+			K_8 => "8",
+			K_9 => "9",
+			K_SEMICOLON => ";",
+			K_EQUALS => "=",
+			K_LEFTBRACKET => "[",
+			K_BACKSLASH => "\\",
+			K_RIGHTBRACKET => "]",
+			K_BACKQUOTE => "`",
+			K_A => "a",
+			K_B => "b",
+			K_C => "c",
+			K_D => "d",
+			K_E => "e",
+			K_F => "f",
+			K_G => "g",
+			K_H => "h",
+			K_I => "i",
+			K_J => "j",
+			K_K => "k",
+			K_L => "l",
+			K_M => "m",
+			K_N => "n",
+			K_O => "o",
+			K_P => "p",
+			K_Q => "q",
+			K_R => "r",
+			K_S => "s",
+			K_T => "t",
+			K_U => "u",
+			K_V => "v",
+			K_W => "w",
+			K_X => "x",
+			K_Y => "y",
+			K_Z => "z",
+		}
+
+		# All the keys that are affected by the Shift key, in UPPER case
+		# 49 lines from here to the end of the hash
+		KEY2UPPER = {
+			K_QUOTE => "\"",
+			K_COMMA => "<",
+			K_MINUS => "_",
+			K_PERIOD => ">",
+			K_SLASH => "?",
+			K_0 => ")",
+			K_1 => "!",
+			K_2 => "@",
+			K_3 => "#",
+			K_4 => "$",
+			K_5 => "%",
+			K_6 => "^",
+			K_7 => "&",
+			K_8 => "*",
+			K_9 => "(",
+			K_SEMICOLON => ":",
+			K_EQUALS => "+",
+			K_LEFTBRACKET => "{",
+			K_BACKSLASH => "|",
+			K_RIGHTBRACKET => "}",
+			K_BACKQUOTE => "~",
+			K_A => "A",
+			K_B => "B",
+			K_C => "C",
+			K_D => "D",
+			K_E => "E",
+			K_F => "F",
+			K_G => "G",
+			K_H => "H",
+			K_I => "I",
+			K_J => "J",
+			K_K => "K",
+			K_L => "L",
+			K_M => "M",
+			K_N => "N",
+			K_O => "O",
+			K_P => "P",
+			K_Q => "Q",
+			K_R => "R",
+			K_S => "S",
+			K_T => "T",
+			K_U => "U",
+			K_V => "V",
+			K_W => "W",
+			K_X => "X",
+			K_Y => "Y",
+			K_Z => "Z",
+		}
+	end #module Key
+
+end # module Rubygame

data/lib/rubygame/event.rb

@@ -0,0 +1,313 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2004-2007  John Croisant
+#
+#	This library is free software; you can redistribute it and/or
+#	modify it under the terms of the GNU Lesser General Public
+#	License as published by the Free Software Foundation; either
+#	version 2.1 of the License, or (at your option) any later version.
+#
+#	This library is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#	Lesser General Public License for more details.
+#
+#	You should have received a copy of the GNU Lesser General Public
+#	License along with this library; if not, write to the Free Software
+#	Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#++
+
+module Rubygame
+
+	# List of all Rubygame hardware event classes. *Do not modify!*
+	SDL_EVENTS = [ActiveEvent, KeyDownEvent, KeyUpEvent,\
+		MouseMotionEvent,MouseDownEvent,MouseUpEvent,JoyAxisEvent,\
+		JoyBallEvent, JoyHatEvent,JoyDownEvent, JoyUpEvent,\
+		ResizeEvent, QuitEvent]
+  
+	# Converts a keyboard symbol (keysym) into a human-readable text string.
+	# If either Shift key was being pressed, alphanumeric or punctuation keys 
+	# will be made uppercase or alternate, based on U.S. keyboard layout.
+	# E.g. "a" becomes "A", "1" becomes "!", and "/" becomes "?".
+	def Rubygame.key2str( sym, mods )
+		if (mods.include? K_LSHIFT) or (mods.include? K_RSHIFT)
+			return (Rubygame::Key::KEY2UPPER[sym]\
+				or Rubygame::Key::KEY2ASCII[sym] or "")
+		else
+			return (Rubygame::Key::KEY2LOWER[sym]\
+				or Rubygame::Key::KEY2ASCII[sym] or "")
+		end
+	end
+
+	# The parent class for all event classes. You can make custom event classes,
+  # if desired; inheriting this class is not necessary, but makes it easier
+  # to check if an object is an event or not.
+	class Event
+	end
+
+	# Indicates that the Rubygame window has gained or lost focus from the
+	# window manager.
+	# 
+	# This event has these attributes:
+	# gain::  true if the window gained focus, and false if it lost focus.
+	# state:: string indicating what type of focus was gained or lost: 
+	#         "mouse"::    the mouse entered/exited the window
+	#         "keyboard":: the window gained or lost input focus
+	#         "active"::   the window was minimized/iconified.
+	class ActiveEvent < Event
+		attr_accessor :gain, :state
+		def initialize(gain,state)
+			@gain = gain
+			@state = state 
+		end
+	end
+
+	# Indicates that a keyboard key was pressed.
+	# 
+	# This event has these attributes:
+	# string:: a human-readable string telling what key was pressed, or nil.
+	#          See #key2str.
+	# key::    the integer keysym for the key. These can be compared with the
+	#          K_* constants in the Rubygame module, e.g. Rubygame::K_A.
+	# mods::   an Array of zero or more keysyms indicating which modifier keys
+	#          were being pressed when the key was pressed. You can compare
+	#          with these constants in the Rubygame module:
+	#          K_RSHIFT::    shift key (right side)
+	#          K_LSHIFT::    shift key (left side)
+	#          K_RCTRL::     ctrl key (right side)
+	#          K_LCTRL::     ctrl key (left side)
+	#          K_RALT::      alt key (right side)
+	#          K_LALT::      alt key (left side)
+	#          K_RMETA::     meta key (right side)
+	#          K_LMETA::     meta key (left side)
+	#          K_RSUPER::    super key, aka. Windows key (right side)
+	#          K_LSUPER::    super key, aka. Windows key (left side)
+	#          K_RALT::      alt key (right side)
+	#          K_NUMLOCK::   num lock
+	#          K_CAPSLOCK::  caps lock
+	#          K_MODE::      mode key
+	#          
+	#          
+	class KeyDownEvent < Event
+		attr_accessor :string,:key,:mods
+
+		# Create a new KeyDownEvent.
+		# 
+		# key::  either an integer keysym (e.g. Rubygame::K_A) or string (e.g. "a")
+		# mods:: array of modifier keysyms
+		def initialize(key,mods)
+			if key.kind_of? Integer
+				@key = key
+				@string = Rubygame.key2str(key, mods) #a string or nil
+			elsif key.kind_of? String
+				@key = Rubygame::Key::ASCII2KEY[key]
+				if @key != nil
+					@string = key
+				else
+					raise(ArgumentError,"First argument of KeyDownEvent.new() must be an Integer KeySym (like K_A) or a ASCII-like String (like \"a\" or \"A\"). Got %s (%s)"%[key,key.class])
+				end
+			end
+			@mods = mods
+		end
+	end
+
+	# Indicates that a keyboard key was released.
+	# 
+	# See KeyDownEvent.
+	class KeyUpEvent < Event
+		attr_accessor :string,:key,:mods
+		def initialize(key,mods)
+			if key.kind_of? Integer
+				@key = key
+				@string = Rubygame.key2str(key, mods) #a string or nil
+			elsif key.kind_of? String
+				@key = Rubygame::Key::ASCII2KEY[key]
+				if @key != nil
+					@string = key
+				else
+					raise(ArgumentError,"First argument of KeyUpEvent.new() must be an Integer KeySym (like K_A) or a ASCII-like String (like \"a\" or \"A\"). Got %s (%s)"%[key,key.class])
+				end
+			end
+			@mods = mods
+		end
+	end
+
+	# Indicates that the mouse cursor moved.
+	# 
+	# This event has these attributes:
+	# pos::     the new position of the cursor, in the form [x,y].
+	# rel::     the relative movement of the cursor since the last update, [x,y].
+	# buttons:: the mouse buttons that were being held during the movement,
+	#           an Array of zero or more of these constants in module Rubygame
+	#           (or the corresponding button number):
+	#           MOUSE_LEFT::   1; left mouse button
+	#           MOUSE_MIDDLE:: 2; middle mouse button
+	#           MOUSE_RIGHT::  3; right mouse button
+	class MouseMotionEvent < Event
+		attr_accessor :pos,:rel,:buttons
+		def initialize(pos,rel,buttons)
+			@pos, @rel, @buttons = pos, rel, buttons
+		end
+	end
+
+	# Indicates that a mouse button was pressed.
+	# 
+	# This event has these attributes:
+	# string:: string indicating the button that was pressed ("left","middle", or
+	#          "right").
+	# pos::    the position of the mouse cursor when the button was pressed,
+	#          in the form [x,y].
+	# button:: the mouse button that was pressed; one of these constants in
+	#          module Rubygame (or the corresponding button number):
+	#          MOUSE_LEFT::   1; left mouse button
+	#          MOUSE_MIDDLE:: 2; middle mouse button
+	#          MOUSE_RIGHT::  3; right mouse button
+	class MouseDownEvent < Event
+		attr_accessor :string,:pos,:button
+		def initialize(pos,button)
+			@pos = pos
+			if button.kind_of? Integer
+				@button = button
+				@string = Rubygame::Mouse::MOUSE2STR[button] #a string or nil
+			elsif key.kind_of? String
+				@button = Rubygame::Mouse::STR2MOUSE[key]
+				if @button != nil
+					@string = button
+				else
+					raise(ArgumentError,"First argument of MouseDownEvent.new() must be an Integer Mouse button indentifier (like MOUSE_LEFT) or a String (like \"left\"). Got %s (%s)"%[button,button.class])
+				end
+			end
+		end
+	end
+
+	# Indicates that a mouse button was released.
+	# 
+	# See MouseDownEvent.
+	class MouseUpEvent < Event
+		attr_accessor :string,:pos,:button
+		def initialize(pos,button)
+			@pos = pos
+			if button.kind_of? Integer
+				@button = button
+				@string = Rubygame::Mouse::MOUSE2STR[button] #a string or nil
+			elsif key.kind_of? String
+				@button = Rubygame::Mouse::STR2MOUSE[key]
+				if @button != nil
+					@string = button
+				else
+					raise(ArgumentError,"First argument of MouseUpEvent.new() must be an Integer Mouse button indentifier (like MOUSE_LEFT) or a String (like \"left\"). Got %s (%s)"%[button,button.class])
+				end
+			end
+		end
+	end
+
+	# Indicates that a Joystick axis was moved.
+	# 
+	# This event has these attributes:
+	# joynum:: the identifier number of the affected Joystick.
+	# axis::   the identifier number of the axis.
+	# value::  the new value of the axis, between -32768 and 32767
+	class JoyAxisEvent < Event
+		attr_accessor :joynum,:axis,:value
+		def initialize(joy,axis,value)
+			# eventually, joy could be int OR a Rubygame::Joystick instance,
+			# which would be stored as joy or maybe joyinstance?
+			@joynum = joy
+			@axis, @value = axis, value
+		end
+	end
+
+	# Indicates that a Joystick trackball was moved.
+	# 
+	# This event has these attributes:
+	# joynum:: the identifier number of the affected Joystick.
+	# ball::   the identifier number of the trackball.
+	# rel::    the relative movement of the trackball, [x,y].
+	class JoyBallEvent < Event
+		attr_accessor :joynum,:ball,:rel
+		def initialize(joy,ball,rel)
+			# eventually, joy could be int OR a Rubygame::Joystick instance,
+			# which would be stored as joy or maybe joyinstance?
+			@joynum = joy
+			@ball, @rel = ball, rel
+		end
+	end
+
+	# Indicates that a Joystick POV hat was moved.
+	# 
+	# This event has these attributes:
+	# joynum:: the identifier number of the affected Joystick.
+	# hat::    the identifier number of the hat.
+	# value::  the new direction of the hat, one of these constants in module
+	#          Rubygame (or the corresponding number):
+	#          HAT_CENTERED::   0
+	#          HAT_UP::         1 
+	#          HAT_RIGHT::      2
+	#          HAT_DOWN::       4 	
+	#          HAT_LEFT::       8
+	#          HAT_RIGHTUP::    3
+	#          HAT_RIGHTDOWN::  6
+	#          HAT_LEFTUP::     9
+	#          HAT_LEFTDOWN::   12
+	class JoyHatEvent < Event
+		attr_accessor :joynum,:hat,:value
+		def initialize(joy,hat,value)
+			# eventually, joy could be int OR a Rubygame::Joystick instance,
+			# which would be stored as joy or maybe joyinstance?
+			@joynum = joy
+			@hat, @value = hat, value
+		end
+	end
+
+	# Indicates that a Joystick button was pressed.
+	# 
+	# This event has these attributes:
+	# joynum:: the identifier number of the affected Joystick.
+	# hat::    the identifier number of the button.
+	class JoyDownEvent < Event
+		attr_accessor :joynum, :button
+		def initialize(joy,button)
+			# eventually, joy could be int OR a Rubygame::Joystick instance,
+			# which would be stored as joy or maybe joyinstance?
+			@joynum = joy
+			@button = button
+		end
+	end
+
+	# Indicates that a Joystick button was released.
+	# 
+	# See JoyDownEvent.
+	class JoyUpEvent < Event
+		attr_accessor :joynum, :button
+		def initialize(joy,button)
+			# eventually, joy could be int OR a Rubygame::Joystick instance,
+			# which would be stored as joy or maybe joyinstance?
+			@joynum = joy
+			@button = button
+		end
+	end
+
+	# Indicates that the application window was resized. (After this event
+	# occurs, you should use Screen#set_mode to change the display surface to
+	# the new size.)
+	# 
+	# This event has these attributes:
+	# size:: the new size of the window, in pixels [w,h].
+	class ResizeEvent < Event
+		attr_accessor :size
+		def initialize(new_size)
+			@size = new_size
+		end
+	end
+
+	# Indicates that part of the application window was exposed or otherwise
+	# changed, and perhaps the window needs to be refreshed. This event occurs,
+	# for example, when an OpenGL display should be updated.
+	class ExposeEvent < Event
+	end
+	
+	# Indicates that the application has been signaled to quit. (E.g. the user
+	# pressed the close button.)
+	class QuitEvent < Event
+	end
+end # module Rubygame