From 1afaa87774ef8f3b8d29f085f1771c9593f887ec Mon Sep 17 00:00:00 2001 From: John Glover Date: Tue, 11 Sep 2012 12:23:13 +0200 Subject: [exceptions] Remove unused Exception classes, add exceptions.cpp to list of sources in Python extension. --- setup.py | 73 +++++++------ src/simpl/exceptions.cpp | 39 +------ src/simpl/exceptions.h | 272 +++++------------------------------------------ 3 files changed, 65 insertions(+), 319 deletions(-) diff --git a/setup.py b/setup.py index b068f19..b49f943 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -""" +''' Simpl is an open source library for sinusoidal modelling written in C/C++ and Python, and making use of Scientific Python (SciPy). The aim of this project is to tie together many of the existing sinusoidal modelling implementations @@ -7,7 +7,7 @@ implementations of some recently published sinusoidal modelling algorithms, many of which have yet to be released in software. Simpl is primarily intended as a tool for other researchers in the field, allowing them to easily combine, compare and contrast many of the published analysis/synthesis algorithms. -""" +''' import os import glob from distutils.core import setup @@ -29,7 +29,7 @@ try: except AttributeError: numpy_include = numpy.get_numpy_include() except ImportError: - print "Error: Numpy was not found." + print 'Error: Numpy was not found.' exit(1) macros = [] @@ -42,24 +42,23 @@ sources = [] # ----------------------------------------------------------------------------- # SndObj Library # ----------------------------------------------------------------------------- - -sndobj_sources = """ +sndobj_sources = ''' SndObj.cpp SndIO.cpp FFT.cpp PVA.cpp IFGram.cpp SinAnal.cpp SinSyn.cpp AdSyn.cpp ReSyn.cpp HarmTable.cpp HammingTable.cpp - """.split() + '''.split() sndobj_sources = map(lambda x: 'src/sndobj/' + x, sndobj_sources) sources.extend(sndobj_sources) # ----------------------------------------------------------------------------- # SMS # ----------------------------------------------------------------------------- -sms_sources = """ +sms_sources = ''' OOURA.c cepstrum.c peakContinuation.c soundIO.c tables.c fileIO.c peakDetection.c spectralApprox.c transforms.c filters.c residual.c spectrum.c windows.c SFMT.c fixTracks.c sineSynth.c stocAnalysis.c harmDetection.c sms.c synthesis.c analysis.c modify.c - """.split() + '''.split() sms_sources = map(lambda x: 'src/sms/' + x, sms_sources) sources.extend(sms_sources) @@ -73,77 +72,83 @@ sources.extend(loris_sources) # Base # ----------------------------------------------------------------------------- base = Extension( - "simpl.base", - sources=["simpl/base.pyx", "src/simpl/base.cpp"], + 'simpl.base', + sources=['simpl/base.pyx', + 'src/simpl/base.cpp', + 'src/simpl/exceptions.cpp'], include_dirs=include_dirs, - language="c++" + language='c++' ) # ----------------------------------------------------------------------------- # Peak Detection # ----------------------------------------------------------------------------- peak_detection = Extension( - "simpl.peak_detection", - sources=sources + ["simpl/peak_detection.pyx", - "src/simpl/peak_detection.cpp", - "src/simpl/base.cpp"], + 'simpl.peak_detection', + sources=sources + ['simpl/peak_detection.pyx', + 'src/simpl/peak_detection.cpp', + 'src/simpl/base.cpp', + 'src/simpl/exceptions.cpp'], include_dirs=include_dirs, libraries=libs, extra_compile_args=['-DMERSENNE_TWISTER', '-DHAVE_FFTW3_H'], - language="c++" + language='c++' ) # ----------------------------------------------------------------------------- # Partial Tracking # ----------------------------------------------------------------------------- partial_tracking = Extension( - "simpl.partial_tracking", - sources=["simpl/partial_tracking.pyx", "src/simpl/partial_tracking.cpp", - "src/simpl/base.cpp"], + 'simpl.partial_tracking', + sources=['simpl/partial_tracking.pyx', + 'src/simpl/partial_tracking.cpp', + 'src/simpl/base.cpp', + 'src/simpl/exceptions.cpp'], include_dirs=include_dirs, - language="c++" + language='c++' ) - # ----------------------------------------------------------------------------- # Synthesis # ----------------------------------------------------------------------------- synthesis = Extension( - "simpl.synthesis", - sources=["simpl/synthesis.pyx", "src/simpl/synthesis.cpp", - "src/simpl/base.cpp"], + 'simpl.synthesis', + sources=['simpl/synthesis.pyx', + 'src/simpl/synthesis.cpp', + 'src/simpl/base.cpp', + 'src/simpl/exceptions.cpp'], include_dirs=include_dirs, - language="c++" + language='c++' ) - # ----------------------------------------------------------------------------- # Residual # ----------------------------------------------------------------------------- residual = Extension( - "simpl.residual", - sources=["simpl/residual.pyx", "src/simpl/residual.cpp", - "src/simpl/base.cpp"], + 'simpl.residual', + sources=['simpl/residual.pyx', + 'src/simpl/residual.cpp', + 'src/simpl/base.cpp', + 'src/simpl/exceptions.cpp'], include_dirs=include_dirs, - language="c++" + language='c++' ) # ----------------------------------------------------------------------------- # Package # ----------------------------------------------------------------------------- - -doc_lines = __doc__.split("\n") +doc_lines = __doc__.split('\n') setup( name='simpl', description=doc_lines[0], - long_description="\n".join(doc_lines[2:]), + long_description='\n'.join(doc_lines[2:]), url='http://simplsound.sourceforge.net', download_url='http://simplsound.sourceforge.net', license='GPL', author='John Glover', author_email='j@johnglover.net', - platforms=["Linux", "Mac OS-X", "Unix"], + platforms=['Linux', 'Mac OS-X', 'Unix'], version='0.3', ext_modules=[base, peak_detection, partial_tracking, synthesis, residual], cmdclass={'build_ext': build_ext}, diff --git a/src/simpl/exceptions.cpp b/src/simpl/exceptions.cpp index 3e4ae53..9431bc0 100644 --- a/src/simpl/exceptions.cpp +++ b/src/simpl/exceptions.cpp @@ -1,42 +1,7 @@ #include "exceptions.h" #include -namespace simpl { +using namespace simpl; -// --------------------------------------------------------------------------- -// Exception constructor -// --------------------------------------------------------------------------- -//! Construct a new instance with the specified description and, optionally -//! a string identifying the location at which the exception as thrown. The -//! Throw(Exception_Class, description_string) macro generates a location -//! string automatically using __FILE__ and __LINE__. -//! -//! \param str is a string describing the exceptional condition -//! \param where is an option string describing the location in -//! the source code from which the exception was thrown -//! (generated automatically byt he Throw macro). -// -Exception::Exception(const std::string & str, const std::string & where) : - _sbuf(str) -{ - _sbuf.append(where); - _sbuf.append(" "); +Exception::Exception(const std::string & str) : _msg(str) { } - -// --------------------------------------------------------------------------- -// append -// --------------------------------------------------------------------------- -//! Append the specified string to this Exception's description, -//! and return a reference to this Exception. -//! -//! \param str is text to append to the exception description -//! \return a reference to this Exception. -// -Exception & -Exception::append(const std::string & str) -{ - _sbuf.append(str); - return *this; -} - -} // end of namespace Simpl diff --git a/src/simpl/exceptions.h b/src/simpl/exceptions.h index 0d247b2..3e9f961 100644 --- a/src/simpl/exceptions.h +++ b/src/simpl/exceptions.h @@ -1,266 +1,42 @@ #ifndef EXCEPTIONS_H #define EXCEPTIONS_H -// -// Mostly taken from the LorisException.h file in Loris (http://www.cerlsoundgroup.org/loris) #include #include -namespace simpl { - -// --------------------------------------------------------------------------- -// class Exception -// -//! Exception is a generic exception class for reporting exceptional -//! circumstances in Simpl. Exception is derived from std:exception, -//! and is the base for a hierarchy of derived exception classes -//! in Simpl. -//! -// -class Exception : public std::exception -{ -public: - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - Exception(const std::string & str, const std::string & where = ""); - - //! Destroy this Exception. - virtual ~Exception(void) throw() {} - - //! Return a description of this Exception in the form of a - //! C-style string (char pointer). Overrides std::exception::what. - //! - //! \return a C-style string describing the exceptional condition. - const char * what(void) const throw() - { - return _sbuf.c_str(); - } - - //! Append the specified string to this Exception's description, - //! and return a reference to this Exception. - //! - //! \param str is text to append to the exception description - //! \return a reference to this Exception. - Exception & append(const std::string & str); - - //! Return a read-only refernce to this Exception's - //! description string. - //! - //! \return a string describing the exceptional condition - const std::string & str(void) const - { - return _sbuf; - } - -protected: - //! string for storing the exception description - std::string _sbuf; - -}; - -// ---------------------------------------------------------------------------- -// class AssertionFailure -// -//! Class of exceptions thrown when an assertion (usually representing an -//! invariant condition, and usually detected by the Assert macro) is -//! violated. -// -class AssertionFailure : public Exception +namespace simpl { -public: - - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - AssertionFailure(const std::string & str, const std::string & where = "") : - Exception(std::string("Assertion failed -- ").append(str), where) - { - } - -}; // --------------------------------------------------------------------------- -// class IndexOutOfBounds -// -//! Class of exceptions thrown when a subscriptable object is accessed -//! with an index that is out of range. +// Exception // -class IndexOutOfBounds : public Exception -{ -public: - - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - IndexOutOfBounds(const std::string & str, const std::string & where = "") : - Exception(std::string("Index out of bounds -- ").append(str), where) {} - -}; +// Exception is derived from std:exception, and is the base for a hierarchy +// of derived exception classes in Simpl. +class Exception : public std::exception { + public: + // Construct a new instance with the specified description. + Exception(const std::string & str); + // Destroy this Exception. + virtual ~Exception(void) throw() {} -// --------------------------------------------------------------------------- -// class InvalidObject -// -//! Class of exceptions thrown when an object is found to be badly configured -//! or otherwise invalid. -// -class InvalidObject : public Exception -{ -public: + // Return a description of this Exception in the form of a + // C-style string (char pointer). Overrides std::exception::what. + const char * what(void) const throw() { + return _msg.c_str(); + } - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - InvalidObject(const std::string & str, const std::string & where = "") : - Exception(std::string("Invalid configuration or object -- ").append(str), where) - { - } - -}; - -// --------------------------------------------------------------------------- -// class InvalidIterator -// -//! Class of exceptions thrown when an Iterator is found to be badly configured -//! or otherwise invalid. -// -class InvalidIterator : public InvalidObject -{ -public: + // Return a read-only refernce to this Exception's + // description string. + const std::string & str(void) const { + return _msg; + } - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - InvalidIterator(const std::string & str, const std::string & where = "") : - InvalidObject(std::string("Invalid Iterator -- ").append(str), where) - { - } - + protected: + // string for storing the exception description + std::string _msg; }; -// --------------------------------------------------------------------------- -// class InvalidArgument -// -//! Class of exceptions thrown when a function argument is found to be invalid. -// -class InvalidArgument : public Exception -{ -public: - - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - InvalidArgument(const std::string & str, const std::string & where = "") : - Exception(std::string("Invalid Argument -- ").append(str), where) - { - } - -}; - -// --------------------------------------------------------------------------- -// class RuntimeError -// -//! Class of exceptions thrown when an unanticipated runtime error is -//! encountered. -// -class RuntimeError : public Exception -{ -public: - - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - RuntimeError(const std::string & str, const std::string & where = "") : - Exception(std::string("Runtime Error -- ").append(str), where) - { - } - -}; - -// --------------------------------------------------------------------------- -// class FileIOException -// -//! Class of exceptions thrown when file input or output fails. -// -class FileIOException : public RuntimeError -{ -public: - - //! Construct a new instance with the specified description and, optionally - //! a string identifying the location at which the exception as thrown. The - //! Throw(Exception_Class, description_string) macro generates a location - //! string automatically using __FILE__ and __LINE__. - //! - //! \param str is a string describing the exceptional condition - //! \param where is an option string describing the location in - //! the source code from which the exception was thrown - //! (generated automatically by the Throw macro). - FileIOException(const std::string & str, const std::string & where = "") : - RuntimeError(std::string("File i/o error -- ").append(str), where) - { - } - -}; - -// --------------------------------------------------------------------------- -// macros for throwing exceptions -// -// The compelling reason for using macros instead of inlines for all these -// things is that the __FILE__ and __LINE__ macros will be useful. -// -#define __STR(x) __VAL(x) -#define __VAL(x) #x -#define Throw(exType, report) \ - throw exType(report, " (" __FILE__ " line: " __STR(__LINE__)") ") - -#define Assert(test) \ - do { \ - if (!(test)) Throw(Simpl::AssertionFailure, #test); \ - } while (false) - -} // end of namespace Simpl +} // end of namespace simpl #endif -- cgit v1.2.3