diff options
Diffstat (limited to 'gr-shd/swig')
| -rw-r--r-- | gr-shd/swig/.gitignore | 8 | ||||
| -rw-r--r-- | gr-shd/swig/Makefile.am | 82 | ||||
| -rw-r--r-- | gr-shd/swig/Makefile.swig.gen | 145 | ||||
| -rw-r--r-- | gr-shd/swig/__init__.py | 88 | ||||
| -rw-r--r-- | gr-shd/swig/gnuradio/.gitignore | 2 | ||||
| -rw-r--r-- | gr-shd/swig/gnuradio/shd.scm | 27 | ||||
| -rwxr-xr-x | gr-shd/swig/qa_shd.py | 40 | ||||
| -rw-r--r-- | gr-shd/swig/run_guile_tests.in | 14 | ||||
| -rw-r--r-- | gr-shd/swig/run_tests.in | 10 | ||||
| -rw-r--r-- | gr-shd/swig/shd.test | 37 | ||||
| -rw-r--r-- | gr-shd/swig/shd_swig.i | 135 |
11 files changed, 588 insertions, 0 deletions
diff --git a/gr-shd/swig/.gitignore b/gr-shd/swig/.gitignore new file mode 100644 index 000000000..23ae38f9b --- /dev/null +++ b/gr-shd/swig/.gitignore @@ -0,0 +1,8 @@ +/shd_swig.cc +/shd_swig.py +/Makefile +/Makefile.in +/guile +/python +/run_guile_tests +/run_tests diff --git a/gr-shd/swig/Makefile.am b/gr-shd/swig/Makefile.am new file mode 100644 index 000000000..3e155ba41 --- /dev/null +++ b/gr-shd/swig/Makefile.am @@ -0,0 +1,82 @@ +# +# Copyright 2011 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. +# + +include $(top_srcdir)/Makefile.common +include $(top_srcdir)/Makefile.swig + +TESTS = +EXTRA_DIST += run_tests.in run_guile_tests.in $(nobase_guile_DATA) +DISTCLEANFILES += run_tests run_guile_tests + +noinst_PYTHON = qa_shd.py +noinst_GUILE = shd.test + +AM_CPPFLAGS = \ + $(STD_DEFINES_AND_INCLUDES) \ + $(PYTHON_CPPFLAGS) \ + $(SHD_CPPFLAGS) \ + $(WITH_INCLUDES) + +shd_swig_swig_args = $(SHD_CPPFLAGS) + +if GUILE +nobase_guile_DATA = \ + gnuradio/shd.scm +endif + +# ---------------------------------------------------------------- +# The SWIG library + +TOP_SWIG_IFILES = \ + shd_swig.i + +# Install so that they end up available as: +# import gnuradio.shd +# This ends up at: +# ${prefix}/lib/python${python_version}/site-packages/gnuradio/shd +shd_swig_pythondir_category = \ + gnuradio/shd + +# additional libraries for linking with the SWIG-generated library +shd_swig_la_swig_libadd = \ + $(top_builddir)/gr-shd/lib/libgnuradio-shd.la + +# additional Python files to be installed along with the SWIG-generated one +shd_swig_python = \ + __init__.py + +# additional SWIG files to be installed +shd_swig_swiginclude_headers = + +shd_swig_swig_args = $(SHD_CPPFLAGS) + +## If SHD was installed, defined GR_HAVE_SHD for swigging headers +if GR_DEFINE_HAVE_SHD + shd_swig_swig_args += -DGR_HAVE_SHD +endif + +if PYTHON +TESTS += run_tests +endif + +if GUILE +TESTS += run_guile_tests +endif diff --git a/gr-shd/swig/Makefile.swig.gen b/gr-shd/swig/Makefile.swig.gen new file mode 100644 index 000000000..ebe843bbe --- /dev/null +++ b/gr-shd/swig/Makefile.swig.gen @@ -0,0 +1,145 @@ +# -*- 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 shd_swig.i + +## Default install locations for these files: +## +## Default location for the Python directory is: +## ${prefix}/lib/python${python_version}/site-packages/[category]/shd_swig +## Default location for the Python exec directory is: +## ${exec_prefix}/lib/python${python_version}/site-packages/[category]/shd_swig +## +## 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. + +shd_swig_pythondir_category ?= gnuradio/shd_swig +shd_swig_pylibdir_category ?= $(shd_swig_pythondir_category) +shd_swig_pythondir = $(pythondir)/$(shd_swig_pythondir_category) +shd_swig_pylibdir = $(pyexecdir)/$(shd_swig_pylibdir_category) + +# The .so libraries for the guile modules get installed whereever guile +# is installed, usually /usr/lib/guile/gnuradio/ +# FIXME: determince whether these should be installed with gnuradio. +shd_swig_scmlibdir = $(libdir) + +# The scm files for the guile modules get installed where ever guile +# is installed, usually /usr/share/guile/site/shd_swig +# FIXME: determince whether these should be installed with gnuradio. +shd_swig_scmdir = $(guiledir) + +## SWIG headers are always installed into the same directory. + +shd_swig_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 > + +## Other cleaned files: dependency files generated by SWIG or this Makefile + +MOSTLYCLEANFILES += $(DEPDIR)/*.S* + +## Various SWIG variables. These can be overloaded in the including +## Makefile.am by setting the variable value there, then including +## Makefile.swig . + +shd_swig_swiginclude_HEADERS = \ + shd_swig.i \ + $(shd_swig_swiginclude_headers) + +if PYTHON +shd_swig_pylib_LTLIBRARIES = \ + _shd_swig.la + +_shd_swig_la_SOURCES = \ + python/shd_swig.cc \ + $(shd_swig_la_swig_sources) + +shd_swig_python_PYTHON = \ + shd_swig.py \ + $(shd_swig_python) + +_shd_swig_la_LIBADD = \ + $(STD_SWIG_LA_LIB_ADD) \ + $(shd_swig_la_swig_libadd) + +_shd_swig_la_LDFLAGS = \ + $(STD_SWIG_LA_LD_FLAGS) \ + $(shd_swig_la_swig_ldflags) + +_shd_swig_la_CXXFLAGS = \ + $(STD_SWIG_CXX_FLAGS) \ + -I$(top_builddir) \ + $(shd_swig_la_swig_cxxflags) + +python/shd_swig.cc: shd_swig.py +shd_swig.py: shd_swig.i + +# Include the python dependencies for this file +-include python/shd_swig.d + +endif # end of if python + +if GUILE + +shd_swig_scmlib_LTLIBRARIES = \ + libguile-gnuradio-shd_swig.la +libguile_gnuradio_shd_swig_la_SOURCES = \ + guile/shd_swig.cc \ + $(shd_swig_la_swig_sources) +nobase_shd_swig_scm_DATA = \ + gnuradio/shd_swig.scm \ + gnuradio/shd_swig-primitive.scm +libguile_gnuradio_shd_swig_la_LIBADD = \ + $(STD_SWIG_LA_LIB_ADD) \ + $(shd_swig_la_swig_libadd) +libguile_gnuradio_shd_swig_la_LDFLAGS = \ + $(STD_SWIG_LA_LD_FLAGS) \ + $(shd_swig_la_swig_ldflags) +libguile_gnuradio_shd_swig_la_CXXFLAGS = \ + $(STD_SWIG_CXX_FLAGS) \ + -I$(top_builddir) \ + $(shd_swig_la_swig_cxxflags) + +guile/shd_swig.cc: gnuradio/shd_swig.scm +gnuradio/shd_swig.scm: shd_swig.i +gnuradio/shd_swig-primitive.scm: gnuradio/shd_swig.scm + +# Include the guile dependencies for this file +-include guile/shd_swig.d + +endif # end of GUILE + + diff --git a/gr-shd/swig/__init__.py b/gr-shd/swig/__init__.py new file mode 100644 index 000000000..17589625c --- /dev/null +++ b/gr-shd/swig/__init__.py @@ -0,0 +1,88 @@ +# +# Copyright 2011 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. +# + +######################################################################## +# Prepare shd swig module to make it more pythonic +######################################################################## +def _prepare_shd_swig(): + import shd_swig + + #some useful typedefs for the user + setattr(shd_swig, 'freq_range_t', shd_swig.meta_range_t) + setattr(shd_swig, 'gain_range_t', shd_swig.meta_range_t) + + #Make the python tune request object inherit from float + #so that it can be passed in GRC as a frequency parameter. + #The type checking in GRC will accept the tune request. + class tune_request_t(shd_swig.tune_request_t, float): + def __new__(self, *args): return float.__new__(self) + def __float__(self): return self.target_freq + setattr(shd_swig, 'tune_request_t', tune_request_t) + + #Make the python tune request object inherit from string + #so that it can be passed in GRC as a string parameter. + #The type checking in GRC will accept the device address. + #Define the set/get item special methods for dict access. + class device_addr_t(shd_swig.device_addr_t, str): + def __new__(self, *args): return str.__new__(self) + def __getitem__(self, key): return self.get(key) + def __setitem__(self, key, val): self.set(key, val) + setattr(shd_swig, 'device_addr_t', device_addr_t) + + #handle general things on all shd_swig attributes + #Install the __str__ and __repr__ handlers if applicable + #Create aliases for shd swig attributes to avoid the "_t" + for attr in dir(shd_swig): + myobj = getattr(shd_swig, attr) + if hasattr(myobj, 'to_string'): myobj.__repr__ = lambda o: o.to_string().strip() + if hasattr(myobj, 'to_pp_string'): myobj.__str__ = lambda o: o.to_pp_string().strip() + if hasattr(myobj, 'to_bool'): myobj.__nonzero__ = lambda o: o.to_bool() + if hasattr(myobj, 'to_int'): myobj.__int__ = lambda o: o.to_int() + if hasattr(myobj, 'to_real'): myobj.__float__ = lambda o: o.to_real() + if attr.endswith('_t'): setattr(shd_swig, attr[:-2], myobj) + + #Cast constructor args (FIXME swig handle overloads?) + for attr in ('smini_source', 'smini_sink'): + def constructor_factory(old_constructor): + def constructor_interceptor(*args, **kwargs): + args = list(args) + kwargs = dict(kwargs) + for index, key, cast in ( + (0, 'device_addr', device_addr), + (1, 'io_type', io_type), + ): + if len(args) > index: args[index] = cast(args[index]) + if kwargs.has_key(key): kwargs[key] = cast(kwargs[key]) + return old_constructor(*args, **kwargs) + return constructor_interceptor + setattr(shd_swig, attr, constructor_factory(getattr(shd_swig, attr))) + + #Aliases for deprecated constructors + setattr(shd_swig, 'single_smini_source', shd_swig.smini_source) + setattr(shd_swig, 'single_smini_sink', shd_swig.smini_sink) + setattr(shd_swig, 'multi_smini_source', shd_swig.smini_source) + setattr(shd_swig, 'multi_smini_sink', shd_swig.smini_sink) + +######################################################################## +# Initialize this module with the contents of shd swig +######################################################################## +_prepare_shd_swig() +from shd_swig import * diff --git a/gr-shd/swig/gnuradio/.gitignore b/gr-shd/swig/gnuradio/.gitignore new file mode 100644 index 000000000..adf5c3727 --- /dev/null +++ b/gr-shd/swig/gnuradio/.gitignore @@ -0,0 +1,2 @@ +shd_swig-primitive.scm +shd_swig.scm diff --git a/gr-shd/swig/gnuradio/shd.scm b/gr-shd/swig/gnuradio/shd.scm new file mode 100644 index 000000000..91af98dd8 --- /dev/null +++ b/gr-shd/swig/gnuradio/shd.scm @@ -0,0 +1,27 @@ +;;; +;;; Copyright 2011 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 this program. If not, see <http://www.gnu.org/licenses/>. +;;; + +;;; Semi bogus module that just reexports the shd_swig module + +(define-module (gnuradio shd) + #:use-module (gnuradio export-safely) + #:use-module (gnuradio shd_swig) + #:duplicates (merge-generics replace check)) + +(re-export-all '(gnuradio shd_swig)) diff --git a/gr-shd/swig/qa_shd.py b/gr-shd/swig/qa_shd.py new file mode 100755 index 000000000..538de918c --- /dev/null +++ b/gr-shd/swig/qa_shd.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python +# +# Copyright 2005,2008,2010 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. +# + +from gnuradio import gr, gr_unittest +import shd_swig + +class test_shd(gr_unittest.TestCase): + + def setUp(self): + self.tb = gr.top_block() + + def tearDown(self): + self.tb = None + + def test_000_nop (self): + """Just see if we can import the module... + They may not have a SHD device connected, etc. Don't try to run anything""" + pass + +if __name__ == '__main__': + gr_unittest.run(test_shd, "test_shd.xml") diff --git a/gr-shd/swig/run_guile_tests.in b/gr-shd/swig/run_guile_tests.in new file mode 100644 index 000000000..5d08b0dd5 --- /dev/null +++ b/gr-shd/swig/run_guile_tests.in @@ -0,0 +1,14 @@ +#!/bin/sh + +. @top_builddir@/setup_guile_test_env + +# 1st argument is absolute path to hand coded guile source directory +# 2nd argument is absolute path to component C++ shared library build directory +# 3nd argument is absolute path to component SWIG build directory + +add_local_paths \ + @srcdir@ \ + @abs_builddir@ \ + @abs_builddir@ + +@GUILE@ -e main -c '(use-modules (gnuradio test-suite guile-test))' -t @srcdir@ diff --git a/gr-shd/swig/run_tests.in b/gr-shd/swig/run_tests.in new file mode 100644 index 000000000..580296374 --- /dev/null +++ b/gr-shd/swig/run_tests.in @@ -0,0 +1,10 @@ +#!/bin/sh + +# 1st parameter is absolute path to component source directory +# 2nd parameter is absolute path to component build directory +# 3rd parameter is path to Python QA directory + +@top_builddir@/run_tests.sh \ + @abs_top_srcdir@/gr-shd \ + @abs_top_builddir@/gr-shd \ + @srcdir@ diff --git a/gr-shd/swig/shd.test b/gr-shd/swig/shd.test new file mode 100644 index 000000000..7b118a081 --- /dev/null +++ b/gr-shd/swig/shd.test @@ -0,0 +1,37 @@ +;;; -*- Scheme -*- +;;; +;;; Copyright 2010 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 this program. If not, see <http://www.gnu.org/licenses/>. +;;; + +;;; If you're using Emacs's Scheme mode: +;;; (put 'with-test-prefix 'scheme-indent-function 1) + +;;; See the comments in gnuradio/test-suite/lib.scm for info on writing tests. +;;; See also the very end of the file, where the test-equal, test-eqv +;;; and test-eq macros are defined. + +(define-module (test-module) + #:use-module (oop goops) + #:use-module (gnuradio core) + #:use-module (gnuradio test-suite lib) + #:duplicates (merge-generics replace check)) + +;;; Just see if we can import the module... +;;; They may not have a SHD device attached, powered up etc. + +(use-modules (gnuradio shd)) diff --git a/gr-shd/swig/shd_swig.i b/gr-shd/swig/shd_swig.i new file mode 100644 index 000000000..217b2f1af --- /dev/null +++ b/gr-shd/swig/shd_swig.i @@ -0,0 +1,135 @@ +/* -*- c++ -*- */ +/* + * Copyright 2011 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. + */ + +// Defined during configure; avoids trying to locate +// header files if SHD was not installed. +#ifdef GR_HAVE_SHD + +#define GR_SHD_API + +//////////////////////////////////////////////////////////////////////// +// Language independent exception handler +//////////////////////////////////////////////////////////////////////// +%include exception.i + +%exception { + try { + $action + } + catch(std::exception &e) { + SWIG_exception(SWIG_RuntimeError, e.what()); + } + catch(...) { + SWIG_exception(SWIG_RuntimeError, "Unknown exception"); + } + +} + +//////////////////////////////////////////////////////////////////////// +// standard includes +//////////////////////////////////////////////////////////////////////// +%include "gnuradio.i" + +//////////////////////////////////////////////////////////////////////// +// block headers +//////////////////////////////////////////////////////////////////////// +%{ +#include <gr_shd_smini_source.h> +#include <gr_shd_smini_sink.h> +%} + +//////////////////////////////////////////////////////////////////////// +// used types +//////////////////////////////////////////////////////////////////////// +%template(string_vector_t) std::vector<std::string>; + +%include <shd/config.hpp> + +%include <shd/utils/pimpl.hpp> + +%ignore shd::dict::operator[]; //ignore warnings about %extend +%include <shd/types/dict.hpp> +%template(string_string_dict_t) shd::dict<std::string, std::string>; //define after dict + +%include <shd/types/device_addr.hpp> + +%include <shd/types/io_type.hpp> + +%template(range_vector_t) std::vector<shd::range_t>; //define before range +%include <shd/types/ranges.hpp> + +%include <shd/types/tune_request.hpp> + +%include <shd/types/tune_result.hpp> + +%include <shd/types/io_type.hpp> + +%include <shd/types/time_spec.hpp> + +%include <shd/types/clock_config.hpp> + +%include <shd/types/metadata.hpp> + +%ignore shd::device::register_device; //causes compile to choke in MSVC +%include <shd/device.hpp> +%template(device_addr_vector_t) std::vector<shd::device_addr_t>; + +%include <shd/types/sensors.hpp> + +//////////////////////////////////////////////////////////////////////// +// swig dboard_iface for python access +//////////////////////////////////////////////////////////////////////// +%include stdint.i +%include <shd/types/serial.hpp> +%template(byte_vector_t) std::vector<uint8_t>; +%include <shd/xmini/dboard_iface.hpp> + +%template(dboard_iface_sptr) boost::shared_ptr<shd::xmini::dboard_iface>; + +//////////////////////////////////////////////////////////////////////// +// block magic +//////////////////////////////////////////////////////////////////////// +GR_SWIG_BLOCK_MAGIC(shd,smini_source) +%include <gr_shd_smini_source.h> + +GR_SWIG_BLOCK_MAGIC(shd,smini_sink) +%include <gr_shd_smini_sink.h> + +//////////////////////////////////////////////////////////////////////// +// helpful constants +//////////////////////////////////////////////////////////////////////// +%{ +static const size_t ALL_MBOARDS = shd::xmini::multi_xmini::ALL_MBOARDS; +%} +static const size_t ALL_MBOARDS; + +#if SWIGGUILE +%scheme %{ +(load-extension-global "libguile-gnuradio-shd_swig" "scm_init_gnuradio_shd_swig_module") +%} + +%goops %{ +(use-modules (gnuradio gnuradio_core_runtime)) +%} +#endif /* SWIGGUILE */ + +#endif /* GR_HAVE_SHD */ |