wxruby3 0.9.2 → 0.9.4

data/rakelib/lib/director/ctrl_with_items.rb

@@ -14,6 +14,8 @@ module WXRuby3
 
     class ControlWithItems < Window
 
+      include Typemap::ClientData
+
       def setup
         super
         if spec.module_name == 'wxControlWithItems'
@@ -26,48 +28,113 @@ module WXRuby3
                                              wxEvtHandler
                                              wxObject])
           spec.ignore([
-            'wxItemContainer::Append(const wxString &, wxClientData *)',
+            'wxItemContainer::Append(const wxString &, void *)',
             'wxItemContainer::Append(const std::vector< wxString > &)',
-            'wxItemContainer::Append(const wxArrayString &, wxClientData **)',
+            'wxItemContainer::Append(const wxArrayString &, void **)',
             'wxItemContainer::Append(unsigned int, const wxString *)',
             'wxItemContainer::Append(unsigned int, const wxString *, void **)',
             'wxItemContainer::Append(unsigned int, const wxString *, wxClientData **)',
-            'wxItemContainer::Insert(const wxString &, unsigned int, wxClientData *)',
+            'wxItemContainer::Insert(const wxString &, unsigned int, void *)',
             'wxItemContainer::Insert(const std::vector< wxString > &)',
-            'wxItemContainer::Insert(const wxArrayString &, unsigned int, wxClientData **)',
+            'wxItemContainer::Insert(const wxArrayString &, unsigned int, void **)',
             'wxItemContainer::Insert(unsigned int, const wxString *, unsigned int)',
             'wxItemContainer::Insert(unsigned int, const wxString *, unsigned int, void **)',
             'wxItemContainer::Insert(unsigned int, const wxString *, unsigned int, wxClientData **)',
             'wxItemContainer::Set(const std::vector< wxString > &)',
-            'wxItemContainer::Set(const wxArrayString &, wxClientData **)',
+            'wxItemContainer::Set(const wxArrayString &, void **)',
             'wxItemContainer::Set(unsigned int, const wxString *)',
             'wxItemContainer::Set(unsigned int, const wxString *, void **)',
             'wxItemContainer::Set(unsigned int, const wxString *, wxClientData **)',
-            'wxItemContainer::DetachClientObject',
-            'wxItemContainer::HasClientObjectData',
-            'wxItemContainer::GetClientObject',
-            'wxItemContainer::SetClientObject'])
+            'wxItemContainer::HasClientUntypedData',
+            'wxItemContainer::GetClientData',
+            'wxItemContainer::SetClientData'])
+          # ignore these but keep docs; will add custom versions below
           spec.ignore([
-            'wxItemContainer::Append(const wxArrayString &, void **)',
-            'wxItemContainer::Insert(const wxArrayString &, unsigned int, void **)',
-            'wxItemContainer::Set(const wxArrayString &, void **)'], ignore_doc: false)
+            'wxItemContainer::DetachClientObject',
+            'wxItemContainer::Append(const wxArrayString &, wxClientData **)',
+            'wxItemContainer::Insert(const wxArrayString &, unsigned int, wxClientData **)',
+            'wxItemContainer::Set(const wxArrayString &, wxClientData **)'], ignore_doc: false)
           if Config.instance.wx_version < '3.3.0'
             # add undocumented method
             spec.extend_interface 'wxControlWithItems',
                                   'bool IsSorted() const'
           end
           # for doc only
-          spec.map 'void** clientData' => 'Array', swig: false do
+          spec.map 'wxClientData** clientData' => 'Array', swig: false do
             map_in code: ''
           end
-          spec.ignore(%w[wxItemContainer::GetClientData wxItemContainer::SetClientData], ignore_doc: false) # keep docs
-          # Replace the old Wx definition of this method (which segfaults)
-          # Only need the setter as we cache data in Ruby and the getter
-          # therefor can be pure Ruby
+          # Replace the old Wx definitions of these methods adding
+          # proper checks on the data arrays.
+          # Also add an item enumerator.
           spec.add_extend_code 'wxControlWithItems', <<~__HEREDOC
-            VALUE set_client_data(int n, VALUE item_data) {
-              self->SetClientData(n, (void *)item_data);
-              return item_data;
+            VALUE DetachClientObject(unsigned int n)
+            {
+              VALUE rc = Qnil;
+              wxClientData *wxcd = $self->DetachClientObject(n);
+              wxRubyClientData *rbcd = wxcd ? dynamic_cast<wxRubyClientData*> (wxcd) : nullptr;
+              if (rbcd)
+              {
+                rc = rbcd->GetData();
+                delete rbcd;
+              }
+              return rc;
+            }
+
+            int Append(const wxArrayString &items, VALUE rb_clientData)
+            {
+              if (TYPE(rb_clientData) != T_ARRAY || 
+                    static_cast<unsigned int> (RARRAY_LEN(rb_clientData)) != items.GetCount())
+              {
+                rb_raise(rb_eArgError, 
+                         TYPE(rb_clientData) == T_ARRAY ? 
+                            "expected Array for client_data" : 
+                            "client_data Array needs to be equal in size to items Array");
+              }
+
+              std::unique_ptr<wxClientData*[]> cd_arr = std::make_unique<wxClientData*[]> (RARRAY_LEN(rb_clientData));
+              for (int i=0; i<RARRAY_LEN(rb_clientData) ;++i)
+              {
+                cd_arr[i] = new wxRubyClientData(rb_ary_entry(rb_clientData, i));
+              }
+              return $self->Append(items, cd_arr.get());
+            }
+
+            int Insert(const wxArrayString &items, unsigned int pos, VALUE rb_clientData)
+            {
+              if (TYPE(rb_clientData) != T_ARRAY || 
+                    static_cast<unsigned int> (RARRAY_LEN(rb_clientData)) != items.GetCount())
+              {
+                rb_raise(rb_eArgError, 
+                         TYPE(rb_clientData) == T_ARRAY ? 
+                            "expected Array for client_data" : 
+                            "client_data Array needs to be equal in size to items Array");
+              }
+
+              std::unique_ptr<wxClientData*[]> cd_arr = std::make_unique<wxClientData*[]> (RARRAY_LEN(rb_clientData));
+              for (int i=0; i<RARRAY_LEN(rb_clientData) ;++i)
+              {
+                cd_arr[i] = new wxRubyClientData(rb_ary_entry(rb_clientData, i));
+              }
+              return $self->Insert(items, pos, cd_arr.get());
+            }
+
+            void Set(const wxArrayString &items, VALUE rb_clientData)
+            {
+              if (TYPE(rb_clientData) != T_ARRAY || 
+                    static_cast<unsigned int> (RARRAY_LEN(rb_clientData)) != items.GetCount())
+              {
+                rb_raise(rb_eArgError, 
+                         TYPE(rb_clientData) == T_ARRAY ? 
+                            "expected Array for client_data" : 
+                            "client_data Array needs to be equal in size to items Array");
+              }
+
+              std::unique_ptr<wxClientData*[]> cd_arr = std::make_unique<wxClientData*[]> (RARRAY_LEN(rb_clientData));
+              for (int i=0; i<RARRAY_LEN(rb_clientData) ;++i)
+              {
+                cd_arr[i] = new wxRubyClientData(rb_ary_entry(rb_clientData, i));
+              }
+              $self->Set(items, cd_arr.get());
             }
 
             VALUE each_string()
@@ -81,7 +148,7 @@ module WXRuby3
               return rc;
             }
             __HEREDOC
-       end
+        end
       end
 
       def setup_ctrl_with_items(clsnm)

data/rakelib/lib/director/date_picker_ctrl.rb

@@ -25,13 +25,15 @@ module WXRuby3
           VALUE get_range() 
           {
             wxDateTime dt1, dt2;
-            $self->GetRange(&dt1, &dt2);
-       
-            VALUE items = rb_ary_new();
-            rb_ary_push(items, wxRuby_wxDateTimeToRuby(dt1));
-            rb_ary_push(items, wxRuby_wxDateTimeToRuby(dt2));
+            if ($self->GetRange(&dt1, &dt2))
+            {
+              VALUE items = rb_ary_new();
+              rb_ary_push(items, wxRuby_wxDateTimeToRuby(dt1));
+              rb_ary_push(items, wxRuby_wxDateTimeToRuby(dt2));
          
-            return items;
+              return items;
+            }
+            return Qnil;
           }
           __HEREDOC
       end

data/rakelib/lib/director/editable_listbox.rb

@@ -16,6 +16,36 @@ module WXRuby3
 
       def setup
         super
+        # methods missing from docs
+        spec.extend_interface 'wxEditableListBox',
+                              'wxListCtrl* GetListCtrl()',
+                              'wxBitmapButton* GetDelButton()',
+                              'wxBitmapButton* GetNewButton()',
+                              'wxBitmapButton* GetUpButton()',
+                              'wxBitmapButton* GetDownButton()',
+                              'wxBitmapButton* GetEditButton()'
+        # redefine this
+        spec.ignore 'wxEditableListBox::GetStrings', ignore_doc: false
+        spec.add_extend_code 'wxEditableListBox', <<~__HEREDOC
+          VALUE GetStrings()
+          {
+            VALUE rb_list = rb_ary_new(); 
+            wxArrayString list;
+            $self->GetStrings(list);
+            for (unsigned int i=0; i<list.GetCount() ;++i)
+            {
+              rb_ary_push(rb_list, WXSTR_TO_RSTR(list.Item(i)));
+            }
+            return rb_list;
+          }
+          __HEREDOC
+        # map for doc gen
+        spec.map 'wxArrayString& strings' => 'Array<String>', swig: false do
+          map_in ignore: true, code: ''
+          map_argout code: ''
+        end
+        # make sure GetStrings uses the right typemap
+        spec.map_apply 'wxArrayString&' => 'const wxArrayString& strings'
       end
     end # class EditableListBox
 

data/rakelib/lib/director/event.rb

@@ -138,36 +138,46 @@ module WXRuby3
               return INT2NUM(event_type_id);
             }
             __HEREDOC
+          spec.map 'wxObject*' => 'Wx::Object' do
+            map_out code: '$result = wxRuby_WrapWxObjectInRuby($1);'
+          end
           # make Ruby director and wrappers use custom implementation
           spec.use_class_implementation('wxCommandEvent', 'wxRubyCommandEvent')
           spec.ignore %w{
-            wxCommandEvent::GetClientObject
-            wxCommandEvent::SetClientObject
+            wxCommandEvent::GetClientData
+            wxCommandEvent::SetClientData
             wxCommandEvent::GetExtraLong
           }
+          # ignore but keep doc; will replace with custom versions
+          spec.ignore %w[wxCommandEvent::GetClientObject wxCommandEvent::SetClientObject], ignore_doc: false
+          # for doc gen only
+          spec.map 'wxClientData*' => 'Object', swig: false do
+            map_in code: ''
+            map_out code: ''
+          end
           # need this to force alloc func
           spec.make_concrete 'wxCommandEvent'
           spec.add_header_code <<~__HEREDOC
             // Cf wxEvent - has to be written as a C+++ subclass to ensure correct
             // GC/thread protection of Ruby instance variables when user-written
             // event classes are queued.
-            //
-            //
-            // FIXME : intermittent errors with CommandEvent losing the tracked
-            // object before handling - though the same code works fine with Wx::Event
             class WXRUBY_EXPORT wxRubyCommandEvent : public wxCommandEvent
             {
             public:
               wxRubyCommandEvent(wxEventType commandType = wxEVT_NULL, 
-                                 int id = 0) : 
-                wxCommandEvent(commandType, id) { }
-              wxRubyCommandEvent(const wxRubyCommandEvent& cev) :
-                wxCommandEvent(cev) { }
+                                 int id = 0) 
+                : wxCommandEvent(commandType, id) 
+              { }
+              wxRubyCommandEvent(const wxRubyCommandEvent& cev) 
+                : wxCommandEvent(cev) 
+                , has_ruby_data_(cev.has_ruby_data_) 
+              { }
             
               // When the C++ side event is destroyed, unlink from the Ruby object
               // and remove that object from the tracking hash so it can be
               // collected by GC.
-              virtual ~wxRubyCommandEvent() {
+              virtual ~wxRubyCommandEvent() 
+              {
                 SWIG_RubyUnlinkObjects((void*)this);
                 wxRuby_RemoveTracking((void*)this);
               }
@@ -176,7 +186,8 @@ module WXRuby3
               // (often when using Threads), because a clone is queued. So copy the
               // Wx C++ event, create a shallow (dup) of the Ruby event object, and
               // add to the tracking hash so that it is GC-protected
-              virtual wxCommandEvent* Clone() const {
+              virtual wxCommandEvent* Clone() const 
+              {
                 wxRubyCommandEvent* wx_ev = new wxRubyCommandEvent(*this);
             
                 VALUE r_obj = SWIG_RubyInstanceFor((void *)this);
@@ -186,7 +197,86 @@ module WXRuby3
                 wxRuby_AddTracking( (void*)wx_ev, r_obj_dup );
                 return wx_ev;
               }
+
+              bool has_ruby_data_ {};
             };
+
+
+            // wxRuby must preserve ruby objects attached as the ClientData of
+            // command events that have been user-defined in ruby. Some of the
+            // standard wxWidgets CommandEvent classes also use ClientData
+            // for their own purposes, and this must not be marked as the data is
+            // not a ruby object, and will thus crash.
+            WXRUBY_EXPORT void GC_mark_wxEvent(void *ptr)
+            {
+            #ifdef __WXRB_DEBUG__
+              if (wxRuby_TraceLevel()>1)
+                std::wcout << "> GC_mark_wxEvent : " << ptr << std::endl;
+            #endif
+            
+              if ( ! ptr ) return;
+              wxEvent* wx_event = (wxEvent*)ptr;
+            #ifdef __WXRB_DEBUG__
+              if (wxRuby_TraceLevel()>2)
+                std::wcout << "* GC_mark_wxEvent(" << ptr << ":{" << wx_event->GetEventType() << "})" << std::endl;
+            #endif
+              if (wx_event->IsCommandEvent())
+              {
+                wxCommandEvent* wx_cm_event = (wxCommandEvent*)ptr;
+                if (wx_cm_event->GetClientObject() == nullptr && wx_cm_event->GetClientData() != nullptr)
+                {
+                  wxRubyCommandEvent* rbcev = dynamic_cast<wxRubyCommandEvent*> (wx_cm_event);
+                  if (rbcev && rbcev->has_ruby_data_)
+                  {
+                    VALUE rb_client_data = (VALUE)wx_cm_event->GetClientData();
+                    rb_gc_mark(rb_client_data);
+                  }
+                }
+              }
+            
+            #ifdef __WXRB_DEBUG__
+              if (wxRuby_TraceLevel()>1)
+                std::wcout << "< GC_mark_wxEvent : " <<  ptr << std::endl;
+            #endif
+            }
+            __HEREDOC
+          # CommandEvent requires custom handling of client data.
+          # As command events do not 'own' their wxClientData objects we cannot use the regular support
+          # for setting client data from Ruby as that would cause memory leaks by creating wxRubyClientData
+          # instances that would never get deleted.
+          # On the other hand wxWidgets library code might still set wxClientData instances propagated from
+          # control or item client data which needs to be used for returning client data with GetClientObject.
+          # As wxRuby client data always is any arbitrary Ruby Object anyway we simply combine the two approaches wxWidgets
+          # offers here under 1 set of methods.
+          spec.include 'wxruby-ClientData.h'
+          spec.add_extend_code 'wxCommandEvent', <<~__HEREDOC
+            VALUE GetClientObject()
+            {
+              VALUE rc = Qnil;
+              // return Ruby client data depending on what's available
+              if ($self->GetClientObject())
+              {
+                wxRubyClientData* rbcd = dynamic_cast<wxRubyClientData*> ($self->GetClientObject());
+                if (rbcd) rc = rbcd->GetData();
+              }
+              else if ($self->GetClientData() != nullptr)
+              {
+                wxRubyCommandEvent* rbcev = dynamic_cast<wxRubyCommandEvent*> ($self);
+                if (rbcev && rbcev->has_ruby_data_) rc = (VALUE)$self->GetClientData();
+              }
+              return rc;
+            }
+
+            void SetClientObject(VALUE cd)
+            {
+              wxRubyCommandEvent* rbcev = dynamic_cast<wxRubyCommandEvent*> ($self);
+              if (rbcev)
+              {
+                // use SetClientData as not to create memory leaks; GC marker for events will keep it alive
+                $self->SetClientData(NIL_P(cd) ? nullptr : (void*)cd);
+                rbcev->has_ruby_data_ = !NIL_P(cd);
+              }
+            }
             __HEREDOC
           spec.add_wrapper_code <<~__HEREDOC
             extern VALUE wxRuby_GetDefaultEventClass() 

data/rakelib/lib/director/event_filter.rb

@@ -14,7 +14,7 @@ module WXRuby3
 
       def setup
         super
-        spec.gc_as_untracked # no tracking
+        spec.gc_as_marked # not tracked but cached in Ruby
       end
     end # class EventFilter
 

data/rakelib/lib/director/event_handler.rb

@@ -12,6 +12,8 @@ module WXRuby3
 
     class EvtHandler < Director
 
+      include Typemap::ClientData
+
       def setup
         super
         # update generated code for all event handlers
@@ -22,8 +24,7 @@ module WXRuby3
               'wxEvtHandler::Connect',
               'wxEvtHandler::Disconnect')
           spec.ignore(%w[wxEVT_HOTKEY])
-          spec.ignore(%w[wxEvtHandler::SetClientData wxEvtHandler::GetClientData
-                         wxEvtHandler::SetClientObject wxEvtHandler::GetClientObject])
+          spec.ignore(%w[wxEvtHandler::SetClientData wxEvtHandler::GetClientData])
           # Do not see much point in allowing/supporting this to be overridden when we
           # have TryBefore and TryAfter to handle this much cleaner
           spec.no_proxy 'wxEvtHandler::ProcessEvent'

data/rakelib/lib/director/event_loop.rb

@@ -15,7 +15,7 @@ module WXRuby3
       def setup
         super
         spec.items << 'wxEventLoopBase'
-        spec.gc_as_untracked
+        spec.gc_as_marked # untracked but never disowned in Ruby
         spec.disable_proxies
         spec.make_concrete 'wxGUIEventLoop'
         spec.fold_bases 'wxGUIEventLoop' => 'wxEventLoopBase'

data/rakelib/lib/director/file_dialog_customize_hook.rb

@@ -17,8 +17,8 @@ module WXRuby3
       def setup
         super
         spec.items << 'wxFileDialogCustomize'
-        spec.gc_as_untracked 'wxFileDialogCustomizeHook'
-        spec.gc_never 'wxFileDialogCustomize'
+        spec.gc_as_marked 'wxFileDialogCustomizeHook' # not tracked but cached in Ruby
+        spec.gc_as_untracked 'wxFileDialogCustomize'
         spec.make_abstract 'wxFileDialogCustomize'
       end
     end # class FileDialogCustomizeHook

data/rakelib/lib/director/functions.rb

@@ -42,7 +42,7 @@ module WXRuby3
 
           // As the wxw logger will only make synchronous use of the filename, func and component pointers while
           // processing the log entry and never store them we simply gather pointers but no copies 
-          static void do_log(wxLogLevel lvl, int argc, VALUE *argv, ...)
+          static void do_log(wxLogLevel lvl, int argc, VALUE *argv)
           {
             const char* filename = nullptr;
             int line = 0;
@@ -66,7 +66,9 @@ module WXRuby3
                     wxLog::IsLevelEnabled(lvl, wxASCII_STR(component)) )
             {
               VALUE log_msg = argc==1 ? argv[0] : rb_f_sprintf(argc, argv);
-              wxLogger(lvl, filename, line, func, component).Log(RSTR_TO_WXSTR(log_msg));
+              wxLogRecordInfo info(filename, line, func, component);
+              info.timestampMS = wxGetUTCTimeMillis().GetValue();
+              wxLog::OnLog(lvl, RSTR_TO_WXSTR(log_msg), info);
             }
           }
 

data/rakelib/lib/director/generic_dirctrl.rb

@@ -20,6 +20,23 @@ module WXRuby3
         spec.do_not_generate(:variables, :defines, :enums, :functions) # already with DirFilterListCtrl
       end
 
+      def process(gendoc: false)
+        defmod = super
+        # fix documentation errors for generic dirctrl events
+        def_item = defmod.find_item('wxGenericDirCtrl')
+        if def_item
+          def_item.event_types.each do |evt_spec|
+            case evt_spec.first
+            when 'EVT_DIRCTRL_SELECTIONCHANGED', 'EVT_DIRCTRL_FILEACTIVATED'
+              if evt_spec[3].nil?
+                evt_spec[3] = 'wxTreeEvent' # missing from docs
+              end
+            end
+          end
+        end
+        defmod
+      end
+
     end # class GenericDirCtrl
 
   end # class Director

data/rakelib/lib/director/grid_cell_attr.rb

@@ -12,14 +12,12 @@ module WXRuby3
 
     class GridCellAttr < Director
 
-      include Typemap::GridClientData
-
       def setup
         super
         # exposing the mixin wxClientDataContainer/wxSharedClientDataContainer has no real upside
         # for wxRuby; far easier to just use member variables in derived classes
         spec.override_inheritance_chain('wxGridCellAttr', [])
-        spec.gc_as_untracked('wxGridCellAttr')
+        spec.gc_as_marked('wxGridCellAttr') # tailored tracking
         # use custom free func to be able to account for more complex inheritance
         spec.add_header_code <<~__HEREDOC
           static void GC_free_GridCellAttr(void *ptr)

data/rakelib/lib/director/grid_cell_editor.rb

@@ -12,11 +12,9 @@ module WXRuby3
 
     class GridCellEditor < Director
 
-      include Typemap::GridClientData
-
       def setup
         super
-        spec.gc_as_untracked
+        spec.gc_as_marked # tailored tracking method
         # use custom free func to be able to account for more complex inheritance
         spec.add_header_code 'extern void GC_free_GridCellEditor(void *ptr);'
         spec.add_swig_code '%feature("freefunc") wxGridCellEditor "GC_free_GridCellEditor";'

data/rakelib/lib/director/grid_cell_renderer.rb

@@ -12,11 +12,9 @@ module WXRuby3
 
     class GridCellRenderer < Director
 
-      include Typemap::GridClientData
-
       def setup
         super
-        spec.gc_as_untracked
+        spec.gc_as_marked # tailored tracking
         # use custom free func to be able to account for more complex inheritance
         spec.add_header_code 'extern void GC_free_GridCellRenderer(void *ptr);'
         spec.add_swig_code '%feature("freefunc") wxGridCellRenderer "GC_free_GridCellRenderer";'

data/rakelib/lib/director/header_ctrl.rb

@@ -17,6 +17,7 @@ module WXRuby3
       def setup
         super
         spec.items << 'wxHeaderColumn' << 'wxHeaderCtrlSimple' << 'wxSettableHeaderColumn' << 'wxHeaderColumnSimple'
+        spec.gc_as_marked 'wxHeaderColumn', 'wxSettableHeaderColumn', 'wxHeaderColumnSimple'
         spec.regard 'wxHeaderCtrl::GetColumn',
                     'wxHeaderCtrl::UpdateColumnVisibility',
                     'wxHeaderCtrl::UpdateColumnsOrder',
@@ -25,10 +26,17 @@ module WXRuby3
         spec.regard 'wxHeaderCtrlSimple::GetBestFittingWidth'
         spec.extend_interface 'wxHeaderCtrlSimple',
                               'virtual const wxHeaderColumn& GetColumn(unsigned int idx) const',
+                              'virtual void UpdateColumnVisibility(unsigned int idx, bool show)',
+                              'virtual void UpdateColumnsOrder(const wxArrayInt& order)',
                               visibility: 'protected'
         # handled; can be suppressed
         spec.suppress_warning(473, 'wxHeaderCtrl::GetColumn', 'wxHeaderCtrlSimple::GetColumn')
-        spec.do_not_generate :typedefs, :variables, :enums, :defines, :functions
+        # ignore here as already available through HeaderCtrlEvent
+        spec.ignore '@.wxHD_ALLOW_REORDER',
+                    '@.wxHD_ALLOW_HIDE',
+                    '@.wxHD_BITMAP_ON_RIGHT',
+                    '@.wxHD_DEFAULT_STYLE'
+        spec.do_not_generate :typedefs, :variables, :defines, :functions
       end
     end # class HeaderCtrl