gosu 1.3.0 → 1.4.0

data/ext/gosu/extconf.rb

@@ -8,17 +8,17 @@ when /^darwin/
 end
 
 if not windows
-  puts 'The Gosu gem requires some libraries to be installed system-wide.'
-  puts 'See the following site for a list:'
+  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'
+    puts "https://github.com/gosu/gosu/wiki/Getting-Started-on-OS-X"
   else
-    puts 'https://github.com/gosu/gosu/wiki/Getting-Started-on-Linux'
+    puts "https://github.com/gosu/gosu/wiki/Getting-Started-on-Linux"
   end
 end
 
-require 'mkmf'
-require 'fileutils'
+require "mkmf"
+require "fileutils"
 
 # Silence internal deprecation warnings in Gosu.
 $CFLAGS << " -DGOSU_DEPRECATED="
@@ -33,25 +33,25 @@ $CXXFLAGS ||= ""
 $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"
+$INCFLAGS << " -I../../include -I../../dependencies/stb -I../../dependencies/utf8proc -I../../dependencies/SDL_sound -I../../dependencies/mojoAL"
 
 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"
+  $CFLAGS << " -DUTF8PROC_STATIC -DAL_LIBTYPE_STATIC"
+  $CXXFLAGS << " -DUTF8PROC_STATIC -DAL_LIBTYPE_STATIC"
 
   # 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"
+  $INCFLAGS << " -I../../dependencies/SDL/include"
+  if RbConfig::CONFIG["arch"] =~ /x64-/
+    $LDFLAGS << "  -L../../dependencies/SDL/lib/x64"
   else
-    $LDFLAGS << "  -L../../dependencies/al_soft/x86 -L../../dependencies/SDL/lib/x86"
+    $LDFLAGS << "  -L../../dependencies/SDL/lib/x86"
   end
-  $LDFLAGS << " -lgdi32 -lwinmm -ldwmapi -lOpenGL32 -lOpenAL32 -lSDL2"
+  $LDFLAGS << " -lgdi32 -lwinmm -ldwmapi -lOpenGL32 -lSDL2"
   # Link libstdc++ statically to avoid having another DLL dependency when using Ocra.
   $LDFLAGS << " -static-libstdc++"
 elsif macos
@@ -66,49 +66,48 @@ elsif macos
   # Disable an error that is disabled by default and prevents Gosu from building with universal Ruby:
   # https://trac.macports.org/ticket/58255 / https://github.com/gosu/gosu/issues/424
   $CXXFLAGS << " -Wno-reserved-user-defined-literal"
-  
+
   # 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"
+  $LDFLAGS << " #{`sdl2-config --static-libs`.chomp} -framework OpenGL -framework Metal"
   # And yet another hack: `sdl2-config --static-libs` uses `-lSDL2` instead of linking to the static library,
   # even if it exists. -> Manually replace it. (Ugh!)
-  $LDFLAGS.sub! " -lSDL2 ", " /usr/local/lib/libSDL2.a " if File.exist? "/usr/local/lib/libSDL2.a"
-  
+  %w(/usr/local/lib/libSDL2.a /opt/homebrew/opt/sdl2/lib/libSDL2.a).each do |static_lib|
+    $LDFLAGS.sub! " -lSDL2 ", " #{static_lib} " if File.exist? static_lib
+  end
+
   # Disable building of 32-bit slices in Apple's Ruby.
   # (RbConfig::CONFIG['CXXFLAGS'] on 10.11: -arch x86_64 -arch i386 -g -Os -pipe)
   $CFLAGS.gsub! "-arch i386", ""
   $CXXFLAGS.gsub! "-arch i386", ""
   $LDFLAGS.gsub! "-arch i386", ""
   $ARCH_FLAG.gsub! "-arch i386", ""
-  CONFIG['LDSHARED'].gsub! "-arch i386", ""
+  CONFIG["LDSHARED"].gsub! "-arch i386", ""
 else
   if /BCM2708/ =~ `cat /proc/cpuinfo`
     $INCFLAGS << " -I/opt/vc/include/GLES"
     $INCFLAGS << " -I/opt/vc/include"
     $LDFLAGS << " -L/opt/vc/lib"
     $LDFLAGS << " -lGLESv1_CM"
-    $CFLAGS   << " -DGOSU_IS_OPENGLES"
+    $CFLAGS << " -DGOSU_IS_OPENGLES"
     $CXXFLAGS << " -DGOSU_IS_OPENGLES"
   else
-    pkg_config 'gl'
+    pkg_config "gl"
   end
 
-  pkg_config 'sdl2'
-  pkg_config 'vorbisfile'
-  pkg_config 'openal'
-  pkg_config 'sndfile'
-  pkg_config 'libmpg123'
-  pkg_config 'fontconfig'
-  
-  have_header 'AL/al.h' if have_library('openal')
+  pkg_config "sdl2"
+  pkg_config "vorbisfile"
+  pkg_config "sndfile"
+  pkg_config "libmpg123"
+  pkg_config "fontconfig"
 end
 
 # 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|
+Dir.glob("../../dependencies/**/*.c").each do |dep|
   File.open("../../src/#{File.basename dep}", "w") do |shim|
     shim.puts "#include \"#{File.expand_path dep}\""
   end

data/include/Gosu/Audio.hpp

@@ -1,141 +1,126 @@
-//! \file Audio.hpp
-//! Contains all the classes of Gosu's audio system.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
 #include <Gosu/IO.hpp>
 #include <Gosu/Platform.hpp>
+#include <Gosu/Utility.hpp>
 #include <memory>
 #include <string>
 
 namespace Gosu
 {
-    //! Sample::play returns a Channel that represents the sound being played.
-    //! This object can be used to stop sounds dynamically, or to check whether playback has
-    //! finished.
+    /// Sample::play returns a Channel that represents the sound being played.
+    /// This object can be used to stop or influence sounds as they are played, or to check whether
+    /// playback has finished.
     class Channel
     {
-        mutable int channel, token;
+        mutable int m_channel, m_token;
 
     public:
-        //! This creates an "empty" Channel which is expired and cannot be resumed.
+        /// This creates an "empty" Channel which is expired and cannot be resumed.
         Channel();
-        //! For internal use only.
+        /// For internal use only.
         Channel(int channel, int token);
-        
-        //! For internal use only.
+
+        /// For internal use only.
         int current_channel() const;
-        
+
         bool playing() const;
         bool paused() const;
-        //! Pauses this instance to be resumed afterwards.
-        //! Avoid leaving samples paused for too long, as they will still occupy one of Gosu's
-        //! limited channels.
+        /// Pauses this instance to be resumed afterwards.
+        /// Avoid leaving samples paused for too long, as they will still occupy one of Gosu's
+        /// limited channels.
         void pause();
         void resume();
-        //! Stops this channel if the sample is still being played.
-        //! If this method is called when playback has finished, it has no effect.
+        /// Stops this m_channel if the sample is still being played.
+        /// If this method is called when playback has finished, it has no effect.
         void stop();
 
-        //! \param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
+        /// @param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
         void set_volume(double volume);
-        //! \param pan Can be anything from -1.0 (left) to 1.0 (right).
+        /// @param pan Can be anything from -1.0 (left) to 1.0 (right).
         void set_pan(double pan);
-        //! \param speed Use 1.0 for normal playback speed.
+        /// @param speed Use 1.0 for normal playback speed.
         void set_speed(double speed);
     };
-    
-    //! A sample is a short sound that is completely loaded in memory, can be
-    //! played multiple times at once and offers very flexible playback
-    //! parameters. Use samples for everything that's not music.
+
+    /// A sample is a short sound that is completely loaded in memory, can be played multiple times
+    /// at once, and offers very flexible playback parameters.
     class Sample
     {
         struct Impl;
-        std::shared_ptr<Impl> pimpl;
+        std::shared_ptr<Impl> m_impl;
 
     public:
-        //! Constructs an empty sample that is inaudible when played.
+        /// Constructs an empty sample that is inaudible when played.
         Sample();
-        
-        //! Constructs a sample that can be played on the specified audio
-        //! system and loads the sample from a file.
+
+        /// Constructs a sample that can be played on the specified audio
+        /// system and loads the sample from a file.
         explicit Sample(const std::string& filename);
-        
-        //! Constructs a sample that can be played on the specified audio
-        //! system and loads the sample data from a stream.
+
+        /// Constructs a sample that can be played on the specified audio
+        /// system and loads the sample data from a stream.
         explicit Sample(Reader reader);
-        
-        //! Plays the sample without panning.
-        //! \param volume Can be anything from 0.0 (silence) to 1.0 (full
-        //! volume).
-        //! \param speed Playback speed is only limited by the underlying audio library,
-        //! and can accept very high or low values. Use 1.0 for
-        //! normal playback speed.
-        Channel play(double volume = 1, double speed = 1, bool looping = false) const;
-
-        //! Plays the sample with panning. Even if pan is 0.0, the sample will
-        //! not be as loud as if it were played by calling play() due to the
-        //! way the panning works.
-        //! \param pan Can be anything from -1.0 (left) to 1.0 (right).
-        //! \param volume Can be anything from 0.0 (silence) to 1.0 (full
-        //! volume).
-        //! \param speed Playback speed is only limited by by the underlying audio library,
-        //! and can accept very high
-        //! or low values. Use 1.0 for normal playback speed.
-        Channel play_pan(double pan, double volume = 1, double speed = 1,
-            bool looping = false) const;
+
+        /// Plays the sample without panning.
+        /// @param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
+        /// @param speed Playback speed is only limited by the underlying audio library,
+        ///              and can accept very high or low values. Use 1.0 for normal playback speed.
+        Channel play(double volume = 1.0, double speed = 1.0, bool looping = false) const;
+
+        /// Plays the sample with panning. Even if pan is 0.0, the sample will
+        /// not be as loud as if it were played by calling play() due to the
+        /// way the panning works.
+        /// @param pan Can be anything from -1.0 (left) to 1.0 (right).
+        /// @param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
+        /// @param speed Playback speed is only limited by by the underlying audio library,
+        ///              and can accept very high or low values. Use 1.0 for normal playback speed.
+        Channel play_pan(double pan, double volume = 1.0, double speed = 1.0,
+                         bool looping = false) const;
     };
 
-    //! Songs are less flexible than samples. Only one Song can be played at any given time,
-    //! and there is no way to control its pan (stereo position) or speed.
-    class Song
+    /// Songs are less flexible than Samples. Only one Song can be played at any given time,
+    /// and there is no way to control its pan (stereo position) or speed.
+    class Song : private Noncopyable
     {
         struct Impl;
-        std::unique_ptr<Impl> pimpl;
-        
-        // Non-movable to avoid dangling internal references.
-        Song(Song&&) = delete;
-        // Non-movable to avoid dangling internal references.
-        Song& operator=(Song&&) = delete;
+        std::unique_ptr<Impl> m_impl;
 
     public:
-        //! Constructs a song that can be played on the provided audio system
-        //! and loads the song from a file.
-        //! The file type is determined by the filename.
+        /// Constructs a song that can be played on the provided audio system and loads the song
+        /// from a file. The file type is determined by the filename.
         explicit Song(const std::string& filename);
-        
-        //! Constructs a song of the specified type that can be played on the
-        //! provided audio system and loads the song data from a stream.
+
+        /// Constructs a song of the specified type that can be played on the
+        /// provided audio system and loads the song data from a stream.
         explicit Song(Reader reader);
-        
+
         ~Song();
-        
-        //! Returns the song currently being played or paused, or 0 if
-        //! no song has been played yet or the last song has finished
-        //! playing.
+
+        /// Returns the song currently being played or paused, or 0 if 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.
+        /// 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);
-        //! Pauses playback of the song. It is not considered being played.
-        //! current_song will stay the same.
+        /// Pauses playback of the song. Song::current_song() will still refer to this song, but
+        /// playing() will return false.
         void pause();
-        //! Returns true if the song is the current song, but in paused
-        //! mode.
+        /// Returns true if the song is the current song, but in paused mode.
         bool paused() const;
-        //! Stops playback of this song if it is currently played or paused.
-        //! Afterwards, current_song will return nullptr.
+        /// Stops playback of this song if it is currently played or paused.
+        /// Afterwards, current_song will return nullptr.
         void stop();
-        //! Returns true if the song is currently playing.
+        /// Returns true if the song is currently playing.
         bool playing() const;
-        //! Returns the current volume of the song.
+        /// Returns the current volume of the song.
         double volume() const;
-        //! \param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
+        /// @param volume Can be anything from 0.0 (silence) to 1.0 (full volume).
         void set_volume(double volume);
-        
-        //! Called every tick by Window to feed new audio data to OpenAL.
+
+        /// Called every tick by Window to feed new audio data to OpenAL.
         static void update();
     };
 }

data/include/Gosu/Color.hpp

@@ -16,20 +16,28 @@ namespace Gosu
         Channel red, green, blue, alpha;
 
         constexpr Color()
-        : red{0}, green{0}, blue{0}, alpha{0}
+        : red{0},
+          green{0},
+          blue{0},
+          alpha{0}
         {
         }
 
         /// Conversion constructor for literals of the form 0xaarrggbb.
         // NOLINTNEXTLINE: We want to allow implicit conversions.
         constexpr Color(std::uint32_t argb)
-        : red{static_cast<Channel>(argb >> 16)}, green{static_cast<Channel>(argb >> 8)},
-          blue{static_cast<Channel>(argb >> 0)}, alpha{static_cast<Channel>(argb >> 24)}
+        : red{static_cast<Channel>(argb >> 16)},
+          green{static_cast<Channel>(argb >> 8)},
+          blue{static_cast<Channel>(argb >> 0)},
+          alpha{static_cast<Channel>(argb >> 24)}
         {
         }
 
         constexpr Color(Channel red, Channel green, Channel blue)
-        : red{red}, green{green}, blue{blue}, alpha{255}
+        : red{red},
+          green{green},
+          blue{blue},
+          alpha{255}
         {
         }
 
@@ -46,19 +54,19 @@ namespace Gosu
 
         /// Returns the hue of the color, in the usual range of 0..360.
         double hue() const;
-        
+
         /// Changes the current color so hue() will return h.
         void set_hue(double h);
-        
+
         /// Returns the saturation of the color, in the range of 0..1.
         double saturation() const;
-        
+
         /// Changes the current color so saturation() will return s.
         void set_saturation(double s);
-        
+
         /// Returns the value (brightness) of the color, in the range of 0..1.
         double value() const;
-        
+
         /// Changes the current color so value() will return v.
         void set_value(double v);
 
@@ -92,7 +100,7 @@ namespace Gosu
 
     // Ensure that we can pass vectors of Gosu::Color straight to OpenGL and back.
     static_assert(sizeof(Color) == sizeof(std::uint32_t));
-    
+
 #ifndef SWIG
     inline bool operator<(Color a, Color b) { return a.gl() < b.gl(); }
     inline bool operator==(Color a, Color b) { return a.gl() == b.gl(); }
@@ -101,7 +109,7 @@ namespace Gosu
     /// Interpolates linearly between two colors, with a given weight towards
     /// the second color.
     Color lerp(Color a, Color b, double t = 0.5);
-    
+
     /// Combines two colors as if their channels were mapped to the 0..1 range
     /// and then multiplied with each other.
     Color multiply(Color a, Color b);

data/include/Gosu/Font.hpp

@@ -1,6 +1,3 @@
-//! \file Font.hpp
-//! Interface of the Font class.
-
 #pragma once
 
 #include <Gosu/Fwd.hpp>
@@ -13,66 +10,65 @@
 
 namespace Gosu
 {
-    //! Fonts are ideal for drawing short, dynamic strings.
-    //! For large, static texts you should use Gosu::layout_text and turn the result into an image.
+    /// A simple bitmap font that renders and caches glyphs on demand.
+    /// For large, static texts you should use Gosu::layout_text and turn the result into an image.
     class Font
     {
         struct Impl;
-        std::shared_ptr<Impl> pimpl;
+        std::shared_ptr<Impl> m_impl;
 
     public:
-        //! Constructs a font that can be drawn onto the graphics object.
-        //! \param name   Name of a system font, or a filename to a TTF file.
-        //! \param height Height of the font, in pixels.
-        //! \param flags  Flags used to render individual characters of the font.
-        Font(int height, const std::string& name = default_font_name(), unsigned flags = 0);
-        
-        //! Returns the name of the font that was used to create it.
+        /// @param name   Name of a system font, or path to a TTF file (must contain '/').
+        /// @param height Height of the font, in pixels.
+        /// @param flags  Flags used to render individual characters of the font (FontFlags enum).
+        explicit Font(int height, const std::string& name = default_font_name(),
+                      unsigned flags = 0);
+
+        /// Returns the name of the font that was used to create it, i.e. the filename, nor the
+        /// internal TTF name. (TODO: Why not?)
         const std::string& name() const;
-        
-        //! Returns the height of the font, in pixels.
+
+        /// Returns the height of the font, in pixels.
         int height() const;
-        
-        //! Returns the flags used to create the font characters.
+
+        /// Returns the flags used to render the characters of the font (FontFlags enum).
         unsigned flags() const;
-        
-        //! Returns the width, in pixels, the given text would occupy if drawn.
+
+        /// Returns the width, in pixels, that the given text would occupy if drawn.
         double text_width(const std::string& text) const;
-        //! Returns the width, in pixels, the given markup would occupy if drawn.
+        /// Returns the width, in pixels, that the given markup would occupy if drawn.
         double markup_width(const std::string& markup) const;
-        
-        //! Draws text so the top left corner of the text is at (x; y).
-        void draw_text(const std::string& text, double x, double y, ZPos z,
+
+        /// Draws text so the top left corner of the text is at (x; y).
+        void draw_text(const std::string& text, double x, double y, ZPos z, //
                        double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
                        BlendMode mode = BM_DEFAULT) const;
-        //! Draws markup so the top left corner of the text is at (x; y).
-        void draw_markup(const std::string& markup, double x, double y, ZPos z,
+        /// Draws markup so the top left corner of the text is at (x; y).
+        void draw_markup(const std::string& markup, double x, double y, ZPos z, //
                          double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
                          BlendMode mode = BM_DEFAULT) const;
-        
-        //! Draws text at a position relative to (x; y).
-        //! \param rel_x Determines where the text is drawn horizontally. If
-        //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
-        //! the text will be to the left of x, if it is 0.5, it will be
-        //! centered on x. All real numbers are possible values.
-        //! \param rel_y See rel_x.
-        void draw_text_rel(const std::string& text, double x, double y, ZPos z,
+
+        /// Draws text at a position relative to (x; y).
+        /// @param rel_x Determines where the text is drawn horizontally. If rel_x is 0.0, the text
+        /// will be to the right of x, if it is 1.0, the text will be to the left of x, if it is
+        /// 0.5, it will be centered on x.
+        /// @param rel_y See rel_x.
+        void draw_text_rel(const std::string& text, double x, double y, ZPos z, //
                            double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
                            Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        //! Draws text at a position relative to (x; y).
-        //! \param rel_x Determines where the text is drawn horizontally. If
-        //! rel_x is 0.0, the text will be to the right of x, if it is 1.0,
-        //! the text will be to the left of x, if it is 0.5, it will be
-        //! centered on x. All real numbers are possible values.
-        //! \param rel_y See rel_x.
-        void draw_markup_rel(const std::string& markup, double x, double y, ZPos z,
+        /// Draws markup at a position relative to (x; y).
+        /// @param rel_x Determines where the text is drawn horizontally. If rel_x is 0.0, the text
+        /// will be to the right of x, if it is 1.0, the text will be to the left of x, if it is
+        /// 0.5, it will be centered on x.
+        /// @param rel_y See rel_x.
+        void draw_markup_rel(const std::string& markup, double x, double y, ZPos z, //
                              double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
                              Color c = Color::WHITE, BlendMode mode = BM_DEFAULT) const;
-        
-        //! Maps a letter to a specific image, instead of generating one using
-        //! Gosu's built-in text rendering.
+
+        /// Maps a letter to a specific image, instead of generating one using Gosu's built-in text
+        /// rendering.
         void set_image(std::string codepoint, unsigned font_flags, const Gosu::Image& image);
-        //! A shortcut for mapping a character to an image regardless of font_flags.
+        /// A shortcut for mapping a character to an image regardless of font_flags.
         void set_image(std::string codepoint, const Gosu::Image& image);
     };
 }