/tags/rel-1.3.35/Examples/ruby/index.html

# · HTML · 94 lines · 74 code · 20 blank · 0 comment · 0 complexity · 1be53227317a2386bde41187fa4b0c59 MD5 · raw file 

    

  1. <head>
    2. 

  2. <title>SWIG:Examples:ruby</title>
    3. 

  3. </head>
    4. 

  4. 

  5. <body bgcolor="#ffffff">
    6. 

  6. <H1>SWIG Ruby Examples</H1>
    7. 

  7. 

  8. <p>
    9. 

  9. The following examples illustrate the use of SWIG with Ruby.
    10. 

  10. 

  11. <ul>
    12. 

  12. <li><a href="simple/index.html">simple</a>.  A minimal example showing how SWIG can
    13. 

  13. be used to wrap a C function, a global variable, and a constant.
    14. 

  14. <li><a href="constants/index.html">constants</a>.  This shows how preprocessor macros and
    15. 

  15. certain C declarations are turned into constants.
    16. 

  16. <li><a href="variables/index.html">variables</a>. An example showing how to access C global variables from Ruby.
    17. 

  17. <li><a href="value/index.html">value</a>. How to pass and return structures by value.
    18. 

  18. <li><a href="class/index.html">class</a>. Wrapping a simple C++ class.
    19. 

  19. <li><a href="reference/index.html">reference</a>. C++ references.
    20. 

  20. <li><a href="pointer/index.html">pointer</a>. Simple pointer handling.
    21. 

  21. <li><a href="funcptr/index.html">funcptr</a>. Pointers to functions.
    22. 

  22. <li><a href="enum/index.html">enum</a>. Enumeration.
    23. 

  23. </ul>
    24. 

  24. 

  25. <h2>Compilation Issues</h2>
    26. 

  26. 

  27. <ul>
    28. 

  28. <li>To create a Ruby extension, SWIG is run with the following options:
    29. 

  29. 

  30. <blockquote>
    31. 

  31. <pre>
    32. 

  32. % swig -ruby interface.i
    33. 

  33. </pre>
    34. 

  34. </blockquote>
    35. 

  35. 

  36. <li>
    37. 

  37. Please see the <a href="../../Doc/Manual/Windows.html">Windows</a> page in the main manual for information on using the examples on Windows. <p>
    38. 

  38. </li>
    39. 

  39. 

  40. <li>On Unix the compilation of examples is done using the file <tt>Example/Makefile</tt>.  This
    41. 

  41. makefile performs a manual module compilation which is platform specific.  Typically,
    42. 

  42. the steps look like this (Linux):
    43. 

  43. 

  44. <blockquote>
    45. 

  45. <pre>
    46. 

  46. % swig -ruby interface.i
    47. 

  47. % gcc -fpic -c interface_wrap.c -I/usr/local/lib/ruby/1.4/i686-linux
    48. 

  48. % gcc -shared interface_wrap.o $(OBJS) -o interface.so 
    49. 

  49. % ruby
    50. 

  50. require 'interface'
    51. 

  51. Interface.blah(...)
    52. 

  52. ...
    53. 

  53. </pre>
    54. 

  54. </blockquote>
    55. 

  55. 

  56. <li>The politically "correct" way to compile a Ruby extension is to follow the steps
    57. 

  57. described <tt>README.EXT</tt> in Ruby distribution:
    58. 

  58. 

  59. <p>
    60. 

  60. <ol>
    61. 

  61. <li>Create a file called <tt>extconf.rb</tt> that looks like the following:
    62. 

  62. 

  63. <blockquote>
    64. 

  64. <pre>
    65. 

  65. require 'mkmf'
    66. 

  66. create_makefile('interface')
    67. 

  67. </pre>
    68. 

  68. </blockquote>
    69. 

  69. <li>Type the following to build the extension:
    70. 

  70. 

  71. <blockquote>
    72. 

  72. <pre>
    73. 

  73. % ruby extconf.rb
    74. 

  74. % make
    75. 

  75. </pre>
    76. 

  76. </blockquote>
    77. 

  77. </ol>
    78. 

  78. </ul>
    79. 

  79. 

  80. <h2>Compatibility</h2>
    81. 

  81. 

  82. The examples have been extensively tested on the following platforms:
    83. 

  83. 

  84. <ul>
    85. 

  85. <li>Linux
    86. 

  86. </ul>
    87. 

  87. 

  88. Your mileage may vary.  If you experience a problem, please let us know by 
    89. 

  89. contacting us on the <a href="http://www.swig.org/mail.html">mailing lists</a>.
    90. 

  90. </body>
    91. 

  91. </html>
    92.