gosu 0.15.0 → 1.0.0

data/ext/gosu/extconf.rb

@@ -1,41 +1,62 @@
-#!/usr/bin/env ruby
+require "rbconfig"
 
-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:"
-  puts "gem install gosu --platform=#{platform}"
-  exit 1
+case RbConfig::CONFIG["host_os"]
+when /^mingw/
+  windows = true
+when /^darwin/
+  macos = true
 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'
-  puts 'https://github.com/gosu/gosu/wiki/Getting-Started-on-OS-X'
-else
-  puts 'https://github.com/gosu/gosu/wiki/Getting-Started-on-Linux'
+if not windows
+  puts 'The Gosu gem requires some libraries to be installed system-wide.'
+  puts 'See the following site for a list:'
+  if macos
+    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
 end
 
 require 'mkmf'
 require 'fileutils'
 
-# Silence internal deprecation warnings in Gosu
+# Silence internal deprecation warnings in Gosu.
 $CFLAGS << " -DGOSU_DEPRECATED="
 
+# Disable assertions in C code.
+$CFLAGS << " -DNDEBUG"
+
 $CXXFLAGS ||= ""
-$CXXFLAGS << " -std=gnu++11"
+# Enable C++17, but at the same time make the compiler more permissive to avoid this error:
+# https://stackoverflow.com/a/31899029 (triggered by ruby.h, which uses register variables)
+# The "register" macro can be removed when support for Ruby 2.6 and older has been dropped.
+$CXXFLAGS << " -std=gnu++17 -Dregister="
+
+# Make Gosu's own header files and all of its dependencies available to C++ source files.
+$INCFLAGS << " -I../../include -I../../dependencies/stb -I../../dependencies/utf8proc -I../../dependencies/SDL_sound"
 
-# For #include <Gosu/...>
-$INCFLAGS << " -I../.."
+if windows
+  # We statically compile utf8proc into the Gosu binary.
+  # This macro is required to avoid errors about dllexport/dllimport mismatches.
+  $CFLAGS << " -DUTF8PROC_STATIC"
+  $CXXFLAGS << " -DUTF8PROC_STATIC"
 
-if `uname`.chomp == 'Darwin'
-  # Disable assertions in C code.
-  $CFLAGS   << " -DNDEBUG"
+  # Define UNICODE to use the Unicode-aware variants of all Win32 API functions.
+  $CXXFLAGS << " -DUNICODE"
+
+  # Use the bundled versions of SDL 2 and open_al.
+  $INCFLAGS << " -I../../dependencies/al_soft -I../../dependencies/SDL/include"
+  if RbConfig::CONFIG['arch'] =~ /x64-/
+    $LDFLAGS << "  -L../../dependencies/al_soft/x64 -L../../dependencies/SDL/lib/x64"
+  else
+    $LDFLAGS << "  -L../../dependencies/al_soft/x86 -L../../dependencies/SDL/lib/x86"
+  end
+  $LDFLAGS << " -lgdi32 -lwinmm -lOpenGL32 -lOpenAL32 -lSDL2"
+  # Link libstdc++ statically to avoid having another DLL dependency when using Ocra.
+  $LDFLAGS << " -static-libstdc++"
+elsif macos
   # Compile all C++ files as Objective C++ on macOS since mkmf does not support .mm files.
   $CXXFLAGS << " -x objective-c++ -fobjc-arc -DNDEBUG"
-  # Prevents issues with Apple's pre-installed Ruby 2.3 on macOS 10.13.
-  # https://github.com/gosu/gosu/issues/424
-  $CXXFLAGS << " -Wno-reserved-user-defined-literal"
 
   # Explicitly specify libc++ as the standard library.
   # rvm will sometimes try to override this:
@@ -43,6 +64,7 @@ if `uname`.chomp == 'Darwin'
   $CXXFLAGS << " -stdlib=libc++"
   
   # Dependencies.
+  $CFLAGS << " #{`sdl2-config --cflags`.chomp}"
   $CXXFLAGS << " #{`sdl2-config --cflags`.chomp}"
   # Prefer statically linking SDL 2.
   $LDFLAGS  << " #{`sdl2-config --static-libs`.chomp} -framework OpenGL -framework Metal -framework OpenAL"
@@ -76,24 +98,16 @@ else
   pkg_config 'libmpg123'
   pkg_config 'fontconfig'
   
-  have_header 'AL/al.h'   if have_library('openal')
+  have_header 'AL/al.h' if have_library('openal')
 end
 
-# 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"
+# Because Ruby will only compile source file in the src/ folder, but our dependencies are
+# stored in dependencies/, we need to create symlinks for all the .c files. This is terrible,
+# but still seems better than putting everything into the same folder to begin with.
+Dir.glob('../../dependencies/**/*.c').each do |dep|
+  File.open("../../src/#{File.basename dep}", "w") do |shim|
+    shim.puts "#include \"#{File.expand_path dep}\""
+  end
 end
 
 create_makefile "gosu", "../../src"

data/{Gosu → include/Gosu}/Audio.hpp

@@ -51,8 +51,8 @@ namespace Gosu
     //! parameters. Use samples for everything that's not music.
     class Sample
     {
-        struct SampleData;
-        std::shared_ptr<SampleData> data;
+        struct Impl;
+        std::shared_ptr<Impl> pimpl;
 
     public:
         //! Constructs an empty sample that is inaudible when played.
@@ -91,10 +91,8 @@ namespace Gosu
     //! and there is no way to control its pan (stereo position) or speed.
     class Song
     {
-        class BaseData;
-        class ModuleData;
-        class StreamData;
-        std::unique_ptr<BaseData> data;
+        struct Impl;
+        std::unique_ptr<Impl> pimpl;
         
         // Non-movable to avoid dangling internal references.
         Song(Song&&) = delete;
@@ -117,7 +115,7 @@ namespace Gosu
         //! no song has been played yet or the last song has finished
         //! playing.
         static Song* current_song();
-        
+
         //! Starts or resumes playback of the song. This will stop all other
         //! songs and set the current song to this object.
         void play(bool looping = false);
@@ -137,7 +135,7 @@ namespace Gosu
         //! \param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
         void set_volume(double volume);
         
-        //! Called every tick by Window for management purposes.
+        //! Called every tick by Window to feed new audio data to OpenAL.
         static void update();
     };
 }

data/include/Gosu/Bitmap.hpp

@@ -0,0 +1,100 @@
+#pragma once
+
+#include <Gosu/Color.hpp>
+#include <Gosu/IO.hpp>
+#include <string>
+#include <vector>
+
+namespace Gosu
+{
+    /// A two-dimensional array area of pixels, each represented by a Color value.
+    /// Bitmaps are typically created only as an intermediate step between loading image files, and
+    /// creating Gosu::Image objects from them (i.e. transferring the image into video RAM).
+    /// Has (expensive) value semantics.
+    class Bitmap
+    {
+        int m_width = 0, m_height = 0;
+        std::vector<Color> m_pixels;
+
+    public:
+        Bitmap() = default;
+
+        Bitmap(int width, int height, Color c = Color::NONE);
+
+        int width() const
+        {
+            return m_width;
+        }
+
+        int height() const
+        {
+            return m_height;
+        }
+
+        void swap(Bitmap& other);
+
+        void resize(int width, int height, Color c = Color::NONE);
+
+        /// Returns the color at the specified position without any bounds checking.
+        Color get_pixel(int x, int y) const
+        {
+            return m_pixels[y * m_width + x];
+        }
+
+        /// Sets the pixel at the specified position without any bounds checking.
+        void set_pixel(int x, int y, Color c)
+        {
+            m_pixels[y * m_width + x] = c;
+        }
+
+        /// This updates a pixel using the "over" alpha compositing operator, see:
+        /// https://en.wikipedia.org/wiki/Alpha_compositing
+        void blend_pixel(int x, int y, Color c);
+
+        /// Inserts a bitmap at the given position. Parts of the inserted bitmap that would be
+        /// outside of the target bitmap will be clipped away.
+        void insert(int x, int y, const Bitmap& source);
+
+        /// Inserts a portion of a bitmap at the given position. Parts of the inserted bitmap that
+        /// would be outside of the target bitmap will be clipped away.
+        void insert(int x, int y, const Bitmap& source,
+                    int src_x, int src_y, int src_width, int src_height);
+
+        /// Direct access to the array of color values.
+        /// The return value is undefined if this bitmap is empty.
+        const Color* data() const
+        {
+            return &m_pixels[0];
+        }
+
+        /// Direct access to the array of color values.
+        /// The return value is undefined if this bitmap is empty.
+        Color* data()
+        {
+            return &m_pixels[0];
+        }
+
+        #ifdef FRIEND_TEST
+        FRIEND_TEST(BitmapTests, MemoryManagement);
+        #endif
+    };
+
+    /// Loads any supported image into a Bitmap.
+    Bitmap load_image_file(const std::string& filename);
+    /// Loads any supported image into a Bitmap.
+    Bitmap load_image_file(Reader input);
+
+    /// Saves a Bitmap to a file.
+    void save_image_file(const Bitmap& bitmap, const std::string& filename);
+    /// Saves a Bitmap to an arbitrary resource.
+    void save_image_file(const Bitmap& bitmap, Writer writer,
+                         const std::string_view& format_hint = "png");
+
+    /// Set the alpha value of all pixels which are equal to the color key to zero.
+    /// To reduce interpolation artefacts when stretching or rotating the resulting image, the color
+    /// value of these pixels will also be adjusted to the average of their surrounding pixels.
+    void apply_color_key(Bitmap& bitmap, Color key);
+
+    Bitmap apply_border_flags(unsigned image_flags, const Bitmap& source,
+                              int src_x, int src_y, int src_width, int src_height);
+}

data/{Gosu → include/Gosu}/Buttons.hpp

@@ -1,15 +1,12 @@
 #pragma once
 
-#include <Gosu/Platform.hpp>
-
 namespace Gosu
 {
-    //! List of button ids that can be used with Gosu::Input.
-    //! This enumeration contains ids for keyboard keys (KB_*),
-    //! mouse buttons and mouse wheel (MS_*) and gamepad buttons (GP_*).
-    enum ButtonName
+    /// List of button IDs that can be used with Gosu::Input.
+    /// This enumeration contains IDs for keyboard keys (KB_*),
+    /// mouse buttons and mouse wheel (MS_*), as well as gamepad buttons (GP_*).
+    enum Button
     {
-        KB_RANGE_BEGIN,
         KB_ESCAPE          = 41,
         KB_F1              = 58,
         KB_F2              = 59,
@@ -51,6 +48,9 @@ namespace Gosu
         KB_DOWN            = 81,
         KB_HOME            = 74,
         KB_END             = 77,
+        KB_PRINT_SCREEN    = 70,
+        KB_SCROLL_LOCK     = 71,
+        KB_PAUSE           = 72,
         KB_INSERT          = 73,
         KB_DELETE          = 76,
         KB_PAGE_UP         = 75,
@@ -67,6 +67,7 @@ namespace Gosu
         KB_COMMA           = 54,
         KB_PERIOD          = 55,
         KB_SLASH           = 56,
+        KB_CAPS_LOCK       = 57,
         KB_A               = 4,
         KB_B               = 5,
         KB_C               = 6,
@@ -93,7 +94,8 @@ namespace Gosu
         KB_X               = 27,
         KB_Y               = 28,
         KB_Z               = 29,
-        KB_ISO             = 100, // ` on US/UK macOS, < on EU macOS, \ on US/UK Windows
+        /// ` on US/UK macOS, < on EU macOS, \ on US/UK Windows
+        KB_ISO             = 100,
         KB_NUMPAD_0        = 98,
         KB_NUMPAD_1        = 89,
         KB_NUMPAD_2        = 90,
@@ -125,13 +127,12 @@ namespace Gosu
         MS_OTHER_5,
         MS_OTHER_6,
         MS_OTHER_7,
-        MS_RANGE_END = 0x110,
-        
+
         GP_RANGE_BEGIN,
-        GP_LEFT = GP_RANGE_BEGIN,
-        GP_RIGHT,
-        GP_UP,
-        GP_DOWN,
+        GP_DPAD_LEFT = GP_RANGE_BEGIN,
+        GP_DPAD_RIGHT,
+        GP_DPAD_UP,
+        GP_DPAD_DOWN,
         GP_BUTTON_0,
         GP_BUTTON_1,
         GP_BUTTON_2,
@@ -149,10 +150,10 @@ namespace Gosu
         GP_BUTTON_14,
         GP_BUTTON_15,
 
-        GP_0_LEFT,
-        GP_0_RIGHT,
-        GP_0_UP,
-        GP_0_DOWN,
+        GP_0_DPAD_LEFT,
+        GP_0_DPAD_RIGHT,
+        GP_0_DPAD_UP,
+        GP_0_DPAD_DOWN,
         GP_0_BUTTON_0,
         GP_0_BUTTON_1,
         GP_0_BUTTON_2,
@@ -169,11 +170,11 @@ namespace Gosu
         GP_0_BUTTON_13,
         GP_0_BUTTON_14,
         GP_0_BUTTON_15,
-        
-        GP_1_LEFT,
-        GP_1_RIGHT,
-        GP_1_UP,
-        GP_1_DOWN,
+
+        GP_1_DPAD_LEFT,
+        GP_1_DPAD_RIGHT,
+        GP_1_DPAD_UP,
+        GP_1_DPAD_DOWN,
         GP_1_BUTTON_0,
         GP_1_BUTTON_1,
         GP_1_BUTTON_2,
@@ -190,11 +191,11 @@ namespace Gosu
         GP_1_BUTTON_13,
         GP_1_BUTTON_14,
         GP_1_BUTTON_15,
-        
-        GP_2_LEFT,
-        GP_2_RIGHT,
-        GP_2_UP,
-        GP_2_DOWN,
+
+        GP_2_DPAD_LEFT,
+        GP_2_DPAD_RIGHT,
+        GP_2_DPAD_UP,
+        GP_2_DPAD_DOWN,
         GP_2_BUTTON_0,
         GP_2_BUTTON_1,
         GP_2_BUTTON_2,
@@ -211,11 +212,11 @@ namespace Gosu
         GP_2_BUTTON_13,
         GP_2_BUTTON_14,
         GP_2_BUTTON_15,
-        
-        GP_3_LEFT,
-        GP_3_RIGHT,
-        GP_3_UP,
-        GP_3_DOWN,
+
+        GP_3_DPAD_LEFT,
+        GP_3_DPAD_RIGHT,
+        GP_3_DPAD_UP,
+        GP_3_DPAD_DOWN,
         GP_3_BUTTON_0,
         GP_3_BUTTON_1,
         GP_3_BUTTON_2,
@@ -232,16 +233,75 @@ namespace Gosu
         GP_3_BUTTON_13,
         GP_3_BUTTON_14,
         GP_3_BUTTON_15,
-        
-        GP_RANGE_END       = GP_3_BUTTON_15,
-        
-        NUM_BUTTONS        = GP_RANGE_END + 1,
-        NUM_GAMEPADS       = 4,
-        NO_BUTTON          = 0xffffffff,
-        
-        KB_NUM             = KB_RANGE_END - KB_RANGE_BEGIN + 1,
-        MS_NUM             = MS_RANGE_END - MS_RANGE_BEGIN + 1,
-        GP_NUM             = GP_RANGE_END - GP_RANGE_BEGIN + 1,
-        GP_NUM_PER_GAMEPAD = GP_NUM / (NUM_GAMEPADS + 1)
+
+        GP_LEFT,
+        GP_RIGHT,
+        GP_UP,
+        GP_DOWN,
+
+        GP_0_LEFT,
+        GP_0_RIGHT,
+        GP_0_UP,
+        GP_0_DOWN,
+
+        GP_1_LEFT,
+        GP_1_RIGHT,
+        GP_1_UP,
+        GP_1_DOWN,
+
+        GP_2_LEFT,
+        GP_2_RIGHT,
+        GP_2_UP,
+        GP_2_DOWN,
+
+        GP_3_LEFT,
+        GP_3_RIGHT,
+        GP_3_UP,
+        GP_3_DOWN,
+        GP_RANGE_END = GP_3_DOWN,
+
+        NUM_GAMEPADS = 4,
+        NO_BUTTON = 0xffffffff,
+    };
+
+    /// List of axis IDs that can be used with Gosu::Input.
+    enum Axis
+    {
+        GP_LEFT_STICK_X_AXIS,
+        GP_LEFT_STICK_Y_AXIS,
+        GP_RIGHT_STICK_X_AXIS,
+        GP_RIGHT_STICK_Y_AXIS,
+        GP_LEFT_TRIGGER_AXIS,
+        GP_RIGHT_TRIGGER_AXIS,
+
+        GP_0_LEFT_STICK_X_AXIS,
+        GP_0_LEFT_STICK_Y_AXIS,
+        GP_0_RIGHT_STICK_X_AXIS,
+        GP_0_RIGHT_STICK_Y_AXIS,
+        GP_0_LEFT_TRIGGER_AXIS,
+        GP_0_RIGHT_TRIGGER_AXIS,
+
+        GP_1_LEFT_STICK_X_AXIS,
+        GP_1_LEFT_STICK_Y_AXIS,
+        GP_1_RIGHT_STICK_X_AXIS,
+        GP_1_RIGHT_STICK_Y_AXIS,
+        GP_1_LEFT_TRIGGER_AXIS,
+        GP_1_RIGHT_TRIGGER_AXIS,
+
+        GP_2_LEFT_STICK_X_AXIS,
+        GP_2_LEFT_STICK_Y_AXIS,
+        GP_2_RIGHT_STICK_X_AXIS,
+        GP_2_RIGHT_STICK_Y_AXIS,
+        GP_2_LEFT_TRIGGER_AXIS,
+        GP_2_RIGHT_TRIGGER_AXIS,
+
+        GP_3_LEFT_STICK_X_AXIS,
+        GP_3_LEFT_STICK_Y_AXIS,
+        GP_3_RIGHT_STICK_X_AXIS,
+        GP_3_RIGHT_STICK_Y_AXIS,
+        GP_3_LEFT_TRIGGER_AXIS,
+        GP_3_RIGHT_TRIGGER_AXIS,
+
+        NUM_AXES
     };
 }