[Tutorial] SketchUp Ruby C Extension
-
@unknownuser said:
Shouldn't the C extension be protected by a sort of a "namespace"? I mean shouldn't
Point3d {};beSX_Ext_Point3D {};? If we have two diffetent DLL's, do their functions exist in a same 'space'
?No - only the Ruby modules, classes and methods you define - like in a normal Ruby Script. Everything else is isolated.
As you see in the init function:
<span class="syntaxdefault"><br />void Init_SX_Basics</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">void </span><span class="syntaxkeyword">)<br />{<br /> </span><span class="syntaxcomment">// Modules<br /> </span><span class="syntaxdefault">mSUExtTest </span><span class="syntaxkeyword">= </span><span class="syntaxdefault">rb_define_module</span><span class="syntaxkeyword">( </span><span class="syntaxstring">"SUExtTest" </span><span class="syntaxkeyword">);<br /> <br /> </span><span class="syntaxcomment">// Constants<br /> // > SUExtTest;;SX_BASIC_VERSION<br /> </span><span class="syntaxdefault">rb_define_const</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"SX_BASIC_VERSION"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">rb_str_new2</span><span class="syntaxkeyword">( </span><span class="syntaxstring">"0.1.0" </span><span class="syntaxkeyword">) );<br /> <br /> </span><span class="syntaxcomment">// Methods<br /> // > SUExtTest.foo<br /> </span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"foo"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">h_foobar</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">0 </span><span class="syntaxkeyword">);<br /> </span><span class="syntaxcomment">// > SUExtTest.multiply( number1, number2 )<br /> </span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"multiply"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">h_multiply</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">2 </span><span class="syntaxkeyword">);<br /> </span><span class="syntaxcomment">// > SUExtTest.pi_array( array )<br /> </span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"pi_array"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">h_pi_array</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">1 </span><span class="syntaxkeyword">);<br /> </span><span class="syntaxcomment">// > SUExtTest.random_points( size )<br /> </span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"random_points"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">h_random_points</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">1 </span><span class="syntaxkeyword">);<br /> </span><span class="syntaxcomment">// > SUExtTest.closest_distance( point_set1, point_set2 )<br /> </span><span class="syntaxdefault">rb_define_module_function</span><span class="syntaxkeyword">( </span><span class="syntaxdefault">mSUExtTest</span><span class="syntaxkeyword">, </span><span class="syntaxstring">"closest_distance"</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">h_closest_distance</span><span class="syntaxkeyword">, </span><span class="syntaxdefault">2 </span><span class="syntaxkeyword">);<br />}<br /> </span><span class="syntaxdefault"></span>It's the
rb_define_*that will make the extension share anything with the Ruby environment - everything else is isolated. -
Hi Guys.
First, I want to say that this project you have started is awesome. I had just decided I needed a ruby extension to get a speed boost for a plug-in project. I found a lot of tutorials on making extensions, but most were for either linux or for MS Visual Studio 6 on Windows. I'm not using either environment. I am on Windows 7 (64bit).
Sooooo, I have followed TBD's example program the best I can.
- I have downloaded the SUExt files.
- I have downloaded the Ruby Installer and Source per the SUExt readme file and installed Ruby.
- I have installed Pelles C.
I tried to open suext.ppj file and Pelles C kept throwing an error about "suext.obj is wrongly located in -path_to_project-". So I tried suext6.ppj and it seemed to be fine. It even seemed to build once I pointed Pelles C to where my Ruby installation was at.
From here I'm a little lost. Am I done? I brought up the irb and typed in: require 'path_to_project/suext.so'
The results were as follows:LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext
path_to_project\suext.so
from path_to_project\suext.so
from path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
from (irb):1
from :0What am I missing?
Thanks
-Chyn -
When you require a C Extension, do not include the file extension.
So instead of:
require 'path_to_project/suext.so'do:
require 'path_to_project/suext' -
Ok. That certainly changed things a little.
I type:
irb(main):002:0> require 'path_to_project\suext'and get back:
LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext
path_to_project\suext.so
from path_to_project\suext.so
from path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
from (irb):2
from :0 -
or
/
? -
Both. The '/'s and ''s that are in the post were copied and pasted. I didn't change any of them. Let me know if you want the original output. I just shortened the paths for readability.
-Chyn
-
TIG means try using this --> / <-- instead of that --> ** <-- in your
requirestatement. -
Ah. Gotchya now.
Nirg. Same result...
Anything else? Maybe is one of you guys have successfully built the example you could post it for download. That would make sure I've got my environment set up correctly.
-Chyn
-
How did you build it? Seems something has gotten confused and the path has gotten mixed into the name of the initializing procedure for the C Extension.
@chyn2000 said:
LoadError: 127: The specified procedure could not be found. - Init_path_to_project\suext
It tries to call a function named
Init_path_to_project\suext- where, given the namesuextit should be trying to callInit_suext. -
I built in Pelles C.
So, the path isn't hard coded in the program. I can place a copy of the suext.so on my d:\ and it changes the error out put to match:
irb(main):002:0> require 'D:\suext'
LoadError: 127: The specified procedure could not be found. - Init_D:\suext
D:\suext.so
from D:\suext.so
from d:/Ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:31:in `require'
from (irb):2
from :0Is there a specific directory I should have the file at?
-
%(#BF8000)[path_to_ruby/lib/ruby/site_ruby/1.8/rubygems/**custom_require.rb**]Why are you customizing the
require()method ?Try it WITHOUT loading this custom script...
-
@dan rathbun said:
Why are you customizing the require() method ?
He isn't - this is something done by RubyGems.
-
OK.. my bad.. N/M
-
@chyn2000 said:
irb(main):002:0> require 'D:\suext'
You did it again.
Use:
require "D:/suext"irb(main);001;0> require 'C;\SX_Basics' LoadError; 127; The specified procedure could not be found. - Init_C;\SX_Basics C;\SX_Basics.so from C;\SX_Basics.so from (irb);1 irb(main);002;0> require 'C;/SX_Basics' => true irb(main);003;0> -
Ok, I just built TBD's suext example using Visual Studio Express 2010.
In order to get the extension to require properly, I had to use:
require "SUExt"<-- note caserequire "suext"failed. -
@jim said:
Ok, I just built TBD's suext example using Visual Studio Express 2010.
In order to get the extension to require properly, I had to use:
require "SUExt"<-- note caserequire "suext"failed.Yep Jim. That was exactly it!
Thanks everyone. Let me know if there is anything I can do to help.
Actually, it occurs to me that we may want to start making a small library of math and geometry ruby extensions very targeted towards SU. Thoughts?
-Chyn
-
@chyn2000 said:
Actually, it occurs to me that we may want to start making a small library of math and geometry ruby extensions very targeted towards SU. Thoughts?
Not a bad idea. I had plans of doing some bezier functions.
-
@chyn2000 said:
Actually, it occurs to me that we may want to start making a small library of math and geometry ruby extensions very targeted towards SU. Thoughts?
Maybe wrapping up an existing library for SketchUp/Ruby would be a way to go? Here's some interesting ones:
[1] http://vcg.sourceforge.net/index.php/Main_Page
[2] http://www.cgal.org/
[3] http://ptex.us/
[4] http://code.google.com/p/ruby-sketchup-sdk/
[5] http://www.visilibity.org/ -
I was so excited to discover that someone was building Sketchup extensions with Visual Studio 2010 - that's exactly what I need to do - unfortunately, after going through the whole process, I can't seem to successfully load the SX_HelloWorld module:
require 'SX_HelloWorld' Error; #<LoadError; C;/Program Files/Google/Google SketchUp 8/Plugins/SX_HelloWorld.so; 126; The specified module could not be found. - C;/Program Files/Google/Google SketchUp 8/Plugins/SX_HelloWorld.so> (eval) (eval);0Notice this is not a situation where the file is missing - that produces a similar but different error message.
After some Googling it seemed like missing .so's are sometimes the culprit, so I tried copying over some from my Ruby build directory (win32ole.so and Win32API.so), but it didn't help. Finally I tried running Sketchup from the VS2010 command line shell - this resulted in the infamous "bugsplat".
I'm at my wit's end here... any ideas?
Thanks,
Jeff
PS: My Ruby install gives RUBY_PLATFORM=i386-mswin32_100, RUBY_VERSION=1.8.6; Sketchup gives RUBY_PLATFORM=i386-mswin32 and the same version -
FYI: When
requireloads a shared object library file (and not a ruby script,)
therequire(filepath)method looks for a C function named:
"Init_" + File.basename( filepath, File.extname(filepath) )
and runs it after loading the shared library.This means that named C function must exist (even if it does nothing,) and must be named exactly as the file is named (CASE SENSITIVE.) If an enduser renames the so (or dll, dylib, etc.,) file later (including changing the case of any characters,) then loading the library file with
require()will fail. (usually resulting in a "entry point not found" error.)
Advertisement