gosu 0.10.9.pre1 → 0.11.0

data/README.md

@@ -1,20 +1,32 @@
 Welcome to Gosu!
 ================
 
-Gosu's main website is [libgosu.org](https://www.libgosu.org/).
-The source code, wiki, issue tracker and change log are all hosted on [GitHub](https://github.com/gosu/gosu)
+Gosu is a 2D game development library for Ruby and C++.
+
+The main website is [www.libgosu.org](https://www.libgosu.org/).
+The source code, wiki, issue tracker and change log are all hosted on [GitHub](https://github.com/gosu/gosu).
+
+Gosu is released under the MIT license.
+
+Getting Started
+---------------
 
 The best entry point into Gosu's documentation is the [wiki home page](https://github.com/gosu/gosu/wiki).
-Try doing the tutorial there if you don't know how to get started,
-or look at one of the games in the [Gosu Showcase](https://www.libgosu.org/cgi-bin/mwf/board_show.pl?bid=2) board.
+Try doing the tutorials there if you don't know how to get started,
+or look at existing projects in the [Gosu Showcase](https://www.libgosu.org/cgi-bin/mwf/board_show.pl?bid=2).
 
-Gosu is licensed under the MIT license. Feel invited to fork, port and transmogrify all parts of it!
+Community
+---------
 
-Complaints, questions, feedback?
-- Visit the [boards](https://www.libgosu.org/)
-- Try your luck in the (mostly idle) [IRC channel](https://webchat.freenode.net/?channels=gosu)
-- Or [email me](mailto:julian@raschke.de) :)
+- Visit our [message board](https://www.libgosu.org/cgi-bin/mwf/forum.pl) or the [r/gosu subreddit](https://reddit.com/r/gosu).
+- There’s also an IRC room, [#gosu on freenode](https://webchat.freenode.net/?channels=gosu). The regulars are spread across many timezones, so you’ll need some patience.
+- You can file bugs and feature requests as [issues on GitHub](https://github.com/gosu/gosu/issues).
+- Or [simply email me](mailto:julian@raschke.de) :)
 
-[![Build Status](https://travis-ci.org/gosu/gosu.svg?branch=master)](https://travis-ci.org/gosu/gosu) Linux, OS X and iOS builds
+Build Status
+------------
 
-[![Build status](https://ci.appveyor.com/api/projects/status/v0liohs47jono1eq?svg=true)](https://ci.appveyor.com/project/gosu-ci/gosu) Windows builds
+Platforms| 
+---|---:
+Linux, macOS and iOS|[![Travis build status](https://travis-ci.org/gosu/gosu.svg?branch=master)](https://travis-ci.org/gosu/gosu)
+Windows|[![Appveyor build status](https://ci.appveyor.com/api/projects/status/v0liohs47jono1eq?svg=true)](https://ci.appveyor.com/project/gosu-ci/gosu)

data/ext/gosu/extconf.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-if RUBY_PLATFORM =~ /mswin$|mingw32|mingw64|win32\-|\-win32/ then
+if RUBY_PLATFORM =~ /mswin$|mingw32|mingw64|win32\-|\-win32/
   platform = (RUBY_PLATFORM =~ /^x64-/ ? 'x64-mingw32' : 'i386-mingw32')
   
   puts "This gem is not meant to be installed on Windows. Instead, please use:"
@@ -10,77 +10,34 @@ end
 
 puts 'The Gosu gem requires some libraries to be installed system-wide.'
 puts 'See the following site for a list:'
-if `uname`.chomp == 'Darwin' then
+if `uname`.chomp == 'Darwin'
   puts 'https://github.com/gosu/gosu/wiki/Getting-Started-on-OS-X'
 else
   puts 'https://github.com/gosu/gosu/wiki/Getting-Started-on-Linux'
 end
 
-BASE_FILES = %w(
-  Bitmap/Bitmap.cpp
-  Bitmap/BitmapIO.cpp
-  DirectoriesUnix.cpp
-  FileUnix.cpp
-  Graphics/BlockAllocator.cpp
-  Graphics/Color.cpp
-  Graphics/Graphics.cpp
-  Graphics/Image.cpp
-  Graphics/LargeImageData.cpp
-  Graphics/Macro.cpp
-  Graphics/Resolution.cpp
-  Graphics/TexChunk.cpp
-  Graphics/Texture.cpp
-  Graphics/Transform.cpp
-  Input/Input.cpp
-  Input/TextInput.cpp
-  Inspection.cpp
-  IO.cpp
-  Math.cpp
-  Text/Font.cpp
-  Text/Text.cpp
-  Utility.cpp
-  Window.cpp
-  
-  stb_vorbis.c
-)
-
-MAC_FILES = %w(
-  Audio/Audio.mm
-  Graphics/ResolutionApple.mm
-  Text/TextApple.mm
-  TimingApple.cpp
-  UtilityApple.mm
-)
-
-LINUX_FILES = %w(
-  Audio/Audio.cpp
-  Text/TextUnix.cpp
-  TimingUnix.cpp
-)
-
 require 'mkmf'
 require 'fileutils'
 
 # Silence internal deprecation warnings in Gosu
 $CFLAGS << " -DGOSU_DEPRECATED="
 
-$CXXFLAGS ||= ''
+$CXXFLAGS ||= ""
+$CXXFLAGS << " -std=gnu++11"
 
-$INCFLAGS << " -I../.. -I../../src"
+# For #include <Gosu/...>
+$INCFLAGS << " -I../.."
 
-if `uname`.chomp == 'Darwin' then
-  SOURCE_FILES = BASE_FILES + MAC_FILES
-  
+if `uname`.chomp == 'Darwin'
   # To make everything work with the Objective C runtime
   $CFLAGS   << " -x objective-c -fobjc-arc -DNDEBUG"
-  # Compile all C++ files as Objective C++ on OS X since mkmf does not support .mm
-  # files.
+  # Compile all C++ files as Objective C++ on macOS since mkmf does not support .mm files.
   $CXXFLAGS << " -x objective-c++ -fobjc-arc -DNDEBUG"
 
-  # Enable C++ 11, and explicitly specify libc++ as the standard library.
+  # Explicitly specify libc++ as the standard library.
   # rvm will sometimes try to override this:
   # https://github.com/shawn42/gamebox/issues/96
-  $CXXFLAGS << " -std=gnu++11 -stdlib=libc++"
+  $CXXFLAGS << " -stdlib=libc++"
   
   # Dependencies.
   $CXXFLAGS << " #{`sdl2-config --cflags`.chomp}"
@@ -95,13 +52,11 @@ if `uname`.chomp == 'Darwin' then
   $ARCH_FLAG.gsub! "-arch i386", ""
   CONFIG['LDSHARED'].gsub! "-arch i386", ""
 else
-  SOURCE_FILES = BASE_FILES + LINUX_FILES
-
-  if /Raspbian/ =~ `cat /etc/issue` or /BCM2708/ =~ `cat /proc/cpuinfo` then
+  if /Raspbian/ =~ `cat /etc/issue` or /BCM2708/ =~ `cat /proc/cpuinfo`
     $INCFLAGS << " -I/opt/vc/include/GLES"
     $INCFLAGS << " -I/opt/vc/include"
-    $LDFLAGS  << " -L/opt/vc/lib"
-    $LDFLAGS  << " -lGLESv1_CM"
+    $LDFLAGS << " -L/opt/vc/lib"
+    $LDFLAGS << " -lGLESv1_CM"
   else
     pkg_config 'gl'
   end
@@ -112,33 +67,28 @@ else
   pkg_config 'openal'
   pkg_config 'sndfile'
   
-  have_header 'SDL_ttf.h'   if have_library('SDL2_ttf', 'TTF_RenderUTF8_Blended')
-  have_header 'AL/al.h'     if have_library('openal')
+  have_header 'SDL_ttf.h' if have_library('SDL2_ttf', 'TTF_RenderUTF8_Blended')
+  have_header 'AL/al.h'   if have_library('openal')
 end
 
-# And now it gets ridiculous (or I am overcomplicating things...):
-# mkmf will compile all .c/.cpp files in this directory, but if they are nested
-# inside folders, it will not find the resulting .o files during linking.
-# So we create a shim .c/.cpp file for each file that we want to compile, ensuring
-# that all .o files are built into the current directory, without any nesting.
-# TODO: Just move all of Gosu's source files back into a flat hierarchy again.
-# The nested directory structure has really not been worth it.
-SOURCE_FILES.each do |file|
-  shim_name = file.gsub('/', '-').sub(/\.mm$/, '.cpp')
-  File.open(shim_name, "w") do |shim|
-    shim.puts "#include \"../../src/#{file}\""
-  end
-end
-
-# This is necessary to build on stock Ruby on OS X 10.7.
+# This is necessary to build with stock Ruby on OS X 10.7.
 CONFIG['CXXFLAGS'] ||= $CXXFLAGS
 
-if RUBY_VERSION >= '1.9.3' and RUBY_VERSION < '2.2.0' then
-  # In some versions of Ruby and mkmf, the $CXXFLAGS variable is badly broken.
-  # We can modify CONFIG instead, and our changes will end up in the Makefile.
-  # See http://bugs.ruby-lang.org/issues/8315
-  # The lower bound was reduced to 1.9.3 here: https://github.com/gosu/gosu/issues/321
+# Gem::Version#initialize is apparently broken in some versions of Ruby, so use a local helper.
+def ruby_newer_than?(want_version)
+  have_parts = RUBY_VERSION.split('.').map { |part| part.to_i }
+  want_parts = want_version.split('.').map { |part| part.to_i }
+  have_parts << 0 while have_parts.size < want_parts.size
+  want_parts << 0 while want_parts.size < have_parts.size
+  (have_parts <=> want_parts) == 1
+end
+
+# In some versions of Ruby/mkmf, the $CXXFLAGS variable does not work.
+# We can modify CONFIG instead, and our changes will end up in the Makefile.
+# See: http://bugs.ruby-lang.org/issues/8315
+# The lower bound was reduced to 1.9.3 here: https://github.com/gosu/gosu/issues/321
+if ruby_newer_than?("1.9.2") and not ruby_newer_than?("2.2.0")
   CONFIG['CXXFLAGS'] = "#$CFLAGS #$CXXFLAGS"
 end
 
-create_makefile 'gosu'
+create_makefile "gosu", "../../src"

data/lib/gosu/patches.rb

@@ -4,31 +4,43 @@ class ::Numeric
   def degrees_to_radians
     self * Math::PI / 180.0
   end
-  
+
   def radians_to_degrees
     self * 180.0 / Math::PI
   end
-  
+
   def gosu_to_radians
     (self - 90) * Math::PI / 180.0
   end
-  
+
   def radians_to_gosu
     self * 180.0 / Math::PI + 90
   end
 end
 
 # Backwards compatibility:
-# Import constants into Gosu::Button.
-module Gosu::Button
-  Gosu.constants.each { |c| const_set(c, Gosu.const_get(c)) }
+# Support for KbLeft instead of KB_LEFT and Gp3Button2 instead of GP_3_BUTTON_2.
+# Also import old-style constants into Gosu::Button.
+module Gosu::Button; end
+Gosu.constants.grep(/^KB_|MS_|GP_/).each do |c|
+  old_name = case c
+  when :KB_ISO then "KbISO"
+  when :KB_NUMPAD_PLUS then "KbNumpadAdd"
+  when :KB_NUMPAD_MINUS then "KbNumpadSubtract"
+  when :KB_EQUALS then "KbEqual"
+  when :KB_LEFT_BRACKET then "KbBracketLeft"
+  when :KB_RIGHT_BRACKET then "KbBracketRight"
+  else c.to_s.capitalize.gsub(/_(.)/) { $1.upcase }
+  end
+  Gosu.const_set old_name, Gosu.const_get(c)
+  Gosu::Button.const_set old_name, Gosu.const_get(c)
 end
 
 # Backwards compatibility:
 # Passing a Window to initialize and from_text has been deprecated in Gosu 0.9.
 class Gosu::Image
   alias initialize_without_window initialize
-  
+
   def initialize(*args)
     if args[0].is_a? Gosu::Window then
       if args.size == 7 then
@@ -40,11 +52,11 @@ class Gosu::Image
       initialize_without_window(*args)
     end
   end
-  
+
   class << self
     alias from_text_without_window from_text
   end
-  
+
   def self.from_text(*args)
     if args.size == 4
       from_text_without_window(args[1], args[3], :font => args[2])
@@ -61,7 +73,7 @@ end
 # Passing a Window to Sample#initialize has been deprecated in Gosu 0.7.17.
 class Gosu::Sample
   alias initialize_without_window initialize
-  
+
   def initialize(*args)
     args.shift if args.first.is_a? Gosu::Window
     initialize_without_window(*args)
@@ -72,7 +84,7 @@ end
 # Passing a Window to Song#initialize has been deprecated in Gosu 0.7.17.
 class Gosu::Song
   alias initialize_without_window initialize
-  
+
   def initialize(*args)
     args.shift if args.first.is_a? Gosu::Window
     initialize_without_window(*args)
@@ -85,7 +97,7 @@ module Gosu
   class ImmutableColor < Color
     private :alpha=, :red=, :green=, :blue=, :hue=, :saturation=, :value=
   end
-  
+
   class Color
     NONE    = Gosu::ImmutableColor.new(0x00_000000)
     BLACK   = Gosu::ImmutableColor.new(0xff_000000)
@@ -109,18 +121,18 @@ end
 class Gosu::Window
   # Backwards compatibility:
   # Class methods that have been turned into module methods.
-  
+
   def self.button_id_to_char(id)
     Gosu.button_id_to_char(id)
   end
-  
+
   def self.char_to_button_id(ch)
     Gosu.char_to_button_id(ch)
   end
-  
+
   # Backwards compatibility:
   # Instance methods that have been turned into module methods.
-  
+
   %w(draw_line draw_triangle draw_quad
      flush gl clip_to record
      transform translate rotate scale
@@ -129,18 +141,22 @@ class Gosu::Window
       Gosu.send method, *args, &block
     end
   end
-  
+
   # Call Thread.pass every tick, which may or may not be necessary for friendly co-existence with
   # Ruby's Thread class.
-  
+
   alias _tick tick
-  
+
   def tick
     Thread.pass
     _tick
   end
 end
 
+# Backwards compatibility:
+# This was renamed, because it's not actually a "copyright notice" (Wikipedia: https://en.wikipedia.org/wiki/Copyright_notice).
+Gosu::GOSU_COPYRIGHT_NOTICE = Gosu::LICENSES
+
 # Release OpenAL resources during Ruby's shutdown, not Gosu's.
 at_exit do
   Gosu::Song.current_song.stop if Gosu::Song.current_song

data/lib/gosu/run.rb

@@ -1,11 +1,20 @@
-# Replace the load path
+# This script is used by Ruby.app: https://github.com/gosu/ruby_app
+
+# Replace the load path.
 $LOAD_PATH.clear
 $LOAD_PATH << File.dirname(__FILE__)[0..-6]
 $LOAD_PATH << $LOAD_PATH[0] + '/lib'
-# Ruby portions of Gosu
+
+# Ruby portions of Gosu.
 require 'gosu/patches'
 require 'gosu/swig_patches'
+
 # Let the application know it is being run from the Mac app wrapper.
 OSX_EXECUTABLE = true
-# Main application
-require 'Main'
+
+# Main application.
+begin
+  require 'Main'
+rescue LoadError
+  require 'main'
+end

data/rdoc/gosu.rb

@@ -1,24 +1,28 @@
-##
-# The first component of the version.
-GOSU_MAJOR_VERSION = :a_fixnum
+module Gosu
+  ##
+  # The first component of the version.
+  MAJOR_VERSION = :a_fixnum
 
-##
-# The second component of the version.
-GOSU_MINOR_VERSION = :a_fixnum
+  ##
+  # The second component of the version.
+  MINOR_VERSION = :a_fixnum
 
-##
-# The third component of the version.
-GOSU_POINT_VERSION = :a_fixnum
+  ##
+  # The third component of the version.
+  POINT_VERSION = :a_fixnum
 
-##
-# A version string of the form "0.1.2", "0.1.2.3" or "0.1.2pre4".
-GOSU_VERSION = :a_string
+  ##
+  # A version string of the form "0.1.2", "0.1.2.3" or "0.1.2pre4".
+  VERSION = :a_string
 
-##
-# A long block of legal copy that your game is obliged to display somewhere.
-GOSU_COPYRIGHT_NOTICE = :a_string
+  ##
+  # @deprecated Use LICENSES instead as it's a more appropriate name
+  GOSU_COPYRIGHT_NOTICE = :a_string
+
+  ##
+  # A block of legal copy that your game is obliged to display somewhere.
+  LICENSES = :a_string
 
-module Gosu
   Kb0 Kb1 Kb2 Kb3 Kb4 Kb5 Kb6 Kb7 Kb8 Kb9 = :implementation_defined
   KbA KbB KbC KbD KbE KbF KbG KbH KbI KbJ KbK KbL KbM KbN KbO KbP KbQ KbR KbS KbT KbU KbV KbW KbX KbY KbZ = :implementation_defined
   KbBackspace = :implementation_defined
@@ -736,21 +740,21 @@ module Gosu
     # The window's width, in pixels. This only counts the drawable area and does not include any borders or decorations added by the window manager.
     #
     # @return [Fixnum] the window's width, in pixels.
-    attr_reader :width
+    attr_accessor :width
 
     ##
     # The window's height, in pixels. This only counts the drawable area and does not include any borders or decorations added by the window manager.
     #
     # @return [Fixnum] the window's height, in pixels.
-    attr_reader :height
+    attr_accessor :height
 
     ##
     # @return [true, false] whether this is a full-screen window.
-    attr_reader :fullscreen?
+    attr_accessor :fullscreen?
 
     ##
     # @return [Float] the interval between calls to {#update}, in milliseconds.
-    attr_reader :update_interval
+    attr_accessor :update_interval
 
     ##
     # Creates a new window with the requested size.

data/src/ALChannelManagement.hpp

@@ -0,0 +1,119 @@
+#include <Gosu/Platform.hpp>
+#include <cstdlib>
+#include <algorithm>
+#include <memory>
+#ifdef GOSU_IS_MAC
+#include <OpenAL/al.h>
+#include <OpenAL/alc.h>
+#else
+#include <AL/al.h>
+#include <AL/alc.h>
+#endif
+
+namespace Gosu
+{
+    class ALChannelManagement
+    {
+        ALChannelManagement(const ALChannelManagement&) = delete;
+        ALChannelManagement& operator=(const ALChannelManagement&) = delete;
+        ALChannelManagement(ALChannelManagement&&) = delete;
+        ALChannelManagement& operator=(ALChannelManagement&&) = delete;
+        
+        static ALCdevice* al_device;
+        static ALCcontext* al_context;
+
+        #ifdef GOSU_IS_IPHONE
+        // iOS system limit.
+        enum { NUM_SOURCES = 32 };
+        #else
+        enum { NUM_SOURCES = 255 };
+        #endif
+        static ALuint al_sources[NUM_SOURCES];
+        static ALuint current_token;
+        static ALuint current_tokens[NUM_SOURCES];
+        
+    public:
+        enum { NO_TOKEN = -1, NO_SOURCE = -1, NO_FREE_CHANNEL = -1 };
+        
+        static ALCdevice* device()
+        {
+            return al_device;
+        }
+        
+        static ALCcontext* context()
+        {
+            return al_context;
+        }
+        
+        ALChannelManagement()
+        {
+            // Open preferred device
+            al_device = alcOpenDevice(0);
+            al_context = alcCreateContext(al_device, 0);
+            alcMakeContextCurrent(al_context);
+            alGenSources(NUM_SOURCES, al_sources);
+            std::fill(current_tokens, current_tokens + NUM_SOURCES, static_cast<ALuint>(NO_TOKEN));
+        }
+        
+        ~ALChannelManagement()
+        {
+            alDeleteSources(NUM_SOURCES, al_sources);
+            alcMakeContextCurrent(0);
+            alcDestroyContext(al_context);
+            alcCloseDevice(al_device);
+        }
+        
+        std::pair<int, int> reserve_channel()
+        {
+            int i;
+            for (i = 1; i <= NUM_SOURCES; ++i) {
+                if (i == NUM_SOURCES) {
+                    return std::make_pair<int, int>(NO_FREE_CHANNEL, NO_TOKEN);
+                }
+                if (current_tokens[i] == NO_TOKEN) {
+                    break;
+                }
+                ALint state;
+                alGetSourcei(al_sources[i], AL_SOURCE_STATE, &state);
+                if (state != AL_PLAYING && state != AL_PAUSED) {
+                    break;
+                }
+            }
+            ++current_token;
+            current_tokens[i] = current_token;
+            return std::make_pair(i, int(current_token));
+        }
+        
+        int source_if_still_playing(int channel, int token) const
+        {
+            if (channel != NO_FREE_CHANNEL && current_tokens[channel] == token) {
+                return al_sources[channel];
+            }
+            else {
+                return NO_SOURCE;
+            }
+        }
+        
+        int source_for_songs() const
+        {
+            return al_sources[0];
+        }
+    };
+    ALCdevice* ALChannelManagement::al_device = 0;
+    ALCcontext* ALChannelManagement::al_context = 0;
+    ALuint ALChannelManagement::al_sources[NUM_SOURCES];
+    ALuint ALChannelManagement::current_token = 0;
+    ALuint ALChannelManagement::current_tokens[NUM_SOURCES];
+
+    std::unique_ptr<ALChannelManagement> al_channel_management;
+    
+    void release_all_openal_resources()
+    {
+        al_channel_management.reset();
+    }
+    
+    ALCcontext *shared_openal_context()
+    {
+        return ALChannelManagement::context();
+    }
+}