ruby2d 0.10.0 → 0.11.2

data/lib/ruby2d/cli/build.rb

@@ -1,58 +1,45 @@
-# Build a Ruby 2D app natively and for the web
+# Build a compiled Ruby 2D app with mruby
 
+require 'ruby2d'
 require 'fileutils'
+require 'ruby2d/cli/colorize'
+require 'ruby2d/cli/platform'
 
-# The installed gem directory
-@gem_dir = "#{Gem::Specification.find_by_name('ruby2d').gem_dir}"
 
 # The Ruby 2D library files
-@lib_files = [
+@ruby2d_lib_files = [
   'cli/colorize',
   'exceptions',
   'renderable',
   'color',
   'window',
   'dsl',
+  'entity',
   'quad',
   'line',
   'circle',
   'rectangle',
   'square',
   'triangle',
+  'pixel',
   'image',
   'sprite',
+  'tileset',
   'font',
   'text',
   'sound',
   'music',
+  'texture',
+  'vertices',
   '../ruby2d'
 ]
 
 
-# Check if source file provided is good
-def check_build_src_file(rb_file)
-  if !rb_file
-    puts "Please provide a Ruby file to build"
-    exit
-  elsif !File.exist? rb_file
-    puts "Can't find file: #{rb_file}"
-    exit
-  end
-end
-
-
-# Assemble the Ruby 2D library in one `.rb` file
-def make_lib
-  FileUtils.mkdir_p 'build'
-
-  lib_dir = "#{@gem_dir}/lib/ruby2d/"
-
-  lib = ''
-  @lib_files.each do |f|
-    lib << File.read("#{lib_dir + f}.rb") + "\n\n"
-  end
+# Helpers ######################################################################
 
-  File.write('build/lib.rb', lib)
+def run_cmd(cmd)
+  puts "#{'$'.info} #{cmd.bold}\n" if @debug
+  system cmd
 end
 
 
@@ -66,57 +53,251 @@ def strip_require(file)
 end
 
 
-# Build a native version of the provided Ruby application
-def build_native(rb_file)
-  check_build_src_file(rb_file)
+# Add linker flags
+def add_ld_flags(ld_flags, name, type, dir = nil)
+  case type
+  when :archive
+    ld_flags << "#{dir}/lib#{name}.a "
+  when :framework
+    ld_flags << "-Wl,-framework,#{name} "
+  end
+end
 
-  # Check if MRuby exists; if not, quit
-  if `which mruby`.empty?
-    puts "#{'Error:'.error} Can't find MRuby, which is needed to build native Ruby 2D applications.\n"
+
+# Build Tasks ##################################################################
+
+# Build the user's application
+def build(target, ruby2d_app)
+
+  # Check if source file provided is good
+  if !ruby2d_app
+    puts "Please provide a Ruby file to build"
+    exit
+  elsif !File.exist? ruby2d_app
+    puts "Can't find file: #{ruby2d_app}"
     exit
   end
 
   # Add debugging information to produce backtrace
   if @debug then debug_flag = '-g' end
 
-  # Assemble the Ruby 2D library in one `.rb` file and compile to bytecode
-  make_lib
-  `mrbc #{debug_flag} -Bruby2d_lib -obuild/lib.c build/lib.rb`
+  # Create build directory
+  FileUtils.mkdir_p 'build'
 
-  # Read the provided Ruby source file, copy to build dir and compile to bytecode
-  File.open('build/src.rb', 'w') { |file| file << strip_require(rb_file) }
-  `mrbc #{debug_flag} -Bruby2d_app -obuild/src.c build/src.rb`
+  # Assemble Ruby 2D library files into one '.rb' file
+
+  ruby2d_lib_dir = "#{Ruby2D.gem_dir}/lib/ruby2d/"
+
+  ruby2d_lib = ''
+  @ruby2d_lib_files.each do |f|
+    ruby2d_lib << File.read("#{ruby2d_lib_dir + f}.rb") + "\n\n"
+  end
+
+  File.write('build/ruby2d_lib.rb', ruby2d_lib)
+
+  # Assemble the Ruby 2D C extension files into one '.c' file
+
+  ruby2d_ext_dir = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+
+  ruby2d_ext = "#define MRUBY 1" << "\n\n"
+  Dir["#{ruby2d_ext_dir}*.c"].each do |c_file|
+    ruby2d_ext << File.read(c_file)
+  end
+
+  File.write('build/ruby2d_ext.c', ruby2d_ext)
+
+  # Select `mrbc` executable based on platform
+  case $RUBY2D_PLATFORM
+  when :macos
+    mrbc = "#{Ruby2D.assets}/macos/universal/bin/mrbc"
+  when :windows
+    mrbc = "#{Ruby2D.assets}/windows/mingw-w64-x86_64/bin/mrbc.exe"
+  else
+    mrbc = 'mrbc'
+  end
+
+  # Compile the Ruby 2D lib (`.rb` files) to mruby bytecode
+  run_cmd "#{mrbc} #{debug_flag} -Bruby2d_lib -obuild/ruby2d_lib.c build/ruby2d_lib.rb"
+
+  # Read the user's provided Ruby source file, copy to build dir and compile to bytecode
+  File.open('build/ruby2d_app.rb', 'w') { |f| f << strip_require(ruby2d_app) }
+  run_cmd "#{mrbc} #{debug_flag} -Bruby2d_app -obuild/ruby2d_app.c build/ruby2d_app.rb"
 
   # Combine contents of C source files and bytecode into one file
   open('build/app.c', 'w') do |f|
-    f << "#define MRUBY 1" << "\n\n"
-    f << File.read("build/lib.c") << "\n\n"
-    f << File.read("build/src.c") << "\n\n"
-    f << File.read("#{@gem_dir}/ext/ruby2d/ruby2d.c")
+    ['ruby2d_app', 'ruby2d_lib', 'ruby2d_ext'].each do |c_file|
+      f << File.read("build/#{c_file}.c") << "\n\n"
+    end
   end
 
-  # Compile to a native executable
-  `cc build/app.c -lmruby -o build/app`
+  # Compile the final application based on the target platform
+  case target
+  when :native
+    compile_native
+  when :web
+    compile_web
+  end
 
-  # Clean up
+  # Remove files used in the build process
   clean_up unless @debug
 
-  # Success!
-  puts "Native app created at `build/app`"
 end
 
 
-# Build a web-based version of the provided Ruby application
-def build_web(rb_file)
-  puts "Warning: ".warn + "This feature is currently disabled while it's being upgraded."
+# Create a native executable using the available C compiler
+def compile_native
+
+  # Get include directories
+  incl_dir_ruby2d = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+  incl_dir_deps = "#{Ruby2D.assets}/include/"
+
+  # Add compiler flags for each platform
+  case $RUBY2D_PLATFORM
+
+  when :macos
+    ld_dir = "#{Ruby2D.assets}/macos/universal/lib"
+
+    c_flags = '-arch arm64 -arch x86_64'
+
+    ld_flags = ''
+    ['mruby', 'SDL2', 'SDL2_image', 'SDL2_mixer', 'SDL2_ttf',
+     'jpeg', 'png16', 'tiff', 'webp',
+     'mpg123', 'ogg', 'FLAC', 'vorbis', 'vorbisfile', 'modplug',
+     'freetype', 'harfbuzz', 'graphite2'].each do |name|
+      add_ld_flags(ld_flags, name, :archive, ld_dir)
+    end
+
+    ld_flags << "-lz -lbz2 -liconv -lstdc++ "
+    ['Cocoa', 'Carbon', 'CoreVideo', 'OpenGL', 'Metal', 'CoreAudio', 'AudioToolbox',
+     'IOKit', 'GameController', 'ForceFeedback', 'CoreHaptics'].each do |name|
+      add_ld_flags(ld_flags, name, :framework)
+    end
+
+  when :linux, :linux_rpi, :bsd
+    # TODO: implement this
+    # ld_flags = '-lSDL2 -lSDL2_image -lSDL2_mixer -lSDL2_ttf -lm -lGL'
+
+  when :windows
+    ld_dir = "#{Ruby2D.assets}/windows/mingw-w64-x86_64/lib"
+
+    ld_flags = '-static -Wl,--start-group '
+    ['mruby',
+     'SDL2',
+     'SDL2_image', 'jpeg', 'png16', 'tiff', 'webp', 'jbig', 'deflate', 'lzma', 'zstd', 'Lerc',
+     'SDL2_mixer', 'mpg123', 'FLAC', 'vorbis', 'vorbisfile', 'ogg', 'modplug', 'opus', 'opusfile', 'sndfile',
+     'SDL2_ttf', 'freetype', 'harfbuzz', 'graphite2', 'bz2', 'brotlicommon', 'brotlidec',
+     'glew32', 'stdc++', 'z', 'ssp'
+    ].each do |name|
+      add_ld_flags(ld_flags, name, :archive, ld_dir)
+    end
+    ld_flags << '-lmingw32 -lopengl32 -lole32 -loleaut32 -limm32 -lversion -lwinmm -lrpcrt4 -mwindows -lsetupapi -ldwrite '\
+                '-lws2_32 -lshlwapi '
+    ld_flags << '-Wl,--end-group'
+  end
+
+  # Compile the app
+  run_cmd "cc #{c_flags} -I#{incl_dir_ruby2d} -I#{incl_dir_deps} build/app.c #{ld_flags} -o build/app"
+
+  create_macos_bundle if $RUBY2D_PLATFORM == :macos
 end
 
 
-# Build an app bundle for macOS
-def build_macos(rb_file)
+# Create a WebAssembly executable using Emscripten
+def compile_web
+
+  # Check for compiler toolchain issues
+  if doctor_web(:building)
+    puts "Fix errors before building.\n\n"
+  end
+
+  wasm_assets = "#{Ruby2D.assets}/wasm"
+
+  # Get include directories
+  incl_dir_ruby2d = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+  incl_dir_deps = "#{Ruby2D.assets}/include/"
+
+  optimize_flags = '-Os --closure 1'
+  ld_flags = "#{wasm_assets}/libmruby.a"
+
+  # Compile using Emscripten
+  run_cmd "emcc -s WASM=1 -I#{incl_dir_ruby2d} -I#{incl_dir_deps} "\
+          "-s USE_SDL=2 -s USE_SDL_IMAGE=2 -s USE_SDL_MIXER=2 -s USE_SDL_TTF=2 "\
+          "build/app.c #{ld_flags} -o build/app.html"
+
+  # TODO: Copy HTML template from gem assets to build directory
+  # FileUtils.cp "#{wasm_assets}/template.html", 'build/app.html'
+
+  exit(1) unless $?.success?
+end
+
+
+def doctor_native
+  # Check if MRuby exists; if not, quit
+  if `which mruby`.empty?
+    puts "#{'Error:'.error} Can't find `mruby`, which is needed to build native Ruby 2D applications.\n"
+    exit
+  end
+end
+
+
+# Check for problems with web build
+def doctor_web(mode = nil)
+
+  errors = false
+  mruby_errors = false
+  emscripten_errors = false
+
+  puts "\nChecking for mruby"
+
+  # Check for `mrbc`
+  print '  mrbc...'
+  if `which mrbc`.empty?
+    puts 'not found'.error
+    mruby_errors = true
+  else
+    puts 'found'.success
+  end
 
-  # Build native app for macOS
-  build_native(rb_file)
+  puts "\nChecking for Emscripten tools"
+
+  # Check for `emcc`
+  print '  emcc...'
+  if `which emcc`.empty?
+    puts 'not found'.error
+    emscripten_errors = true
+  else
+    puts 'found'.success
+  end
+
+  # Check for `emar`
+  print '  emar...'
+  if `which emar`.empty?
+    puts 'not found'.error
+    emscripten_errors = true
+  else
+    puts 'found'.success
+  end
+
+  if mruby_errors || emscripten_errors then errors = true end
+
+  if errors
+    puts "\nErrors were found!\n\n"
+    if mruby_errors
+      puts "* Did you install mruby?"
+    end
+    if emscripten_errors
+      puts "* Did you run \`./emsdk_env.sh\` ?", "  For help, check out the \"Getting Started\" guide on webassembly.org"
+    end
+    puts "\n"
+    exit(1)
+  else
+    puts "\n👍 Everything looks good!\n\n"
+  end
+end
+
+
+# Build an app bundle for macOS
+def create_macos_bundle
 
   # Property list source for the bundle
   info_plist = %(
@@ -151,10 +332,10 @@ def build_macos(rb_file)
   #   FileUtils.cp "#{@gem_dir}/assets/app.icns", 'build/App.app/Contents/Resources'
 
   # Clean up
-  FileUtils.rm_f 'build/app' unless @debug
+  # FileUtils.rm_f 'build/app' unless @debug
 
   # Success!
-  puts 'macOS app bundle created: `build/App.app`'
+  # puts 'macOS app bundle created: `build/App.app`'
 end
 
 
@@ -206,8 +387,7 @@ end
 # Clean up unneeded build files
 def clean_up(cmd = nil)
   FileUtils.rm(
-    Dir.glob('build/{src,lib}.{rb,c,js}') +
-    Dir.glob('build/app.c')
+    Dir.glob('build/*.{rb,c,js}')
   )
   if cmd == :all
     puts "cleaning up..."

data/lib/ruby2d/cli/colorize.rb

@@ -3,8 +3,9 @@
 # Extend `String` to include some fancy colors
 class String
   def ruby2d_colorize(c); "\e[#{c}m#{self}\e[0m" end
-  def bold;  ruby2d_colorize('1')    end
-  def info;  ruby2d_colorize('1;34') end
-  def warn;  ruby2d_colorize('1;33') end
-  def error; ruby2d_colorize('1;31') end
+  def bold;    ruby2d_colorize('1')    end
+  def info;    ruby2d_colorize('1;34') end
+  def warn;    ruby2d_colorize('1;33') end
+  def success; ruby2d_colorize('1;32') end
+  def error;   ruby2d_colorize('1;31') end
 end

data/lib/ruby2d/cli/platform.rb

@@ -0,0 +1,17 @@
+# Set the OS and platform
+
+case RUBY_PLATFORM
+when /darwin/
+  $RUBY2D_PLATFORM = :macos
+when /linux/
+  $RUBY2D_PLATFORM = :linux
+  if `cat /etc/os-release` =~ /raspbian/
+    $RUBY2D_PLATFORM = :linux_rpi
+  end
+when /bsd/
+  $RUBY2D_PLATFORM = :bsd
+when /mingw/
+  $RUBY2D_PLATFORM = :windows
+else
+  $RUBY2D_PLATFORM = nil
+end

data/lib/ruby2d/font.rb

@@ -2,8 +2,28 @@
 
 module Ruby2D
   class Font
+    FONT_CACHE_LIMIT = 100
+
+    @@loaded_fonts = {}
+
+    attr_reader :ttf_font
+
+    def initialize(path, size, style=nil)
+      @ttf_font = Font.ext_load(path, size, style.to_s)
+    end
 
     class << self
+      def load(path, size, style=nil)
+        unless File.exist? path
+          raise Error, "Cannot find font file `#{path}`"
+        end
+
+        (@@loaded_fonts[[path, size, style]] ||= Font.new(path, size, style)).tap do |font|
+          if @@loaded_fonts.size > FONT_CACHE_LIMIT
+            @@loaded_fonts.shift
+          end
+        end
+      end
 
       # List all fonts, names only
       def all
@@ -50,6 +70,7 @@ module Ruby2D
         macos_font_path   = '/Library/Fonts'
         linux_font_path   = '/usr/share/fonts'
         windows_font_path = 'C:/Windows/Fonts'
+        openbsd_font_path = '/usr/X11R6/lib/X11/fonts'
 
         # If MRI and/or non-Bash shell (like cmd.exe)
         if Object.const_defined? :RUBY_PLATFORM
@@ -60,16 +81,20 @@ module Ruby2D
             linux_font_path
           when /mingw/
             windows_font_path
+          when /openbsd/
+            openbsd_font_path
           end
         # If MRuby
         else
           uname = `uname`
-          if uname.include? 'Darwin' # macOS
+          if uname.include? 'Darwin'  # macOS
             macos_font_path
           elsif uname.include? 'Linux'
             linux_font_path
           elsif uname.include? 'MINGW'
             windows_font_path
+          elsif uname.include? 'OpenBSD'
+            openbsd_font_path
           end
         end
       end

data/lib/ruby2d/image.rb

@@ -7,26 +7,34 @@ module Ruby2D
     attr_reader :path
     attr_accessor :x, :y, :width, :height, :rotate, :data
 
-    def initialize(path, opts = {})
+    def self.load_image(path)
       unless File.exist? path
         raise Error, "Cannot find image file `#{path}`"
       end
+
+      ext_load_image(path)
+    end
+
+    def initialize(path, opts = {})
       @path = path
+
+      @texture = Texture.new(*Image.load_image(@path))
+      @width = opts[:width] || @texture.width
+      @height = opts[:height] || @texture.height
+
       @x = opts[:x] || 0
       @y = opts[:y] || 0
       @z = opts[:z] || 0
-      @width = opts[:width] || nil
-      @height = opts[:height] || nil
       @rotate = opts[:rotate] || 0
       self.color = opts[:color] || 'white'
-      self.opacity = opts[:opacity] if opts[:opacity]
-      unless ext_init(@path)
-        raise Error, "Image `#{@path}` cannot be created"
-      end
+      self.color.opacity = opts[:opacity] if opts[:opacity]
+
       unless opts[:show] == false then add end
     end
 
     def draw(opts = {})
+      Window.render_ready_check
+
       opts[:width] = opts[:width] || @width
       opts[:height] = opts[:height] || @height
       opts[:rotate] = opts[:rotate] || @rotate
@@ -34,20 +42,17 @@ module Ruby2D
         opts[:color] = [1.0, 1.0, 1.0, 1.0]
       end
 
-      self.class.ext_draw([
-        self, opts[:x], opts[:y], opts[:width], opts[:height], opts[:rotate],
-        opts[:color][0], opts[:color][1], opts[:color][2], opts[:color][3]
-      ])
+      render(x: opts[:x], y: opts[:y], width: opts[:width], height: opts[:height], color: Color.new(opts[:color]), rotate: opts[:rotate])
     end
 
     private
 
-    def render
-      self.class.ext_draw([
-        self, @x, @y, @width, @height, @rotate,
-        @color.r, @color.g, @color.b, @color.a
-      ])
-    end
+    def render(x: @x, y: @y, width: @width, height: @height, color: @color, rotate: @rotate)
+      vertices = Vertices.new(x, y, width, height, rotate)
 
+      @texture.draw(
+        vertices.coordinates, vertices.texture_coordinates, color
+      )
+    end
   end
 end

data/lib/ruby2d/line.rb

@@ -14,7 +14,7 @@ module Ruby2D
       @z = opts[:z] || 0
       @width = opts[:width] || 2
       self.color = opts[:color] || 'white'
-      self.opacity = opts[:opacity] if opts[:opacity]
+      self.color.opacity = opts[:opacity] if opts[:opacity]
       add
     end
 
@@ -39,6 +39,8 @@ module Ruby2D
     end
 
     def self.draw(opts = {})
+      Window.render_ready_check
+
       ext_draw([
         opts[:x1], opts[:y1], opts[:x2], opts[:y2], opts[:width],
         opts[:color][0][0], opts[:color][0][1], opts[:color][0][2], opts[:color][0][3],

data/lib/ruby2d/quad.rb

@@ -25,7 +25,7 @@ module Ruby2D
       @y4 = opts[:y4] || 100
       @z  = opts[:z]  || 0
       self.color = opts[:color] || 'white'
-      self.opacity = opts[:opacity] if opts[:opacity]
+      self.color.opacity = opts[:opacity] if opts[:opacity]
       add
     end
 
@@ -49,6 +49,8 @@ module Ruby2D
     end
 
     def self.draw(opts = {})
+      Window.render_ready_check
+
       ext_draw([
         opts[:x1], opts[:y1], opts[:color][0][0], opts[:color][0][1], opts[:color][0][2], opts[:color][0][3],
         opts[:x2], opts[:y2], opts[:color][1][0], opts[:color][1][1], opts[:color][1][2], opts[:color][1][3],

data/lib/ruby2d/rectangle.rb

@@ -10,7 +10,7 @@ module Ruby2D
       @width = opts[:width] || 200
       @height = opts[:height] || 100
       self.color = opts[:color] || 'white'
-      self.opacity = opts[:opacity] if opts[:opacity]
+      self.color.opacity = opts[:opacity] if opts[:opacity]
       update_coords(@x, @y, @width, @height)
       add
     end

data/lib/ruby2d/renderable.rb

@@ -31,18 +31,6 @@ module Ruby2D
     alias_method :colour, :color
     alias_method :colour=, :color=
 
-    # Allow shortcuts for setting color values
-    def r; self.color.r end
-    def g; self.color.g end
-    def b; self.color.b end
-    def a; self.color.a end
-    def r=(c); self.color.r = c end
-    def g=(c); self.color.g = c end
-    def b=(c); self.color.b = c end
-    def a=(c); self.color.a = c end
-    def opacity; self.color.opacity end
-    def opacity=(val); self.color.opacity = val end
-
     # Add a contains method stub
     def contains?(x, y)
       x >= @x && x <= (@x + @width) && y >= @y && y <= (@y + @height)

data/lib/ruby2d/sound.rb

@@ -26,5 +26,30 @@ module Ruby2D
       ext_length
     end
 
+    # Get the volume of the sound
+    def volume
+      ext_get_volume
+    end
+
+    # Set the volume of the sound
+    def volume=(v)
+      # Clamp value to between 0-100
+      if v < 0 then v = 0 end
+      if v > 100 then v = 100 end
+      ext_set_volume(v)
+    end
+
+    # Get the volume of the sound mixer
+    def self.mix_volume
+      ext_get_mix_volume
+    end
+
+    # Set the volume of the sound mixer
+    def self.mix_volume=(v)
+      # Clamp value to between 0-100
+      if v < 0 then v = 0 end
+      if v > 100 then v = 100 end
+      ext_set_mix_volume(v)
+    end
   end
 end