wxruby3 1.5.4 → 1.6.1

data/rakelib/lib/extractor/function.rb

@@ -15,6 +15,20 @@ module WXRuby3
 
       include Util::StringUtil
 
+      class Block
+        def initialize(exclude_default=false)
+          @yield_param = []
+          @exclude_default = exclude_default
+        end
+
+        attr_reader :yield_param, :exclude_default
+
+        def yield(name, desc, type: nil)
+          @yield_param << {name: name, desc: desc, type: type}
+          self
+        end
+      end
+
       def initialize(element = nil, **kwargs)
         super()
         @type = nil
@@ -23,12 +37,13 @@ module WXRuby3
         @args_string = ''
         @is_overloaded = false
         @overloads = []
+        @block_arg = nil
 
         update_attributes(**kwargs)
         extract(element) if element
       end
 
-      attr_accessor :type, :definition, :template_params, :args_string, :is_overloaded, :overloads
+      attr_accessor :type, :definition, :template_params, :args_string, :is_overloaded, :overloads, :block_arg
 
       def is_template?
         !template_params.empty?
@@ -74,6 +89,10 @@ module WXRuby3
         items.inject(0) { |c, i| c += 1 if ParamDef === i && !i.default; c }
       end
 
+      def accept_block_arg(exclude_default=false)
+        @block_arg = Block.new(exclude_default)
+      end
+
       def rb_decl_name
         "self.#{rb_method_name(rb_name || name)}"
       end
@@ -81,11 +100,23 @@ module WXRuby3
       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] << [movl, params, doc]
-          else
-            docs[name] = [[movl, params, doc]]
+        ovl_docs.inject({}) do |docs, (movl, name, params, doc, retdoc)|
+          docs[name] = [] unless docs.has_key?(name)
+          # add regular method signature doc
+          docs[name] << [movl, params, doc+[retdoc]]
+          # is an optional block arg allowed for ALL methods or just this overload?
+          if @block_arg || movl.block_arg
+            # add an overload method signature doc with block arg and yield param
+            blk_arg = @block_arg || movl.block_arg
+            # skip in case default ctor/method (no args) is excluded from block args
+            unless params.empty? && blk_arg.exclude_default
+              type = is_ctor ? rb_return_type(type_maps, xml_trans) : nil
+              blk_arg.yield_param.each { |yp| doc << "@yieldparam [#{yp[:type] || type}] #{yp[:name]} #{yp[:desc].split("\n").join("\n  ")}" }
+              doc << retdoc
+              blkarg = params.empty? ? '' : ', '
+              blkarg << '&block'
+              docs[name] << [movl, params+blkarg, doc]
+            end
           end
           docs
         end
@@ -157,15 +188,15 @@ module WXRuby3
                  end
         result.concat(mapped_ret_args.collect { |mra| mra.type }) if mapped_ret_args
         result.compact! # remove nil values (possible ignored output)
-        case result.size
-        when 0
-          doclns << "@return [void]"
-        when 1
-          doclns << "@return [#{result.first}]"
-        else
-          doclns << "@return [Array(#{result.join(',')})]"
-        end
-        [rb_decl_name, paramlist, doclns]
+        retdoc = case result.size
+                 when 0
+                   "@return [void]"
+                 when 1
+                   "@return [#{result.first}]"
+                 else
+                   "@return [Array(#{result.join(',')})]"
+                 end
+        [rb_decl_name, paramlist, doclns, retdoc]
       end
 
       def rb_return_type(type_maps, xml_trans)

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

@@ -0,0 +1,22 @@
+---
+:wxGenericHyperlinkCtrl:
+  :brief:
+    :pre:
+      :briefdescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            This is the generic implementation of a class that shows a static text element which links to a URL.
+            For WXOSX this class is identical to wxHyperlinkCtrl.
+
+  :detail:
+    :pre:
+      :para:
+        - :pattern: !ruby/regexp /Currently\s+this\s+class\s+is\s+implemented.*other\s+ports./
+          :replace: ''
+:wxGenericHyperlinkCtrl.wxGenericHyperlinkCtrl:
+  :detail:
+    :pre:
+      :detaileddescription:
+        - :pattern: !ruby/regexp /See.*for\s+more\s+info\./
+          :replace: |
+            See {Wx::GenericHyperlinkCtrl#create} for more info.

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

@@ -1,4 +1,42 @@
 ---
+:wxScrolled:
+  :brief:
+    :pre:
+      :briefdescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            The Wx::ScrolledXXX classes manage scrolling for their client areas, transforming the coordinates according 
+            to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
+  :detail:
+    :pre:
+      :simplesect:
+        - :pattern: !ruby/regexp /if you want to use.*wxScrolled.*with a custom class/
+          :replace: ''
+    :post:
+      - :pattern: !ruby/regexp /commonly used \(but not the only possible!\) /
+        :subst: 'commonly used '
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxPanel>}, is equivalent to \{Wx::ScrolledWindow} from earlier versions. Derived/
+        :subst: ' derives'
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxWindow>},/
+        :subst: ''
+      - :pattern: !ruby/regexp /\{Wx::Scrolled<wxControl>}/
+        :subst: 'Wx::ScrolledControl'
+      - :pattern: !ruby/regexp / \(also note the absence of a \{Wx::ScrolledControl} typedef\)/
+        :subst: ''
+      - :pattern: !ruby/regexp /Starting from version 2.4 of wxWidgets, there are several ways to use a \{Wx::ScrolledWindow} \(and now \{Wx::Scrolled}\). In particular, there /
+        :subst: 'There '
+      - :pattern: !ruby/regexp /Wx::Scrolled#(\w+)/
+        :subst: '{Wx::ScrolledCanvas#\1}'
+        :global: true
+      - :pattern: !ruby/regexp /\{Wx::Scrolled}/
+        :subst: '{Wx::ScrolledCanvas}'
+        :global: true
+:wxScrolled.Create:
+  :detail:
+    :pre:
+      :detaileddescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''
 :wxScrolled.DoPrepareDC:
   :detail:
     :pre:

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

@@ -1,4 +1,42 @@
 ---
+:wxScrolled:
+  :brief:
+    :pre:
+      :briefdescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            The Wx::ScrolledXXX classes manage scrolling for their client areas, transforming the coordinates according 
+            to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
+  :detail:
+    :pre:
+      :simplesect:
+        - :pattern: !ruby/regexp /if you want to use.*wxScrolled.*with a custom class/
+          :replace: ''
+    :post:
+      - :pattern: !ruby/regexp /commonly used \(but not the only possible!\) /
+        :subst: 'commonly used '
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxPanel>}, is equivalent to \{Wx::ScrolledWindow} from earlier versions. Derived/
+        :subst: ' derives'
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxWindow>},/
+        :subst: ''
+      - :pattern: !ruby/regexp /\{Wx::Scrolled<wxControl>}/
+        :subst: 'Wx::ScrolledControl'
+      - :pattern: !ruby/regexp / \(also note the absence of a \{Wx::ScrolledControl} typedef\)/
+        :subst: ''
+      - :pattern: !ruby/regexp /Starting from version 2.4 of wxWidgets, there are several ways to use a \{Wx::ScrolledWindow} \(and now \{Wx::Scrolled}\). In particular, there /
+        :subst: 'There '
+      - :pattern: !ruby/regexp /Wx::Scrolled#(\w+)/
+        :subst: '{Wx::ScrolledControl#\1}'
+        :global: true
+      - :pattern: !ruby/regexp /\{Wx::Scrolled}/
+        :subst: '{Wx::ScrolledControl}'
+        :global: true
+:wxScrolled.Create:
+  :detail:
+    :pre:
+      :detaileddescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''
 :wxScrolled.DoPrepareDC:
   :detail:
     :pre:

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

@@ -1,4 +1,42 @@
 ---
+:wxScrolled:
+  :brief:
+    :pre:
+      :briefdescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: |
+            The Wx::ScrolledXXX classes manage scrolling for their client areas, transforming the coordinates according 
+            to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view.
+  :detail:
+    :pre:
+      :simplesect:
+        - :pattern: !ruby/regexp /if you want to use.*wxScrolled.*with a custom class/
+          :replace: ''
+    :post:
+      - :pattern: !ruby/regexp /commonly used \(but not the only possible!\) /
+        :subst: 'commonly used '
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxPanel>}, is equivalent to \{Wx::ScrolledWindow} from earlier versions. Derived/
+        :subst: ' derives'
+      - :pattern: !ruby/regexp /, aka \{Wx::Scrolled<wxWindow>},/
+        :subst: ''
+      - :pattern: !ruby/regexp /\{Wx::Scrolled<wxControl>}/
+        :subst: 'Wx::ScrolledControl'
+      - :pattern: !ruby/regexp / \(also note the absence of a \{Wx::ScrolledControl} typedef\)/
+        :subst: ''
+      - :pattern: !ruby/regexp /Starting from version 2.4 of wxWidgets, there are several ways to use a \{Wx::ScrolledWindow} \(and now \{Wx::Scrolled}\). In particular, there /
+        :subst: 'There '
+      - :pattern: !ruby/regexp /Wx::Scrolled#(\w+)/
+        :subst: '{Wx::ScrolledWindow#\1}'
+        :global: true
+      - :pattern: !ruby/regexp /\{Wx::Scrolled}/
+        :subst: '{Wx::ScrolledWindow}'
+        :global: true
+:wxScrolled.Create:
+  :detail:
+    :pre:
+      :detaileddescription:
+        - :pattern: !ruby/regexp /.*/
+          :replace: ''
 :wxScrolled.DoPrepareDC:
   :detail:
     :pre:

data/rakelib/lib/specs/interfaces.rb

@@ -139,7 +139,9 @@ module WXRuby3
     Director.Spec(pkg, 'wxScrolledWindow', director: Director::ScrolledT)
     Director.Spec(pkg, 'wxScrolledCanvas', director: Director::ScrolledT)
     Director.Spec(pkg, 'wxScrolledControl', director: Director::ScrolledT)
-    Director.Spec(pkg, 'wxVScrolledWindow')
+    Director.Spec(pkg, 'wxHScrolledWindow', director: Director::HVScrolled)
+    Director.Spec(pkg, 'wxVScrolledWindow', director: Director::HVScrolled)
+    Director.Spec(pkg, 'wxVScrolledCanvas', director: Director::HVScrolled)
     Director.Spec(pkg, 'wxVListBox')
     Director.Spec(pkg, 'wxFindReplaceData', requirements: %w[USE_FINDREPLDLG])
     Director.Spec(pkg, 'wxFindReplaceDialog', director: Director::Dialog, requirements: %w[USE_FINDREPLDLG])
@@ -272,7 +274,7 @@ module WXRuby3
     Director.Spec(pkg, 'wxHtmlEasyPrinting', requirements: %w[USE_PRINTING_ARCHITECTURE])
     Director.Spec(pkg, 'wxHtmlPrintout', requirements: %w[USE_PRINTING_ARCHITECTURE])
     Director.Spec(pkg, 'wxHtmlListBox')
-    Director.Spec(pkg, 'wxHTMLDataObject') if Config.instance.wx_version >= '3.3'
+    Director.Spec(pkg, 'wxHTMLDataObject') if Config.instance.wx_version_check('3.3') >= 0
   }
 
   Director.Package('Wx::RTC', 'USE_RICHTEXT', depends_on: ['Wx::HTML']) { |pkg|

data/rakelib/lib/swig_runner.rb

@@ -418,14 +418,14 @@ module WXRuby3
           # get the generated (class) items for which an alternate implementation has been registered
           class_list = def_items.select { |itm| Extractor::ClassDef === itm && itm.name != class_implementation(itm.name) }
           # create re match list for class names
-          cls_re_txt = class_list.collect { |clsdef| clsdef.name }.join('|')
+          cls_re_txt = class_list.collect { |clsdef| class_name(clsdef.name) }.join('|')
           # updating any matching alloc functions in generated SWIG sourcecode
           # create regexp for 'initialize' wrappers (due to overloads this could be more than one per class)
           new_re = /_wrap_new_(#{cls_re_txt})\w*\(.*\)/
           # check if any of the selected classes have a Director proxy enabled
           if proxies_enabled = class_list.any? { |clsdef| has_proxy?(clsdef) }
             # create re match list for classes with director proxy enabled
-            dir_cls_re_txt = class_list.select { |clsdef| has_proxy?(clsdef) }.collect { |cd| cd.name }.join('|')
+            dir_cls_re_txt = class_list.select { |clsdef| has_proxy?(clsdef) }.collect { |cd| class_name(cd.name) }.join('|')
             # create regexp for Director constructors (may not exist if no proxies are enabled)
             dir_ctor_re = /SwigDirector_\w+::SwigDirector_\w+\(.*\)\s*:\s*(#{dir_cls_re_txt})\(.*\)\s*,\s*Swig::Director.*{/
             # create regexp for method wrappers other than 'initialize' wrappers

data/rakelib/lib/typemap/print_page_range.rb

@@ -20,7 +20,7 @@ module WXRuby3
 
       define do
 
-        if Config.instance.wx_version >= '3.3.0'
+        if Config.instance.wx_version_check('3.3.0') >= 0
           map 'const std::vector<wxPrintPageRange> &' => 'Array<Wx::PRT::PrintPageRange>' do
             map_out code: <<~__CODE
                 $result = rb_ary_new();