ruby2d 0.12.0 → 1.0.0

data/ext/ruby2d/extconf.rb

@@ -1,179 +1,156 @@
 require 'mkmf'
-require_relative '../../lib/ruby2d/cli/colorize'
-require_relative '../../lib/ruby2d/cli/platform'
-
-$errors = []  # Holds errors
+require_relative '../../lib/ruby2d/deps_help'
+require_relative '../../lib/ruby2d/cli/messages'
+require_relative '../../lib/ruby2d/version'
 
 # Helper functions #############################################################
 
-# Print installation errors
-def print_errors
-  puts "
-#{"== #{"Ruby 2D Installation Errors".error} =======================================\n"}
-  #{$errors.join("\n  ")}\n
-#{"======================================================================"}"
-end
-
-
 # Add compiler and linker flags
 def add_flags(type, flags)
   case type
-  when :c
-    $CFLAGS << " #{flags} "
-  when :ld
-    $LDFLAGS << " #{flags} "
+  when :c  then $CFLAGS  << " #{flags} "
+  when :ld then $LDFLAGS << " #{flags} "
   end
 end
 
-
-# Check for SDL libraries
-def check_sdl
-  unless have_library('SDL2') && have_library('SDL2_image') && have_library('SDL2_mixer') && have_library('SDL2_ttf')
-
-    $errors << "Couldn't find packages needed by Ruby 2D."
-
-    case $platform
-    when :linux, :linux_rpi
-      # Fedora and CentOS
-      if system('which yum')
-        $errors << "Install the following packages using `yum` (or `dnf`) and try again:\n" <<
-        "  SDL2-devel SDL2_image-devel SDL2_mixer-devel SDL2_ttf-devel".bold
-
-      # Arch
-      elsif system('which pacman')
-        $errors << "Install the following packages using `pacman` and try again:\n" <<
-        "  sdl2 sdl2_image sdl2_mixer sdl2_ttf".bold
-
-      # openSUSE
-      elsif system('which zypper')
-        $errors << "Install the following packages using `zypper` and try again:\n" <<
-        "  libSDL2-devel libSDL2_image-devel libSDL2_mixer-devel libSDL2_ttf-devel".bold
-
-      # Ubuntu, Debian, and Mint
-      # `apt` must be last because openSUSE has it aliased to `zypper`
-      elsif system('which apt')
-        $errors << "Install the following packages using `apt` and try again:\n" <<
-        "  libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev".bold
-      end
-    when :bsd
-      $errors << "Install the following packages using `pkg` and try again:\n" <<
-      "  sdl2 sdl2_image sdl2_mixer sdl2_ttf".bold
-    end
-
-    $errors << "" << "See #{"ruby2d.com".bold} for additional help."
-    print_errors; exit
-  end
+# Whether all four SDL3 static archives are present in a lib dir
+SDL3_STATIC_LIBS = %w[libSDL3.a libSDL3_image.a libSDL3_mixer.a libSDL3_ttf.a].freeze
+def static_libs_present?(lib_dir)
+  SDL3_STATIC_LIBS.all? { |lib| File.exist?(File.join(lib_dir, lib)) }
 end
 
-
-# Set Raspberry Pi flags
-def set_rpi_flags
-  if $platform == :linux_rpi
-    add_flags(:c, '-I/opt/vc/include')
-    add_flags(:ld, '-L/opt/vc/lib -lbrcmGLESv2')
-  end
+# A `ruby2d setup` cache build is stamped with the ruby2d version that produced
+# it; only reuse it for a matching version (a gem upgrade may pin newer SDL, so
+# stale cache libs must not be linked against this version's headers/sources).
+def cache_stamp_ok?(platform_dir)
+  stamp = File.join(platform_dir, '.ruby2d-version')
+  File.exist?(stamp) && File.read(stamp).strip == Ruby2D::VERSION
 end
 
-
-# Set flags for Linux and BSD
-def set_linux_bsd_flags
-  check_sdl
-  set_rpi_flags
-  add_flags(:ld, "-lSDL2 -lSDL2_image -lSDL2_mixer -lSDL2_ttf -lm")
-  if $RUBY2D_PLATFORM == :linux then add_flags(:ld, '-lGL') end
-end
-
-
-# Use SDL and other libraries installed by the user (not those bundled with the gem)
-def use_usr_libs
-  case $RUBY2D_PLATFORM
-  when :macos
-    add_flags(:c, `sdl2-config --cflags`)
-    add_flags(:c, '-I/opt/homebrew/include')
-    add_flags(:ld, `sdl2-config --libs`)
-    add_flags(:ld, '-lSDL2 -lSDL2_image -lSDL2_mixer -lSDL2_ttf')
-    add_flags(:ld, '-Wl,-framework,OpenGL')
-  when :windows
-    add_flags(:ld, '-lSDL2 -lSDL2_image -lSDL2_mixer -lSDL2_ttf')
-    add_flags(:ld, '-lopengl32 -lglew32')
-  when :linux_rpi
-    set_linux_bsd_flags
+# Install without the native extension: write a do-nothing Makefile so `gem
+# install` still completes, surface the recovery guidance, and exit cleanly. The
+# user finishes with `ruby2d setup`, or a package-manager install + `gem pristine
+# ruby2d`. Far friendlier than aborting the whole install — and the `ruby2d` CLI
+# (including `setup`) keeps working without the extension.
+def skip_build(reason)
+  notice = "Ruby 2D: #{reason}\n#{Ruby2D::DepsHelp.notice}"
+
+  # RubyGems runs extconf via Open3.popen2e and hides the captured stdout/stderr
+  # on a successful (exit-0) install, so a plain `puts` never reaches the user.
+  # Write straight to the controlling terminal — which popen2e leaves attached —
+  # to surface the guidance on an interactive install. Best-effort: with no tty
+  # (CI, piped) it's skipped, and the same guidance still shows at run time via
+  # the LoadError rescue in lib/ruby2d/core.rb.
+  begin
+    File.open('/dev/tty', 'w') { |tty| tty.puts notice }
+  rescue SystemCallError
+    # no controlling terminal — rely on the runtime notice
   end
-end
+  puts notice # also captured to the build log (visible with `gem install --verbose`)
 
+  File.write('Makefile', "all:\ninstall:\nclean:\n")
+  exit 0
+end
 
 # Configure native extension ###################################################
 
-# Build Ruby 2D native extention using libraries installed by user
-# To use install flag: `gem install ruby2d -- dev`
-if ARGV.include? 'dev'
-  use_usr_libs
+# Resolve SDL3 static libraries: bundled with the gem first, then a `ruby2d
+# setup` cache build (version-stamped). Mirrors lib/ruby2d/cli/build.rb.
+#
+# `--with-bundled-libs` marks a local `rake` install, where the working tree's
+# `assets/platform` — packaged into the gem by `rake build` — is the only
+# sanctioned source. This script can't otherwise tell a developer's `rake` from
+# a user's `gem install`, and falling through to a `ruby2d setup` cache or to
+# system SDL3 would silently link libraries the developer never built.
+use_system_libs  = with_config('system-libs')
+use_bundled_libs = with_config('bundled-libs')
+
+static_platform =
+  if use_system_libs
+    nil
+  elsif static_libs_present?(File.join(AssetsTarget.platform_dir, 'lib'))
+    AssetsTarget.platform_dir
+  elsif use_bundled_libs
+    abort_error "No SDL3 static libraries for #{AssetsTarget.target_id} " \
+                "in the gem's assets/platform.\n\n" \
+                "  A local build links only those. Build them with #{'rake deps:build'.bold}, or\n" \
+                "  link system-installed SDL3 instead with " \
+                "#{'CONFIGURE_ARGS=--with-system-libs rake'.bold}.\n\n",
+                spaced: true, indent: 2
+  else
+    cache = AssetsTarget.platform_dir(root: AssetsTarget.cache_root)
+    cache if static_libs_present?(File.join(cache, 'lib')) && cache_stamp_ok?(cache)
+  end
 
-# Use libraries provided by the gem (default)
+# Name the source that won. Bundled and cache libs both land in the branch
+# above, and linking the wrong one is otherwise invisible in the build log.
+if use_system_libs
+  puts 'Ruby 2D: Using system-installed SDL3 libraries (--with-system-libs).'
+elsif static_platform.nil?
+  puts 'Ruby 2D: No bundled or cached static libraries; trying system-installed SDL3.'
+elsif static_platform == AssetsTarget.platform_dir
+  puts "Ruby 2D: Using the static libraries bundled in #{static_platform}."
 else
-  add_flags(:c, '-std=c11')
-
-  case $RUBY2D_PLATFORM
-
-  when :macos
-    add_flags(:c, '-I../../assets/include')
-    ldir = "#{Dir.pwd}/../../assets/macos/universal/lib"
-
-    add_flags(:ld, "#{ldir}/libSDL2.a #{ldir}/libSDL2_image.a #{ldir}/libSDL2_mixer.a #{ldir}/libSDL2_ttf.a")
-    add_flags(:ld, "#{ldir}/libjpeg.a #{ldir}/libjxl.a #{ldir}/libavif.a #{ldir}/libzstd.a #{ldir}/libbrotlicommon-static.a #{ldir}/libbrotlidec-static.a #{ldir}/libhwy.a #{ldir}/libpng.a #{ldir}/libtiff.a #{ldir}/libwebp.a")
-    add_flags(:ld, "#{ldir}/libmpg123.a #{ldir}/libogg.a #{ldir}/libFLAC.a #{ldir}/libvorbis.a #{ldir}/libvorbisfile.a #{ldir}/libmodplug.a")
-    add_flags(:ld, "#{ldir}/libfreetype.a #{ldir}/libharfbuzz.a #{ldir}/libgraphite2.a")
-    add_flags(:ld, "-lz -lbz2 -liconv -lstdc++")
-    add_flags(:ld, "-Wl,-framework,Cocoa -Wl,-framework,Carbon -Wl,-framework,GameController -Wl,-framework,ForceFeedback -Wl,-framework,OpenGL -Wl,-framework,AudioToolbox -Wl,-framework,CoreAudio -Wl,-framework,IOKit -Wl,-framework,CoreHaptics -Wl,-framework,CoreVideo -Wl,-framework,Metal")
-
-  when :windows
-    add_flags(:c, '-I../../assets/include')
-
-    if RUBY_PLATFORM =~ /ucrt/
-      ldir = "#{Dir.pwd}/../../assets/windows/mingw-w64-ucrt-x86_64/lib"
-    else
-      ldir = "#{Dir.pwd}/../../assets/windows/mingw-w64-x86_64/lib"
-    end
-
-    # Start linker flags (needed to avoid circular dependencies)
-    add_flags(:ld, "-Wl,--start-group")
-
-    # SDL2
-    add_flags(:ld, "#{ldir}/libSDL2.a")
+  puts "Ruby 2D: Using `ruby2d setup` cache libraries in #{static_platform}."
+end
 
-    # SDL2_image
-    add_flags(:ld, "#{ldir}/libSDL2_image.a")
-    add_flags(:ld, "#{ldir}/libjpeg.a #{ldir}/libpng.a #{ldir}/libtiff.a #{ldir}/libwebp.a")
-    add_flags(:ld, "#{ldir}/libjxl.a #{ldir}/libhwy.a #{ldir}/libjbig.a #{ldir}/libdeflate.a #{ldir}/liblzma.a #{ldir}/libzstd.a #{ldir}/libLerc.a")
+if static_platform
+
+  # Bundled or cache-built static libraries. List the dependent archives before
+  # the base `libSDL3.a` so single-pass GNU ld (MinGW) resolves their symbols;
+  # macOS's order-independent ld64 is unaffected.
+  ldir        = File.join(static_platform, 'lib')
+  include_dir = File.join(File.dirname(static_platform), 'include')
+
+  add_flags(:c, "-I#{include_dir}")
+  add_flags(:ld, "#{ldir}/libSDL3_image.a #{ldir}/libSDL3_mixer.a #{ldir}/libSDL3_ttf.a #{ldir}/libSDL3.a")
+
+  case AssetsTarget.host_os
+  when 'macos'
+    # System frameworks the bundled SDL3 static libs reference. Must match the
+    # authoritative list in assets/Rakefile (PLATFORM_LIBS) — a missing one
+    # leaves unresolved symbols that only happen to resolve via CRuby's
+    # `-Wl,-undefined,dynamic_lookup` at load time.
+    frameworks = %w[
+      AVFoundation AudioToolbox Carbon Cocoa CoreAudio CoreHaptics
+      CoreMedia ForceFeedback GameController IOKit Metal QuartzCore
+      UniformTypeIdentifiers
+    ]
+    add_flags(:ld, frameworks.map { |fw| "-Wl,-framework,#{fw}" }.join(' '))
+
+  when 'windows'
+    add_flags(:ld, '-lgdi32 -lhid -limm32 -lole32 -loleaut32 -lrpcrt4 -lsetupapi -lusp10 -luuid -lversion -lwinmm')
 
-    # SDL2_mixer
-    add_flags(:ld, "#{ldir}/libSDL2_mixer.a")
-    add_flags(:ld, "#{ldir}/libmpg123.a #{ldir}/libFLAC.a #{ldir}/libvorbis.a #{ldir}/libvorbisfile.a #{ldir}/libogg.a "\
-                   "#{ldir}/libmodplug.a #{ldir}/libopus.a #{ldir}/libopusfile.a #{ldir}/libsndfile.a")
+  end
 
-    # SDL2_ttf
-    add_flags(:ld, "#{ldir}/libSDL2_ttf.a")
-    add_flags(:ld, "#{ldir}/libfreetype.a #{ldir}/libharfbuzz.a #{ldir}/libgraphite2.a "\
-                   "#{ldir}/libbz2.a #{ldir}/libbrotlicommon.a #{ldir}/libbrotlidec.a")
+else
 
-    # Other dependencies
-    add_flags(:ld, "#{ldir}/libglew32.a #{ldir}/libstdc++.a #{ldir}/libz.a")
-    add_flags(:ld, '-lmingw32 -lopengl32 -lole32 -loleaut32 -limm32 -lversion -lwinmm -lrpcrt4 -mwindows -lsetupapi -ldwrite')
+  # System-installed SDL3 libraries
+  # Try pkg-config first — provides accurate include paths and link flags
+  sdl3_pkgs = 'sdl3 sdl3-image sdl3-mixer sdl3-ttf'
 
-    # End linker flags
-    add_flags(:ld, "-Wl,--end-group")
+  if system("pkg-config --exists #{sdl3_pkgs} 2>#{File::NULL}")
+    puts 'Ruby 2D: Configuring SDL3 via pkg-config.'
+    add_flags(:c,  `pkg-config --cflags #{sdl3_pkgs}`.chomp)
+    add_flags(:ld, `pkg-config --libs   #{sdl3_pkgs}`.chomp)
 
-  when :linux, :linux_rpi, :bsd
-    set_linux_bsd_flags
+  elsif !(have_library('SDL3') && have_library('SDL3_image') &&
+          have_library('SDL3_mixer') && have_library('SDL3_ttf'))
+    # No static libs, no pkg-config, and not in the standard system paths —
+    # install without the extension and tell the user how to finish.
+    skip_build('no bundled, cached, or system SDL3 libraries found.')
+  end
 
-  # If can't detect the platform, use libraries installed by the user
-  else
-    use_usr_libs
+  case AssetsTarget.host_os
+  when 'linux', 'bsd'
+    add_flags(:ld, '-lm')
   end
+
 end
 
-$CFLAGS.gsub!(/\n/, ' ')  # remove newlines in flags, they can cause problems
-$LDFLAGS.gsub!(/\n/, ' ')  # remove newlines in flags, they can cause problems
+# Remove newlines in flags, they can cause problems
+$CFLAGS.gsub!(/\n/, ' ')
+$LDFLAGS.gsub!(/\n/, ' ')
 
 # Create Makefile
 create_makefile('ruby2d/ruby2d')