rubygame 2.3.0 → 2.4.0

data/CREDITS

@@ -58,3 +58,8 @@
   Email::         mokkan at users.sourceforge.net
   Contribution::  Patch to add Screen.icon=
   Date::          2007-11-21 (r597)
+
+- <b>Elio Cuevas Gómez</b> / elcugo
+  Email::         elcugo at gmail.com
+  Contribution::  Patch to fix color conversion segfault on x86_64.
+  Date::          2008-07-31

data/NEWS

@@ -1,5 +1,93 @@
 = NEWS
 
+== Rubygame 2.4.0
+
+Release focus: Events.
+
+=== Features
+
+- New Events module, with a suite of new and revised event classes.
+  The new classes offer full functionality as the older classes.
+
+  - Use Rubygame::EventQueue#enable_new_style_events to enable the new
+    event classes. This will become the default in Rubygame 3.0.
+
+  - Uses symbols instead of integer constants for keyboard keys and
+    mouse buttons (e.g. :a, :space, :mouse_left, :mouse_right).
+
+  - Better unicode / international keyboard text input support.
+    (See Rubygame::Events::KeyPressed#string)
+
+  - More natural and memorable class naming scheme.
+
+- New hook-based event handling system.
+  (NOTE: Requires use of the new event classes.)
+
+  - Rubygame::EventHandler class.
+    EventHandler holds many EventHook instances. It handles each event
+    by passing it to matching hooks.
+
+  - Rubygame::EventHandler::HasEventHandler mixin module.
+    Include this in your custom classes to add easy event handling
+    and event hook creation abilities.
+
+  - Rubygame::EventHook class.
+    
+  - Rubygame::EventActions module.
+    Has several pre-made event action classes to use with EventHook.
+
+  - Rubygame::EventTriggers module.
+    Has several pre-made event trigger classes to use with EventHook.
+
+- Added Rubygame.enable_key_repeat and Rubygame.disable_key_repeat.
+  Thanks to atiaxi for this new feature!
+
+=== Fixes
+
+- Fixed: EventQueue#peek_each didn't yield any events.
+
+- Fixed: Segfault in extract_rgba_u8_as_u8() on x86_64 systems.
+  Thanks to ElCuGo for this fix!
+
+- Fixed: Several "cast from pointer" warnings on x86_64 systems.
+
+- Fixed: Build system didn't correctly compile with debug symbols
+  when using "debug" option.
+
+- Fixed: Surface#get_at didn't work correctly for 8-bit Surfaces.
+
+- Fixed: Ftor.new_from_to would always complain about "wrong number
+  of arguments". Thanks to atiaxi for this fix!
+
+=== Other Stuff
+
+- The panda demo (samples/demo_rubygame.rb) has been renovated to
+  demonstrate how to use the new features, and to be a better example.
+
+- Old event classes are deprecated and will be removed in 3.0.
+  - ActiveEvent      (use Events::InputFocusGained,
+                          Events::InputFocusLost,
+                          Events::MouseFocusGained,
+                          Events::MouseFocusLost,
+                          Events::WindowMinimized, and
+                          Events::WindowUnminimized)
+  - ExposeEvent      (use Events::WindowExposed)
+  - JoyAxisEvent     (use Events::JoystickAxisMoved)
+  - JoyBallEvent     (use Events::JoystickBallMoved)
+  - JoyDownEvent     (use Events::JoystickButtonPressed)
+  - JoyHatEvent      (use Events::JoystickHatMoved)
+  - JoyUpEvent       (use Events::JoystickButtonReleased)
+  - KeyDownEvent     (use Events::KeyPressed)
+  - KeyUpEvent       (use Events::KeyReleased)
+  - MouseDownEvent   (use Events::MousePressed)
+  - MouseMotionEvent (use Events::MouseMoved)
+  - MouseUpEvent     (use Events::MouseReleased)
+  - QuitEvent        (use Events::QuitRequested)
+  - ResizeEvent      (use Events::WindowResized)
+
+
+
+
 == Rubygame 2.3.0
 
 Release focus: Media resources.

data/README

@@ -13,7 +13,7 @@
  event and game object management.
 
  === Relevant Links
- 1. Rubygame: http://rubygame.sourceforge.net
+ 1. Rubygame: http://rubygame.org
  2. Ruby: http://www.ruby-lang.org
  3. Pygame: http://www.pygame.org
  4. SDL: http://www.libsdl.org
@@ -106,18 +106,22 @@
 
  == Usage
  
- See the documentation (online at http://rubygame.sourceforge.net, or
+ See the documentation (online at http://docs.rubygame.org, or
  generated locally with the 'rake rdoc' command). 
 
  We also recommend that you take a peek at the demo applications in
- the 'samples' directory, especially chimp.rb.
+ the 'samples' directory, especially demo_rubygame.rb and chimp.rb.
 
  == License
 
  Rubygame is distributed under the terms of the GNU Lesser GPL.
  See LICENSE for more details.
 
+ The contents of the file 'Rakefile' is licensed under the terms of the
+ MIT license. See that file for more details.
+
  Some of the sample files are distributed under licenses other than the
  GNU Lesser GPL. See 'samples/README' and 'samples/GPL' for more details.
 
- John Croisant (jacius at users.sourceforge.net)
+
+ John Croisant (jacius at gmail.com)

data/ROADMAP

@@ -4,55 +4,33 @@ This represents the direction Rubygame will be going in, but
 keep in mind that specific details may change over time.
 
 
-== 2.4.0 (next minor release)
-
-Release focus: Events.
-
-- New EventHook class, has 3 parts: owner, trigger, and action.
-  - New trigger classes, e.g. KeyPressedTrigger (matches key presses)
-  - New action classes, e.g. MethodAction (calls a method on owner)
-
-- New EventHandler class
-  - Holds many EventHook instances, feeds the event to each
-    matching hook.
-
-- New HasEventHandler mixin, can embed in sprite, etc. classes
-  for easy event handling and hook creation.
-
-- New Events module, with a suite of new and revised event classes.
-
-  - Eliminate integer constants in favor of symbols
-    - Keyboard keys are symbols (e.g. :up, :a, :space)
-    - Mouse buttons are symbols (e.g. :mouse_left, :mouse_wheel_up)
-
-  - Nicer, more natural naming scheme
-    - Drop the word "Event" from the class names.
-    - "Down" and "Up" (e.g. in KeyDownEvent) become "Pressed"
-      and "Released" (e.g. KeyPressed).
-    - MouseMotionEvent becomes MouseMoved.
-    - Other miscellaneous changes.
-
-  - Better unicode / international keyboard support
-    - KeyPress#string gives a UTF8 bytestring with the glyph that was
-      generated by the keypress (useful for text input in GUIs).
-
-- Old versions of the event classes stay the same, but are deprecated.
-
-
-
 == 2.X.0 (_possible_ minor releases before 3.0.0)
 
-=== Focus: Time
+=== Focus: Clock
 
-- New Events::Tick class with lots of information
-  - Time since last frame, in both seconds and milliseconds.
+- New Events::ClockTicked class with lots of information
+  - Time since last frame, in both seconds and milliseconds
   - Current time
   - Current framerate
 
 - New clock class
-  - Based on Ruby's timer (allows multi-threading).
+  - Based on Ruby's timer (allows multi-threading)
   - Better framerate calculation algorithm
-  - #tick returns an instance of Events::Tick.
+  - #tick returns an instance of Events::Tick
+
+
+=== Focus: Surface & Rect
+
+- Surface improvements
+  - Make Surface instances copyable and marshalable
+  - Support for palettes on 8-bit Surfaces
+  - To Fix: New Surfaces never have alpha channels
+  - To Fix: Surface#set_at doesn't respect alpha
+  - To Add: Surface#pixels= (set pixel data directly)
+  - To Add: Surface.load_from_pixels (create from pixel data)
+
+- Rewrite Rect class in C for speed
+
 
 === Focus: Sprites
 
@@ -105,5 +83,3 @@ Release focus: Events.
   - Screen#update (cannot pass object with rect attribute)
   - Screen#update_rects (same as above)
   - Why not just call the ruby function from within C?
-
-

data/Rakefile

@@ -1,3 +1,41 @@
+# 
+# This is the Rakefile for Rubygame. It's used for
+# compiling, packaging, installing generating the 
+# documentation, and running specs.
+# 
+
+
+# The version number for Rubygame.
+RUBYGAME_VERSION = [2,4,0]
+
+
+# 
+# The following terms (the MIT license) apply to this Rakefile:
+# 
+# Copyright (c) 2008  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.
+# 
+
+
 require 'rubygems'
 Gem::manage_gems
 
@@ -48,14 +86,12 @@ end
 OBJEXT = from_env_or_config("OBJEXT")
 DLEXT = from_env_or_config("DLEXT")
 
-RUBYGAME_VERSION = [2,3,0]
-
 gem_spec = Gem::Specification.new do |s|
   s.name     = "rubygame"
   s.version  = RUBYGAME_VERSION.join(".")
   s.author   = "John Croisant"
-  s.email    = "jacius@users.sourceforge.net"
-  s.homepage = "http://rubygame.sourceforge.net/"
+  s.email    = "jacius@gmail.com"
+  s.homepage = "http://rubygame.org/"
   s.summary  = "Clean and powerful library for game programming"
   s.has_rdoc = true
 
@@ -192,7 +228,6 @@ string_option :sitelibdir
 CFLAGS = [from_env_or_config("CFLAGS"),
           try_sdl_config("--cflags"),
           "-I. -I#{CONFIG['topdir']}",
-          ("-g" if $options[:debug]),
           "-DRUBYGAME_MAJOR_VERSION=#{RUBYGAME_VERSION[0]}",
           "-DRUBYGAME_MINOR_VERSION=#{RUBYGAME_VERSION[1]}",
           "-DRUBYGAME_PATCHLEVEL=#{RUBYGAME_VERSION[2]}"
@@ -283,7 +318,7 @@ class ExtensionModule
          ])\
     do |t|
 
-      compile_command = "#{from_env_or_config('CC')} -c #{CFLAGS} #{t.source} -o #{t.name}"
+      compile_command = "#{from_env_or_config('CC')} -c #{CFLAGS} #{"-g " if $options[:debug]} #{t.source} -o #{t.name}"
 
       # If compile command includes i386 arch, and we're not allowing universal
       if( /-arch i386/ === compile_command and not $options[:universal] )
@@ -303,7 +338,7 @@ class ExtensionModule
     FileList.new("#{@directory}*.c").each do |source|
       object = source.sub(".c", ".#{OBJEXT}")
       file object => ([source] + depends_headers( source )) do |t|
-        compile_command = "#{CONFIG['CC']} -c #{CFLAGS} #{source} -o #{t.name}"
+        compile_command = "#{CONFIG['CC']} -c #{CFLAGS} #{"-g " if $options[:debug]} #{source} -o #{t.name}"
         if( $options[:verbose] )
           try_shell { sh compile_command }
         else
@@ -334,6 +369,7 @@ rubygame_core = ExtensionModule.new do |core|
   core.objs = ['rubygame_main',
                'rubygame_shared',
                'rubygame_event',
+               'rubygame_event2',
                'rubygame_gl',
                'rubygame_joystick',
                'rubygame_screen',
@@ -424,15 +460,63 @@ task :install => [:install_ext, :install_lib]
 
 
 
+#########
+# SPECS #
+#########
+
 begin
   require 'spec/rake/spectask'
 
-  desc "Run all specs (tests)"
+
+  desc "Run all specs"
   Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList['test/*_spec.rb']
+    t.spec_files = FileList['spec/*_spec.rb']
   end
+
+
+  namespace :spec do
+    desc "Run all specs"
+    Spec::Rake::SpecTask.new(:all) do |t|
+      t.spec_files = FileList['spec/*_spec.rb']
+    end
+
+    desc "Run spec/[name]_spec.rb (e.g. 'color')"
+    task :name do
+      puts( "This is just a stand-in spec.",
+            "Run rake spec:[name] where [name] is e.g. 'color', 'music'." )
+    end
+  end
+
+
+rule(/spec:.+/) do |t|
+  name = t.name.gsub("spec:","")
+
+  path = File.join( File.dirname(__FILE__),'spec','%s_spec.rb'%name )
+
+  if File.exist? path
+    Spec::Rake::SpecTask.new(name) do |t|
+      t.spec_files = [path]
+    end
+
+    puts "\nRunning spec/%s_spec.rb"%name
+
+    Rake::Task[name].invoke
+  else
+    puts "File does not exist: %s"%path
+  end
+
+end
+
 rescue LoadError
+
+  error = "ERROR: RSpec is not installed?"
+
   task :spec do 
-    puts "ERROR: RSpec is not installed?"
+    puts error
+  end
+
+  rule( /spec:.*/ ) do
+    puts error
   end
+
 end

data/doc/macosx_install.rdoc

@@ -48,7 +48,7 @@ In order to use Rubygame applications on Mac OS X, you must use a special wrappe
     
 
 == Installing Rubygame
-1. {Download and unpack Rubygame}[https://sourceforge.net/project/showfiles.php?group_id=172781].
+1. {Download and unpack Rubygame}[http://rubyforge.org/frs/?group_id=5089].
 2. From within the rubygame directory:
 
     sudo rake install
@@ -61,7 +61,7 @@ In order to use Rubygame applications on Mac OS X, you must use a special wrappe
 If all went well, you can now run Rubygame applications like so: 
 <code>rsdl a_rubygame_app.rb</code>
 
-If something bad happened along the way, you can {submit a support request}[https://sourceforge.net/tracker/?func=add&group_id=172781&atid=862995]
+If something bad happened along the way, you can {email rubygame-users}[https://sourceforge.net/mail/?group_id=172781]
 and we'll try to help! Be sure to include plenty of details and paste any error
 messages that occur (plus a good bit of the text right before the error
 messages).

data/doc/windows_install.rdoc

@@ -63,9 +63,9 @@ This will allow the libraries to be detected properly later on.
 == Step 2: Get Rubygame
 
 If you haven't already, download the latest Rubygame source from the 
-{download page}[http://sourceforge.net/project/showfiles.php?group_id=172781]. 
+{download page}[http://rubyforge.org/frs/?group_id=5089]. 
 If you're feeling adventurous, you could try the in-development code from
-the {Subversion repository}[http://sourceforge.net/svn/?group_id=172781].  
+the {Git repository}[http://github.com/jacius/rubygame].  
 You can decompress the .tar.bz2 file with either MSYS' <code>tar</code>
 (<code>tar xvjf rubygame-2.0.0.tar.bz2</code>) or a program like 
 {7zip}[http://www.7-zip.org].

data/ext/rubygame/rubygame_event.c

@@ -22,6 +22,7 @@
 #include "rubygame_event.h"
 
 void Rubygame_Init_Event();
+
 VALUE cEvent;
 VALUE cActiveEvent;
 VALUE cKeyDownEvent;
@@ -298,6 +299,117 @@ VALUE rbgm_fetchevents(VALUE self)
   return event_array;
 }
 
+
+
+/* Convert an argument to #enable_key_repeat into an integer
+ * number of milliseconds.
+ *
+ * Argument must be nil, :default, or a numeric greater than 0.001.
+ */
+int rg_get_keyrepeat_value( VALUE vvalue, int default_value, char *name )
+{
+
+	int value;
+
+	if( NIL_P(vvalue) )
+	{
+		return default_value;
+	}
+
+	switch( TYPE(vvalue) ){
+		case T_SYMBOL: {
+				if( make_symbol("default") == vvalue )
+				{
+					return default_value;
+				}
+				else
+				{
+					rb_raise( rb_eArgError, "unsupported symbol '%s' for %s", 
+					          RSTRING(rb_inspect(vvalue))->ptr, name );
+				}
+		}
+
+		default: {
+				int value = NUM2INT(vvalue) * 1000; /* seconds -> milleseconds */
+
+				if( value < 1 )
+				{
+					rb_raise( rb_eArgError, "%s must be at least 0.001 seconds (got %s)",
+					          name, RSTRING(rb_inspect(vvalue))->ptr);
+				}
+
+				return value;
+		}
+	}
+}
+
+
+
+/* 
+ *  call-seq:
+ *    enable_key_repeat( delay=:default, interval=:default )
+ *
+ *  Enable key repeat, so that additional keyboard release and press
+ *  events are automatically generated for as long as the key is held
+ *  down. See also #disable_key_repeat.
+ *
+ *  delay::    how many seconds to wait before starting to repeat.
+ *             Default is 0.5 seconds. (Numeric or :default, optional)
+ *
+ *  interval:: how many seconds to wait in between repetitions after
+ *             the first one. Default is 0.03 seconds. 
+ *             (Numeric or :default, optional)
+ *
+ */
+VALUE rg_enable_key_repeat(int argc, VALUE *argv, VALUE module)
+{
+
+	VALUE vdelay, vinterval;
+	rb_scan_args(argc, argv, "02", &vdelay, &vinterval);
+
+
+	int delay = rg_get_keyrepeat_value( vdelay,
+	                                    SDL_DEFAULT_REPEAT_DELAY,
+	                                    "delay" );
+
+	int interval = rg_get_keyrepeat_value( vinterval,
+	                                       SDL_DEFAULT_REPEAT_INTERVAL,
+	                                       "interval" );
+
+
+	int result = SDL_EnableKeyRepeat( delay, interval );
+
+	if (result != 0) {
+		rb_raise(eSDLError, "Could not enable key repeat: %s",
+		         SDL_GetError());
+	}
+
+	return Qnil;
+}
+
+
+
+/* 
+ *  call-seq:
+ *    disable_key_repeat
+ *
+ *  Disable key repeat, undoing the effect of #enable_key_repeat.
+ *
+ */
+VALUE rg_disable_key_repeat(VALUE module)
+{
+	int result = SDL_EnableKeyRepeat( 0, 0 );
+
+	if (result != 0) {
+		rb_raise(eSDLError, "Could not disable key repeat: %s",
+		         SDL_GetError());
+	}
+
+	return Qnil;
+}
+
+
+
 /*
  *--
  *  The event documentation is in rubygame/lib/rubygame/event.rb
@@ -310,6 +422,10 @@ void Rubygame_Init_Event()
 #endif
 
   rb_define_singleton_method(mRubygame, "fetch_sdl_events",rbgm_fetchevents,0);
+  rb_define_singleton_method(mRubygame, "enable_key_repeat", 
+	                           rg_enable_key_repeat, -1);
+  rb_define_singleton_method(mRubygame, "disable_key_repeat", 
+	                           rg_disable_key_repeat, 0);
 
   cEvent =        rb_define_class_under(mRubygame,"Event",rb_cObject);
   cActiveEvent =  rb_define_class_under(mRubygame,"ActiveEvent",cEvent);