thr3ads.net - wxruby development - [Wxruby-development] [794] trunk/wxruby2: Fix get_ruby_object so it works with SWIG tracking, move find_window

If this information is useful, please help other people find it:
Share via:
nobody at rubyforge.org
2006-Dec-23 03:04 UTC
[Wxruby-development] [794] trunk/wxruby2: Fix get_ruby_object so it works with SWIG tracking, move find_window_xx

<!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>[794] trunk/wxruby2: Fix get_ruby_object so it works with SWIG
tracking, move find_window_xx</title>
</head>
<body>

<div id="msg">
<dl>
<dt>Revision</dt> <dd>794</dd>
<dt>Author</dt> <dd>brokentoy</dd>
<dt>Date</dt> <dd>2006-12-22 22:04:53 -0500 (Fri, 22 Dec
2006)</dd>
</dl>

<h3>Log Message</h3>
<pre>Fix get_ruby_object so it works with SWIG tracking, move
find_window_xx
instance methods into ruby</pre>

<h3>Modified Paths</h3>
<ul>
<li><a
href="#trunkwxruby2libwxclasseswindowrb">trunk/wxruby2/lib/wx/classes/window.rb</a></li>
<li><a
href="#trunkwxruby2swigclassesWindowi">trunk/wxruby2/swig/classes/Window.i</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwxruby2libwxclasseswindowrb"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/lib/wx/classes/window.rb (793 => 794)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/lib/wx/classes/window.rb&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-21
00:09:12 UTC (rev 793)
+++
trunk/wxruby2/lib/wx/classes/window.rb&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-23
03:04:53 UTC (rev 794)
</span><span class="lines">@@ -2,8 +2,30 @@
</span><span class="cx"> # released under the MIT-style
wxruby2 license
</span><span class="cx"> 
</span><span class="cx"> class Wx::Window
</span><del>-  # create a DC for drawing on the window, run the
block passing in the DC
</del><ins>+  # Creates a device context which can be used for
drawing on the
+  # window, and passes it into a block. Note that this method should
+  # only be used within an on_paint handler.
</ins><span class="cx">   def paint
</span><span class="cx">     yield Wx::PaintDC.new(self)
</span><span class="cx">   end
</span><ins>+
+  # Recursively searches all windows below +self+ and returns the first
+  # window which has the id +an_id+. This corresponds to the find_window
+  # method method in WxWidgets when called with an integer.
+  def find_window_by_id(an_id)
+    Wx::Window.find_window_by_id(an_id, self)
+  end
+
+  # Searches all windows below +self+ and returns the first window which
+  # has the name +a_name+ This corresponds to the find_window method method
+  # in WxWidgets when called with an string.
+  def find_window_by_name(a_name)
+    Wx::Window.find_window_by_name(a_name, self)
+  end
+
+  # Searches all windows below +self+ and returns the first window which
+  # has the label +a_label+.
+  def find_window_by_label(a_label)
+    Wx:Window.find_window_by_label(a_label, self)
+  end
</ins><span class="cx"> end
</span></span></pre></div>
<a id="trunkwxruby2swigclassesWindowi"></a>
<div class="modfile"><h4>Modified:
trunk/wxruby2/swig/classes/Window.i (793 => 794)</h4>
<pre class="diff"><span>
<span class="info">---
trunk/wxruby2/swig/classes/Window.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-21
00:09:12 UTC (rev 793)
+++
trunk/wxruby2/swig/classes/Window.i&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp2006-12-23
03:04:53 UTC (rev 794)
</span><span class="lines">@@ -8,7 +8,6 @@
</span><span class="cx"> %ignore wxWindow::Clear;
</span><span class="cx"> %ignore wxWindow::GetAccessible;
</span><span class="cx"> %ignore
wxWindow::PopEventHandler;
</span><del>-# %ignore wxWindow::SetCaret;
</del><span class="cx"> 
</span><span class="cx"> // LayoutConstraints are
deprecated and not supported in WxRuby
</span><span class="cx"> %ignore wxWindow::SetConstraints;
</span><span class="lines">@@ -24,7 +23,7 @@
</span><span class="cx"> 
</span><span class="cx"> %apply int * INOUT { int *
x_INOUT, int * y_INOUT }
</span><span class="cx"> 
</span><del>-// Typemap for GetChildren
</del><ins>+// Typemap for GetChildren - casts wxObjects to correct
ruby wrappers
</ins><span class="cx"> %typemap(out) wxList& {
</span><span class="cx">   $result = rb_ary_new();
</span><span class="cx"> 
</span><span class="lines">@@ -37,38 +36,57 @@
</span><span class="cx">   }
</span><span class="cx"> }
</span><span class="cx"> 
</span><del>-// general-purpose function used to return ruby
wrappers around windows
-// whose type is not known in advance - as in find_window, get_children etc
-
-// TODO - doesn''t work correctly with object tracking - it should
return
-// the same Ruby object if the object has been seen before
-// use something like:
-//&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp 
returnVal = SWIG_NewPointerObj(obj, SWIGTYPE_p_wxWindow, 0);
-// but this causes problems for when a new Ruby object is needed - eg with XRC
</del><ins>+// Returns a ruby wrapper around a wxObject whose wx
class is not known
+// in advance - needed for find_window, get_children etc This is a bit
+// complicated because it must check if the ruby object already exists,
+// and if not, wrap it in the correct class, and ensure that future
+// calls return the same object.
</ins><span class="cx"> %{
</span><del>-static VALUE get_ruby_object(wxObject *obj)
</del><ins>+static VALUE get_ruby_object(wxObject *wx_obj)
</ins><span class="cx"> {
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif
( ! obj )
</del><ins>+  if ( ! wx_obj ) return Qnil;
+
+  // Get the wx class and the ruby class we are converting into  
+  wxString class_name( wx_obj->GetClassInfo()->GetClassName() );
+  VALUE r_class;
+  if ( class_name.Len() > 2 )
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp{
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
return Qnil;
</del><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
r_class = rb_iv_get(mWxruby2, class_name.mb_str() + 2);
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp}
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspVALUE
returnVal = Qnil;
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspwxString
classNameString(obj->GetClassInfo()->GetClassName());
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspif(classNameString.Len()
> 2)
</del><ins>+  else return Qnil;
+
+  // First, Try fetching a tracked (previously seen) object
+  VALUE r_obj = SWIG_RubyInstanceFor(wx_obj);
+  if ( r_obj != Qnil ) // Found a tracked object
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp{
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
VALUE ruby_class = rb_iv_get(mWxruby2, classNameString.mb_str()+2);
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp   
returnVal = Data_Wrap_Struct(ruby_class,0,0,obj);
</del><ins>+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
// Check the types match (see SWIG_NewPointerObj)
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  VALUE
r_swigtype = rb_iv_get(r_obj, "__swigtype__");
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp  if (
r_swigtype != Qnil && rb_obj_is_kind_of(r_obj, r_class) )
+&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspreturn
r_obj;
</ins><span class="cx">
&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp}
</span><del>-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp
-&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbsp&nbspreturn
returnVal;
</del><ins>+  
+  // Otherwise - no previously tracked object found - so wrap a new one.
+  // Get a string with the internal SWIG name tag of the class (eg _p_wxButton)
+  char *swigtype = (char *) malloc(3 + class_name.Len() + 1);
+  sprintf(swigtype, "_p_%s", (const char *)(class_name.mb_str()));
+  
+  // Wrap the object, tag its swigtype (core Wx type), and track it
+  // Imitates latter part of SWIG_NewPointerObj
+  r_obj = Data_Wrap_Struct(r_class, 0, 0, wx_obj);
+  rb_iv_set(r_obj, "__swigtype__", rb_str_new2(swigtype));
+  SWIG_RubyAddTracking(wx_obj, r_obj);
+  
+  free((void *) swigtype);
+  return r_obj;
</ins><span class="cx"> }
</span><span class="cx"> 
</span><span class="cx"> %}
</span><span class="cx"> 
</span><del>-# These are implemented below by hand so casting of
types are correct which is
-# very important when using XRC.
</del><ins>+// This is the instance method - implemented instead in
Ruby - see window.rb
</ins><span class="cx"> %ignore wxWindow::FindWindow;
</span><ins>+
+// These are class methods implemented below by hand so casting of types
+// is correct, which is very important when using XRC.
</ins><span class="cx"> %ignore wxWindow::FindWindowById;
</span><span class="cx"> %ignore
wxWindow::FindWindowByName;
</span><span class="cx"> %ignore
wxWindow::FindWindowByLabel;
</span><span class="lines">@@ -79,29 +97,10 @@
</span><span class="cx"> %include
"include/wxWindow.h"
</span><span class="cx"> 
</span><span class="cx"> %extend wxWindow {
</span><del>-  VALUE find_window(long  id)
-  {
-    VALUE returnVal = Qnil;
-    
-    wxObject* obj = self->FindWindow(id); 
-    returnVal = get_ruby_object(obj);
-  
-    return returnVal;    
-  }
-  
-  VALUE find_window(const wxString&  name)
-  {
-    VALUE returnVal = Qnil;
-    
-    wxObject* obj = self->FindWindow(name); 
-    returnVal = get_ruby_object(obj);
-  
-    return returnVal;    
-  }  
-  
</del><span class="cx">   static VALUE
find_window_by_id(long  id , wxWindow* parent = NULL)
</span><span class="cx">   {
</span><span class="cx">     VALUE returnVal = Qnil;
</span><ins>+
</ins><span class="cx">     wxObject* obj =
wxWindow::FindWindowById(id,parent);
</span><span class="cx">     returnVal =
get_ruby_object(obj);
</span><span class="cx">   
</span><span class="lines">@@ -127,5 +126,4 @@
</span><span class="cx">   
</span><span class="cx">     return returnVal;    
</span><span class="cx">   }  
</span><del>-  
</del><span class="cx"> }
</span></span></pre>
</div>
</div>

</body>
</html>
Reasonably Related Threads

Search for more apparently analagous threads
wxruby development - Dec 2006 - [794] trunk/wxruby2: Fix get_ruby_object so it works with SWIG tracking, move find_window_xx

[Wxruby-development] [794] trunk/wxruby2: Fix get_ruby_object so it works with SWIG tracking, move find_window_xx

Reasonably Related Threads

Wisdom of the Ancients
