gosu 0.13.3 → 0.14.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11cad0cf3c250ded2f28767de4b16a3813fe9344ab7ae4fced8fc175c84f1a45
-  data.tar.gz: 1ed49eebd7f989d77af063d9ba72a39623f61ce2ef0ad650c670cbe41ebe2c77
+  metadata.gz: fae36fbf2c222327884fa9b34c5c2dc0a085a8fe7389dcc3c58d6d865b44a8f5
+  data.tar.gz: 843de673ab12f0d0ab72f29d560e29dd1262ecb8e4c1929118fc9dd770db5b77
 SHA512:
-  metadata.gz: 70dc3a30a7bda5cb80f3ec61f51869ee764e18a96f0403ce592b10b8c66124b7d190ca5585c8fa8ad530adafe723d901775c0e45995d18b5f91f431b213fc43a
-  data.tar.gz: 04c99a303c628114457eba9b4f3f770a3ca9278862b86ea15bd3f0fa30dad3cd3155f054ee98e95d2c844efd2869b0ef29bda63553061ca167caa10631723947
+  metadata.gz: 7a0f3a6bc482c1e30dbf2e04a4097ddde5fe630a8583875c9344463808d306b8f0c41131b70229bfc0f343e948d15714e65707bef077c18b434c434f9bd6a3e3
+  data.tar.gz: 2a1ec2451e8653b6dd7682faf8c4e7cf4b354a778234c0db51c4f0f17ad547a7a6356019c25d8458f1975d685c81f8e219cd384c2e81ed285f8053b5e2a61077

data/Gosu/Audio.hpp

@@ -11,26 +11,31 @@
 
 namespace Gosu
 {
-    //! Sample::play returns a Channel that represents the sound currently being played.
-    //! This object can be used to stop sounds dynamically, or to check whether they have finished.
+    //! 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.
     class Channel
     {
         mutable int channel, token;
 
     public:
+        //! This creates an "empty" Channel which is expired and cannot be resumed.
+        Channel();
         //! For internal use only.
         Channel(int channel, int token);
         
+        //! For internal use only.
         int current_channel() const;
         
         bool playing() const;
         bool paused() const;
         //! Pauses this instance to be resumed afterwards.
-        //! It will still occupy an audio channel while paused.
+        //! Avoid leaving samples paused for too long, as they will still occupy one of Gosu's
+        //! limited channels.
         void pause();
         void resume();
-        //! Stops this instance of a sound being played.
-        //! Calling this twice, or too late, does not do any harm.
+        //! Stops this 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).
@@ -50,7 +55,7 @@ namespace Gosu
         std::shared_ptr<SampleData> data;
 
     public:
-        //! Constructs an empty sample that acts as if the song had a length of 0.
+        //! Constructs an empty sample that is inaudible when played.
         Sample();
         
         //! Constructs a sample that can be played on the specified audio
@@ -82,7 +87,7 @@ namespace Gosu
             bool looping = false) const;
     };
 
-    //! Songs are less flexible than samples. Only Song can be played at any given time,
+    //! 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
     {
@@ -98,8 +103,8 @@ namespace Gosu
 
     public:
         //! Constructs a song that can be played on the provided audio system
-        //! and loads the song from a file. The type is determined from the
-        //! filename.
+        //! 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
@@ -129,8 +134,7 @@ namespace Gosu
         bool playing() const;
         //! 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 for management purposes.

data/Gosu/Font.hpp

@@ -29,14 +29,13 @@ namespace Gosu
         //! \param font_height Height of the font, in pixels.
         //! \param font_flags Flags used to render individual characters of
         //!        the font.
-        Font(unsigned font_height, const std::string& font_name = default_font_name(),
-            unsigned font_flags = FF_BOLD);
+        Font(int height, const std::string& name = default_font_name(), unsigned flags = FF_BOLD);
         
         //! Returns the name of the font that was used to create it.
-        std::string name() const;
+        const std::string& name() const;
         
         //! Returns the height of the font, in pixels.
-        unsigned height() const;
+        int height() const;
         
         //! Returns the flags used to create the font characters.
         unsigned flags() const;
@@ -47,8 +46,8 @@ namespace Gosu
         //! Draws text so the top left corner of the text is at (x; y).
         //! \param text Formatted text without line-breaks.
         void draw(const std::string& text, double x, double y, ZPos z,
-            double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
-            AlphaMode mode = AM_DEFAULT) const;
+                  double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
+                  AlphaMode mode = AM_DEFAULT) const;
         
         //! Draws text at a position relative to (x; y).
         //! \param rel_x Determines where the text is drawn horizontally. If
@@ -57,25 +56,30 @@ namespace Gosu
         //! centered on x. Of course, all real numbers are possible values.
         //! \param rel_y See rel_x.
         void draw_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, AlphaMode mode = AM_DEFAULT) const;
-        
+                      double rel_x, double rel_y, double scale_x = 1, double scale_y = 1,
+                      Color c = Color::WHITE, AlphaMode mode = AM_DEFAULT) const;
+
+        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle.
+        //! Use Graphics::push_transform to achieve the same effect.
+    #ifndef SWIG
+        GOSU_DEPRECATED
+    #endif
+        void draw_rot(const std::string& text, double x, double y, ZPos z, double angle,
+                      double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
+                      AlphaMode mode = AM_DEFAULT) const;
+
         //! Maps a letter to a specific image instead of generating one using
         //! Gosu's built-in text rendering. This can only be called once per
         //! character, and the character must not have been drawn before.
         //! This ensures that Fonts are still (sort of) immutable.
-        void set_image(wchar_t wc, unsigned font_flags, const Gosu::Image& image);
+    #ifndef SWIG
+        GOSU_DEPRECATED
+    #endif
+        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.
-        //! Later versions might apply faux italics or faux bold to it (to be decided!).
-        void set_image(wchar_t wc, const Gosu::Image& image);
-        
-        #ifndef SWIG
+    #ifndef SWIG
         GOSU_DEPRECATED
-        #endif
-        //! DEPRECATED: Analogous to draw, but rotates the text by a given angle.
-        //! Use Graphics::push_transform to achieve the same effect.
-        void draw_rot(const std::string& text, double x, double y, ZPos z, double angle,
-            double scale_x = 1, double scale_y = 1, Color c = Color::WHITE,
-            AlphaMode mode = AM_DEFAULT) const;
+    #endif
+        void set_image(std::string codepoint, const Gosu::Image& image);
     };
 }

data/Gosu/Fwd.hpp

@@ -9,6 +9,7 @@ namespace Gosu
     class Bitmap;
     class Buffer;
     class Button;
+    class Channel;
     class Color;
     class File;
     class Font;
@@ -21,7 +22,6 @@ namespace Gosu
     class Sample;
     class Song;
     class TextInput;
-    class Timer;
     class Window;
     class Writer;
 }

data/Gosu/Graphics.hpp

@@ -24,9 +24,8 @@ namespace Gosu
     class Graphics
     {
         struct Impl;
-        // Non-movable (const) to avoid dangling internal references.
-        const std::unique_ptr<Impl> pimpl;
-        
+        std::unique_ptr<Impl> pimpl;
+
     public:
         Graphics(unsigned physical_width, unsigned physical_height);
         ~Graphics();
@@ -60,11 +59,11 @@ namespace Gosu
         static void clip_to(double x, double y, double width, double height,
                             const std::function<void ()>& f);
         
-        //! Records a macro and returns it as an ImageData instance.
-        //! Usually, the return value is passed to Image::Image().
-        //! Cannot be nested.
-        static std::unique_ptr<Gosu::ImageData> record(int width, int height,
-                                                       const std::function<void ()>& f);
+        //! Renders everything drawn in f onto a new Image of size (width, height).
+        static Gosu::Image render(int width, int height, const std::function<void ()>& f);
+        
+        //! Records a macro and returns it as an Image.
+        static Gosu::Image record(int width, int height, const std::function<void ()>& f);
         
         //! Pushes one transformation onto the transformation stack.
         static void transform(const Transform& transform,
@@ -100,7 +99,7 @@ namespace Gosu
 
         //! Turns a portion of a bitmap into something that can be drawn on a Graphics object.
         static std::unique_ptr<ImageData> create_image(const Bitmap& src,
-                                                       unsigned src_x, unsigned src_y,
+                                                       unsigned src_x,     unsigned src_y,
                                                        unsigned src_width, unsigned src_height,
                                                        unsigned image_flags);
     };

data/Gosu/ImageData.hpp

@@ -17,7 +17,7 @@ namespace Gosu
     struct GLTexInfo
     {
         int tex_name;
-        float left, right, top, bottom;
+        double left, right, top, bottom;
     };
 
     //! The ImageData class is an abstract base class for drawable images.

data/Gosu/Input.hpp

@@ -59,7 +59,7 @@ namespace Gosu
     public:
     #ifdef GOSU_IS_IPHONE
         Input(void* view, float update_interval);
-        void feed_touch_event(int type, void* touches);
+        void feed_touch_event(std::function<void (Touch)>& callback, void* touches);
     #else
         Input(void* window);
         bool feed_sdl_event(void* event);

data/Gosu/Math.hpp

@@ -12,24 +12,6 @@
 
 namespace Gosu
 {
-    //! Truncates the fractional part of a real value. Equivalent to
-    //! static_cast<long>.
-    inline long trunc(double value)
-    {
-        return static_cast<long>(value);
-    }
-    
-    //! Rounds a real value towards the next integer.
-    inline long round(double value)
-    {
-        if (value >= 0) {
-            return static_cast<long>(value + 0.5);
-        }
-        else {
-            return static_cast<long>(value - 0.5);
-        }
-    }
-    
     //! Returns a real value between min (inclusive) and max (exclusive).
     //! Uses std::rand, so you should call std::srand before using it.
     double random(double min, double max);

data/Gosu/Text.hpp

@@ -10,53 +10,45 @@
 
 namespace Gosu
 {
-    //! Returns the name of a neutral font that is available on the current
-    //! platform.
+    //! Returns the name of a neutral font that is available on the current platform.
     std::string default_font_name();
 
     //! Returns the width an unformatted line of text would span on a bitmap if it were drawn using
-    //! draw_text with the same arguments. This is a very low-level function that does not
-    //! understand any of Gosu's HTML-like markup.
-    //! \param text Unformatted text.
-    //! \param font_name Name of a system font, or a filename to a TTF file (must contain '/').
-    unsigned text_width(const std::string& text, const std::string& font_name, unsigned font_height,
-        unsigned font_flags = 0);
+    //! draw_text with the same arguments.
+    //! \param text A UCS-4 string, normalization: NFC.
+    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
+    double text_width(const std::u32string& text, const std::string& font_name, double font_height,
+                      unsigned font_flags = 0);
 
     //! Draws a line of unformatted text on a bitmap. This is a very low-level function that does
     //! not understand any of Gosu's HTML-like markup.
-    //! \param text Unformatted text.
-    //! \param font_name Name of a system font, or a filename to a TTF file (must contain '/').
+    //! \param text A UCS-4 string, normalization: NFC.
+    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
     //! \param font_height Height, in pixels, of the text.
-    //! \param font_flags Binary combination of members of the FontFlags
-    //! enum.
-    void draw_text(Bitmap& bitmap, const std::string& text, int x, int y, Color c,
-        const std::string& font_name, unsigned font_height, unsigned font_flags = 0);
+    //! \param font_flags Binary combination of members of the FontFlags enum.
+    double draw_text(Bitmap& bitmap, double x, double y, Color c, const std::u32string& text,
+                     const std::string& font_name, double font_height, unsigned font_flags = 0);
 
     //! Creates a bitmap that is filled with a line of formatted text given to the function.
     //! The line can contain line breaks and HTML-like markup.
     //! \param text Formatted text.
-    //! \param font_name Name of a system font, or a filename to a TTF file (must contain '/').
+    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
     //! \param font_height Height of the font in pixels.
-    //! \param font_flags Binary combination of members of the FontFlags
-    //! enum.
-    Bitmap create_text(const std::string& text, const std::string& font_name, unsigned font_height,
-        unsigned font_flags = 0);
+    //! \param font_flags Binary combination of members of the FontFlags enum.
+    Bitmap create_text(const std::string& text, const std::string& font_name, double font_height,
+                       unsigned font_flags = 0);
 
     //! Creates a bitmap that is filled with the formatted text given to the function.
     //! The line can contain line breaks and HTML-like markup.
     //! \param text Formatted text.
-    //! \param font_name Name of a system font, or a filename to a TTF file (must contain '/').
+    //! \param font_name Name of a system font, or filename of a TTF file (must contain '/' or '.').
     //! \param font_height Height of the font in pixels.
     //! \param line_spacing Spacing between two lines of text in pixels. Can be negative to make
-    //! text stick together more closely.
-    //! \param width Width of the bitmap that will be returned. Text will be split into multiple
-    //! lines to avoid drawing over the right border. When a single word is too long, it will be
-    //! truncated.
+    //!        text stick together more closely.
+    //! \param width Width of the bitmap that will be returned.
+    //!        Text will be split into multiple lines to avoid drawing over the right border.
+    //!        When a single word is too long, it will be truncated.
     //! \param font_flags Binary combination of members of the FontFlags enum.
-    Bitmap create_text(const std::string& text, const std::string& font_name, unsigned font_height,
-        int line_spacing, unsigned width, Alignment align, unsigned font_flags = 0);
-    
-    //! Registers a new HTML-style entity that can subsequently be used
-    //! with Gosu::Font and Gosu::create_text. The name is given without & and ;.
-    void register_entity(const std::string& name, const Bitmap& replacement);
+    Bitmap create_text(const std::string& text, const std::string& font_name, double font_height,
+                       double line_spacing, int width, Alignment align, unsigned font_flags = 0);
 }

data/Gosu/TextInput.hpp

@@ -49,8 +49,10 @@ namespace Gosu
         //! Sets the start of the selection as returned by selection_start.
         void set_selection_start(unsigned pos);
         
+#ifndef GOSU_IS_IPHONE
         // Platform-specific communication with Gosu::Input.
         bool feed_sdl_event(void* event);
+#endif
 
         //! Overridable filter that is applied to all new text that is entered.
         //! Allows for context-sensitive filtering/extending/... of new characters.
@@ -59,5 +61,16 @@ namespace Gosu
         {
             return text;
         }
+        
+        //! Replaces the current selection (if any) and inserts the given string at the current
+        //! caret position.
+        //! The filter method will not be applied before appending the string.
+        void insert_text(std::string text);
+        
+        //! Deletes the current selection, if any, or the next character.
+        void delete_forward();
+        
+        //! Deletes the current selection, if any, or the previous character.
+        void delete_backward();
     };
 }

data/Gosu/Utility.hpp

@@ -12,6 +12,8 @@ namespace Gosu
     //! Converts an UCS-4 or UTF-16 to UTF-8, depending on the platform's interpretation of wstring.
     std::string wstring_to_utf8(const std::wstring& ws);
     
+    std::u32string utf8_to_composed_utc4(const std::string& utf8);
+    
     //! Returns true if the filename has the given extension.
     //! The comparison is case-insensitive, but you must pass the extension in lower case.
     bool has_extension(const std::string& filename, const char* extension);

data/Gosu/Window.hpp

@@ -118,10 +118,10 @@ namespace Gosu
         virtual void button_up(Gosu::Button) {}
 
         //! Called when a file is dropped onto the window.
-        //! \param path The filename of the dropped file. When multiple files are dropped, this
+        //! \param filename The filename of the dropped file. When multiple files are dropped, this
         //! method will be called several times.
         virtual void drop(const std::string& filename) {}
-        
+
         // Ignore when SWIG is wrapping this class for Ruby/Gosu.
         #ifndef SWIG
         // Callbacks for touch events. So far these are only used on iOS.
@@ -138,7 +138,7 @@ namespace Gosu
         #endif
         
         #ifdef GOSU_IS_IPHONE
-        void* UIWindow() const;
+        void* uikit_window() const;
         #endif
     };
 }

data/README.md

@@ -18,10 +18,9 @@ or look at existing projects in the [Gosu Showcase](https://www.libgosu.org/cgi-
 Community
 ---------
 
-- 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.
-- Please file bugs and request features [on GitHub](https://github.com/gosu/gosu/issues).
+- There is a lively [Discord community](https://discord.gg/SZ4nbEd).
+- If you want to discuss or announce something in a more permanent place than a chat room, we also have a [message board](https://www.libgosu.org/cgi-bin/mwf/forum.pl).
+- Please file bugs and feature requests [on GitHub](https://github.com/gosu/gosu/issues).
 
 Build Status
 ------------

data/ext/gosu/extconf.rb

@@ -24,16 +24,18 @@ $CFLAGS << " -DGOSU_DEPRECATED="
 
 $CXXFLAGS ||= ""
 $CXXFLAGS << " -std=gnu++11"
-$CXXFLAGS << " -Wno-reserved-user-defined-literal" # see https://github.com/gosu/gosu/issues/424
 
 # For #include <Gosu/...>
 $INCFLAGS << " -I../.."
 
 if `uname`.chomp == 'Darwin'
-  # To make everything work with the Objective C runtime
-  $CFLAGS   << " -x objective-c -fobjc-arc -DNDEBUG"
+  # Disable assertions in C code.
+  $CFLAGS   << " -DNDEBUG"
   # 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,7 +45,7 @@ if `uname`.chomp == 'Darwin'
   # Dependencies.
   $CXXFLAGS << " #{`sdl2-config --cflags`.chomp}"
   # Prefer statically linking SDL 2.
-  $LDFLAGS  << " #{`sdl2-config --static-libs`.chomp} -framework OpenGL -framework OpenAL"
+  $LDFLAGS  << " #{`sdl2-config --static-libs`.chomp} -framework OpenGL -framework Metal -framework OpenAL"
   
   # Disable building of 32-bit slices in Apple's Ruby.
   # (RbConfig::CONFIG['CXXFLAGS'] on 10.11: -arch x86_64 -arch i386 -g -Os -pipe)
@@ -65,19 +67,15 @@ else
   end
 
   pkg_config 'sdl2'
-  pkg_config 'pangoft2'
   pkg_config 'vorbisfile'
   pkg_config 'openal'
   pkg_config 'sndfile'
   pkg_config 'libmpg123'
+  pkg_config 'fontconfig'
   
-  have_header 'SDL_ttf.h' if have_library('SDL2_ttf', 'TTF_RenderUTF8_Blended')
   have_header 'AL/al.h'   if have_library('openal')
 end
 
-# This is necessary to build with stock Ruby on OS X 10.7.
-CONFIG['CXXFLAGS'] ||= $CXXFLAGS
-
 # 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 }