wxruby3 0.9.0.pre.beta.8

data/rakelib/install.rb

@@ -0,0 +1,220 @@
+###
+# wxRuby3 rake install support
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require 'optparse'
+require_relative './lib/config'
+
+module WXRuby3
+
+  module Install
+
+    class << self
+      def prefix
+        @prefix
+      end
+      def prefix=(v)
+        @prefix = v.to_s
+      end
+
+      def wxwin_shlibs
+        unless @wxwin_shlibs
+          @wxwin_shlibs = Rake::FileList.new
+          # include wxWidgets shared libraries we linked with
+          WXRuby3.config.wx_libs.select { |s| s.start_with?('-L') }.each do |libdir|
+            libdir = libdir[2..libdir.size]
+            libdir = File.join(File.dirname(libdir), 'bin').gsub('\\', '/') if WXRuby3.config.windows?
+            WXRuby3.config.wx_libs.select { |s| s.start_with?('-l') }.each do |lib|
+              lib = lib[2..lib.size]
+              if WXRuby3.config.windows?
+                # match only wxWidgets libraries
+                if (m = /\Awx_([a-z]+)(_[a-z]+)?-(.*)/.match(lib))
+                  # translate lib name to shlib name
+                  grp_id = m[1]
+                  lib_id = m[2]
+                  ver = m[3].sub('.', '')
+                  lib = "wx#{grp_id.sub(/u\Z/, '')}#{ver}u#{lib_id}"
+                  @wxwin_shlibs.include File.join(libdir, "#{lib}*.#{WXRuby3.config.dll_mask}")
+                end
+              else
+                # match only wxWidgets libraries
+                if /\Awx_([a-z\d]+)(_[a-z]+)?-(.*)/.match(lib)
+                  @wxwin_shlibs.include File.join(libdir, "lib#{lib}*.#{WXRuby3.config.dll_mask}")
+                end
+              end
+            end
+          end
+          @wxwin_shlibs = ::Set.new(@wxwin_shlibs.to_a)
+        end
+        @wxwin_shlibs
+      end
+
+      def install_wxwin_shlibs
+        if WXRuby3.config.get_config('with-wxwin')
+          # prepare required wxWidgets shared libs
+          WXRuby3::Install.wxwin_shlibs.each do |shlib|
+            if File.symlink?(shlib)
+              src_shlib = shlib
+              src_shlib = File.join(File.dirname(shlib), File.basename(File.readlink(src_shlib))) while File.symlink?(src_shlib)
+              FileUtils.ln_s(File.join('.', File.basename(src_shlib)), File.join('ext', File.basename(shlib)))
+            else
+              FileUtils.cp(shlib, inshlib = File.join('ext', File.basename(shlib)))
+              unless WXRuby3.config.patch_rpath(inshlib, '$ORIGIN')
+                # cleanup and exit
+                FileUtils.rm_f(Dir["ext/*.#{WXRuby3.config.dll_mask}"])
+                exit(1)
+              end
+            end
+          end
+          # prepare wxRuby shared libs
+          unless Dir["lib/*.#{WXRuby3.config.dll_mask}"].all? { |shlib| WXRuby3.config.patch_rpath(shlib, '$ORIGIN:$ORIGIN/../ext') }
+            # cleanup and exit
+            FileUtils.rm_f(Dir["ext/*.#{WXRuby3.config.dll_mask}"])
+            exit(1)
+          end
+        end
+      end
+
+      def remove_wxwin_shlibs
+        if WXRuby3.config.get_config('with-wxwin')
+          WXRuby3::Install.wxwin_shlibs.each { |shlib| FileUtils.rm_f(File.join('ext', File.basename(shlib))) }
+        end
+      end
+
+    end
+
+    def self.define(task, args)
+      #_argv = Rake.application.cleanup_args(ARGV) rescue exit(1)
+      OptionParser.new do |opts|
+        opts.banner = <<~__USAGE
+          Usage: rake [RAKE_OPTIONS] #{task.name}[TASK_OPTIONS] [NO_HARM=1]
+
+          TASK_OPTIONS need to be specified as '<taskname>[<opt>,<opt>,...]' without whitespaces.
+          In case whitespaces are needed enclose the entire string in "" like "<taskname>[<opt>,<opt>,...]".
+          __USAGE
+
+        opts.separator ""
+
+        opts.on('--prefix=path',
+                "path prefix of target environment (default #{Install.prefix ? "'#{Install.prefix}'" : 'unset'})") {|v| Install.prefix = File.expand_path(v) }
+
+        opts.separator ""
+
+        opts.on('--help', 'Show this help message') { puts opts; puts; exit }
+
+        opts.separator ""
+
+        opts.separator "\tAdding 'NO_HARM=1' will run the command without actually executing any\n\tactions but only printing what it would do."
+
+      end.parse!(args.extras.dup)
+    end
+
+    def self.nowrite(v = nil)
+      # need to do this because of Rake version differences
+      rv = Rake.__send__ :nowrite
+      Rake.__send__(:nowrite, v) if v
+      if block_given?
+        begin
+          yield
+        ensure
+          Rake.__send__(:nowrite, rv)
+        end
+      end
+      rv
+    end
+
+    def self.verbose
+      Rake.__send__ :verbose
+    end
+
+    def self.specs
+      specs = [
+        [WXRuby3.config.get_cfg_string('siterubyver'), ['lib/wx.rb'], 0644],
+        [File.join(WXRuby3.config.get_cfg_string('siterubyver'), 'wx'), ['lib/wx'], 0644],
+      ]
+      # add wxRuby shared libraries
+      WXRuby3::Director.each_package { |pkg| specs << [WXRuby3.config.get_cfg_string('siterubyverarch'), [pkg.lib_target], 0555] }
+      if WXRuby3.config.get_config('with-wxwin')
+        specs << [WXRuby3.config.get_cfg_string('siterubyverarch'), Install.wxwin_shlibs, 0555]
+      end
+      specs
+    end
+
+    def self.install
+      WXRuby3::Install.specs.each do |dest, srclist, mode, match|
+        srclist.each do |src|
+          if File.directory?(src)
+            install_dir(src, dest, mode, match)
+          else
+            install_file(src, dest, mode, match)
+          end
+        end
+      end
+    end
+
+    def self.uninstall
+      WXRuby3::Install.specs.each do |dest, srclist, _mode, match|
+        srclist.each do |src|
+          if File.directory?(src)
+            uninstall_dir(src, dest, match)
+          else
+            uninstall_file(src, dest, match)
+          end
+        end
+      end
+    end
+
+  end
+
+  module InstallMethods
+
+    def install_file(src, dest, mode, match)
+      return unless match.nil? || match.call(src)
+      dest = File.join(Install.prefix, dest) if Install.prefix
+      FileUtils.mkdir_p(dest, :noop => nowrite, :verbose => verbose) unless File.directory?(dest)
+      FileUtils.install(src, dest, :mode => mode, :noop => nowrite, :verbose => verbose)
+    end
+    def install_dir(dir, dest, mode, match)
+      return unless match.nil? || match.call(dir)
+      FileUtils.chdir(dir, :verbose => verbose) do
+        Dir['*'].each do |entry|
+          if File.directory?(entry)
+            install_dir(entry, File.join(dest, entry), mode, match)
+          else
+            install_file(entry, dest, mode, match)
+          end
+        end
+      end
+    end
+    def uninstall_file(src, dest, match)
+      return unless match.nil? || match.call(src)
+      dest = File.join(Install.prefix, dest) if Install.prefix
+      dst_file = File.join(dest, File.basename(src))
+      if nowrite || File.file?(dst_file)
+        if nowrite || FileUtils.compare_file(src, dst_file)
+          FileUtils.rm_f(dst_file, :noop => nowrite, :verbose => verbose)
+        else
+          STDERR.puts "ALERT: source (#{src}) differs from installed file (#{dst_file})"
+        end
+      end
+    end
+    def uninstall_dir(dir, dest, match)
+      return unless match.nil? || match.call(dir)
+      FileUtils.chdir(dir, :verbose => verbose) do
+        Dir['*'].each do |entry|
+          if File.directory?(entry)
+            uninstall_dir(entry, File.join(dest, entry), match)
+          else
+            uninstall_file(entry, dest, match)
+          end
+        end
+      end
+      FileUtils.rmdir(dest, :noop => nowrite, :verbose => verbose)
+    end
+
+  end
+
+  Install.singleton_class.include WXRuby3::InstallMethods
+
+end

data/rakelib/lib/config/cygwin.rb

@@ -0,0 +1,6 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+raise "Cygwin platform is unsupported as yet."

data/rakelib/lib/config/linux.rb

@@ -0,0 +1,78 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './unixish'
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      def self.included(base)
+        base.class_eval do
+          include Config::UnixLike
+          alias :base_ldflags :ldflags
+          def ldflags(target)
+            "-Wl,-soname,#{File.basename(target)} #{base_ldflags(target)}"
+          end
+
+          def debug_command(*args)
+            args.unshift(FileUtils::RUBY)
+            args.unshift('--args')
+            args.unshift('gdb')
+            args.join(' ')
+          end
+
+          def check_rpath_patch
+            unless @rpath_patch
+              if system('which patchelf > /dev/null 2>&1')
+                @rpath_patch = 'patchelf --set-rpath'
+              else
+                STDERR.puts 'Installation of binary gem with-wxwin requires an installed version of either the patchelf utility.'
+                return false
+              end
+            end
+            true
+          end
+
+          def patch_rpath(shlib, rpath)
+            if check_rpath_patch
+              sh("#{@rpath_patch} '#{rpath}' #{shlib}", verbose: false)
+              return true
+            end
+            false
+          end
+        end
+      end
+
+      def init_platform
+        init_unix_platform
+
+        @dll_pfx = 'lib'
+
+        if @wx_version
+          @extra_cflags.concat %w[-Wno-unused-function -Wno-conversion-null -Wno-maybe-uninitialized]
+          @extra_cflags << ' -Wno-deprecated-declarations' unless @no_deprecated
+
+          # create a .so binary
+          @extra_ldflags << '-shared'
+
+          # This class is not available on linux ports (wxGTK/wxQT/wxX11/wxMotif)
+          exclude_module('wxPrinterDC')
+
+          unless @wx_path.empty?
+            libdirs = @wx_libs.select {|s| s.start_with?('-L')}.collect {|s| s.sub(/^-L/,'')}
+            @exec_env['LD_LIBRARY_PATH'] = "#{ENV['LD_LIBRARY_PATH']}:#{dest_dir}:#{libdirs.join(':')}"
+          end
+        end
+      end
+      private :init_platform
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/macosx.rb

@@ -0,0 +1,6 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+raise "MacOSX platform is unsupported as yet."

data/rakelib/lib/config/mingw.rb

@@ -0,0 +1,133 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './unixish'
+
+if ENV['RI_DEVKIT'].nil?
+  begin
+    require 'devkit'
+  rescue LoadError
+    STDERR.puts "Missing a fully installed & configured Ruby devkit. Make sure to install the Ruby devkit with MSYS2 and MINGW toolchains."
+    exit(1)
+  end
+end
+
+module WXRuby3
+
+  module Config
+
+    module Platform
+
+      def self.included(base)
+        base.include Config::UnixLike
+        base.class_eval do
+
+          attr_reader :rescomp
+
+          alias :base_ldflags :ldflags
+          def ldflags(target)
+            "-Wl,-soname,#{File.basename(target)} #{base_ldflags(target)}"
+          end
+
+          def debug_command(*args)
+            args.unshift(FileUtils::RUBY)
+            args.unshift('--args')
+            args.unshift('gdb')
+            args.join(' ')
+          end
+
+          # override accessor to guarantee win path
+          def wx_setup_h
+            if @wx_setup_h.index('/')
+              @wx_setup_h = win_path(@wx_setup_h)
+            end
+            @wx_setup_h
+          end
+
+          def dll_mask
+            "{#{dll_ext},dll}"
+          end
+
+          private
+
+          def wx_generate_xml
+            chdir(File.join(ext_path, 'wxWidgets', 'docs', 'doxygen')) do
+              sh({ 'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, 'regen.bat xml')
+            end
+          end
+
+          def respawn_rake(argv = ARGV)
+            Kernel.exec('rake', *argv)
+          end
+
+          def expand(cmd)
+            super("bash -c \"#{cmd}\"")
+          end
+
+          def bash(*cmd, **kwargs)
+            env = ::Hash === cmd.first ? cmd.shift : nil
+            opts = ::Hash === cmd.last ? cmd.pop : nil
+            cmd = ['bash', '-c', cmd.join(' ')]
+            cmd.unshift(env) if env
+            super(*cmd, **kwargs)
+          end
+
+          def nix_path(winpath)
+            (winpath.nil? || winpath.empty?) ? '' : `cygpath -a -u #{winpath}`.strip
+          end
+
+          # Allow specification of custom wxWidgets build (mostly useful for
+          # static wxRuby3 builds)
+          def win_path(nixpath)
+            (nixpath.nil? || nixpath.empty?) ? '' : `cygpath -a -w #{nixpath}`.strip
+          end
+
+          def get_wx_path
+            nix_path(super)
+          end
+
+        end
+      end
+
+      def init_platform
+        init_unix_platform
+
+        if @wx_version
+          # need to convert these to windows paths
+          @wx_cppflags.each { |flags| flags.gsub!(/-I(\S+)/) { |s| "-I#{win_path($1)}" } }
+          @wx_libs.each { |libflag| libflag.gsub!(/-L(\S+)/) { |s| "-L#{win_path($1)}" } }
+
+          @extra_cflags.concat %w[-Wno-unused-function -Wno-conversion-null -Wno-maybe-uninitialized]
+          @extra_cflags << ' -Wno-deprecated-declarations' unless @no_deprecated
+
+          # create a .dll binary
+          @extra_ldflags << '-shared'
+
+          @ruby_ldflags.each { |flags| flags.sub!(' $(DEFFILE)', '') } # cleanup for older RubyInstaller versions
+          @ruby_ldflags.each { |flags| flags.gsub!(/-s(\s|\Z)/, '') } if @debug_build # do not strip debug symbols for debug build
+          @ruby_cppflags << RB_CONFIG['debugflags'] if @debug_build
+          @ruby_cppflags.each { |flags| flags.gsub!(/-O\d/, '-O0') } if @debug_build # disable optimizations for debug build
+
+          unless @wx_path.empty?
+            exec_pfx = win_path(wx_config("--exec-prefix"))
+            libdirs = [File.join(exec_pfx, 'bin')]
+            libdirs << win_path(File.join(ENV['MSYSTEM_PREFIX'], 'bin'))
+            @exec_env['RUBY_DLL_PATH'] = "#{ENV['RUBY_DLL_PATH']};#{dest_dir};#{libdirs.join(';')}"
+          end
+
+          @rescomp = wx_config('--rescomp').gsub(/--include-dir\s+(\S+)/) { |s| "--include-dir #{win_path($1)}" }
+          @rescomp << " --include-dir #{@ext_path}"
+          @rescomp << ' --define __WXMSW__ --define wxUSE_DPI_AWARE_MANIFEST=2 --define wxUSE_RC_MANIFEST=1 --define ISOLATION_AWARE_ENABLED'
+          @rescomp << ' --define WXUSINGDLL'
+          @extra_cflags << '-DISOLATION_AWARE_ENABLED'
+        end
+      end
+      private :init_platform
+
+    end
+
+  end
+
+end

data/rakelib/lib/config/netbsd.rb

@@ -0,0 +1,6 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+raise "NETBSD platform is unsupported as yet."

data/rakelib/lib/config/unixish.rb

@@ -0,0 +1,187 @@
+###
+# wxRuby3 buildtools configuration
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require 'set'
+
+module WXRuby3
+
+  module Config
+
+    # Common code for platforms that use wx-config (basically, everything
+    # not MSW)
+    module UnixLike
+
+      def check_wx_config
+        !expand("which #{@wx_config} 2>/dev/null").chomp.empty?
+      end
+
+      # Helper function that runs the wx-config command line program from
+      # wxWidgets to determine suitable builds and build options. Passed an
+      # option which corresponds to one of the command-line options to
+      # wx-config, eg '--list' or '--libs'. See --help for that program.
+      def wx_config(option)
+        #
+        if @release_build
+          debug_mode = '--debug=no'
+        elsif @debug_build
+          debug_mode = '--debug=yes'
+        end
+
+        cfg = expand("#{@wx_config} #{debug_mode} --static=no #{option} 2>&1")
+
+        # Check status for errors
+        unless $?.exitstatus.zero?
+          if cfg =~ /Warning: No config found to match:([^\n]*)/
+            STDERR.puts "ERROR: No suitable wxWidgets found for specified build options " +
+                          "(#{$1.strip})"
+          else
+            STDERR.puts "ERROR: wx-config error (#{cfg})"
+          end
+          exit(1)
+        end
+
+        return cfg.strip
+      end
+
+      def do_link(pkg)
+        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}"
+      end
+
+      private
+
+      def wx_checkout
+        check_git
+        # clone wxWidgets GIT repository under ext_path
+        chdir(ext_path) do
+          if (rc = sh("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
+                    end
+              # checkout the version we are building against
+              rc = sh("git checkout #{tag}")
+            end
+          end
+          unless rc
+            STDERR.puts "ERROR: Failed to checkout wxWidgets."
+            exit(1)
+          end
+        end
+      end
+
+      def wx_build
+        # initialize submodules
+        unless sh('git submodule update --init')
+          STDERR.puts "ERROR: Failed to update wxWidgets submodules."
+          exit(1)
+        end
+        # configure wxWidgets
+        unless bash('./configure --prefix=`pwd`/install --disable-tests --without-subdirs --disable-debug_info')
+          STDERR.puts "ERROR: Failed to configure wxWidgets."
+          exit(1)
+        end
+        # make and install wxWidgets
+        unless bash('make && make install')
+          STDERR.puts "ERROR: Failed to build wxWidgets libraries."
+          exit(1)
+        end
+      end
+
+      def wx_generate_xml
+        chdir(File.join(ext_path, 'wxWidgets', 'docs', 'doxygen')) do
+          sh({ 'WX_SKIP_DOXYGEN_VERSION_CHECK' => '1' }, './regen.sh xml')
+        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
+        get_config('with-wxwin') && get_cfg_string('wxwin').empty? ? File.join(ext_path, 'wxWidgets', 'install') : get_cfg_string('wxwin')
+      end
+
+      def get_wx_xml_path
+        get_cfg_string('wxxml')
+      end
+
+      def init_unix_platform
+        # Allow specification of custom wxWidgets build (mostly useful for
+        # static wxRuby3 builds)
+        @wx_path = get_wx_path
+
+        STDERR.puts "> wx_path = '#{@wx_path}'" if verbose?
+
+        @wx_xml_path = get_wx_xml_path
+
+        @wx_config = @wx_path.empty? ? 'wx-config' : File.join(@wx_path, 'bin', 'wx-config')
+
+        if check_wx_config
+          # Now actually run the program to fill in some variables
+          @wx_version  = wx_config('--version')
+          @wx_port = case wx_config('--selected-config')
+                     when /\Agtk/
+                       :wxGTK
+                     when /\Aqt/
+                       :wxQT
+                     when /\Ax11/
+                       :wxX11
+                     when /\Amotif/
+                       :wxMOTIF
+                     when /\Amsw/
+                       :wxMSW
+                     when /\Aosx/
+                       :wxOSX
+                     else
+                       nil
+                     end
+          @wx_cppflags = wx_config('--cppflags').split(' ')
+
+          # Find out where the wxWidgets setup.h file being used is located
+          setup_inc_dir = @wx_cppflags.find { |flag| flag =~ /^-I\S+/ }[2..-1]
+          @wx_setup_h  = File.join(setup_inc_dir, 'wx', 'setup.h')
+
+          @cpp         = wx_config("--cxx")
+          @ld          = wx_config("--ld")
+          wx_libset = ::Set.new
+          wx_libset.merge wx_config("--libs all").split(' ')
+          # some weird thing with this; at least sometimes '--libs all' will not output media library even if feature active
+          if features_set?('wxUSE_MEDIACTRL')
+            wx_libset.merge wx_config("--libs media").split(' ')
+          end
+          @wx_libs = wx_libset.collect { |s| s.dup }
+
+          # remove all warning flags provided by Ruby config
+          @ruby_cppflags = @ruby_cppflags.collect { |flags| flags.split(' ') }.flatten.
+            select { |o| !o.start_with?('-W') || o.start_with?('-Wl,') }
+          @ruby_cppflags.concat %w[-Wall -Wextra -Wno-unused-parameter]   # only keep these
+          # add include flags
+          @ruby_cppflags.concat ['-I.', *@ruby_includes.collect { |inc| "-I#{inc}" }]
+          @ruby_ldflags << '-s' if @release_build                         # strip debug symbols for release build
+          @ruby_ldflags << "-Wl,-rpath,\\$ORIGIN/../lib"                  # add default rpath
+          @ruby_libs <<  "-L#{RB_CONFIG['libdir']}"                       # add ruby lib dir
+          # add ruby defined shared ruby lib(s); not any other flags
+          @ruby_libs.concat RB_CONFIG['LIBRUBYARG_SHARED'].split(' ').select { |s| s.start_with?('-l')}
+
+          # maintain minimum compatibility with ABI 3.0.0
+          @wx_abi_version = [ @wx_version, "3.0.0" ].min
+          @wx_cppflags << "-DwxABI_VERSION=%s" % @wx_abi_version.tr(".", "0")
+        end
+      end
+    end
+
+  end
+
+end