wxruby3 1.7.0 → 1.8.1

data/rakelib/lib/config/mingw.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+  # Copyright (c) 2023 M.J.N. Corino, The Netherlands
 #
 # This software is released under the MIT license.
 
@@ -10,6 +10,7 @@ require_relative './unixish'
 require_relative 'pkgman/mingw'
 
 require 'uri'
+require 'digest/sha2'
 
 
 if ENV['RI_DEVKIT'].nil?
@@ -31,6 +32,12 @@ module WXRuby3
         base.class_eval do
           include Config::UnixLike
 
+          const_set(:WEBVIEW2_VERSION, '1.0.3485.44')
+          const_set(:WEBVIEW2_URL, "https://www.nuget.org/api/v2/package/Microsoft.Web.WebView2/#{const_get(:WEBVIEW2_VERSION)}")
+          const_set(:WEBVIEW2_INCLUDE, File.join('3rdparty','webview2','build','native','include','WebView2.h'))
+          const_set(:WEBVIEW2_LOADER, File.join('3rdparty','webview2','build','native',(RB_CONFIG["arch"] =~ /x64/ ? 'x64' : 'x86'),'WebView2Loader.dll'))
+          const_set(:WEBVIEW2_SHA256, 'BC09150B179246AC90189649B13BE8E6B11B3AC200E817E18DF106E1F3CF489E')
+
           attr_reader :rescomp
 
           alias :base_ldflags :ldflags
@@ -39,7 +46,7 @@ module WXRuby3
           end
 
           def debug_command(*args)
-            args.unshift(nix_path(FileUtils::RUBY))
+            args.unshift(FileUtils::RUBY)
             args.unshift('--args')
             args.unshift('gdb')
             args.join(' ')
@@ -80,7 +87,7 @@ module WXRuby3
           def install_prerequisites
             pkg_deps = super
             PkgManager.install(pkg_deps)
-            []
+            pkg_deps
           end
 
           def expand(cmd)
@@ -97,12 +104,66 @@ module WXRuby3
 
           private
 
+          def wx_checkout
+            super
+            # do we need to build an embedded wxWidgets?
+            if get_config('with-wxwin') && get_cfg_string('wxwin').empty?
+              # then check webview requirements
+              if wx_with_webview_backend?('edge')
+                # download and install Edge WebView2 SDK
+                chdir(File.join(ext_path, 'wxWidgets')) do
+                  FileUtils.mkdir_p(File.join('3rdparty', 'webview2'))
+                  if download_file(self.class::WEBVIEW2_URL, File.join('3rdparty', 'webview2', 'webview2_sdk.zip'))
+                    chdir(File.join('3rdparty', 'webview2')) do
+                      # check digest
+                      File.open('webview2_sdk.zip', 'r', binmode: true) do |fin|
+                        # check digest signature
+                        digest = Digest::SHA256.new
+                        while (data = fin.read(1024*1024))
+                          digest << data
+                        end
+                        if self.class::WEBVIEW2_SHA256 != digest.hexdigest!.upcase
+                          $stderr.puts 'ERROR: WebView2 SDK package digest signature does NOT match.'
+                          exit(1)
+                        end
+                      end
+                      unless sh("unzip webview2_sdk.zip")
+                        STDERR.puts 'ERROR: Failed to unpack required WebView2 SDK.'
+                        exit(1)
+                      end
+                    end
+                    unless File.exist?(self.class::WEBVIEW2_INCLUDE)
+                      STDERR.puts 'ERROR: Error in required WebView2 SDK.'
+                      exit(1)
+                    end
+                  else
+                    STDERR.puts 'ERROR: Failed to download required WebView2 SDK.'
+                    exit(1)
+                  end
+                end
+              end
+            end
+          end
+
           def wx_configure
-            bash('./configure --prefix=`pwd`/install --disable-tests --without-subdirs --without-regex --without-libcurl --with-expat=builtin --with-zlib=builtin --disable-debug_info')
+            bash("./configure --prefix=`pwd`/install --disable-tests --without-subdirs " \
+                   "--without-regex --without-libcurl --with-expat=builtin --with-zlib=builtin " \
+                   "--disable-debug_info #{wx_with_webview?  ? '--enable-webview' : '--disable-webview'} " \
+                   "#{wx_with_webview_backend?('edge') ? '--enable-webviewedge ' : '--disable-webviewedge '} " \
+                   "#{!get_config('with-webview').nil? && wx_with_webview_backend?('ie') ? '--enable-webviewie ' : '--disable-webviewie'} ")
           end
 
           def wx_make
-            bash('make && make install')
+            if bash('make && make install')
+              # in case of an embedded wxWidgets with WebView SDK backend
+              if get_config('with-wxwin') && get_cfg_string('wxwin').empty? && wx_with_webview_backend?('edge')
+                # we need to copy the WebView2 loader dll to the install bin folder
+                FileUtils.cp(self.class::WEBVIEW2_LOADER, File.join('install', 'bin'))
+              end
+              true
+            else
+              false
+            end
           end
 
           def wx_generate_xml

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

@@ -43,9 +43,11 @@ module WXRuby3
         end
 
         PLATFORM_DEPS = {
-          debian: PlatformDependencies.new(%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])
-                                      .add('debian', %w[libgtk-3-dev libwebkit2gtk-4.1-dev libgspell-1-dev libunwind-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libcurl4-openssl-dev libsecret-1-dev libnotify-dev], release: '13')
+          debian: PlatformDependencies.new(%w[libgtk-3-dev libwebkit2gtk-4.[0-9]+-dev libgspell-1-dev libunwind-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libcurl4-openssl-dev libsecret-1-dev libnotify-dev])
+                                      .add('debian', %w[libgtk-3-dev libwebkit2gtk-4.1-dev libgspell-1-dev libunwind-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libcurl4-openssl-dev libsecret-1-dev libnotify-dev], release: '12')
+                                      .alias('debian', '12', 'debian', '13')
                                       .add('ubuntu', %w[libgtk-3-dev libwebkit2gtk-4.1-dev libgspell-1-dev libunwind-dev libgstreamer1.0-dev libgstreamer-plugins-base1.0-dev libcurl4-openssl-dev libsecret-1-dev libnotify-dev], release: '24.04')
+                                      .alias('ubuntu', '24.04', 'ubuntu', '26.04')
                                       .alias('ubuntu', '24.04', 'linuxmint', '22')
                                       .alias('ubuntu', '24.04', 'linuxmint', '22.1')
                                       .alias('ubuntu', '24.04', 'linuxmint', '22.2')

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

@@ -14,7 +14,7 @@ module WXRuby3
 
       module PkgManager
 
-        XTRA_PLATFORM_DEPS = %w[python]
+        XTRA_PLATFORM_DEPS = %w[python unzip curl]
 
         class << self
 

data/rakelib/lib/config/unixish.rb

@@ -70,7 +70,7 @@ module WXRuby3
 
       # add deployment lookup paths for wxruby shared libraries
       def update_shlib_loadpaths(shlib)
-        WXRuby3.config.patch_rpath(shlib, WXRuby3.config.get_rpath_origin, "#{WXRuby3.config.get_rpath_origin}/../ext")
+        WXRuby3.config.patch_rpath(shlib, WXRuby3.config.get_rpath_origin, "#{WXRuby3.config.get_rpath_origin}/../ext/lib")
       end
 
       def expand(cmd)
@@ -110,7 +110,9 @@ module WXRuby3
       end
 
       def wx_configure
-        bash('./configure --prefix=`pwd`/install --disable-tests --without-subdirs --without-regex --disable-debug_info')
+        bash("./configure --prefix=`pwd`/install --disable-tests " \
+               "--without-subdirs --without-regex --disable-debug_info " \
+               "#{wx_with_webview? ? '--enable-webview' : '--disable-webview'}")
       end
 
       def wx_make

data/rakelib/lib/config.rb

@@ -116,6 +116,12 @@ module WXRuby3
 
   WXWIN_MINIMUM = '3.2.0'
 
+  WX_WEBVIEW_BACKENDS = {
+    macosx: ['webkit'],
+    linux: ['webkit'],
+    mingw: ['ie', 'edge']
+  }
+
   module Config
 
     def self.command_to_s(*cmd)
@@ -361,7 +367,7 @@ module WXRuby3
             test = File.join(Config.instance.test_dir, test)
             test = Dir.glob(test+'.rb').shift || test unless File.exist?(test)
           end
-          Rake.sh(Config.instance.exec_env.merge({'RUBYLIB'=>rb_lib_path}), FileUtils::RUBY, test) { |ok,status| errors << File.basename(test, '.rb') unless ok }
+          Rake.sh(exec_env, *make_ruby_cmd(*(ENV['TESTOPTS'] ? [test, ENV['TESTOPTS']] : [test]), verbose: verbose?)) { |ok,_| errors << File.basename(test, '.rb') unless ok }
         end
       end
       fail "ERRORS: ##{errors.size} test scripts failed.\n\t#{errors.join("\n\t")}" unless errors.empty?
@@ -444,6 +450,14 @@ module WXRuby3
       Config.clear_config(key)
     end
 
+    def wx_with_webview?
+      Config.wx_with_webview?
+    end
+
+    def wx_with_webview_backend?(backend)
+      Config.wx_with_webview_backend?(backend)
+    end
+
     def dll_mask
       "#{dll_ext}*"
     end
@@ -733,10 +747,21 @@ module WXRuby3
             @wx_version || ''
           end
 
-          def wx_version_check(ver)
+          def wx_version_list
             @wx_version_list ||= (@wx_version || '0.0.0').split('.').collect {|s| s.to_i }
+          end
+
+          def wx_version_check(ver)
             ver = ver.split('.').collect {|s| s.to_i }  unless ::Array === ver
-            @wx_version_list <=> ver
+            wx_version_list <=> ver
+          end
+
+          def wx_plugin_path
+            @wx_plugin_path ||= if (wx_version_list[1] % 2) == 0
+                                  File.join('wx', "#{wx_version_list[0]}.#{wx_version_list[1]}")
+                                else
+                                  File.join('wx', wx_version)
+                                end
           end
 
           def mingw?
@@ -909,6 +934,15 @@ module WXRuby3
         WXRuby3::CONFIG.delete(key.to_s)
       end
 
+      def wx_with_webview?
+        get_config('with-webview') != false
+      end
+
+      def wx_with_webview_backend?(backend)
+        v = get_config('with-webview')
+        v.nil? || v == true || (v.is_a?(Array) && v.include?(backend))
+      end
+
       def is_configured?
         instance.is_configured?
       end

data/rakelib/lib/core/include/client_data.inc

@@ -6,21 +6,53 @@
 #define WXRUBY_EXPORT WXRB_EXPORT_FLAG
 #endif
 
+#include "wxruby-runtime.h"
 #include "wxruby-ClientData.h"
 
 #include <set>
 
-static std::set<wxRubyClientData*> __s_WxRubyClientDataSet;
-static std::set<wxRubyUserData*> __s_WxRubyUserDataSet;
+static bool __s_RubyClientDataMarker_Registered = false;
+static bool __s_RubyUserDataMarker_Registered = false;
+
+static const std::string WXRUBY_CLIENT_DATA = { "WXRUBY_CLIENT_DATA" };
+static const std::string WXRUBY_USER_DATA = { "WXRUBY_USER_DATA" };
+
+static void wxRuby_GC_mark_ClientData(const TGCTrackingValueMap& values)
+{
+  for (const auto& ti : values)
+  {
+    wxRubyClientData* pcd = static_cast<wxRubyClientData*> (ti.first);
+    rb_gc_mark(pcd->GetData());
+  }
+}
+
+static void wxRuby_GC_mark_UserData(const TGCTrackingValueMap& values)
+{
+  for (const auto& ti : values)
+  {
+    wxRubyUserData* pud = static_cast<wxRubyUserData*> (ti.first);
+    rb_gc_mark(pud->GetData());
+  }
+}
 
 WXRB_EXPORT_FLAG void wxRuby_RegisterClientData(wxRubyClientData* pcd)
 {
-  __s_WxRubyClientDataSet.insert(pcd);
+  if (!__s_RubyClientDataMarker_Registered)
+  {
+    wxRuby_RegisterTrackingCategory(WXRUBY_CLIENT_DATA, wxRuby_GC_mark_ClientData, true);
+    __s_RubyClientDataMarker_Registered = true;
+  }
+  wxRuby_RegisterCategoryValue(WXRUBY_CLIENT_DATA, pcd, Qnil);
 }
 
 WXRB_EXPORT_FLAG void wxRuby_RegisterUserData(wxRubyUserData* pud)
 {
-  __s_WxRubyUserDataSet.insert(pud);
+  if (!__s_RubyUserDataMarker_Registered)
+  {
+    wxRuby_RegisterTrackingCategory(WXRUBY_USER_DATA, wxRuby_GC_mark_UserData, true);
+    __s_RubyUserDataMarker_Registered = true;
+  }
+  wxRuby_RegisterCategoryValue(WXRUBY_USER_DATA, pud, Qnil);
 }
 
 static ID client_data_unlinked_id()
@@ -36,7 +68,7 @@ static ID client_data_unlinked_id()
 WXRB_EXPORT_FLAG void wxRuby_UnregisterClientData(wxRubyClientData* pcd)
 {
   VALUE rbcd = pcd->GetData();
-  __s_WxRubyClientDataSet.erase(pcd);
+  wxRuby_UnregisterCategoryValue(WXRUBY_CLIENT_DATA, pcd);
   if (!NIL_P(rbcd) && rb_respond_to(rbcd, client_data_unlinked_id()))
   {
     wxRuby_Funcall(rbcd, client_data_unlinked_id(), 0);
@@ -46,20 +78,9 @@ WXRB_EXPORT_FLAG void wxRuby_UnregisterClientData(wxRubyClientData* pcd)
 WXRB_EXPORT_FLAG void wxRuby_UnregisterUserData(wxRubyUserData* pud)
 {
   VALUE rbud = pud->GetData();
-  __s_WxRubyUserDataSet.erase(pud);
+  wxRuby_UnregisterCategoryValue(WXRUBY_USER_DATA, pud);
   if (!NIL_P(rbud) && rb_respond_to(rbud, client_data_unlinked_id()))
   {
     wxRuby_Funcall(rbud, client_data_unlinked_id(), 0);
   }
 }
-
-static void wxRuby_GC_mark_ClientData()
-{
-  for (wxRubyClientData* pcd : __s_WxRubyClientDataSet)
-    rb_gc_mark(pcd->GetData());
-  for (wxRubyUserData* pud : __s_WxRubyUserDataSet)
-    rb_gc_mark(pud->GetData());
-}
-
-typedef void (*WXRBMarkFunction)();
-WXRUBY_EXPORT void wxRuby_AppendMarker(WXRBMarkFunction marker);

data/rakelib/lib/core/include/funcall.inc

@@ -78,7 +78,7 @@ protected:
         // handle exception
         VALUE rexc = this->get_exception ();
         wxRuby_PrintException(rexc);
-        ::exit(255);
+        ::exit(127);
       }
       else
       {

data/rakelib/lib/core/include/swigdirector.inc

@@ -220,19 +220,19 @@ namespace Swig
   void DirectorTypeMismatchException::raise(VALUE error, const char *msg)
   {
     print(DirectorTypeMismatchException(error, msg));
-    ::exit(254);
+    ::exit(126);
   }
 
   void DirectorTypeMismatchException::raise(const char *msg)
   {
     print(DirectorTypeMismatchException(msg));
-    ::exit(254);
+    ::exit(126);
   }
 
   void DirectorTypeMismatchException::raise(VALUE self, const char* method, VALUE error, const char *msg)
   {
     print(DirectorTypeMismatchException(self, method, error, msg));
-    ::exit(254);
+    ::exit(126);
   }
 
   /* Any Ruby exception that occurs during a director method call */

data/rakelib/lib/core/include/swigrubyrun.inc

@@ -10,44 +10,32 @@
 extern "C" {
 #endif
 // Shared custom swig tracking functions
+WXRB_EXPORT_FLAG void wxRuby_InitializeTracking();
 WXRB_EXPORT_FLAG void wxRuby_AddTracking(void* ptr, VALUE object);
 WXRB_EXPORT_FLAG VALUE wxRuby_FindTracking(void* ptr);
 WXRB_EXPORT_FLAG void wxRuby_RemoveTracking(void* ptr);
-WXRB_EXPORT_FLAG void wxRuby_IterateTracking( void(*meth)(void* ptr, VALUE obj) );
-/* Setup a Ruby hash table to store Trackings - mostly done in wx.i */
-SWIGRUNTIMEINLINE void SWIG_RubyInitializeTrackings(void)
-{
-  // no-op
-}
+WXRB_EXPORT_FLAG void wxRuby_UnlinkObject(void* ptr);
+
+/* Setup a Ruby hash table to store Trackings */
+#define SWIG_RubyInitializeTrackings()
+
 /* Add a Tracking from a C/C++ struct to a Ruby object */
-SWIGRUNTIMEINLINE void SWIG_RubyAddTracking(void* ptr, VALUE object)
-{
-  wxRuby_AddTracking(ptr, object);
-}
+#define SWIG_RubyAddTracking wxRuby_AddTracking
+
 /* Get the Ruby object that owns the specified C/C++ struct */
-SWIGRUNTIMEINLINE VALUE SWIG_RubyInstanceFor(void* ptr)
-{
-  return wxRuby_FindTracking(ptr);
-}
+#define SWIG_RubyInstanceFor wxRuby_FindTracking
+
 /* Remove a Tracking from a C/C++ struct to a Ruby object.  It
    is very important to remove objects once they are destroyed
    since the same memory address may be reused later to create
    a new object. */
-SWIGRUNTIMEINLINE void SWIG_RubyRemoveTracking(void* ptr)
-{
-  wxRuby_RemoveTracking(ptr);
-}
+#define SWIG_RubyRemoveTracking wxRuby_RemoveTracking
+
 /* This is a helper method that unlinks a Ruby object from its
    underlying C++ object.  This is needed if the lifetime of the
    Ruby object is longer than the C++ object */
-SWIGRUNTIMEINLINE void SWIG_RubyUnlinkObjects(void* ptr)
-{
-  VALUE object = SWIG_RubyInstanceFor(ptr);
-  if (object != Qnil)
-  {
-    DATA_PTR(object) = 0;
-  }
-}
+#define SWIG_RubyUnlinkObjects wxRuby_UnlinkObject
+
 #ifdef __cplusplus
 }
 #endif

data/rakelib/lib/core/package.rb

@@ -418,8 +418,6 @@ module WXRuby3
                 fsrc.puts %Q{rb_define_const(mWxSetup, "#{feature}", Q#{val});}
               end
               fsrc.puts
-              # install wxRubyClientData marker
-              fsrc.puts %Q{wxRuby_AppendMarker(wxRuby_GC_mark_ClientData);}
             else
               fsrc.puts %Q{#{module_variable} = rb_define_module_under(wxRuby_Core(), "#{name}");}
               # record package submodule in main module's list

data/rakelib/lib/director/app.rb

@@ -152,20 +152,13 @@ module WXRuby3
           // Prevents the App being destroyed prematurely when Ruby exits down with
           // an exception. Otherwise GC destroys the C++ object, which can still
           // be needed for final WxWidgets events.
-          %markfunc wxApp "wxRubyApp::mark_wxRubyApp";
+          %markfunc wxApp "wxRubyApp::GC_mark_wxRubyApp";
           __HEREDOC
         spec.add_header_code <<~__HEREDOC
           extern void GC_SetWindowDeleted(void*);
           extern "C" void Init_wxRubyStockObjects();
           extern void wxRuby_MarkProtectedEvtHandlerProcs();
 
-          static wxVector<WXRBMarkFunction> WXRuby_Mark_List;
-
-          WXRUBY_EXPORT void wxRuby_AppendMarker(WXRBMarkFunction marker)
-          {
-            WXRuby_Mark_List.push_back(marker);
-          }
-
           #include "wxRubyApp.h"          
 
           WXRUBY_EXPORT bool wxRuby_IsAppRunning()

data/rakelib/lib/director/art_provider.rb

@@ -29,10 +29,14 @@ module WXRuby3
           typedef wxString wxArtID;
           typedef wxString wxArtClient;
 
-          // Missing from docs
-          %constant const char* wxART_STOP = wxART_STOP;
-          %constant const char* wxART_REFRESH = wxART_REFRESH;
           __HEREDOC
+        if Config.instance.wx_version_check('3.3.2') <= 0
+          spec.add_swig_code <<~__HEREDOC
+            // Missing from docs
+            %constant const char* wxART_STOP = wxART_STOP;
+            %constant const char* wxART_REFRESH = wxART_REFRESH;
+            __HEREDOC
+        end
         spec.map *%w[wxArtID wxArtClient], as: 'String', swig: false do
           map_in
           map_out

data/rakelib/lib/director/comboctrl.rb

@@ -82,11 +82,6 @@ module WXRuby3
             }
             return rb_cpp;
           }
-
-          static void wxRuby_markComboPopups()
-          {
-            WxRubyComboPopup::GC_mark_combo_popups();
-          }
           __HEREDOC
         # ignore these
         spec.ignore 'wxComboCtrl::SetPopupControl',
@@ -110,8 +105,6 @@ module WXRuby3
           }
           __HEREDOC
         spec.add_init_code <<~__HEREDOC
-          wxRuby_AppendMarker(wxRuby_markComboPopups);
-
           g_rb_mWxComboPopup = rb_define_module_under(mWxCore, "ComboPopup");
           rb_define_method(g_rb_mWxComboPopup, "get_combo_ctrl", VALUEFUNC(wx_combo_popup_get_combo_ctrl), -1);
 

data/rakelib/lib/director/context_help_button.rb

@@ -16,8 +16,41 @@ module WXRuby3
 
       def setup
         super
-        spec.items << 'wxContextHelp'
-        spec.no_proxy 'wxContextHelp'
+        # add custom implementation of ContextHelp as module function (not a class)
+        spec.add_header_code <<~__CODE
+          SWIGINTERN int SWIG_AsVal_bool (VALUE obj, bool *val); // forward decl
+
+          static VALUE wxruby_ContextHelp(int argc, VALUE *argv, VALUE self)
+          {
+            if (argc > 1)
+            {
+              rb_raise(rb_eArgError, "wrong # of arguments %d for 1", argc);
+              return Qnil;
+            }
+
+            void *ptr = nullptr;
+            wxWindow *window = nullptr;
+            int res = 0;
+          
+            if (argc > 0)
+            {
+              res = SWIG_ConvertPtr(argv[0], &ptr, SWIGTYPE_p_wxWindow, 0);
+              if (!SWIG_IsOK(res)) 
+              {
+                VALUE msg = rb_inspect(argv[0]);
+                rb_raise(rb_eTypeError, "expected wxWindow* for 1 but got %s", StringValuePtr(msg));
+                return Qnil; 
+              }
+              window = reinterpret_cast< wxWindow * >(ptr);
+            }
+
+            wxContextHelp(window, true);
+            return Qnil;
+          } 
+          __CODE
+        spec.add_init_code <<~__CODE__
+          rb_define_module_function(mWxCore, "ContextHelp", VALUEFUNC(wxruby_ContextHelp), -1);
+          __CODE__
       end
     end # class ContextHelpButton