wxruby3 0.9.0 → 0.9.2

data/ext/wxruby3/swig/custom/typemaps/swigtypemaps.swg

@@ -0,0 +1,173 @@
+/* -----------------------------------------------------------------------------
+ * swigtypemaps.swg
+ *
+ * Unified Typemap Library frontend
+ *
+ * Customized for wxRuby3.
+ * Copyright (c) 2023 M.J.N. Corino, The Netherlands
+ *
+ * This software is released under the MIT license.
+ * ----------------------------------------------------------------------------- */
+
+/*
+  This file provides the frontend to the Unified Typemap Library.
+
+  When using this library in a SWIG target language, you need to
+  define a minimum set of fragments, specialize a couple of macros,
+  and then include this file.
+
+  Typically you will create a 'mytypemaps.swg' file in each target
+  language, where you will have the following sections:
+
+    === mytypemaps.swg ===
+
+    //  Fragment section 
+    %include <typemaps/fragments.swg>
+    <include target language fragments>
+
+    // Unified typemap section 
+    <specialized the typemap library macros>
+    %include <typemaps/swigtypemaps.swg>
+
+    // Local typemap section 
+    <add/replace extra target language typemaps>
+
+    === mytypemaps.swg ===
+
+  While we add more docs, please take a look at the following cases
+  to see how you specialized the unified typemap library for a new
+  target language:
+
+      Lib/python/pytypemaps.swg
+      Lib/tcl/tcltypemaps.swg
+      Lib/ruby/rubytypemaps.swg
+      Lib/perl5/perltypemaps.swg
+    
+*/
+
+#define SWIGUTL SWIGUTL
+
+/* -----------------------------------------------------------------------------
+ *   Language specialization section. 
+ *
+ *   Tune these macros for each language as needed.
+ * ----------------------------------------------------------------------------- */
+
+/*
+  The SWIG target language object must be provided.
+  For example in python you define:
+
+    #define SWIG_Object PyObject *
+*/
+
+#if !defined(SWIG_Object) 
+#error "SWIG_Object must be defined as the SWIG target language object"
+#endif
+
+/*==== flags for new/convert methods ====*/
+
+
+#ifndef %convertptr_flags
+%define %convertptr_flags  0 %enddef
+#endif
+
+#ifndef %newpointer_flags
+%define %newpointer_flags  0 %enddef
+#endif
+
+#ifndef %newinstance_flags
+%define %newinstance_flags 0 %enddef
+#endif
+
+/*==== set output ====*/
+
+#ifndef %set_output
+/* simple set output operation */
+#define %set_output(obj)                  $result = obj
+#endif
+
+/*==== set variable output  ====*/
+
+#ifndef %set_varoutput
+/* simple set varoutput operation */
+#define %set_varoutput(obj)               $result = obj
+#endif
+
+/*==== append output ====*/
+
+#ifndef %append_output
+#if defined(SWIG_AppendOutput)
+/* simple append operation */
+#define %append_output(obj)               $result = SWIG_AppendOutput($result,obj) 
+#else
+#error "Language must define SWIG_AppendOutput or %append_output"
+#endif
+#endif
+
+/*==== set constant ====*/
+
+#ifndef %set_constant
+#if defined(SWIG_SetConstant)
+/* simple set constant operation */
+#define %set_constant(name,value)         SWIG_SetConstant(name,value)
+#else
+#error "Language must define SWIG_SetConstant or %set_constant"
+#endif
+#endif
+
+/*==== raise an exception ====*/
+
+#ifndef %raise
+#if defined(SWIG_Raise)
+/* simple raise operation */
+#define %raise(obj, type, desc)           SWIG_Raise(obj, type, desc); SWIG_fail
+#else
+#error "Language must define SWIG_Raise or %raise"
+#endif
+#endif
+
+/*==== director output exception ====*/
+
+/* wxRuby : make sure to pass the object and method that caused the failure */
+#if defined(SWIG_DIRECTOR_TYPEMAPS)
+#ifndef SWIG_DirOutFail
+#define SWIG_DirOutFail(self, method, code, msg)        Swig::DirectorTypeMismatchException::raise(self, method, SWIG_ErrorType(code), msg)
+#endif
+#endif
+
+
+/* -----------------------------------------------------------------------------
+ *  Language independent definitions
+ * ----------------------------------------------------------------------------- */
+
+#define %error_block(Block...)                 %block(Block)
+#define %default_code(code)                    SWIG_ArgError(code)  
+#define %argument_fail(code, type, name, argn) SWIG_exception_fail(%default_code(code), %argfail_fmt(type, name, argn))
+#define %argument_nullref(type, name, argn)    SWIG_exception_fail(SWIG_ValueError, %argnullref_fmt(type, name, argn))
+#define %variable_fail(code, type, name)       SWIG_exception_fail(%default_code(code), %varfail_fmt(type, name))
+#define %variable_nullref(type, name)          SWIG_exception_fail(SWIG_ValueError, %varnullref_fmt(type, name))
+#define %releasenotowned_fail(code, type, name, argn) SWIG_exception_fail(%default_code(code), %releasenotownedfail_fmt(type, name, argn))
+
+/* wxRuby : make sure to pass the object and method that caused the failure */
+#if defined(SWIG_DIRECTOR_TYPEMAPS)
+#define %dirout_fail(code, type)          SWIG_DirOutFail(swig_get_self(), "$symname", %default_code(code), %outfail_fmt(type))
+#define %dirout_nullref(type)             SWIG_DirOutFail(swig_get_self(), "$symname", SWIG_ValueError, %outnullref_fmt(type))
+#endif
+
+/* -----------------------------------------------------------------------------
+ *  All the typemaps
+ * ----------------------------------------------------------------------------- */
+
+
+%include <typemaps/fragments.swg>
+%include <typemaps/exception.swg>
+%include <typemaps/swigtype.swg>
+%include <typemaps/void.swg>
+%include <typemaps/swigobject.swg>
+%include <typemaps/valtypes.swg>
+%include <typemaps/ptrtypes.swg>
+%include <typemaps/inoutlist.swg>
+%include <typemaps/primtypes.swg>
+%include <typemaps/string.swg>
+%include <typemaps/misctypes.swg>
+%include <typemaps/enumint.swg>

data/ext/wxruby3/swig/wx.i

@@ -35,11 +35,31 @@ WX_DECLARE_HASH_MAP(VALUE,
 					RbClassToSwigTypeHash);
 RbClassToSwigTypeHash Global_Type_Map;
 
+// Mapping of wxWidgets class names to Ruby classes
+WX_DECLARE_STRING_HASH_MAP(VALUE,
+                           WxClassnameToRbClassHash);
+WxClassnameToRbClassHash Global_Class_Map;
+
+// Record wxRuby class for a wxw class name
+WXRUBY_EXPORT void wxRuby_SetRbClassForWxName(const wxString& wx_name, VALUE cls)
+{
+  Global_Class_Map[wx_name] = cls;
+}
+
+// Retrieve wxRuby class for a wxw class name
+WXRUBY_EXPORT VALUE wxRuby_GetRbClassForWxName(const wxString& wx_name)
+{
+  return Global_Class_Map[wx_name];
+}
+
 // Record swig_type_info for a wxRuby class; called in class
 // initialisation
 WXRUBY_EXPORT void wxRuby_SetSwigTypeForClass(VALUE cls, swig_type_info* ty)
 {
   Global_Type_Map[cls] = ty;
+  const char* swig_type_name = ty->name;
+  // skip '_p_' prefix and register class
+  wxRuby_SetRbClassForWxName(wxString(swig_type_name+3), cls);
 }
 
 // Retrieve swig_type_info for a ruby class - needed by functions which
@@ -141,41 +161,41 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxObjectInRuby(wxObject *wx_obj)
 
   // Get the wx class and the ruby class we are converting into
   wxString class_name( wx_obj->GetClassInfo()->GetClassName() );
-  wxCharBuffer wx_classname = class_name.mb_str();
-  VALUE r_class_name = rb_intern(wx_classname.data () + 2);
-  VALUE r_class = Qnil;
-
-  if ( class_name.Len() > 2 )
-  {
-    // lookup the class in the main module and any package submodules loaded
-    if (rb_const_defined(mWxCore, r_class_name))
-      r_class = rb_const_get(mWxCore, r_class_name);
-    else
-    {
-      VALUE submod_ary = rb_ivar_get(mWxCore, rb_intern("@__pkgmods__"));
-      for (long n=0; n<RARRAY_LEN(submod_ary); ++n)
-      {
-        VALUE submod = rb_ary_entry(submod_ary, n);
-        if (rb_const_defined(submod, r_class_name))
-        {
-          r_class = rb_const_get(submod, r_class_name);
-          break;
-        }
-      }
-    }
-  }
+  VALUE r_class = wxRuby_GetRbClassForWxName(class_name);
 
   // Handle classes (currently) unknown in wxRuby.
   // (could cause problems because class-specific methods won't be accessible).
-  if ( r_class == Qnil )
+  if (r_class == 0 || NIL_P(r_class))
   {
-    // map unknown wxWindow derivatives as basic window
+    // map unknown wxWindow derivatives as a mapped base class
+    // this solves issues with explicitly defined wxRuby custom
+    // DECLARE_DYNAMIC_CLASS classes like WxRubyTreeCtrl
     if (wxIsKindOf(wx_obj, wxWindow))
     {
-      r_class = rb_const_get(mWxCore, window_id());
-      // issue warning if $VERBOSE is true
-      rb_warning("Cannot wrap exact window class as '%s' is not (yet) known in wxRuby; wrapping as base Window object.",
-                 (const char *)class_name.mb_str());
+      wxClassInfo* cls_info = wx_obj->GetClassInfo();
+      do
+      {
+        wxString base_name(wx_obj->GetClassInfo()->GetBaseClassName1());
+        r_class = wxRuby_GetRbClassForWxName(base_name);
+        if (r_class == 0 || NIL_P(r_class))
+        {
+          cls_info = wxClassInfo::FindClass(base_name);
+          if (!cls_info)
+          {
+            // map to basic Wx::Window
+            r_class = rb_const_get(mWxCore, window_id());
+            // issue warning if $VERBOSE is true
+            rb_warning("Cannot wrap exact window class as '%s' is not (yet) known in wxRuby; wrapping as base Wx::Window object.",
+                       (const char *)class_name.mb_str());
+          }
+        }
+        else
+        {
+          // issue warning if $VERBOSE is true
+          rb_warning("Cannot wrap exact window class as '%s' is not (yet) known in wxRuby; wrapping as %s object.",
+                     (const char *)class_name.mb_str(), rb_class2name(r_class));
+        }
+      } while (r_class == 0 || NIL_P(r_class));
     }
     else
     {
@@ -188,7 +208,7 @@ WXRUBY_EXPORT VALUE wxRuby_WrapWxObjectInRuby(wxObject *wx_obj)
   // 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);
-  VALUE r_obj = SWIG_NewPointerObj(wx_obj, swig_type, 1);
+  VALUE r_obj = SWIG_NewPointerObj(wx_obj, swig_type, 0);
   return r_obj;
 }
 

data/lib/wx/aui/aui_tab_ctrl.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+class Wx::AUI::AuiTabCtrl
+
+  # Convenience method for iterating pages
+  def each_page
+    if block_given?
+      0.upto(get_page_count - 1) do | i |
+        yield get_page(i)
+      end
+    else
+      ::Enumerator.new { |y| each_page { |pg| y << pg } }
+    end
+  end
+
+end

data/lib/wx/aui/auinotebook.rb

@@ -19,8 +19,12 @@ class Wx::AUI::AuiNotebook
 
   # Convenience method for iterating pages
   def each_page
-    0.upto(get_page_count - 1) do | i |
-      yield get_page(i)
+    if block_given?
+      0.upto(get_page_count - 1) do | i |
+        yield get_page(i)
+      end
+    else
+      ::Enumerator.new { |y| each_page { |pg| y << pg } }
     end
   end
 end

data/lib/wx/aui/require.rb

@@ -9,5 +9,6 @@ require_relative './events/evt_list'
 require_relative './auimanager'
 require_relative './auinotebook'
 require_relative './auifloatframe'
+require_relative './aui_tab_ctrl'
 
 Wx::Dialog.setup_dialog_functors(Wx::AUI)

data/lib/wx/core/app.rb

@@ -79,8 +79,8 @@ class Wx::App
   # WxRuby. Such messages usually indicate that the API is being used
   # incorrectly; the file/line reference points to the place in the
   # WxWidgets source code where the assertion was made.
-  define_method(:on_assert_failure) do | file, line, func, condition, message |
-    warn "Wx WARNING: #{message} (#{func}@#{file}:#{line})"
+  def on_assert_failure(file, line, func, condition, message)
+    warn %Q{Wx WARNING: ASSERT #{condition} fired with "#{message}" at (#{func}@#{file}:#{line})}
   end
 
   # For use in development only, of no practical use in production code.

data/lib/wx/core/collapsible_pane.rb

@@ -10,7 +10,7 @@
 
 module Wx
 
-  if Wx.has_feature?(:USE_COLLPANE) && (!Wx.has_feature?(:WXGTK20) || Wx.has_feature?(:WXUNIVERSAL))
+  if Wx.has_feature?(:USE_COLLPANE)
     
     GenericCollapsiblePane = CollapsiblePane
     

data/lib/wx/core/const.rb

@@ -0,0 +1,83 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
+module Wx
+
+=begin
+  These constants are not documented in the wxWidgets interface headers
+  although they are referenced in various argument defaults which *are*
+  in the interface header declarations so.
+=end
+
+  DEFAULT_DATE_TIME_FORMAT = '%c'
+  DEFAULT_TIME_SPAN_FORMAT = '%H:%M:%S'
+
+  CHOICE_NAME_STR = 'choice'
+  COLOUR_PICKER_CTRL_NAME_STR = 'colourpicker'
+  COLOUR_PICKER_WIDGET_NAME_STR = 'colourpickerwidget'
+  HYPERLINK_CTRL_NAME_STR = 'hyperlink'
+  PANEL_NAME_STR = 'panel'
+  LIST_BOX_NAME_STR = 'listBox'
+  FRAME_NAME_STR = 'frame'
+  STATUS_LINE_NAME_STR = 'status_line'
+  STATIC_BITMAP_NAME_STR = 'staticBitmap'
+  WEB_VIEW_NAME_STR = 'wxWebView'
+  ANIMATION_CTRL_NAME_STR = 'animationctrl'
+  TOOL_BAR_NAME_STR = 'toolbar'
+  TEXT_CTRL_NAME_STR = 'text'
+  LIST_CTRL_NAME_STR = 'listCtrl'
+  FILE_PICKER_CTRL_NAME_STR = 'filepicker'
+  FILE_PICKER_WIDGET_NAME_STR = 'filepickerwidget'
+  DIR_PICKER_CTRL_NAME_STR = 'dirpicker'
+  DIR_PICKER_WIDGET_NAME_STR = 'dirpickerwidget'
+  FILE_CTRL_NAME_STR = 'wxfilectrl'
+  FILE_SELECTOR_PROMPT_STR = 'Select a file'
+  STATIC_BOX_NAME_STR = 'groupBox'
+  BUTTON_NAME_STR = 'button'
+  RADIO_BOX_NAME_STR = 'radioBox'
+  STATIC_LINE_NAME_STR = 'staticLine'
+  RADIO_BUTTON_NAME_STR = 'radioButton'
+  BITMAP_RADIO_BUTTON_NAME_STR = 'radioButton'
+  GAUGE_NAME_STR = 'gauge'
+  DATA_VIEW_CTRL_NAME_STR = 'dataviewCtrl'
+  FONT_PICKER_CTRL_NAME_STR = 'fontpicker'
+  FONT_PICKER_WIDGET_NAME_STR = 'fontpickerwidget'
+  REARRANGE_LIST_NAME_STR = 'wxRearrangeList'
+  REARRANGE_DIALOG_NAME_STR = 'wxRearrangeDlg'
+  NOTEBOOK_NAME_STR = 'notebook'
+  CONTROL_NAME_STR = 'control'
+  SCROLL_BAR_NAME_STR = 'scrollBar'
+  STATUS_BAR_NAME_STR = 'statusBar'
+  SLIDER_NAME_STR = 'slider'
+  HEADER_CTRL_NAME_STR = 'wxHeaderCtrl'
+  BITMAP_COMBO_BOX_NAME_STR = 'bitmapComboBox'
+  CHECK_BOX_NAME_STR = 'check'
+  FILE_DIALOG_NAME_STR = 'filedlg'
+  ADD_REMOVE_CTRL_NAME_STR = 'wxAddRemoveCtrl'
+  STATIC_TEXT_NAME_STR = 'staticText'
+  COMBO_BOX_NAME_STR = 'comboBox'
+  SEARCH_CTRL_NAME_STR = 'searchCtrl'
+  TREE_CTRL_NAME_STR = 'treeCtrl'
+  DIALOG_NAME_STR = 'dialog'
+  COLLAPSIBLE_HEADER_CTRL_NAME_STR = 'collapsibleHeader'
+  COLLAPSIBLE_PANE_NAME_STR = 'collapsiblePane'
+  BANNER_WINDOW_NAME_STR = 'bannerwindow'
+  GRID_NAME_STR = 'grid'
+  TREE_LIST_CTRL_NAME_STR = 'wxTreeListCtrl'
+  HTML_LIST_BOX_NAME_STR = 'htmlListBox'
+  SIMPLE_HTML_LIST_BOX_NAME_STR = 'simpleHtmlListBox'
+  EDITABLE_LIST_BOX_NAME_STR = 'editableListBox'
+  V_LIST_BOX_NAME_STR = 'wxVListBox'
+
+  if Wx::PLATFORM == 'WXMSW'
+    # wxMSW only
+    MSW_HEADER_CTRL_NAME_STR = 'wxMSWHeaderCtrl'
+  end
+
+  PROPERTY_GRID_MANAGER_NAME_STR = 'wxPropertyGridManager'
+  PROPERTY_GRID_NAME_STR = 'wxPropertyGrid'
+  STC_NAME_STR = 'stcwindow'
+
+end

data/lib/wx/core/controlwithitems.rb

@@ -11,12 +11,14 @@
 
 class Wx::ControlWithItems
 
-  # Make these Ruby enumerables so find, find_all, map etc are available
-  include Enumerable
-
-  # Passes each valid item index into the passed block
-  def each
-    get_count.times { | i | yield i }
+  # Overload to provide Enumerator without block
+  wx_each_string = instance_method :each_string
+  define_method :each_string do |&block|
+    if block
+      wx_each_string.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_string.bind(self).call { |ln| y << ln } }
+    end
   end
 
   # We need to cache client data in Ruby variables as we cannot access items

data/lib/wx/core/menu.rb

@@ -26,6 +26,16 @@ class Wx::Menu
     end
   end
 
+  # Overload to provide Enumerator without block
+  wx_each_item = instance_method :each_item
+  define_method :each_item do |&block|
+    if block
+      wx_each_item.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_item.bind(self).call { |mi| y << mi } }
+    end
+  end
+
   # In the standard WxWidgets API, the methods append, prepend, insert
   # (and their variants) require a constant integer id as the identifier
   # of the menu item. This is then used in event handling. 

data/lib/wx/core/notebook.rb

@@ -11,8 +11,12 @@
 class Wx::Notebook
   # Convenience method for iterating pages
   def each_page
-    0.upto(get_page_count - 1) do | i |
-      yield get_page(i)
+    if block_given?
+      0.upto(get_page_count - 1) do | i |
+        yield get_page(i)
+      end
+    else
+      ::Enumerator.new { |y| each_page { |pg| y << pg } }
     end
   end
 end

data/lib/wx/core/sizer.rb

@@ -49,4 +49,15 @@ class Wx::Sizer
       insert(idx, *full_args)
     end
   end
+
+  # Overload to provide Enumerator without block
+  wx_each_child = instance_method :each_child
+  define_method :each_child do |&block|
+    if block
+      wx_each_child.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_child.bind(self).call { |c| y << c } }
+    end
+  end
+
 end

data/lib/wx/core/task_bar_button.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
+module Wx
+
+  if Wx::PLATFORM == 'WXMSW'
+    class TaskBarButton
+
+      wx_remove_thumb_bar_button = instance_method :remove_thumb_bar_button
+      define_method :remove_thumb_bar_button do |button|
+        button = button.get_id if button.is_a?(Wx::ThumbBarButton)
+        wx_remove_thumb_bar_button.bind(self).call(button)
+      end
+
+    end
+  end
+end

data/lib/wx/core/textctrl.rb

@@ -59,10 +59,20 @@ module Wx
   class TextCtrl
     wx_op_append = instance_method :<<
     define_method :<< do |o|
-      wx_op_append.bind(self).call(o)
+      wx_op_append.bind(self).call(o.to_s)
       self
     end
 
+    # Overload to provide Enumerator without block
+    wx_each_line = instance_method :each_line
+    define_method :each_line do |&block|
+      if block
+        wx_each_line.bind(self).call(&block)
+      else
+        ::Enumerator.new { |y| wx_each_line.bind(self).call { |ln| y << ln } }
+      end
+    end
+
     if Wx.has_feature?(:USE_SPELLCHECK)
 
       protected :do_enable_proof_check

data/lib/wx/core/{treectrl.rb → tree_ctrl.rb}

@@ -9,22 +9,41 @@
 # Hierarchical control with items
 
 class Wx::TreeCtrl
-  # Make these ruby enumerables so find, find_all, map etc are available
-  include Enumerable
+
+  # Overload to provide Enumerator without block
+  wx_traverse = instance_method :traverse
+  define_method :traverse do |start_id=nil, &block|
+    if block
+      wx_traverse.bind(self).call(start_id, &block)
+    else
+      ::Enumerator.new { |y| wx_traverse.bind(self).call(start_id) { |c| y << c } }
+    end
+  end
+
   # Iterate over all items
   alias :each :traverse
 
-  # Return the children of +parent+ as an array of TreeItemIDs.
-  def get_children(parent)
-    kids = []
-    kid, _ = get_first_child(parent)
-    return [] unless kid.ok?
-    kids << kid
-
-    while kid = get_next_sibling(kids.last) and kid.ok?
-      kids << kid
+  # Make these ruby enumerables so find, find_all, map etc are available
+  include Enumerable
+
+  # Iterate all children of parent_id
+  def each_item_child(parent_id, &block)
+    if block
+      rc = nil
+      child_id, cookie = get_first_child(parent_id)
+      while child_id && child_id.ok?
+        rc = block.call(child_id)
+        child_id, cookie = get_next_child(parent_id, cookie)
+      end
+      rc
+    else
+      ::Enumerator.new { |y| each_item_child(parent_id) { |child_id| y << child_id } }
     end
-    kids
+  end
+
+  # Return the children of +parent+ as an array of TreeItemIDs.
+  def get_item_children(parent_id)
+    each_item_child(parent_id).to_a
   end
 
   # Returns a Wx::Rect corresponding to the edges of an individual tree

data/lib/wx/core/window.rb

@@ -79,6 +79,16 @@ class Wx::Window
     end
   end
 
+  # Overload to provide Enumerator without block
+  wx_each_child = instance_method :each_child
+  define_method :each_child do |&block|
+    if block
+      wx_each_child.bind(self).call(&block)
+    else
+      ::Enumerator.new { |y| wx_each_child.bind(self).call { |c| y << c } }
+    end
+  end
+
   # implement non-static variants of these
 
   def from_dip(*args)