rubygame 2.1.0 → 2.2.0

data/CREDITS

@@ -48,3 +48,13 @@
   Email::         danielneis at gmail.com
   Contribution::  Patch to add Sprite#undraw (based on UpdateGroup#undraw).
   Date::          2007-07-29 (r460).
+
+- <b>ippa</a>
+  Email::         admin at rubylicio.us
+  Contribution::  Patch to optimize Rect#collide_rect?
+  Date::          2007-11-21 (r595)
+
+- <b>Michael Swiger</b> / mokkan
+  Email::         mokkan at users.sourceforge.net
+  Contribution::  Patch to add Screen.icon=
+  Date::          2007-11-21 (r597)

data/{Changelog → NEWS}

@@ -1,3 +1,41 @@
+== Changes from 2.1.0 to 2.2.0
+
+=== Features
+
+- Add: Rubygame::Color module
+  - ColorRGB, ColorHSV, and ColorHSL classes.
+  - X11 and CSS palettes of pre-defined colors.
+  - Surface methods can accept ColorRGB etc. for colors.
+  - Automatic lookup of color names when a string or symbol
+    is passed for a color to Surface methods.
+- Add: Surface#set_at().
+
+- Add: Screen#icon=().
+
+=== Bug Fixes
+
+- Fix: Surface#draw_arc was incorrectly documented as Surface#draw_pie
+
+=== Improvements
+
+- Rect#collide_rect? is now faster.
+- Sprites::Group#collide_group can take a block; arguments are deprecated.
+
+=== Other Stuff
+
+- Build system correctly recompiles if source has changed.
+- Build system option syntax has changed. See the README: Advanced Install.
+- Build system will correctly exit with an error status if it can't compile;
+  fixes Rubygems trying to install even when compile failed.
+
+=== Acknowledgements
+
+- Michael Swiger (mokkan) for Screen#icon=.
+- ippa for optimizing Rect#collide_rect?.
+
+
+
+
 == Changes from 2.0.1 to 2.1.0
 
 === Features
@@ -41,6 +79,7 @@
 - Roger Ostrander (denor) for and bug fixes and adding Rubygame.key_name.
 - Bjorn De Meyer (beoran) for numerous patches and improvements.
 
+
  
 
 == Changes from 2.0.0 to 2.0.1

data/README

@@ -49,7 +49,7 @@
  If you are compiling source on a binary-based Linux ditribution,
  you will also need the "dev" packages of ruby, SDL, SDL_gfx, SDL_image,
  SDL_mixer, and SDL_ttf. (Really, you just need the header files.)
- 
+
  And of course, if you are compiling the source, you will need a C compiler!
  These versions of gcc worked fine when I tried them; other compilers might
  work too:
@@ -69,18 +69,35 @@
 
  === Advanced Install
 
- You can provide flags to configure how the build and install tasks run.
- Flags are provided in an environmental variable, RUBYGAME_CONFIG.
- (Yes, I know this is an ugly hack. At least you only have to do it once.)
+ The build and install tasks can be configured by providing certain commands
+ to rake:
+
+  * no-sdl-gfx::    do not build modules which depend on SDL_gfx
+  * no-sdl-image::  do not build modules which depend on SDL_image
+  * no-sdl-mixer::  do not build modules which depend on SDL_mixer
+  * no-sdl-ttf::    do not build modules which depend on SDL_ttf
+  * no-opengl::     do not build modules which depend on OpenGL
+
+  * no-sdl-config:: do not guess compiler/linker flags using `sdl-config'
+
+  * debug::         build modules with debbugging flags enabled
+  * verbose::       display the build commands as they are run
 
- Try this command to see all the possible configuration flags:
+ Additionally, the build process respects certain environmental variables.
+ In particular, CFLAGS and LDFLAGS are important for users compiling with
+ the no-sdl-config command.
 
-  $ RUBYGAME_CONFIG="--help" rake
+  * CC::            C compiler command
+  * CFLAGS::        flags passed to the C compiler
+  * LDSHARED::      linker command
+  * LDFLAGS::       flags passed to the linker
+  * RUBYARCHDIR::   where to install platform-specific compiled extensions
+  * RUBYLIBDIR::    where to install platform-independent interpreted libs
 
  IMPORTANT: if you are missing any optional SDL_* libraries, you must specify
- "--no-*" flags for those libraries. For example, if you don't have SDL_gfx:
+ "no-*" flags for those libraries. For example, if you don't have SDL_gfx:
 
-  $ RUBYGAME_CONFIG="--no-gfx" rake build
+  $ rake no-gfx build
 
  If you don't disable the features, the compile will probably fail when it
  looks for the headers and libraries. (The build system is not smart enough to

data/{TODO → ROADMAP}

@@ -1,15 +1,11 @@
-= TODO / ROADMAP
-
-=== 2.2.0 (next minor release)
-
-- Color (representation of a color)
-  - ColorRGB and ColorHSV classes
-  - Mix/combine colors using various blending modes (add, multiply, etc.)
-  - Library of common pre-defined colors. (:red, :black, :chartreuse, etc.)
-  - Integrate with SDL/OpenGL functions (automatic conversion).
+= ROADMAP
 
 === 3.0.0 (next major release)
 
+- Backwards compatibility will be broken:
+  - Surface#get_at
+  - Sprites::Group#collide_group
+
 - New scene/camera/sprite sytem.
 - New geometric primitives classes (for collision detection, drawing).
 - New hook-based event handler system.
@@ -43,3 +39,5 @@
   - Screen#update (cannot pass object with rect attribute)
   - Screen#update_rects (same as above)
   - Why not just call the ruby function from within C?
+
+- Generate bounding Polygon from an image automatically.

data/Rakefile

@@ -8,24 +8,47 @@ require 'rake/rdoctask'
 require "rbconfig"
 include Config
 
+require 'English'
+
+class ShellCommandError < RuntimeError
+end
+
+# Execute the block (which is supposed to perform a shell command),
+# then raise ShellCommandError if the command failed.
+def try_shell( &block )
+  result = yield
+  
+  unless $CHILD_STATUS.exitstatus == 0
+    raise ShellCommandError, "Command failed. Aborting."
+  end
+  
+  return result
+end
+
+def try_sdl_config( flag )
+  begin
+    if $options[:"sdl-config"]
+      return try_shell { `sdl-config #{flag}`.chomp }
+    else
+      return String.new
+    end
+  rescue ShellCommandError
+    warn "WARNING: 'sdl-config' failed."
+    warn "Continuing anyway, but compile may fail."
+    return String.new
+  end
+end
+
 # Get a variable from ENV or CONFIG, with ENV having precedence.
 # Returns "" if the variable didn't exist at all.
 def from_env_or_config(string)
   ([ENV[string], CONFIG[string]] - ["", nil])[0] or ""
 end
 
-def try_sdl_config( flag )
-	if $options.sdl_config
-		`sdl-config #{flag}`.chomp 
-	else
-		return ""
-	end
-end
-
 OBJEXT = from_env_or_config("OBJEXT")
 DLEXT = from_env_or_config("DLEXT")
 
-RUBYGAME_VERSION = "2.1.0"
+RUBYGAME_VERSION = "2.2.0"
 
 spec = Gem::Specification.new do |s|
   s.name     = "rubygame"
@@ -36,21 +59,20 @@ spec = Gem::Specification.new do |s|
   s.summary  = "Clean and powerful library for game programming"
   s.has_rdoc = true
 
-  candidates = Dir.glob("{lib,ext,samples,doc}/**/*")
-  s.files    = candidates.delete_if do |item|
-    item.include?("svn") or item =~ /\.#{OBJEXT}/
+  s.files = FileList.new do |fl|
+    fl.include("{lib,ext,samples,doc}/**/*")
+    fl.exclude(/svn/)
+    #fl.exclude(/\.#{OBJEXT}/)
   end
 
   s.require_paths = ["lib", "lib/rubygame/", "ext/rubygame/"]
   s.autorequire = "rubygame.rb"
   s.extensions = ["Rakefile"]
 
-  s.extra_rdoc_files = Dir.glob("doc/*.rdoc")
-  s.extra_rdoc_files += ["README",
-                         "LICENSE",
-                         "CREDITS",
-                         "TODO",
-                         "Changelog"]
+  s.extra_rdoc_files = FileList.new do |fl|
+    fl.include "doc/*.rdoc"
+    fl.include "README", "LICENSE", "CREDITS", "ROADMAP", "NEWS"
+  end
 end
 
 task :linux do
@@ -73,13 +95,13 @@ Rake::RDocTask.new do |rd|
   rd.main = "README"
   rd.title = "Rubygame #{RUBYGAME_VERSION} Docs"
   rd.rdoc_files.include("ext/rubygame/*.c",
-                        "lib/rubygame/*.rb",
+                        "lib/rubygame/**/*.rb",
                         "doc/*.rdoc",
                         "README",
                         "LICENSE",
                         "CREDITS",
-                        "TODO",
-                        "Changelog")
+                        "ROADMAP",
+                        "NEWS")
 end
 
 task :default => [:build]
@@ -90,101 +112,106 @@ require 'rake/clean'
 task(:clean) { puts "Cleaning out temporary generated files" }
 task(:clobber) { puts "Cleaning out final generated files" }
 
-# Options
-
-require 'ostruct'
-$options = OpenStruct.new(:gfx         => true,
-                         :image       => true,
-                         :ttf         => true,
-                         :mixer       => true,
-                         :opengl      => true,
-                         :sdl_config  => true,
-                         :debug       => false,
-                         :verbose     => false,
-                         :sitearchdir => CONFIG["sitearchdir"],
-                         :sitelibdir  => CONFIG["sitelibdir"]
-                         )
-
-# Default behavior for win32 is to skip sdl-config,
+##############################
+##      BUILD  OPTIONS      ##
+##############################
+
+$options = {
+	:"sdl-gfx"    => true,
+	:"sdl-image"  => true,
+	:"sdl-ttf"    => true,
+	:"sdl-mixer"  => true,
+	:opengl       => true,
+	:"sdl-config" => true,
+	:debug        => false,
+	:verbose      => false,
+	:sitearchdir  => CONFIG["sitearchdir"],
+	:sitelibdir   => CONFIG["sitelibdir"]
+}
+
+# Default behavior for win32 is to skip sdl_config,
 # since it's usually not available. It can still be
 # enabled through the options, though.
 if PLATFORM =~ /win32/
-	$options.sdl_config = false
+	$options[:"sdl-config"] = false
 end
 
-require 'optparse'
-optparse = OptionParser.new
-
-optparse.banner = "Configure the rubygame build/install tasks."
-
-optparse.on("-g", "--debug", 
-            "Compile extensions with debug symbols.") do |val|
-  $options.debug = val
-end
-optparse.on("-v", "--verbose", "Show commands while compiling.") do |val|
-  $options.verbose = val
+# Define tasks to enable and disable bool options.
+# 
+#     rake option
+#     rake no-option
+# 
+#   task_name::   the task name to use
+#   option_name:: the option name (if different from
+#                 the task name)
+#   desc::        a longer description, to fill
+#                 "Enable ________.", if different
+#                 from the task name.
+# 
+def bool_option( task_name, option_name=nil, desc=nil )
+	option_name = task_name unless option_name
+	option_name = option_name.intern if option_name.kind_of? String
+
+	desc = task_name.to_s unless desc
+  
+	notask_name = "no-#{task_name.to_s}".intern
+
+	is_true = $options[option_name]
+	
+	desc "Enable #{desc} #{'(default)' if is_true}"
+	task(task_name)   { $options[option_name] = true  }
+
+	desc "Disable #{desc} #{'(default)' unless is_true}"
+	task(notask_name) { $options[option_name] = false }
 end
-optparse.on("--[no-]gfx", "Compile rubygame_gfx or not.") do |val|
-  $options.gfx = val
-end
-optparse.on("--[no-]image", "Compile rubygame_image or not.") do |val|
-  $options.image = val
-end
-optparse.on("--[no-]ttf", "Compile rubygame_ttf or not.") do |val|
-  $options.ttf = val
-end
-optparse.on("--[no-]mixer", "Compile rubygame_mixer or not.") do |val|
-  $options.mixer = val
-end
-optparse.on("--[no-]opengl", "Enable OpenGL support.") do |val|
-  $options.opengl = val
-end
-optparse.on("--[no-]sdl-config",
-            "Feed results from `sdl-config' to \\",
-            "\tthe compiler and linker or not.") do |val|
-  $options.sdl_config = val
-end
-optparse.on("--sitearchdir PATH",
-            "Install extensions into this PATH \\",
-            "\tinstead of the usual sitearchdir.") do |val|
-  $options.sitearchdir = val
-end
-optparse.on("--sitelibdir PATH",
-            "Install library into this PATH \\",
-            "\tinstead of the usual sitelibdir.") do |val|
-  $options.sitelibdir = val
+
+# Gather a string option from an environment variable:
+# 
+#     rake option="the value of the option"
+# 
+#   task_name::   the task name to use
+#   option_name:: the option name (if different from
+#                 the task name)
+# 
+def string_option( task_name, option_name=nil )
+	option_name = task_name unless option_name
+	option_name = option_name.intern if option_name.kind_of? String
+
+	$options[option_name] = ENV["#{task_name}"] if ENV["#{task_name}"]
 end
 
-# Rake is not very nice about letting us specify custom flags, so
-# we'll go around it in this way.
-optparse.parse( (ENV["RUBYGAME_CONFIG"] or "").split(" ") )
+bool_option :"sdl-gfx",    nil,  "SDL_gfx support"
+bool_option :"sdl-image",  nil,  "SDL_image support"
+bool_option :"sdl-mixer",  nil,  "SDL_mixer support"
+bool_option :"sdl-ttf",    nil,  "SDL_ttf support"
+bool_option :"sdl-config", nil,  "guess compiler flags for SDL"
+bool_option :opengl,       nil,  "OpenGL support"
+bool_option :debug,        nil,  "compil with debug symbols"
+bool_option :verbose,      nil,  "show compiler commands"
 
-# rubygem passes RUBYARCHDIR=/path/to/some/directory when building extension
-rule( /RUBYARCHDIR/ ) do |t|
-  $options.sitearchdir = t.name.split("=")[1]
-end
+string_option "RUBYARCHDIR", :sitearchdir
+string_option :sitearchdir
+
+string_option "RUBYLIBDIR", :sitelibdir
+string_option :sitelibdir
 
-# rubygem passes RUBYLIBDIR=/path/to/another/directory when building extension
-rule( /RUBYLIBDIR/ ) do |t|
-  $options.sitelibdir = t.name.split("=")[1]
-end
 
 CFLAGS = [from_env_or_config("CFLAGS"),
           try_sdl_config("--cflags"),
           "-I. -I#{CONFIG['topdir']}",
-          ("-g" if $options.debug) ].join(" ")
+          ("-g" if $options[:debug]) ].join(" ")
 
 LINK_FLAGS = [from_env_or_config("LIBRUBYARG_SHARED"),
               from_env_or_config("LDFLAGS"),
               try_sdl_config("--libs")].join(" ")
 
-DEFALUT_EXTDIR = File.join('ext','rubygame','')
+DEFAULT_EXTDIR = File.join('ext','rubygame','')
 
 class ExtensionModule
   @@libflag = " -l%s " # compiler flag for giving linked libraries
   attr_accessor :dynlib, :objs, :libs, :cflags, :lflags, :directory
   def initialize(&block)
-    @directory = DEFALUT_EXTDIR
+    @directory = DEFAULT_EXTDIR
     @dynlib = ""
     @objs = []
     @libs = []
@@ -221,20 +248,14 @@ class ExtensionModule
       File.join( @directory, "#{obj}.#{OBJEXT}" )
     }
 
-    taskname = @dynlib.gsub('rubygame_','')
-
-    file dynlib_full do
-      Rake::Task[taskname].invoke
-    end
-
     desc "Compile the #{@dynlib} extension"
-    task taskname => objs_full do |task|
+    file dynlib_full => objs_full do |task|
       link_command = "#{from_env_or_config('LDSHARED')} #{LINK_FLAGS} #{@lflags} -o #{dynlib_full} #{task.prerequisites.join(' ')}"
-      if( $options.verbose )
-        sh link_command
+      if( $options[:verbose] )
+        try_shell { sh link_command }
       else
         puts "Linking compiled files to create #{File.basename(@directory)}/#{File.basename(dynlib_full)}"
-        `#{link_command}`
+        try_shell { `#{link_command}` }
       end
     end
 
@@ -256,11 +277,11 @@ class ExtensionModule
          ])\
     do |t|
       compile_command = "#{from_env_or_config('CC')} -c #{CFLAGS} #{t.source} -o #{t.name}"
-      if( $options.verbose )
-        sh compile_command
+      if( $options[:verbose] )
+        try_shell { sh compile_command }
       else
         puts "Compiling #{File.basename(@directory)}/#{File.basename(t.source)}"
-        `#{compile_command}`
+        try_shell { `#{compile_command}` }
       end
     end
   rescue
@@ -269,11 +290,11 @@ class ExtensionModule
       object = source.sub(".c", ".#{OBJEXT}")
       file object => ([source] + depends_headers( source )) do |t|
         compile_command = "#{CONFIG['CC']} -c #{CFLAGS} #{source} -o #{t.name}"
-        if( $options.verbose )
-          sh compile_command
+        if( $options[:verbose] )
+          try_shell { sh compile_command }
         else
           puts "Compiling #{File.basename(@directory)}/#{File.basename(source)}"
-          `#{compile_command}`
+          try_shell { `#{compile_command}` }
         end
       end
     end
@@ -316,7 +337,7 @@ rubygame_gfx = ExtensionModule.new do |gfx|
   gfx.add_lib( 'SDL_gfx' )
   gfx.add_header( 'SDL_gfxPrimitives.h')
   gfx.add_header( 'SDL_rotozoom.h' )
-  gfx.create_all_tasks() if $options.gfx
+  gfx.create_all_tasks() if $options[:"sdl-gfx"]
 end
 
 rubygame_image = ExtensionModule.new do |image|
@@ -324,7 +345,7 @@ rubygame_image = ExtensionModule.new do |image|
   image.objs = ['rubygame_shared', 'rubygame_image']
   image.add_lib('SDL_image')
   image.add_header('SDL_image.h')
-  image.create_all_tasks() if $options.image
+  image.create_all_tasks() if $options[:"sdl-image"]
 end
 
 rubygame_mixer = ExtensionModule.new do |mixer|
@@ -332,7 +353,7 @@ rubygame_mixer = ExtensionModule.new do |mixer|
   mixer.objs = ['rubygame_shared', 'rubygame_mixer']
   mixer.add_lib('SDL_mixer')
   mixer.add_header('SDL_mixer.h')
-  mixer.create_all_tasks() if $options.mixer
+  mixer.create_all_tasks() if $options[:"sdl-mixer"]
 end
 
 rubygame_ttf = ExtensionModule.new do |ttf|
@@ -340,10 +361,10 @@ rubygame_ttf = ExtensionModule.new do |ttf|
   ttf.add_lib('SDL_ttf')
   ttf.objs = ['rubygame_shared', 'rubygame_ttf']
   ttf.add_header('SDL_ttf.h')
-  ttf.create_all_tasks() if $options.ttf
+  ttf.create_all_tasks() if $options[:"sdl-ttf"]
 end
 
-if $options.opengl
+if $options[:opengl]
   CFLAGS << " -DHAVE_OPENGL "
 end
 
@@ -361,19 +382,27 @@ task :fix_filenames do
 	end
 end
 
-desc "Install only the extensions"
+desc "Install just the extensions"
 task :install_ext do |task|
-  puts "Installing extensions to #{$options.sitearchdir}"
-  mkdir_p $options.sitearchdir
-  cp task.prerequisites.to_a, $options.sitearchdir
+  puts "Installing extensions to #{$options[:sitearchdir]}"
+  mkdir_p $options[:sitearchdir]
+  cp task.prerequisites.to_a, $options[:sitearchdir]
 end
 
-desc "Install only the library"
+desc "Install just the library"
 task :install_lib do |task|
-  puts "Installing library to #{$options.sitelibdir}"
-  mkdir_p $options.sitelibdir + "/rubygame/"
-  cp "./lib/rubygame.rb", $options.sitelibdir
-  cp FileList.new("./lib/rubygame/*.rb").to_a, $options.sitelibdir+"/rubygame/"
+  puts "Installing library to #{$options[:sitelibdir]}"
+
+  files = FileList.new do |fl|
+    fl.include("lib/**/*.rb")
+    fl.exclude(/svn/)
+  end
+
+  files.each do |f|
+    dir = File.join($options[:sitelibdir], File.dirname(f).sub('lib',''), "")
+    mkdir_p dir
+    cp f, dir
+  end
 end
 
 desc "Install both the extensions and the library"