No-op: remove all trailing whitespace.
[dcpomatic.git] / src / lib / exceptions.h
index f4631c09b67310bcf75492daca3b2b58dfd5e835..268e8c36d200771d84e291ccd90e8f215da54c29 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     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
 
 */
 
-#ifndef DCPOMATIC_EXCEPTIONS_H
-#define DCPOMATIC_EXCEPTIONS_H
-
-/** @file  src/exceptions.h
+/** @file  src/lib/exceptions.h
  *  @brief Our exceptions.
  */
 
-#include <stdexcept>
-#include <cstring>
-#include <boost/exception/all.hpp>
-#include <boost/filesystem.hpp>
+#ifndef DCPOMATIC_EXCEPTIONS_H
+#define DCPOMATIC_EXCEPTIONS_H
+
 #include <boost/thread.hpp>
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
+#include <boost/exception/all.hpp>
+#include <boost/filesystem.hpp>
+#include <stdexcept>
+#include <cstring>
 
 /** @class StringError
  *  @brief A parent class for exceptions using messages held in a std::string
@@ -40,9 +40,9 @@ class StringError : public std::exception
 {
 public:
        /** @param w Error message */
-       StringError (std::string w) {
-               _what = w;
-       }
+       StringError (std::string w)
+               : _what (w)
+       {}
 
        virtual ~StringError () throw () {}
 
@@ -205,7 +205,7 @@ public:
        {}
 };
 
-/** @class NetworkError.
+/** @class NetworkError
  *  @brief Indicates some problem with communication on the network.
  */
 class NetworkError : public StringError
@@ -216,6 +216,9 @@ public:
        {}
 };
 
+/** @class KDMError
+ *  @brief A problem with a KDM.
+ */
 class KDMError : public StringError
 {
 public:
@@ -224,27 +227,77 @@ public:
        {}
 };
 
+/** @class PixelFormatError
+ *  @brief A problem with an unsupported pixel format.
+ */
 class PixelFormatError : public StringError
 {
 public:
        PixelFormatError (std::string o, AVPixelFormat f);
 };
 
+/** @class SubRipError
+ *  @brief An error that occurs while parsing a SubRip file.
+ */
+class SubRipError : public FileError
+{
+public:
+       SubRipError (std::string, std::string, boost::filesystem::path);
+};
+
+class DCPError : public StringError
+{
+public:
+       DCPError (std::string s)
+               : StringError (s)
+       {}
+};
+
+class InvalidSignerError : public StringError
+{
+public:
+       InvalidSignerError ();
+};
+
+class ProgrammingError : public StringError
+{
+public:
+       ProgrammingError (std::string file, int line);
+};
+
+/** @class ExceptionStore
+ *  @brief A parent class for classes which have a need to catch and
+ *  re-throw exceptions.
+ *
+ *  This is intended for classes which run their own thread; they should do
+ *  something like
+ *
+ *  void my_thread ()
+ *  try {
+ *    // do things which might throw exceptions
+ *  } catch (...) {
+ *    store_current ();
+ *  }
+ *
+ *  and then in another thread call rethrow().  If any
+ *  exception was thrown by my_thread it will be stored by
+ *  store_current() and then rethrow() will re-throw it where
+ *  it can be handled.
+ */
 class ExceptionStore
 {
 public:
-       bool thrown () const {
-               boost::mutex::scoped_lock lm (_mutex);
-               return _exception;
-       }
-       
        void rethrow () {
                boost::mutex::scoped_lock lm (_mutex);
-               boost::rethrow_exception (_exception);
+               if (_exception) {
+                       boost::exception_ptr tmp = _exception;
+                       _exception = boost::exception_ptr ();
+                       boost::rethrow_exception (tmp);
+               }
        }
 
-protected:     
-       
+protected:
+
        void store_current () {
                boost::mutex::scoped_lock lm (_mutex);
                _exception = boost::current_exception ();
@@ -255,6 +308,4 @@ private:
        mutable boost::mutex _mutex;
 };
 
-       
-
 #endif