wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/typemap/pgprop_arg.rb

@@ -0,0 +1,74 @@
+###
+# wxRuby3 PGPropArg typemap definitions
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    module PGPropArg
+
+      include Typemap::Module
+
+      # provide automagic conversion of simple types to PGPropArg arguments
+      define do
+
+        map 'const wxPGPropArgCls&' => 'String,Wx::PG::PGProperty' do
+          map_in temp: 'wxPGPropArgCls temp = (wxPGProperty *)0', code: <<~__CODE
+            if (!NIL_P($input))
+            {
+              if (TYPE($input) == T_STRING)
+              {
+                temp = wxPGPropArgCls(RSTR_TO_WXSTR($input));
+              }
+              else if (TYPE($input) == T_DATA)
+              {
+                VALUE rb_klass = rb_const_get(mWxPG, rb_intern("PGProperty"));
+                if (rb_obj_is_kind_of($input, rb_klass))
+                {
+                  swig_type_info* swig_type = wxRuby_GetSwigTypeForClass(rb_klass);
+                  wxPGProperty *pgprop = (wxPGProperty *)0;
+                  SWIG_ConvertPtr($input, SWIG_as_voidptrptr(&pgprop), swig_type, SWIG_POINTER_DISOWN);
+                  temp = wxPGPropArgCls(pgprop);
+                }
+                else
+                {
+                  VALUE msg = rb_inspect($input);
+                  rb_raise(rb_eArgError, "Expected Wx::PGProperty for $argnum but got %s",
+                                          StringValuePtr(msg));
+                }
+              }
+            }
+            $1 = &temp;
+            __CODE
+          map_directorin code: <<~__CODE
+            if ($1.HasName())
+            {
+              $input = WXSTR_TO_RSTR($1.GetName());
+            }
+            else
+            {
+              $input = wxRuby_WrapWxPGPropertyInRuby($1.GetPtr0());
+            }
+            __CODE
+          map_typecheck precedence: 1, code: <<~__CODE
+            VALUE rb_klass = rb_const_get(mWxPG, rb_intern("PGProperty"));
+            $1 = NIL_P($input) || (TYPE($input) == T_STRING) || (TYPE($input) == T_DATA && rb_obj_is_kind_of($input, rb_klass));
+            __CODE
+        end
+
+        # doc-only
+        map 'wxPGPropArg' => 'String,Wx::PG::PGProperty', swig: false do
+          map_in code: ''
+        end
+
+      end
+
+    end # PGPropArg
+
+  end # Typemap
+
+end # WXRuby3

data/rakelib/lib/typemap/pgproperty.rb

@@ -0,0 +1,35 @@
+###
+# wxRuby3 PGProperty typemap definition
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    # Typemaps for converting returned PGProperty references to
+    # either the correct wxRuby class
+    module PGProperty
+
+      include Typemap::Module
+
+      define do
+
+        map 'wxPGProperty*' => 'Wx::PG::PGProperty' do
+          add_header_code <<~__CODE
+            #include <wx/propgrid/property.h>
+            extern VALUE wxRuby_WrapWxPGPropertyInRuby(const wxPGProperty *wx_pp);
+            __CODE
+          map_out code: '$result = wxRuby_WrapWxPGPropertyInRuby($1);'
+          map_directorin code: '$input = wxRuby_WrapWxPGPropertyInRuby($1);'
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/rakelib/lib/typemap/points_list.rb

@@ -0,0 +1,124 @@
+###
+# wxRuby3 Common typemap definitions
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    # These typemaps create lists of wxPoints from ruby arrays. They are
+    # used by DC in methods like draw_lines, draw_polygon etc
+    module PointsList
+
+      include Typemap::Module
+
+      define do
+
+        map 'int n, wxPoint points[]' do
+
+          # Helper function to convert an array of Wx::Points or two-integer
+          # ruby arrays (as a terser representation of a Point) into a C++
+          # array. The C++ array should be already created with the correct
+          # length
+          add_header_code <<~__CODE
+            static void wxRuby_PointArrayRubyToC(VALUE rb_arr, wxPoint wx_arr[]) 
+            {
+              wxPoint *wx_point;
+              VALUE rb_item;
+              for (int i = 0; i < RARRAY_LEN(rb_arr); i++)
+              {
+                rb_item = rb_ary_entry (rb_arr, i);
+                if (TYPE(rb_item) == T_DATA)
+                {
+                    SWIG_ConvertPtr (rb_item, (void **) &wx_point,
+                                     SWIGTYPE_p_wxPoint, 1);
+                }
+                else if (TYPE(rb_item) == T_ARRAY && RARRAY_LEN(rb_item) == 2)
+                {
+                  wx_point = new wxPoint (NUM2INT( rb_ary_entry(rb_item, 0)),
+                    NUM2INT(rb_ary_entry (rb_item, 1)));
+                  // Create a ruby object so the C++ obj is freed when GC runs
+                  SWIG_NewPointerObj (wx_point, SWIGTYPE_p_wxPoint, 1);
+                }
+                else
+                {
+                  rb_raise(rb_eTypeError, "Wrong type for wxPoint parameter %i", i);
+                }
+                wx_arr[i] = *wx_point;
+              }
+            }
+            __CODE
+
+          # Set of typemaps for draw_lines, draw_polygon etc
+          map_in from: {type: 'Array<Wx::Point>,Array<Array<Integer>>', index: 1},
+                 temp: 'std::unique_ptr<wxPoint[]> arr', code: <<~__CODE
+            if ( ($input == Qnil) || (TYPE($input) != T_ARRAY) )
+            {
+              $1 = 0;
+              $2 = NULL;
+            }
+            else
+            {
+              $1 = RARRAY_LEN($input);
+              arr = std::make_unique<wxPoint[]>(RARRAY_LEN($input));
+              wxRuby_PointArrayRubyToC($input, arr.get());
+              $2 = arr.get();
+            }
+           __CODE
+
+         map_default code: '$1 = 0; $2 = NULL;'
+
+         map_typecheck code: '$1 = (TYPE($input) == T_ARRAY);'
+
+        end
+
+        map_apply 'int n, wxPoint points[]' => [ 'int n, wxPoint* points', 'int nItems, wxPoint *points' ]
+
+        # For draw_poly_polygon only
+        map 'int n, const int count[], const wxPoint points[]' do
+
+          map_in from: {type: 'Array<Array<Wx::Point>>,Array<Array<Array<Integer>>>', index: 2},
+                 temp: 'std::unique_ptr<int[]> count_arr, std::unique_ptr<wxPoint[]> point_arr', code: <<~__CODE
+            if ( ($input == Qnil) || (TYPE($input) != T_ARRAY) )
+            {
+              $1 = 0;
+              $2 = NULL;
+              $3 = NULL;
+            }
+            else
+            {
+              // total number of polygons
+              $1 = RARRAY_LEN($input);
+              count_arr = std::make_unique<int[]>($1);
+              // number of points in each polygon
+              for ( int i = 0; i < RARRAY_LEN($input); i++ )
+                count_arr[i] = RARRAY_LEN( rb_ary_entry($input, i) );
+              $2 = count_arr.get();
+              // array of all the points
+              VALUE all_points = rb_funcall($input, rb_intern("flatten"), 0);
+              point_arr = std::make_unique<wxPoint[]>(RARRAY_LEN(all_points));
+              wxRuby_PointArrayRubyToC(all_points, point_arr.get());
+              $3 = point_arr.get();
+            }
+            __CODE
+
+          map_default code: <<~__CODE
+            $1 = 0;
+            $2 = NULL;
+            $3 = NULL;
+            __CODE
+
+          map_typecheck code: '$1 = (TYPE($input) == T_ARRAY);'
+
+        end
+
+      end # define
+
+    end # PointsList
+
+  end # Typemap
+
+end # WXRuby3

data/rakelib/lib/typemap/richtext.rb

@@ -0,0 +1,67 @@
+###
+# wxRuby3 Common typemap definitions
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    # Shared features used by the RichText classes
+    module RichText
+
+      include Typemap::Module
+
+      def self.on_include(including_mod)
+        # Used by several classes to load and save rich text content to files
+        # and streams.
+        including_mod.include(Typemap::IOStreams)
+      end
+
+      define do
+
+        # The wxWidgets RichText API in several places represents and returns
+        # ranges of text selections with a special class. It doesn't add
+        # anything much that Ruby's own range class doesn't, so deal with using
+        # typemaps
+        map 'wxRichTextRange&' => 'Range' do
+
+          map_in code: <<~__CODE
+            int start = NUM2INT( rb_funcall( $input, rb_intern("begin"), 0));
+            int end   = NUM2INT( rb_funcall( $input, rb_intern("end"), 0));
+            wxRichTextRange rng = wxRichTextRange(start, end);
+            $1 = &rng;
+            __CODE
+
+          map_typecheck precedence: 1, code: '$1 = ( CLASS_OF($input) == rb_cRange );'
+
+          map_out code: '$result = rb_range_new (LONG2NUM($1->GetStart()),LONG2NUM($1->GetEnd()),0);'
+
+          map_directorin code: '$input = rb_range_new (LONG2NUM($1.GetStart()),LONG2NUM($1.GetEnd()),0);'
+
+        end
+
+        map 'wxRichTextRange' => 'Range' do
+
+          map_out code: '$result = rb_range_new (LONG2NUM($1.GetStart()),LONG2NUM($1.GetEnd()),0);'
+
+          map_directorout code: <<~__CODE
+            int start = NUM2INT( rb_funcall( $input, rb_intern("begin"), 0));
+            int end   = NUM2INT( rb_funcall( $input, rb_intern("end"), 0));
+            $result = wxRichTextRange(start, end);
+            __CODE
+
+        end
+
+        # Used as in/out parameters by some other selection-getting methods
+        map_apply 'int *OUTPUT' => [ 'long * from' , 'long * to' ]
+
+      end # define
+
+    end # RichText
+
+  end # Typemap
+
+end # WXRuby3

data/rakelib/lib/typemap/tree_itemid.rb

@@ -0,0 +1,49 @@
+###
+# wxRuby3 Common typemap definitions
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative '../core/mapping'
+
+module WXRuby3
+
+  module Typemap
+
+    # These typemaps are used by TreeCtrl and TreeEvent to convert wx tree
+    # item ids into lightweight wrapper objects
+    module TreeItemId
+
+      include Typemap::Module
+
+      define do
+
+        map 'wxTreeItemId&' => 'Wx::TreeItemId' do
+
+          add_header_code <<~__CODE
+            // implemented in TreeEvent.cpp
+            extern VALUE _wxRuby_Wrap_wxTreeItemId(const wxTreeItemId& id);
+            extern wxTreeItemId _wxRuby_Unwrap_wxTreeItemId(VALUE id);
+            __CODE
+
+          map_in temp: 'wxTreeItemId tmpId', code: <<~__CODE
+            if ($input != Qnil) tmpId = _wxRuby_Unwrap_wxTreeItemId($input);
+            $1 = &tmpId;
+            __CODE
+          map_directorin code: '$input = _wxRuby_Wrap_wxTreeItemId($1);'
+        end
+
+        map 'wxTreeItemId' => 'Wx::TreeItemId' do
+          map_out code: '$result = _wxRuby_Wrap_wxTreeItemId($1);'
+          map_directorout temp: 'wxTreeItemId tmpId', code: <<~__CODE
+            if ($input != Qnil) tmpId = _wxRuby_Unwrap_wxTreeItemId($input);
+            $result = &tmpId;
+          __CODE
+        end
+
+      end # define
+
+    end # TreeItemId
+
+  end # Typemap
+
+end # WXRuby3

data/rakelib/lib/util/string.rb

@@ -0,0 +1,141 @@
+###
+# String utilities mixin
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  module Util
+
+    module StringUtil
+
+      RBKW = %w[
+          __FILE__ and def end in or self unless __LINE__ begin defined? ensure module redo
+          super until BEGIN break do false next rescue then when END case else for retry true while
+          alias class elsif if not return undef
+      ]
+
+      def simple_underscore!(s)
+        s.gsub!(/([A-Z])/, '_\1')
+        s.downcase!
+        s
+      end
+
+      def simple_underscore(s)
+        underscore!(s.dup)
+      end
+
+      def underscore(s)
+        underscore!(s.dup)
+      end
+
+      def underscore!(s)
+        s.gsub!(/::/, '/')
+        s.gsub!(/([A-Z]+)([A-Z][a-z])/,"\\1_\\2")
+        s.gsub!(/([a-z])([A-Z])/,"\\1_\\2")
+        s.tr('-','_')
+        s.downcase!
+        s
+      end
+
+      def camelize(s)
+        camelize!(s.dup)
+      end
+
+      def camelize!(s)
+        s.gsub!(/[^a-zA-Z0-9_]/, '_')
+        s.sub!(/^[a-z\d]*/) { |ms| ms.capitalize }
+        s.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{$1}#{$2.capitalize}" }
+        s
+      end
+
+      def rb_class_name(name)
+        name.sub(/\Awx_?/i, '')
+      end
+
+      def rb_method_name(name, keep_wx_prefix: false)
+        rbnm = underscore(name)
+        rbnm.sub!(/\Awx_/, '') unless keep_wx_prefix
+        rbnm.sub!(/\A_wx_/, 'wx_') unless keep_wx_prefix
+        rbnm.sub!(/\Aoperator/, '')
+        rbnm << '_' if RBKW.include?(rbnm)
+        rbnm
+      end
+
+      def rb_constant_name(name)
+        rbnm = underscore(name)
+        rbnm.sub!(/\Awx_/, '')
+        rbnm.upcase!
+        rbnm
+      end
+
+      def rb_param_name(name)
+        rbnm = name.dup
+        rbnm << '_' if RBKW.include?(name)
+        rbnm
+      end
+
+      def rb_wx_name(name)
+        name.sub(/\Awx/i, '')
+      end
+
+      def rb_module_name(name)
+        rb_wx_name(name).sub(/\A[a-z]/) { |s| s.upcase }
+      end
+
+      def rb_constant_value(name)
+        val = name.sub(/\Awx/, 'Wx::')
+        val == 'NULL' ? 'nil' : val
+      end
+
+      def rb_constant_expression(exp)
+        exp.gsub(/(\w+(::\w+)*)(\s*\()?/) do |s|
+          idstr = $1
+          is_call = !!$3
+          is_scoped = false
+          ids = idstr.split('::')
+          if ids.size > 1
+            is_scoped = true
+            scoped_name = rb_constant_value(ids.shift)
+            while ids.size > 1
+              scoped_name << '::' << ids.shift
+            end
+          end
+          idstr = ids.shift
+          if is_call
+            # object ctor or static method call
+            if is_scoped
+              # static method
+              "#{scoped_name}.#{rb_method_name(idstr)}("
+            else
+              # ctor
+              case idstr
+              when 'wxString'
+                '('
+              else
+                "#{rb_constant_value(idstr)}.new("
+              end
+            end
+          else
+            if is_scoped
+              # nested identifier
+              "#{scoped_name}::#{idstr}"
+            else
+              # constant
+              if /[\-\+\.\d]+/ =~ idstr
+                idstr # numeric constant
+              elsif /\A(true|false|NULL)/ =~ idstr
+                $1 == 'NULL' ? 'nil' : $1
+              else
+                "Wx::#{rb_constant_name(idstr)}"
+              end
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/rakelib/prepost.rake

@@ -0,0 +1,91 @@
+###
+# wxRuby3 rake file
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './prepost'
+
+namespace 'wxruby' do
+
+  namespace 'pre' do
+
+    task :uninstall do
+      if WXRuby3.config.windows? && WXRuby3.config.get_config('with-wxwin') && !Rake::FileUtilsExt.nowrite_flag
+        # since we created this file ourselves remove it before uninstalling
+        rm_f(File.join(WXRuby3.config.get_cfg_string('siterubyver'), 'wx/startup.rb'), verbose: false)
+      end
+    end
+
+  end
+
+  namespace 'post' do
+
+    task :srcgem => %w[gem:wxwin gem:install wxruby:doc] do
+      # cleanup
+      rm_rf('rakelib')
+      rm_rf('ext/wxruby3')
+      rm_rf('ext/wxWidgets') if File.exist?('ext/wxWidgets')
+    end
+
+    task :bingem => 'gem:install' do
+      # cleanup
+      rm_rf('rakelib')
+    end
+
+    namespace 'gem' do
+      task :wxwin do
+        WXRuby3::Install.install_wxwin_shlibs
+      end
+
+      task :install do
+        if WXRuby3.config.windows?
+          if WXRuby3.config.get_config('with-wxwin')
+            WXRuby3::Post.create_startup <<~__CODE
+              begin
+                require 'ruby_installer'
+                if RubyInstaller::Runtime.respond_to?(:add_dll_directory)
+                  RubyInstaller::Runtime.add_dll_directory('#{File.expand_path('ext')}')
+                else
+                  RubyInstaller::Build.add_dll_directory('#{File.expand_path('ext')}')
+                end
+              rescue LoadError
+              end
+              __CODE
+          elsif !WXRuby3.config.get_cfg_string('wxwin').empty? && File.directory?(WXRuby3.config.get_cfg_string('wxwininstdir'))
+            WXRuby3::Post.create_startup <<~__CODE
+              begin
+                require 'ruby_installer'
+                if RubyInstaller::Runtime.respond_to?(:add_dll_directory)
+                  RubyInstaller::Runtime.add_dll_directory('#{WXRuby3.config.get_cfg_string('wxwininstdir')}')
+                else
+                  RubyInstaller::Build.add_dll_directory('#{WXRuby3.config.get_cfg_string('wxwininstdir')}')
+                end
+              rescue LoadError
+              end
+              __CODE
+          end
+        end
+      end
+    end
+
+    task :install do
+      if WXRuby3.config.windows? && WXRuby3.config.get_config('with-wxwin') && !Rake::FileUtilsExt.nowrite_flag
+        File.open(File.join(WXRuby3.config.get_cfg_string('siterubyver'), 'wx/startup.rb'), 'w') do |f|
+          f.puts <<~__CODE
+            begin
+              require 'ruby_installer'
+              if RubyInstaller::Runtime.respond_to?(:add_dll_directory)
+                RubyInstaller::Runtime.add_dll_directory('#{WXRuby3.config.get_cfg_string('siterubyverarch')}')
+              else
+                RubyInstaller::Build.add_dll_directory('#{WXRuby3.config.get_cfg_string('siterubyverarch')}')
+              end
+            rescue LoadError
+            end
+            __CODE
+        end
+      end
+    end
+
+  end
+
+end

data/rakelib/prepost.rb

@@ -0,0 +1,26 @@
+###
+# wxRuby3 rake gem support
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './lib/config'
+require_relative './install'
+
+module WXRuby3
+
+  module Post
+
+    def self.create_startup(code)
+      File.open('lib/wx/startup.rb', 'w+') do |f|
+        f.puts <<~__CODE
+          # Wx startup for wxRuby3
+          # Copyright (c) M.J.N. Corino, The Netherlands
+
+          #{code}
+          __CODE
+      end
+    end
+
+  end
+
+end

data/rakelib/run.rake

@@ -0,0 +1,49 @@
+###
+# wxRuby3 rake file
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './configure'
+
+namespace :wxruby do
+
+  task :run, [:app] => 'config:bootstrap' do |t, args|
+    Rake::Task[:build].invoke
+    WXRuby3.config.run args[:app]
+  end
+
+  task :debug, [:app] => 'config:bootstrap' do |t, args|
+    Rake::Task[:build].invoke
+    WXRuby3.config.debug args[:app]
+  end
+
+  task :test => 'config:bootstrap' do |t, args|
+    Rake::Task[:build].invoke
+    tests = args.extras - [':nodep']
+    tests << ENV['TEST'] if ENV['TEST']
+    WXRuby3.config.test *tests
+  end
+
+  task :irb => 'config:bootstrap' do |t, args|
+    Rake::Task[:build].invoke
+    WXRuby3.config.irb
+  end
+
+  task :exec => 'config:bootstrap' do |t, args|
+    WXRuby3.config.execute args.extras
+  end
+
+end
+
+desc "Run wxRuby tests"
+task :test => 'wxruby:test'
+
+task :tests => 'wxruby:test'
+
+desc 'Run wxRuby (sample) app'
+task :run, [:app] => 'wxruby:run'
+
+desc 'Debug wxRuby (sample) app'
+task :debug, [:app] => 'wxruby:debug'
+
+task :irb => 'wxruby:irb'

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

@@ -0,0 +1,7 @@
+
+blockquote {
+    background: #f7f7f9;
+    border-left: .25em solid #e1e1e8;
+    margin: 14px;
+    padding-left: 14px;
+}

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

@@ -0,0 +1,5 @@
+
+def stylesheets
+  # Load the existing stylesheets while appending the custom one
+  super + %w(css/wxruby3.css)
+end

data/rakelib/yard/yard/relative_markdown_links/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module YARD
+  module RelativeMarkdownLinks
+    # Current version of the yard-relative_markdown_links gem.
+    VERSION = "0.4.1"
+  end
+end