wxruby3 0.9.2 → 0.9.4

data/rakelib/lib/director/numeric_property_validator.rb

@@ -6,31 +6,156 @@
 # wxRuby3 wxWidgets interface director
 ###
 
-require_relative './event_handler'
+require_relative './validator'
 
 module WXRuby3
 
   class Director
 
-    class NumericPropertyValidator < EvtHandler
+    class NumericPropertyValidator < Validator
 
       def setup
         super
         # need a custom implementation to handle event handler proc cleanup
         spec.add_header_code <<~__HEREDOC
-          class WXRubyNumericPropertyValidator : public wxNumericPropertyValidator
+          class WXRubyNumericPropertyValidator : public wxNumericPropertyValidator, public wxRubyValidatorBinding
           {
           public:
             WXRubyNumericPropertyValidator(NumericType numericType, int base=10) 
-              : wxNumericPropertyValidator(numericType, base) {}
+              : wxNumericPropertyValidator(numericType, base) 
+            {
+              m_stringValue = &m_valueCache;
+            }
+            WXRubyNumericPropertyValidator(const WXRubyNumericPropertyValidator& other) 
+              : wxNumericPropertyValidator(other)
+              , wxRubyValidatorBinding(other) 
+            {
+              m_stringValue = &m_valueCache;
+            }
             virtual ~WXRubyNumericPropertyValidator() 
             {
               wxRuby_ReleaseEvtHandlerProcs(this);
             }               
+
+            virtual wxObject* Clone() const override
+            {
+              WXRubyNumericPropertyValidator *clone = new WXRubyNumericPropertyValidator(*this);
+              clone->m_valueCache = this->m_valueCache;
+              return clone;
+            }
+
+            virtual void SetWindow(wxWindow *win) override
+            {
+              this->wxNumericPropertyValidator::SetWindow(win);
+              VALUE self = 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->wxNumericPropertyValidator::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->wxNumericPropertyValidator::TransferToWindow();
+            }
+
+            const wxString& GetValue () const
+            {
+              return m_valueCache;
+            }
+
+            void SetValue (const wxString& val)
+            {
+              m_valueCache = val;
+            }
+
+          private:
+            static VALUE c_NumericPropertyValidator; 
+
+            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_NumericPropertyValidator))
+                  {
+                    c_NumericPropertyValidator = rb_eval_string("Wx::PG::NumericPropertyValidator");
+                  }
+                  swig_type_info* swig_type = wxRuby_GetSwigTypeForClass(c_NumericPropertyValidator);
+                  this->self_ = SWIG_NewPointerObj(this, swig_type, 0); // wrap but don't make Ruby own it
+                }
+              }
+              return this->self_; 
+            }
+
+            wxString m_valueCache;               
           };
-        __HEREDOC
+
+          VALUE WXRubyNumericPropertyValidator::c_NumericPropertyValidator = Qnil;
+
+          static void GC_mark_wxNumericPropertyValidator(void* ptr)
+          {
+            if (ptr)
+            {
+              wxValidator* vp = reinterpret_cast<wxValidator*> (ptr);
+              WXRubyNumericPropertyValidator* rbvp = dynamic_cast<WXRubyNumericPropertyValidator*> (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 wxValidator "GC_mark_wxValidator";'
+        # make Ruby director and wrappers use custom implementation
         spec.use_class_implementation 'wxNumericPropertyValidator', 'WXRubyNumericPropertyValidator'
-        spec.no_proxy 'wxNumericPropertyValidator::Clone'
+        spec.new_object 'wxNumericPropertyValidator::Clone'
+        # add wxRuby extensions
+        spec.add_extend_code 'wxNumericPropertyValidator', <<~__HEREDOC
+          VALUE GetValue()
+          {
+            WXRubyNumericPropertyValidator* rb_self = dynamic_cast<WXRubyNumericPropertyValidator*> ($self);
+            if (rb_self)
+              return WXSTR_TO_RSTR(rb_self->GetValue());
+            else
+              return Qnil;
+          }
+
+          void SetValue(const wxString& val)
+          {
+            WXRubyNumericPropertyValidator* rb_self = dynamic_cast<WXRubyNumericPropertyValidator*> ($self);
+            if (rb_self)
+              rb_self->SetValue(val);
+          }
+          __HEREDOC
+        # handle clone mapping
+        spec.map 'wxObject *' => 'Wx::PG::NumericPropertyValidator' do
+          map_out code: <<~__CODE
+            $result = SWIG_NewPointerObj(SWIG_as_voidptr($1), SWIGTYPE_p_wxTextValidator, SWIG_POINTER_OWN);
+            __CODE
+        end
+        spec.suppress_warning(473, 'wxNumericPropertyValidator::Clone')
+        spec.extend_interface 'wxNumericPropertyValidator',
+                              'wxNumericPropertyValidator(const wxNumericPropertyValidator &other)'
         spec.do_not_generate :variables, :defines, :enums, :functions
       end
 

data/rakelib/lib/director/owner_drawn_combobox.rb

@@ -0,0 +1,192 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 wxWidgets interface director
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class OwnerDrawnComboBox < Window
+
+      include Typemap::ClientData
+
+      def setup
+        super
+        spec.items << 'wxItemContainer'
+        # override inheritance chain
+        spec.override_inheritance_chain('wxOwnerDrawnComboBox', %w[wxComboCtrl wxControl wxWindow wxEvtHandler wxObject])
+        spec.fold_bases('wxOwnerDrawnComboBox' => %w[wxItemContainer])
+        spec.regard %w[
+          wxOwnerDrawnComboBox::OnDrawBackground
+          wxOwnerDrawnComboBox::OnDrawItem
+          wxOwnerDrawnComboBox::OnMeasureItem
+          wxOwnerDrawnComboBox::OnMeasureItemWidth
+        ]
+        # unuseful overloads
+        spec.ignore 'wxOwnerDrawnComboBox::wxOwnerDrawnComboBox(wxWindow *, wxWindowID, const wxString &, const wxPoint &, const wxSize &, int, const wxString [], long, const wxValidator &, const wxString &)',
+                    'wxOwnerDrawnComboBox::Create(wxWindow *, wxWindowID, const wxString &, const wxPoint &, const wxSize &, int, const wxString [], long, const wxValidator &, const wxString &)'
+        spec.ignore('wxItemContainer::Append(const wxString &, void *)',
+                    'wxItemContainer::Append(const std::vector< wxString > &)',
+                    '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, void *)',
+                    'wxItemContainer::Insert(const std::vector< wxString > &)',
+                    '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 &, void **)',
+                    'wxItemContainer::Set(unsigned int, const wxString *)',
+                    'wxItemContainer::Set(unsigned int, const wxString *, void **)',
+                    'wxItemContainer::Set(unsigned int, const wxString *, wxClientData **)',
+                    'wxItemContainer::GetClientData',
+                    'wxItemContainer::SetClientData',
+                    'wxItemContainer::HasClientUntypedData',
+                    'wxItemContainer::Clear')
+        # ignore these but keep docs; will add custom versions below
+        spec.ignore([
+                      'wxItemContainer::DetachClientObject',
+                      'wxItemContainer::Append(const wxArrayString &, wxClientData **)',
+                      'wxItemContainer::Insert(const wxArrayString &, unsigned int, wxClientData **)',
+                      'wxItemContainer::Set(const wxArrayString &, wxClientData **)'], ignore_doc: false)
+        # ambiguous
+        spec.ignore 'wxOwnerDrawnComboBox::IsEmpty', ignore_doc: false
+        # missing from docs; needed to override TextEntry version
+        spec.extend_interface 'wxOwnerDrawnComboBox', 'void Clear()'
+        # missing from docs; required so proxy calls correct override
+        spec.extend_interface 'wxOwnerDrawnComboBox',
+                              'virtual void DoSetPopupControl(wxComboPopup* popup)',
+                              visibility: 'protected'
+        # missing from docs; implementations of wxItemContainerImmutable methods
+        spec.extend_interface 'wxOwnerDrawnComboBox',
+                              'unsigned int GetCount() const',
+                              'wxString GetString(unsigned int n) const',
+                              'void SetString(unsigned int n, const wxString& s)',
+                              'int FindString(const wxString& s, bool bCase = false) const',
+                              'void Select(int n)',
+                              'wxArrayString GetStrings() const'
+        # for doc only
+        spec.map 'void** clientData' => 'Array', swig: false do
+          map_in code: ''
+        end
+        # Replace the old Wx definitions of these methods adding
+        # proper checks on the data arrays.
+        # Also add an item enumerator.
+        spec.add_extend_code 'wxOwnerDrawnComboBox', <<~__HEREDOC
+          wxString GetListStringSelection()
+          {
+            return $self->wxItemContainerImmutable::GetStringSelection();
+          } 
+
+          bool SetListStringSelection(const wxString& string)
+          {
+            return $self->wxItemContainerImmutable::SetStringSelection(string);
+          } 
+
+          void SetListSelection(int n)
+          {
+            $self->SetSelection(n);
+          }
+
+          int GetListSelection()
+          {
+            return $self->GetSelection();
+          }
+
+          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()
+          {
+            VALUE rc = Qnil;
+            for (unsigned int i=0; i<$self->GetCount() ;++i)
+            {
+              VALUE rb_s = WXSTR_TO_RSTR($self->GetString(i));
+              rc = rb_yield(rb_s);
+            }
+            return rc;
+          }
+          __HEREDOC
+      end
+
+    end # class OwnerDrawnComboBox
+
+  end # class Director
+
+end # module WXRuby3