wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/director/defs.rb

@@ -0,0 +1,139 @@
+###
+# wxRuby3 Defs director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Defs < Director
+
+      def setup
+        spec.items.replace ['defs.h']
+        spec.ignore %w{
+          wxINT8_MIN
+          wxINT8_MAX
+          wxUINT8_MAX
+          wxINT16_MIN
+          wxINT16_MAX
+          wxUINT16_MAX
+          wxINT32_MIN
+          wxINT32_MAX
+          wxUINT32_MAX
+          wxINT64_MIN
+          wxINT64_MAX
+          wxUINT64_MAX
+          wxVaCopy
+        }
+        if Config.instance.wx_version >= '3.3.0'
+          spec.ignore 'wxOVERRIDE'
+        end
+        super
+      end
+
+      def generator
+        WXRuby3::DefsGenerator.new(self)
+      end
+      protected :generator
+
+      def rake_generator
+        WXRuby3::DefsRakeGenerator.new(self)
+      end
+      protected :rake_generator
+
+    end # class Defs
+
+  end # class Director
+
+  class DefsGenerator < InterfaceGenerator
+
+    def gen_swig_header(fout)
+      fout << <<~__HEREDOC
+        /**
+         * This file is automatically generated by the WXRuby3 interface generator.
+         * Do not alter this file.
+         */
+
+        %include "../common.i"
+
+        %module(directors="1") #{module_name}
+
+        // Version numbers from wx/version.h
+        %constant const int wxWXWIDGETS_MAJOR_VERSION = wxMAJOR_VERSION;
+        %constant const int wxWXWIDGETS_MINOR_VERSION = wxMINOR_VERSION;
+        %constant const int wxWXWIDGETS_RELEASE_NUMBER = wxRELEASE_NUMBER;
+        %constant const int wxWXWIDGETS_SUBRELEASE_NUMBER = wxSUBRELEASE_NUMBER;
+        // WXWIDGETS_VERSION is defined in lib/wx/core.rb
+        
+        #ifdef __WXDEBUG__
+        %constant const bool wxDEBUG = true;
+        #else
+        %constant const bool wxDEBUG = false;
+        #endif
+                 
+        // Platform constants
+        
+        #ifdef __WXMOTIF__
+        #define wxPLATFORM "WXMOTIF"
+        #endif
+        #ifdef __WXX11__
+        #define wxPLATFORM "WXX11"
+        #endif
+        #ifdef __WXGTK__
+        #define wxPLATFORM "WXGTK"
+        #endif
+        #ifdef __WXQT__
+        #define wxPLATFORM "WXQT"
+        #endif
+        #ifdef __WXMSW__
+        #define wxPLATFORM "WXMSW"
+        #endif
+        #ifdef __WXOSX__
+        #define wxPLATFORM "WXOSX"
+        #endif
+
+      __HEREDOC
+    end
+
+    def gen_interface_include_code(fout)
+      gen_enums(fout)
+
+      gen_defines(fout)
+
+      gen_variables(fout)
+
+      gen_functions(fout)
+    end
+
+    def run
+      Stream.transaction do
+        f = CodeStream.new(File.join(Config.instance.classes_dir, 'common', 'typedefs.i'))
+        f << <<~__HEREDOC
+          /**
+           * This file is automatically generated by the WXRuby3 interface generator.
+           * Do not alter this file.
+           */
+        __HEREDOC
+        gen_typedefs(f)
+      end
+      # make sure to keep this last for the parallel builds synchronize on the *.i files
+      super
+    end
+
+  end # class DefsGenerator
+
+  class DefsRakeGenerator < RakeDependencyGenerator
+
+
+    def create_rake_tasks(frake)
+      super
+      frake << <<~__TASK
+          file '#{File.join(Config.instance.common_dir, 'typedefs.i')}' => '#{File.join(Config.instance.classes_dir, 'Defs.i')}'
+      __TASK
+    end
+    protected :create_rake_tasks
+
+  end
+
+end # module WXRuby3

data/rakelib/lib/director/derived_dc.rb

@@ -0,0 +1,64 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class DerivedDC < Director
+
+      def setup
+        super
+        spec.disable_proxies
+        if spec.module_name == 'wxScreenDC'
+          spec.make_abstract 'wxScreenDC'
+          # as a ScreenDC should always be a temporary stack object
+          # we do not allow creation in Ruby but rather provide a class
+          # method for block execution on a temp dc
+          spec.add_extend_code 'wxScreenDC', <<~__HEREDOC
+            static VALUE paint(VALUE proc)
+            {
+              if (rb_block_given_p ())
+              {
+                wxScreenDC screen_dc;
+                wxDC* dc_ptr = &screen_dc;
+                VALUE rb_dc = SWIG_NewPointerObj(SWIG_as_voidptr(dc_ptr), SWIGTYPE_p_wxScreenDC, 0);
+                return rb_yield(rb_dc);
+              }
+              return Qnil;
+            }
+            __HEREDOC
+          # not relevant anymore
+          spec.ignore 'wxScreenDC::StartDrawingOnTop',
+                      'wxScreenDC::EndDrawingOnTop',
+                      'wxScreenDC::wxScreenDC'
+        elsif spec.module_name == 'wxSVGFileDC'
+          spec.items.concat %w[wxSVGBitmapHandler wxSVGBitmapFileHandler wxSVGBitmapEmbedHandler]
+          spec.disown 'wxSVGBitmapHandler *handler'
+          # all inherited from wxDC; only documented since they are not implemented for this DC class
+          spec.ignore 'wxSVGFileDC::DestroyClippingRegion',
+                      'wxSVGFileDC::CrossHair',
+                      'wxSVGFileDC::FloodFill',
+                      'wxSVGFileDC::GetPixel',
+                      'wxSVGFileDC::SetPalette',
+                      'wxSVGFileDC::GetDepth',
+                      'wxSVGFileDC::SetLogicalFunction',
+                      'wxSVGFileDC::GetLogicalFunction',
+                      'wxSVGFileDC::StartDoc',
+                      'wxSVGFileDC::EndDoc',
+                      'wxSVGFileDC::StartPage',
+                      'wxSVGFileDC::EndPage'
+        elsif spec.module_name == 'wxGCDC'
+          spec.ignore 'wxGCDC::wxGCDC(const wxEnhMetaFileDC &)'
+        else
+          # ctors of all other derived DC require a running App
+          spec.require_app spec.module_name
+        end
+      end
+    end # class DerivedDC
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/dialog.rb

@@ -0,0 +1,214 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './top_level_window'
+
+module WXRuby3
+
+  class Director
+
+    class Dialog < TopLevelWindow
+
+      def setup
+        super
+        # overrule common typemap to allow default NULL
+        spec.map 'wxWindow* parent' do
+          map_check code: ''
+        end
+        case spec.module_name
+        when 'wxDialog'
+          spec.ignore('wxDialog::GetContentWindow',
+                      'wxDialog::GetToolBar') # seemingly removed from MSW
+          spec.swig_import('swig/classes/include/wxDefs.h')
+          spec.add_wrapper_code <<~__HEREDOC
+            extern VALUE wxRuby_GetDialogClass() {
+              return SwigClassWxDialog.klass;
+            }
+          __HEREDOC
+        when 'wxMessageDialog'
+        when 'wxFontDialog'
+          # ignore the non-const version
+          spec.ignore 'wxFontDialog::GetFontData'
+          spec.regard 'wxFontDialog::GetFontData() const'
+        when 'wxFileDialog'
+          # override the wxArrayString& typemap for GetFilenames and GetPaths
+          spec.map 'wxArrayString&' => 'Array<String>' do
+            map_in ignore: true, temp: 'wxArrayString sel', code: '$1 = &sel;'
+            map_argout code: <<~__CODE
+             $result = rb_ary_new();
+             for (size_t i = 0; i < $1->GetCount(); i++)
+               rb_ary_push($result, WXSTR_TO_RSTR( (*$1)[i] ) );
+             __CODE
+          end
+          spec.ignore 'wxFileDialog::SetExtraControlCreator'
+          if Config.instance.wx_version >= '3.2.1'
+            # doc does not seem to match actual header code so just ignore for now
+            spec.ignore('wxFileDialog::AddShortcut')
+          end
+          spec.do_not_generate :functions
+        when 'wxPropertySheetDialog'
+          spec.ignore 'wxPropertySheetDialog::GetContentWindow'
+          # In Ruby a derived class with customized '#initialize' is far easier
+          spec.ignore 'wxPropertySheetDialog::CreateBookCtrl'
+          # Needs special handling to ensure the return value is cast to the
+          # correct book class, not the generic abstract parent class
+          # wxBookCtrlBase
+          spec.ignore('wxPropertySheetDialog::GetBookCtrl', ignore_doc: false) # keep doc
+          spec.add_extend_code 'wxPropertySheetDialog', <<~__HEREDOC
+            VALUE get_book_ctrl() {
+              wxBookCtrlBase* book = $self->GetBookCtrl();
+              return wxRuby_WrapWxObjectInRuby( (wxObject*)book) ;
+            }
+            __HEREDOC
+        when 'wxFindReplaceDialog'
+          spec.ignore 'wxFindReplaceDialog::wxFindReplaceDialog()'
+          spec.map_apply 'SWIGTYPE *DISOWN' => 'wxFindReplaceData* data'
+          spec.do_not_generate(:variables, :enums)
+        when 'wxColourDialog'
+          # make interface GC-safe
+          spec.ignore 'wxColourDialog::GetColourData'
+          spec.add_extend_code 'wxColourDialog', <<~__HEREDOC
+            wxColourData* GetColourData()
+            {
+              return new wxColourData(self->GetColourData());
+            }
+            void SetColourData(const wxColourData& cd)
+            {
+              self->GetColourData() = cd;
+            }
+            __HEREDOC
+          spec.new_object 'wxColourDialog::GetColourData'
+        when 'wxTextEntryDialog'
+          spec.items << 'wxPasswordEntryDialog'
+        when 'wxSingleChoiceDialog'
+          # unnneeded and unwanted for Ruby
+          spec.ignore 'wxSingleChoiceDialog::wxSingleChoiceDialog(wxWindow *,const wxString &,const wxString &,int,const wxString *,void **,long,const wxPoint &)'
+          # Wx's SingleChoiceDialog offers the possibility of attaching client
+          # data to each choice. However this would need memory management, and a
+          # pure ruby implementation is trivial and likely to be more convenient
+          # on a per-case basis so just ignore this argument for Ruby.
+          spec.map 'char** clientData' do
+            map_in ignore: true, code: '$1 = (char **)NULL;'
+          end
+          spec.ignore 'wxSingleChoiceDialog::GetSelectionData'
+          spec.do_not_generate(:functions)
+        when 'wxMultiChoiceDialog'
+          # unnneeded and unwanted for Ruby
+          spec.ignore 'wxMultiChoiceDialog::wxMultiChoiceDialog(wxWindow *,const wxString &,const wxString &,int,const wxString *,long,const wxPoint &)'
+          # Wx's MultiChoiceDialog offers the possibility of attaching client
+          # data to each choice. However this would need memory management, and a
+          # pure ruby implementation is trivial and likely to be more convenient
+          # on a per-case basis so just ignore this argument for Ruby.
+          spec.map 'char** clientData' do
+            map_in ignore: true, code: '$1 = (char **)NULL;'
+          end
+          spec.do_not_generate(:functions, :enums, :defines)
+        when 'wxDirDialog'
+        when 'wxProgressDialog'
+          # These two have problematic arguments; they accept a bool pointer
+          # which will be set to true if "skip" was pressed since the last
+          # update. Dealt with below.
+          spec.make_concrete 'wxProgressDialog'
+          spec.items << 'wxGenericProgressDialog'
+          spec.fold_bases('wxProgressDialog' => 'wxGenericProgressDialog')
+          spec.ignore(%w[wxGenericProgressDialog::Pulse wxGenericProgressDialog::Update], ignore_doc: false) # keep docs
+          # TODO : add docs for Ruby specials
+          spec.add_extend_code 'wxProgressDialog', <<~__HEREDOC
+            // In wxRuby there are two versions of each of these methods, the
+            // standard one which returns just true/false depending on whether it
+            // has been aborted, and a special one which returns a pair of values,
+            // true/false for "aborted" and then true/false for "skipped"
+            VALUE pulse(VALUE rb_msg = Qnil)
+            {
+              wxString new_msg;
+              if ( rb_msg == Qnil )
+                new_msg = wxEmptyString;
+              else
+                new_msg = wxString( StringValuePtr(rb_msg), wxConvUTF8 );
+          
+              if ( $self->Pulse(new_msg) )
+                return Qtrue;
+              else
+                return Qfalse;
+            }
+          
+            VALUE pulse_and_check(VALUE rb_msg = Qnil)
+            {
+              VALUE ret = rb_ary_new();
+          
+              wxString new_msg;
+              if ( rb_msg == Qnil )
+                new_msg = wxEmptyString;
+              else
+                new_msg = wxString( StringValuePtr(rb_msg), wxConvUTF8 );
+              
+              bool skip = false;
+              if ( $self->Pulse(new_msg, &skip) )
+                rb_ary_push(ret, Qtrue);
+              else 
+                rb_ary_push(ret, Qfalse);
+              
+              rb_ary_push(ret, ( skip ? Qtrue : Qfalse) );
+          
+              return ret;
+            }
+          
+            VALUE update(int value, VALUE rb_msg = Qnil)
+            {
+              wxString new_msg;
+              if ( rb_msg == Qnil )
+                new_msg = wxEmptyString;
+              else
+                new_msg = wxString( StringValuePtr(rb_msg), wxConvUTF8 );
+          
+              if ( $self->Update(value, new_msg) )
+                return Qtrue;
+              else
+                return Qfalse;
+            }
+          
+            VALUE update_and_check(int value, VALUE rb_msg = Qnil)
+            {
+              VALUE ret = rb_ary_new();
+          
+              wxString new_msg;
+              if ( rb_msg == Qnil )
+                new_msg = wxEmptyString;
+              else
+                new_msg = wxString( StringValuePtr(rb_msg), wxConvUTF8 );
+          
+              bool skip = false;
+              if ( $self->Update(value, new_msg, &skip) )
+                rb_ary_push(ret, Qtrue);
+              else 
+                rb_ary_push(ret, Qfalse);
+          
+              rb_ary_push(ret, ( skip ? Qtrue : Qfalse) );
+          
+              return ret;
+            }
+            __HEREDOC
+        when 'wxWizard'
+          # special handling
+          spec.ignore 'wxWizard::GetBitmap'
+          # add custom Ruby version
+          spec.add_extend_code 'wxWizard', <<~__HEREDOC
+            wxBitmap GetBitmap() const
+            {
+              return $self->GetBitmap();
+            }
+            __HEREDOC
+          # handled; can be suppressed
+          spec.suppress_warning(473,
+                                'wxWizard::GetCurrentPage',
+                                'wxWizard::GetPageAreaSizer')
+          spec.do_not_generate(:variables, :enums, :defines, :functions)
+        end
+      end
+    end # class Dialog
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/dir_filterlist_ctrl.rb

@@ -0,0 +1,29 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './ctrl_with_items'
+
+module WXRuby3
+
+  class Director
+
+    class DirFilterListCtrl < ControlWithItems
+
+      def setup
+        super
+        setup_ctrl_with_items('wxDirFilterListCtrl')
+        spec.override_inheritance_chain('wxDirFilterListCtrl',
+                                        %w[wxChoice
+                                           wxControlWithItems
+                                           wxControl
+                                           wxWindow
+                                           wxEvtHandler
+                                           wxObject])
+      end
+    end # class DirFilterListCtrl
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/dir_picker_ctrl.rb

@@ -0,0 +1,22 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class DirPickerCtrl < Window
+
+      def setup
+        super
+        spec.do_not_generate(:variables, :defines, :enums, :functions) # with FileDirPickerEvent
+      end
+    end # class DirPickerCtrl
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/drag_image.rb

@@ -0,0 +1,20 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class DragImage < Director
+
+      def setup
+        spec.set_only_for('__WXUNIVERSAL__', 'wxDragImage::DoDrawImage', 'wxDragImage::GetImageRect', 'wxDragImage::UpdateBackingFromWindow')
+        super
+      end
+    end # class DragImage
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/dragdrop.rb

@@ -0,0 +1,61 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class DragDrop < Director
+
+      def setup
+        super
+        spec.items.replace %w[wxDropSource wxDropTarget wxFileDropTarget wxTextDropTarget dnd.h]
+        spec.gc_as_object
+        # wxWidgets will free the DataObject once it's owned by DropSource or DropTarget
+        spec.disown 'wxDataObject* data'
+        # special mark functions to preserve Ruby object during GC
+        spec.add_header_code <<~__HEREDOC
+          static void mark_wxDropTarget(void* ptr) 
+          {
+            if ( GC_IsWindowDeleted(ptr) ) return;
+            
+            wxDropTarget* drop_tgt = (wxDropTarget*)ptr;
+            wxDataObject* data_obj = drop_tgt->GetDataObject();
+            if ( data_obj )
+              rb_gc_mark( SWIG_RubyInstanceFor(data_obj) );
+          }
+
+          static void mark_wxDropSource(void* ptr) 
+          {
+            if ( GC_IsWindowDeleted(ptr) ) return;
+            
+            wxDropSource* drop_src = (wxDropSource*)ptr;
+            wxDataObject* data_obj = drop_src->GetDataObject();
+            if ( data_obj )
+              rb_gc_mark( SWIG_RubyInstanceFor(data_obj) );
+          }
+          __HEREDOC
+        spec.add_swig_code '%markfunc wxDropSource "mark_wxDropSource";',
+                           '%markfunc wxDropTarget "mark_wxDropTarget";'
+        spec.extend_interface 'wxDropSource', 'virtual ~wxDropSource()' # correct interface omission
+        spec.ignore %w[wxFileDropTarget::OnDrop wxTextDropTarget::OnDrop]
+        spec.no_proxy %w[wxFileDropTarget::OnDrop wxFileDropTarget::OnData]
+        spec.no_proxy %w[wxTextDropTarget::OnDrop wxTextDropTarget::OnData]
+        # type mapping for wxFileDropTarget::OnDropFiles
+        spec.map 'const wxArrayString&' => 'Array<String>' do
+          map_directorin code: <<~__CODE
+            $input = rb_ary_new();
+            for (size_t i = 0; i < $1.GetCount(); i++)
+            {
+              rb_ary_push($input, WXSTR_TO_RSTR($1.Item(i)));
+            }
+            __CODE
+        end
+      end
+    end # class DragDrop
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/editable_listbox.rb

@@ -0,0 +1,21 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class EditableListBox < Window
+
+      def setup
+        super
+      end
+    end # class EditableListBox
+
+  end # class Director
+
+end # module WXRuby3