wxruby3 0.9.1 → 0.9.3

data/rakelib/lib/director/styled_text_ctrl.rb

@@ -87,6 +87,18 @@ module WXRuby3
         # TODO : these will need some sort of stream solution to be useful
         spec.ignore 'wxStyledTextCtrl::GetCharacterPointer',
                     'wxStyledTextCtrl::GetRangePointer'
+        spec.add_extend_code 'wxStyledTextCtrl', <<~__HEREDOC
+          VALUE each_line()
+          {
+            VALUE rc = Qnil;
+            for (int i=0; i<$self->GetNumberOfLines() ;++i)
+            {
+              VALUE rb_ln = WXSTR_TO_RSTR($self->GetLineText(i));
+              rc = rb_yield(rb_ln);
+            }
+            return rc;
+          }
+          __HEREDOC
         spec.do_not_generate(:variables, :enums, :defines, :functions)
       end
     end # class StyledTextCtrl

data/rakelib/lib/director/task_bar_button.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 wxWidgets interface director
+###
+
+module WXRuby3
+
+  class Director
+
+    class TaskBarButton < Director
+
+      def setup
+        super
+        spec.items << 'wxThumbBarButton'
+        spec.no_proxy 'wxTaskBarButton'
+        spec.gc_as_untracked 'wxTaskBarButton', 'wxThumbBarButton'
+        spec.disown 'wxThumbBarButton *button'
+        # superfluous and causing trouble for disown policy (re-implemented in pure Ruby)
+        spec.ignore 'wxTaskBarButton::RemoveThumbBarButton(wxThumbBarButton*)', ignore_doc: false
+        spec.new_object 'wxTaskBarButton::RemoveThumbBarButton(int)'
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/director/task_bar_icon.rb

@@ -16,7 +16,7 @@ module WXRuby3
 
       def setup
         super
-        spec.gc_never
+        spec.gc_as_object
         # need a custom implementation to handle event handler proc cleanup
         spec.add_header_code <<~__HEREDOC
           class WXRubyTaskBarIcon : public wxTaskBarIcon
@@ -26,9 +26,11 @@ module WXRuby3
             virtual ~WXRubyTaskBarIcon() 
             {
               wxRuby_ReleaseEvtHandlerProcs(this);
-            }               
+              SWIG_RubyUnlinkObjects(this);
+              SWIG_RubyRemoveTracking(this);
+            }
           };
-        __HEREDOC
+          __HEREDOC
         spec.use_class_implementation 'wxTaskBarIcon', 'WXRubyTaskBarIcon'
         # this one is protected so ignored by default but we want it here
         # (we do not want GetPopupMenu available for override in Ruby)
@@ -61,16 +63,6 @@ module WXRuby3
             }
             __CODE
         end
-        spec.add_extend_code 'wxTaskBarIcon', <<~__HEREDOC
-          // Explicitly dispose of a TaskBarIcon; needed for clean exits on
-          // Windows.
-          VALUE destroy()
-          {
-            delete $self;
-            return Qnil;
-          }
-          __HEREDOC
-        # already generated with TaskBarIconEvent
         spec.do_not_generate :variables, :enums, :defines, :functions
       end
     end # class TaskBarIcon

data/rakelib/lib/director/text_entry.rb

@@ -26,6 +26,10 @@ module WXRuby3
         spec.add_header_code '#define wxTextEntry wxTextEntryBase'
         spec.disown 'wxTextCompleter *completer' # managed by wxWidgets after passing in
         spec.map_apply 'long * OUTPUT' => 'long *' # for GetSelection
+        # missing non-pure virtual overrides in docs for wxTextCompleterSimple
+        spec.extend_interface 'wxTextCompleterSimple',
+                              'virtual bool Start(const wxString &prefix)',
+                              'virtual wxString GetNext()'
         # for wxTextCompleterSimple::GetCompletions
         spec.map 'wxArrayString &res' => 'Array<String>' do
 

data/rakelib/lib/director/text_validator.rb

@@ -6,48 +6,159 @@
 # wxRuby3 wxWidgets interface director
 ###
 
-require_relative './event_handler'
+require_relative './validator'
 
 module WXRuby3
 
   class Director
 
-    class TextValidator < EvtHandler
+    class TextValidator < Validator
 
       def setup
         super
         # need a custom implementation to handle event handler proc cleanup
         spec.add_header_code <<~__HEREDOC
-          class WXRubyTextValidator : public wxTextValidator
+          class WXRubyTextValidator : public wxTextValidator, public wxRubyValidatorBinding
           {
           public:
-            WXRubyTextValidator(const wxTextValidator& v) 
-              : wxTextValidator(v) {}
             WXRubyTextValidator(long style=wxFILTER_NONE) 
-              : wxTextValidator(style) {}
+              : wxTextValidator(style, &m_valueCache) 
+            {
+            }
+            WXRubyTextValidator(const WXRubyTextValidator& other) 
+              : wxTextValidator(other.GetStyle(), &m_valueCache)
+              , wxRubyValidatorBinding(other)
+            {
+            }
             virtual ~WXRubyTextValidator() 
             {
               wxRuby_ReleaseEvtHandlerProcs(this);
-            }               
+            }
+
+            virtual wxObject* Clone() const override
+            {
+              WXRubyTextValidator* clone = new WXRubyTextValidator(*this);
+              clone->m_valueCache = this->m_valueCache;
+              return clone;
+            }
+
+            virtual void SetWindow(wxWindow *win) override
+            {
+              this->wxTextValidator::SetWindow(win);
+              VALUE self = this->get_self();
+              // make sure Ruby does not own this validator instance anymore
+              RDATA(self)->dfree = SWIG_RubyRemoveTracking;
+            } 
+
+            virtual bool TransferFromWindow () override 
+            {
+              // call super 
+              if (this->wxTextValidator::TransferFromWindow())
+              {
+                // ok, data is retrieved from window and cached
+                // now allow any defined binding handler to pass on the data
+                return this->DoOnTransferFromWindow(WXSTR_TO_RSTR(m_valueCache));
+              } 
+              return false;
+            }
+            virtual bool TransferToWindow () override 
+            { 
+              // collect data from any defined binding handler
+              VALUE data = this->DoOnTransferToWindow();
+              // if Qnil returned there is no data returned from handler so we just keep what's in the store
+              if (!NIL_P(data))
+              {
+                m_valueCache = RSTR_TO_WXSTR(data);
+              }
+              // now allow standard functionality to transfer to window 
+              return this->wxTextValidator::TransferToWindow();
+            }
+
+            const wxString& GetValue () const
+            {
+              return m_valueCache;
+            }
+
+            void SetValue (const wxString& val)
+            {
+              m_valueCache = val;
+            }
+
+          private:
+            static VALUE c_TextValidator; 
+
+            virtual VALUE get_self() override
+            {
+              if (NIL_P(this->self_))
+              {
+                this->self_ = SWIG_RubyInstanceFor(this);
+                // if this is a C++ created clone (wxWidgets clones validators that are set) it's not tracked yet
+                if (NIL_P(this->self_))
+                {
+                  if (NIL_P(c_TextValidator))
+                  {
+                    c_TextValidator = rb_const_get(mWxCore, rb_intern("TextValidator"));
+                  }
+                  swig_type_info* swig_type = wxRuby_GetSwigTypeForClass(c_TextValidator);
+                  this->self_ = SWIG_NewPointerObj(this, swig_type, 0); // wrap but don't make Ruby own it
+                }
+              }
+              return this->self_; 
+            }
+
+            wxString m_valueCache;               
           };
-        __HEREDOC
+
+          VALUE WXRubyTextValidator::c_TextValidator = Qnil;
+
+          static void GC_mark_wxTextValidator(void* ptr)
+          {
+            if (ptr)
+            {
+              wxValidator* vp = reinterpret_cast<wxValidator*> (ptr);
+              WXRubyTextValidator* rbvp = dynamic_cast<WXRubyTextValidator*> (vp);
+              // This might be a pointer to a non-customized validator (or clone thereof) created internally 
+              // by wxWidgets C++ code 
+              if (rbvp) rbvp->GC_Mark();
+            }
+          } 
+
+          __HEREDOC
+        spec.add_swig_code '%markfunc wxTextValidator "GC_mark_wxTextValidator";'
+        # make Ruby director and wrappers use custom implementation
         spec.use_class_implementation 'wxTextValidator', 'WXRubyTextValidator'
-        # ignore copy ctor doc
-        spec.regard 'wxTextValidator::wxTextValidator(const wxTextValidator&)', regard_doc: false
         # ignore this ctor
         spec.ignore 'wxTextValidator::wxTextValidator(long, wxString*)'
         # add alternative
         spec.extend_interface 'wxTextValidator', 'wxTextValidator(long style=wxFILTER_NONE)'
-        # ignore non-virtual standard handler (not really useful in Ruby)
+        # add wxRuby extensions
+        spec.add_extend_code 'wxTextValidator', <<~__HEREDOC
+          VALUE GetValue()
+          {
+            WXRubyTextValidator* rb_self = dynamic_cast<WXRubyTextValidator*> ($self);
+            if (rb_self)
+              return WXSTR_TO_RSTR(rb_self->GetValue());
+            else
+              return Qnil;
+          }
+
+          void SetValue(const wxString& val)
+          {
+            WXRubyTextValidator* rb_self = dynamic_cast<WXRubyTextValidator*> ($self);
+            if (rb_self)
+              rb_self->SetValue(val);
+          }
+          __HEREDOC
+        # ignore non-virtual standard handler (not useful in Ruby)
         spec.ignore 'wxTextValidator::OnChar'
-        spec.no_proxy 'wxTextValidator::Clone'
         spec.new_object 'wxTextValidator::Clone'
         # handle clone mapping
         spec.map 'wxObject *' => 'Wx::TextValidator' do
           map_out code: <<~__CODE
-            $result = SWIG_NewPointerObj(SWIG_as_voidptr($1), SWIGTYPE_p_wxTextValidator, SWIG_POINTER_OWN |  0 );
+            $result = SWIG_NewPointerObj(SWIG_as_voidptr($1), SWIGTYPE_p_wxTextValidator, SWIG_POINTER_OWN);
             __CODE
         end
+        spec.suppress_warning(473, 'wxTextValidator::Clone')
         # not provided in Ruby
         spec.ignore %w[wxTextValidator::TransferFromWindow wxTextValidator::TransferToWindow]
       end

data/rakelib/lib/director/textctrl.rb

@@ -32,7 +32,7 @@ module WXRuby3
         # we will not wrap it but create a simplified interface when USE_SPELLCHECK is enabled which
         # we will complement in pure Ruby to provide Wx::TextProofOptions class
         spec.ignore('wxTextCtrl::EnableProofCheck', 'wxTextCtrl::GetProofCheckOptions')
-        if Config.instance.features_set?('wxUSE_SPELLCHECK')
+        if Config.instance.features_set?('USE_SPELLCHECK')
           spec.add_extend_code 'wxTextCtrl', <<~__HEREDOC
             VALUE DoEnableProofCheck(bool spelling, bool grammar, const wxString& language)
             {
@@ -99,6 +99,17 @@ module WXRuby3
             else if(TYPE(value)==T_FLOAT)
               *self << (double)(RFLOAT_VALUE(value));
           }
+
+          VALUE each_line()
+          {
+            VALUE rc = Qnil;
+            for (int i=0; i<$self->GetNumberOfLines() ;++i)
+            {
+              VALUE rb_ln = WXSTR_TO_RSTR($self->GetLineText(i));
+              rc = rb_yield(rb_ln);
+            }
+            return rc;
+          }
           __HEREDOC
         spec.swig_import 'swig/classes/include/wxTextAttr.h'
       end

data/rakelib/lib/director/toggle_button.rb

@@ -15,6 +15,7 @@ module WXRuby3
     class ToggleButton < Window
 
       def setup
+        spec.items << 'wxBitmapToggleButton'
         spec.include('wx/tglbtn.h')
         super
       end

data/rakelib/lib/director/tool_tip.rb

@@ -13,7 +13,7 @@ module WXRuby3
     class ToolTip < Director
 
       def setup
-        spec.ignore('wxToolTip::SetMaxWidth') unless Config.instance.features_set?('__WXMSW__')
+        spec.ignore_unless('WXMSW', 'wxToolTip::SetMaxWidth')
         super
       end
     end # class ToolTip

data/rakelib/lib/director/top_level_window.rb

@@ -26,10 +26,8 @@ module WXRuby3
           # for upcalls
           spec.extend_interface('wxTopLevelWindow',
                                 'virtual bool Destroy() override',
-                                #'virtual bool IsTopLevel() override',
                                 'virtual void SetLayoutDirection(wxLayoutDirection dir) override',
                                 'virtual bool Show(bool show = true) override',
-                                'virtual void Raise() override',
                                 'virtual void Refresh(bool eraseBackground = true, wxRect const *rect = NULL) override')
           spec.add_wrapper_code <<~__HEREDOC
             extern VALUE wxRuby_GetTopLevelWindowClass() {
@@ -41,15 +39,14 @@ module WXRuby3
             wxTopLevelWindow::RestoreToGeometry
             wxTopLevelWindow::GeometrySerializer
           }
-          unless Config.instance.features_set?('__WXUNIVERSAL__')
-            spec.ignore %w{
+          # #ignore_unless if wxRuby one day supports 'WXUNIVERSAL'
+          spec.ignore %w{
             wxTopLevelWindow::IsUsingNativeDecorations
             wxTopLevelWindow::UseNativeDecorations
             wxTopLevelWindow::UseNativeDecorationsByDefault
             }
-          end
-          spec.ignore('wxTopLevelWindow::MSWGetSystemMenu') unless Config.instance.features_set?('__WXMSW__')
-          spec.ignore('wxTopLevelWindow::OSXSetModified','wxTopLevelWindow::OSXIsModified') unless Config.instance.features_set?('__WXOSX__')
+          spec.ignore_unless('WXMSW', 'wxTopLevelWindow::MSWGetSystemMenu')
+          spec.ignore_unless('WXOSX', 'wxTopLevelWindow::OSXSetModified','wxTopLevelWindow::OSXIsModified')
           spec.swig_import 'swig/classes/include/wxDefs.h'
           # incorrectly documented here
           spec.override_events 'wxTopLevelWindow',

data/rakelib/lib/director/tree_ctrl.rb

@@ -50,6 +50,41 @@ module WXRuby3
           wxTreeCtrl::GetFirstChild
           wxTreeCtrl::GetNextChild
           ]
+        if Config.instance.wx_version >= '3.3.0'
+          # new method with bitmap bundle vector
+          spec.no_proxy 'wxTreeCtrl::SetStateImages'
+          spec.map 'const wxVector<wxBitmapBundle>& images' => 'Array<Wx::ImageBundle>' do
+            map_in temp: 'wxVector<wxBitmapBundle> tmp', code: <<~__CODE
+            if ($input != Qnil)
+            {
+              if (TYPE($input) == T_ARRAY)
+              {
+                for (int i=0; i<RARRAY_LEN($input) ;++i)
+                {
+                  void* ptr;
+                  VALUE rb_image = rb_ary_entry($input, i);
+                  int res = SWIG_ConvertPtr(rb_image, &ptr, wxRuby_GetSwigTypeForClassName("BitmapBundle"), 0);
+                  if (!SWIG_IsOK(res)) 
+                  {
+                    VALUE msg = rb_inspect(rb_image);
+                    rb_raise(rb_eTypeError, "Expected Wx::ImageBundle at index %d but got %s", i, StringValuePtr(msg));
+                  }
+                  tmp.push_back(*static_cast<wxBitmapBundle*>(ptr));
+                }
+              }
+              else
+              {
+                VALUE msg = rb_inspect($input);
+                rb_raise(rb_eArgError, "Expected Array of Wx::ImageBundle for $argnum but got %s", StringValuePtr(msg));
+              }
+            }
+            $1 = &tmp;
+            __CODE
+          end
+        end
+        # don't see how supporting overloading this one in Ruby is helpful
+        # (also seeing SetButtonsImageList isn't virtual at all)
+        spec.no_proxy 'wxTreeCtrl::SetStateImageList'
         # these are potentially involved in GC mark phase so
         # we can't have them redirecting to Ruby calls
         spec.no_proxy %w[
@@ -75,7 +110,7 @@ module WXRuby3
           wxTreeCtrl::GetFocusedItem
           wxTreeCtrl::GetSelection
           ]
-        if Config.instance.features_set?('wxHAS_LAST_VISIBLE')
+        if Config.instance.features_set?('HAS_LAST_VISIBLE')
           spec.no_proxy 'wxTreeCtrl::GetLastVisible'
         end
         # simply a nuisance to support
@@ -84,7 +119,7 @@ module WXRuby3
           wxTreeCtrl::EndEditLabel
           ]
         # for now, ignore this version as the added customization features
-        # do not work as yet and may cause us more trouble than it's worth
+        # work only on WXMSW as yet and may cause us more trouble than it's worth
         spec.ignore 'wxTreeCtrl::EditLabel'
         # add simplified non-virtual version
         spec.add_extend_code 'wxTreeCtrl', <<~__HEREDOC
@@ -94,10 +129,9 @@ module WXRuby3
             (void)self->EditLabel(item);
           }
           __HEREDOC
-        if [:wxmsw, :wxqt].include?(Config.instance.wx_port)
-          spec.ignore('wxTreeCtrl::SetButtonsImageList')
-          spec.ignore('wxTreeCtrl::GetButtonsImageList')
-        end
+        spec.ignore_unless(Config::AnyOf.new(*%w[WXGTK WXOSX]),
+                           'wxTreeCtrl::SetButtonsImageList',
+                           'wxTreeCtrl::GetButtonsImageList')
         # these reimplemented window base methods need to be properly wrapped but
         # are missing from the XML docs
         spec.extend_interface('wxTreeCtrl',

data/rakelib/lib/director/utils.rb

@@ -41,8 +41,22 @@ module WXRuby3
           wxNow
           wxDecToHex
           wxHexToDec
-          wxStripMenuCodes
           ]
+        # ignore these enum(erator)s
+        spec.ignore %w[
+          wxSignal
+          wxKillError
+          wxKillFlags
+          wxShutdownFlags
+          @.wxEXEC_ASYNC
+          @.wxEXEC_SYNC
+          @.wxEXEC_SHOW_CONSOLE
+          @.wxEXEC_MAKE_GROUP_LEADER
+          @.wxEXEC_NODISABLE
+          @.wxEXEC_NOEVENTS
+          @.wxEXEC_HIDE_CONSOLE
+          @.wxEXEC_BLOCK
+        ]
         spec.ignore 'wxPostDelete'  unless Config.instance.wx_version >= '3.3.0'
         spec.ignore 'wxGetEmailAddress(char *,int)',
                     'wxGetUserId(char *,int)',
@@ -53,7 +67,7 @@ module WXRuby3
             __CODE
         end
         # we want only the functions that are not ignored
-        spec.do_not_generate(:classes, :typedefs, :variables, :enums, :defines)
+        spec.do_not_generate(:classes, :typedefs, :variables, :defines)
         super
       end
     end # class Utils