wxruby3 1.6.1 → 1.8.0

data/ext/wxruby3/swig/mark_free_impl.i

@@ -16,12 +16,17 @@
 %}
 
 %{
-// Code to be run when the ruby object is swept by GC - this only
-// unlinks the C++ object from the ruby VALUE but doesn't delete
-// it because it is still needed and will be managed by WxWidgets.
-WXRUBY_EXPORT void GcNullFreeFunc(void *ptr)
+WXRUBY_TRACE_GUARD(WxRubyTraceMarkSizer, "GC_MARK_SIZER")
+WXRUBY_TRACE_GUARD(WxRubyTraceMarkWindow, "GC_MARK_WINDOW")
+WXRUBY_TRACE_GUARD(WxRubyTraceFreeWindow, "GC_FREE_WINDOW")
+WXRUBY_TRACE_GUARD(WxRubyTraceFreeRefcounted, "GC_FREE_REFCOUNT")
+
+// Check if a Ruby object is (still) Ruby GC managed in which case it's
+// 'dfree' function pointer should reference a specific free function
+// and not be either 0 or a reference to the SWIG tracking removal function.
+WXRUBY_EXPORT bool GC_IsObjectOwned(VALUE object)
 {
-  SWIG_RubyRemoveTracking(ptr);
+  return RDATA(object)->dfree != SWIG_RubyRemoveTracking && RDATA(object)->dfree != 0;
 }
 
 // Tests if the window has been signalled as destroyed by a
@@ -41,6 +46,10 @@ WXRUBY_EXPORT bool GC_IsWindowDeleted(void *ptr)
 // WindowDestroyEvent, handled by wxRubyApp (see swig/classes/App.i).
 WXRUBY_EXPORT void GC_SetWindowDeleted(void *ptr)
 {
+  WXRUBY_TRACE_IF(WxRubyTraceFreeWindow, 2)
+    WXRUBY_TRACE("> GC_SetWindowDeleted : " << ptr)
+  WXRUBY_TRACE_END
+
   // All Windows are EvtHandlers, so prevent any pending events being
   // sent after destruction (otherwise ObjectPreviouslyDeleted errors result)
   wxEvtHandler* evt_handler = (wxEvtHandler*)ptr;
@@ -77,6 +86,10 @@ WXRUBY_EXPORT void GC_SetWindowDeleted(void *ptr)
   // Disassociate the C++ and Ruby objects
   SWIG_RubyUnlinkObjects(ptr);
   SWIG_RubyRemoveTracking(ptr);
+
+  WXRUBY_TRACE_IF(WxRubyTraceFreeWindow, 2)
+    WXRUBY_TRACE("< GC_SetWindowDeleted : " << ptr)
+  WXRUBY_TRACE_END
 }
 
 // Code to be run when the ruby object is swept by GC - this only
@@ -84,36 +97,37 @@ WXRUBY_EXPORT void GC_SetWindowDeleted(void *ptr)
 // reference counter.
 WXRUBY_EXPORT void GcRefCountedFreeFunc(void *ptr)
 {
+  WXRUBY_TRACE_IF(WxRubyTraceFreeRefcounted, 2)
+    WXRUBY_TRACE("> GcRefCountedFreeFunc : " << ptr)
+  WXRUBY_TRACE_END
+
   SWIG_RubyRemoveTracking(ptr);
   if (ptr)
     ((wxRefCounter*)ptr)->DecRef();
-}
 
-// Code to be run when the ruby object is swept by GC - this checks
-// for unattached sizers and deletes those, only unlinking others
-// as these will be managed by WxWidgets.
-WXRUBY_EXPORT void GcSizerFreeFunc(void *ptr)
-{
-  wxSizer* wx_szr = (wxSizer*)ptr;
-  // unlink in all cases
-  SWIG_RubyRemoveTracking(ptr);
-  delete wx_szr; // delete unattached sizers
+  WXRUBY_TRACE_IF(WxRubyTraceFreeRefcounted, 2)
+    WXRUBY_TRACE("< GcRefCountedFreeFunc")
+  WXRUBY_TRACE_END
 }
 
 void GC_mark_SizerBelongingToWindow(wxSizer *wx_sizer, VALUE rb_sizer);
 
 WXRUBY_EXPORT void GC_mark_wxSizer(void* ptr)
 {
+  WXRUBY_TRACE_IF(WxRubyTraceMarkSizer, 2)
+    WXRUBY_TRACE("> GC_mark_wxSizer : " << ptr)
+  WXRUBY_TRACE_END
+
   VALUE rb_szr = SWIG_RubyInstanceFor(ptr);
-  if (rb_szr && rb_szr != Qnil)
+  if (!RB_NIL_P(rb_szr))
   {
-    wxSizer* wx_szr = (wxSizer*)ptr;
-
-    // as long as the dfree function is still the GCSizeFreeFunc the sizer has not been attached to a window
+    // as long as the dfree function is still the sizer's free function the sizer has not been attached to a window
     // or added to a parent sizer (as that would 'disown' and replace the free function by the tracking removal function)
     // but it may hay have already had child sizers added which need to be marked
-    if (RDATA(rb_szr)->dfree == (void (*)(void *))GcSizerFreeFunc)
+    if (RDATA(rb_szr)->dfree != (void (*)(void *))SWIG_RubyRemoveTracking)
     {
+      wxSizer* wx_szr = (wxSizer*)ptr;
+
       // Then loop over the sizer's content and mark each sub-sizer
       wxSizerItemList& children = wx_szr->GetChildren();
       for ( wxSizerItemList::compatibility_iterator node = children.GetFirst();
@@ -134,6 +148,10 @@ WXRUBY_EXPORT void GC_mark_wxSizer(void* ptr)
       }
     }
   }
+
+  WXRUBY_TRACE_IF(WxRubyTraceMarkSizer, 2)
+    WXRUBY_TRACE("< GC_mark_wxSizer : " << ptr)
+  WXRUBY_TRACE_END
 }
 
 // Carries out marking of Sizer objects belonging to a Wx::Window. Note
@@ -144,10 +162,9 @@ WXRUBY_EXPORT void GC_mark_wxSizer(void* ptr)
 // directors, they must be preserved from GC.
 void GC_mark_SizerBelongingToWindow(wxSizer *wx_sizer, VALUE rb_sizer)
 {
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "> GC_mark_SizerBelongingToWindow : " << wx_sizer << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkSizer, 2)
+    WXRUBY_TRACE("> GC_mark_SizerBelongingToWindow : " << wx_sizer)
+  WXRUBY_TRACE_END
 
   // First, mark this sizer
   rb_gc_mark( rb_sizer );
@@ -170,104 +187,66 @@ void GC_mark_SizerBelongingToWindow(wxSizer *wx_sizer, VALUE rb_sizer)
     }
   }
 
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "< GC_mark_SizerBelongingToWindow : " << wx_sizer << std::endl;
-#endif
-}
-
-// Similar to Sizers, MenuBar requires a special mark routine. This is
-// because Wx::Menu is not a subclass of Window so isn't automatically
-// protected in the mark phase by Wx::App. However, the ruby object
-// still must not be destroyed while it is still accessible on screen,
-// because it may still handle events. Rather than a SWIG %markfunc,
-// which can catch destroyed MenuBars linked to an in-scope ruby
-// variable and cause segfaults, MenuBars are always marked via the
-// containing Frame.
-void GC_mark_MenuBarBelongingToFrame(wxMenuBar *menu_bar)
-{
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "> GC_mark_MenuBarBelongingToFrame : " << menu_bar << std::endl;
-#endif
-
-  rb_gc_mark( SWIG_RubyInstanceFor(menu_bar) );
-  // Mark each menu in the menubar in turn
-  for ( size_t i = 0; i < menu_bar->GetMenuCount(); i++ )
-	{
-	  wxMenu* menu  = menu_bar->GetMenu(i);
-	  rb_gc_mark( SWIG_RubyInstanceFor(menu) );
-	}
-
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "< GC_mark_MenuBarBelongingToFrame : " << menu_bar << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkSizer, 2)
+    WXRUBY_TRACE("< GC_mark_SizerBelongingToWindow : " << wx_sizer)
+  WXRUBY_TRACE_END
 }
 
 // Default mark routine for Windows - preserve the main sizer and caret
 // belong to this window
 WXRUBY_EXPORT void GC_mark_wxWindow(void *ptr)
 {
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "> GC_mark_wxWindow : " << ptr << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 2)
+    WXRUBY_TRACE("> GC_mark_wxWindow : " << ptr)
+  WXRUBY_TRACE_END
 
   if ( GC_IsWindowDeleted(ptr) )
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>1)
-      std::wcout << "< GC_mark_wxWindow : deleted" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 2)
+      WXRUBY_TRACE("< GC_mark_wxWindow : deleted")
+    WXRUBY_TRACE_END
     return;
   }
 
   wxWindow* wx_win = (wxWindow*)ptr;
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>2)
-    std::wcout << "* GC_mark_wxWindow - getting sizer" << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+    WXRUBY_TRACE("| GC_mark_wxWindow : getting sizer")
+  WXRUBY_TRACE_END
   wxSizer* wx_sizer = wx_win->GetSizer();
   if ( wx_sizer )
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>2)
-      std::wcout << "* GC_mark_wxWindow - found sizer" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+      WXRUBY_TRACE("| GC_mark_wxWindow : found sizer " << wx_sizer)
+    WXRUBY_TRACE_END
     VALUE rb_sizer = SWIG_RubyInstanceFor(wx_sizer);
 	  if ( rb_sizer != Qnil )
       GC_mark_SizerBelongingToWindow(wx_sizer, rb_sizer);
   }
 
   // mark any pushed event handlers
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>2)
-    std::wcout << "* GC_mark_wxWindow - getting event handler" << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+    WXRUBY_TRACE("| GC_mark_wxWindow : getting event handler")
+  WXRUBY_TRACE_END
   wxEvtHandler* evh = wx_win->GetEventHandler();
   while (evh && evh != wx_win)
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>2)
-      std::wcout << "* GC_mark_wxWindow - marking event handler" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+      WXRUBY_TRACE("| GC_mark_wxWindow : found event handler " << evh)
+    WXRUBY_TRACE_END
     VALUE rb_evh = SWIG_RubyInstanceFor(evh);
 	  rb_gc_mark(rb_evh);
 	  evh = evh->GetNextHandler();
   }
 
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>2)
-    std::wcout << "* GC_mark_wxWindow - getting caret" << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+    WXRUBY_TRACE("| GC_mark_wxWindow : getting caret")
+  WXRUBY_TRACE_END
   wxCaret* wx_caret = wx_win->GetCaret();
   if ( wx_caret )
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>2)
-      std::wcout << "* GC_mark_wxWindow - found caret" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+      WXRUBY_TRACE("| GC_mark_wxWindow : found caret " << wx_caret)
+    WXRUBY_TRACE_END
     VALUE rb_caret = SWIG_RubyInstanceFor(wx_caret);
 	  rb_gc_mark(rb_caret);
   }
@@ -275,76 +254,36 @@ WXRUBY_EXPORT void GC_mark_wxWindow(void *ptr)
   // be careful; getting drop target may require fully created window (default ctors do  not call Create())
   if (wx_win->GetId() != wxID_ANY)  // any fully created window has an Id != wxID_ANY
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>2)
-      std::wcout << "* GC_mark_wxWindow - getting droptarget" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+      WXRUBY_TRACE("| GC_mark_wxWindow : getting droptarget")
+    WXRUBY_TRACE_END
     wxDropTarget* wx_droptarget = wx_win->GetDropTarget();
     if ( wx_droptarget )
     {
-#ifdef __WXRB_DEBUG__
-      if (wxRuby_TraceLevel()>2)
-        std::wcout << "* GC_mark_wxWindow - found droptarget" << std::endl;
-#endif
+      WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+        WXRUBY_TRACE("| GC_mark_wxWindow : found drop target " << wx_droptarget)
+      WXRUBY_TRACE_END
       VALUE rb_droptarget = SWIG_RubyInstanceFor(wx_droptarget);
       rb_gc_mark(rb_droptarget);
     }
   }
 
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>2)
-    std::wcout << "* GC_mark_wxWindow - getting validator" << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+    WXRUBY_TRACE("| GC_mark_wxWindow : getting validator")
+  WXRUBY_TRACE_END
   wxValidator* wx_validator = wx_win->GetValidator();
   if ( wx_validator )
   {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>2)
-      std::wcout << "* GC_mark_wxWindow - found validator" << std::endl;
-#endif
+    WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 3)
+      WXRUBY_TRACE("| GC_mark_wxWindow : found validator " << wx_validator)
+    WXRUBY_TRACE_END
 	  VALUE rb_validator = SWIG_RubyInstanceFor(wx_validator);
 	  rb_gc_mark(rb_validator);
   }
 
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "< GC_mark_wxWindow : " << ptr << std::endl;
-#endif
+  WXRUBY_TRACE_IF(WxRubyTraceMarkWindow, 2)
+    WXRUBY_TRACE("< GC_mark_wxWindow : " << ptr)
+  WXRUBY_TRACE_END
 }
 
-
-WXRUBY_EXPORT void GC_mark_wxFrame(void *ptr)
-{
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-  std::wcout << "> GC_mark_wxFrame : " << ptr << std::endl;
-#endif
-
-  if ( GC_IsWindowDeleted(ptr) )
-  {
-#ifdef __WXRB_DEBUG__
-    if (wxRuby_TraceLevel()>1)
-    std::wcout << "> GC_mark_wxFrame : deleted" << std::endl;
-#endif
-    return;
-  }
-
-  // Frames are also a subclass of wxWindow, so must do all the marking
-  // of sizers and carets associated with that class
-  GC_mark_wxWindow(ptr);
-
-  wxFrame* wx_frame = (wxFrame*)ptr;
-  // Then mark the MenuBar, if one is associated with this Frame
-
-  wxMenuBar* menu_bar = wx_frame->GetMenuBar();
-  if ( menu_bar )
-  {
-    GC_mark_MenuBarBelongingToFrame(menu_bar);
-  }
-
-#ifdef __WXRB_DEBUG__
-  if (wxRuby_TraceLevel()>1)
-    std::wcout << "> GC_mark_wxFrame : " << ptr << std::endl;
-#endif
-}
 %}

data/ext/wxruby3/swig/memory_management.i

@@ -9,30 +9,11 @@
 // This file, required by common.i defines a set of macros which are used
 // to specify memory management strategies for individual Wx classes.
 
-// Broadly speaking there are two different strategies:
-//
-// 1) For all classes which inherit from Wx::Window, including all Frames,
-//    Dialogs and Controls: the C++ objects are managed by WxWidgets; when=
-//    Frame is closed, it and all its contents are deleted. Therefore wxRuby
-//    doesn't try to delete these objects as part of GC until they are known
-//    to have been deleted. The instance of Wx::App watches for window
-//    destruction, and in the GC-mark phase marks all Windows that are still
-//    alive. [see App.i]
-//
-// 2) Almost all other classes are memory managed by wxRuby - that is, when
-//    they have fallen out of scope and GC is run, the underlying C++ object
-//    will be deleted too by the standard %freefunc.
-
-
 // These are implemented in swig/wx.i, so they are shared among all classes
 %{
-WXRUBY_EXPORT void GcNullFreeFunc(void *);
-WXRUBY_EXPORT void GcSizerFreeFunc(void *);
-WXRUBY_EXPORT void GcDialogFreeFunc(void *);
 WXRUBY_EXPORT void GcRefCountedFreeFunc(void *);
 WXRUBY_EXPORT void GC_mark_wxSizer(void *);
 WXRUBY_EXPORT void GC_mark_wxWindow(void *);
-WXRUBY_EXPORT void GC_mark_wxFrame(void *);
 WXRUBY_EXPORT void GC_mark_wxEvent(void *);
 %}
 
@@ -42,7 +23,7 @@ WXRUBY_EXPORT void GC_mark_wxEvent(void *);
 // all Windows, including Frames and Dialogs
 %define GC_NEVER(kls)
 %trackobjects kls;
-%feature("freefunc") kls "GcNullFreeFunc";
+%feature("freefunc") kls "SWIG_RubyRemoveTracking";
 %enddef
 
 // Strategy for windows that aren't top-level windows.  Here, the C++
@@ -60,26 +41,21 @@ GC_NEVER(kls);
 %enddef
 
 // Strategy for top-level frames - these are destroyed
-// automatically. Marking is the same as for Windows, plus preservation
-// of the associated MenuBar, if reuqired.
+// automatically. Marking is the same as for Windows.
 %define GC_MANAGE_AS_FRAME(kls)
-GC_NEVER(kls);
-// Mark any associated sizer
-%feature("markfunc") kls "GC_mark_wxFrame";
+GC_MANAGE_AS_WINDOW(kls);
 %enddef
 
 // Strategy for dialogs - these are NOT destroyed automatically
 %define GC_MANAGE_AS_DIALOG(kls)
-GC_NEVER(kls);
-// Mark any associated sizer
-%feature("markfunc") kls "GC_mark_wxWindow";
+GC_MANAGE_AS_WINDOW(kls);
 %enddef
 
 // Events - most are created within wxWidgets C++ on the stack and thus
 // do not need deletion. These are passed into ruby via EvtHandler or
 // App methods, and are wrapped using wxRuby_WrapWxEventInRuby (see
-// wx.i). This gives them a void freefunc and markfunc and are NOT
-// tracked - they are treated as one-shot short-lived objects.
+// wx.i). This gives them a null freefunc and markfunc and provides no
+// tracking - they are treated as one-shot short-lived objects.
  //
 // However, custom events created on the ruby side need to be deleted to
 // avoid leakage as SWIG wrappers call C++ "new" to allocate the
@@ -112,15 +88,10 @@ GC_NEVER(kls);
 %define GC_MANAGE_AS_MARKED(kls)
 %enddef
 
-// Sizers attached to windows are automatically destroyed by wxWidgets,
-// so they should not be deleted.
-//
-// TODO - orphaned/unattached sizers are not automatically destroyed -
-// so the freefunc should check for this condition and do the delete if
-// required to prevent a memory leak.
+// Attached sizers should only be marked by the window they are attached to.
 %define GC_MANAGE_AS_SIZER(kls)
 %trackobjects kls;
-%feature("freefunc") kls "GcSizerFreeFunc";
+//%feature("freefunc") kls "GcSizerFreeFunc";
 %feature("markfunc") kls "GC_mark_wxSizer";
 %enddef
 
@@ -132,12 +103,6 @@ GC_NEVER(kls);
 %feature("freefunc") kls "GcRefCountedFreeFunc";
 %enddef
 
-// special refcounted for grid cell renderers/editors and attrs
-%define GC_MANAGE_AS_UNTRACKED_REFCOUNTED(kls)
-%feature("freefunc") kls "GcRefCountedFreeFunc";
-%enddef
-
-
 // All other classes - mainly helper classes (eg Sizer, GridCellxxx).
 // These are tracked but sometimes later disowned once passed into a
 // widget, and thenceforth managed by WxWidgets