wxruby3 0.9.3 → 0.9.5

data/ext/wxruby3/include/wxruby-Config.h

@@ -53,6 +53,7 @@ static int wxrb_CountConfig(VALUE key, VALUE value, VALUE rbCounter)
 }
 
 static VALUE g_cConfigBase;
+static VALUE g_cConfigWx;
 static VALUE g_cConfig;
 
 /*
@@ -88,12 +89,18 @@ public:
 
   virtual ~wxRbHashConfig()
   {
-    DATA_PTR(m_cfgInstance) = 0; // make sure it never get's deleted twice
+    if (!NIL_P(m_cfgInstance))
+    {
+      DATA_PTR(m_cfgInstance) = 0; // make sure it never get's deleted twice
+    }
   }
 
-  // Get wrapped Ruby ConfigBase instance
+  // Get wrapped Ruby Config instance
   VALUE GetRubyConfig() const { return m_cfgInstance; }
 
+  // Reset wrapped Ruby Config instance
+  void ResetRubyConfig() { m_cfgInstance = Qnil; }
+
   // implement inherited pure virtual functions
   virtual void SetPath(const wxString& strPath) override { DoSetPath(strPath, true /* create missing components */); }
   virtual const wxString& GetPath() const override { return m_strPath; }
@@ -806,7 +813,7 @@ private:
 
   void SetRootPath()
   {
-    m_strPath.Empty();
+    m_strPath.Clear();
     m_cfgGroup = m_cfgHash;
     m_cfgGroupKeys = Qnil;
   }
@@ -815,7 +822,7 @@ private:
   // if path doesn't exist and createMissingComponents == false
   bool DoSetPath(const wxString& strPath, bool createMissingComponents)
   {
-    if ( strPath.empty() )
+    if ( strPath.IsEmpty() || strPath == cfgSepStr)
     {
         SetRootPath();
         return true;
@@ -913,7 +920,8 @@ static const char * __iv_Config_data = "@data";
 
 WXRUBY_EXPORT bool wxRuby_IsRubyConfig(VALUE rbConfig)
 {
-  return rb_obj_is_kind_of(rbConfig, g_cConfig) == Qtrue;
+  return rb_obj_is_kind_of(rbConfig, g_cConfig) == Qtrue ||
+    rb_obj_is_kind_of(rbConfig, g_cConfigWx) == Qtrue;
 }
 
 // Wrap a Ruby hash for input type mapping
@@ -933,6 +941,12 @@ WXRUBY_EXPORT wxConfigBase* wxRuby_Ruby2ConfigBase(VALUE rbConfig)
     // return wrapper
     return config;
   }
+  else if (rb_obj_is_kind_of(rbConfig, g_cConfigWx) == Qtrue)
+  {
+    wxConfigBase* cfg;
+    Data_Get_Struct(rbConfig, wxConfigBase, cfg);
+    return cfg;
+  }
   return nullptr;
 }
 
@@ -946,6 +960,10 @@ WXRUBY_EXPORT VALUE wxRuby_ConfigBase2Ruby(wxConfigBase* config)
     {
       return hsh_config->GetRubyConfig();
     }
+    else
+    {
+      return Data_Wrap_Struct(g_cConfigWx, 0, 0, config);
+    }
   }
   return Qnil;
 }

data/ext/wxruby3/include/wxruby-Persistence.h

@@ -0,0 +1,79 @@
+// Copyright (c) 2023 M.J.N. Corino, The Netherlands
+//
+// This software is released under the MIT license.
+
+/*
+ * WxRuby3 persistence classes
+ */
+
+#ifndef _WXRUBY_PERSISTENCE_HASH_H
+#define _WXRUBY_PERSISTENCE_HASH_H
+
+#include <wx/persist.h>
+#include <wx/config.h>
+
+#include <map>
+
+/*
+  This class serves as a base for any Ruby defined persistence manager in order to provide
+  customized save and restore methods for Ruby values but also as a replacement for the
+  default global persistence manager instance.
+ */
+class WxRubyPersistenceManager : public wxPersistenceManager
+{
+private:
+  typedef std::map<VALUE, VALUE> rb_object_to_rb_po_map_t;
+  rb_object_to_rb_po_map_t rb_object_po_map_;
+
+public:
+  WxRubyPersistenceManager() : wxPersistenceManager() {}
+
+  bool SaveRubyValue(const wxPersistentObject& who, const wxString& name, VALUE value);
+
+  VALUE RestoreRubyValue(const wxPersistentObject& who, const wxString& name);
+
+
+  bool DoSaveRubyValue(const wxPersistentObject& who, const wxString& name, VALUE value);
+
+  VALUE DoRestoreRubyValue(const wxPersistentObject& who, const wxString& name);
+
+  void RegisterRbPO(VALUE rb_obj, VALUE rb_po)
+  {
+    rb_object_po_map_[rb_obj] = rb_po;
+  }
+
+  VALUE FindRbPO(VALUE rb_obj)
+  {
+    VALUE rb_po = Qnil;
+    if (rb_object_po_map_.count(rb_obj) > 0)
+    {
+      rb_po = rb_object_po_map_[rb_obj];
+    }
+    return rb_po;
+  }
+
+  VALUE UnregisterRbPO(VALUE rb_obj)
+  {
+    VALUE rb_po = Qnil;
+    if (rb_object_po_map_.count(rb_obj) > 0)
+    {
+      rb_po = rb_object_po_map_[rb_obj];
+      rb_object_po_map_.erase(rb_obj);
+    }
+    return rb_po;
+  }
+
+  void GC_markPO();
+
+  static void UnregisterPersistentObject(VALUE rb_obj);
+};
+
+class WxRubyPersistentObject : public wxPersistentObject
+{
+public:
+  virtual ~WxRubyPersistentObject();
+protected:
+  WxRubyPersistentObject(VALUE rb_obj);
+};
+
+#endif /* _WXRUBY_PERSISTENCE_HASH_H */

data/ext/wxruby3/swig/memory_management.i

@@ -106,6 +106,12 @@ GC_NEVER(kls);
 %define GC_MANAGE_AS_UNTRACKED(kls)
 %enddef
 
+// Strategy for objects that are GC marked through customized, tailored, mechanisms outside
+// of the standard SWIG object tracking option.
+// The different naming is mostly to allow doc gen to properly recognize these objects.
+%define GC_MANAGE_AS_MARKED(kls)
+%enddef
+
 // Sizers attached to windows are automatically destroyed by wxWidgets,
 // so they should not be deleted.
 //

data/lib/wx/core/book_ctrl_base.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+module Wx
+
+  class BookCtrlBase
+
+    # create PersistentObject for toplevel windows (incl. Dialog and Frame)
+    def create_persistent_object
+      PersistentBookCtrl.new(self)
+    end
+
+  end
+
+end

data/lib/wx/core/combo_ctrl.rb

@@ -0,0 +1,171 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+
+module Wx
+
+  module ComboPopup
+
+    def self.included(mod)
+      unless mod == Wx::ComboPopupWx
+        mod.class_eval { include Wx::ComboPopup::Methods }
+      end
+    end
+
+    module Methods
+      # Returns pointer to the associated parent {Wx::ComboCtrl}.
+      # @return [Wx::ComboCtrl]
+      # def get_combo_ctrl; end
+
+      # The including class must implement this to initialize its internal variables.
+      #
+      # This method is called immediately after construction finishes. m_combo member variable has been initialized before the call.
+      # @return [void]
+      def init
+      end
+
+      # The including class may implement this to return true if it wants to delay call to {Wx::ComboPopup#create} until the popup is shown for the first time.
+      #
+      # It is more efficient, but on the other hand it is often more convenient to have the control created immediately.
+      #
+      # <div class="wxrb-remark">
+      # <b>Remark:</b>
+      # <p>Base implementation returns false.
+      # </p>
+      # </div>
+      # @return [Boolean]
+      def lazy_create
+        false
+      end
+
+      # The including class must implement this to create the popup control.
+      #
+      # true if the call succeeded, false otherwise.
+      # @param parent [Wx::Window]
+      # @return [Boolean]
+      def create(parent)
+        false
+      end
+
+      # You only need to implement this member function if you create your popup class in non-standard way.
+      #
+      # The default implementation can handle both multiple-inherited popup control (as seen in {Wx::ComboCtrl} samples) and one allocated separately in heap.
+      # If you do completely re-implement this function, make sure it calls Destroy() for the popup control and also deletes this object (usually as the last thing).
+      # @return [void]
+      def destroy_popup
+      end
+
+      # Implement to customize matching of value string to an item container entry.
+      #
+      # <div class="wxrb-remark">
+      # <b>Remark:</b>
+      # <p>Default implementation always return true and does not alter trueItem.
+      # </p>
+      # </div>
+      # @param item [String]  String entered, usually by user or from SetValue() call.
+      # @param trueItem [Boolean] if true the true item string should be returned in case matching but different
+      # @return [Boolean, String] Returns true if a match is found or false if not. If trueItem == true and item matches an entry, but the entry's string representation is not exactly the same (case mismatch, for example), then the true item string should be returned as the match result.
+      def find_item(item, trueItem=false)
+        true
+      end
+
+      # The including class may implement this to return adjusted size for the popup control, according to the variables given.
+      #
+      # <div class="wxrb-remark">
+      # <b>Remark:</b>
+      # <p>This function is called each time popup is about to be shown.
+      # </p>
+      # </div>
+      # @param minWidth [Integer]  Preferred minimum width.
+      # @param prefHeight [Integer]  Preferred height. May be -1 to indicate no preference.
+      # @param maxHeight [Integer]  Max height for window, as limited by screen size.
+      # @return [Wx::Size]
+      def get_adjusted_size(minWidth, prefHeight, maxHeight)
+        Wx::Size.new(minWidth, prefHeight)
+      end
+
+      # The including class must implement this to return pointer to the associated control created in {Wx::ComboPopup#create}.
+      # @return [Wx::Window]
+      def get_control
+      end
+
+      # The including class must implement this to receive string value changes from {Wx::ComboCtrl}.
+      # @param value [String]
+      # @return [void]
+      def set_string_value(value)
+      end
+
+      # The including class must implement this to return string representation of the value.
+      # @return [String]
+      def get_string_value
+        nil
+      end
+
+      # The including class may implement this to do something when the parent {Wx::ComboCtrl} gets double-clicked.
+      # @return [void]
+      def on_combo_double_click
+      end
+
+      # The including class may implement this to receive key down events from the parent {Wx::ComboCtrl}.
+      #
+      # Events not handled should be skipped, as usual.
+      # @param event [Wx::KeyEvent]
+      # @return [void]
+      def on_combo_key_event(event)
+        event.skip
+      end
+
+      # The including class may implement this to receive char events from the parent {Wx::ComboCtrl}.
+      #
+      # Events not handled should be skipped, as usual.
+      # @param event [Wx::KeyEvent]
+      # @return [void]
+      def on_combo_char_event(event)
+        event.skip
+      end
+
+      # The including class may implement this to do special processing when popup is hidden.
+      # @return [void]
+      def on_dismiss
+      end
+
+      # The including class may implement this to do special processing when popup is shown.
+      # @return [void]
+      def on_popup
+      end
+
+      # The including class may implement this to paint the parent {Wx::ComboCtrl}.
+      # This is called to custom paint in the combo control itself (ie. not the popup).
+      #
+      # Default implementation draws value as string.
+      # @param dc [Wx::DC]
+      # @param rect [Wx::Rect]
+      # @return [void]
+      def paint_combo_control(dc, rect)
+        combo = get_combo_ctrl
+        if combo.get_window_style.allbits?(Wx::CB_READONLY) # ie. no textctrl
+          combo.prepare_background(dc, rect,0)
+
+          dc.draw_text(combo.get_value,
+                       rect.x + combo.get_margin_left,
+                       (rect.height-dc.get_char_height)/2 + rect.y)
+        end
+      end
+
+    end
+
+  end
+
+  class ComboPopupWx
+
+    include ComboPopup
+
+    # this method has not been wrapped as a default popup control will always already have been
+    # initialized before returned from #get_combo_control
+    # just do nothing here (or should we raise an exception?)
+    def init; end
+
+  end
+
+end