wxruby3 1.2.0 → 1.3.0

data/rakelib/lib/generate/doc/generic_about_dialog.yaml

@@ -0,0 +1,46 @@
+---
+:wxGenericAboutDialog:
+  :detail:
+    :pre:
+      :programlisting:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+
+            ```ruby
+            class MyFrame < Wx::Frame
+            
+              # declare custom about dialog class                        
+              class MyAboutDlg < Wx::GenericAboutDialog
+            
+                def initialize(about_info, parent=nil)
+                  super()
+            
+                  create(about_info, parent)
+                end
+            
+                def do_add_custom_controls
+                  # add custom controls ...
+                end
+                protected :do_add_custom_controls
+            
+              end
+            
+              # fill in MyFrame class ...
+            
+              # handler for an About menu/button
+              def on_about(_evt)
+                aboutInfo = Wx::AboutDialogInfo.new
+                
+                aboutInfo.set_name('MyApp')
+                aboutInfo.set_version(MY_APP_VERSION_STRING)
+                aboutInfo.set_description('My wxWidgets-based application!')
+                aboutInfo.set_copyright('(C) 1992-2024')
+                aboutInfo.set_web_site('http://myapp.org')
+                aboutInfo.add_developer('My Self')
+                
+                MyFrame.MyAboutDlg(aboutInfo, self) do |dlgAbout|
+                  dlgAbout.show_modal
+                end
+              end
+            end
+            ```

data/rakelib/lib/specs/interfaces.rb

@@ -237,6 +237,8 @@ module WXRuby3
     Director.Spec(pkg, 'wxDCOverlay', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxGeometry', requirements: %w[USE_GEOMETRY])
     Director.Spec(pkg, 'wxAffineMatrix2D', requirements: %w[USE_GEOMETRY])
+    Director.Spec(pkg, 'wxCredentialEntryDialog', director: Director::Dialog, requirements: %w[USE_CREDENTIALDLG])
+    Director.Spec(pkg, 'wxGenericAboutDialog', director: Director::Dialog, requirements: %w[USE_ABOUTDLG])
   }
 
   Director.Package('Wx::PRT', 'USE_PRINTING_ARCHITECTURE') do |pkg|

data/rakelib/lib/swig_runner.rb

@@ -726,20 +726,23 @@ module WXRuby3
             elsif wrapper_re =~ line
               class_nm = $1
               mtd_nm = $2
+              if /(\w+)__SWIG_.+/ =~ mtd_nm # in case of method overloads
+                mtd_nm = $1
+              end
               at_wrapper = true
               if (mdef = member_map[class_nm].detect { |m| Extractor::MethodDef === m && (m.rb_name || m.name) == mtd_nm })
                 matched_wrapper = true
                 mtd_call_re = /(\s*)\S.*arg1\)?->#{mtd_nm}(\(.*\));/
-                line = [line, '  bool fpa_upcall = false;', '  Swig::Director *fpa_dir = 0;']
+                line = [line, '  bool SWIGUNUSED fpa_upcall = false;', '  Swig::Director* SWIGUNUSED fpa_dir = 0;']
               elsif (mdef = member_map[class_nm].detect { |m| Extractor::MemberVarDef === m && "#{m.rb_name || m.name}_get" == mtd_nm })
                 matched_wrapper = true
                 mtd_call_re = /(\s*)\S.*arg1\)?->#{mdef.name}\)?;/
-                line = [line, '  bool fpa_upcall = false;', '  Swig::Director *fpa_dir = 0;']
+                line = [line, '  bool SWIGUNUSED fpa_upcall = false;', '  Swig::Director* SWIGUNUSED fpa_dir = 0;']
               elsif (mdef = member_map[class_nm].detect { |m| Extractor::MemberVarDef === m && "#{m.rb_name || m.name}_set" == mtd_nm })
                 matched_wrapper = true
                 at_setter = true;
                 mtd_call_re = /(\s*)\S.*arg1\)?->#{mdef.name}(\s*=\s*.*);/
-                line = [line, '  bool fpa_upcall = false;', '  Swig::Director *fpa_dir = 0;']
+                line = [line, '  bool SWIGUNUSED fpa_upcall = false;', '  Swig::Director* SWIGUNUSED fpa_dir = 0;']
               end
             elsif /rb_define_method\(SwigClassWx(#{cls_re_txt}).klass\s*,\s*"(\w+)(=)?"\s*,\s*VALUEFUNC/ =~ line
               class_nm = $1

data/rakelib/lib/util/string.rb

@@ -107,9 +107,10 @@ module WXRuby3
       end
 
       def rb_constant_expression(exp, const_xref)
-        exp.gsub(/(\w+(::\w+)*)(\s*\()?/) do |s|
+        exp.gsub(/(\w+(::\w+)*)(\s*\((\))?)?/) do |s|
           idstr = $1
-          is_call = !!$3
+          call_bracket = $3
+          is_empty_call = !!$4
           is_scoped = false
           ids = idstr.split('::')
           if ids.size > 1
@@ -120,18 +121,18 @@ module WXRuby3
             end
           end
           idstr = ids.shift
-          if is_call
+          if call_bracket
             # object ctor or static method call
             if is_scoped
               # static method
-              "#{scoped_name}.#{rb_method_name(idstr)}("
+              "#{scoped_name}.#{rb_method_name(idstr)}#{call_bracket}"
             else
               # ctor
               case idstr
               when 'wxString'
-                '('
+                is_empty_call ? "''" : call_bracket
               else
-                "#{idstr.start_with?('wx') ? 'Wx::' : ''}#{rb_wx_name(idstr)}.new("
+                "#{idstr.start_with?('wx') ? 'Wx::' : ''}#{rb_wx_name(idstr)}.new#{call_bracket}"
               end
             end
           else

data/samples/animate/anitest.rb

@@ -0,0 +1,288 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+#
+# Adapted for wxRuby from wxWidgets widgets sample
+# Copyright (c) 2001 Julian Smart
+
+require 'wx'
+
+module AniTest
+
+  # Define a new frame
+  class MyFrame < Wx::Frame
+
+    module ID
+      include Wx::IDHelper
+
+      PLAY = self.next_id
+      SET_NULL_ANIMATION = self.next_id
+      SET_INACTIVE_BITMAP = self.next_id
+      SET_NO_AUTO_RESIZE = self.next_id
+      SET_BGCOLOR = self.next_id
+      USE_GENERIC = self.next_id
+
+    end
+
+    def initialize(title)
+      super(nil, :title => title, :size => [500, 400], style: Wx::DEFAULT_FRAME_STYLE)
+
+      set_icon(Wx.Icon(:sample, art_path: File.dirname(__dir__)))
+
+      # Make a menubar
+      file_menu = Wx::Menu.new
+
+      if Wx.has_feature?(:USE_FILEDLG)
+        file_menu.append(Wx::ID_OPEN, "&Open Animation...\tCtrl+O", 'Loads an animation')
+      end # USE_FILEDLG
+      file_menu.append(Wx::ID_EXIT)
+
+      play_menu = Wx::Menu.new
+      play_menu.append(ID::PLAY, "Play\tCtrl+P", "Play the animation")
+      play_menu.append(Wx::ID_STOP, "Stop\tCtrl+S", "Stop the animation")
+      play_menu.append_separator
+      play_menu.append(ID::SET_NULL_ANIMATION, "Set null animation",
+                       "Sets the empty animation in the control")
+      play_menu.append_check_item(ID::SET_INACTIVE_BITMAP, "Set inactive bitmap",
+                                  "Sets an inactive bitmap for the control")
+      play_menu.append_check_item(ID::SET_NO_AUTO_RESIZE, "Set no autoresize",
+                                  "Tells the control not to resize automatically")
+      play_menu.append(ID::SET_BGCOLOR, "Set background colour...",
+                       "Sets the background colour of the control")
+
+      if Wx::PLATFORM == 'WXGTK'
+        play_menu.append_separator
+        play_menu.append_check_item(ID::USE_GENERIC, "Use &generic animation\tCtrl+G",
+                                    "Selects whether native or generic version is used")
+      end
+
+      help_menu = Wx::Menu.new
+      help_menu.append(Wx::ID_ABOUT)
+
+      menu_bar = Wx::MenuBar.new
+
+      menu_bar.append(file_menu, "&File")
+      menu_bar.append(play_menu, "&Animation")
+      menu_bar.append(help_menu, "&Help")
+
+      # Associate the menu bar with this frame
+      set_menu_bar(menu_bar)
+
+      if Wx.has_feature?(:USE_STATUSBAR)
+        create_status_bar
+      end # USE_STATUSBAR
+
+      # use a Wx::BoxSizer otherwise Wx::Frame will automatically
+      # resize the @animation_ctrl to fill its client area on
+      # user resizes
+      sz = Wx::VBoxSizer.new
+      sz.add(Wx::StaticText.new(self, Wx::ID_ANY, "wxAnimationCtrl:"),
+             Wx::SizerFlags.new.centre.border)
+
+      @animation_ctrl = Wx::AnimationCtrl.new(self, Wx::ID_ANY)
+
+      if Wx::WXWIDGETS_VERSION >= '3.3.0'
+        animations = Wx::AnimationBundle.new
+
+        throbber = Wx::Animation.new(File.join(__dir__, 'throbber.gif'))
+        animations.add(throbber) if throbber.ok?
+
+        throbber2x = Wx::Animation.new(File.join(__dir__, 'throbber_2x.gif'))
+        animations.add(throbber2x) if throbber2x.ok?
+
+        if animations.ok?
+          @animation_ctrl.set_animation(animations)
+          @animation_ctrl.play
+        end
+      elsif @animation_ctrl.load('throbber.gif')
+        @animation_ctrl.play
+      end
+
+      sz.add(@animation_ctrl, Wx::SizerFlags.new.centre.border)
+      set_sizer(sz)
+
+      evt_menu(ID::PLAY, :on_play)
+      evt_menu(ID::SET_NULL_ANIMATION, :on_set_null_animation)
+      evt_menu(ID::SET_INACTIVE_BITMAP, :on_set_inactive_bitmap)
+      evt_menu(ID::SET_NO_AUTO_RESIZE, :on_set_no_auto_resize)
+      evt_menu(ID::SET_BGCOLOR, :on_set_bg_color)
+      if Wx::PLATFORM == 'WXGTK'
+        evt_menu(ID::USE_GENERIC, :on_use_generic)
+      end
+
+      evt_menu(Wx::ID_STOP, :on_stop)
+      evt_menu(Wx::ID_ABOUT, :on_about)
+      evt_menu(Wx::ID_EXIT, :on_quit)
+      if Wx.has_feature?(:USE_FILEDLG)
+        evt_menu(Wx::ID_OPEN, :on_open)
+      end # USE_FILEDLG
+
+      evt_size { self.layout }
+      evt_update_ui(Wx::ID_ANY, :on_update_ui)
+    end
+
+    def on_about(_event)
+      info = Wx::AboutDialogInfo.new
+      info.set_name("Wx::AnimationCtrl and Wx::Animation sample")
+      info.set_description("This sample program demonstrates the usage of Wx::AnimationCtrl")
+      info.set_copyright("(C) 2024 Martin Corino (original (C) 2006 Julian Smart)")
+
+      info.add_developer("Martin Corino")
+
+      Wx.about_box(info, self)
+    end
+
+    def on_quit(_event)
+      close
+    end
+
+    def on_play(_event)
+      Wx.log_error('Invalid animation') unless @animation_ctrl.play
+    end
+
+    def on_set_null_animation(_event)
+      @animation_ctrl.set_animation(Wx::NULL_ANIMATION)
+    end
+
+    def on_set_inactive_bitmap(event)
+      if event.checked?
+        # set a dummy bitmap as the inactive bitmap
+        bmp = Wx::ArtProvider.get_bitmap(Wx::ART_MISSING_IMAGE)
+        @animation_ctrl.set_inactive_bitmap(bmp)
+      else
+        @animation_ctrl.set_inactive_bitmap(Wx::NULL_BITMAP)
+      end
+    end
+
+    def on_set_no_auto_resize(event)
+      # recreate the control with the new flag if necessary
+      style = Wx::AC_DEFAULT_STYLE | (event.checked? ? Wx::AC_NO_AUTORESIZE : 0)
+
+      recreate_animation(style) if style != @animation_ctrl.get_window_style
+    end
+
+    def on_set_bg_color(_event)
+      clr = Wx.get_colour_from_user(self, @animation_ctrl.get_background_colour,
+                                    'Choose the background colour')
+
+      @animation_ctrl.set_background_colour(clr) if clr.ok?
+    end
+
+    def on_stop(_event)
+      @animation_ctrl.stop
+    end
+
+    if Wx::PLATFORM == 'WXGTK'
+
+      def on_use_generic(_event)
+        recreate_animation(@animation_ctrl.get_window_style)
+      end
+
+    end
+
+    def on_update_ui(_event)
+      get_menu_bar.find_item(Wx::ID_STOP).first.enable(@animation_ctrl.playing?)
+      get_menu_bar.find_item(ID::PLAY).first.enable(!@animation_ctrl.playing?)
+      get_menu_bar.find_item(ID::SET_NO_AUTO_RESIZE).first.enable(!@animation_ctrl.playing?)
+    end
+
+    if Wx.has_feature?(:USE_FILEDLG)
+
+      def on_open(_event)
+        Wx.FileDialog(self, "Please choose an animation", '', '', '*.gif;*.ani', Wx::FD_OPEN) do |dialog|
+          if dialog.show_modal == Wx::ID_OK
+              filename = dialog.get_path
+
+              temp = @animation_ctrl.create_animation
+              unless temp.load_file(filename)
+                Wx.log_error("Sorry, this animation is not a valid format for Wx::Animation.")
+                return
+              end
+
+              @animation_ctrl.set_animation(temp)
+              @animation_ctrl.play
+
+              get_sizer.layout
+          end
+        end
+      end
+
+    end # USE_FILEDLG
+
+    private
+
+    def recreate_animation(style) 
+      # save status of the control before destroying it
+  
+      # We can't reuse the existing animation if we're switching from native to
+      # generic control or vice versa (as indicated by the absence of change in
+      # the style, which is the only other reason we can get called). We could
+      # save the file name we loaded it from and recreate it, of course, but for
+      # now, for simplicity, just start without any animation in this case.
+      curr = Wx::Animation.new
+      if Wx::PLATFORM == 'WXGTK'
+        curr = @animation_ctrl.get_animation if style != @animation_ctrl.get_window_style
+      end
+  
+      inactive = @animation_ctrl.get_inactive_bitmap
+      bg = @animation_ctrl.get_background_colour
+  
+      # destroy & rebuild
+      old = @animation_ctrl
+  
+      if Wx::PLATFORM == 'WXGTK' && get_menu_bar.is_checked(ID::USE_GENERIC)
+        @animation_ctrl = Wx::GenericAnimationCtrl.new(self, Wx::ID_ANY, curr, style: style)
+      else
+        @animation_ctrl = Wx::AnimationCtrl.new(self, Wx::ID_ANY, curr, style: style)
+      end
+  
+      get_sizer.replace(old, @animation_ctrl)
+
+      # load old status in new control
+      @animation_ctrl.set_inactive_bitmap(inactive)
+      @animation_ctrl.set_background_colour(bg)
+  
+      get_sizer.layout
+    end
+
+  end
+
+
+  class App < Wx::App
+
+    # this one is called on application startup and is a good place for the app
+    # initialization (doing it here and not in the ctor allows to have an error
+    # return: if OnInit() returns false, the application terminates)
+    def on_init
+      # Create the main frame window
+      frame = MyFrame.new('Animation Demo')
+      frame.show
+    end
+
+  end
+
+end
+
+module AniTestSample
+
+  include WxRuby::Sample if defined? WxRuby::Sample
+
+  def self.describe
+    { file: __FILE__,
+      summary: 'wxRuby AnimationCtrl example.',
+      description: <<~__DESC
+        A Ruby port of the wxWidgets anitest sample which showcases
+        animation controls.
+      __DESC
+    }
+  end
+
+  def self.run
+    execute(__FILE__)
+  end
+
+  if $0 == __FILE__
+    AniTest::App.run
+  end
+
+end

data/tests/lib/leaked_overload_exception_test.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './wxframe_runner'
+
+class DirectorOverloadExceptionTests < WxRuby::Test::GUITests
+
+  class ExceptionSizer < Wx::BoxSizer
+
+    def calc_min
+      raise RuntimeError, 'AnyThing'
+    end
+
+  end
+
+  def test_exception_in_overload
+    szr = ExceptionSizer.new(Wx::Orientation::VERTICAL)
+    szr.add(Wx::Button.new(frame_win, name: 'button'), Wx::Direction::TOP)
+    frame_win.sizer = szr
+    frame_win.layout
+    frame_win.sizer = nil
+  end
+
+end

data/tests/lib/leaked_process_event_exception_test.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './wxapp_runner'
+
+class ProcessEventHandlingExceptionTests < Test::Unit::TestCase
+
+  class TestEvent < Wx::Event
+    EVT_TEST_EVENT = Wx::EvtHandler.register_class(self, nil, 'evt_test_event', 0)
+    def initialize(id=0)
+      super(EVT_TEST_EVENT, id)
+    end
+  end
+
+  class TestFrame < Wx::Frame
+
+    def initialize
+      super(nil, size: [300,300])
+
+      evt_test_event { |_evt| raise RuntimeError, 'Whatever' }
+    end
+
+  end
+
+  def test_process_event
+    win = TestFrame.new
+    win.process_event(TestEvent.new)
+    win.destroy
+    10.times { Wx.get_app.yield }
+  end
+
+end

data/tests/lib/leaked_queued_event_exception_test.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './wxapp_runner'
+
+class QueuedEventHandlingExceptionTests < Test::Unit::TestCase
+
+  class TestEvent < Wx::Event
+    EVT_TEST_EVENT = Wx::EvtHandler.register_class(self, nil, 'evt_test_event', 0)
+    def initialize(id=0)
+      super(EVT_TEST_EVENT, id)
+    end
+  end
+
+  class TestFrame < Wx::Frame
+
+    def initialize
+      super(nil, size: [300,300])
+
+      evt_test_event { |_evt| raise RuntimeError, 'Whatever' }
+    end
+
+  end
+
+  def test_queue_event
+    win = TestFrame.new
+    win.queue_event(TestEvent.new)
+    Wx.get_app.yield
+    win.destroy
+    10.times { Wx.get_app.yield }
+  end
+
+end

data/tests/lib/overload_type_exception_test.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './wxframe_runner'
+
+class DirectorTypeExceptionTests < WxRuby::Test::GUITests
+
+  class InvalidOutputSizer < Wx::BoxSizer
+
+    def calc_min
+      nil #Wx::Point.new(1,1) # expects Wx::Size
+    end
+
+  end
+
+  def test_invalid_output
+    szr = InvalidOutputSizer.new(Wx::Orientation::VERTICAL)
+    szr.add(Wx::Button.new(frame_win, name: 'button'), Wx::Direction::TOP)
+    frame_win.sizer = szr
+    frame_win.layout
+    frame_win.sizer = nil
+  end
+
+end

data/tests/test_exceptions.rb

@@ -2,40 +2,40 @@
 #
 # This software is released under the MIT license.
 
-require_relative './lib/wxframe_runner'
+require 'test/unit'
+require 'plat4m'
+require 'open3'
 
-class DirectorExceptionTests < WxRuby::Test::GUITests
+class DirectorExceptionTests < Test::Unit::TestCase
 
-  class InvalidOutputSizer < Wx::BoxSizer
+  # Path to the currently running Ruby program
+  RUBY = ENV["RUBY"] || File.join(
+    RbConfig::CONFIG["bindir"],
+    RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"]).
+    sub(/.*\s.*/m, '"\&"')
 
-    def calc_min
-      Wx::Point.new(1,1) # expects Wx::Size
-    end
+  OPTS = {
+    :err => (Plat4m.current.windows? ? 'NULL' : '/dev/null'), :out => (Plat4m.current.windows? ? 'NULL' : '/dev/null'),
+  }
 
+  def test_invalid_overload_type
+    assert_false(Kernel.system(RUBY, File.join(__dir__, 'lib/overload_type_exception_test.rb'), **OPTS))
+    assert_equal(254, $?.exitstatus)
   end
 
-  def test_invalid_output
-    szr = InvalidOutputSizer.new(Wx::Orientation::VERTICAL)
-    szr.add(Wx::Button.new(frame_win, name: 'button'), Wx::Direction::TOP)
-    frame_win.sizer = szr
-    assert_raise_kind_of(TypeError) { frame_win.layout }
-    frame_win.sizer = nil
+  def test_leaked_exception_in_overload
+    assert_false(Kernel.system(RUBY, File.join(__dir__, 'lib/leaked_overload_exception_test.rb'), **OPTS))
+    assert_equal(255, $?.exitstatus)
   end
 
-  class ExceptionSizer < Wx::BoxSizer
-
-    def calc_min
-      raise RuntimeError, 'AnyThing'
-    end
-
+  def test_leaked_process_event_handling_exception
+    assert_false(Kernel.system(RUBY, File.join(__dir__, 'lib/leaked_process_event_exception_test.rb'), **OPTS))
+    assert_equal(1, $?.exitstatus)
   end
 
-  def test_exception_in_overload
-    szr = ExceptionSizer.new(Wx::Orientation::VERTICAL)
-    szr.add(Wx::Button.new(frame_win, name: 'button'), Wx::Direction::TOP)
-    frame_win.sizer = szr
-    assert_raise_kind_of(RuntimeError) { frame_win.layout }
-    frame_win.sizer = nil
+  def test_leaked_queued_event_handling_exception
+    assert_false(Kernel.system(RUBY, File.join(__dir__, 'lib/leaked_queued_event_exception_test.rb'), **OPTS))
+    assert_equal(1, $?.exitstatus)
   end
 
 end