| <html> |
| <head> |
| <title>SWIG:Examples:ruby:constants</title> |
| </head> |
| |
| <body bgcolor="#ffffff"> |
| |
| <tt>SWIG/Examples/ruby/constants/</tt> |
| <hr> |
| |
| <H2>Wrapping C Constants</H2> |
| |
| <p> |
| When SWIG encounters C preprocessor macros and C declarations that look like constants, |
| it creates Ruby constants with an identical value. Click <a href="example.i">here</a> |
| to see a SWIG interface with some constant declarations in it. |
| |
| <h2>Accessing Constants from Ruby</h2> |
| |
| Click <a href="run.rb">here</a> to see a script that prints out the values |
| of the constants contained in the above file. |
| |
| <h2>Key points</h2> |
| |
| <ul> |
| <li>The values of preprocessor macros are converted into Ruby constants. |
| <li>Types are inferred by syntax (e.g., "3" is an integer and "3.5" is a float). |
| <li>Character constants such as 'x' are converted into Ruby strings. |
| <li>C string literals such as "Hello World" are converted into Ruby strings. |
| <li>Macros that are not fully defined are simply ignored. For example: |
| <blockquote> |
| <pre> |
| #define EXTERN extern |
| </pre> |
| </blockquote> |
| is ignored because SWIG has no idea what type of variable this would be. |
| |
| <p> |
| <li>Expressions are allowed provided that all of their components are defined. Otherwise, the constant is ignored. |
| |
| <li>Certain C declarations involving 'const' are also turned into Ruby constants. |
| |
| <li>Constants that begin with lower case character are automatically capitalized. |
| For example: |
| <blockquote> |
| <pre> |
| const int iconst = 37; |
| </pre> |
| </blockquote> |
| is capitalized as <tt>Example::Iconst</tt> because Ruby constants name must begin |
| with upper case character. |
| |
| <li>The constants that appear in a SWIG interface file do not have to appear in any sort |
| of matching C source file since the creation of a constant does not require linkage |
| to a stored value (i.e., a value held in a C global variable or memory location). |
| |
| |
| </ul> |
| |
| <hr> |
| |
| |
| </body> |
| </html> |