wxruby3 0.9.4 → 0.9.7

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

data/lib/wx/core/ext.rb

@@ -28,18 +28,37 @@ module Wx
       end
     end
 
+    class Value
+      def initialize(code, block)
+        @code = code
+        @block = block
+      end
+
+      def value
+        @block ? @block.call : Kernel.eval(@code || 'nil')
+      end
+
+      def to_s
+        @code || ''
+      end
+    end
+
     def delayed_constants
       @delayed_constants ||= ::Hash.new
     end
 
     public
 
-    def add_delayed_constant(mod, sym, &block)
-      delayed_constants[Key.new(mod,sym)] = block
+    def add_delayed_constant(mod, sym, code='', &block)
+      delayed_constants[Key.new(mod,sym)] = Value.new(code, block)
+    end
+
+    def delayed_constants_for(mod)
+      delayed_constants.select { |k,v| k.mod == mod }
     end
 
     def load_delayed_constants
-      delayed_constants.each_pair { |key, blk| key.mod.const_set(key.sym, blk.call) }
+      delayed_constants.each_pair { |key, val| key.mod.const_set(key.sym, val.value) }
       delayed_constants.clear # cleanup
     end
 

data/lib/wx/doc/comboctrl.rb

@@ -7,11 +7,136 @@
 
 module Wx
 
-  class OwnerDrawnComboBox < ComboCtrl
+  # In order to use a custom popup with {Wx::ComboCtrl}, a class must include {Wx::ComboPopup}.
+  #
+  # For more information on how to use it, see {Wx::ComboCtrl Setting Custom Popup for Wx::ComboCtrl}.
+  module ComboPopup
 
-    alias :get_item_data :get_client_object
+    # Returns pointer to the associated parent {Wx::ComboCtrl}.
+    # @return [Wx::ComboCtrl]
+    def get_combo_ctrl; end
 
-    alias :set_item_data :set_client_object
+    # 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; 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) 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) 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) 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; 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) 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) 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) end
+
+  end
+
+  # A Ruby interface class for default comboctrl popup classes used by {Wx::OwnerDrawnComboBox} and
+  # {Wx::RichTextStyleListBox}.
+  #
+  # If no custom popup control has been installed with {Wx::ComboCtrl#SetPopupControl} an instance of this
+  # class will be returned when {Wx::ComboCtrl#GetPopupControl} is called for either of the widgets mentioned
+  # above.
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>This is an abstract class that cannot be derived from.
+  # </p>
+  # </div>
+  class ComboPopupWx
+
+    include ComboPopup
 
   end
 

data/lib/wx/doc/owner_drawn_combobox.rb

@@ -7,7 +7,11 @@
 
 module Wx
 
-  class OwnerDrawnComboBox
+  class OwnerDrawnComboBox < ComboCtrl
+
+    alias :get_item_data :get_client_object
+
+    alias :set_item_data :set_client_object
 
     # Returns the label of the selected item or an empty string if no item is selected.
     #

data/lib/wx/version.rb

@@ -3,5 +3,5 @@
 # This software is released under the MIT license.
 
 module Wx
-  WXRUBY_VERSION    = '0.9.4'
+  WXRUBY_VERSION    = '0.9.7'
 end

data/lib/wx/wxruby/base.rb

@@ -25,12 +25,15 @@ module WxRuby
       end
       private :commands
 
+      def setup_done?
+        File.exist?(File.join(WxRuby::ROOT, 'ext', 'wxruby.setup.done'))
+      end
+
       def options
         @options ||= {
           :verbose => false
         }
       end
-      private :options
 
       def register(cmdid, cmdhandler)
         commands[cmdid.to_s] = case
@@ -59,7 +62,7 @@ module WxRuby
       def parse_args(args)
         opts = OptionParser.new
         opts.banner = "Usage: wxruby [global options] COMMAND [arguments]\n\n" +
-            "    COMMAND\t\t\tSpecifies wxruby command to execute."
+            "    COMMAND\t\t\t\tSpecifies wxruby command to execute."
         opts.separator ''
         opts.on('-v', '--verbose',
                 'Show verbose output') { |v| ::WxRuby::Commands.options[:verbose] = true }
@@ -70,8 +73,7 @@ module WxRuby
           describe_all
           exit(0)
         end
-        opts.raise_unknown = false
-        opts.parse!(args)
+        opts.order!(args)
       end
     end
   end

data/lib/wx/wxruby/cmd/sampler.rb

@@ -10,44 +10,54 @@ require 'fileutils'
 module WxRuby
   module Commands
     class Sampler
-      OPTIONS = {
-        save_path: nil
-      }
+
+      DESC = 'Run wxRuby3 Sampler application (or copy samples).'
 
       def self.description
-        "    sampler [help]|[copy DEST]\tRun wxRuby3 Sampler application (or copy samples)."
+        "    sampler -h|[options]\t\t#{DESC}"
+      end
+
+      def self.options
+        Commands.options['sampler'] ||= { verbose: Commands.options[:verbose] }
+      end
+
+      def self.parse_args(args)
+        opts = OptionParser.new
+        opts.banner = "#{DESC}\n\nUsage: wxruby sampler -h|--help OR wxruby sampler [options]\n\n" +
+          "Runs the sampler application if no options specified.\n\n"
+        opts.separator ''
+        opts.on('--copy=DEST',
+                'Copies the included wxRuby sample folders under the directory indicated by DEST (MUST exist)')  {|v| Sampler.options[:copy] << v }
+        opts.on('-h', '--help',
+                'Show this message.') do |v|
+          puts opts
+          puts
+          exit(0)
+        end
+        opts.parse!(args)
       end
 
       def self.run(argv)
-        if argv == :describe
-          description
-        else
-          if argv.empty?
-            exec(RUBY, File.join(WxRuby::ROOT, 'samples', 'sampler.rb'))
-          else
-            arg = argv.shift
-            if arg == 'help'
-              puts 'Usage: wxruby [global options] sampler [help]|[copy DEST]'
-              puts
-              puts '    Starts the sampler application if called without arguments.'
-              puts '    Otherwise shows this help for argument "help" or copies the included wxRuby'
-              puts '    sample folders under the directory indicated by DEST for argument "copy DEST".'
-              puts '    The directory indicated by DEST *must* already exist.'
-              puts
-            elsif arg == 'copy'
-              unless File.directory?(dest = argv.shift)
-                STDERR.puts "ERROR: Invalid destination folder #{dest}"
-                exit(1)
-              end
-              Dir[File.join(WxRuby::ROOT, 'samples', '*')].each do |fp|
-                FileUtils.cp_r(fp, dest, verbose: true)
-              end
-            end
+        return description if argv == :describe
+
+        parse_args(argv)
+
+        if options[:copy]
+          unless File.directory?(dest = options[:copy])
+            $stderr.puts "ERROR: Invalid destination folder #{dest}"
+            exit(1)
           end
+          Dir[File.join(WxRuby::ROOT, 'samples', '*')].each do |fp|
+            FileUtils.cp_r(fp, dest, verbose: true)
+          end
+        else
+          exec(RUBY, File.join(WxRuby::ROOT, 'samples', 'sampler.rb'))
         end
       end
     end
 
-    self.register('sampler', Sampler)
+    if self.setup_done?
+      self.register('sampler', Sampler)
+    end
   end
 end

data/lib/wx/wxruby/cmd/setup.rb

@@ -0,0 +1,122 @@
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+
+# wxruby setup command handler
+#--------------------------------------------------------------------
+
+require 'fileutils'
+
+module WxRuby
+  module Commands
+    class Setup
+
+      DESC = 'Run wxRuby3 post-install setup.'
+
+      def self.description
+        "    setup -h|[options]\t\t#{DESC}"
+      end
+
+      def self.options
+        Commands.options['setup'] ||= { verbose: Commands.options[:verbose] }
+      end
+
+      def self.parse_args(args)
+        opts = OptionParser.new
+        opts.banner = "#{DESC}\n\nUsage: wxruby setup -h|--help OR wxruby setup [options]\n\n"
+        opts.separator ''
+        opts.on('--wxwin=path',
+                "the installation root for the wxWidgets libraries and headers if not using the system default")  {|v| Setup.options['wxwin'] = File.expand_path(v)}
+        opts.on('--wxxml=path',
+                "the path to the doxygen generated wxWidgets XML interface specs if not using bootstrap")  {|v| Setup.options['wxxml'] = File.expand_path(v)}
+        opts.on('--with-wxwin',
+                "build a local copy of wxWidgets for use with wxRuby [false]")  {|v| Setup.options['with-wxwin'] = true}
+        opts.on('--swig=path',
+                "the path to swig executable [swig]")  {|v| Setup.options['swig'] = v}
+        opts.on('--doxygen=path',
+                "the path to doxygen executable [doxygen]")  {|v| Setup.options['doxygen'] = v}
+        opts.on('--git=path',
+                "the path to git executable [git]")  {|v| Setup.options['git'] = v}
+        opts.on('--[no-]autoinstall',
+                "do (not) attempt to automatically install any required packages")  {|v| Setup.options['autoinstall'] = !!v }
+        opts.on('--log=PATH',
+                "write log to PATH/setup.log (PATH must exist) and do not remove when finished")  {|v| Setup.options['log'] = v }
+        opts.on('-h', '--help',
+                'Show this message.') do |v|
+          puts opts
+          puts
+          exit(0)
+        end
+        opts.parse!(args)
+      end
+
+      def self.run(argv)
+        return description if argv == :describe
+
+        parse_args(argv)
+
+        cfg_args = []
+        cfg_args << "--wxwin=#{Setup.options['wxwin']}" if Setup.options['wxwin']
+        cfg_args << "--wxxml=#{Setup.options['wxxml']}" if Setup.options['wxxml']
+        cfg_args << '--with-wxwin' if Setup.options['with-wxwin']
+        cfg_args << "--swig=#{Setup.options['swig']}" if Setup.options['swig']
+        cfg_args << "--doxygen=#{Setup.options['doxygen']}" if Setup.options['doxygen']
+        cfg_args << "--git=#{Setup.options['git']}" if Setup.options['git']
+        unless Setup.options['autoinstall'].nil?
+          cfg_args << (Setup.options['autoinstall'] ? '--autoinstall' : '--no-autoinstall')
+        end
+        cfg_cmd = 'rake configure'
+        cfg_cmd << "[#{cfg_args.join(',')}]" unless cfg_args.empty?
+
+        result = false
+        FileUtils.chdir(WxRuby::ROOT) do
+          steps = 0
+          actions_txt = if Setup.options['autoinstall'] != false
+                          steps = 1
+                          '(possibly) install required software'
+                        else
+                          ''
+                        end
+          if Setup.options['with-wxwin'] || Setup.options['wxwin'].nil?
+            actions_txt << ', ' if steps>0
+            actions_txt << 'build the wxWidgets libraries (if needed), '
+            actions_txt << "\n" if steps>0
+            steps += 1
+          else
+            actions_txt << ',' if steps>0
+          end
+          actions_txt << 'build the native wxRuby3 extensions '
+          actions_txt << "\n" if steps==1
+          actions_txt << 'and generate the wxRuby3 reference documentation.'
+          $stdout.puts <<~__INFO_TXT
+
+            ---            
+            Now running wxRuby3 post-install setup.
+            This will #{actions_txt}
+            Please be patient as this may take quite a while depending on your system.
+            ---
+
+            __INFO_TXT
+          log_file = File.join(WxRuby::ROOT, 'setup.log')
+          if Setup.options['log']
+            if File.directory?(Setup.options['log']) && File.writable?(Setup.options['log'])
+              log_file = File.join(Setup.options['log'], 'setup.log')
+            else
+              $stderr.puts "ERROR: cannot write log to #{Setup.options['log']}. Log path must exist and be writable."
+              exit(1)
+            end
+          end
+          run_env = {'WXRUBY_RUN_SILENT' => "#{log_file}"}
+          run_env['WXRUBY_VERBOSE'] = '1' if Setup.options[:verbose]
+          # can't rely on FileUtils#chdir returning the block result (bug in older Rubies) so assign result here
+          result = system(run_env, "#{cfg_cmd} && rake -m wxruby:gem:setup#{Setup.options['log'] ? '[:keep_log]' : ''} && gem rdoc wxruby3 --overwrite")
+        end
+        exit(result ? 0 : 1)
+      end
+    end
+
+    unless self.setup_done?
+      self.register('setup', Setup)
+    end
+  end
+end