wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/director/pen.rb

@@ -0,0 +1,174 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Pen < Director
+
+      def setup
+        super
+        spec.items << 'wxPenInfo'
+        spec.gc_as_temporary 'wxPenInfo'
+        spec.disable_proxies
+        spec.add_header_code <<~__HEREDOC
+          // special free funcs are needed to clean up Dashes array if it has been
+          // set; wxWidgets does not do this automatically so will leak if not
+          // dealt with.
+          void GC_free_wxPen(wxPen *pen) 
+          {
+            SWIG_RubyRemoveTracking(pen);
+            if (pen && pen->IsOk ())
+            {
+              wxDash *dashes;
+              int dash_count = pen->GetDashes(&dashes);
+              if ( dash_count )
+                delete dashes;
+            }
+            delete pen;
+          }
+          void GC_free_wxPenInfo(wxPenInfo *pen_info) 
+          {
+            SWIG_RubyRemoveTracking(pen_info);
+            if (pen_info)
+            {
+              wxDash *dashes;
+              int dash_count = pen_info->GetDashes(&dashes);
+              if ( dash_count )
+                delete dashes;
+            }
+            delete pen_info;
+          }
+          __HEREDOC
+        spec.add_swig_code '%feature("freefunc") wxPen "GC_free_wxPen";'
+        spec.add_swig_code '%feature("freefunc") wxPenInfo "GC_free_wxPenInfo";'
+        # all but the default ctor require a running App
+        spec.require_app 'wxPen::wxPen(const wxPenInfo &info)',
+                         'wxPen::wxPen(const wxColour &colour, int width, wxPenStyle style)',
+                         'wxPen::wxPen(const wxBitmap &stipple, int width)',
+                         'wxPen::wxPen(const wxPen &pen)'
+        # ignore because of memory management issue
+        spec.ignore 'wxPen::wxPen(const wxPenInfo &)'
+        # add our own
+        spec.add_extend_code 'wxPen', <<~__HEREDOC
+          wxPen(const wxPenInfo &info)
+          {
+            if (!wxRuby_IsAppRunning()) 
+              rb_raise(rb_eRuntimeError, "Contract violation: require: (wxRuby_IsAppRunning())");
+
+            wxPen* new_pen = new wxPen(info.GetColour(), info.GetWidth(), info.GetStyle());
+            new_pen->SetJoin(info.GetJoin());
+            new_pen->SetCap(info.GetCap());
+            // copy the dashes
+            wxDash* new_dashes = new wxDash[info.GetDashCount()];
+            for (int i = 0; i < info.GetDashCount(); i++)
+            {
+              new_dashes[i] = info.GetDash()[i];
+            }
+            new_pen->SetDashes(info.GetDashCount(), new_dashes);
+            return new_pen;
+          }
+          __HEREDOC
+        # dealt with below - these require special handling becaause of the use
+        # of wxDash array, which cannot be freed until the pen(info) is disposed of
+        # or until a new dash pattern is specified.
+        spec.ignore(%w[wxPen::GetDashes wxPen::SetDashes wxPenInfo::GetDashes wxPenInfo::Dashes], ignore_doc: false)
+        spec.ignore 'wxPenInfo::GetDash'
+        spec.add_extend_code 'wxPen', <<~__HEREDOC
+          // Returns a ruby array with the dash lengths
+          VALUE get_dashes() 
+          {
+            VALUE rb_dashes = rb_ary_new();
+            wxDash* dashes;
+            int dash_count = $self->GetDashes(&dashes);
+            for ( int i = 0; i < dash_count; i++ )
+            {
+              rb_ary_push(rb_dashes, INT2NUM(dashes[i]));
+            }
+            return rb_dashes;
+          }
+        
+          // Sets the dashes to have the lengths defined in the ruby array of ints
+          void set_dashes(VALUE rb_dashes) 
+          {
+            // Check right parameter type
+            if ( TYPE(rb_dashes) != T_ARRAY )
+              rb_raise(rb_eTypeError, 
+                       "Wrong argument type for set_dashes, should be Array");
+        
+            // Get old value in case it needs to be deallocated to avoid leaking
+            wxDash* old_dashes;
+            int old_dashes_count = $self->GetDashes(&old_dashes);
+        
+            // Create a C++ wxDash array to hold the new dashes, and populate
+            int new_dash_count = RARRAY_LEN(rb_dashes);
+            wxDash* new_dashes = new wxDash[ new_dash_count ];
+            for ( int i = 0; i < new_dash_count; i++ )
+            {
+              new_dashes[i] = NUM2INT(rb_ary_entry(rb_dashes, i));
+            }
+            $self->SetDashes(new_dash_count, new_dashes);
+        
+            // Clean up the old if it existed
+            if ( old_dashes_count )
+              delete old_dashes;
+          }
+          __HEREDOC
+        spec.add_extend_code 'wxPenInfo', <<~__HEREDOC
+          // Returns a ruby array with the dash lengths
+          VALUE get_dashes() 
+          {
+            VALUE rb_dashes = rb_ary_new();
+            wxDash* dashes;
+            int dash_count = $self->GetDashes(&dashes);
+            for ( int i = 0; i < dash_count; i++ )
+            {
+              rb_ary_push(rb_dashes, INT2NUM(dashes[i]));
+            }
+            return rb_dashes;
+          }
+        
+          // Sets the dashes to have the lengths defined in the ruby array of ints
+          void dashes(VALUE rb_dashes) 
+          {
+            // Check right parameter type
+            if ( TYPE(rb_dashes) != T_ARRAY )
+              rb_raise(rb_eTypeError, 
+                       "Wrong argument type for set_dashes, should be Array");
+        
+            // Get old value in case it needs to be deallocated to avoid leaking
+            wxDash* old_dashes;
+            int old_dashes_count = $self->GetDashes(&old_dashes);
+        
+            // Create a C++ wxDash array to hold the new dashes, and populate
+            int new_dash_count = RARRAY_LEN(rb_dashes);
+            wxDash* new_dashes = new wxDash[ new_dash_count ];
+            for ( int i = 0; i < new_dash_count; i++ )
+            {
+              new_dashes[i] = NUM2INT(rb_ary_entry(rb_dashes, i));
+            }
+            $self->Dashes(new_dash_count, new_dashes);
+        
+            // Clean up the old if it existed
+            if ( old_dashes_count )
+              delete old_dashes;
+          }
+        __HEREDOC
+        spec.map 'wxPenInfo &' => 'Wx::PenInfo' do
+          map_out code: '$result = self; wxUnusedVar($1);'
+        end
+        # for SetColour
+        spec.map_apply 'const wxColour&' => ['wxColour&']
+        # these are defined and loaded in RubyStockObjects.i
+        spec.ignore %w[
+          wxRED_PEN wxBLUE_PEN wxCYAN_PEN wxGREEN_PEN wxYELLOW_PEN wxBLACK_PEN wxWHITE_PEN
+          wxTRANSPARENT_PEN wxBLACK_DASHED_PEN wxGREY_PEN wxMEDIUM_GREY_PEN wxLIGHT_GREY_PEN wxThePenList]
+      end
+    end # class Pen
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/pgarray_editor_dialog.rb

@@ -0,0 +1,64 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './dialog'
+
+module WXRuby3
+
+  class Director
+
+    class PGArrayEditorDialog < Dialog
+
+      def setup
+        spec.items << 'wxPGArrayStringEditorDialog'
+        super
+        spec.regard 'wxPGArrayEditorDialog::ArrayGet',
+                    'wxPGArrayEditorDialog::ArrayGetCount',
+                    'wxPGArrayEditorDialog::ArrayInsert',
+                    'wxPGArrayEditorDialog::ArraySet',
+                    'wxPGArrayEditorDialog::ArrayRemoveAt',
+                    'wxPGArrayEditorDialog::ArraySwap',
+                    'wxPGArrayEditorDialog::OnCustomNewAction',
+                    'wxPGArrayEditorDialog::m_elb',
+                    'wxPGArrayEditorDialog::m_elbSubPanel',
+                    'wxPGArrayEditorDialog::m_lastFocused',
+                    'wxPGArrayEditorDialog::m_itemPendingAtIndex',
+                    'wxPGArrayEditorDialog::m_modified',
+                    'wxPGArrayEditorDialog::m_hasCustomNewAction'
+        spec.rename_for_ruby 'elb_' => 'wxPGArrayEditorDialog::m_elb',
+                             'elb_sub_panel_' => 'wxPGArrayEditorDialog::m_elbSubPanel',
+                             'last_focused_' => 'wxPGArrayEditorDialog::m_lastFocused',
+                             'item_pending_at_index_' => 'wxPGArrayEditorDialog::m_itemPendingAtIndex',
+                             'modified_' => 'wxPGArrayEditorDialog::m_modified',
+                             'has_custom_new_action_' => 'wxPGArrayEditorDialog::m_hasCustomNewAction'
+        spec.extend_interface 'wxPGArrayStringEditorDialog',
+                              'wxEditableListBox *m_elb',
+                              'wxWindow *m_elbSubPanel',
+                              'wxWindow *m_lastFocused',
+                              'int m_itemPendingAtIndex',
+                              'bool m_modified',
+                              'bool m_hasCustomNewAction',
+                              visibility: 'protected'
+        spec.rename_for_ruby 'elb_' => 'wxPGArrayStringEditorDialog::m_elb',
+                             'elb_sub_panel_' => 'wxPGArrayStringEditorDialog::m_elbSubPanel',
+                             'last_focused_' => 'wxPGArrayStringEditorDialog::m_lastFocused',
+                             'item_pending_at_index_' => 'wxPGArrayStringEditorDialog::m_itemPendingAtIndex',
+                             'modified_' => 'wxPGArrayStringEditorDialog::m_modified',
+                             'has_custom_new_action_' => 'wxPGArrayStringEditorDialog::m_hasCustomNewAction'
+        spec.suppress_warning(473, 'wxPGArrayEditorDialog::GetTextCtrlValidator')
+        # make sure SWIG knows this type is an enum
+        spec.add_swig_code 'enum wxPGPropertyFlags;'
+        if Config.instance.wx_version >= '3.3.0'
+          # internal use only
+          spec.ignore 'wxPG_PROP_PASSWORD',
+                      'wxPG_PROP_USE_CHECKBOX',
+                      'wxPG_PROP_USE_DCC'
+        end
+      end
+    end # class PGArrayEditorDialog
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/pgcell.rb

@@ -0,0 +1,68 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class PGCell < Director
+
+      def setup
+        super
+        spec.items << 'wxPGCellData' << 'wxPGChoiceEntry'
+        spec.override_inheritance_chain('wxPGCellData', [])
+        spec.make_abstract 'wxPGCellData' # there is never any need to create an instance in Ruby
+        spec.no_proxy 'wxPGCellData'
+        spec.gc_never 'wxPGCellData'
+        spec.do_not_generate :variables, :enums, :defines, :functions # with PGProperty
+        # add method for correctly wrapping PGCell output references
+        spec.add_header_code <<~__CODE
+            extern VALUE mWxPG; // declare external module reference
+            extern VALUE wxRuby_WrapWxPGCellInRuby(const wxPGCell *wx_pc)
+            {
+              // If no object was passed to be wrapped.
+              if ( ! wx_pc )
+                return Qnil;
+
+              // check if this instance is already tracked; return tracked value if so 
+              VALUE r_pc = SWIG_RubyInstanceFor(const_cast<wxPGCell*> (wx_pc));
+              if (r_pc && !NIL_P(r_pc)) return r_pc;              
+
+              // Get the wx class and the ruby class we are converting into
+              wxString class_name = wxS("wxPGCell");
+              if (dynamic_cast<const wxPGChoiceEntry*> (wx_pc))
+              {
+                class_name = wxS("wxPGChoiceEntry");
+              }
+              VALUE r_class = Qnil;
+              if ( class_name.Len() > 2 )
+              {
+                wxCharBuffer wx_classname = class_name.mb_str();
+                VALUE r_class_name = rb_intern(wx_classname.data () + 2); // wxRuby class name (minus 'wx')
+                if (rb_const_defined(mWxPG, r_class_name))
+                  r_class = rb_const_get(mWxPG, r_class_name);
+              }
+
+              // If we cannot find the class output a warning and return nil
+              if ( r_class == Qnil )
+              {
+                rb_warn("Error wrapping object; class `%s' is not (yet) supported in wxRuby",
+                        (const char *)class_name.mb_str() );
+                return Qnil;
+              }
+
+
+              // 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);
+              return SWIG_NewPointerObj(const_cast<wxPGCell*> (wx_pc), swig_type, 0);
+            }
+        __CODE
+      end
+    end # class PGCell
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/pgeditor.rb

@@ -0,0 +1,154 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class PGEditor < Director
+
+      def setup
+        super
+        spec.items.concat %w[wxPGCheckBoxEditor wxPGChoiceEditor wxPGChoiceAndButtonEditor wxPGComboBoxEditor
+                             wxPGTextCtrlEditor wxPGSpinCtrlEditor wxPGTextCtrlAndButtonEditor wxPGEditorDialogAdapter]
+        spec.includes << 'wx/propgrid/propgriddefs.h'
+        if Config.instance.wx_version >= '3.3.0'
+          # make sure SWIG knows this as enum type
+          spec.add_swig_code 'enum wxPGPropertyFlags;'
+        end
+        spec.add_header_code <<~__HEREDOC
+          // template specialization to circumvent lack of default ctor
+          template <> wxPGWindowList SwigValueInit<wxPGWindowList>() {
+            return wxPGWindowList(0);
+          }
+          __HEREDOC
+        # SWIG fails to use SwigValueInit for local var init properly (SWIG 4 partially)
+        # so we fix it ourselves
+        spec.post_processors << :update_pg_window_list
+        spec.map 'wxPGWindowList' => 'Wx::Window,Array<Wx::Window,Wx::Window>' do
+          map_out code: <<~__CODE
+            wxWindow *winsec = $1.GetSecondary();
+            if (winsec) 
+            {
+              $result = rb_ary_new();
+              rb_ary_push($result, wxRuby_WrapWxObjectInRuby($1.GetPrimary()));
+              rb_ary_push($result, wxRuby_WrapWxObjectInRuby(winsec));
+            }
+            else
+            {
+              $result = wxRuby_WrapWxObjectInRuby($1.GetPrimary());
+            }
+            __CODE
+          map_directorout code: <<~__CODE
+            if (TYPE($input) == T_ARRAY && RARRAY_LEN($input) >= 1)
+            {
+              void *ptr;
+              int res = SWIG_ConvertPtr(rb_ary_entry($input, 0), &ptr, SWIGTYPE_p_wxWindow, 0 |  0);
+              if (!SWIG_IsOK(res)) 
+              {
+                Swig::DirectorTypeMismatchException::raise(SWIG_ErrorType(SWIG_ArgError(res)), "in primary output value of type 'wxWindow *'");
+              }
+              $result = wxPGWindowList(static_cast<wxWindow*>(ptr));
+              if (RARRAY_LEN($input) > 1)
+              {
+                res = SWIG_ConvertPtr(rb_ary_entry($input, 1), &ptr, SWIGTYPE_p_wxWindow, 0 |  0);
+                if (!SWIG_IsOK(res)) 
+                {
+                  Swig::DirectorTypeMismatchException::raise(SWIG_ErrorType(SWIG_ArgError(res)), "in secundary output value of type 'wxWindow *'");
+                }
+                $result.SetSecondary(static_cast<wxWindow*>(ptr));
+              }
+            }
+            __CODE
+        end
+        # since OnEvent is const we need a slightly different version of this type map
+        spec.map 'wxEvent &event' => 'Wx::Event' do
+          map_directorin code: <<~__CODE
+            #ifdef __WXRB_DEBUG__
+            $input = wxRuby_WrapWxEventInRuby(const_cast<void*> (static_cast<const void*> (this)), &$1);
+            #else
+            $input = wxRuby_WrapWxEventInRuby(&$1);
+            #endif
+          __CODE
+
+          # Thin and trusting wrapping to bypass SWIG's normal mechanisms; we
+          # don't want SWIG changing ownership or typechecking these.
+          map_in code: '$1 = (wxEvent*)DATA_PTR($input);'
+        end
+        # add method for correctly wrapping PGEditor output references
+        spec.add_header_code <<~__CODE
+          extern VALUE mWxPG; // declare external module reference
+          extern VALUE wxRuby_WrapWxPGEditorInRuby(const wxPGEditor *wx_pe)
+          {
+            // If no object was passed to be wrapped.
+            if ( ! wx_pe )
+              return Qnil;
+
+            // check if this instance is already tracked; return tracked value if so 
+            VALUE r_pe = SWIG_RubyInstanceFor(const_cast<wxPGEditor*> (wx_pe));
+            if (r_pe && !NIL_P(r_pe)) return r_pe;              
+
+            // Get the wx class and the ruby class we are converting into
+            wxString class_name( wx_pe->GetClassInfo()->GetClassName() ); 
+            VALUE r_class = Qnil;
+            if ( class_name.Len() > 2 )
+            {
+              wxCharBuffer wx_classname = class_name.mb_str();
+              VALUE r_class_name = rb_intern(wx_classname.data () + 2); // wxRuby class name (minus 'wx')
+              if (rb_const_defined(mWxPG, r_class_name))
+                r_class = rb_const_get(mWxPG, r_class_name);
+            }
+
+            // If we cannot find the class output a warning and return nil
+            if ( r_class == Qnil )
+            {
+              rb_warn("Error wrapping object; class `%s' is not (yet) supported in wxRuby",
+                      (const char *)class_name.mb_str() );
+              return Qnil;
+            }
+
+
+            // 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);
+            return SWIG_NewPointerObj(const_cast<wxPGEditor*> (wx_pe), swig_type, 0);
+          }
+          __CODE
+        # ignore the variables themselves
+        spec.ignore 'wxPGEditor_TextCtrl',
+                    'wxPGEditor_Choice',
+                    'wxPGEditor_ComboBox',
+                    'wxPGEditor_TextCtrlAndButton',
+                    'wxPGEditor_CheckBox',
+                    'wxPGEditor_ChoiceAndButton',
+                    'wxPGEditor_SpinCtrl',
+                    'wxPGEditor_DatePickerCtrl'
+      end
+
+    end # class PGEditor
+
+  end # class Director
+
+  module SwigRunner
+    # wxPGWindowList lacks a default ctor (stupid!) and therefor cannot be used by SWIG
+    # for return by value setups.
+    # We declared a compatible version in the header which can be used for var decls
+    # and here we're going to replace all SWIG generated decls to use the custom class.
+    class Processor
+      class UpdatePgWindowList < Processor
+        def run
+          # just replace all occurrences of wxPGWindowList result var decls by SwigValueInit decls.
+          update_source do |line|
+            if /\A(\s*)wxPGWindowList\s+(c_)?result\s*;/ =~ line
+              line = "#{$1}wxPGWindowList #{$2}result = SwigValueInit<wxPGWindowList>();"
+            end
+            line
+          end
+        end
+      end
+    end
+  end
+
+end # module WXRuby3

data/rakelib/lib/director/pgmulti_button.rb

@@ -0,0 +1,22 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class PGMultiButton < Window
+
+      def setup
+        super
+        spec.do_not_generate :variables, :enums, :defines, :functions
+      end
+    end # class PGMultiButton
+
+  end # class Director
+
+end # module WXRuby3