Merged r10554:10595 from michaelld/am_swig_4 into trunk. Major overhaul of SWIG usage in build system, also fixes ticket:130. Trunk passes distcheck.

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@10596 221aa14e-8319-0410-a670-987f0aec2ac5

3 files changed, 289 insertions, 51 deletions

diff --git a/usrp/host/swig/Makefile.am b/usrp/host/swig/Makefile.am
index 08e6c436b..6af452b02 100644
--- a/usrp/host/swig/Makefile.am
+++ b/usrp/host/swig/Makefile.am
@@ -21,63 +21,42 @@
 
 include $(top_srcdir)/Makefile.common
 
-ourpythondir = $(usrppythondir)
-ourlibdir    = $(usrppyexecdir)
+AM_CPPFLAGS =			\
+	$(USRP_INCLUDES)	\
+	$(PYTHON_CPPFLAGS)	\
+	-I$(srcdir)		\
+	$(WITH_INCLUDES)
 
+#################################
+# SWIG interface and library
 
-AM_CPPFLAGS = $(USRP_INCLUDES) 		\
-	   $(PYTHON_CPPFLAGS) 		\
-	   -I$(srcdir)			\
-	   $(WITH_INCLUDES)
+TOP_SWIG_IFILES =		\
+	usrp_prims.i
 
-LOCAL_IFILES =				\
-	prims.i
+# Install so that they end up available as:
+#   import usrpm.usrp_prims
+# This ends up at:
+#   ${prefix}/lib/python${python_version}/site-packages/usrpm
+usrp_prims_pythondir_category =	\
+	usrpm
 
+# additional arguments to the SWIG command
+usrp_prims_swig_args =		\
+	$(USRP_INCLUDES)
 
-ALL_IFILES =				\
-	$(LOCAL_IFILES)			
+# additional libraries for linking with the SWIG-generated library
+usrp_prims_la_swig_libadd =	\
+	$(USRP_LA)
 
+# additional Python files to be installed along with the SWIG-generated one
+usrp_prims_python =		\
+	__init__.py		\
+	usrp_fpga_regs.py
 
-EXTRA_DIST = 				\
-	$(LOCAL_IFILES)
+include $(top_srcdir)/Makefile.swig
 
+# add some of the variables generated inside the Makefile.swig.gen
+BUILT_SOURCES = $(swig_built_sources)
 
-BUILT_SOURCES =				\
-	prims.cc			\
-	usrp_prims.py
-
-
-ourpython_PYTHON = 			\
-	__init__.py			\
-	usrp_fpga_regs.py		\
-	usrp_prims.py			
-
-# special SWIG flags
-LOCAL_SWIG_DEFINES_AND_INCLUDES = $(USRP_INCLUDES)
-
-ourlib_LTLIBRARIES = 			\
-	_usrp_prims.la
-
-_usrp_prims_la_SOURCES = 		\
-	prims.cc		
-
-
-noinst_HEADERS =
-
-_usrp_prims_la_LIBADD  = $(USRP_LA) -lstdc++ $(PYTHON_LDFLAGS)
-_usrp_prims_la_LDFLAGS = $(NO_UNDEFINED) -module -avoid-version
-
-_usrp_prims_la_CXXFLAGS = @swig_CXXFLAGS@
-
-prims.cc usrp_prims.py : $(srcdir)/prims.i ../../firmware/include/fpga_regs_common.h ../../firmware/include/fpga_regs_standard.h
-	$(SWIG) $(STD_SWIG_PYTHON_ARGS) -module usrp_prims \
-		-o prims.cc $(srcdir)/prims.i
-
-MOSTLYCLEANFILES = \
-	prims.cc usrp_prims.py *~ *.pyc
-
-# Don't distribute output of swig
-dist-hook:
-	@for file in $(BUILT_SOURCES); do echo $(RM) $(distdir)/$$file; done
-	@for file in $(BUILT_SOURCES); do $(RM) $(distdir)/$$file; done
-
+# Do not distribute the output of SWIG
+no_dist_files = $(swig_built_sources)
diff --git a/usrp/host/swig/Makefile.swig.gen b/usrp/host/swig/Makefile.swig.gen
new file mode 100644
index 000000000..00de3e423
--- /dev/null
+++ b/usrp/host/swig/Makefile.swig.gen
@@ -0,0 +1,259 @@
+# -*- Makefile -*-
+#
+# Copyright 2009 Free Software Foundation, Inc.
+# 
+# This file is part of GNU Radio
+# 
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+# 
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING.  If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+# 
+
+# Makefile.swig.gen for usrp_prims.i
+
+## Default install locations for these files:
+##
+## Default location for the Python directory is:
+##  ${prefix}/lib/python${python_version}/site-packages/[category]/usrp_prims
+## Default location for the Python exec directory is:
+##  ${exec_prefix}/lib/python${python_version}/site-packages/[category]/usrp_prims
+##
+## The following can be overloaded to change the install location, but
+## this has to be done in the including Makefile.am -before-
+## Makefile.swig is included.
+
+usrp_prims_pythondir_category ?= gnuradio/usrp_prims
+usrp_prims_pylibdir_category ?= $(usrp_prims_pythondir_category)
+usrp_prims_pythondir = $(pythondir)/$(usrp_prims_pythondir_category)
+usrp_prims_pylibdir = $(pyexecdir)/$(usrp_prims_pylibdir_category)
+
+## SWIG headers are always installed into the same directory.
+
+usrp_prims_swigincludedir = $(swigincludedir)
+
+## This is a template file for a "generated" Makefile addition (in
+## this case, "Makefile.swig.gen").  By including the top-level
+## Makefile.swig, this file will be used to generate the SWIG
+## dependencies.  Assign the variable TOP_SWIG_FILES to be the list of
+## SWIG .i files to generated wrappings for; there can be more than 1
+## so long as the names are unique (no sorting is done on the
+## TOP_SWIG_FILES list). This file explicitly assumes that a SWIG .i
+## file will generate .cc, .py, and possibly .h files -- meaning that
+## all of these files will have the same base name (that provided for
+## the SWIG .i file).
+##
+## This code is setup to ensure parallel MAKE ("-j" or "-jN") does the
+## right thing.  For more info, see <
+## http://sources.redhat.com/automake/automake.html#Multiple-Outputs >
+
+## Stamps used to ensure parallel make does the right thing.  These
+## are removed by "make clean", but otherwise unused except during the
+## parallel built.  These will not be included in a tarball, because
+## the SWIG-generated files will be removed from the distribution.
+
+STAMPS += $(DEPDIR)/usrp_prims-generate-*
+
+## Other cleaned files: dependency files generated by SWIG or this Makefile
+
+MOSTLYCLEANFILES += $(DEPDIR)/*.S*
+
+## Add the .py and .cc files to the list of SWIG built sources.  The
+## .h file is sometimes built, but not always ... so that one has to
+## be added manually by the including Makefile.am .
+
+swig_built_sources += usrp_prims.py usrp_prims.cc
+
+## Various SWIG variables.  These can be overloaded in the including
+## Makefile.am by setting the variable value there, then including
+## Makefile.swig .
+
+usrp_prims_swiginclude_HEADERS =		\
+	usrp_prims.i			\
+	$(usrp_prims_swiginclude_headers)
+
+usrp_prims_pylib_LTLIBRARIES =		\
+	_usrp_prims.la
+
+_usrp_prims_la_SOURCES = 			\
+	usrp_prims.cc			\
+	$(usrp_prims_la_swig_sources)
+
+_usrp_prims_la_LIBADD =			\
+	$(STD_SWIG_LA_LIB_ADD)		\
+	$(usrp_prims_la_swig_libadd)
+
+_usrp_prims_la_LDFLAGS =			\
+	$(STD_SWIG_LA_LD_FLAGS)		\
+	$(usrp_prims_la_swig_ldflags)
+
+_usrp_prims_la_CXXFLAGS =			\
+	$(STD_SWIG_CXX_FLAGS)		\
+	$(usrp_prims_la_swig_cxxflags)
+
+usrp_prims_python_PYTHON =			\
+	usrp_prims.py			\
+	$(usrp_prims_python)
+
+## Entry rule for running SWIG
+
+usrp_prims.h usrp_prims.py usrp_prims.cc: usrp_prims.i
+## This rule will get called only when MAKE decides that one of the
+## targets needs to be created or re-created, because:
+##
+## * The .i file is newer than any or all of the generated files;
+##
+## * Any or all of the .cc, .h, or .py files does not exist and is
+##   needed (in the case this file is not needed, the rule for it is
+##   ignored); or
+##
+## * Some SWIG-based dependecy of the .cc file isn't met and hence the
+##   .cc file needs be be regenerated.  Explanation: Because MAKE
+##   knows how to handle dependencies for .cc files (regardless of
+##   their name or extension), then the .cc file is used as a target
+##   instead of the .i file -- but with the dependencies of the .i
+##   file.  It is this last reason why the line:
+##
+##     	if test -f $@; then :; else
+##
+##   cannot be used in this case: If a .i file dependecy is not met,
+##   then the .cc file needs to be rebuilt.  But if the stamp is newer
+##   than the .cc file, and the .cc file exists, then in the original
+##   version (with the 'test' above) the internal MAKE call will not
+##   be issued and hence the .cc file will not be rebuilt.
+##
+## Once execution gets to here, it should always proceed no matter the
+## state of a stamp (as discussed in link above).  The
+## $(DEPDIR)/usrp_prims-generate stuff is used to allow for parallel
+## builds to "do the right thing".  The stamp has no relationship with
+## either the target files or dependency file; it is used solely for
+## the protection of multiple builds during a given call to MAKE.
+##
+## Catch signals SIGHUP (1), SIGINT (2), SIGPIPE (13), and SIGTERM
+## (15).  At a caught signal, the quoted command will be issued before
+## exiting.  In this case, remove any stamp, whether temporary of not.
+## The trap is valid until the process exits; the process includes all
+## commands appended via "\"s.
+##
+	trap 'rm -rf $(DEPDIR)/usrp_prims-generate-*' 1 2 13 15; \
+##
+## Create a temporary directory, which acts as a lock.  The first
+## process to create the directory will succeed and issue the MAKE
+## command to do the actual work, while all subsequent processes will
+## fail -- leading them to wait for the first process to finish.
+##
+	if mkdir $(DEPDIR)/usrp_prims-generate-lock 2>/dev/null; then \
+##
+## This code is being executed by the first process to succeed in
+## creating the directory lock.
+##
+## Remove the stamp associated with this filename.
+##
+		rm -f $(DEPDIR)/usrp_prims-generate-stamp; \
+##
+## Tell MAKE to run the rule for creating this stamp.
+##
+		$(MAKE) $(AM_MAKEFLAGS) $(DEPDIR)/usrp_prims-generate-stamp WHAT=$<; \
+##
+## Now that the .cc, .h, and .py files have been (re)created from the
+## .i file, future checking of this rule during the same MAKE
+## execution will come back that the rule doesn't need to be executed
+## because none of the conditions mentioned at the start of this rule
+## will be positive.  Remove the the directory lock, which frees up
+## any waiting process(es) to continue.
+##
+		rmdir $(DEPDIR)/usrp_prims-generate-lock; \
+	else \
+##
+## This code is being executed by any follower processes while the
+## directory lock is in place.
+##
+## Wait until the first process is done, testing once per second.
+##
+		while test -d $(DEPDIR)/usrp_prims-generate-lock; do \
+			sleep 1; \
+		done; \
+##
+## Succeed if and only if the first process succeeded; exit this
+## process returning the status of the generated stamp.
+##
+		test -f $(DEPDIR)/usrp_prims-generate-stamp; \
+		exit $$?; \
+	fi;
+
+$(DEPDIR)/usrp_prims-generate-stamp:
+## This rule will be called only by the first process issuing the
+## above rule to succeed in creating the lock directory, after
+## removing the actual stamp file in order to guarantee that MAKE will
+## execute this rule.
+##
+## Call SWIG to generate the various output files; special
+## post-processing on 'mingw32' host OS for the dependency file.
+##
+	if $(SWIG) $(STD_SWIG_PYTHON_ARGS) $(usrp_prims_swig_args) \
+		-MD -MF $(DEPDIR)/usrp_prims.Std \
+		-module usrp_prims -o usrp_prims.cc $(WHAT); then \
+	    if test $(host_os) = mingw32; then \
+		$(RM) $(DEPDIR)/usrp_prims.Sd; \
+		$(SED) 's,\\\\,/,g' < $(DEPDIR)/usrp_prims.Std \
+			> $(DEPDIR)/usrp_prims.Sd; \
+		$(RM) $(DEPDIR)/usrp_prims.Std; \
+		$(MV) $(DEPDIR)/usrp_prims.Sd $(DEPDIR)/usrp_prims.Std; \
+	    fi; \
+	else \
+	    $(RM) $(DEPDIR)/usrp_prims.S*; exit 1; \
+	fi;
+##
+## Mess with the SWIG output .Std dependency file, to create a
+## dependecy file valid for the input .i file: Basically, simulate the
+## dependency file created for libraries by GNU's libtool for C++,
+## where all of the dependencies for the target are first listed, then
+## each individual dependency is listed as a target with no further
+## dependencies.
+##
+## (1) remove the current dependency file
+##
+	$(RM) $(DEPDIR)/usrp_prims.d
+##
+## (2) Copy the whole SWIG file:
+##
+	cp $(DEPDIR)/usrp_prims.Std $(DEPDIR)/usrp_prims.d
+##
+## (3) all a carriage return to the end of the dependency file.
+##
+	echo "" >> $(DEPDIR)/usrp_prims.d
+##
+## (4) from the SWIG file, remove the first line (the target); remove
+##     trailing " \" and " " from each line.  Append ":" to each line,
+##     followed by 2 carriage returns, then append this to the end of
+##     the dependency file.
+##
+	$(SED) -e '1d;s, \\,,g;s, ,,g' < $(DEPDIR)/usrp_prims.Std | \
+		awk '{ printf "%s:\n\n", $$0 }' >> $(DEPDIR)/usrp_prims.d
+##
+## (5) remove the SWIG-generated file
+##
+	$(RM) $(DEPDIR)/usrp_prims.Std
+##
+## Create the stamp for this filename generation, to signal success in
+## executing this rule; allows other threads waiting on this process
+## to continue.
+##
+	touch $(DEPDIR)/usrp_prims-generate-stamp
+
+# KLUDGE: Force runtime include of a SWIG dependency file.  This is
+# not guaranteed to be portable, but will probably work.  If it works,
+# we have accurate dependencies for our swig stuff, which is good.
+
+@am__include@ @am__quote@./$(DEPDIR)/usrp_prims.d@am__quote@
+
diff --git a/usrp/host/swig/prims.i b/usrp/host/swig/usrp_prims.i
index d973c6d78..d973c6d78 100644
--- a/usrp/host/swig/prims.i
+++ b/usrp/host/swig/usrp_prims.i