Chicken: a few bug fixes, a new example and some new test suite runme, and some doc updates

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@7143 626c5289-ae23-0410-ae9c-e8d60b6d4f22

Examples/chicken/README

@@ -2,6 +2,7 @@ This directory contains examples for CHICKEN.
 
 class       -- illustrates the shadow-class C++ interface
 constants   -- handling #define and %constant literals
+egg         -- examples of building chicken extension libraries
 multimap    -- typemaps with multiple sub-types
 overload    -- C++ function overloading
 simple      -- the simple example from the user manual

Examples/chicken/egg/Makefile

@@ -0,0 +1,39 @@
+SWIG = ../../../preinst-swig
+
+all: single multi
+
+# This creates an egg which contains only the single module.  Any additional implementation files
+# that implement the interface being wrapped should also be added to this egg
+single: single_wrap.cxx
+	mkdir -p eggs
+	tar czf eggs/single.egg single.setup single.scm single_wrap.cxx
+	rm -f single.scm single_wrap.cxx
+
+# complie the single module with -nounit
+single_wrap.cxx: single.i
+	$(SWIG) -chicken -c++ -proxy -nounit single.i
+
+# Now build both mod1 and mod2 into a single egg
+multi: mod1_wrap.cxx mod2_wrap.cxx
+	mkdir -p eggs
+	tar czf eggs/multi.egg multi.setup multi_init.scm mod1.scm mod1_wrap.cxx mod2.scm mod2_wrap.cxx
+	rm -f mod1.scm mod1_wrap.cxx mod2.scm mod2_wrap.cxx
+
+mod1_wrap.cxx: mod1.i
+	$(SWIG) -chicken -c++ -proxy mod1.i
+
+mod2_wrap.cxx: mod2.i
+	$(SWIG) -chicken -c++ -proxy mod2.i
+
+clean:
+	rm -rf eggs
+
+# this part is for testing...
+setup:
+	cd eggs && \
+	mkdir -p install && \
+	chicken-setup -repository `pwd`/install single.egg && \
+	chicken-setup -repository `pwd`/install multi.egg
+
+check:
+	cd eggs/install && csi ../../test.scm

Examples/chicken/egg/README

@@ -0,0 +1,19 @@
+These examples show how to build a chicken extension module in the form of an
+egg.  There are two eggs that get built, single.egg which contains a single
+module which is built with -nounit and multi.egg, which contains two modules
+mod1 and mod2.  These are built normally, and multi_init.scm loads them both.
+Read section "17.4.2 Building chicken extension libraries" in the manual
+for a description of these two techniques.
+
+To build:
+
+$ make
+$ make setup
+$ make run
+
+$ make clean
+
+The eggs are built into an eggs subdirectory, because chicken-setup has
+problems installing eggs when there are other files named similar in
+the same directory.  The make setup step runs chicken-setup to install
+the eggs into the eggs/install directory.

Examples/chicken/egg/mod1.i

@@ -0,0 +1,8 @@
+%module mod1
+
+%inline %{
+class Bar {
+  public:
+    int b;
+};
+%}

Examples/chicken/egg/mod2.i

@@ -0,0 +1,17 @@
+%module mod2
+
+%import "mod1.i"
+
+%{
+class Bar {
+  public:
+    int b;
+};
+%}
+
+%inline %{
+  class Bar2 : public Bar {
+    public:
+      int c;
+  };
+%}

Examples/chicken/egg/multi.setup

@@ -0,0 +1,2 @@
+(run (csc -s -o multi.so multi_init.scm mod1.scm mod1_wrap.cxx mod2.scm mod2_wrap.cxx))
+(install-extension 'multi '("multi.so"))

Examples/chicken/egg/multi_init.scm

@@ -0,0 +1,2 @@
+(declare (uses mod1))
+(declare (uses mod2))

Examples/chicken/egg/single.i

@@ -0,0 +1,8 @@
+%module single
+
+%inline %{
+class Foo {
+  public:
+    int a;
+};
+%}

Examples/chicken/egg/single.setup

@@ -0,0 +1,2 @@
+(run (csc -s -o single.so single.scm single_wrap.cxx))
+(install-extension 'single '("single.so"))

Examples/chicken/egg/test.scm

@@ -0,0 +1,18 @@
+(require-extension single)
+(require-extension multi)
+
+(define f (make <Foo>))
+(slot-set! f 'a 3)
+(print (slot-ref f 'a))
+
+(define b (make <Bar>))
+(slot-set! b 'b 2)
+(print (slot-ref b 'b))
+
+(define b2 (make <Bar2>))
+(slot-set! b2 'b 4)
+(slot-set! b2 'c 6)
+(print (slot-ref b2 'b))
+(print (slot-ref b2 'c))
+
+(exit 0)

Examples/test-suite/chicken/Makefile.in

@@ -6,6 +6,7 @@
 LANGUAGE     = chicken
 VARIANT      = 
 SCRIPTSUFFIX = _runme.ss
+PROXYSUFFIX  = _runme_proxy.ss
 srcdir       = @srcdir@
 top_srcdir   = @top_srcdir@
 top_builddir = @top_builddir@
@@ -24,11 +25,17 @@ SWIGOPT +=
 	$(setup) \
 	($(swig_and_compile_cpp); ) && \
 	$(run_testcase)
+	if [ -f $(srcdir)/$(SCRIPTPREFIX)$*$(PROXYSUFFIX) ]; then ( \
+	  $(MAKE) $*.cppproxy; ) \
+	fi;
 
 %.ctest:
 	$(setup) \
 	($(swig_and_compile_c); ) && \
 	$(run_testcase)
+	if [ -f $(srcdir)/$(SCRIPTPREFIX)$*$(PROXYSUFFIX) ]; then ( \
+	  $(MAKE) $*.cproxy; ) \
+	fi;
 
 %.multicpptest: 
 	$(setup) \
@@ -42,6 +49,22 @@ run_testcase = \
 	  env LD_LIBRARY_PATH=.:$$LD_LIBRARY_PATH $(CHICKEN_CSI) $(srcdir)/$(SCRIPTPREFIX)$*$(SCRIPTSUFFIX);) \
 	fi;
 
+# If there exists a PROXYSUFFIX runme file, we also generate the wrapper
+# with the -proxy argument
+%.cppproxy: SWIGOPT += -proxy
+%.cppproxy: SCRIPTSUFFIX = $(PROXYSUFFIX)
+%.cppproxy:
+	echo "Checking testcase $* (with run test) under chicken with -proxy"; \
+	($(swig_and_compile_cpp); ) && \
+	$(run_testcase)
+
+%.cproxy: SWIGOPT += -proxy
+%.cproxy: SCRIPTSUFFIX = $(PROXYSUFFIX)
+%.cproxy:
+	echo "Checking testcase $* (with run test) under chicken with -proxy"; \
+	($(swig_and_compile_c); ) && \
+	$(run_testcase)
+
 # Clean
 %.clean:
 	

Examples/test-suite/chicken/README

@@ -5,3 +5,7 @@ NOTE: I had to use _runme.ss becuase otherwise it would be hard to implement mak
 Since when SWIG runs it generates an example.scm file for every test, to clean those files
 I needed to add a rm -f *.scm to make clean.  But we don't want the runme scripts to
 dissappear as well!
+
+Any testcases which have _runme_proxy.ss appended after the testcase name will be detected
+and run with the -proxy argument passed to SWIG.  SWIG will not be run with the -unhide-primitive
+option, so the _runme_proxy.ss file must use only the tinyclos exported interface.

Examples/test-suite/chicken/newobject2_runme.ss

@@ -1,20 +1,29 @@
 (load-library 'newobject2 "newobject2.so")
 
-(define f (make <Foo>))
+(define f (new-Foo))
 
-(slot-set! f 'dummy 14)
-(if (not (= (slot-ref f 'dummy) 14))
+(Foo-dummy-set f 14)
+(if (not (= (Foo-dummy-get f) 14))
   (error "Bad dummy value"))
 
+(if (not (= (fooCount) 0))
+  (error "Bad foo count 1"))
+
 (define f2 (makeFoo))
 
-(slot-set! f2 'dummy 16)
-(if (not (= (slot-ref f2 'dummy) 16))
+(if (not (= (fooCount) 1))
+  (error "Bad foo count 2"))
+
+(Foo-dummy-set f2 16)
+(if (not (= (Foo-dummy-get f2) 16))
   (error "Bad dummy value for f2"))
 
 (set! f #f)
 (set! f2 #f)
 
-(gc)
+(gc #t)
+
+(if (not (= (fooCount) -1))
+  (error "Bad foo count 3"))
 
 (exit 0)

Examples/test-suite/chicken/newobject2_runme_proxy.ss

@@ -0,0 +1,29 @@
+(load-library 'newobject2 "newobject2.so")
+
+(define f (make <Foo>))
+
+(slot-set! f 'dummy 14)
+(if (not (= (slot-ref f 'dummy) 14))
+  (error "Bad dummy value"))
+
+(if (not (= (fooCount) 0))
+  (error "Bad foo count 1"))
+
+(define f2 (makeFoo))
+
+(if (not (= (fooCount) 1))
+  (error "Bad foo count 2"))
+
+(slot-set! f2 'dummy 16)
+(if (not (= (slot-ref f2 'dummy) 16))
+  (error "Bad dummy value for f2"))
+
+(set! f #f)
+(set! f2 #f)
+
+(gc #t)
+
+(if (not (= (fooCount) -1))
+  (error "Bad foo count 3"))
+
+(exit 0)