uhd: added a bunch of custom exceptions, not used yet

9 files changed, 156 insertions, 53 deletions

diff --git a/host/include/uhd/utils/assert.hpp b/host/include/uhd/utils/assert.hpp
index 7f7b71cfb..cd752c1c1 100644
--- a/host/include/uhd/utils/assert.hpp
+++ b/host/include/uhd/utils/assert.hpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2010 Ettus Research LLC
+// Copyright 2010-2011 Ettus Research LLC
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -25,13 +25,8 @@
 
 namespace uhd{
 
-    //! The exception to throw when assertions fail
-    struct UHD_API assert_error : std::runtime_error{
-        assert_error(const std::string &what);
-    };
-
     //! Throw an assert error with throw-site information
-    #define UHD_ASSERT_THROW(_x) if (not (_x)) throw uhd::assert_error( \
+    #define UHD_ASSERT_THROW(_x) if (not (_x)) throw uhd::assertion_error( \
         UHD_THROW_SITE_INFO("assertion failed: " + std::string(#_x)) \
     ); else void(0)
 
diff --git a/host/include/uhd/utils/assert.ipp b/host/include/uhd/utils/assert.ipp
index 6a8b3e417..4374fff67 100644
--- a/host/include/uhd/utils/assert.ipp
+++ b/host/include/uhd/utils/assert.ipp
@@ -1,5 +1,5 @@
 //
-// Copyright 2010 Ettus Research LLC
+// Copyright 2010-2011 Ettus Research LLC
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -37,7 +37,7 @@ namespace uhd{
             if (i++ > 0) possible_values += ", ";
             possible_values += boost::lexical_cast<std::string>(v);
         }
-        throw uhd::assert_error(str(boost::format(
+        throw uhd::assertion_error(str(boost::format(
                 "assertion failed:\n"
                 "  %s is not a valid %s.\n"
                 "  possible values are: [%s].\n"
diff --git a/host/include/uhd/utils/exception.hpp b/host/include/uhd/utils/exception.hpp
index e74c19b9c..71836e22e 100644
--- a/host/include/uhd/utils/exception.hpp
+++ b/host/include/uhd/utils/exception.hpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2010 Ettus Research LLC
+// Copyright 2010-2011 Ettus Research LLC
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -24,22 +24,96 @@
 #include <string>
 
 /*!
- * Create a formated string with throw-site information.
- * Fills in the function name, file name, and line number.
- * \param what the std::exeption message
- * \return the formatted exception message
+ * Define common exceptions used throughout the code:
+ *
+ * - The python built-in exceptions were used as inspiration.
+ * - Exceptions inherit from std::exception to provide what().
+ * - Exceptions inherit from uhd::exception to provide code().
+ *
+ * The code() provides an error code which allows the application
+ * the option of printing a cryptic error message from the 1990s.
  */
-#define UHD_THROW_SITE_INFO(what) std::string( \
-    std::string(what) + "\n" + \
-    "  in " + std::string(BOOST_CURRENT_FUNCTION) + "\n" + \
-    "  at " + std::string(__FILE__) + ":" + BOOST_STRINGIZE(__LINE__) + "\n" \
-)
+namespace uhd{
 
-/*!
- * Throws an invalid code path exception with throw-site information.
- * Use this macro in places that code execution is not supposed to go.
- */
-#define UHD_THROW_INVALID_CODE_PATH() \
-    throw std::runtime_error(UHD_THROW_SITE_INFO("invalid code path"))
+    struct UHD_API exception : std::runtime_error{
+        exception(const std::string &what);
+        virtual unsigned code(void) const = 0;
+    };
+
+    struct UHD_API assertion_error : exception{
+        assertion_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API lookup_error : exception{
+        lookup_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API index_error : lookup_error{
+        index_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API key_error : lookup_error{
+        key_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API value_error : exception{
+        value_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API runtime_error : exception{
+        runtime_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API not_implemented_error : runtime_error{
+        not_implemented_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API environment_error : exception{
+        environment_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API io_error : environment_error{
+        io_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API os_error : environment_error{
+        os_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    struct UHD_API system_error : exception{
+        system_error(const std::string &what);
+        virtual unsigned code(void) const;
+    };
+
+    /*!
+     * Create a formated string with throw-site information.
+     * Fills in the function name, file name, and line number.
+     * \param what the std::exeption message
+     * \return the formatted exception message
+     */
+    #define UHD_THROW_SITE_INFO(what) std::string( \
+        std::string(what) + "\n" + \
+        "  in " + std::string(BOOST_CURRENT_FUNCTION) + "\n" + \
+        "  at " + std::string(__FILE__) + ":" + BOOST_STRINGIZE(__LINE__) + "\n" \
+    )
+
+    /*!
+     * Throws an invalid code path exception with throw-site information.
+     * Use this macro in places that code execution is not supposed to go.
+     */
+    #define UHD_THROW_INVALID_CODE_PATH() \
+        throw uhd::system_error(UHD_THROW_SITE_INFO("invalid code path"))
+
+} //namespace uhd
 
 #endif /* INCLUDED_UHD_UTILS_EXCEPTION_HPP */
diff --git a/host/lib/device.cpp b/host/lib/device.cpp
index 386588a08..34dd3f854 100644
--- a/host/lib/device.cpp
+++ b/host/lib/device.cpp
@@ -140,7 +140,7 @@ device::sptr device::make(const device_addr_t &hint, size_t which){
         return hash_to_device[dev_hash].lock();
     }
     //create and register a new device
-    catch(const uhd::assert_error &){
+    catch(const uhd::assertion_error &){
         device::sptr dev = maker(dev_addr);
         hash_to_device[dev_hash] = dev;
         return dev;
diff --git a/host/lib/usrp/dboard_eeprom.cpp b/host/lib/usrp/dboard_eeprom.cpp
index c47390bf8..5e8e27272 100644
--- a/host/lib/usrp/dboard_eeprom.cpp
+++ b/host/lib/usrp/dboard_eeprom.cpp
@@ -128,7 +128,7 @@ void dboard_eeprom_t::load(i2c_iface &iface, boost::uint8_t addr){
             &bytes.at(DB_EEPROM_SERIAL+DB_EEPROM_SERIAL_LEN))
         );
 
-    }catch(const uhd::assert_error &){
+    }catch(const uhd::assertion_error &){
         id = dboard_id_t::none();
         serial = "";
     }
diff --git a/host/lib/utils/CMakeLists.txt b/host/lib/utils/CMakeLists.txt
index a4d3b2db2..082553ff9 100644
--- a/host/lib/utils/CMakeLists.txt
+++ b/host/lib/utils/CMakeLists.txt
@@ -110,7 +110,7 @@ SET_SOURCE_FILES_PROPERTIES(
 # Append sources
 ########################################################################
 LIBUHD_APPEND_SOURCES(
-    ${CMAKE_CURRENT_SOURCE_DIR}/assert.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/exception.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/gain_group.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/images.cpp
     ${CMAKE_CURRENT_SOURCE_DIR}/load_modules.cpp
diff --git a/host/lib/utils/assert.cpp b/host/lib/utils/assert.cpp
deleted file mode 100644
index 7ace9024c..000000000
--- a/host/lib/utils/assert.cpp
+++ /dev/null
@@ -1,24 +0,0 @@
-//
-// Copyright 2010 Ettus Research LLC
-//
-// This program 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 of the License, or
-// (at your option) any later version.
-//
-// This program 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/>.
-//
-
-#include <uhd/utils/assert.hpp>
-
-using namespace uhd;
-
-assert_error::assert_error(const std::string &what) : std::runtime_error(what){
-    /* NOP */
-}
diff --git a/host/lib/utils/exception.cpp b/host/lib/utils/exception.cpp
new file mode 100644
index 000000000..e66addb0c
--- /dev/null
+++ b/host/lib/utils/exception.cpp
@@ -0,0 +1,47 @@
+//
+// Copyright 2011 Ettus Research LLC
+//
+// This program 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 of the License, or
+// (at your option) any later version.
+//
+// This program 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/>.
+//
+
+#include <uhd/utils/assert.hpp>
+#include <boost/functional/hash.hpp>
+#include <boost/format.hpp>
+
+using namespace uhd;
+
+static unsigned make_code(const std::string &name){
+    boost::hash<std::string> string_hash;
+    return unsigned(string_hash(name) & 0xfff);
+};
+
+exception::exception(const std::string &what):
+    std::runtime_error(what){/* NOP */}
+
+#define make_exception_impl(name, class, base) \
+    class::class(const std::string &what): \
+        base(str(boost::format("%s: %s") % name % what)){} \
+    unsigned class::code(void) const{return make_code(#class);}
+
+make_exception_impl("AssertionError",        assertion_error,         exception)
+make_exception_impl("LookupError",           lookup_error,            exception)
+make_exception_impl("IndexError",            index_error,             lookup_error)
+make_exception_impl("KeyError",              key_error,               lookup_error)
+make_exception_impl("ValueError",            value_error,             exception)
+make_exception_impl("RuntimeError",          runtime_error,           exception)
+make_exception_impl("NotImplementedError",   not_implemented_error,   runtime_error)
+make_exception_impl("EnvironmentError",      environment_error,       exception)
+make_exception_impl("IOError",               io_error,                environment_error)
+make_exception_impl("OSError",               os_error,                environment_error)
+make_exception_impl("SystemError",           system_error,            exception)
diff --git a/host/tests/error_test.cpp b/host/tests/error_test.cpp
index c76a15ab7..041e6b943 100644
--- a/host/tests/error_test.cpp
+++ b/host/tests/error_test.cpp
@@ -1,5 +1,5 @@
 //
-// Copyright 2010 Ettus Research LLC
+// Copyright 2010-2011 Ettus Research LLC
 //
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -16,10 +16,21 @@
 //
 
 #include <boost/test/unit_test.hpp>
+#include <uhd/utils/exception.hpp>
 #include <uhd/utils/assert.hpp>
 #include <vector>
 #include <iostream>
 
+BOOST_AUTO_TEST_CASE(test_exception_methods){
+    try{
+        throw uhd::assertion_error("your assertion failed: 1 != 2");
+    }
+    catch(const uhd::exception &e){
+        std::cout << "what: " << e.what() << std::endl;
+        std::cout << "code: " << e.code() << std::endl;
+    }
+}
+
 BOOST_AUTO_TEST_CASE(test_assert_has){
     std::vector<int> vec;
     vec.push_back(2);