summaryrefslogtreecommitdiff
path: root/Examples/perl5/constants
diff options
context:
space:
mode:
Diffstat (limited to 'Examples/perl5/constants')
-rw-r--r--Examples/perl5/constants/Makefile18
-rw-r--r--Examples/perl5/constants/example.i27
-rw-r--r--Examples/perl5/constants/index.html53
-rw-r--r--Examples/perl5/constants/runme.pl29
4 files changed, 127 insertions, 0 deletions
diff --git a/Examples/perl5/constants/Makefile b/Examples/perl5/constants/Makefile
new file mode 100644
index 0000000..576d2a0
--- /dev/null
+++ b/Examples/perl5/constants/Makefile
@@ -0,0 +1,18 @@
+TOP = ../..
+SWIG = $(TOP)/../preinst-swig
+SRCS =
+TARGET = example
+INTERFACE = example.i
+SWIGOPT =
+all::
+ $(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
+ SWIGOPT='$(SWIGOPT)' TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' perl5
+
+static::
+ $(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
+ SWIGOPT='$(SWIGOPT)' TARGET='myperl' INTERFACE='$(INTERFACE)' perl5_static
+
+clean::
+ $(MAKE) -f $(TOP)/Makefile perl5_clean
+
+check: all
diff --git a/Examples/perl5/constants/example.i b/Examples/perl5/constants/example.i
new file mode 100644
index 0000000..4f7b1a4
--- /dev/null
+++ b/Examples/perl5/constants/example.i
@@ -0,0 +1,27 @@
+/* File : example.i */
+%module example
+
+/* A few preprocessor macros */
+
+#define ICONST 42
+#define FCONST 2.1828
+#define CCONST 'x'
+#define CCONST2 '\n'
+#define SCONST "Hello World"
+#define SCONST2 "\"Hello World\""
+
+/* This should work just fine */
+#define EXPR ICONST + 3*(FCONST)
+
+/* This shouldn't do anything */
+#define EXTERN extern
+
+/* Neither should this (BAR isn't defined) */
+#define FOO (ICONST + BAR)
+
+/* The following directives also produce constants */
+
+%constant int iconst = 37;
+%constant double fconst = 3.14;
+
+
diff --git a/Examples/perl5/constants/index.html b/Examples/perl5/constants/index.html
new file mode 100644
index 0000000..f38338b
--- /dev/null
+++ b/Examples/perl5/constants/index.html
@@ -0,0 +1,53 @@
+<html>
+<head>
+<title>SWIG:Examples:perl5:constants</title>
+</head>
+
+<body bgcolor="#ffffff">
+
+<tt>SWIG/Examples/perl5/constants/</tt>
+<hr>
+
+<H2>Wrapping C Constants</H2>
+
+<p>
+When SWIG encounters C preprocessor macros and C declarations that look like constants,
+it creates Perl5 variables 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 Perl</h2>
+
+Click <a href="runme.pl">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 Perl 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 Perl strings.
+<li>C string literals such as "Hello World" are converted into Perl 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 Perl constants.
+
+<p>
+<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>
diff --git a/Examples/perl5/constants/runme.pl b/Examples/perl5/constants/runme.pl
new file mode 100644
index 0000000..6e8a6ed
--- /dev/null
+++ b/Examples/perl5/constants/runme.pl
@@ -0,0 +1,29 @@
+# file: runme.pl
+
+use example;
+
+print "ICONST = ", $example::ICONST, " (should be 42)\n";
+print "FCONST = ", $example::FCONST, " (should be 2.1828)\n";
+print "CCONST = ", $example::CCONST, " (should be 'x')\n";
+print "CCONST2 = ", $example::CCONST2," (this should be on a new line)\n";
+print "SCONST = ", $example::SCONST, " (should be 'Hello World')\n";
+print "SCONST2 = ", $example::SCONST2, " (should be '\"Hello World\"')\n";
+print "EXPR = ", $example::EXPR, " (should be 48.5484)\n";
+print "iconst = ", $example::iconst, " (should be 37)\n";
+print "fconst = ", $example::fconst, " (should be 3.14)\n";
+
+
+if ($example::EXTERN) {
+ print "EXTERN = ", example.EXTERN, " (Arg! This shouldn't print anything)\n";
+} else {
+ print "EXTERN isn't defined (good)\n";
+}
+
+if ($example::FOO) {
+ print "FOO = ", example.FOO, "(Arg! This shouldn't print anything)\n";
+} else {
+ print "FOO isn't defined (good)\n";
+}
+
+
+