wxruby3 0.9.0.pre.rc.3 → 0.9.1

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/mark_free_impl.i

@@ -1,7 +1,9 @@
-/* wxRuby3
- * Copyright (c) Martin J.N. Corino
- */
-// Copyright 2004-2008, wxRuby development team
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+//
+// Some parts are
+// Copyright 2004-2007, wxRuby development team
 // released under the MIT-like wxRuby2 license
 
 // mark_free_impl.i - this contains the C++ implementation of various

data/ext/wxruby3/swig/memory_management.i

@@ -1,6 +1,8 @@
-/* wxRuby3
- * Copyright (c) Martin J.N. Corino
- */
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+//
+// Some parts are
 // Copyright 2004-2007, wxRuby development team
 // released under the MIT-like wxRuby2 license
 

data/ext/wxruby3/swig/typedefs.i

@@ -1,6 +1,8 @@
-/* wxRuby3
- * Copyright (c) Martin J.N. Corino
- */
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+//
+// Some parts are
 // Copyright 2004-2007, wxRuby development team
 // released under the MIT-like wxRuby2 license
 

data/ext/wxruby3/swig/wx.i

@@ -1,3 +1,8 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+//
+// Some parts are
 // Copyright 2004-2007, wxRuby development team
 // released under the MIT-like wxRuby2 license
 
@@ -30,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
@@ -136,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
     {
@@ -183,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/ext/wxruby3/swig/wx.rc

@@ -1,8 +1,10 @@
-/////////////////////////////////////////////////////////////////////////////
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+
 // Name:        swig/wxruby.rc
 // Purpose:     wxRuby3 MSW standard resource file
 // Author:      Martin Corino
-/////////////////////////////////////////////////////////////////////////////
 
 // note that the icon used by the Explorer (i.e. the programs icon) is the
 // first icon in the executable and the icons are sorted both by their order

data/lib/wx/accessors.rb

@@ -1,3 +1,11 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # = WxSugar - Accessors
 #
 # The default WxRuby interface has lots and lots of methods like
@@ -7,7 +15,7 @@
 #  * is_checked()
 #  * can_undo()
 #  * has_style(a_style)
-# 
+#
 # and so on. Methods that retrieve set, or query attributes of an object
 # are more normally in Ruby called simply by the attribute name, or, in
 # other cases, with a predicate method:
@@ -24,7 +32,7 @@
 # automagically creates an alias for every WxRuby instance method that
 # begins with +get_+, +set_+, +is_+, +can_+ and +has_+. Note that if you are calling a
 # 'setter' method on self, you must explicitly send the message to self:
-# 
+#
 #  # set's self size to be 100px by 100px
 #  self.size = Wx::Size.new(100, 100)
 #  # only sets the value of a local variable 'size'

data/lib/wx/aui/auifloatframe.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+# Advanced User Interface Notebook - draggable panes etc
+
+class Wx::AUI::AuiFloatingFrame
+
+  # Before wxWidgets 3.3 the AUI manager of this control would prevent
+  # WindowDestroyEvent propagation so we 'patch' in a std event handler
+  # that designates the event skipped.
+  if Wx::WXWIDGETS_VERSION < '3.3'
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args|
+      wx_initialize.bind(self).call(*args)
+      evt_window_destroy { |evt| evt.skip }
+    end
+  end
+
+end

data/lib/wx/aui/auimanager.rb

@@ -1,3 +1,6 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
 
 class Wx::AUI::AuiManager
   def get_all_panes

data/lib/wx/aui/auinotebook.rb

@@ -1,5 +1,22 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
 # Advanced User Interface Notebook - draggable panes etc
+
 class Wx::AUI::AuiNotebook
+
+  # Before wxWidgets 3.3 the AUI manager of this control would prevent
+  # WindowDestroyEvent propagation so we 'patch' in a std event handler
+  # that designates the event skipped.
+  if Wx::WXWIDGETS_VERSION < '3.3'
+    wx_initialize = instance_method :initialize
+    define_method :initialize do |*args|
+      wx_initialize.bind(self).call(*args)
+      evt_window_destroy { |evt| evt.skip }
+    end
+  end
+
   # Convenience method for iterating pages
   def each_page
     0.upto(get_page_count - 1) do | i |

data/lib/wx/aui/require.rb

@@ -1,9 +1,13 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
 # Wx::AUI sub package for wxRuby3
-# Copyright (c) M.J.N. Corino, The Netherlands
 
 #require_relative './ext'
 require_relative './events/evt_list'
 require_relative './auimanager'
 require_relative './auinotebook'
+require_relative './auifloatframe'
 
 Wx::Dialog.setup_dialog_functors(Wx::AUI)

data/lib/wx/aui.rb

@@ -1,5 +1,8 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
 # Wx::AUI sub package loader for wxRuby3
-# Copyright (c) M.J.N. Corino, The Netherlands
 
 
 require 'wx/core'

data/lib/wx/core/acceleratortable.rb

@@ -1,3 +1,11 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 class Wx::AcceleratorTable
   # Allow new to be called as []
   class << self

data/lib/wx/core/animation.rb

@@ -1,3 +1,11 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 class Wx::Animation
   # Redefine the initialize method so it raises an exception if a
   # non-existent file is given to the constructor; otherwise, wx Widgets

data/lib/wx/core/app.rb

@@ -1,3 +1,11 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # Copyright 2004-2006 by Kevin Smith
 # released under the MIT-style wxruby2 license
 

data/lib/wx/core/array_ext.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 module Wx
 

data/lib/wx/core/art_locator.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 module Wx
 

data/lib/wx/core/artprovider.rb

@@ -1,4 +1,13 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # Class which can supply icons and bitmaps
+
 class Wx::ArtProvider
   # Keep a note of supplied ArtProviders to prevent them being GC'd
   @__art_provs = []

data/lib/wx/core/bitmap.rb

@@ -1,4 +1,13 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # A platform-dependent image that can be drawn on the screen
+
 module Wx
 
   if Wx::PLATFORM == 'WXMSW'
@@ -94,10 +103,13 @@ module Wx
     end
   end
 
-  def self.Bitmap(name, bmp_type = nil)
-    art_path = File.dirname(caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.path)
-    art_owner = File.basename(caller_path, '.*')
-    art_file = ArtLocator.find_art(name, art_type: :bitmap, art_path: art_path, art_section: art_owner, bmp_type: bmp_type)
+  def self.Bitmap(name, bmp_type = nil, art_path: nil, art_section: nil)
+    unless art_path && art_section
+      caller_path = caller_locations(1).first.absolute_path || caller_locations(1).first.path
+      art_path = File.dirname(caller_path) unless art_path
+      art_section = File.basename(caller_path, '.*') unless art_section
+    end
+    art_file = ArtLocator.find_art(name, art_type: :bitmap, art_path: art_path, art_section: art_section, bmp_type: bmp_type)
     ::Kernel.raise ArgumentError, "Cannot locate art file for #{name}:Bitmap" unless art_file
     Bitmap.new(art_file, bmp_type)
   end

data/lib/wx/core/bitmap_combobox.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 module Wx
 

data/lib/wx/core/brush.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 module Wx
 

data/lib/wx/core/busycursor.rb

@@ -1,5 +1,14 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # Emulates the wxWidgets BusyCursor class, by providing a scope within
 # which a busy cursor will be shown
+
 class Wx::BusyCursor
   # Only one class method, optionally accepting a cursor that should be
   # shown, defaulting to an hour glass cursor.

data/lib/wx/core/choice.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 require_relative './controlwithitems'
 

data/lib/wx/core/choicedlg.rb

@@ -1,3 +1,10 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
 
 module Wx
 

data/lib/wx/core/clientdc.rb

@@ -1,5 +1,14 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # Device Context to paint on a window outside an on_paint handler. It is
 # recommended that PaintDC is used in preference to this class.
+
 class Wx::ClientDC
   # This class should not be instantiated directly in wxRuby; it should
   # always be used via Window#paint, which takes a block receiving the

data/lib/wx/core/clipboard.rb

@@ -1,3 +1,11 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 class Wx::Clipboard
   class << self
     # This is provided internally by the SWIG interface file, but all

data/lib/wx/core/collapsible_pane.rb

@@ -1,5 +1,12 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# 
+# Some parts are
+# Copyright 2004-2007, wxRuby development team
+# released under the MIT-like wxRuby2 license
+
 # WxRuby Extensions - CollapsiblePane platform dependent alias
-# Copyright (c) M.J.N. Corino, The Netherlands
 
 module Wx