rubygame 2.3.0-x86-mswin32-60

data/lib/rubygame/keyconstants.rb

@@ -0,0 +1,237 @@
+# :enddoc:
+module Rubygame
+ALL_KEYS = {\
+K_BACKSPACE => ["\b", "backspace"],\
+K_TAB => ["\t", "tab"],\
+K_CLEAR => [nil, "clear"],\
+K_RETURN => ["\n", "return", "enter"],\
+K_PAUSE => [nil, "pause"],\
+K_ESCAPE => ["^[", "escape"],\
+K_SPACE => [" ", "space"],\
+K_EXCLAIM => ["!", "exclamation_mark", "exclaim"],\
+K_QUOTEDBL => ["\"", "double_quote"],\
+K_HASH => ["#", "hash", "pound", "bang"],\
+K_DOLLAR => ["$", "dollar"],\
+K_AMPERSAND => ["&", "ampersand", "and"],\
+K_QUOTE => ["'", "quote"],\
+K_LEFTPAREN => ["(", "left_parenthesis", "lparen"],\
+K_RIGHTPAREN => [")", "right_parenthesis","rparen"],\
+K_ASTERISK => ["*", "asterisk"],\
+K_PLUS => ["+", "plus"],\
+K_COMMA => [",", "comma"],\
+K_MINUS => ["-", "minus"],\
+K_PERIOD => [".", "period"],\
+K_SLASH => ["/", "slash"],\
+K_0 => ["0", "numberline_0"],\
+K_1 => ["1", "numberline_1"],\
+K_2 => ["2", "numberline_2"],\
+K_3 => ["3", "numberline_3"],\
+K_4 => ["4", "numberline_4"],\
+K_5 => ["5", "numberline_5"],\
+K_6 => ["6", "numberline_6"],\
+K_7 => ["7", "numberline_7"],\
+K_8 => ["8", "numberline_8"],\
+K_9 => ["9", "numberline_9"],\
+K_COLON => [":", "colon"],\
+K_SEMICOLON => [";", "semicolon"],\
+K_LESS => ["<", "less_than"],\
+K_EQUALS => ["=", "equals"],\
+K_GREATER => [">", "greater_than"],\
+K_QUESTION => ["?", "question_mark", "question"],\
+K_AT => ["@", "at"],\
+K_LEFTBRACKET => ["[", "left_bracket", "lbracket"],\
+K_BACKSLASH => ["\\", "backslash"],\
+K_RIGHTBRACKET => ["]", "right_bracket", "rbracket"],\
+K_CARET => ["^", "caret"],\
+K_UNDERSCORE => ["_", "underscore"],\
+K_BACKQUOTE => ["`", "backquote", "grave"],\
+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_DELETE => [nil, "delete", "del"],\
+K_KP0 => ["0", "kp0", "keypad_0"],\
+K_KP1 => ["1", "kp1", "keypad_1"],\
+K_KP2 => ["2", "kp2", "keypad_2"],\
+K_KP3 => ["3", "kp3", "keypad_3"],\
+K_KP4 => ["4", "kp4", "keypad_4"],\
+K_KP5 => ["5", "kp5", "keypad_5"],\
+K_KP6 => ["6", "kp6", "keypad_6"],\
+K_KP7 => ["7", "kp7", "keypad_7"],\
+K_KP8 => ["8", "kp8", "keypad_8"],\
+K_KP9 => ["9", "kp9", "keypad_9"],\
+K_KP_PERIOD => [".", "period", "keypad_period"],\
+K_KP_DIVIDE => ["/", "divide", "keypad_divide"],\
+K_KP_MULTIPLY => ["*", "multiply", "keypad_multiply"],\
+K_KP_MINUS => ["-", "minus", "keypad_minus"],\
+K_KP_PLUS => ["+", "plus", "keypad_plus"],\
+K_KP_ENTER => ["\n", "enter", "keypad_enter"],\
+K_KP_EQUALS => ["=", "equals", "keypad_equals"],\
+K_UP => [nil, "up"],\
+K_DOWN => [nil, "down"],\
+K_RIGHT => [nil, "right"],\
+K_LEFT => [nil, "left"],\
+K_INSERT => [nil, "insert", "ins"],\
+K_HOME => [nil, "home"],\
+K_END => [nil, "end"],\
+K_PAGEUP => [nil, "page_up", "pgup"],\
+K_PAGEDOWN => [nil, "page_down", "pgdn"],\
+K_F1 => [nil, "f1", "function_1"],\
+K_F2 => [nil, "f2", "function_2"],\
+K_F3 => [nil, "f3", "function_3"],\
+K_F4 => [nil, "f4", "function_4"],\
+K_F5 => [nil, "f5", "function_5"],\
+K_F6 => [nil, "f6", "function_6"],\
+K_F7 => [nil, "f7", "function_7"],\
+K_F8 => [nil, "f8", "function_8"],\
+K_F9 => [nil, "f9", "function_9"],\
+K_F10 => [nil, "f10", "function_10"],\
+K_F11 => [nil, "f11", "function_11"],\
+K_F12 => [nil, "f12", "function_12"],\
+K_F13 => [nil, "f13", "function_13"],\
+K_F14 => [nil, "f14", "function_14"],\
+K_F15 => [nil, "f15", "function_15"],\
+K_NUMLOCK => [nil, "numlock"],\
+K_CAPSLOCK => [nil, "capslock", "caplock"],\
+K_SCROLLOCK => [nil, "scroll_lock", "scrollock", "scrolllock"],\
+K_LSHIFT => [nil, "left_shift", "lshift"],\
+K_RSHIFT => [nil, "right_shift", "rshift"],\
+K_LCTRL => [nil, "left_control", "lctrl"],\
+K_RCTRL => [nil, "right_control", "rctrl"],\
+K_LALT => [nil, "left_alt", "lalt"],\
+K_RALT => [nil, "right_alt", "ralt"],\
+K_LMETA => [nil, "left_meta", "lmeta"],\
+K_RMETA => [nil, "right_meta", "rmeta"],\
+K_LSUPER => [nil, "left_super", "lsuper"],\
+K_RSUPER => [nil, "right_super", "rsuper"],\
+K_MODE => [nil, "mode"],\
+K_HELP => [nil, "help"],\
+K_PRINT => [nil, "print_screen","prt_scr","print"],\
+K_SYSREQ => [nil, "sysrq", "sysreq", "system_request"],\
+K_BREAK => [nil, "break"],\
+K_MENU => [nil, "menu"],\
+K_POWER => [nil, "power"],\
+# I have no idea how to get a Euro symbol here!
+K_EURO => ["\u20ac", "euro"],\
+# just K_WORLD_0 to K_WORLD_95 after this
+K_WORLD_0 => [nil, "world_0"],\
+K_WORLD_1 => [nil, "world_1"],\
+K_WORLD_2 => [nil, "world_2"],\
+K_WORLD_3 => [nil, "world_3"],\
+K_WORLD_4 => [nil, "world_4"],\
+K_WORLD_5 => [nil, "world_5"],\
+K_WORLD_6 => [nil, "world_6"],\
+K_WORLD_7 => [nil, "world_7"],\
+K_WORLD_8 => [nil, "world_8"],\
+K_WORLD_9 => [nil, "world_9"],\
+K_WORLD_10 => [nil, "world_10"],\
+K_WORLD_11 => [nil, "world_11"],\
+K_WORLD_12 => [nil, "world_12"],\
+K_WORLD_13 => [nil, "world_13"],\
+K_WORLD_14 => [nil, "world_14"],\
+K_WORLD_15 => [nil, "world_15"],\
+K_WORLD_16 => [nil, "world_16"],\
+K_WORLD_17 => [nil, "world_17"],\
+K_WORLD_18 => [nil, "world_18"],\
+K_WORLD_19 => [nil, "world_19"],\
+K_WORLD_20 => [nil, "world_20"],\
+K_WORLD_21 => [nil, "world_21"],\
+K_WORLD_22 => [nil, "world_22"],\
+K_WORLD_23 => [nil, "world_23"],\
+K_WORLD_24 => [nil, "world_24"],\
+K_WORLD_25 => [nil, "world_25"],\
+K_WORLD_26 => [nil, "world_26"],\
+K_WORLD_27 => [nil, "world_27"],\
+K_WORLD_28 => [nil, "world_28"],\
+K_WORLD_29 => [nil, "world_29"],\
+K_WORLD_30 => [nil, "world_30"],\
+K_WORLD_31 => [nil, "world_31"],\
+K_WORLD_32 => [nil, "world_32"],\
+K_WORLD_33 => [nil, "world_33"],\
+K_WORLD_34 => [nil, "world_34"],\
+K_WORLD_35 => [nil, "world_35"],\
+K_WORLD_36 => [nil, "world_36"],\
+K_WORLD_37 => [nil, "world_37"],\
+K_WORLD_38 => [nil, "world_38"],\
+K_WORLD_39 => [nil, "world_39"],\
+K_WORLD_40 => [nil, "world_40"],\
+K_WORLD_41 => [nil, "world_41"],\
+K_WORLD_41 => [nil, "world_41"],\
+K_WORLD_42 => [nil, "world_42"],\
+K_WORLD_43 => [nil, "world_43"],\
+K_WORLD_44 => [nil, "world_44"],\
+K_WORLD_45 => [nil, "world_45"],\
+K_WORLD_46 => [nil, "world_46"],\
+K_WORLD_47 => [nil, "world_47"],\
+K_WORLD_48 => [nil, "world_48"],\
+K_WORLD_49 => [nil, "world_49"],\
+K_WORLD_50 => [nil, "world_50"],\
+K_WORLD_51 => [nil, "world_51"],\
+K_WORLD_52 => [nil, "world_52"],\
+K_WORLD_53 => [nil, "world_53"],\
+K_WORLD_54 => [nil, "world_54"],\
+K_WORLD_55 => [nil, "world_55"],\
+K_WORLD_56 => [nil, "world_56"],\
+K_WORLD_57 => [nil, "world_57"],\
+K_WORLD_58 => [nil, "world_58"],\
+K_WORLD_59 => [nil, "world_59"],\
+K_WORLD_60 => [nil, "world_60"],\
+K_WORLD_61 => [nil, "world_61"],\
+K_WORLD_62 => [nil, "world_62"],\
+K_WORLD_63 => [nil, "world_63"],\
+K_WORLD_64 => [nil, "world_64"],\
+K_WORLD_65 => [nil, "world_65"],\
+K_WORLD_66 => [nil, "world_66"],\
+K_WORLD_67 => [nil, "world_67"],\
+K_WORLD_68 => [nil, "world_68"],\
+K_WORLD_69 => [nil, "world_69"],\
+K_WORLD_70 => [nil, "world_70"],\
+K_WORLD_71 => [nil, "world_71"],\
+K_WORLD_72 => [nil, "world_72"],\
+K_WORLD_73 => [nil, "world_73"],\
+K_WORLD_74 => [nil, "world_74"],\
+K_WORLD_75 => [nil, "world_75"],\
+K_WORLD_76 => [nil, "world_76"],\
+K_WORLD_77 => [nil, "world_77"],\
+K_WORLD_78 => [nil, "world_78"],\
+K_WORLD_79 => [nil, "world_79"],\
+K_WORLD_80 => [nil, "world_80"],\
+K_WORLD_81 => [nil, "world_81"],\
+K_WORLD_82 => [nil, "world_82"],\
+K_WORLD_83 => [nil, "world_83"],\
+K_WORLD_84 => [nil, "world_84"],\
+K_WORLD_85 => [nil, "world_85"],\
+K_WORLD_86 => [nil, "world_86"],\
+K_WORLD_87 => [nil, "world_87"],\
+K_WORLD_88 => [nil, "world_88"],\
+K_WORLD_89 => [nil, "world_89"],\
+K_WORLD_90 => [nil, "world_90"],\
+K_WORLD_91 => [nil, "world_91"],\
+K_WORLD_92 => [nil, "world_92"],\
+K_WORLD_93 => [nil, "world_93"],\
+K_WORLD_94 => [nil, "world_94"],\
+K_WORLD_95 => [nil, "world_95"],\
+}
+end

data/lib/rubygame/mediabag.rb

@@ -0,0 +1,94 @@
+#--
+#	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
+#++
+
+require "rubygame"
+
+module Rubygame
+
+  # *NOTE*: you must require 'rubygame/mediabag' manually to gain access to
+  # Rubygame::MediaBag. It is not imported with Rubygame by default!
+  # 
+  # A Hash-like class which will load and retain media files (images and
+  # sounds), so that the file can be loaded once, but used many times.
+  # 
+  # The first time a file is requested with the #[] method,that file will be
+  # loaded into memory. All subsequent requests for the same file will return
+  # a reference to the already-loaded version. Ideally, objects should not
+  # have to know whether or not the image has been loaded or not.
+  class MediaBag
+    @@image_ext = %W{bmp gif jpg lbm pcx png pnm ppm pgm pbm tga tif xcf xpm}
+    @@sound_ext = %W{wav}
+
+    def initialize()
+      @media = Hash.new
+    end
+
+    # Return a reference to the stored value for key. 
+    # If there is no value for key, automatically attempt to load key
+    # as a filename (guessing the file type based on its extension)
+    # 
+    def [](key)
+      @media[key] or load(key)
+    rescue Rubygame::SDLError
+      nil
+    end
+
+    # Load the file, but only if it has not been previously loaded.
+    def load(filename)
+      @media[filename] or store( filename, load_file(filename) )
+    end
+
+    # Store value as key, but only if there is no previous value.
+    def store(key,value)
+      @media[key] ||= value
+    end
+
+    # Forcibly (re)load the file, replacing the previous version in memory 
+    # (if any).
+    def force_load(filename)
+      force_store( filename, load_file(filename) )
+    end
+
+    # Forcibly store value as key, replacing the previous value (if any).
+    def force_store(key,value)
+      @media[key] = value
+    end
+
+    def load_file(filename)
+      case File::extname(filename).downcase[1..-1]
+      when *(@@image_ext)
+        return load_image(filename)
+      when *(@@sound_ext)
+        return load_sound(filename)
+      else
+        raise(ArgumentError,"Unrecognized file extension `%s': %s"%
+              [File::extname(filename), filename])
+      end
+    end
+
+    def load_image(filename)
+      return Rubygame::Surface.load_image(filename)
+    end
+
+    def load_sound(filename)
+      return Rubygame::Mixer::Sample.load_audio(filename)
+    end
+  end
+
+end

data/lib/rubygame/named_resource.rb

@@ -0,0 +1,254 @@
+#--
+#	Rubygame -- Ruby code and bindings to SDL to facilitate game creation
+#	Copyright (C) 2004-2008  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
+
+  #  NamedResource is a mix-in module to implement a globally-available
+  #  resource table, a @name variable and accessors, and a system for
+  #  automatically loading resources when they are first needed.
+  #
+  #  This module is used for Rubygame::Music, Rubygame::Sound, and
+  #  Rubygame::Surface. You can use it in your own classes this way:
+  #
+  #  1. Do 'include Rubygame::NamedResource' in your class definition.
+  #
+  #  2. Set MyClass.autoload_dirs to an Array of directories to look
+  #     for files when autoloading. Tip: use File.join to create
+  #     paths that work on any operating system.
+  #
+  #  3. Define #autoload to implement the behavior for your class,
+  #     or leave it as the default if you don't need autoloading.
+  #     See the docs for #autoload for more information.
+  #
+  #  Here's an example of how you could use this for a class which
+  #  loads maps from a file:
+  #
+  #      class Map
+  #        include Rubygame::NamedResource
+  #
+  #        Map.autoload_dirs = [ File.join("maps","world_1"),
+  #                              File.join("maps","custom") ]
+  #
+  #        def autoload( name )
+  #          # Searches autoload_dirs for the file
+  #          path = find_file( name )
+  #
+  #          if( path )
+  #            return load_map( path )
+  #          else
+  #            return nil
+  #          end
+  #        end
+  #
+  #        def load_map( path )
+  #          # Your code to do the real loading, then return
+  #          # the created instance of Map class.
+  #          # ...
+  #          return map_instance
+  #        end
+  #      end
+  #
+  #  Here's an example of how you could then use the Map class:
+  #
+  #      map = Map["level_1.map"]
+  #
+  #      if( map )
+  #        start_playing( map )
+  #      else
+  #        raise "Oops! The map file for Level 1 doesn't exist!"
+  #      end
+  #
+  module NamedResource
+
+
+    #  Adds class methods when the NamedResource module is included
+    #  in a class. (Here, we are assuming that the NamedResource
+    #  module was included in a class called MyClass.)
+    module NamedResourceClassMethods
+
+      #  An Array of paths to check for files. See #find_file.
+      attr_accessor :autoload_dirs
+
+
+      #  call-seq:
+      #    MyClass[ name ]  ->  instance or nil
+      #
+      #  Retrieves an instance of the class from a per-class resource
+      #  table (Hash).
+      #
+      #  If no object has been saved under the given name, invoke
+      #  #autoload to try to load a new instance, store it in the
+      #  Hash table under this name, and sets the instance's @name
+      #  to this name.
+      #
+      def []( name )
+        result = @resources[name]
+
+        if result.nil?
+          result = autoload(name)
+          if result
+            self[name] = result
+            result.name = name
+          end
+        end
+
+        return result
+      end
+
+
+      #  call-seq:
+      #    MyClass[ name ] = instance
+      #
+      #  Stores an instance of the class in a per-class resource table
+      #  (Hash) for future access. If another object is already stored
+      #  with this name, the old record is lost.
+      #
+      #  May raise:  TypeError, if you try to store anything
+      #             that is not kind of this class.
+      #
+      def []=( name, value )
+        if( value.kind_of? self )
+          @resources[name] = value
+        else
+          raise TypeError, "#{self}#[]= can only store instances of #{self}"
+        end
+      end
+
+      #  call-seq:
+      #    MyClass.autoload( name )  ->  instance or nil
+      #
+      #  This method is invoked when a non-existing resource is
+      #  accessed with #[]. By default, this method simply returns
+      #  nil, effectively disabling autoloading.
+      #
+      #  You should override this method in your class to provide
+      #  class-specific loading behavior, or leave it as the default if
+      #  you don't need autoloading. Your method should return either
+      #  an instance of the class, or nil.
+      #
+      #  NOTE: The #find_file method is useful for getting the full
+      #  path to a file which matches the name. That's what it's there
+      #  for, so you should use it!
+      #
+      def autoload( name )
+        nil
+      end
+
+
+      #  call-seq:
+      #    MyClass.basename( path )  ->  filename
+      #
+      #  Returns the basename for the path (i.e. the
+      #  filename without the directory). Same as
+      #  File.basename
+      #
+      def basename( path )
+        File.basename( path )
+      end
+
+
+      #  call-seq:
+      #    MyClass.exist?( path )  ->  true or false
+      #
+      #  True if the given path points to a file
+      #  that exists, otherwise false. Same as
+      #  File.exist?
+      #
+      def exist?( path )
+        File.exist?(path)
+      end
+
+
+      #  call-seq:
+      #    MyClass.find_file( filename )  ->  path or nil
+      #
+      #  Checks every directory in @autoload_dirs for
+      #  a file with the given name, and returns the
+      #  path (directory and name) for the first match.
+      #
+      #  If no directories have a file with that name,
+      #  return nil.
+      #
+      def find_file( filename )
+        dir = @autoload_dirs.find { |dir|
+          exist?( File.join(dir,filename) )
+        }
+
+        if dir
+          return File.join(dir,filename)
+        else
+          return nil
+        end
+      end
+
+    end
+
+
+    #  Sets up the class when this module is included.
+    #  Adds the class methods and defines class instance
+    #  variables.
+    def self.included( object ) # :nodoc:
+
+      class << object
+        include NamedResourceClassMethods
+      end
+
+      object.instance_eval do
+        @resources = Hash.new
+        @autoload_dirs = []
+      end
+
+    end
+
+
+    # Returns the instance's @name. See also #name=.
+    def name
+      @name
+    end
+
+    #
+    #  Sets the instance's @name to the given String, or nil to
+    #  unset the name. See also #name.
+    #
+    #  NOTE: This does not automatically store the instance in the
+    #  class resource table by name. Use the #[]= class method to do
+    #  that.
+    #
+    #  The string is dup'ed and frozen before being stored.
+    #
+    #  May raise:  TypeError, if new_name is not a String or nil.
+    #
+    def name=( new_name )
+      if new_name.nil?
+        return @name = nil
+      end
+
+      unless new_name.kind_of? String
+        raise TypeError, "name must be a String (got #{new_name.class})"
+      end
+
+      @name = new_name.dup
+      @name.freeze
+    end
+
+
+  end
+
+end