wxruby3 0.9.1 → 0.9.3

data/rakelib/lib/director/validator.rb

@@ -16,29 +16,204 @@ module WXRuby3
 
       def setup
         super
-        # make Ruby director and wrappers use custom implementation
-        spec.use_class_implementation('wxValidator', 'wxRubyValidator')
-        # provide custom wxRuby derivative of validator
-        spec.add_header_code <<~__HEREDOC
-          class wxRubyValidator : public wxValidator
-          {
-          public:
-            wxRubyValidator () : wxValidator () {}
-            virtual ~wxRubyValidator ()
+        if spec.module_name == 'wxValidator'
+          # make Ruby director and wrappers use custom implementation
+          spec.use_class_implementation('wxValidator', 'wxRubyValidator')
+          # provide custom wxRuby derivative of validator
+          spec.add_header_code <<~__HEREDOC
+            #include "wxruby-Validator.h"
+  
+            WxRuby_ID wxRubyValidator::do_transfer_from_window_id("do_transfer_from_window");
+            WxRuby_ID wxRubyValidator::do_transfer_to_window_id("do_transfer_to_window");
+            WxRuby_ID wxRubyValidator::clone_id("clone");
+
+            wxRubyValidator::wxRubyValidator () 
+              : wxValidator ()
+              , wxRubyValidatorBinding () 
+            {}
+            wxRubyValidator::wxRubyValidator (const wxRubyValidator& v)
+              : wxValidator (v)
+              , wxRubyValidatorBinding (v)
+            {}
+            wxRubyValidator::~wxRubyValidator ()
             {
               wxRuby_ReleaseEvtHandlerProcs(this);
-            }               
-
-            // these two methods are noops in wxRuby (since we do not support C++ data transfer there) 
-            // but we want them to always return true to prevent wxWidgets from complaining 
-            bool TransferFromWindow () override { return true; }
-            bool TransferToWindow () override { return true; }
-          };
-          __HEREDOC
-        # will be provided as a pure Ruby method
-        spec.ignore 'wxValidator::Clone'
-        # not provided in Ruby
-        spec.ignore %w[wxValidator::TransferFromWindow wxValidator::TransferToWindow]
+            }
+
+            wxObject* wxRubyValidator::Clone() const
+            {
+              bool ex_caught = false;
+              VALUE self = const_cast<wxRubyValidator*> (this)->get_self();
+              VALUE rc = wxRuby_Funcall(ex_caught, self, clone_id(), 0);
+              if (ex_caught)
+              {
+                throw Swig::DirectorRubyException(rc, self, clone_id());
+              }
+              void *ptr;
+              int res = SWIG_ConvertPtr(rc, &ptr, SWIGTYPE_p_wxValidator,  0);
+              if (!SWIG_IsOK(res)) 
+              {
+                Swig::DirectorTypeMismatchException::raise(self, "clone", SWIG_ErrorType(SWIG_ArgError(res)), "in output value of type '""Wx::Validator *""'");
+              }
+              return reinterpret_cast< wxValidator * >(ptr);
+            }
+
+            void wxRubyValidator::SetWindow(wxWindow *win)
+            {
+              this->wxValidator::SetWindow(win);
+              VALUE self = this->get_self();
+              // make sure Ruby does not own this validator instance anymore
+              RDATA(self)->dfree = SWIG_RubyRemoveTracking;
+            } 
+
+            bool wxRubyValidator::TransferFromWindow() 
+            { 
+              return this->DoOnTransferFromWindow(this->DoTransferFromWindow());
+            }
+            bool wxRubyValidator::TransferToWindow() 
+            { 
+              return this->DoTransferToWindow(this->DoOnTransferToWindow());
+            }
+  
+            VALUE wxRubyValidator::DoTransferFromWindow()
+            {
+              bool ex_caught = false;
+              VALUE rc = wxRuby_Funcall(ex_caught, this->get_self(), do_transfer_from_window_id(), 0);
+              if (ex_caught)
+              {
+                throw Swig::DirectorRubyException(rc, this->get_self(), do_transfer_from_window_id());
+              }
+              return rc; 
+            } 
+            bool wxRubyValidator::DoTransferToWindow(VALUE data)
+            {
+              bool ex_caught = false;
+              VALUE rc = wxRuby_Funcall(ex_caught, this->get_self(), do_transfer_to_window_id(), 1, data);
+              if (ex_caught)
+              {
+                throw Swig::DirectorRubyException(rc, this->get_self(), do_transfer_to_window_id());
+              }
+              return (rc == Qtrue); 
+            } 
+
+            VALUE wxRubyValidator::get_self()
+            {
+              if (NIL_P(this->self_))
+              {
+                this->self_ = SWIG_RubyInstanceFor(this);
+              }
+              return this->self_;
+            }
+
+            WxRuby_ID wxRubyValidatorBinding::do_on_transfer_from_window_id("do_on_transfer_from_window");
+            WxRuby_ID wxRubyValidatorBinding::do_on_transfer_to_window_id("do_on_transfer_to_window");
+            WxRuby_ID wxRubyValidatorBinding::call_id("call");
+
+            bool wxRubyValidatorBinding::DoOnTransferFromWindow(VALUE data)
+            {
+              bool ex_caught = false;
+              VALUE rc = wxRuby_Funcall(ex_caught, this->get_self(), do_on_transfer_from_window_id(), 1, data);
+              if (ex_caught)
+              {
+                throw Swig::DirectorRubyException(rc, this->get_self(), do_on_transfer_from_window_id());
+              }
+              return (rc == Qtrue); 
+            } 
+            VALUE wxRubyValidatorBinding::DoOnTransferToWindow()
+            {
+              bool ex_caught = false;
+              VALUE rc = wxRuby_Funcall(ex_caught, this->get_self(), do_on_transfer_to_window_id(), 0);
+              if (ex_caught)
+              {
+                throw Swig::DirectorRubyException(rc, this->get_self(), do_on_transfer_to_window_id());
+              }
+              return rc; 
+            } 
+
+            bool wxRubyValidatorBinding::OnTransferFromWindow(VALUE data)
+            {
+              if (!NIL_P(this->on_transfer_from_win_proc_))
+              {
+                bool ex_caught = false;
+                VALUE rc = wxRuby_Funcall(ex_caught, this->on_transfer_from_win_proc_, call_id(), 1, data);
+                if (ex_caught)
+                {
+                  throw Swig::DirectorRubyException(rc, this->on_transfer_from_win_proc_, call_id());
+                }
+              }
+              return true; 
+            } 
+            VALUE wxRubyValidatorBinding::OnTransferToWindow()
+            {
+              if (!NIL_P(this->on_transfer_to_win_proc_))
+              {
+                bool ex_caught = false;
+                VALUE rc = wxRuby_Funcall(ex_caught, this->on_transfer_to_win_proc_, call_id(), 0);
+                if (ex_caught)
+                {
+                  throw Swig::DirectorRubyException(rc, this->on_transfer_to_win_proc_, call_id());
+                }
+                return rc;
+              }
+              return Qnil; 
+            } 
+
+            void wxRubyValidatorBinding::CopyBindings(const wxRubyValidatorBinding* val_bind)
+            {
+              if (val_bind)
+              {
+                this->on_transfer_from_win_proc_ = val_bind->on_transfer_from_win_proc_;
+                this->on_transfer_to_win_proc_ = val_bind->on_transfer_to_win_proc_;
+              }
+            }
+  
+            static void GC_mark_wxValidator(void* ptr)
+            {
+              if (ptr)
+              {
+                wxValidator* vp = reinterpret_cast<wxValidator*> (ptr);
+                wxRubyValidator* rbvp = dynamic_cast<wxRubyValidator*> (vp);
+                // This might be a pointer to the global constant wxDefaultValidator or one of it's clones 
+                // which are not wxRubyValidator-s 
+                if (rbvp) rbvp->GC_Mark();
+              }
+            } 
+            __HEREDOC
+          spec.add_swig_code '%markfunc wxValidator "GC_mark_wxValidator";'
+          # will be provided as a pure Ruby method
+          spec.ignore 'wxValidator::Clone', ignore_doc: false
+          # add wxRuby specifics
+          spec.extend_interface 'wxValidator',
+                                'wxValidator(const wxValidator& other)'
+          spec.add_extend_code 'wxValidator', <<~__HEREDOC
+            void OnTransferFromWindow(VALUE proc)
+            {
+              dynamic_cast<wxRubyValidatorBinding *>($self)->SetOnTransferFromWindow(proc);
+            } 
+            void OnTransferToWindow(VALUE proc)
+            {
+              dynamic_cast<wxRubyValidatorBinding *>($self)->SetOnTransferToWindow(proc);
+            }
+            bool DoOnTransferFromWindow(VALUE data)
+            {
+              return dynamic_cast<wxRubyValidatorBinding *>($self)->OnTransferFromWindow(data);
+            }
+            VALUE DoOnTransferToWindow()
+            {
+              return dynamic_cast<wxRubyValidatorBinding *>($self)->OnTransferToWindow();
+            }
+            __HEREDOC
+          # not provided in Ruby
+          spec.ignore %w[wxValidator::TransferFromWindow wxValidator::TransferToWindow wxValidator::SetWindow]
+        else
+          spec.add_header_code <<~__HEREDOC
+            #include "wxruby-ValidatorBinding.h"
+            __HEREDOC
+        end
+        # overrule common typemap for parent arg of Validate
+        spec.map 'wxWindow* parent' do
+          map_check code: ''
+        end
       end
     end # class Validator
 

data/rakelib/lib/director/variant.rb

@@ -227,7 +227,7 @@ module WXRuby3
             $1 = rb_obj_is_kind_of($input, rb_const_get(mWxPG, var_ColourPropertyValue_id()));
           __CODE
         end
-        if Config.instance.features_set?('wxUSE_LONGLONG')
+        if Config.instance.features_set?('USE_LONGLONG')
           # wxLongLong mapping to be considered before considering 'long' (see typecheck precedence)
           spec.map 'wxLongLong' => 'Integer' do
             map_in code: <<~__CODE

data/rakelib/lib/director/window.rb

@@ -66,9 +66,6 @@ module WXRuby3
             __CODE
           end
           spec.ignore [
-            'wxWindow::TransferDataFromWindow',
-            'wxWindow::TransferDataToWindow',
-            'wxWindow::GetAccessible',
             'wxWindow::PopEventHandler',
             'wxWindow::SetConstraints',
             'wxWindow::GetHandle',
@@ -82,6 +79,9 @@ module WXRuby3
             'wxWindow::SendIdleEvents',
             'wxWindow::ClientToScreen(int*,int*)', # no need; prefer the wxPoint version
             'wxWindow::ScreenToClient(int*,int*)', # no need; prefer the wxPoint version
+            # provide (non-virtual) renamed alternatives (prevent Ruby keyword/standard clash)
+            'wxWindow::Raise',
+            'wxWindow::Lower'
           ]
           # no real docs and can't find actual examples of usage; ignore
           spec.ignore 'wxWindow::GetConstraints', 'wxWindow::SetConstraints'
@@ -92,6 +92,15 @@ module WXRuby3
             map_check code: ''
           end
           spec.add_extend_code 'wxWindow', <<~__HEREDOC
+            void raise_window()
+            {
+              $self->Raise();
+            }  
+            void lower_window()
+            {
+              $self->Lower();
+            }  
+
             static wxWindow* find_window_by_id(long id, const wxWindow *find_from_parent=0)
             {
               return wxWindow::FindWindowById(id, find_from_parent);
@@ -110,10 +119,15 @@ module WXRuby3
             spec.ignore 'wxWindow::EnableTouchEvents'
           end
           if Config.instance.wx_version >= '3.3.0'
-            spec.ignore('wxWindow::MSWDisableComposited') unless Config.instance.features_set?('__WXMSW__')
+            spec.ignore_unless('WXMSW', 'wxWindow::MSWDisableComposited')
+          end
+          if Config.instance.features_set?('USE_ACCESSIBILITY')
+            spec.disown 'wxAccessible *accessible'
+          else
+            spec.ignore('wxWindow::SetAccessible',
+                        'wxWindow::GetAccessible')
           end
-          spec.ignore('wxWindow::SetAccessible') unless Config.instance.features_set?('wxUSE_ACCESSIBILITY')
-          spec.ignore(%w[wxWindow::RegisterHotKey wxWindow::UnregisterHotKey]) unless Config.instance.features_set?('wxUSE_HOTKEY')
+          spec.ignore_unless('USE_HOTKEY', %w[wxWindow::RegisterHotKey wxWindow::UnregisterHotKey])
           spec.ignore('wxWindow::SetSize(int, int)') # not useful as the wxSize variant will also accept an array
           spec.swig_import %w{
             swig/classes/include/wxObject.h
@@ -189,7 +203,22 @@ module WXRuby3
           
               return do_paint_buffered(self);
             }
-          __HEREDOC
+
+            VALUE each_child() 
+            {
+              const wxWindowList& child_list = self->GetChildren();
+              VALUE rc = Qnil;
+              wxWindowList::compatibility_iterator node = child_list.GetFirst();
+              while (node)
+              {
+                wxObject *child = node->GetData();
+                VALUE rb_child = wxRuby_WrapWxObjectInRuby(child);
+                rc = rb_yield(rb_child);
+                node = node->GetNext();
+              }
+              return rc;
+            }
+            __HEREDOC
           spec.override_events 'wxWindow', 'EVT_ACTIVATE' => ['EVT_ACTIVATE', 0, 'wxActivateEvent']
         when 'wxNonOwnedWindow'
           spec.no_proxy('wxNonOwnedWindow')
@@ -250,9 +279,13 @@ module WXRuby3
                           "#{spec.class_name(citem)}::SetAcceleratorTable",
                           "#{spec.class_name(citem)}::SetBackgroundColour",
                           "#{spec.class_name(citem)}::SetBackgroundStyle",
+                          "#{spec.class_name(citem)}::HasTransparentBackground",
                           "#{spec.class_name(citem)}::SetCursor",
                           "#{spec.class_name(citem)}::SetFocus",
                           "#{spec.class_name(citem)}::SetFocusFromKbd",
+                          "#{spec.class_name(citem)}::AcceptsFocus",
+                          "#{spec.class_name(citem)}::AcceptsFocusRecursively",
+                          "#{spec.class_name(citem)}::AcceptsFocusFromKeyboard",
                           "#{spec.class_name(citem)}::SetFont",
                           "#{spec.class_name(citem)}::SetForegroundColour",
                           "#{spec.class_name(citem)}::SetHelpText",

data/rakelib/lib/director.rb

@@ -94,7 +94,7 @@ module WXRuby3
 
       def each_package(&block)
         packages.each_value do |pkg|
-          pkg.each_package(&block) if Config.instance.features_set?(*pkg.required_features)
+          pkg.each_package(&block) if Package.full_docs? || Config.instance.features_set?(*pkg.required_features)
         end
       end
 
@@ -269,7 +269,7 @@ module WXRuby3
     end
 
     def handle_item_ignore(defmod, fullname, ignore, ignoredoc)
-      action = ignore ? 'ignore' : 'regard'
+      action = (ignore==false) ? 'regard' : 'ignore'
       # find the item
       item = defmod.find_item(fullname)
       if item
@@ -361,8 +361,8 @@ module WXRuby3
       # extract the module definitions
       defmod = Extractor.extract_module(spec.package, spec.module_name, spec.name, spec.items, gendoc: gendoc)
       # handle ignores
-      spec.ignores.each_pair do |fullname, ignoredoc|
-        handle_item_ignore(defmod, fullname, true, ignoredoc)
+      spec.ignores.each_pair do |fullname, ignore_spec|
+        handle_item_ignore(defmod, fullname, ignore_spec[:ignore], ignore_spec[:ignore_doc])
       end
       # handle regards
       spec.regards.each_pair do |fullname, regarddoc|

data/rakelib/lib/extractor/function.rb

@@ -75,14 +75,14 @@ module WXRuby3
         "self.#{rb_method_name(rb_name || name)}"
       end
 
-      def rb_doc(xml_trans, type_maps)
-        ovls = all.select {|m| !m.docs_ignored && !m.deprecated }
-        ovl_docs = ovls.collect { |mo| mo.rb_doc_decl(xml_trans, type_maps) }
-        ovl_docs.inject({}) do |docs, (name, params, doc)|
+      def rb_doc(xml_trans, type_maps, fulldocs=false)
+        ovls = all.select {|m| !m.docs_ignored(fulldocs) && !m.deprecated }
+        ovl_docs = ovls.collect { |mo| [mo]+mo.rb_doc_decl(xml_trans, type_maps) }
+        ovl_docs.inject({}) do |docs, (movl, name, params, doc)|
           if docs.has_key?(name)
-            docs[name] << [params, doc]
+            docs[name] << [movl, params, doc]
           else
-            docs[name] = [[params, doc]]
+            docs[name] = [[movl, params, doc]]
           end
           docs
         end
@@ -95,8 +95,9 @@ module WXRuby3
         params_doc.unlink if params_doc
         # get brief doc
         doc = xml_trans.to_doc(@brief_doc, item: self)
+        doc << "\n" if @detailed_doc # force empty line (paragraph break) between summary and detail
         # add detailed doc text without params doc
-        doc << xml_trans.to_doc(@detailed_doc, item: self, desc: :detail)
+        doc << xml_trans.to_doc(@detailed_doc, item: self, desc: :detail) if @detailed_doc
         # get mapped ruby parameter list
         params = []
         mapped_ret_args = nil

data/rakelib/lib/extractor.rb

@@ -182,7 +182,7 @@ module WXRuby3
         extract(element) if element
       end
 
-      attr_accessor :name, :rb_name, :ignored, :docs_ignored, :brief_doc, :detailed_doc, :deprecated, :only_for, :items
+      attr_accessor :name, :rb_name, :brief_doc, :detailed_doc, :deprecated, :only_for, :items
 
       def extra_attributes
         @extra_attributes ||= {}
@@ -221,8 +221,10 @@ module WXRuby3
           @detailed_doc = element.xpath('detaileddescription')
           if (el = @detailed_doc.at_xpath('para/onlyfor'))
             @only_for = el.text.strip.split(',').collect { |s| s.downcase }
-            @ignored = @only_for.none? { |s| Config.instance.wx_port == s.to_sym }
-            @docs_ignored = @ignored
+            unless @only_for.empty?
+              @ignored = [Config::AnyOf.new(*@only_for.collect { |s| s.upcase })] # transform to feature ids like 'WXGTK'
+              @docs_ignored = @ignored
+            end
           end
         end
       end
@@ -256,12 +258,39 @@ module WXRuby3
         end
       end
 
+      def get_ignore_val(val)
+        if val.is_a?(::Array)
+          val
+        elsif val.is_a?(Config::AnyOf) || val.is_a?(::String)
+          [val]
+        else
+          !!val
+        end
+      end
+      private :get_ignore_val
+
       def ignore(val = true, ignore_doc: nil)
-        @ignored = !!val
-        @docs_ignored = ignore_doc.nil? ? @ignored : ignore_doc
+        @ignored = get_ignore_val(val)
+        @docs_ignored = if ignore_doc.nil?
+                          @ignored
+                        else
+                          get_ignore_val(ignore_doc)
+                        end
         self
       end
 
+      def ignored
+        @ignored == true || (@ignored.is_a?(::Array) && !Config.instance.features_set?(*@ignored))
+      end
+
+      def docs_ignored(fulldocs)
+        @docs_ignored == true || (!fulldocs && @docs_ignored.is_a?(::Array) && !Config.instance.features_set?(*@docs_ignored))
+      end
+
+      def required_features_doc
+        @docs_ignored.is_a?(::Array) ? @docs_ignored : nil
+      end
+
       def find(name)
         # Locate and return an item within this item that has a matching name.
         # The name string can use a dotted notation to continue the search

data/rakelib/lib/generate/analyzer.rb

@@ -87,7 +87,7 @@ module WXRuby3
       attr_reader :director, :classdef, :class_spec_name, :class_registry
 
       def item_ignored?(item)
-        @doc_gen ? item.docs_ignored : item.ignored
+        @doc_gen ? item.docs_ignored(Director::Package.full_docs?) : item.ignored
       end
       private :item_ignored?
 
@@ -366,7 +366,7 @@ module WXRuby3
         type_list = [type]
         type_list << "#{enum_scope}::#{type.split('::').pop}" unless enum_scope.empty?
         rb_enum_name = if !enum_scope.empty?
-                         "#{enum_scope}::#{rb_wx_name(type.split('::').pop)}"
+                         "#{rb_wx_name(enum_scope)}::#{rb_wx_name(type.split('::').pop)}"
                        else
                          rb_wx_name(type)
                        end
@@ -482,12 +482,17 @@ module WXRuby3
         end
       end
 
+      def item_ignored(item, doc_gen)
+        doc_gen ? item.docs_ignored(Director::Package.full_docs?) : item.ignored
+      end
+      private :item_ignored
+
       def preprocess(enum_maps, doc_gen = false)
         STDERR.puts "** Preprocessing #{module_name}" if Director.trace?
         def_items.each do |item|
           case item
           when Extractor::ClassDef
-            if !(doc_gen ? item.docs_ignored : item.ignored) &&
+            if !item_ignored(item, doc_gen) &&
                   (!item.is_template? || template_as_class?(item.name)) &&
                   !is_folded_base?(item.name)
               clsproc = ClassProcessor.new(director, item, doc_gen)
@@ -536,7 +541,7 @@ module WXRuby3
           errors = []
           warnings = []
           def_items.each do |item|
-            if Extractor::ClassDef === item && !(doc_gen ? item.docs_ignored : item.ignored) &&
+            if Extractor::ClassDef === item && !item_ignored(item, doc_gen) &&
               (!item.is_template? || template_as_class?(item.name)) &&
               !is_folded_base?(item.name)
               intf_class_name = if item.is_template? || template_as_class?(item.name)

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

@@ -47,8 +47,6 @@
           
             but take care to not cause undesirable re-entrance when doing it (see {Wx::App#yield} for more details). The simplest way to do it is to use {Wx::WindowDisabler} class as illustrated in the above example.
             Note that a {Wx::BusyInfo} is always built with the {Wx::STAY_ON_TOP} window style (see {Wx::Frame} window styles for more info).
-            
-            ===
           
             Category:  Common Dialogs
           

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

@@ -37,7 +37,5 @@
             clipboard managers will automatically flush the clipboard after each new piece of data is added, while others 
             will not. The {Wx::Clipboard#flush} function will force the clipboard manager to flush the data.
             
-            === 
-            
             Category:  Clipboard and Drag & Drop
             @see  Wx::DataObject 

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

@@ -13,8 +13,6 @@
             the cursor for a window, as in X, rather than to set it globally as in MS Windows, although a global 
             {set_cursor} function is also available for MS Windows use.
             
-            === 
-            
             Category:  Graphics Device Interface (GDI)
             Predefined objects/pointers:
             - {Wx::NULL_CURSOR}

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

@@ -0,0 +1,7 @@
+---
+:wxPanel:
+  :detail:
+    :pre:
+      :simplesect:
+        - :pattern: !ruby/regexp /Tab\s+traversal\s+is\s+implemented.*/
+          :replace: ''