nobody at rubyforge.org
2007-Jul-21 11:08 UTC
[Wxruby-development] [1127] trunk/wxruby2: Move shared C++ GC functions into separate file included into wx.i
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!-- #msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; } #msg dt { float: left; width: 6em; font-weight: bold; } #msg dt:after { content:'':'';} #msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; } #msg dl a { font-weight: bold} #msg dl a:link { color:#fc3; } #msg dl a:active { color:#ff0; } #msg dl a:visited { color:#cc6; } h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; } #msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; } #msg ul, pre { overflow: auto; } #header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; } #patch { width: 100%; } #patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;} #patch .propset h4, #patch .binary h4 {margin:0;} #patch pre {padding:0;line-height:1.2em;margin:0;} #patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;} #patch .propset .diff, #patch .binary .diff {padding:10px 0;} #patch span {display:block;padding:0 10px;} #patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;} #patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;} #patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;} #patch .lines, .info {color:#888;background:#fff;} --></style> <title>[1127] trunk/wxruby2: Move shared C++ GC functions into separate file included into wx.i</title> </head> <body> <div id="msg"> <dl> <dt>Revision</dt> <dd>1127</dd> <dt>Author</dt> <dd>brokentoy</dd> <dt>Date</dt> <dd>2007-07-21 07:08:38 -0400 (Sat, 21 Jul 2007)</dd> </dl> <h3>Log Message</h3> <pre>Move shared C++ GC functions into separate file included into wx.i</pre> <h3>Modified Paths</h3> <ul> <li><a href="#trunkwxruby2rakerakewxrb">trunk/wxruby2/rake/rakewx.rb</a></li> <li><a href="#trunkwxruby2swigwxi">trunk/wxruby2/swig/wx.i</a></li> </ul> <h3>Added Paths</h3> <ul> <li><a href="#trunkwxruby2swigmark_free_impli">trunk/wxruby2/swig/mark_free_impl.i</a></li> </ul> </div> <div id="patch"> <h3>Diff</h3> <a id="trunkwxruby2rakerakewxrb"></a> <div class="modfile"><h4>Modified: trunk/wxruby2/rake/rakewx.rb (1126 => 1127)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/rake/rakewx.rb        2007-07-20 21:21:08 UTC (rev 1126) +++ trunk/wxruby2/rake/rakewx.rb        2007-07-21 11:08:38 UTC (rev 1127) </span><span class="lines">@@ -28,7 +28,7 @@ </span><span class="cx"> $optional_dir = File.join($classes_dir, ''optional'') </span><span class="cx"> $optional_h_dir = File.join($optional_dir, ''include'') </span><span class="cx"> </span><del>-$swig_cmd = "swig" </del><ins>+$swig_cmd = ENV[''SWIGCMD''] || "swig" </ins><span class="cx"> $swig_options = '''' </span><span class="cx"> $swig_minimum_version = ''1.3.29'' </span><span class="cx"> </span><span class="lines">@@ -224,8 +224,7 @@ </span><span class="cx"> def create_swig_helper_task(base_name) </span><span class="cx"> cpp_file = cpp_file(base_name) </span><span class="cx"> swig_file = special_swig_file(base_name) </span><del>- - file(cpp_file => swig_file) do |t| </del><ins>+ file(cpp_file => swig_file ) do |t| </ins><span class="cx"> do_swig(swig_file, cpp_file, $swig_options) </span><span class="cx"> post_process(cpp_file, "fixmodule.rb") </span><span class="cx"> end </span><span class="lines">@@ -259,8 +258,8 @@ </span><span class="cx"> def create_swig_main_task(base_name) </span><span class="cx"> cpp_file = cpp_file(base_name) </span><span class="cx"> swig_file = special_swig_file(base_name) </span><del>- - file(cpp_file => swig_file) do |t| </del><ins>+ mark_free = special_swig_file("mark_free_impl") + file(cpp_file => [ swig_file, mark_free ] ) do |t| </ins><span class="cx"> do_swig(swig_file, cpp_file, "") </span><span class="cx"> post_process(cpp_file, "fixmainmodule.rb") </span><span class="cx"> add_initializers(cpp_file) </span></span></pre></div> <a id="trunkwxruby2swigmark_free_impli"></a> <div class="addfile"><h4>Added: trunk/wxruby2/swig/mark_free_impl.i (0 => 1127)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/swig/mark_free_impl.i         (rev 0) +++ trunk/wxruby2/swig/mark_free_impl.i        2007-07-21 11:08:38 UTC (rev 1127) </span><span class="lines">@@ -0,0 +1,133 @@ </span><ins>+// Copyright 2004-2007, WxRuby development team +// released under the MIT-style wxruby2 license + +// mark_free_impl.i - this contains the C++ implementation of various +// common GC-related functions, such as shared %mark functions and +// methods for checking and setting whether a wxWidgets window has been +// destroyed. It is compiled into wx.cpp. + + +%{ +static VALUE wx_destroyed_sym = rb_intern("@__wx_destroyed__"); + +// Code to be run when the ruby object is swept by GC - this only +// unlinks the C++ object from the ruby VALUE but doesn''t delete +// it because it is still needed and will be managed by WxWidgets. +void GcNullFreeFunc(void *ptr) +{ + SWIG_RubyRemoveTracking(ptr); +} + +// Tests if the window has been signalled as destroyed by a +// WindowDestroyEvent handled by wxRubyApp +bool GC_IsWindowDeleted(void *ptr) +{ + VALUE rb_win = SWIG_RubyInstanceFor(ptr); + if ( rb_ivar_defined(rb_win, wx_destroyed_sym ) ) +        return true; + else +        return false; +} + +// Notes that the window has been signalled as destroyed by a +// WindowDestroyEvent handled by wxRubyApp +void GC_SetWindowDeleted(void *ptr) +{ + VALUE rb_win = SWIG_RubyInstanceFor(ptr); + if ( rb_win != Qnil ) +        { +         rb_ivar_set(rb_win, wx_destroyed_sym, Qtrue); +        } +} + +// Carries out marking of Sizer objects belonging to a Wx::Window. Note +// that this isn''t done as a standard mark routine because ONLY sizers +// that are known to belong to a still-alive window should be marked, +// not those picked up as marked by in-scope variables by +// Ruby. Otherwise, segfaults may result. Because Sizers are SWIG +// directors, they must be preserved from GC. +void GC_mark_SizerBelongingToWindow(wxSizer *wx_sizer, VALUE rb_sizer) +{ + // First, mark this sizer + rb_gc_mark( rb_sizer ); + + // Then loop over hte sizer''s content and mark each sub-sizer in turn + wxSizerItemList& children = wx_sizer->GetChildren(); + for ( wxwxSizerItemListNode *node = children.GetFirst(); +                node; +                node = node->GetNext() ) +        { +         wxSizerItem* item = node->GetData(); +         wxSizer* child_sizer = item->GetSizer(); +         if ( child_sizer ) +                { +                 VALUE rb_child_sizer = SWIG_RubyInstanceFor(child_sizer); +                 if ( rb_child_sizer != Qnil ) +                        { GC_mark_SizerBelongingToWindow(child_sizer, rb_child_sizer); } +                } +        } + +} +// Similar to Sizers, MenuBar requires a special mark routine. This is +// because Wx::Menu is not a subclass of Window so isn''t automatically +// protected in the mark phase by Wx::App. However, the ruby object +// still must not be destroyed while it is still accessible on screen, +// because it may still handle events. Rather than a SWIG %markfunc, +// which can catch destroyed MenuBars linked to an in-scope ruby +// variable and cause segfaults, MenuBars are always marked via the +// containing Frame. +void GC_mark_MenuBarBelongingToFrame(wxMenuBar *menu_bar) +{ + rb_gc_mark( SWIG_RubyInstanceFor(menu_bar) ); + // Mark each menu in the menubar in turn + for ( int i = 0; i < menu_bar->GetMenuCount(); i++ ) +        { +         wxMenu* menu = menu_bar->GetMenu(i); +         rb_gc_mark( SWIG_RubyInstanceFor(menu) ); +        } + +} + +// Default mark routine for Windows - preserve the main sizer and caret +// belong to this window +void GC_mark_wxWindow(void *ptr) +{ + // can occasionally be NULL if called in an evt_create handler + if ( ! ptr ) return; + if ( GC_IsWindowDeleted(ptr) ) return; + + wxWindow* wx_win = (wxWindow*)ptr; + wxSizer* wx_sizer = wx_win->GetSizer(); + if ( wx_sizer ) +        { +         VALUE rb_sizer = SWIG_RubyInstanceFor(wx_sizer); +         if ( rb_sizer != Qnil ) +                GC_mark_SizerBelongingToWindow(wx_sizer, rb_sizer); +        } + + wxCaret* wx_caret = wx_win->GetCaret(); + if ( wx_caret ) +        { +         VALUE rb_caret = SWIG_RubyInstanceFor(wx_caret); +         rb_gc_mark(rb_caret); +        } +} + + +void GC_mark_wxFrame(void *ptr) +{ + if ( ! ptr ) return; + if ( GC_IsWindowDeleted(ptr) ) return; + + // Frames are also a subclass of wxWindow, so must do all the marking + // of sizers and carets associated with that class + GC_mark_wxWindow(ptr); + + wxFrame* wx_frame = (wxFrame*)ptr; + // Then mark the MenuBar, if one is associated with this Frame + + wxMenuBar* menu_bar = wx_frame->GetMenuBar(); + if ( menu_bar ) +        { GC_mark_MenuBarBelongingToFrame(menu_bar); } +} +%} </ins></span></pre></div> <a id="trunkwxruby2swigwxi"></a> <div class="modfile"><h4>Modified: trunk/wxruby2/swig/wx.i (1126 => 1127)</h4> <pre class="diff"><span> <span class="info">--- trunk/wxruby2/swig/wx.i        2007-07-20 21:21:08 UTC (rev 1126) +++ trunk/wxruby2/swig/wx.i        2007-07-21 11:08:38 UTC (rev 1127) </span><span class="lines">@@ -1,5 +1,5 @@ </span><del>-# Copyright 2004-2005 by Kevin Smith -# released under the MIT-style wxruby2 license </del><ins>+// Copyright 2004-2007, wxRuby development team +// released under the MIT-style wxruby2 license </ins><span class="cx"> </span><span class="cx"> %module(directors="1") wxruby2 </span><span class="cx"> </span><span class="lines">@@ -13,126 +13,10 @@ </span><span class="cx"> #include <wx/filesys.h> </span><span class="cx"> #include <wx/fs_zip.h> </span><span class="cx"> </span><del>-// Code to be run when the ruby object is swept by GC - this only -// unlinks the C++ object from the ruby VALUE but doesn''t delete -// it because it is still needed and will be managed by WxWidgets. -void GcNullFreeFunc(void *ptr) -{ - SWIG_RubyRemoveTracking(ptr); -} - -static VALUE wx_destroyed_sym = rb_intern("@__wx_destroyed__"); - -// Tests if the window has been signalled as destroyed by a -// WindowDestroyEvent handled by wxRubyApp -bool GC_IsWindowDeleted(void *ptr) -{ - VALUE rb_win = SWIG_RubyInstanceFor(ptr); - return ( rb_ivar_defined(rb_win, wx_destroyed_sym ) ); -} - -// Notes that the window has been signalled as destroyed by a -// WindowDestroyEvent handled by wxRubyApp -void GC_SetWindowDeleted(void *ptr) -{ - VALUE rb_win = SWIG_RubyInstanceFor(ptr); - if ( rb_win != Qnil ) -        rb_ivar_set(rb_win, wx_destroyed_sym, Qtrue); -} - -// Carries out marking of Sizer objects belonging to a Wx::Window. Note -// that this isn''t done as a standard mark routine because ONLY sizers -// that are known to belong to a still-alive window should be marked, -// not those picked up as marked by in-scope variables by -// Ruby. Otherwise, segfaults may result. Because Sizers are SWIG -// directors, they must be preserved from GC. -void GC_mark_SizerBelongingToWindow(wxSizer *wx_sizer, VALUE rb_sizer) -{ - // First, mark this sizer - rb_gc_mark( rb_sizer ); - - // Then loop over hte sizer''s content and mark each sub-sizer in turn - wxSizerItemList& children = wx_sizer->GetChildren(); - for ( wxwxSizerItemListNode *node = children.GetFirst(); -                node; -                node = node->GetNext() ) -        { -         wxSizerItem* item = node->GetData(); -         wxSizer* child_sizer = item->GetSizer(); -         if ( child_sizer ) -                { -                 VALUE rb_child_sizer = SWIG_RubyInstanceFor(child_sizer); -                 if ( rb_child_sizer != Qnil ) -                        { GC_mark_SizerBelongingToWindow(child_sizer, rb_child_sizer); } -                } -        } - -} -// Similar to Sizers, MenuBar requires a special mark routine. This is -// because Wx::Menu is not a subclass of Window so isn''t automatically -// protected in the mark phase by Wx::App. However, the ruby object -// still must not be destroyed while it is still accessible on screen, -// because it may still handle events. Rather than a SWIG %markfunc, -// which can catch destroyed MenuBars linked to an in-scope ruby -// variable and cause segfaults, MenuBars are always marked via the -// containing Frame. -void GC_mark_MenuBarBelongingToFrame(wxMenuBar *menu_bar) -{ - rb_gc_mark( SWIG_RubyInstanceFor(menu_bar) ); - // Mark each menu in the menubar in turn - for ( int i = 0; i < menu_bar->GetMenuCount(); i++ ) -        { -         wxMenu* menu = menu_bar->GetMenu(i); -         rb_gc_mark( SWIG_RubyInstanceFor(menu) ); -        } - -} - -// Default mark routine for Windows - preserve the main sizer and caret -// belong to this window -void GC_mark_wxWindow(void *ptr) -{ - // can occasionally be NULL if called in an evt_create handler - if ( ! ptr ) return; - if ( GC_IsWindowDeleted(ptr) ) return; - - wxWindow* wx_win = (wxWindow*)ptr; - wxSizer* wx_sizer = wx_win->GetSizer(); - if ( wx_sizer ) -        { -         VALUE rb_sizer = SWIG_RubyInstanceFor(wx_sizer); -         if ( rb_sizer != Qnil ) -                GC_mark_SizerBelongingToWindow(wx_sizer, rb_sizer); -        } - - wxCaret* wx_caret = wx_win->GetCaret(); - if ( wx_caret ) -        { -         VALUE rb_caret = SWIG_RubyInstanceFor(wx_caret); -         rb_gc_mark(rb_caret); -        } -} - - -void GC_mark_wxFrame(void *ptr) -{ - if ( ! ptr ) return; - if ( GC_IsWindowDeleted(ptr) ) return; - - // Frames are also a subclass of wxWindow, so must do all the marking - // of sizers and carets associated with that class - GC_mark_wxWindow(ptr); - - wxFrame* wx_frame = (wxFrame*)ptr; - // Then mark the MenuBar, if one is associated with this Frame - - wxMenuBar* menu_bar = wx_frame->GetMenuBar(); - if ( menu_bar ) -        { GC_mark_MenuBarBelongingToFrame(menu_bar); } -} - </del><span class="cx"> %} </span><span class="cx"> </span><ins>+%include "mark_free_impl.i" + </ins><span class="cx"> %init %{ </span><span class="cx"> </span><span class="cx"> extern void InitializeOtherModules(); </span></span></pre> </div> </div> </body> </html>
Apparently Analagous Threads
- [1135] trunk/wxruby2/swig/mark_free_impl.i: Convert from DOS to Unix newlines
- [1123] trunk/wxruby2/swig/wx.i: Check sizers being marked have a ruby rep and are not internal Wx-only,
- [1108] trunk/wxruby2/swig: Revised mem mgmt for Sizers to address more GC crashes in Sizers demo
- [1032] trunk/wxruby2/swig: Preserve Sizers associated with Windows from GC; fix several sample
- [1109] trunk/wxruby2/swig: Move marking of MenuBar from direct %markfunc to via mark_wxFrame, so