wxruby3 0.9.5 → 0.9.7

data/rakelib/lib/config/pkgman/base.rb

@@ -0,0 +1,169 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools platform pkg manager base
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        MIN_GENERIC_PKGS = %w[gtk3-devel patchelf g++ make git webkit2gtk3-devel gspell-devel gstreamer-devel gstreamer-plugins-base-devel libcurl-devel libsecret-devel libnotify-devel libSDL-devel zlib-devel]
+
+        class << self
+
+          def install(pkgs)
+            # do we need to install anything?
+            if !pkgs.empty? || builds_wxwidgets?
+              # determine the linux distro specs
+              distro = get_distro
+              begin
+                # load distro installation support
+                require_relative "./#{distro[:type]}"
+              rescue LoadError
+                # do we need to build wxWidgets?
+                pkgs.concat(MIN_GENERIC_PKGS) if builds_wxwidgets?
+                $stderr.puts <<~__ERROR_TXT
+                  ERROR: Do not know how to install required packages for distro type '#{distro[:type]}'.
+  
+                  Make sure the following packages (or equivalent) are installed and than try again with `WXRUBY_NO_AUTOINSTALL=1`:
+                  #{pkgs.join(', ')}
+                  __ERROR_TXT
+                exit(1)
+              end
+              # can we install?
+              unless no_autoinstall? || has_sudo? || is_root?
+                $stderr.puts 'ERROR: Cannot check for or install required packages. Please install sudo or run as root and try again.'
+                exit(1)
+              end
+              # do we need to build wxWidgets?
+              if builds_wxwidgets?
+                # add platform specific packages for wxWidgets
+                add_platform_pkgs(pkgs)
+              end
+              # do we actually have any packages to install?
+              unless pkgs.empty?
+                # autoinstall or not?
+                unless wants_autoinstall?
+                  $stderr.puts <<~__ERROR_TXT
+                    ERROR: This system may lack installed versions of the following required software packages:
+                      #{pkgs.join(', ')}
+                      
+                    Install these packages and try again.
+                    __ERROR_TXT
+                  exit(1)
+                end
+                # do the actual install
+                unless do_install(distro, pkgs)
+                  $stderr.puts <<~__ERROR_TXT
+                    ERROR: Failed to install all or some of the following required software packages:
+                    #{pkgs.join(', ')}
+                    
+                    Fix any problems or install these packages yourself and try again.
+                    __ERROR_TXT
+                  if WXRuby3.config.run_silent?
+                    $stderr.puts "For error details check #{WXRuby3.config.silent_log_name}"
+                  end
+                  exit(1)
+                end
+              end
+            end
+          end
+
+          private
+
+          def builds_wxwidgets?
+            Config.get_config('with-wxwin') && Config.get_cfg_string('wxwin').empty?
+          end
+
+          def no_autoinstall?
+            Config.get_config('autoinstall') == false
+          end
+
+          def wants_autoinstall?
+            WXRuby3.config.wants_autoinstall?
+          end
+
+          def has_sudo?
+            system('command -v sudo > /dev/null')
+          end
+
+          def is_root?
+            `id -u 2>/dev/null`.chomp == '0'
+          end
+
+          def run(cmd)
+            $stdout.print "Running #{cmd}..."
+            rc = WXRuby3.config.sh("#{is_root? ? '' : 'sudo '}#{cmd}")
+            $stderr.puts (rc ? 'done!' : 'FAILED!')
+            rc
+          end
+
+          def expand(cmd)
+            `#{is_root? ? '' : 'sudo '}#{cmd}`
+          end
+
+          def get_distro
+            if File.file?('/etc/os-release') # works with most (if not all) recent distro releases
+              data = File.readlines('/etc/os-release').reduce({}) do |hash, line|
+                val, var = line.split('=')
+                hash[val] = var.strip.gsub(/(\A")|("\Z)/, '')
+                hash
+              end
+              {
+                type: if data['ID_LIKE']
+                        data['ID_LIKE'].split.first.to_sym
+                      elsif File.file?('/etc/redhat-release')
+                        :rhel
+                      elsif File.file?('/etc/SUSE-brand') || File.file?('/etc/SuSE-release')
+                        :suse
+                      elsif File.file?('/etc/debian_version')
+                        :debian
+                      else
+                        data['ID'].to_sym
+                      end,
+                distro: data['ID'].downcase,
+                release: data['VERSION_ID']
+              }
+            elsif File.file?('/etc/redhat-release')
+              data = File.read('/etc/redhat-release').strip
+              {
+                type: :rhel,
+                distro: data.split.shift.downcase,
+                release: data =~ /\d+(\.\d+)*/ ? $~[0] : ''
+              }
+            elsif File.file?('/etc/SUSE-brand') || File.file?('/etc/SuSE-release')
+              data = File.readlines(File.file?('/etc/SUSE-brand') ? '/etc/SUSE-brand' : '/etc/SuSE-release')
+              {
+                type: :suse,
+                distro: data.shift.split.shift.downcase,
+                release: (data.find { |s| s.strip =~ /\AVERSION\s*=/ } || '').split('=').last || ''
+              }
+            elsif File.file?('/etc/debian_version')
+              {
+                type: :debian,
+                distro: 'generic',
+                release: File.read('/etc/debian_version').strip
+              }
+            else
+              {
+                type: :unknown
+              }
+            end
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/pkgman/debian.rb

@@ -0,0 +1,66 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools platform pkg manager for Debian type systems
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        PLATFORM_DEPS = %w[libgtk-3-dev libwebkit2gtk-4.0-dev libgspell-1-dev libunwind-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libcurl4-openssl-dev libsecret-1-dev libnotify-dev]
+
+        class << self
+
+          private
+
+          def do_install(distro, pkgs)
+            run_apt(make_install_cmd(pkgs))
+          end
+
+          def add_platform_pkgs(pkgs)
+            # get architecture
+            arch = expand('dpkg --print-architecture').strip
+            # find pkgs we need
+            PLATFORM_DEPS.inject(pkgs) do |list, pkg|
+              list << pkg unless (system("dpkg-query -s \"#{pkg}:#{arch}\" >/dev/null 2>&1") ||
+                                    system("dpkg-query -s \"#{pkg}:all\" >/dev/null 2>&1") ||
+                                    (expand("dpkg-query -s \"#{pkg}\" 2>/dev/null").strip =~ /Architecture: (#{arch}|all)/))
+              list
+            end
+          end
+
+          def run_apt(cmd)
+            run("DEBIAN_FRONTEND=noninteractive apt-get -q -o=Dpkg::Use-Pty=0 #{cmd}")
+          end
+
+          def update_pkgs
+            run_apt('update')
+          end
+
+          def make_install_cmd(pkgs)
+            # update cache
+            update_pkgs
+            # get list of available packages
+            apt_cache = `apt-cache pkgnames`.chomp.split("\n").collect { |s| s.strip }
+            # remove un-installables
+            pkgs = pkgs.select { |pkg| apt_cache.include?(pkg) }
+            # create install command
+            "install -y #{ pkgs.join(' ') }"
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/pkgman/macosx.rb

@@ -0,0 +1,183 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools MacOSX pkg manager
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        class << self
+
+          def install(pkgs)
+            # do we need to install anything?
+            if !pkgs.empty?
+              # can we install XCode commandline tools?
+              unless no_autoinstall? || !pkgs.include?('xcode') || has_sudo? || is_root?
+                STDERR.puts 'ERROR: Cannot check for or install required packages. Please install sudo or run as root and try again.'
+                exit(1)
+              end
+
+              # autoinstall or not?
+              unless pkgs.empty? || wants_autoinstall?
+                $stderr.puts <<~__ERROR_TXT
+                  ERROR: This system may lack installed versions of the following required software packages:
+                    #{pkgs.join(', ')}
+                    
+                    Install these packages and try again.
+                  __ERROR_TXT
+                exit(1)
+              end
+              # do the actual install (or nothing)
+              unless do_install(pkgs)
+                $stderr.puts <<~__ERROR_TXT
+                  ERROR: Failed to install all or some of the following required software packages:
+                    #{pkgs.join(', ')}
+                    
+                  Fix any problems or install these packages yourself and try again.
+                  __ERROR_TXT
+                exit(1)
+              end
+            end
+          end
+
+          private
+
+          def do_install(pkgs)
+            rc = true
+            # first see if we need to install XCode commandline tools
+            if pkgs.include?('xcode')
+              pkgs.delete('xcode')
+              rc = run('xcode-select --install')
+            end
+            # now check if we need any other packages (which need Homebrew or MacPorts)
+            if rc && !pkgs.empty?
+              # Has Ruby been installed through MacPorts?
+              if has_macports? &&
+                    (ruby_info = expand('port -q installed installed').strip.split("\n").find { |ln| ln.strip =~ /\Aruby\d+\s/ })
+
+                # this is really crap; with MacPorts we need to install swig-ruby instead of simply swig
+                # which for whatever nonsensical reason will pull in another (older) Ruby version (probably 2.3 or such)
+                # although SWIG's Ruby support is version agnostic and has no binary bindings
+                if pkgs.include?('swig')
+                  pkgs.delete('swig')
+                  pkgs << 'swig-ruby'
+                end
+                # in case MacPorts was installed with root privileges this install would also have to be run
+                # with root privileges (otherwise it would fail early on with access problems) so we can
+                # just run without sudo as we either have root privileges for root-installed MacPorts or
+                # we're running without root privileges for user-installed MacPorts
+                pkgs.each { |pkg| rc &&= sh("port install #{pkg}") }
+
+              # or are we running without root privileges and have Homebrew installed?
+              # (Ruby may be installed using Homebrew itself or using a Ruby version manager like RVM)
+              elsif !is_root? && has_homebrew?
+
+                pkgs.each { |pkg| rc &&= sh("brew install #{pkg}") }
+
+              # or do we have MacPorts (running either privileged or not) and
+              # a Ruby installed using a Ruby version manager.
+              elsif has_macports?
+
+                # same crap as above
+                if pkgs.include?('swig')
+                  pkgs.delete('swig')
+                  pkgs << 'swig-ruby'
+                end
+                # in case MacPorts was installed with root privileges this install would also have to be run
+                # with root privileges (otherwise it would fail early on with access problems) so we can
+                # just run without sudo as we either have root privileges for root-installed MacPorts or
+                # we're running without root privileges for user-installed MacPorts
+                pkgs.each { |pkg| rc &&= sh("port install #{pkg}") }
+
+              else
+                if has_homebrew? || is_root?
+                  $stderr.puts <<~__ERROR_TXT
+                    ERROR: Unsupported Ruby installation. wxRuby3 can only be installed for Ruby with root privileges
+                           in case Ruby was installed with MacPorts. Homebrew should not be run with root privileges.
+                      
+                    Re-install a supported Ruby setup and try again.
+                    __ERROR_TXT
+                else
+                  $stderr.puts <<~__ERROR_TXT
+                    ERROR: Unsupported Ruby installation. wxRuby3 requires either a MacPorts installed Ruby version 
+                           or a non-privileged Ruby installation and have Homebrew installed.
+                      
+                    Install either Homebrew or MacPorts and try again.
+                    __ERROR_TXT
+                end
+                exit(1)
+              end
+            end
+            rc
+          end
+
+          def builds_wxwidgets?
+            Config.get_config('with-wxwin') && Config.get_cfg_string('wxwin').empty?
+          end
+
+          def no_autoinstall?
+            Config.get_config('autoinstall') == false
+          end
+
+          def wants_autoinstall?
+            WXRuby3.config.wants_autoinstall?
+          end
+
+          def has_sudo?
+            system('command -v sudo > /dev/null')
+          end
+
+          def is_root?
+            if @is_root.nil?
+              @is_root = (`id -u 2>/dev/null`.chomp == '0')
+            end
+            @is_root
+          end
+
+          def has_macports?
+            if @has_macports.nil?
+              @has_macports = system('command -v port>/dev/null')
+            end
+          end
+
+          def has_homebrew?
+            if @has_homebrew.nil?
+              @has_homebrew = system('command -v brew>/dev/null')
+            end
+          end
+
+          def run(cmd)
+            $stdout.print "Running #{cmd}..."
+            rc = WXRuby3.config.sh("#{is_root? ? '' : 'sudo '}#{cmd}")
+            $stderr.puts (rc ? 'done!' : 'FAILED!')
+            rc
+          end
+
+          def sh(*cmd, title: nil)
+            $stdout.print(title ? title : "Running #{cmd}...")
+            rc = WXRuby3.config.sh(*cmd)
+            $stderr.puts (rc ? 'done!' : 'FAILED!')
+            rc
+          end
+
+          def expand(cmd)
+            WXRuby3.config.expand(cmd)
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/pkgman/rhel.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools platform pkg manager for RHEL type systems
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        PLATFORM_DEPS = %w[expat-devel findutils gspell-devel gstreamer1-plugins-base-devel gtk3-devel libcurl-devel libjpeg-devel libnotify-devel libpng-devel libSM-devel libsecret-devel libtiff-devel SDL-devel webkit2gtk4.1-devel zlib-devel]
+
+        class << self
+
+          private
+
+          def do_install(distro, pkgs)
+            run_dnf(make_install_cmd(pkgs))
+          end
+
+          def add_platform_pkgs(pkgs)
+            # add build tools
+            if pkgs.include?('git')
+              pkgs.delete('git')
+              pkgs << 'git-core'
+            end
+            # find pkgs we need
+            PLATFORM_DEPS.inject(pkgs) { |list, pkg| list << pkg unless system("dnf list installed #{pkg} >/dev/null 2>&1"); list }
+          end
+
+          def run_dnf(cmd)
+            run("dnf #{cmd}")
+          end
+
+          def make_install_cmd(pkgs)
+            # create install command
+            "install -y #{ pkgs.join(' ') }"
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/pkgman/suse.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 buildtools platform pkg manager for SuSE type systems
+###
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      module PkgManager
+
+        PLATFORM_DEPS = %w[gtk3-devel webkit2gtk3-devel gspell-devel gstreamer-devel gstreamer-plugins-base-devel libcurl-devel libsecret-devel libnotify-devel libSDL-devel zlib-devel libjpeg-devel libpng-devel]
+
+        class << self
+
+          private
+
+          def do_install(distro, pkgs)
+            run_zypper(make_install_cmd(pkgs))
+          end
+
+          def add_platform_pkgs(pkgs)
+            # add build tools
+            if pkgs.include?('g++')
+              pkgs.delete('g++')
+              pkgs << 'gcc-c++'
+            end
+            # find pkgs we need
+            PLATFORM_DEPS.inject(pkgs) { |list, pkg| list << pkg unless system("rpm -q --whatprovides #{pkg} >/dev/null 2>&1"); list }
+          end
+
+          def run_zypper(cmd)
+            run("zypper -t -i #{cmd}")
+          end
+
+          def make_install_cmd(pkgs)
+            # create install command
+            "install -y #{ pkgs.join(' ') }"
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/unixish.rb

@@ -52,32 +52,49 @@ module WXRuby3
         objs = pkg.all_obj_files.collect { |o| File.join('..', o) }.join(' ') + ' '
         depsh = pkg.dep_libnames.collect { |dl| "#{dl}.#{dll_ext}" }.join(' ')
         sh "cd lib && #{WXRuby3.config.ld} #{WXRuby3.config.ldflags(pkg.lib_target)} #{objs} #{depsh} " +
-             "#{WXRuby3.config.libs} #{WXRuby3.config.link_output_flag}#{pkg.lib_target}"
+             "#{WXRuby3.config.libs} #{WXRuby3.config.link_output_flag}#{pkg.lib_target}",
+           fail_on_error: true
+      end
+
+      def check_tool_pkgs
+        pkg_deps = super
+        pkg_deps << 'doxygen' unless system('command -v doxygen>/dev/null')
+        pkg_deps << 'swig' unless system('command -v swig>/dev/null')
+        pkg_deps
       end
 
       def get_rpath_origin
         "$ORIGIN"
       end
 
+      def expand(cmd)
+        STDERR.puts "> sh: #{cmd}" if verbose?
+        s = super
+        STDERR.puts "< #{s}" if verbose?
+        s
+      end
+
       private
 
       def wx_checkout
-        check_git
+        $stdout.print 'Checking out wxWidgets...' if run_silent?
         # clone wxWidgets GIT repository under ext_path
         chdir(ext_path) do
-          if (rc = sh("git clone https://github.com/wxWidgets/wxWidgets.git"))
+          if (rc = sh("#{get_cfg_string('git')} clone https://github.com/wxWidgets/wxWidgets.git"))
             chdir('wxWidgets') do
               tag = if @wx_version
                       "v#{@wx_version}"
                     else
-                      expand('git tag').split("\n").select { |t| (/\Av3\.(\d+)/ =~ t) && $1.to_i >= 2  }.max
+                      expand("#{get_cfg_string('git')} tag").split("\n").select { |t| (/\Av3\.(\d+)/ =~ t) && $1.to_i >= 2  }.max
                     end
               # checkout the version we are building against
-              rc = sh("git checkout #{tag}")
+              rc = sh("#{get_cfg_string('git')} checkout #{tag}")
             end
           end
-          unless rc
-            STDERR.puts "ERROR: Failed to checkout wxWidgets."
+          if rc
+            $stdout.puts 'done!' if run_silent?
+          else
+            $stderr.puts "ERROR: Failed to checkout wxWidgets."
             exit(1)
           end
         end
@@ -92,36 +109,36 @@ module WXRuby3
       end
 
       def wx_build
+        $stdout.print 'Configuring wxWidgets...' if run_silent?
         # initialize submodules
-        unless sh('git submodule update --init')
-          STDERR.puts "ERROR: Failed to update wxWidgets submodules."
+        unless sh("#{get_cfg_string('git')} submodule update --init")
+          $stderr.puts "ERROR: Failed to update wxWidgets submodules."
           exit(1)
         end
         # configure wxWidgets
         unless wx_configure
-          STDERR.puts "ERROR: Failed to configure wxWidgets."
+          $stderr.puts "ERROR: Failed to configure wxWidgets."
           exit(1)
         end
+        $stdout.puts 'done!' if run_silent?
+        $stdout.print 'Building wxWidgets...' if run_silent?
         # make and install wxWidgets
         unless wx_make
-          STDERR.puts "ERROR: Failed to build wxWidgets libraries."
+          $stderr.puts "ERROR: Failed to build wxWidgets libraries."
           exit(1)
         end
+        $stdout.puts 'done!' if run_silent?
       end
 
       def wx_generate_xml
         chdir(File.join(ext_path, 'wxWidgets', 'docs', 'doxygen')) do
-          sh({ 'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, './regen.sh xml')
+          unless sh({ 'DOXYGEN' => get_cfg_string("doxygen"),  'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, './regen.sh xml')
+            $stderr.puts 'ERROR: Failed to generate wxWidgets XML API specifications for parsing by wxRuby3.'
+            exit(1)
+          end
         end
       end
 
-      def expand(cmd)
-        STDERR.puts "> sh: #{cmd}" if verbose?
-        s = super
-        STDERR.puts "< #{s}" if verbose?
-        s
-      end
-
       # Allow specification of custom wxWidgets build (mostly useful for
       # static wxRuby3 builds)
       def get_wx_path