jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added the -globalmodule command-line option for the Ruby module, which

Browse source 
allows the user to wrap all classes, methods and constants directly into
the global module (i.e. the Kernel module) instead of a named, nested
module.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@4706 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Logan Johnson 2003-04-25 16:03:50 +00:00
commit efd8f86d89
4 changed files with 27 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

23
Doc/Manual/Ruby.html
View file

@ -211,8 +211,7 @@ Ruby <i>module</i> names must be capitalized, but the convention for Ruby
<i>feature</i> names is to use lowercase names. So, for example, the <b>Etc</b>
extension module is imported by requiring the <b>etc</b> feature:
<pre><blockquote>
# The feature name begins with a lowercase letter...
<pre><blockquote># The feature name begins with a lowercase letter...
require 'etc'
# ... but the module name begins with an uppercase letter
@ -224,8 +223,7 @@ To stay consistent with this practice, you should always specify a
SWIG will automatically correct the resulting Ruby module name for your
extension. So for example, a SWIG interface file that begins with:
<pre><blockquote>
%module example
<pre><blockquote>%module example
</blockquote></pre>
will result in an extension module using the feature name "example" and
@ -364,9 +362,20 @@ nested directly under the global module. You can specify a more deeply nested
module by specifying the fully-qualified module name in quotes, e.g.
<blockquote><pre>%module "Foo::Bar::Spam"</pre></blockquote>
When choosing a module name, do not use the same
name as a built-in Ruby command or standard module name, the results may be
unpredictable.
Starting with SWIG 1.3.20, you can also choose to wrap everything into the global
module by specifying the <tt>-globalmodule</tt> option on the SWIG command line, i.e.
<blockquote><pre>$ <b>swig -ruby -globalmodule example.i</b></pre></blockquote>
Note that this does not relieve you of the requirement of specifying the SWIG
module name with the <tt>%module</tt> directive (or the <tt>-module</tt>
command-line option) as described earlier.<p>
When choosing a module name, do not use the same name as a built-in Ruby command
or standard module name, as the results may be unpredictable. Similarly, if you're
using the <tt>-globalmodule</tt> option to wrap everything into the global module,
take care that the names of your constants, classes and methods don't conflict
with any of Ruby's built-in names.
<a name="n13"></a><H3>20.3.2 Functions</H3>