wxruby3 1.6.1 → 1.8.0

data/ext/wxruby3/swig/wx.i

@@ -17,6 +17,15 @@
 
 #include <wx/filesys.h>
 #include <wx/fs_zip.h>
+#include <wx/utils.h>
+
+#include <unordered_map>
+
+WXRUBY_TRACE_GUARD(WxRubyTraceGCWrapEvents, "GC_WRAP_EVENTS")
+WXRUBY_TRACE_GUARD(WxRubyTraceGCWrapObject, "GC_WRAP_OBJECT")
+
+// SWIG and wxRuby3 custom tracking support
+#include "wxruby-GCTracking.h"
 %}
 
 // Some common functions
@@ -75,63 +84,6 @@ WXRUBY_EXPORT swig_type_info* wxRuby_GetSwigTypeForClassName(const char* clsname
   return wxRuby_GetSwigTypeForClass(rb_const_get(wxRuby_Core(), rb_intern(clsname)));
 }
 
-// Overriding standard SWIG tracking - SWIG's implementation is not
-// compatible with ruby 1.8.7 / 1.9.x as it can allocate BigNum objects
-// during GC , which is an error. So instead we provide a C++ ptr->Ruby
-// object map using Wx's hashmap class.
-WX_DECLARE_VOIDPTR_HASH_MAP(VALUE,
-                            PtrToRbObjHash);
-PtrToRbObjHash Global_Ptr_Map;
-
-// Add a tracking from ptr -> object
-WXRUBY_EXPORT void wxRuby_AddTracking(void* ptr, VALUE object)
-{
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-  {
-    std::wcout << "> wxRuby_AddTracking" << std::flush;
-    VALUE clsname = rb_mod_name(CLASS_OF(object));
-    std::wcout << "("
-               << ptr << ":{"
-               << (clsname != Qnil ? StringValueCStr(clsname) : "<noname>")
-               << "})" << std::endl;
-  }
-#endif
-  Global_Ptr_Map[ptr] = object;
-}
-
-// Return the ruby object for ptr
-WXRUBY_EXPORT VALUE wxRuby_FindTracking(void* ptr)
-{
-  if ( Global_Ptr_Map.count(ptr) == 0 )
-    return Qnil;
-  else
-    return Global_Ptr_Map[ptr];
-}
-
-// Remove the tracking for ptr
-WXRUBY_EXPORT void wxRuby_RemoveTracking(void* ptr)
-{
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "< wxRuby_RemoveTracking(" << ptr << ")" << std::endl;
-#endif
-  Global_Ptr_Map.erase(ptr);
-}
-
-// Iterate over all the trackings, calling the passed-in method on each
-WXRUBY_EXPORT void wxRuby_IterateTracking( void(*meth)(void* ptr, VALUE obj) )
-{
-  PtrToRbObjHash::iterator it;
-  for( it = Global_Ptr_Map.begin(); it != Global_Ptr_Map.end(); ++it )
-    {
-      void* ptr = it->first;
-      VALUE obj = it->second;
-      (*meth)(ptr, obj);
-    }
-}
-
-
 // Returns a ruby object wrapped around a wxObject. This is used for
 // methods whose return type is a generic C++ class (eg wxWindow), but
 // whose return values are actually instances of specific C++ classes
@@ -152,12 +104,22 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxObjectInRuby(wxObject *wx_obj)
 {
   static WxRuby_ID window_id("Window");
 
+  WXRUBY_TRACE_IF(WxRubyTraceGCWrapObject, 2)
+    WXRUBY_TRACE("> wxRuby_WrapWxObjectInRuby(" << wx_obj << ")")
+  WXRUBY_TRACE_END
+
   // If no object was passed to be wrapped; this could be a normal state
   // (eg if get_sizer was called on a Window with no sizer set), or
   // could be an error, eg if calling get_window_by_id and no window
   // matched the id, or an error arose from incorrect XML syntax
   if ( ! wx_obj )
+  {
+    WXRUBY_TRACE_IF(WxRubyTraceGCWrapObject, 2)
+      WXRUBY_TRACE("< wxRuby_WrapWxObjectInRuby - returning nil")
+    WXRUBY_TRACE_END
+
     return Qnil;
+  }
 
   // Get the wx class and the ruby class we are converting into
   wxString class_name( wx_obj->GetClassInfo()->GetClassName() );
@@ -199,12 +161,20 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxObjectInRuby(wxObject *wx_obj)
     }
     else
     {
+      WXRUBY_TRACE_IF(WxRubyTraceGCWrapObject, 2)
+        WXRUBY_TRACE("< wxRuby_WrapWxObjectInRuby - returning nil for unsupported object " << wx_obj << "{" << (const char *)class_name.mb_str() << "}")
+      WXRUBY_TRACE_END
+
       rb_warn("Error wrapping object; class '%s' is not (yet) supported in wxRuby",
               (const char *)class_name.mb_str());
       return Qnil;
     }
   }
 
+  WXRUBY_TRACE_IF(WxRubyTraceGCWrapObject, 2)
+    WXRUBY_TRACE("< wxRuby_WrapWxObjectInRuby - returning wrapped object " << wx_obj << "{" << rb_class2name(r_class) << "}")
+  WXRUBY_TRACE_END
+
   // Otherwise, retrieve the swig type info for this class and wrap it
   // in Ruby. wxRuby_GetSwigTypeForClass is defined in wx.i
   swig_type_info* swig_type = wxRuby_GetSwigTypeForClass(r_class);
@@ -224,6 +194,18 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxObjectInRuby(wxObject *wx_obj)
 static VALUE Evt_Type_Map = NULL;
 static VALUE WxRuby_cAsyncProcCallEvent = Qnil;
 
+inline VALUE _get_ThreadEventClass()
+{
+  static VALUE __cThreadEvent = Qnil;
+
+  if (RB_NIL_P(__cThreadEvent))
+  {
+    VALUE module = rb_const_get(wxRuby_Core(), rb_intern("RT"));
+    if (!RB_NIL_P(module)) __cThreadEvent = rb_const_get(module, rb_intern("ThreadEvent"));
+  }
+  return __cThreadEvent;
+}
+
 #ifdef __WXRB_DEBUG__
 WXRUBY_EXPORT VALUE wxRuby_WrapWxEventInRuby(void* rcvr, wxEvent *wx_event)
 #else
@@ -236,10 +218,9 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxEventInRuby(wxEvent *wx_event)
     Evt_Type_Map = wxRuby_GetEventTypeClassMap ();
   }
 
-#if __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "* wxRuby_WrapWxEventInRuby(rcvr=" << rcvr << ", " << wx_event << ":{" << wx_event->GetEventType() << "@" << wx_event->GetEventObject() << "})" << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceGCWrapEvents, 2)
+    WXRUBY_TRACE("> wxRuby_WrapWxEventInRuby(rcvr=" << rcvr << ", " << wx_event << ":{" << wx_event->GetEventType() << "@" << wx_event->GetEventObject() << "})")
+  WXRUBY_TRACE_END
 
   VALUE rb_event_type_id = INT2NUM(wx_event->GetEventType());
   VALUE rb_event_class = Qnil;
@@ -280,9 +261,22 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxEventInRuby(wxEvent *wx_event)
   if ( rb_event != Qnil )
   {
     if (rb_obj_is_kind_of(rb_event, rb_event_class))
+    {
+      WXRUBY_TRACE_IF(WxRubyTraceGCWrapEvents, 2)
+        WXRUBY_TRACE_WITH(swig_type_info*  type = wx_event->GetEventType() == wxEVT_ASYNC_METHOD_CALL ?
+                                    wxRuby_GetSwigTypeForClass(wxRuby_GetDefaultEventClass()) :
+                                    wxRuby_GetSwigTypeForClass(rb_event_class))
+        WXRUBY_TRACE("< wxRuby_WrapWxEventInRuby - returning tracked event " << wx_event << "{" << (type ? type->name : rb_class2name(rb_event_class)) << "} -> " << rb_event)
+      WXRUBY_TRACE_END
       return rb_event; // OK
+    }
     else
+    {
+      WXRUBY_TRACE_IF(WxRubyTraceGCWrapEvents, 2)
+        WXRUBY_TRACE("| wxRuby_WrapWxEventInRuby - removing tracking of stale object " << wx_event << " -> " << rb_event)
+      WXRUBY_TRACE_END
       SWIG_RubyRemoveTracking((void *)wx_event); // Remove stale ref
+    }
   }
 
   // No existing Ruby instance found, so a transitory event object; wrap
@@ -291,39 +285,45 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxEventInRuby(wxEvent *wx_event)
   DATA_PTR(rb_event) = wx_event;
   // do not forget to mark the instance with the mangled swig type name
   // (as there is no swig_type for the Wx::AsyncProcCallEvent class use it's base Wx::Event)
-  swig_type_info*  type = wx_event->GetEventType() == wxEVT_ASYNC_METHOD_CALL ?
-                            wxRuby_GetSwigTypeForClass(wxRuby_GetDefaultEventClass()) :
-                            wxRuby_GetSwigTypeForClass(rb_event_class);
-  rb_iv_set(rb_event, "@__swigtype__", rb_str_new2(type->name));
-
-#if __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "* wxRuby_WrapWxEventInRuby - wrapped transitory event " << wx_event << "{" << type->name << "}" << std::endl;
-#endif
+  swig_type_info*  type;
+  if (wx_event->GetEventType() == wxEVT_ASYNC_METHOD_CALL)
+  {
+    type = wxRuby_GetSwigTypeForClass(wxRuby_GetDefaultEventClass());
+  }
+  else
+  {
+    type = wxRuby_GetSwigTypeForClass(rb_event_class);
+    if (!type)
+    {
+      // could be derived ThreadEvent
+      VALUE klass = _get_ThreadEventClass();
+      if (!RB_NIL_P(klass) && rb_class_inherited_p(rb_event_class, klass))
+      {
+        type = wxRuby_GetSwigTypeForClass(klass);
+      }
+    }
+  }
+  // type should never be null but let's be paranoid
+  if (type) rb_iv_set(rb_event, "@__swigtype__", rb_str_new2(type->name));
+
+  WXRUBY_TRACE_IF(WxRubyTraceGCWrapEvents, 2)
+    WXRUBY_TRACE("< wxRuby_WrapWxEventInRuby - wrapped transitory event " << wx_event << "{" << (type ? type->name : rb_class2name(rb_event_class)) << "}")
+  WXRUBY_TRACE_END
 
   return rb_event;
 }
-%}
 
-%inline %{
-#ifdef __WXRB_DEBUG__
-int wxrb_trace_level = 0;
-#else
-const int wxrb_trace_level = 0;
-#endif
-%}
-
-%constant int wxWXWIDGETS_DEBUG_LEVEL = wxDEBUG_LEVEL;
-
-%{
-#ifdef __WXRB_DEBUG__
-WXRUBY_EXPORT int wxRuby_TraceLevel()
+static VALUE wxruby_get_wx_prefix(int argc, VALUE *argv, VALUE self)
 {
-  return wxrb_trace_level;
+  if ((argc < 0) || (argc > 0)) {
+    rb_raise(rb_eArgError, "wrong # of arguments(%d for 0)",argc); return Qnil;
+  }
+  return WXSTR_TO_RSTR(wxGetInstallPrefix());
 }
-#endif
 %}
 
+%constant int wxWXWIDGETS_DEBUG_LEVEL = wxDEBUG_LEVEL;
+
 %include "mark_free_impl.i"
 
 %init %{
@@ -335,4 +335,6 @@ WXRUBY_EXPORT int wxRuby_TraceLevel()
 
 	// This is needed so HtmlHelp can load docs from a zip file
 	wxFileSystem::AddHandler(new wxArchiveFSHandler);
+
+	rb_define_module_function(mWxruby3, "get_wx_prefix", VALUEFUNC(wxruby_get_wx_prefix), -1);
 %}

data/lib/wx/aui/events/evt_list.rb

@@ -0,0 +1,148 @@
+#-------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 interface generator.
+# Do not alter this file.
+#-------------------------------------------------------------------------
+
+class Wx::EvtHandler
+  # from wxAuiManagerEvent
+  self.register_event_type EventType[
+      'evt_aui_pane_button', 0,
+      Wx::AUI::EVT_AUI_PANE_BUTTON,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_pane_close', 0,
+      Wx::AUI::EVT_AUI_PANE_CLOSE,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_pane_minimize', 0,
+      Wx::AUI::EVT_AUI_PANE_MINIMIZE,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_pane_maximize', 0,
+      Wx::AUI::EVT_AUI_PANE_MAXIMIZE,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_pane_restore', 0,
+      Wx::AUI::EVT_AUI_PANE_RESTORE,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_pane_activated', 0,
+      Wx::AUI::EVT_AUI_PANE_ACTIVATED,
+      Wx::AUI::AuiManagerEvent
+    ]
+  self.register_event_type EventType[
+      'evt_aui_render', 0,
+      Wx::AUI::EVT_AUI_RENDER,
+      Wx::AUI::AuiManagerEvent
+    ]
+  # from wxAuiNotebookEvent
+  self.register_event_type EventType[
+      'evt_auinotebook_page_close', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSE,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_page_closed', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSED,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_page_changed', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGED,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_page_changing', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGING,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_button', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_BUTTON,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_begin_drag', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_BEGIN_DRAG,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_end_drag', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_END_DRAG,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_drag_motion', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_DRAG_MOTION,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_allow_dnd', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_ALLOW_DND,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_drag_done', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_DRAG_DONE,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_tab_middle_down', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_tab_middle_up', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_tab_right_down', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_tab_right_up', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auinotebook_bg_dclick', 1,
+      Wx::AUI::EVT_AUINOTEBOOK_BG_DCLICK,
+      Wx::AUI::AuiNotebookEvent
+    ]
+  # from wxAuiToolBarEvent
+  # from wxAuiManager
+  # from wxAuiNotebook
+  # from wxAuiToolBar
+  self.register_event_type EventType[
+      'evt_auitoolbar_tool_dropdown', 1,
+      Wx::AUI::EVT_AUITOOLBAR_TOOL_DROPDOWN,
+      Wx::AUI::AuiToolBarEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auitoolbar_overflow_click', 1,
+      Wx::AUI::EVT_AUITOOLBAR_OVERFLOW_CLICK,
+      Wx::AUI::AuiToolBarEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auitoolbar_right_click', 1,
+      Wx::AUI::EVT_AUITOOLBAR_RIGHT_CLICK,
+      Wx::AUI::AuiToolBarEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auitoolbar_middle_click', 1,
+      Wx::AUI::EVT_AUITOOLBAR_MIDDLE_CLICK,
+      Wx::AUI::AuiToolBarEvent
+    ]
+  self.register_event_type EventType[
+      'evt_auitoolbar_begin_drag', 1,
+      Wx::AUI::EVT_AUITOOLBAR_BEGIN_DRAG,
+      Wx::AUI::AuiToolBarEvent
+    ]
+end

data/lib/wx/aui/require.rb

@@ -9,4 +9,3 @@ require_relative './events/evt_list'
 require_relative './auimanager'
 require_relative './auinotebook'
 require_relative './auifloatframe'
-require_relative './aui_tab_ctrl'

data/lib/wx/core/calendar_ctrl.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
+module Wx
+
+  if PLATFORM == 'WXOSX'
+    GenericCalendarCtrl = CalendarCtrl
+  end
+
+end

data/lib/wx/core/clipboard.rb

@@ -32,32 +32,28 @@ class Wx::Clipboard
     ensure
        clip.close if clip
     end
-  end
-
-  # Need to do some internal record-keeping to protect data objects on
-  # the clipboard from garbage collection
-  @@__clip_data = []
 
-  # These methods affect the clipboard contents; each time, update the
-  # record with the changed data contents
-  wx_add_data = instance_method(:add_data)
-  wx_redefine_method(:add_data) do | the_data |
-    @@__clip_data << the_data
-    wx_add_data.bind(self).call(the_data)
+    # Need to do some internal record-keeping to protect data objects on
+    # the clipboard from garbage collection
+    def cache_data(data)
+      @data_cache = data
+    end
   end
 
   wx_clear = instance_method(:clear)
   wx_redefine_method(:clear) do 
     wx_clear.bind(self).call
-    @@__clip_data.clear
+    self.class.cache_data(nil)
   end
 
   wx_set_data = instance_method(:set_data)
   wx_redefine_method(:set_data) do | the_data |
-    @@__clip_data = [ the_data ]
+    self.class.cache_data(the_data)
     wx_set_data.bind(self).call(the_data)
   end
 
+  alias :add_data :set_data
+
   # Aliases, more clearly expressive?
   alias :place :set_data
   alias :fetch :get_data

data/lib/wx/core/config.rb

@@ -638,7 +638,7 @@ module Wx
     def set_expand_env_vars(flag)
       @expand_env_vars = !!flag
     end
-    alias :expand_env_vars :set_expand_env_vars
+    alias :expand_env_vars= :set_expand_env_vars
 
     def get_group_at(segments, create_missing_groups: false, is_pruned: false)
       unless is_pruned

data/lib/wx/core/const.rb

@@ -23,7 +23,6 @@ module Wx
   FRAME_NAME_STR = 'frame'
   STATUS_LINE_NAME_STR = 'status_line'
   STATIC_BITMAP_NAME_STR = 'staticBitmap'
-  WEB_VIEW_NAME_STR = 'wxWebView'
   ANIMATION_CTRL_NAME_STR = 'animationctrl'
   TOOL_BAR_NAME_STR = 'toolbar'
   TEXT_CTRL_NAME_STR = 'text'

data/lib/wx/core/context_help.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class << self
+
+    define_method :ContextHelp do |window = nil|
+
+      context_help(window)
+
+    end
+
+  end
+
+end

data/lib/wx/core/cursor.rb

@@ -24,6 +24,7 @@ module Wx
 
       wx_set_cursor = instance_method :set_cursor
       wx_redefine_method :set_cursor do |cursor|
+        cursor = Wx::Cursor.new(cursor) if cursor.is_a?(Wx::StockCursor)
         wx_set_cursor.bind(self).call(cursor.is_a?(Wx::Cursor) ? Wx::CursorBundle.new(cursor) :  cursor)
       end
     end