wxruby3 0.9.0.pre.beta.8

data/rakelib/lib/director/list_ctrl.rb

@@ -0,0 +1,197 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class ListCtrl < Window
+
+      def setup
+        spec.items << 'wxListItem' << 'wxItemAttr' << 'wxListView'
+        spec.gc_as_object('wxItemAttr')
+        spec.include 'wx/imaglist.h'
+
+        # for wxListItem
+
+        # These need to be dealt with below,
+        spec.ignore 'wxListItem::GetData() const'
+        # Only allow the void* version
+        spec.ignore 'wxListItem::SetData(long)'
+
+        spec.add_extend_code 'wxListItem', <<~__HEREDOC
+          VALUE get_data() 
+          {
+            VALUE rb_obj;
+            long data = self->GetData();
+            if ( data )
+            { rb_obj = (VALUE)data; }
+            else
+            { rb_obj = Qnil; }
+            return rb_obj;
+          }
+          __HEREDOC
+
+        # for wxListCtrl
+
+        # Ruby handles memory management - always use SetImageList
+        spec.ignore 'wxListCtrl::AssignImageList'
+        # for now, ignore this version as the added customization features
+        # have no added value without custom edit controls which we can't
+        # define in Ruby for this
+        spec.ignore 'wxListCtrl::EditLabel'
+        # add simplified non-virtual version
+        spec.add_extend_code 'wxListCtrl', <<~__HEREDOC
+          void EditLabel(long item)
+          {
+            // route to original method
+            (void)self->EditLabel(item);
+          }
+        __HEREDOC
+        spec.set_only_for 'wxHAS_LISTCTRL_COLUMN_ORDER',
+                          %w[wxListCtrl::GetColumnIndexFromOrder
+                             wxListCtrl::GetColumnOrder
+                             wxListCtrl::GetColumnsOrder
+                             wxListCtrl::SetColumnsOrder]
+        # these are protected so ignored by defaylt but we want them here
+        spec.regard %w[
+            wxListCtrl::OnGetItemAttr
+            wxListCtrl::OnGetItemColumnAttr
+            wxListCtrl::OnGetItemColumnImage
+            wxListCtrl::OnGetItemImage
+            wxListCtrl::OnGetItemText
+            wxListCtrl::OnGetItemIsChecked
+          ]
+        # handled; can be suppressed
+        spec.suppress_warning(473,
+                              'wxListCtrl::OnGetItemAttr',
+                              'wxListCtrl::OnGetItemColumnAttr')
+        # this reimplemented window base method need to be properly wrapped but
+        # is missing from the XML docs
+        spec.extend_interface('wxListCtrl', 'virtual void OnInternalIdle()')
+        # dealt with below
+        spec.ignore 'wxListCtrl::GetItem(wxListItem &) const',
+                    'wxListCtrl::GetItemData',
+                    'wxListCtrl::SetItemData',
+                    'wxListCtrl::SetItemPtrData',
+                    'wxListCtrl::SortItems'
+        # required for GetItemRect and GetSubItemRect
+        spec.map 'wxRect &rect' => 'Wx::Rect' do
+          map_in ignore: true, code: '$1 = new wxRect();'
+          map_argout code: '$result = SWIG_NewPointerObj($1, SWIGTYPE_p_wxRect, 1);'
+        end
+        # required for hit_test, return flags as second part of array return value
+        spec.map_apply 'int *OUTPUT' => 'int& flags'
+        # and ignore ptrSubItem argument (always pass NULL)
+        spec.map 'long *ptrSubItem' do
+          map_in ignore: true, code: ''
+        end
+        spec.add_swig_code '%markfunc wxListCtrl "GC_mark_wxListCtrl";'
+        spec.add_swig_code '%markfunc wxListView "GC_mark_wxListCtrl";'
+        spec.add_header_code <<~__HEREDOC
+          // Helper code for SortItems - yields the two items being compared into
+          // the associated block, and get an integer return value
+          int wxCALLBACK wxListCtrl_SortByYielding(wxIntPtr item1, wxIntPtr item2, wxIntPtr data)
+          {
+            VALUE items = rb_ary_new();
+            rb_ary_push(items, (VALUE)item1);
+            rb_ary_push(items, (VALUE)item2);
+            VALUE the_order = rb_yield(items);
+            return NUM2INT(the_order);
+          }
+
+          // Prevents Ruby's GC sweeping up items that are stored as item data
+          static void GC_mark_wxListCtrl(void* ptr) 
+          {
+            if ( GC_IsWindowDeleted(ptr) )
+            {
+              return;
+            }
+            // Do standard marking routines as for all wxWindows
+            GC_mark_wxWindow(ptr);
+            
+            wxListCtrl* wx_lc = (wxListCtrl*) ptr;
+            
+            // First check if there's ImageLists and mark if found
+            wxImageList* img_list;
+            img_list= wx_lc->GetImageList(wxIMAGE_LIST_NORMAL);
+            if ( img_list ) rb_gc_mark(SWIG_RubyInstanceFor(img_list));
+            img_list= wx_lc->GetImageList(wxIMAGE_LIST_SMALL);
+            if ( img_list ) rb_gc_mark(SWIG_RubyInstanceFor(img_list));
+            img_list= wx_lc->GetImageList(wxIMAGE_LIST_STATE);
+            if ( img_list ) rb_gc_mark(SWIG_RubyInstanceFor(img_list));
+            
+            // Don't try to mark item data for VIRTUAL listctrls
+            if ( wx_lc->GetWindowStyle() & wxLC_VIRTUAL )
+              return;
+            
+            int count = wx_lc->GetItemCount();
+            if ( count == 0 ) return;
+            
+            for (int i = 0; i < count; ++i)
+            {
+              wxUIntPtr data = wx_lc->GetItemData(i);
+              VALUE object = reinterpret_cast<VALUE> (data);
+              if ( object && object != Qnil ) 
+              {
+                rb_gc_mark(object);
+              }
+            }
+          }
+          __HEREDOC
+        spec.add_extend_code 'wxListCtrl', <<~__HEREDOC
+          VALUE get_item(int row, int col = -1)
+          {
+            VALUE returnVal = Qnil;
+            wxListItem *list_item = new wxListItem();
+            list_item->SetId(row);
+            if ( col != -1 )
+              list_item->SetColumn(col);
+            // We don't know what fields the ruby user might wish to access, so
+            // we fetch them all
+            list_item->SetMask(wxLIST_MASK_DATA|wxLIST_MASK_FORMAT|wxLIST_MASK_IMAGE|wxLIST_MASK_STATE|wxLIST_MASK_TEXT|wxLIST_MASK_WIDTH);
+        
+            bool success = self->GetItem(*list_item);
+            if ( success ) 
+              returnVal = SWIG_NewPointerObj(list_item, SWIGTYPE_p_wxListItem, 1);
+        
+            return returnVal;
+          }
+        
+          VALUE get_item_data(int row)
+          {
+            if ( row < 0 || row >= self->GetItemCount() ) return Qnil;
+            wxUIntPtr item_data = self->GetItemData(row);
+            if ( item_data == 0 ) return Qnil;
+            return reinterpret_cast<VALUE> (item_data);
+          }
+        
+          VALUE set_item_data(int row, VALUE ruby_obj)
+          {
+            if (row < 0 || row >= self->GetItemCount()) 
+            {
+              rb_raise(rb_eIndexError, "Uninitialized item");
+            }
+            wxUIntPtr item_data = reinterpret_cast<wxUIntPtr> (ruby_obj);
+            bool result = self->SetItemPtrData(row, item_data);
+            if ( result )
+              return Qtrue;
+            return Qnil;
+          }	
+          
+          void sort_items()
+          {
+            self->SortItems(wxListCtrl_SortByYielding, 0);
+          }
+          __HEREDOC
+        super
+      end
+    end # class ListCtrl
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/listbox.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 ListBox < ControlWithItems
+
+      include Typemap::ArrayIntSelections
+
+      def setup
+        super
+        setup_ctrl_with_items('wxListBox')
+        spec.override_inheritance_chain('wxListBox',
+                                        %w[wxControlWithItems
+                                           wxControl
+                                           wxWindow
+                                           wxEvtHandler
+                                           wxObject])
+        spec.ignore('wxListBox::InsertItems(unsigned int,const wxString *,unsigned int)')
+      end
+
+    end # class ListBox
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/locale.rb

@@ -0,0 +1,35 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Locale < Director
+
+      def setup
+        super
+        spec.disable_proxies
+        spec.items << 'wxLanguageInfo' << 'language.h'
+        spec.gc_as_object('wxLocale')
+        spec.gc_as_temporary('wxLanguageInfo')
+        spec.regard %w[
+          wxLanguageInfo::Language
+          wxLanguageInfo::LocaleTag
+          wxLanguageInfo::CanonicalName
+          wxLanguageInfo::CanonicalRef
+          wxLanguageInfo::Description
+          wxLanguageInfo::DescriptionNative
+          wxLanguageInfo::LayoutDirection
+          wxLanguageInfo::WinLang
+          wxLanguageInfo::WinSublang
+          ]
+        spec.set_only_for('__WIN32__', 'wxLanguageInfo::WinLang', 'wxLanguageInfo::WinSublang')
+      end
+    end # class Locale
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/log.rb

@@ -0,0 +1,32 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Log < Director
+
+      def setup
+        spec.gc_as_object
+        spec.items.concat(%w[wxLogBuffer wxLogChain wxLogGui wxLogStderr wxLogStream wxLogTextCtrl wxLogInterposer wxLogInterposerTemp wxLogWindow])
+        spec.no_proxy(%w[wxLogBuffer wxLogChain wxLogGui wxLogStderr wxLogTextCtrl wxLogInterposer wxLogInterposerTemp wxLogWindow])
+        spec.ignore 'wxLogBuffer::Flush'
+        spec.ignore 'wxLogGui::Flush'
+        if Config.instance.features_set?(%w[wxUSE_STD_IOSTREAM])
+          spec.ignore 'wxLogStream'
+        end
+        spec.ignore 'wxLog::SetThreadActiveTarget'
+        spec.disown 'wxLog *logtarget'
+        spec.do_not_generate(:functions)
+        spec.make_concrete('wxLog')
+        spec.extend_interface('wxLog', '  virtual ~wxLog ();')
+        super
+      end
+    end # class Log
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/mdi_frame.rb

@@ -0,0 +1,36 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './frame'
+
+module WXRuby3
+
+  class Director
+
+    class MDIFrame < Frame
+
+      def setup
+        spec.items.replace(%w[wxMDIParentFrame wxMDIChildFrame])
+        super
+        spec.no_proxy %w[
+          wxMDIParentFrame::GetActiveChild
+          wxMDIParentFrame::SetWindowMenu
+          wxMDIParentFrame::Tile
+          wxMDIParentFrame::Cascade]
+        # for GetClientWindow
+        spec.map 'wxMDIClientWindowBase *' => 'wxMDIClientWindow *' do
+          map_out code: <<~__HEREDOC
+            $result = SWIG_NewPointerObj(SWIG_as_voidptr($1), SWIGTYPE_p_wxMDIClientWindow, 0 |  0 );
+            __HEREDOC
+        end
+        spec.suppress_warning(473, 'wxMDIParentFrame::OnCreateClient')
+        spec.no_proxy %w[
+          wxMDIChildFrame::Activate]
+      end
+    end # class MDIFrame
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/media_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 MediaCtrl < Window
+
+      def setup
+        super
+        spec.do_not_generate :variables, :enums, :defines, :functions
+      end
+    end # class MediaCtrl
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/menu.rb

@@ -0,0 +1,92 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Menu < Director
+
+      def setup
+        spec.gc_never
+        spec.ignore 'wxMenu::wxMenu(long)'
+        spec.no_proxy 'wxMenu'  # do not support derived wxMenu classes
+        spec.add_header_code <<~__HEREDOC
+          // Custom subclass implementation. 
+          // Provides proper support for Ruby GC in destructor.
+          class wxRubyMenu : public wxMenu
+          {
+          public:
+            wxRubyMenu() : wxMenu() {}
+            wxRubyMenu(const wxString &title, long style=0) : wxMenu(title, style) {}
+            virtual ~wxRubyMenu()
+            {
+              SWIG_RubyUnlinkObjects(this);
+              SWIG_RubyRemoveTracking(this);
+            }
+          };
+        __HEREDOC
+        # make Ruby director and wrappers use custom implementation
+        spec.use_class_implementation('wxMenu', 'wxRubyMenu')
+        spec.rename_for_ruby(
+          'AppendItem' =>
+            'wxMenu::Append(wxMenuItem *item)')
+        # ignore non-const version as that has no benefits in Ruby
+        spec.ignore 'wxMenu::GetMenuItems()'
+        # Fix for GetMenuItems - converts list of MenuItems to Array
+        spec.map 'wxMenuItemList&' => 'Array<Wx::MenuItem>' do
+          map_out code: <<~__CODE
+            $result = rb_ary_new();
+            wxMenuItemList::iterator iter;
+            for (iter = $1->begin(); iter != $1->end(); ++iter)
+            {
+                wxMenuItem *wx_menu_item = *iter;
+                VALUE rb_menu_item = SWIG_NewPointerObj(SWIG_as_voidptr(wx_menu_item), 
+                                                        SWIGTYPE_p_wxMenuItem, 0);
+                rb_ary_push($result, rb_menu_item);
+            }
+            __CODE
+        end
+        spec.add_header_code <<~__HEREDOC
+          // Mark Function
+          // Need to protect MenuItems which are included in the Menu, including
+          // their associated sub-menus, recursively.
+          static void mark_wxMenu(void *ptr) 
+          {
+            if ( GC_IsWindowDeleted(ptr) )
+              return;
+        
+            wxMenu* menu = (wxMenu*)ptr;
+            wxMenuItemList menu_items = menu->GetMenuItems();
+            wxMenuItemList::iterator iter;
+            for (iter = menu_items.begin(); iter != menu_items.end(); ++iter)
+              {
+                wxMenuItem *item = *iter;
+                rb_gc_mark( SWIG_RubyInstanceFor(item) ); 
+                wxMenu* sub_menu = item->GetSubMenu();
+                if ( sub_menu)
+                  rb_gc_mark( SWIG_RubyInstanceFor(sub_menu) );
+              }
+            return;
+          }
+        __HEREDOC
+        spec.add_swig_code <<~__HEREDOC
+          %markfunc wxMenu "mark_wxMenu";
+          __HEREDOC
+        # fix SWIG's problems with const& return value
+        spec.ignore('wxMenu::GetTitle', ignore_doc: false) # keep doc
+        spec.add_extend_code 'wxMenu', <<~__HEREDOC
+          wxString* GetTitle() const {
+            wxString const& title = $self->GetTitle();
+            return &const_cast<wxString&> (title);
+          }
+          __HEREDOC
+        super
+      end
+    end # class Menu
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/menu_bar.rb

@@ -0,0 +1,28 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './window'
+
+module WXRuby3
+
+  class Director
+
+    class MenuBar < Window
+
+      def setup
+        spec.no_proxy('wxMenuBar::FindItem',
+                'wxMenuBar::Remove',
+                'wxMenuBar::Replace')
+        spec.ignore('wxMenuBar::wxMenuBar(size_t,wxMenu *[],const wxString[],long)',
+                'wxMenuBar::GetLabelTop',
+                'wxMenuBar::SetLabelTop',
+                'wxMenuBar::Refresh')
+        super
+      end
+    end # class MenuBar
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/menu_item.rb

@@ -0,0 +1,36 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class MenuItem < Director
+
+      def setup
+        # this assumes all MenuItem-s created by users will always be added to a menu
+        # (which seems acceptable as there is no use for menu items otherwise)
+        # if not the C++ item will never be deleted before the process terminates
+        # (but this goes for all object marked for GC_NEVER).
+        spec.gc_never
+        spec.ignore(%w[wxMenuItem::GetLabel wxMenuItem::GetName wxMenuItem::GetText wxMenuItem::SetText wxMenuItem::GetLabelFromText])
+        # ignore this as there is no implementation anymore
+        spec.ignore 'wxMenuItem::GetAccelFromString'
+        spec.set_only_for 'wxUSE_ACCEL', 'wxMenuItem::GetAccel'
+        spec.no_proxy 'wxMenuItem::GetAccel'
+        spec.ignore 'wxMenuItem::GetBitmap(bool)' # not portable
+        if Config.instance.wx_version >= '3.3.0'
+          spec.set_only_for '__WXMSW__',
+                            'wxMenuItem::SetBackgroundColour',
+                            'wxMenuItem::SetFont',
+                            'wxMenuItem::SetTextColour'
+        end
+        super
+      end
+    end # class MenuItem
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/mouse_state.rb

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

data/rakelib/lib/director/numeric_property_validator.rb

@@ -0,0 +1,38 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './event_handler'
+
+module WXRuby3
+
+  class Director
+
+    class NumericPropertyValidator < EvtHandler
+
+      def setup
+        super
+        # need a custom implementation to handle event handler proc cleanup
+        spec.add_header_code <<~__HEREDOC
+          class WXRubyNumericPropertyValidator : public wxNumericPropertyValidator
+          {
+          public:
+            WXRubyNumericPropertyValidator(NumericType numericType, int base=10) 
+              : wxNumericPropertyValidator(numericType, base) {}
+            virtual ~WXRubyNumericPropertyValidator() 
+            {
+              wxRuby_ReleaseEvtHandlerProcs(this);
+            }               
+          };
+        __HEREDOC
+        spec.use_class_implementation 'wxNumericPropertyValidator', 'WXRubyNumericPropertyValidator'
+        spec.no_proxy 'wxNumericPropertyValidator::Clone'
+        spec.do_not_generate :variables, :defines, :enums, :functions
+      end
+
+    end # class NumericPropertyValidator
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/object.rb

@@ -0,0 +1,32 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Object < Director
+
+      def setup
+        spec.make_abstract('wxObject')
+        spec.ignore %w[wxObject::Ref wxObject::UnRef wxObject::GetRefData wxObject::IsKindOf wxObject::GetClassInfo]
+        spec.no_proxy 'wxObject'
+        spec.add_extend_code 'wxObject', <<~__HEREDOC
+          // Returns the string name of the C++ wx class which this object is wrapping.
+          // The doubled wx_ name is to fool renamer.rb, which strips the wx_ prefix.
+          // The actual final method is called wx_class
+          VALUE wx_wx_class() {
+          wxString class_name( self->GetClassInfo()->GetClassName() );
+          VALUE rb_class_name = WXSTR_TO_RSTR(class_name);
+          return rb_class_name;
+          }
+          __HEREDOC
+        super
+      end
+    end # class Object
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/page_setup_dialog.rb

@@ -0,0 +1,30 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+require_relative './dialog'
+
+module WXRuby3
+
+  class Director
+
+    class PageSetupDialog < Director::Dialog
+
+      def setup
+        super
+        # make PageSetupDialog GC-safe
+        spec.ignore 'wxPageSetupDialog::GetPageSetupData'
+        spec.add_extend_code 'wxPageSetupDialog', <<~__HEREDOC
+          wxPageSetupDialogData* GetPageSetupData()
+          { return new wxPageSetupDialogData(self->GetPageSetupData()); }
+          void SetPageSetupData(const wxPageSetupDialogData& psdd)
+          { self->GetPageSetupData() = psdd; }
+          __HEREDOC
+        spec.new_object 'wxPageSetupDialog::GetPageSetupData'
+      end
+    end # class PageSetupDialog
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/palette.rb

@@ -0,0 +1,25 @@
+###
+# wxRuby3 wxWidgets interface director
+# Copyright (c) M.J.N. Corino, The Netherlands
+###
+
+module WXRuby3
+
+  class Director
+
+    class Palette < Director
+
+      def setup
+        super
+        spec.disable_proxies
+        if Config.instance.wx_port == :wxQT
+          # mismatched implementation which does nothing anyway
+          spec.ignore 'wxPalette::wxPalette(int, const unsigned char *, const unsigned char *, const unsigned char *)'
+          spec.ignore 'wxPalette::Create(int, const unsigned char *, const unsigned char *, const unsigned char *)'
+        end
+      end
+    end # class Palette
+
+  end # class Director
+
+end # module WXRuby3

data/rakelib/lib/director/panel.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 Panel < Window
+
+      def setup
+        super
+        spec.no_proxy 'wxPanel::Layout'
+      end
+    end # class Panel
+
+  end # class Director
+
+end # module WXRuby3