wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/director/aui_toolbar_item.rb

@@ -0,0 +1,21 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class AuiToolBarItem < Director
+
+      def setup
+        super
+        spec.gc_as_object
+        spec.do_not_generate(:variables, :defines, :enums, :functions)
+      end
+    end # class AuiToolBarItem
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/bitmap.rb

@@ -0,0 +1,87 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Bitmap < Director
+
+      def setup
+        spec.items << 'wxBitmapBundle' << 'wxMask'
+        spec.gc_as_object 'wxBitmapBundle'
+        spec.require_app 'wxBitmap',
+                         'wxBitmapBundle',
+                         'wxMask'
+        spec.ignore 'wxBitmapBundle::FromSVG(char *,const wxSize &)'
+        # not useful in Ruby
+        spec.ignore 'wxBitmapBundle::wxBitmapBundle(const char * const *)'
+        # disable the wxBitmapBundle typemap for the copy constructor
+        spec.map_disable 'const wxBitmapBundle&'
+        # add typemap for bitmap vectors
+        spec.map 'const wxVector<wxBitmap> &' do
+          map_in from: 'Array<Wx::Bitmap>', temp: 'wxVector<wxBitmap> tmpVec', code: <<~__CODE
+            $1 = &tmpVec;
+            if (TYPE($input) == T_ARRAY)
+            {
+              for (int i = 0; i < RARRAY_LEN($input); i++)
+              {
+                void* ptr;
+                VALUE obj = rb_ary_entry($input, i);
+                int res = SWIG_ConvertPtr(obj, &ptr, SWIGTYPE_p_wxBitmap, 0);
+                if (!SWIG_IsOK(res)) 
+                {
+                  SWIG_exception_fail(SWIG_ArgError(res), "Expected array of Wx::Bitmap for argument 1"); 
+                }
+                tmpVec.push_back (*static_cast<wxBitmap*> (ptr));
+              }
+            }
+            else
+            {
+              SWIG_exception_fail(SWIG_TypeError, "Wrong type for $1_basetype parameter $argnum");
+            }
+            __CODE
+        end
+        spec.no_proxy 'wxBitmap'
+        # Handler functions are not needed in wxRuby - all standard handlers
+        # are loaded at startup, and we don't allow custom image handlers to be
+        # written in Ruby. Should someone want to add these methods, it will
+        # also require fixing freearg typemap for wxString to free correctly in
+        # static methods
+        spec.ignore %w[
+          wxBitmap::AddHandler
+          wxBitmap::CleanUpHandlers
+          wxBitmap::FindHandler
+          wxBitmap::GetHandlers
+          wxBitmap::InitStandardHandlers
+          wxBitmap::InsertHandler
+          wxBitmap::RemoveHandler
+          wxBitmap::NewFromPNGData
+          ]
+        # problematic and not really useful in Ruby
+        spec.ignore('wxBitmap::wxBitmap(const char[],int,int,int)',
+                    'wxBitmap::wxBitmap(const char *const *)')
+        # wxPalette not supported in wxRuby
+        spec.ignore 'wxBitmap::SetPalette',
+                    'wxBitmap::GetPalette'
+        if Config.instance.platform == :mingw
+          spec.ignore 'wxBitmap::UseAlpha'
+          spec.add_extend_code 'wxBitmap', <<~__HEREDOC
+            // wxw documentation incorrectly declares this method
+            // with a 'bool' return type which should be void
+            void use_alpha(bool val)
+            {
+              $self->UseAlpha(val);
+            }
+            __HEREDOC
+        end
+        spec.disown 'wxMask* mask'
+        super
+      end
+    end # class Bitmap
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/book_ctrls.rb

@@ -0,0 +1,104 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class BookCtrls < Window
+
+      def setup
+        super
+        # Protect panels etc added as Toolbook pages from being GC'd by Ruby;
+        # avoids double-free segfaults on exit on GTK
+        spec.map_apply 'SWIGTYPE *DISOWN' => 'wxWindow* page'
+        # but not for const args (query methods)
+        spec.map_apply 'SWIGTYPE *' => 'const wxWindow* page'
+
+        case spec.module_name
+        when 'wxBookCtrlBase'
+          spec.make_abstract 'wxBookCtrlBase'
+          spec.items.replace %w[wxBookCtrlBase bookctrl.h]
+          # add fully implemented noop base class for director
+          spec.add_header_code <<~__HEREDOC
+            class WXRubyBookCtrlBase : public wxBookCtrlBase
+            {
+            public:
+              WXRubyBookCtrlBase () : wxBookCtrlBase() {}
+              WXRubyBookCtrlBase(wxWindow *parent,
+                                 wxWindowID winid,
+                                 const wxPoint& pos = wxDefaultPosition,
+                                 const wxSize& size = wxDefaultSize,
+                                 long style = 0,
+                                 const wxString& name = wxEmptyString)
+                : wxBookCtrlBase(parent, winid, pos, size, style, name) 
+              {}
+              virtual bool SetPageText(size_t, const wxString&) { return false; }
+              virtual wxString GetPageText(size_t) const { return wxString(); }
+
+              virtual int GetPageImage(size_t) const { return -1; }
+              virtual bool SetPageImage(size_t, int) { return false; }
+
+              virtual bool InsertPage(size_t,
+                                      wxWindow *,
+                                      const wxString&,
+                                      bool = false,
+                                      int = NO_IMAGE) { return false; }
+          
+              virtual int SetSelection(size_t) { return -1; }
+              virtual int ChangeSelection(size_t) { return -1; }
+
+            protected:
+              virtual wxWindow *DoRemovePage(size_t) { return NULL; } 
+            };
+            __HEREDOC
+          spec.use_class_implementation 'wxBookCtrlBase', 'WXRubyBookCtrlBase'
+          spec.ignore 'wxBookCtrl' # useless define in bookctrl.h doc
+          spec.override_inheritance_chain('wxBookCtrlBase', %w[wxControl wxWindow wxEvtHandler wxObject])
+          #spec.no_proxy('wxBookCtrlBase')
+          # argout for HitTest
+          spec.map_apply 'long *OUTPUT' => 'long *flags'
+          # mixin WithImages
+          spec.include_mixin 'wxBookCtrlBase', 'Wx::WithImages'
+        when 'wxNotebook'
+          spec.ignore("wxNotebook::OnSelChange")
+          # this reimplemented window base method need to be properly wrapped but
+          # is missing from the XML docs
+          spec.extend_interface('wxNotebook', 'virtual void OnInternalIdle()')
+          spec.override_inheritance_chain(spec.module_name, %w[wxBookCtrlBase wxControl wxWindow wxEvtHandler wxObject])
+        when 'wxToolbook', 'wxListbook', 'wxChoicebook', 'wxSimplebook'
+          setup_book_ctrl_class(spec.module_name)
+          spec.force_proxy(spec.module_name)
+        when 'wxTreebook'
+          setup_book_ctrl_class(spec.module_name)
+          spec.force_proxy(spec.module_name)
+          # add public API missing from docs (essential for better control of tree control)
+          spec.extend_interface 'wxTreebook', 'wxTreeCtrl* GetTreeCtrl() const'
+        end
+      end
+      
+      def setup_book_ctrl_class(clsnm)
+        spec.override_inheritance_chain(clsnm, %w[wxBookCtrlBase wxControl wxWindow wxEvtHandler wxObject])
+        # add implemented overloads missing from docs
+        spec.extend_interface clsnm,
+                              'virtual int GetPageImage(size_t nPage) const',
+                              'virtual bool SetPageImage(size_t page, int image)',
+                              'virtual wxString GetPageText(size_t nPage) const',
+                              'virtual bool SetPageText(size_t page, const wxString &text)',
+                              'virtual int SetSelection(size_t page)',
+                              'virtual int ChangeSelection(size_t page)'
+        unless spec.module_name == 'wxTreebook'
+          spec.extend_interface clsnm,
+                                'virtual int GetSelection() const',
+                                'virtual bool InsertPage(size_t index, wxWindow *page, const wxString &text, bool select=false, int imageId=NO_IMAGE)'
+        end
+      end
+    end # class Object
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/brush.rb

@@ -0,0 +1,28 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Brush < Director
+
+      def setup
+        super
+        spec.disable_proxies
+        # all but the default ctor require a running App
+        spec.require_app 'wxBrush::wxBrush(const wxColour &colour, wxBrushStyle style)',
+                         'wxBrush::wxBrush(const wxBitmap &stippleBitmap)',
+                         'wxBrush::wxBrush(const wxBrush &brush)'
+        # these are defined and loaded in RubyStockObjects.i
+        spec.ignore %w[
+          wxBLUE_BRUSH wxGREEN_BRUSH wxYELLOW_BRUSH wxWHITE_BRUSH wxBLACK_BRUSH wxGREY_BRUSH
+          wxMEDIUM_GREY_BRUSH wxLIGHT_GREY_BRUSH wxTRANSPARENT_BRUSH wxCYAN_BRUSH wxRED_BRUSH wxTheBrushList]
+      end
+    end # class Brush
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/busy_info.rb

@@ -0,0 +1,71 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class BusyInfo < Director
+
+      def setup
+        super
+        spec.items << 'wxBusyInfoFlags'
+        spec.disable_proxies
+        spec.gc_as_temporary 'wxBusyInfoFlags'
+        # again C++ type guards do not work with Ruby
+        # need to Rubify this
+        spec.make_abstract 'wxBusyInfo'
+        spec.ignore %w[
+          wxBusyInfo::wxBusyInfo
+          ]
+        # BusyInfo is an exception to the general rule in typemap.i - it
+        # accepts a wxWindow* parent argument which may be null - but it does
+        # not inherit from TopLevelWindow - so special typemap for this class.
+        spec.map 'wxWindow* parent' do
+          map_check code: <<~__CODE
+            if ( !wxRuby_IsAppRunning() )
+            { 
+              rb_raise(rb_eRuntimeError,
+                   "Cannot create BusyInfo before App.main_loop has been called");
+            }
+            __CODE
+        end
+        spec.add_extend_code 'wxBusyInfo', <<~__HEREDOC
+          static VALUE busy(const wxString& message, wxWindow *parent = NULL)
+          {
+            VALUE rb_busyinfo = Qnil;
+            wxBusyInfo *p_busyinfo = 0 ;
+            if (rb_block_given_p())
+            {
+              wxBusyInfo disabler(message,parent);
+              p_busyinfo = &disabler;
+              rb_busyinfo = SWIG_NewPointerObj(SWIG_as_voidptr(p_busyinfo), SWIGTYPE_p_wxBusyInfo, 0 |  0 );
+              return rb_yield(rb_busyinfo);
+            }
+            return Qnil;
+          }
+          static VALUE busy(const wxBusyInfoFlags &flags)
+          {
+            VALUE rb_busyinfo = Qnil;
+            wxBusyInfo *p_busyinfo = 0 ;
+            if (rb_block_given_p())
+            {
+              wxBusyInfo disabler(flags);
+              p_busyinfo = &disabler;
+              rb_busyinfo = SWIG_NewPointerObj(SWIG_as_voidptr(p_busyinfo), SWIGTYPE_p_wxBusyInfo, 0 |  0 );
+              return rb_yield(rb_busyinfo);
+            }
+            return Qnil;
+          }
+          __HEREDOC
+        spec.map 'wxBusyInfoFlags &' => 'Wx::BusyInfoFlags' do
+          map_out code: '$result = self; wxUnusedVar($1);'
+        end
+      end
+    end # class BusyInfo
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/button.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 Button < Window
+
+      def setup
+        spec.no_proxy %w[wxButton::SetDefault]
+        super
+      end
+    end # class Button
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/calendar_ctrl.rb

@@ -0,0 +1,98 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class CalendarCtrl < Window
+
+      include Typemap::DateTime
+
+      def setup
+        super
+        # for GetDataRange
+        spec.map 'wxDateTime *lowerdate, wxDateTime *upperdate' => 'Array(Time, Time), nil' do
+
+          map_in ignore: true, temp: 'wxDateTime lwrDt, wxDateTime hgrDt',
+                 code: 'arg2 = &lwrDt; arg3 = &hgrDt;'
+
+          map_argout code: <<~__CODE
+            if (result)
+            {
+              $result = rb_ary_new ();
+              rb_ary_push ($result, wxRuby_wxDateTimeToRuby(lwrDt$argnum));
+              rb_ary_push ($result, wxRuby_wxDateTimeToRuby(hgrDt$argnum));
+            }
+            else
+            {
+              $result = Qnil;
+            }
+            __CODE
+
+          # ignore C defined return value
+          map_out ignore: 'bool'
+
+          # just skip this; nothing to convert
+          map_directorin code: ''
+
+          # handle the Ruby style result
+          map_directorargout code: <<~__CODE
+            if (result != Qnil && TYPE(result) == T_ARRAY && RARRAY_LEN(result) == 2)
+            {
+              wxDateTime* tmpDT = wxRuby_wxDateTimeFromRuby(rb_ary_entry (result, 0));
+              *lowerdate = *tmpDT; delete tmpDT;
+              tmpDT = wxRuby_wxDateTimeFromRuby(rb_ary_entry (result, 1));
+              *upperdate = *tmpDT; delete tmpDT;
+              c_result = true;
+            }
+            else
+            {
+              c_result = false;
+            }
+          __CODE
+        end
+        # Custom implementation for Ruby
+        spec.ignore('wxCalendarCtrl::HitTest', ignore_doc: false)
+        # deprecated
+        spec.ignore 'wxCalendarCtrl::EnableYearChange'
+        # handled; can be suppressed
+        spec.suppress_warning(473,
+                              'wxCalendarCtrl::GetAttr',
+                              'wxCalendarCtrl::GetHeaderColourBg',
+                              'wxCalendarCtrl::GetHeaderColourFg',
+                              'wxCalendarCtrl::GetHighlightColourBg',
+                              'wxCalendarCtrl::GetHighlightColourFg',
+                              'wxCalendarCtrl::GetHolidayColourBg',
+                              'wxCalendarCtrl::GetHolidayColourFg')
+
+        # These are managed by the CalendarCtrl once set via set_attr
+        spec.disown 'wxCalendarDateAttr* attr'
+
+        spec.add_extend_code 'wxCalendarCtrl', <<~__HEREDOC
+        VALUE hit_test(wxPoint& pos)
+        {
+          wxDateTime hit_date;
+          wxDateTime::WeekDay hit_wkday;
+          wxCalendarHitTestResult hit = $self->HitTest(pos, &hit_date, &hit_wkday);
+          if ( hit == wxCAL_HITTEST_HEADER ) {
+            return(INT2NUM(hit_wkday));
+          }
+          else if ( hit == wxCAL_HITTEST_DAY ) {
+            return(wxRuby_wxDateTimeToRuby(hit_date));
+          }
+          // Assume that hit == wxCAL_HITTEST_NOWHERE
+          return Qnil;
+        }
+        __HEREDOC
+        spec.do_not_generate(:variables, :enums, :defines, :functions)
+      end
+    end # class CalendarCtrl
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/calendar_date_attr.rb

@@ -0,0 +1,22 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class CalendarDateAttr < Director
+
+      def setup
+        spec.gc_as_object
+        spec.add_swig_code 'enum wxCalendarDateBorder;'
+        spec.do_not_generate(:variables, :enums, :defines, :functions)
+        super
+      end
+    end # class CalendarDateAttr
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/caret.rb

@@ -0,0 +1,31 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Caret < Director
+
+      def setup
+        super
+        spec.gc_as_object 'wxCaret'
+        # all ctors require a running App
+        spec.require_app 'wxCaret'
+        # ignore method overloads that have no additional benefit  in Ruby
+        spec.ignore 'wxCaret::wxCaret(wxWindow*, int, int)',
+                    'wxCaret::Create(wxWindow*, int, int)',
+                    'wxCaret::GetPosition(int*, int*) const',
+                    'wxCaret::GetSize(int*, int*) const',
+                    'wxCaret::Move(int, int)',
+                    'wxCaret::SetSize(int, int)'
+        # prevent SWIG warning
+        spec.extend_interface 'wxCaret', 'virtual ~wxCaret();'
+      end
+    end # class Caret
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/check_listbox.rb

@@ -0,0 +1,33 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './ctrl_with_items'
+
+module WXRuby3
+
+  class Director
+
+    class CheckListBox < ControlWithItems
+
+      include Typemap::ArrayIntSelections
+
+      def setup
+        super
+        setup_ctrl_with_items('wxCheckListBox')
+        spec.override_inheritance_chain('wxCheckListBox',
+                                        %w[wxListBox
+                                           wxControlWithItems
+                                           wxControl
+                                           wxWindow
+                                           wxEvtHandler
+                                           wxObject])
+        spec.ignore('wxCheckListBox::Create(wxWindow *,wxWindowID, const wxPoint &,const wxSize &,int,const wxString[],long,const wxValidator &,const wxString &)')
+      end
+
+    end # class ListBox
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/choice.rb

@@ -0,0 +1,32 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './ctrl_with_items'
+
+module WXRuby3
+
+  class Director
+
+    class Choice < ControlWithItems
+
+      def setup
+        super
+        setup_ctrl_with_items('wxChoice')
+        spec.override_inheritance_chain('wxChoice',
+                                        %w[wxControlWithItems
+                                           wxControl
+                                           wxWindow
+                                           wxEvtHandler
+                                           wxObject])
+        # redundant with good typemaps
+        spec.ignore('wxChoice::wxChoice(wxWindow *,wxWindowID,const wxPoint &,const wxSize &,int,const wxString[],long,const wxValidator &,const wxString &)')
+        spec.ignore('wxChoice::Create(wxWindow *,wxWindowID,const wxPoint &,const wxSize &,int,const wxString[],long,const wxValidator &,const wxString &)')
+      end
+
+    end # class Choice
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/clipboard.rb

@@ -0,0 +1,37 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Clipboard < Director
+
+      include Typemap::DataFormat
+
+      def setup
+        super
+        spec.gc_never
+        # there is no need or support for clipboard derivatives
+        # not least because wxRuby only ever allows a single global clipboard
+        spec.disable_proxies
+        spec.make_abstract 'wxClipboard'
+        # After a data object has been set to the clipboard using set_data, it
+        # becomes owned by the clipboard and shouldn't be freed
+        spec.disown 'wxDataObject* data'
+        spec.add_extend_code 'wxClipboard', <<~__HEREDOC
+          // Provide access to the global clipboard; same clipboard must be used
+          // between calls to do data transfer properly.
+          static VALUE get_global_clipboard() 
+          {
+            return SWIG_NewPointerObj(wxTheClipboard, SWIGTYPE_p_wxClipboard, 0);
+          }
+          __HEREDOC
+      end
+    end # class Clipboard
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/collapsible_pane.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 CollapsiblePane < Window
+
+      def setup
+        super
+        spec.suppress_warning(473, 'wxCollapsiblePane::GetPane')
+      end
+    end # class CollapsiblePane
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/collapsible_pane_event.rb

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