wxruby3 0.9.4 → 0.9.7

data/rakelib/lib/generate/doc.rb

@@ -26,22 +26,30 @@ module WXRuby3
           WX_GLOBAL_CONSTANTS=false
           require 'wx'
           def handle_module(mod, table)
+            Wx.delayed_constants_for(mod).each do |key, delayed_const|
+              table[key.sym.to_s] = { type: true, value: delayed_const.to_s }
+            end
             mod.constants.each do |c|
               a_const = mod.const_get(c)
               if (::Module === a_const || ::Class === a_const) && a_const.name.start_with?('Wx::')  # Wx:: Package submodule or Class (possibly Enum)
                 handle_module(a_const, table[c.to_s] = {})
               elsif Wx::Enum === a_const
-                table[c.to_s] = { type: a_const.class.name.split('::').last, value: "\#{a_const.class}.new(\#{a_const.to_i})" } 
-              elsif !(::Hash === a_const || ::Array === a_const) 
-                table[c.to_s] = { type: a_const.class.name.split('::').last, value: a_const } unless c == :THE_APP
+                table[c.to_s] = { type: true, value: "\#{a_const.class}.new(\#{a_const.to_i})" } 
+              elsif !(::Hash === a_const || ::Array === a_const)
+                case a_const
+                when Wx::Size
+                  table[c.to_s] = { type: true, value: "Wx::Size.new(\#{a_const.width}, \#{a_const.height})" }
+                when Wx::Point
+                  table[c.to_s] = { type: true, value: "Wx::Point.new(\#{a_const.x}, \#{a_const.y})" }
+                else 
+                  table[c.to_s] = { type: true, value: a_const } unless c == :THE_APP
+                end
               end
             end
           end
-          Wx::App.run do 
-            table = { 'Wx' => {}}
-            handle_module(Wx, table['Wx'])
-            STDOUT.puts JSON.dump(table)
-          end
+          table = { 'Wx' => {}}
+          handle_module(Wx, table['Wx'])
+          STDOUT.puts JSON.dump(table)
         __SCRIPT
         STDERR.puts "* executing constants collection script:\n#{script}" if Director.trace?
         begin
@@ -693,15 +701,22 @@ module WXRuby3
         # at least 2 newlines to make Yard skip/forget the header comment
         fdoc.puts
         fdoc.puts
-        fdoc.puts "module #{package.fullname}"
-        fdoc.puts
-        fdoc.indent do
+        mod_indent = 0
+        package.all_modules.each do |modnm|
+          fdoc.iputs("module #{package.fullname}", mod_indent)
+          fdoc.puts
+          mod_indent += 1
+        end
+        fdoc.indent(mod_indent) do
           gen_constants_doc(fdoc)
           gen_functions_doc(fdoc) unless no_gen?(:functions)
           gen_class_doc(fdoc) unless no_gen?(:classes)
         end
-        fdoc.puts
-        fdoc.puts 'end'
+        package.all_modules.each do |_|
+          fdoc.puts
+          fdoc.iputs('end', mod_indent)
+          mod_indent -= 1
+        end
       end
     end
 
@@ -742,7 +757,7 @@ module WXRuby3
     end
 
     def gen_constant_value(val)
-      if ::String === val && /\A(#<(.*)>|[\w:]+\.new\(.*\))\Z/ =~ val
+      if ::String === val && /\A(#<(.*)>|[\w:]+\.\w+\(.*\))\Z/ =~ val
         if $2
           valstr = $2
           if /\Awx/ =~ valstr

data/rakelib/lib/generate/interface.rb

@@ -547,10 +547,18 @@ module WXRuby3
         if Extractor::EnumDef === item && !item.ignored && !item.items.all? {|e| e.ignored }
           fout.puts
           fout.puts "// from enum #{item.is_anonymous ? '' : item.name}"
-          fout.puts "enum #{item.name};" unless item.is_anonymous
-          item.items.each do |e|
-            unless e.ignored
-              fout.puts "%constant int #{e.name} = #{e.fqn};"
+          if item.is_anonymous
+            item.items.each do |e|
+              unless e.ignored
+                fout.puts "%constant int #{e.name} = #{e.fqn};"
+              end
+            end
+          else
+            fout.puts "enum #{item.name};"
+            item.items.each do |e|
+              unless e.ignored
+                fout.puts "%constant int #{item.name}_#{e.name} = #{e.fqn};"
+              end
             end
           end
         end
@@ -595,7 +603,8 @@ module WXRuby3
         elsif item.value =~ /wx(Colour|Font)(\(.*\))/
           frbext = init_rb_ext_file unless frbext
           frbext.indent do
-            frbext.puts "Wx.add_delayed_constant(self, :#{rb_constant_name(item.name)}) { Wx::#{$1}.new#{$2} }"
+            code = "Wx::#{$1}.new#{$2}"
+            frbext.puts "Wx.add_delayed_constant(self, :#{rb_constant_name(item.name)}, '#{code}') { #{code} }"
           end
           frbext.puts
         elsif item.value =~ /wxSystemSettings::(\w+)\((.*)\)/
@@ -603,7 +612,8 @@ module WXRuby3
           setting_mtd = $1
           args = $2.split(',').collect {|a| rb_constant_value(a) }.join(', ')
           frbext.indent do
-            frbext.puts "Wx.add_delayed_constant(self, :#{rb_constant_name(item.name)}) { Wx::SystemSettings.#{rb_method_name(setting_mtd)}(#{args}) }"
+            code = "Wx::SystemSettings.#{rb_method_name(setting_mtd)}(#{args})"
+            frbext.puts "Wx.add_delayed_constant(self, :#{rb_constant_name(item.name)}, '#{code}') { #{code} }"
           end
           frbext.puts
         else

data/rakelib/lib/swig_runner.rb

@@ -43,24 +43,23 @@ module WXRuby3
         @swig_version
       end
 
-
       def check_swig
         begin
           @swig_version = `#{WXRuby3::Config.get_config('swig')} -version`[/\d+\.\d+\.\d+/]
         rescue Exception
-          STDERR.puts "ERROR: Could not run SWIG (#{WXRuby3::Config.get_config('swig')})"
+          $stderr.puts "ERROR: Could not run SWIG (#{WXRuby3::Config.get_config('swig')})"
           exit(1)
         end
 
-        # Very old versions put --version on STDERR, not STDOUT
+        # Very old versions put --version on $stderr, not $stdout
         unless @swig_version
-          STDERR.puts "Could not get version info from SWIG; " +
+          $stderr.puts "Could not get version info from SWIG; " +
                         "is a very old version installed?.\n"
           exit(1)
         end
 
         if @swig_version < SWIG_MINIMUM_VERSION
-          STDERR.puts "SWIG version #{@swig_version} is installed, " +
+          $stderr.puts "SWIG version #{@swig_version} is installed, " +
                         "minimum version required is #{SWIG_MINIMUM_VERSION}.\n"
           exit(1)
         end
@@ -72,11 +71,12 @@ module WXRuby3
         check_swig unless swig_state
         inc_paths = "-I#{config.wxruby_dir} -I#{config.swig_dir}/custom"
         inc_paths << " -I#{config.swig_dir}/custom/swig#{swig_major}"
-        sh "#{config.get_config('swig')} #{config.wx_cppflags.join(' ')} " +
-             "#{config.extra_cppflags.join(' ')} #{config.verbose_flag} #{inc_paths} " +
-             #"-w401 -w801 -w515 -c++ -ruby " +
-             "-w801 -c++ -ruby " +
-             "-o #{target} #{source}"
+        WXRuby3.config.sh "#{config.get_config('swig')} #{config.wx_cppflags.join(' ')} " +
+                            "#{config.extra_cppflags.join(' ')} #{config.verbose_flag} #{inc_paths} " +
+                            #"-w401 -w801 -w515 -c++ -ruby " +
+                            "-w801 -c++ -ruby " +
+                            "-o #{target} #{source}",
+                          fail_on_error: true
       end
 
     end
@@ -205,7 +205,7 @@ module WXRuby3
       end
 
       def self.run(pid, director, target)
-        puts "Processor.#{pid}: #{target}"
+        Config.instance.log_progress("Processor.#{pid}: #{target}")
         const_get(camelize(pid.to_s)).new(director, target).run
       end
 
@@ -262,7 +262,7 @@ module WXRuby3
           def_items.each do |item|
             case item
             when Extractor::EnumDef
-              item.items.each { |e| enumerators[rb_wx_name(e.name)] = item } if item.is_type
+              item.items.each { |e| enumerators["#{rb_wx_name(item.name)}_#{e.name}"] = item } if item.is_type
             when Extractor::ClassDef
               item.items.select { |itm| Extractor::EnumDef === itm }.each do |enum|
                 enum.items.each { |e| enumerators[rb_wx_name(e.name)] = enum } if enum.is_type
@@ -334,6 +334,7 @@ module WXRuby3
                     fix_enum = true
                     enum_item = enum_table[md[2]]
                     enum_name = rb_wx_name(enum_item.name)
+                    enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                     enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                     enum_var = enum_id.gsub('::', '_')
                     line = [
@@ -343,7 +344,7 @@ module WXRuby3
                       # add enum class constant to current module (use unscoped name)
                       "  rb_define_const(#{md[1]}, \"#{enum_name}\", cWx#{enum_var}); // Inserted by fixmodule.rb",
                       # create enumerator value const under new enum class
-                      "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                      "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                     ].join("\n")
                   end
                 else
@@ -352,13 +353,15 @@ module WXRuby3
                     # of the same enum?
                     if enum_item && enum_table[md[2]] == enum_item
                       enum_name = rb_wx_name(enum_item.name)
+                      enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                       enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                       enum_var = enum_id.gsub('::', '_')
                       # create enumerator value const under new enum class
-                      line = "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                      line = "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                     else # we found the start of another enum
                       enum_item = enum_table[md[2]]
                       enum_name = rb_wx_name(enum_item.name)
+                      enumerator_name = rb_wx_name(md[2].sub(/\A#{enum_name}_/, ''))
                       enum_id = enum_item.scope.empty? ? enum_name : "#{rb_wx_name(enum_item.scope)}::#{enum_name}"
                       enum_var = enum_id.gsub('::', '_')
                       line = [
@@ -368,7 +371,7 @@ module WXRuby3
                         # add enum class constant to current module (use unscoped name)
                         "  rb_define_const(#{md[1]}, \"#{enum_name}\", cWx#{enum_var}); // Inserted by fixmodule.rb",
                         # create enumerator value const under new enum class
-                        "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{md[2]}\"#{md[3]} // Updated by fixmodule.rb"
+                        "  wxRuby_AddEnumValue(cWx#{enum_var}, \"#{enumerator_name}\"#{md[3]} // Updated by fixmodule.rb"
                       ].join("\n")
                     end
                   else # end of enum def

data/rakelib/lib/typemap/combo_popup.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+###
+# wxRuby3 wxComboPopup typemap definition
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    module ComboPopup
+
+      include Typemap::Module
+
+      define do
+
+        # for DoSetPopupControl
+        map 'wxComboPopup* popup' => 'Wx::ComboPopup,nil' do
+
+          add_header_code <<~__CODE
+            #include <wx/combo.h>
+            
+            WXRUBY_EXPORT wxComboPopup* wxRuby_ComboPopupFromRuby(VALUE popup);
+            WXRUBY_EXPORT VALUE wxRuby_ComboPopupToRuby(wxComboPopup* popup);
+            __CODE
+
+          map_in code: '$1 = wxRuby_ComboPopupFromRuby($input);'
+
+          map_directorin code: '$input = wxRuby_ComboPopupToRuby($1);'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/prepost.rake

@@ -23,16 +23,21 @@ namespace 'wxruby' do
 
   namespace 'post' do
 
-    task :srcgem => %w[gem:wxwin gem:install wxruby:doc] do
+    task :srcgem => %w[gem:wxwin gem:install] do
+      $stdout.print "Generating wxRuby3 reference documentation..." if WXRuby3.config.run_silent?
+      Rake::Task['wxruby:doc'].invoke
+      $stdout.puts 'done!' if WXRuby3.config.run_silent?
       # cleanup
-      rm_rf('rakelib')
-      rm_rf('ext/wxruby3')
-      rm_rf('ext/wxWidgets') if File.exist?('ext/wxWidgets')
+      rm_rf('rakelib', verbose: !WXRuby3.config.run_silent?)
+      rm_rf('ext/wxruby3', verbose: !WXRuby3.config.run_silent?)
+      WXRuby3.config.cleanup_bootstrap
+      File.open(File.join(WXRuby3::Config.wxruby_root, 'ext', 'wxruby.setup.done'), 'w') { |f| f << '1' }
     end
 
     task :bingem => 'gem:install' do
       # cleanup
       rm_rf('rakelib')
+      File.open(File.join(WXRuby3::Config.wxruby_root, 'ext', 'wxruby.setup.done'), 'w') { |f| f << '1' }
     end
 
     namespace 'gem' do

data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css

@@ -77,3 +77,17 @@ div.wxrb-logo table td {
     font-weight: bold;
     font-size: 0.9em;
 }
+
+#filecontents {
+    margin-right: 340px;
+}
+
+#filecontents blockquote {
+    border-left: .5em solid #e0e0e0;
+    margin: 10px;
+    padding-left: 10px;
+}
+
+#toc {
+    position: fixed;
+}

data/rakelib/yard/templates/default/fulldoc/html/setup.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 def init
-  # It seems YARD messes things up so that a number of classes are not properly
+  # It seems YARD messes things up so that a lot of classes, modules and constants are not properly
   # registered in their enclosing namespaces.
   # This hack makes sure that if that is the case we fix that here.
-  all_classes = Registry.all(:class)
-  all_classes.each do |c|
+  all_objects = Registry.all(:class, :constant, :module)
+  all_objects.each do |c|
     if (ns = c.namespace)
       unless ns.children.any? { |nsc| nsc.path == c.path }
-        ns.children << c # class missing from child list of enclosing namespace -> add here
+        ns.children << c # class/module/constant missing from child list of enclosing namespace -> add here
       end
     end
     if (ns = Registry[c.namespace.path])
       unless ns.children.any? { |nsc| nsc.path == c.path }
-        ns.children << c # class missing from child list of enclosing namespace -> add here
+        ns.children << c # class/module/constant missing from child list of enclosing namespace -> add here
       end
     end
   end

data/rakelib/yard/yard/relative_markdown_links.rb

@@ -31,12 +31,18 @@ module YARD # rubocop:disable Style/Documentation
           if fnames.include?(href.path)
             link.replace "{file:#{href} #{link.inner_html}}"
           elsif href.path.end_with?('_md.html') && (fname = fnames.find {|fnm| fnm.end_with?(href.path.sub(/_md.html\Z/, '.md')) })
-            link.replace "{file:#{fname} #{link.inner_html}}"
+            link.replace "{file:#{fname}#{href.fragment ? "##{fragment_to_yard(href.fragment)}" : ''} #{link.inner_html}}"
           end
         end
       end
       super(html.to_s)
     end
+
+    # this does not work with mixed case labels but is good enough for us
+    def fragment_to_yard(s)
+      s.start_with?('label-') ? s : "label-#{s.gsub('-', '+').capitalize}"
+    end
+
   end
 
   Templates::Template.extra_includes << RelativeMarkdownLinks

data/tests/test_combo_ctrl.rb

@@ -0,0 +1,196 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+require_relative './lib/wxframe_runner'
+require_relative './lib/text_entry_tests'
+
+class ComboCtrlCtrlTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class LVComboPopup < Wx::ListView
+
+    include Wx::ComboPopup
+
+    def initialize
+      # call default control ctor; need to call Wx::ListView#create later
+      super
+    end
+
+    def init
+      @value = -1
+    end
+
+    def create(parent)
+      # need to finish creating the list view here
+      # as calling super here would just call Wx::ComboPopup#create and not Wx::ListView#create
+      # we need to use Ruby magic
+      wx_lv_create = (Wx::ListView.instance_method :create).bind(self)
+      wx_lv_create.call(parent, 1, [0,0], Wx::DEFAULT_SIZE)
+      evt_motion :on_mouse_move
+      evt_left_up :on_mouse_click
+    end
+    
+    # Return pointer to the created control
+    def get_control
+      self
+    end
+
+    def lv_find_item(*args)
+      unless @wx_lv_find_item
+        @wx_lv_find_item = (Wx::ListView.instance_method :find_item).bind(self)
+      end
+      @wx_lv_find_item.call(*args)
+    end
+    protected :lv_find_item
+
+    # Translate string into a list selection
+    def set_string_value(s)
+      n = lv_find_item(-1, s)
+      if n >= 0 && n < get_item_count
+        select(n)
+        @value = n
+      end
+    end
+ 
+    # Get list selection as a string
+    def get_string_value
+      return get_item_text(@value) if @value >= 0
+      ''
+    end
+ 
+    # Do mouse hot-tracking (which is typical in list popups)
+    def on_mouse_move(event)
+      # Move selection to cursor ...
+    end
+ 
+    # On mouse left up, set the value and close the popup
+    def on_mouse_click(_event)
+      @value = get_first_selected
+ 
+      # Send event as well ...
+ 
+      dismiss
+    end
+
+  end
+
+  def setup
+    super
+    @combo = Wx::ComboCtrl.new(frame_win, name: 'ComboCtrl')
+    @combo.set_popup_control(LVComboPopup.new)
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.insert_item(0, 'This is the first item')
+    list.insert_item(1, 'This is the second item')
+    list.insert_item(2, 'This is the third item')
+    list.insert_item(3, 'This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control)
+    assert_kind_of(Wx::ListView, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo.get_popup_control) }
+    combo.popup
+
+    combo.set_value_by_user('This is the second item')
+
+    assert_equal('This is the second item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end
+
+class OwnerDrawnCBTests < WxRuby::Test::GUITests
+
+  include TextEntryTests
+
+  class TestODComboBox < Wx::OwnerDrawnComboBox
+
+    def on_draw_item(dc, rect, item, _flags)
+      return if item == Wx::NOT_FOUND
+
+      dc.set_text_foreground(Wx::BLACK)
+      dc.draw_text(get_string(item),
+                   rect.x + 3,
+                   rect.y + ((rect.height - dc.char_height)/2))
+    end
+
+    def on_draw_background(dc, rect, item,  flags)
+      # If item is selected or even, or we are painting the
+      # combo control itself, use the default rendering.
+      if flags.anybits?(Wx::ODCB_PAINTING_CONTROL|Wx::ODCB_PAINTING_SELECTED) || (item & 1) == 0
+        super(dc,rect,item,flags)
+        return
+      end
+
+      # Otherwise, draw every other background with different colour.
+      bgCol = Wx::Colour.new(240,240,250)
+      dc.set_brush(Wx::Brush.new(bgCol))
+      dc.set_pen(Wx::Pen.new(bgCol))
+      dc.draw_rectangle(rect)
+    end
+
+    def on_measure_item(_item)
+      48
+    end
+
+    def on_measure_item_width(_item)
+      -1 # default - will be measured from text width
+    end
+
+  end
+
+  def setup
+    super
+    @combo = TestODComboBox.new(frame_win, name: 'ODComboBox')
+  end
+
+  def cleanup
+    @combo.destroy
+    super
+  end
+
+  attr_reader :combo
+  alias :text_entry :combo
+
+  def fill_list(list)
+    list.append('This is the first item')
+    list.append('This is the second item')
+    list.append('This is the third item')
+    list.append('This is the fourth item')
+  end
+
+  def test_popup
+    assert_equal('', combo.get_value)
+
+    assert_kind_of(Wx::ComboPopup, combo.get_popup_control)
+    assert_kind_of(Wx::ComboPopupWx, combo.get_popup_control)
+    assert_kind_of(Wx::VListBox, combo.get_popup_control.get_control)
+
+    assert_nothing_raised { fill_list(combo) }
+    combo.popup
+
+    combo.set_value_by_user('This is the third item')
+
+    assert_equal('This is the third item', combo.get_popup_control.get_string_value)
+
+    combo.dismiss
+  end
+
+end