wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/director/html_cell.rb

@@ -0,0 +1,36 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class HtmlCell < Director
+
+      include Typemap::HtmlCell
+
+      def setup
+        super
+        spec.items << 'wxHtmlLinkInfo' << 'wxHtmlContainerCell' << 'htmldefs.h'
+        # the classes here are internal and for reference only
+        # should never be derived from or instantiated in (Ruby) user code
+        spec.disable_proxies
+        spec.make_abstract 'wxHtmlCell'
+        spec.make_abstract 'wxHtmlLinkInfo'
+        spec.make_abstract 'wxHtmlContainerCell'
+        spec.gc_as_temporary 'wxHtmlLinkInfo' # no tracking
+        spec.ignore 'wxHtmlCell::Find'
+        # not useful for wxRuby as we do not support customizing these
+        spec.ignore 'wxHtmlCell::AdjustPagebreak',
+                    'wxHtmlCell::Draw',
+                    'wxHtmlCell::DrawInvisible',
+                    'wxHtmlCell::Layout',
+                    'wxHtmlCell::ProcessMouseClick'
+      end
+    end # class HtmlCell
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_easy_printing.rb

@@ -0,0 +1,45 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class HtmlEasyPrinting < Director
+
+      def setup
+        super
+        # Deal with sizes argument to SetFonts
+        spec.map 'const int *sizes' => 'Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil' do
+          map_in temp: 'int tmp[7]', code: <<~__CODE
+            if (NIL_P($input))
+            {
+              $1 = NULL;
+            }
+            else if (TYPE($input) == T_ARRAY && RARRAY_LEN($input) == 7)
+            {
+              tmp[0] = NUM2INT(rb_ary_entry($input, 0));
+              tmp[1] = NUM2INT(rb_ary_entry($input, 1));
+              tmp[2] = NUM2INT(rb_ary_entry($input, 2));
+              tmp[3] = NUM2INT(rb_ary_entry($input, 3));
+              tmp[4] = NUM2INT(rb_ary_entry($input, 4));
+              tmp[5] = NUM2INT(rb_ary_entry($input, 5));
+              tmp[6] = NUM2INT(rb_ary_entry($input, 6));
+              $1 = &tmp[0];
+            }
+            else
+            {
+              VALUE msg = rb_inspect($input);
+              rb_raise(rb_eArgError, "Expected nil or array of 7 integers for %d but got %s",
+                       $argnum-1, StringValuePtr(msg));
+            }
+            __CODE
+        end
+      end
+    end # class HtmlEasyPrinting
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_event.rb

@@ -0,0 +1,24 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './event'
+
+module WXRuby3
+
+  class Director
+
+    class HtmlEvent < Event
+
+      include Typemap::HtmlCell
+
+      def setup
+        super
+        spec.do_not_generate :variables, :enums, :defines, :functions
+      end
+    end # class HtmlEvent
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_help_data.rb

@@ -0,0 +1,43 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class HtmlHelpData < Director
+
+      def setup
+        super
+        spec.items << 'wxHtmlBookRecord' << 'wxHtmlHelpDataItem'
+        # type mapping for wxHtmlBookRecArray and wxHtmlHelpDataItems
+        spec.map 'const wxHtmlBookRecArray&' => 'Array<Wx::HtmlBookRecord>' do
+          map_out code: <<~__CODE
+            $result = rb_ary_new();
+            for (size_t n=0; n<$1->GetCount() ;++n)
+            {
+              wxHtmlBookRecord* hbr_ptr = &($1->Item(n));
+              VALUE rb_hbr = Data_Wrap_Struct(rb_cObject, 0, 0, hbr_ptr);
+              rb_ary_push($result, rb_hbr);
+            }
+            __CODE
+        end
+        spec.map 'const wxHtmlHelpDataItems&' => 'Array<Wx::HtmlHelpDataItem>' do
+          map_out code: <<~__CODE
+            $result = rb_ary_new();
+            for (size_t n=0; n<$1->GetCount() ;++n)
+            {
+              wxHtmlHelpDataItem* hdi_ptr = &($1->Item(n));
+              VALUE rb_hdi = Data_Wrap_Struct(rb_cObject, 0, 0, hdi_ptr);
+              rb_ary_push($result, rb_hdi);
+            }
+            __CODE
+        end
+      end
+    end # class HtmlHelpData
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_help_frame.rb

@@ -0,0 +1,25 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './frame'
+
+module WXRuby3
+
+  class Director
+
+    class HtmlHelpFrame < Frame
+
+      def setup
+        super
+        spec.no_proxy %w[
+          wxHtmlHelpFrame::CreateStatusBar wxHtmlHelpFrame::CreateToolBar
+          wxHtmlHelpFrame::GetMenuBar wxHtmlHelpFrame::GetStatusBar
+          wxHtmlHelpFrame::GetToolBar]
+      end
+    end # class HtmlHelpFrame
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_listbox.rb

@@ -0,0 +1,54 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class HtmlListBox < Window
+
+      def setup
+        spec.items << 'wxSimpleHtmlListBox'
+        super
+        spec.override_inheritance_chain('wxHtmlListBox', %w[wxVListBox wxVScrolledWindow wxPanel wxWindow wxEvtHandler wxObject])
+        spec.make_abstract 'wxHtmlListBox'
+        # provide base implementation for OnGetItem
+        spec.add_header_code <<~__HEREDOC
+          // Custom subclass implementation. 
+          class wxRubyHtmlListBox : public wxHtmlListBox
+          {
+          public:
+            wxRubyHtmlListBox() 
+              : wxHtmlListBox () {}
+            wxRubyHtmlListBox(wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxHtmlListBoxNameStr)
+              : wxHtmlListBox(parent, id, pos, size, style, name) {}
+          protected:
+            virtual wxString 	OnGetItem (size_t n) const
+            {
+              rb_raise(rb_eNoMethodError, "Not implemented");
+            }
+          };
+        __HEREDOC
+        # make Ruby director and wrappers use custom implementation
+        spec.use_class_implementation('wxHtmlListBox', 'wxRubyHtmlListBox')
+        # we do not want wxFileSystem exposed (not worth the trouble)
+        spec.ignore 'wxHtmlListBox::GetFileSystem'
+        # just add an extension to change the path for resolving relative paths in HTML
+        spec.add_extend_code 'wxHtmlListBox', <<~__HEREDOC
+          void change_filesystem_path_to(const wxString& location, bool is_dir=false)
+          {
+            $self->GetFileSystem().ChangePathTo(location, is_dir);
+          }
+          __HEREDOC
+        # override inheritance chain
+        spec.override_inheritance_chain('wxSimpleHtmlListBox', %w[wxHtmlListBox wxVListBox wxVScrolledWindow wxPanel wxWindow wxEvtHandler wxObject])
+      end
+    end # class HtmlListBox
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_printout.rb

@@ -0,0 +1,47 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class HtmlPrintout < Director
+
+      def setup
+        super
+        spec.override_inheritance_chain('wxHtmlPrintout', {'wxPrintout' => 'wxPrinter'}, 'wxObject')
+        # Deal with sizes argument to SetFonts
+        spec.map 'const int *sizes' => 'Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil' do
+          map_in temp: 'int tmp[7]', code: <<~__CODE
+            if (NIL_P($input))
+            {
+              $1 = NULL;
+            }
+            else if (TYPE($input) == T_ARRAY && RARRAY_LEN($input) == 7)
+            {
+              tmp[0] = NUM2INT(rb_ary_entry($input, 0));
+              tmp[1] = NUM2INT(rb_ary_entry($input, 1));
+              tmp[2] = NUM2INT(rb_ary_entry($input, 2));
+              tmp[3] = NUM2INT(rb_ary_entry($input, 3));
+              tmp[4] = NUM2INT(rb_ary_entry($input, 4));
+              tmp[5] = NUM2INT(rb_ary_entry($input, 5));
+              tmp[6] = NUM2INT(rb_ary_entry($input, 6));
+              $1 = &tmp[0];
+            }
+            else
+            {
+              VALUE msg = rb_inspect($input);
+              rb_raise(rb_eArgError, "Expected nil or array of 7 integers for %d but got %s",
+                       $argnum-1, StringValuePtr(msg));
+            }
+          __CODE
+        end
+        spec.do_not_generate(:variables, :defines, :enums, :functions)
+      end
+    end # class HtmlPrintout
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/html_window.rb

@@ -0,0 +1,114 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class HtmlWindow < Window
+
+      include Typemap::HtmlCell
+
+      def setup
+        super
+        spec.items << 'wxHtmlFilter' << 'htmlpars.h'
+        spec.gc_as_window 'wxHtmlWindow'
+        spec.override_inheritance_chain('wxHtmlWindow', %w[wxScrolledWindow wxPanel wxWindow wxEvtHandler wxObject])
+        # add members from wxHtmlWindowInterface
+        # (we do it like this because we do not want pure virtual declarations which is
+        # what we would get if we used fold_bases)
+        spec.extend_interface 'wxHtmlWindow',
+                              'enum HTMLCursor { HTMLCursor_Default, HTMLCursor_Link, HTMLCursor_Text }',
+                              'virtual wxPoint HTMLCoordsToWindow(wxHtmlCell *cell, const wxPoint& pos) const',
+                              'virtual wxWindow* GetHTMLWindow()',
+                              'virtual wxColour GetHTMLBackgroundColour() const',
+                              'virtual void SetHTMLBackgroundColour(const wxColour& clr)',
+                              'virtual void SetHTMLBackgroundImage(const wxBitmapBundle& bmpBg)',
+                              'virtual void SetHTMLStatusText(const wxString& text)',
+                              'virtual wxCursor GetHTMLCursor(HTMLCursor type) const'
+        # handled; can be suppressed
+        spec.suppress_warning(473, "wxHtmlWindow::GetHTMLWindow")
+        # deprecated; use event handler instead
+        spec.ignore 'wxHtmlWindow::OnLinkClicked'
+        spec.no_proxy 'wxHtmlWindow::SendAutoScrollEvents'
+        spec.add_header_code 'typedef wxHtmlWindow::HTMLCursor HTMLCursor;'
+        # type mapping for LoadFile, SetFonts and OnOpeningURL
+        spec.map 'const wxFileName &filename' => 'String' do
+          # Deal with wxFileName
+          map_in temp: 'wxFileName tmp', code: <<~__CODE
+            tmp = wxFileName(RSTR_TO_WXSTR($input));
+            $1 = &tmp;
+            __CODE
+        end
+        # Deal with sizes argument to SetFonts
+        spec.map 'const int *sizes' => 'Array(Integer,Integer,Integer,Integer,Integer,Integer,Integer), nil' do
+          map_in temp: 'int tmp[7]', code: <<~__CODE
+            if (NIL_P($input))
+            {
+              $1 = NULL;
+            }
+            else if (TYPE($input) == T_ARRAY && RARRAY_LEN($input) == 7)
+            {
+              tmp[0] = NUM2INT(rb_ary_entry($input, 0));
+              tmp[1] = NUM2INT(rb_ary_entry($input, 1));
+              tmp[2] = NUM2INT(rb_ary_entry($input, 2));
+              tmp[3] = NUM2INT(rb_ary_entry($input, 3));
+              tmp[4] = NUM2INT(rb_ary_entry($input, 4));
+              tmp[5] = NUM2INT(rb_ary_entry($input, 5));
+              tmp[6] = NUM2INT(rb_ary_entry($input, 6));
+              $1 = &tmp[0];
+            }
+            else
+            {
+              VALUE msg = rb_inspect($input);
+              rb_raise(rb_eArgError, "Expected nil or array of 7 integers for %d but got %s",
+                       $argnum-1, StringValuePtr(msg));
+            }
+          __CODE
+        end
+        spec.map 'const wxString &url, wxString *redirect' do
+          # deal with OnOpeningURL's "wxString *redirect" argument
+          map_directorin code: '$input = WXSTR_TO_RSTR($1);'
+        end
+        spec.map 'wxHtmlOpeningStatus' => 'true,false,String' do
+          map_directorout code: ''
+          map_out code: <<~__CODE
+            switch ($1)
+            {
+              case wxHTML_OPEN: $result = Qtrue; break;
+              case wxHTML_REDIRECT: $result = WXSTR_TO_RSTR(redir_tmp4); break;
+              default: $result = Qfalse; break; // BLOCK
+            }
+          __CODE
+        end
+        spec.map 'wxString *redirect' do
+          map_directorargout code: <<~__CODE
+            if (TYPE(result) == T_STRING)
+            {
+              *redirect = RSTR_TO_WXSTR(result);
+              c_result = wxHTML_REDIRECT;
+            }
+            else if (result != Qnil && result != Qfalse)
+            {
+              c_result = wxHTML_OPEN;
+            }
+            else
+            {
+              c_result = wxHTML_BLOCK;
+            }
+            __CODE
+          map_in ignore: true, temp: 'wxString redir_tmp', code: '$1 = &redir_tmp;'
+        end
+
+        # disown added HtmlFilter-s (pure Ruby override takes care of GC marking)
+        spec.disown 'wxHtmlFilter*'
+      end
+    end # class HtmlWindow
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/icon.rb

@@ -0,0 +1,33 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Icon < Director
+
+      include Typemap::IOStreams
+
+      def setup
+        spec.items << 'wxIconBundle'
+        spec.disable_proxies
+        spec.require_app 'wxIcon', 'wxIconBundle'
+        # disable as there is no way to distinguish char*/[] from wxString in Ruby
+        # and anyway there is no real benefit compared to loading XPM by filename
+        spec.ignore('wxIcon::wxIcon(const char *const *)', 'wxIcon::wxIcon(const char[],int,int)')
+        # xml specs incorrectly list this method for MWS while it does not exist anymore
+        spec.ignore('wxIcon::ConvertToDisabled')
+        unless Config.platform == :mingw
+          spec.override_inheritance_chain('wxIcon', %w[wxBitmap wxGDIObject wxObject])
+          spec.ignore 'wxIconBundle::wxIconBundle(const wxString &, WXHINSTANCE)'
+        end
+        super
+      end
+    end # class Icon
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/image.rb

@@ -0,0 +1,111 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Image < Director
+
+      include Typemap::IOStreams
+
+      def setup
+        super
+        # Handled in Ruby: lib/wx/classes/image.rb
+        spec.ignore [
+          'wxImage::wxImage(wxInputStream &,wxBitmapType,int)',
+          'wxImage::wxImage(wxInputStream &,const wxString &,int)',
+          'wxImage::GetImageCount(wxInputStream &,wxBitmapType)'
+          ]
+        spec.rename_for_ruby(
+          'LoadStream' => ['wxImage::LoadFile(wxInputStream &, wxBitmapType, int)', 'wxImage::LoadFile(wxInputStream &,const wxString &, int)'],
+          'Write' => ['wxImage::SaveFile(wxOutputStream &, wxBitmapType) const', 'wxImage::SaveFile(wxOutputStream &,const wxString &) const'],
+          # Renaming to avoid method overloading and thus conflicts at Ruby level
+          # 'GetAlphaData' => 'wxImage::GetAlpha() const',
+          'SetAlphaData' => 'wxImage::SetAlpha(unsigned char *,bool)',
+          # Renaming for consistency with above methods and SetRGB method
+          # 'GetRgbData' => 'wxImage::GetData() const',
+          'SetRgbDataWithSize' => 'wxImage::SetData(unsigned char *,int,int,bool)')
+        # handle this in Ruby
+        spec.ignore 'wxImage::SetData(unsigned char *,bool)'
+        # Handler methods are not supported in wxRuby; all standard handlers
+        # are loaded at startup, and we don't allow custom image handlers to be
+        # written in Ruby.
+        spec.ignore %w[
+          wxImage::AddHandler
+          wxImage::CleanUpHandlers
+          wxImage::FindHandler
+          wxImage::FindHandlerMime
+          wxImage::GetHandlers
+          wxImage::InitStandardHandlers
+          wxImage::InsertHandler
+          wxImage::RemoveHandler
+          ]
+        # The GetRgbData and GetAlphaData methods require special handling using %extend;
+        spec.ignore %w[wxImage::GetData wxImage::GetAlpha]
+        # The SetRgbData and SetAlphaData are dealt with by typemaps (see below).
+        # For Image#set_rgb_data, Image#set_alpha_data and Image.new with raw data arg:
+        # copy raw string data from a Ruby string to a memory block that will be
+        # managed by wxWidgets (see static_data typemap below)
+        spec.map 'unsigned char* data', 'unsigned char* alpha', as: 'String' do
+          map_in code: <<~__CODE
+            if ( TYPE($input) == T_STRING )
+              {
+                int data_len = RSTRING_LEN($input);
+                $1 = (unsigned char*)malloc(data_len);
+                memcpy($1, StringValuePtr($input), data_len);
+              }
+            else if ( $input == Qnil ) // Needed for SetAlpha, an error for SetData
+              $1 = NULL;
+            else
+              SWIG_exception_fail(SWIG_ERROR, 
+                                  "String required as raw Image data argument");
+            __CODE
+        end
+        # Image.new(data...) and Image#set_alpha_data both accept a static_data
+        # argument to specify whether wxWidgets should delete the data
+        # pointer. Since in wxRuby we always copy from the Ruby string object
+        # to the Image, we always want wxWidgets to handle deletion of the copy
+        spec.map 'bool static_data' do
+          map_in ignore: true, code: '$1 = false;'
+        end
+
+        # For get_or_find_mask_colour, which should returns a triplet
+        # containing the mask colours, plus its normal Boolean return value.
+        spec.map_apply 'unsigned char *OUTPUT' => ['unsigned char* r',
+                                                   'unsigned char* g',
+                                                   'unsigned char* b' ]
+        # GetRgbData and GetAlphaData methods return an unsigned char* pointer to the
+        # internal representation of the image's data. We can't simply use
+        # rb_str_new2 because the data is not NUL terminated, so strlen won't
+        # return the right length; we have to know the image's height and
+        # width to give the ruby string the right length.
+        #
+        # Unlike the C++ version of these methods, these return copies of the
+        # data; the ruby string is NOT a pointer to that internal data and
+        # cannot be directly manipulated to change the image. This is tricky
+        # b/c of Ruby's GC; it might be possible, as in mmap (see
+        # http:#blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/296601)
+        # but I do not think it is desirable.
+        spec.add_extend_code 'wxImage', <<~__HEREDOC
+          VALUE get_alpha_data() {
+            unsigned char* alpha_data = $self->GetAlpha();
+            int length = $self->GetWidth() * $self->GetHeight();
+            return rb_str_new( (const char*)alpha_data, length);
+          }
+        
+          VALUE get_rgb_data() {
+            unsigned char* rgb_data = $self->GetData();
+            int length = $self->GetWidth() * $self->GetHeight() * 3;
+            return rb_str_new( (const char*)rgb_data, length);
+          }
+          __HEREDOC
+        spec.do_not_generate(:functions)
+      end
+    end # class Image
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/image_list.rb

@@ -0,0 +1,21 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class ImageList < Director
+
+      def setup
+        spec.require_app 'wxImageList'
+        spec.rename_for_ruby('AddIcon' => 'wxImageList::Add(const wxIcon &)')
+        super
+      end
+    end # class ImageList
+
+  end # class Director
+
+end # module WXRuby3