wxruby3 0.9.0.pre.beta.14 → 0.9.0.pre.rc.2

data/rakelib/lib/generate/doc.rb

@@ -4,6 +4,7 @@
 ###
 
 require 'set'
+require 'yaml'
 
 require_relative './base'
 require_relative './analyzer'
@@ -152,6 +153,7 @@ module WXRuby3
         text.gsub!('@remarks', '')
         text.gsub!(/@see.*\n/, '')
         text.gsub!('@ref', '')
+        text.gsub!(/(\W|\A)nullptr(\W|\Z)/, '\1nil\2')
         unless no_ref?
           # auto create references for any ids explicitly declared such
           text.gsub!(/\W?(wx\w+(::\w+)?(\(.*\))?)/) do |s|
@@ -167,6 +169,7 @@ module WXRuby3
               end
             end
           end
+          text.gsub!(/WX(K_[A-Z]+)/) { "{Wx::#{$1}}"}
         end
         if event_section?
           case text
@@ -214,7 +217,7 @@ module WXRuby3
 
       def programlisting_to_doc(node)
         no_idents do
-          "\n\n  #{node_to_doc(node).split("\n").join("\n  ")}\n"
+          "\n```\n  #{node_to_doc(node).split("\n").join("\n  ")}\n```\n"
         end
       end
 
@@ -405,7 +408,8 @@ module WXRuby3
 
       def node_to_doc(xmlnode)
         xmlnode.children.inject('') do |docstr, node|
-          docstr << self.__send__("#{node.name}_to_doc", node)
+          node = preprocess_node(node)
+          docstr << (node.is_a?(Nokogiri::XML::Node) ? self.__send__("#{node.name}_to_doc", node) : node.to_s)
         end
       end
 
@@ -421,9 +425,9 @@ module WXRuby3
         para = node_to_doc(node)
         # loose specific notes paragraphs
         case para
-        when /\A(\<b\>)?wxPerl Note:/,  # wxPerl note
-             /\A\s*Library:/,           # Library note
-             /\A\s*Include\s+file:/     # Include file note
+        when /\A(\<(b)\>)?(wxPerl|\{Wx::Perl\}) Note:/, # wxPerl note
+             /\A\s*Library:/,                 # Library note
+             /\A\s*Include\s+file:/           # Include file note
           ''
         else
           para.sub!(/Include\s+file:\s+\#include\s+\<[^>]+\>\s*\Z/, '')
@@ -475,6 +479,24 @@ module WXRuby3
         end
       end
 
+      def preprocess_node(node)
+        if @item_doc_ovr[:pre] && @item_doc_ovr[:pre][node.name.to_sym]
+          @item_doc_ovr[:pre][node.name.to_sym].each do |ovr|
+            if ovr[:replace]
+              return ovr[:replace] if ovr[:pattern] =~ node.inner_html
+            elsif ovr[:subst]
+              if ovr[:global]
+                node.inner_html = node.inner_html.gsub(ovr[:pattern], ovr[:subst])
+              else
+                node.inner_html = node.inner_html.sub(ovr[:pattern], ovr[:subst])
+              end
+            end
+          end
+        end
+        node
+      end
+      private :preprocess_node
+
       def method_missing(mtd, *args, &block)
         if /\A\w+_to_doc\Z/ =~ mtd.to_s && args.size==1
           node_to_doc(*args)
@@ -487,6 +509,15 @@ module WXRuby3
 
       def initialize(director)
         @director = director
+        @doc_overrides = if File.exist?(doc_override_file =  File.join(__dir__, 'doc', underscore(name)+ '.yaml'))
+                           if ::Psych::VERSION >= '3.1.0'
+                            ::Psych.safe_load(File.read(doc_override_file), permitted_classes: [::Regexp, ::Symbol])
+                           else
+                             ::Psych.safe_load(File.read(doc_override_file), [::Regexp, ::Symbol])
+                           end
+                         else
+                           {}
+                         end
         @classdef = nil
         @see_list = []
       end
@@ -503,15 +534,44 @@ module WXRuby3
         end
       end
 
-      def to_doc(xmlnode_or_set)
+      def to_doc(xmlnode_or_set, item: nil, desc: :brief)
         return '' unless xmlnode_or_set
         @see_list.clear
+        @item_doc_ovr = if item
+                          item_key = if item.is_a?(Extractor::BaseDef)
+                                       if item.is_a?(Extractor::ClassDef) || @classdef.nil?
+                                         item.name
+                                       else
+                                         "#{@classdef.name}.#{item.name}"
+                                       end
+                                     else
+                                       @classdef ? "#{@classdef.name}.#{item}" : item.to_s
+                                     end
+                          item_key = item_key.to_sym
+                          @doc_overrides[item_key] ? @doc_overrides[item_key][desc] || {} : {}
+                        else
+                          {}
+                        end
         doc = if Nokogiri::XML::NodeSet === xmlnode_or_set
-                xmlnode_or_set.inject('') { |s, n| s << node_to_doc(n) }
+                xmlnode_or_set.inject('') do |s, n|
+                  n = preprocess_node(n)
+                  s << (n.is_a?(Nokogiri::XML::Node) ? node_to_doc(n) : n.to_s)
+                end
               else
-                node_to_doc(xmlnode_or_set)
+                xmlnode_or_set = preprocess_node(xmlnode_or_set)
+                xmlnode_or_set.is_a?(Nokogiri::XML::Node) ? node_to_doc(xmlnode_or_set) : xmlnode_or_set.to_s
               end
         event_section(false)
+        if @item_doc_ovr.has_key?(:post)
+          @item_doc_ovr[:post].each do |ovr|
+            if ovr[:global]
+              doc.gsub!(ovr[:pattern], ovr[:subst])
+            else
+              doc.sub!(ovr[:pattern], ovr[:subst])
+            end
+          end
+        end
+        doc.sub!(/\<b\>\{Wx::Perl.*/, '')
         doc.strip!
         # reduce triple(or more) newlines to max 2
         doc << "\n" # always end with a NL without following whitespace
@@ -562,7 +622,7 @@ module WXRuby3
     protected
 
     def get_constant_doc(const)
-      @xml_trans.to_doc(const.brief_doc)
+      @xml_trans.to_doc(const.brief_doc, item: const)
     end
 
     def gen_constant_value(val)
@@ -589,9 +649,9 @@ module WXRuby3
     end
 
     def get_enum_doc(enumdef)
-      doc = @xml_trans.to_doc(enumdef.brief_doc)
+      doc = @xml_trans.to_doc(enumdef.brief_doc, item: enumdef)
       doc << "\n" if enumdef.detailed_doc
-      doc << @xml_trans.to_doc(enumdef.detailed_doc) if enumdef.detailed_doc
+      doc << @xml_trans.to_doc(enumdef.detailed_doc, item: enumdef, desc: :detail) if enumdef.detailed_doc
       doc
     end
 
@@ -681,8 +741,8 @@ module WXRuby3
     end
 
     def get_class_doc(cls)
-      doc = @xml_trans.to_doc(cls.brief_doc)
-      doc << @xml_trans.to_doc(cls.detailed_doc) if cls.detailed_doc
+      doc = @xml_trans.to_doc(cls.brief_doc, item: cls)
+      doc << @xml_trans.to_doc(cls.detailed_doc, item: cls, desc: :detail) if cls.detailed_doc
       doc
     end
 
@@ -792,6 +852,7 @@ module WXRuby3
               fdoc.doc.puts "\n@note  In wxRuby this is a mixin module instead of a (base) class."
               fdoc.puts "module #{clsnm}"
             else
+              fdoc.doc.puts "\n@note This class is <b>untracked</b> and should not be derived from nor instances extended!" unless is_tracked?(item)
               basecls = ifspec.classdef_name(base_class(item, doc: true))
               fdoc.puts "class #{clsnm} < #{basecls ? basecls.sub(/\Awx/, '') : '::Object'}"
             end
@@ -799,7 +860,7 @@ module WXRuby3
 
             # mixin includes
             if included_mixins.has_key?(item.name)
-              included_mixins[item.name].each { |mod| fdoc.iputs "include #{mod}" }
+              included_mixins[item.name].keys.each { |mod| fdoc.iputs "include #{mod}" }
               fdoc.puts
             end
 
@@ -820,6 +881,8 @@ module WXRuby3
                       const_name = rb_constant_name(e.name)
                       if xref_table.has_key?(const_name)
                         gen_constant_doc(fdoc, const_name, xref_table[const_name], get_constant_doc(e))
+                      elsif xref_table.has_key?(e.name)
+                        gen_constant_doc(fdoc, e.name, xref_table[e.name], get_constant_doc(e))
                       end
                     end
                   else

data/rakelib/lib/generate/interface.rb

@@ -86,6 +86,11 @@ module WXRuby3
                 Data_Get_Struct(obj, void, vptr);
                 wx_#{underscore(rb_name)}_convert_fn fn_cvt = it->second;
                 *ptr = (*fn_cvt)(vptr);
+                if (!ptr)
+                {
+                  rb_raise(rb_eArgError, 
+                           "#{rb_name} object already deleted.");
+                } 
                 return SWIG_OK;
               }
             }
@@ -94,18 +99,19 @@ module WXRuby3
       __HEREDOC
     end
 
-    def gen_mixin_convert_code(fout, cls, mod)
+    def gen_mixin_convert_code(fout, cls, mod, ctype)
       rb_mod_name = mod.split('::').last
+      ctype ||= "wx#{rb_mod_name}"
       decl_flag = (mod.start_with?(package.fullname) ? 'WXRB_EXPORT_FLAG' : 'WXRB_IMPORT_FLAG') # same package (dll) or import?
       fout.puts
       fout << <<~__HEREDOC
-          // Mixin converter for wx#{rb_mod_name} included in #{cls} 
-          typedef wx#{rb_mod_name}* (*wx_#{underscore(rb_mod_name)}_convert_fn)(void*); 
+          // Mixin converter for #{ctype} (#{mod}) included in #{cls} 
+          typedef #{ctype}* (*wx_#{underscore(rb_mod_name)}_convert_fn)(void*); 
           #{decl_flag} void wxRuby_Register_#{rb_mod_name}_Include(swig_class* cls_info, 
                                                                               wx_#{underscore(rb_mod_name)}_convert_fn converter);
-          static wx#{rb_mod_name}* wxRuby_ConvertTo_#{rb_mod_name}(void* ptr)
+          static #{ctype}* wxRuby_ConvertTo_#{rb_mod_name}(void* ptr)
           {
-            return ((wx#{rb_mod_name}*) static_cast<#{cls}*> (ptr));
+            return ((#{ctype}*) static_cast<#{cls}*> (ptr));
           }
       __HEREDOC
     end
@@ -142,7 +148,7 @@ module WXRuby3
           mixins.each { |name| gen_mixin_code(fout, name) }
         end
         unless included_mixins.empty?
-          included_mixins.each_pair {|cls, mods| mods.each { |mod| gen_mixin_convert_code(fout, cls, mod) } }
+          included_mixins.each_pair {|cls, mods| mods.each_pair { |mod, ctype| gen_mixin_convert_code(fout, cls, mod, ctype) } }
         end
         fout.puts "%}"
       end
@@ -202,10 +208,16 @@ module WXRuby3
         fout.puts
         fout.puts swig_code
       end
+      unless explicit_concretes.empty?
+        fout.puts
+        explicit_concretes.each do |cls|
+          fout.puts %Q{%feature("notabstract") #{cls};}
+        end
+      end
       unless included_mixins.empty?
         fout.puts
-        included_mixins.each_pair do |cls, module_names|
-          module_names.each { |m| fout.puts %Q{%mixin #{cls} "#{m}";} }
+        included_mixins.each_pair do |cls, modules|
+          modules.keys.each { |m| fout.puts %Q{%mixin #{cls} "#{m}";} }
         end
       end
     end
@@ -229,8 +241,8 @@ module WXRuby3
         end
         unless included_mixins.empty?
           fout.puts
-          included_mixins.each_pair do |cls, module_names|
-            module_names.each do |modname|
+          included_mixins.each_pair do |cls, modules|
+            modules.keys.each do |modname|
               m = modname.split('::').last
               fout.puts %Q{wxRuby_Register_#{m}_Include(&SwigClassWx#{rb_wx_name(cls)}, wxRuby_ConvertTo_#{m});}
             end

data/rakelib/lib/specs/interfaces.rb

@@ -16,21 +16,20 @@ module WXRuby3
     Director.Spec(pkg, 'wxEvent')
     Director.Spec(pkg, 'wxEvtHandler')
     Director.Spec(pkg, 'wxEvents')
+    Director.Spec(pkg, 'wxEventFilter')
     Director.Spec(pkg, 'wxApp')
     Director.Spec(pkg, 'wxDC')
     Director.Spec(pkg, 'wxWindowDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxClientDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxPaintDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxMemoryDC', director: Director::DerivedDC)
-    Director.Spec(pkg, 'wxBufferedDC', director: Director::DerivedDC)
-    Director.Spec(pkg, 'wxBufferedPaintDC', director: Director::DerivedDC)
-    Director.Spec(pkg, 'wxAutoBufferedPaintDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxMirrorDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxScreenDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxSVGFileDC', director: Director::DerivedDC, requirements: %w[wxUSE_SVG])
     Director.Spec(pkg, 'wxGCDC', director: Director::DerivedDC, requirements: %w[wxUSE_GRAPHICS_CONTEXT])
     Director.Spec(pkg, 'wxScaledDC', director: Director::DerivedDC)
     Director.Spec(pkg, 'wxWindow')
+    Director.Spec(pkg, 'wxEventBlocker')
     Director.Spec(pkg, 'wxNonOwnedWindow', director: Director::Window)
     Director.Spec(pkg, 'wxPopupWindow')
     Director.Spec(pkg, 'wxTopLevelWindow')
@@ -71,6 +70,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxToggleButton')
     Director.Spec(pkg, 'wxControlWithItems')
     Director.Spec(pkg, 'wxComboBox')
+    Director.Spec(pkg, 'wxBitmapComboBox')
     Director.Spec(pkg, 'wxRadioBox')
     Director.Spec(pkg, 'wxPanel')
     Director.Spec(pkg, 'wxWithImages')
@@ -81,6 +81,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxListBox')
     Director.Spec(pkg, 'wxChoice')
     Director.Spec(pkg, 'wxStaticBox')
+    Director.Spec(pkg, 'wxSearchCtrl')
     Director.Spec(pkg, 'wxCollapsiblePane', requirements: %w[wxUSE_COLLPANE])
     Director.Spec(pkg, 'wxCollapsiblePaneEvent', requirements: %w[wxUSE_COLLPANE])
     Director.Spec(pkg, 'wxStaticLine', director: Director::Window)
@@ -126,7 +127,6 @@ module WXRuby3
     Director.Spec(pkg, 'wxListbook', director: Director::BookCtrls, requirements: Director.AnyOf(%w[wxUSE_LISTBOOK]))
     Director.Spec(pkg, 'wxTreebook', director: Director::BookCtrls, requirements: Director.AnyOf(%w[wxUSE_TREEBOOK]))
     Director.Spec(pkg, 'wxSimplebook', director: Director::BookCtrls, requirements: Director.AnyOf(%w[wxUSE_AUI wxUSE_NOTEBOOK wxUSE_LISTBOOK wxUSE_CHOICEBOOK wxUSE_TOOLBOOK wxUSE_TREEBOOK]))
-    Director.Spec(pkg, 'wxColourData', requirements: %w[wxUSE_COLOURDLG])
     Director.Spec(pkg, 'wxColourDialog', director: Director::Dialog, requirements: %w[wxUSE_COLOURDLG])
     Director.Spec(pkg, 'wxColourPickerEvent', director: Director::Event, requirements: %w[wxUSE_COLOURPICKERCTRL wxUSE_COLOURDLG])
     Director.Spec(pkg, 'wxColourPickerCtrl', requirements: %w[wxUSE_COLOURPICKERCTRL wxUSE_COLOURDLG])
@@ -177,7 +177,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxDataObjectSimpleBase', requirements: %w[wxUSE_CLIPBOARD])
     Director.Spec(pkg, 'wxClipboard', requirements: %w[wxUSE_CLIPBOARD])
     Director.Spec(pkg, 'wxDragDrop', requirements: %w[wxUSE_DRAG_AND_DROP])
-    Director.Spec(pkg, 'wxContextHelpButton', director: Director::Button, requirements: %w[wxUSE_HELP])
+    Director.Spec(pkg, 'wxContextHelpButton', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxHelpProvider', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxHelpController', requirements: %w[wxUSE_HELP])
     Director.Spec(pkg, 'wxExtHelpController', director: Director::HelpController, requirements: %w[wxUSE_HELP])
@@ -199,6 +199,10 @@ module WXRuby3
     Director.Spec(pkg, 'wxVariant', requirements: %w[wxUSE_VARIANT])
     Director.Spec(pkg, 'wxPlatformInfo')
     Director.Spec(pkg, 'wxSplashScreen', requirements: %w[wxUSE_SPLASH])
+    Director.Spec(pkg, 'wxUIActionSimulator', requirements: %w[wxUSE_UIACTIONSIMULATOR])
+    Director.Spec(pkg, 'wxActivityIndicator', director: Director::Window, requirements: %w[wxUSE_ACTIVITYINDICATOR])
+    Director.Spec(pkg, 'wxHyperlinkCtrl', director: Director::Window, requirements: %w[wxUSE_HYPERLINKCTRL])
+    Director.Spec(pkg, 'wxHyperlinkEvent', requirements: %w[wxUSE_HYPERLINKCTRL])
   }
 
   Director.Package('Wx::PRT', 'wxUSE_PRINTING_ARCHITECTURE') do |pkg|

data/rakelib/lib/swig_runner.rb

@@ -211,7 +211,7 @@ module WXRuby3
           update_source do |line|
             case line
               # defined method names
-            when /(rb_define_method|rb_define_module_function|rb_define_protected_method).*("[_a-zA-Z0-9]*")/
+            when /(rb_define_method|rb_define_module_function|rb_define_protected_method).*("[_a-zA-Z0-9]*[=\?\!]?")/
               name = $2
               unless name == '"THE_APP"'
                 line[name] = '"%s"' % rb_method_name(name[1..-2])
@@ -222,7 +222,7 @@ module WXRuby3
               line['rb_funcall'] = 'wxRuby_Funcall'
               line[name] = '"%s"' % rb_method_name(name[1..-2])
               # defined alias methods (original method name)
-            when /rb_define_alias\s*\(.*"[_a-zA-Z0-9]+[=\?]?".*("[_a-zA-Z0-9]*")/
+            when /rb_define_alias\s*\(.*"[_a-zA-Z0-9]+[=\?]?".*("[_a-zA-Z0-9]*[=\?\!]?")/
               name = $1
               line[name] = '"%s"' % rb_method_name(name[1..-2])
               # defined class names
@@ -234,7 +234,7 @@ module WXRuby3
               name = $1
               line[name] = '"%s"' % rb_wx_name(name[1..-2])
               # defined class/global methods
-            when /rb_define_singleton_method.*("[_a-zA-Z0-9]*")/
+            when /rb_define_singleton_method.*("[_a-zA-Z0-9]*[=\?\!]?")/
               name = $1
               no_wx_name = name[1..-2].sub(/\Awx_?/i, '')
               if no_wx_name == no_wx_name.upcase

data/rakelib/lib/typemap/common.rb

@@ -528,6 +528,15 @@ module WXRuby3
               VALUE klass = rb_const_get(wxRuby_Core(), rb_intern(class_name));
               return rb_obj_is_kind_of(obj, klass);
             }
+            static swig_type_info * wx_BitmapBundleSwigType()
+            {
+              static swig_type_info* swigtype = 0;
+              if (!swigtype)
+              {
+                swigtype = wxRuby_GetSwigTypeForClassName("BitmapBundle");
+              } 
+              return swigtype;
+            }
             __CODE
           map_in from: 'Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image',
                  temp: 'wxBitmapBundle tmpBundle', code: <<~__CODE
@@ -565,6 +574,9 @@ module WXRuby3
               }
             }
             __CODE
+          map_out to: 'Wx::BitmapBundle', code: <<~__CODE
+              $result = SWIG_NewPointerObj((new wxBitmapBundle(*static_cast< const wxBitmapBundle* >($1))), wx_BitmapBundleSwigType(), SWIG_POINTER_OWN);
+          __CODE
           map_typecheck precedence: 2000, code: <<~__CODE
             $1 = (NIL_P($input) || 
                     (TYPE($input) == T_DATA && 
@@ -579,10 +591,10 @@ module WXRuby3
         # output typemaps for common reference counted objects like wxPen, wxBrush,
         # making sure to ALWAYS create managed copies
         # (wxColour and wxFont are handled in separate typemaps above)
-        %w[wxPen wxBrush wxBitmap wxIcon wxCursor wxIconBundle wxPalette wxFontData wxFindReplaceData].each do |klass|
-          map "const #{klass}&", "const #{klass}*" do
+        %w[Pen Brush Bitmap Icon Cursor IconBundle Palette FontData].each do |klass|
+          map "const wx#{klass}&", "const wx#{klass}*", as: "Wx::#{klass}" do
             map_out code: <<~__CODE
-              $result = SWIG_NewPointerObj((new #{klass}(*static_cast< const #{klass}* >($1))), SWIGTYPE_p_#{klass}, SWIG_POINTER_OWN);
+              $result = SWIG_NewPointerObj((new wx#{klass}(*static_cast< const wx#{klass}* >($1))), SWIGTYPE_p_wx#{klass}, SWIG_POINTER_OWN);
               __CODE
           end
         end

data/rakelib/lib/util/string.rb

@@ -74,6 +74,7 @@ module WXRuby3
 
       def rb_param_name(name)
         rbnm = name.dup
+        rbnm[0] = rbnm[0].downcase # make sure name conforms to Ruby naming rules
         rbnm << '_' if RBKW.include?(name)
         rbnm
       end

data/rakelib/yard/yard/relative_markdown_links.rb

@@ -20,7 +20,11 @@ module YARD # rubocop:disable Style/Documentation
     def resolve_links(text)
       html = Nokogiri::HTML.fragment(text)
       html.css("a[href]").each do |link|
-        href = URI(link["href"])
+        begin
+          href = URI(link["href"])
+        rescue
+          return super(text)
+        end
 
         if href.relative? && options.files
           fnames = options.files.map(&:filename)