X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fexceptions.h;h=5cbf6994154dadaeda169130cd82ac2ddaf48637;hp=96dc816ec4dea27cbbc94937dbf98a0c76c2fe6b;hb=89952bc64f5ae1b075b653f8a9daa02fd8d90260;hpb=bfe277e664a03ec47cd6bee7e1b1e4aca6eb38e6

diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h
index 96dc816ec..5cbf69941 100644
--- a/src/lib/exceptions.h
+++ b/src/lib/exceptions.h
@@ -1,95 +1,112 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic 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 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic 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, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+
 /** @file  src/lib/exceptions.h
  *  @brief Our exceptions.
  */
 
+
 #ifndef DCPOMATIC_EXCEPTIONS_H
 #define DCPOMATIC_EXCEPTIONS_H
 
-#include <boost/thread.hpp>
+
+#include "compose.hpp"
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
-#include <boost/exception/all.hpp>
 #include <boost/filesystem.hpp>
-#include <stdexcept>
+#include <boost/optional.hpp>
 #include <cstring>
+#include <stdexcept>
 
-/** @class StringError
- *  @brief A parent class for exceptions using messages held in a std::string
+
+/** @class DecodeError
+ *  @brief A low-level problem with the decoder (possibly due to the nature
+ *  of a source file).
  */
-class StringError : public std::exception
+class DecodeError : public std::runtime_error
 {
 public:
-	/** @param w Error message */
-	StringError (std::string w)
-		: _what (w)
+	explicit DecodeError (std::string s)
+		: std::runtime_error (s)
 	{}
 
-	virtual ~StringError () throw () {}
+	DecodeError (std::string function, std::string caller)
+		: std::runtime_error (String::compose("%1 failed [%2]", function, caller))
+	{}
 
-	/** @return error message */
-	char const * what () const throw () {
-		return _what.c_str ();
-	}
+	DecodeError (std::string function, std::string caller, int error)
+		: std::runtime_error (String::compose("%1 failed [%2] (%3)", function, caller, error))
+	{}
+
+	DecodeError (std::string function, std::string caller, boost::filesystem::path file)
+		: std::runtime_error (String::compose("%1 failed [%2] (%3)", function, caller, file.string()))
+	{}
 
-protected:
-	/** error message */
-	std::string _what;
+	DecodeError (std::string function, std::string caller, int error, boost::filesystem::path file)
+		: std::runtime_error (String::compose("%1 failed [%2] (%3) (%4)", function, caller, error, file.string()))
+	{}
 };
 
-/** @class DecodeError
- *  @brief A low-level problem with the decoder (possibly due to the nature
- *  of a source file).
- */
-class DecodeError : public StringError
+
+class CryptoError : public std::runtime_error
 {
 public:
-	DecodeError (std::string s)
-		: StringError (s)
+	explicit CryptoError (std::string s)
+		: std::runtime_error (s)
 	{}
 };
 
+
 /** @class EncodeError
  *  @brief A low-level problem with an encoder.
  */
-class EncodeError : public StringError
+class EncodeError : public std::runtime_error
 {
 public:
-	EncodeError (std::string s)
-		: StringError (s)
+	explicit EncodeError (std::string s)
+		: std::runtime_error (s)
+	{}
+
+	explicit EncodeError (std::string function, std::string caller)
+		: std::runtime_error (String::compose("%1 failed [%2]", function, caller))
+	{}
+
+	explicit EncodeError (std::string function, std::string caller, int error)
+		: std::runtime_error (String::compose("%1 failed [%2] (%3)", function, caller, error))
 	{}
 };
 
+
 /** @class FileError.
  *  @brief Parent class for file-related errors.
  */
-class FileError : public StringError
+class FileError : public std::runtime_error
 {
 public:
 	/** @param m Error message.
 	 *  @param f Name of the file that this exception concerns.
 	 */
 	FileError (std::string m, boost::filesystem::path f)
-		: StringError (m)
+		: std::runtime_error (String::compose("%1 with %2", m, f.string()))
 		, _file (f)
 	{}
 
@@ -105,32 +122,50 @@ private:
 	boost::filesystem::path _file;
 };
 
-class JoinError : public StringError
+
+class JoinError : public std::runtime_error
 {
 public:
-	JoinError (std::string s)
-		: StringError (s)
+	explicit JoinError (std::string s)
+		: std::runtime_error (s)
 	{}
 };
 
+
 /** @class OpenFileError.
  *  @brief Indicates that some error occurred when trying to open a file.
  */
 class OpenFileError : public FileError
 {
 public:
-	/** @param f File that we were trying to open */
-	OpenFileError (boost::filesystem::path f);
+	enum Mode {
+		READ,
+		WRITE,
+		READ_WRITE
+	};
+
+	/** @param f File that we were trying to open.
+	 *  @param error Code of error that occurred.
+	 *  @param mode Mode that we tried to open the file in.
+	 */
+	OpenFileError (boost::filesystem::path f, int error, Mode mode);
 };
 
-/** @class CreateFileError.
- *  @brief Indicates that some error occurred when trying to create a file.
- */
-class CreateFileError : public FileError
+
+class FileNotFoundError : public std::runtime_error
 {
 public:
-	/** @param f File that we were trying to create */
-	CreateFileError (boost::filesystem::path f);
+	FileNotFoundError (boost::filesystem::path f);
+	virtual ~FileNotFoundError () throw () {}
+
+	/** @return name of the file that this exception concerns */
+	boost::filesystem::path file () const {
+		return _file;
+	}
+
+private:
+	/** name of the file that this exception concerns */
+	boost::filesystem::path _file;
 };
 
 
@@ -146,6 +181,7 @@ public:
 	ReadFileError (boost::filesystem::path f, int e = 0);
 };
 
+
 /** @class WriteFileError.
  *  @brief Indicates that some error occurred when trying to write to a file
  */
@@ -158,17 +194,18 @@ public:
 	WriteFileError (boost::filesystem::path f, int e);
 };
 
+
 /** @class SettingError.
  *  @brief Indicates that something is wrong with a setting.
  */
-class SettingError : public StringError
+class SettingError : public std::runtime_error
 {
 public:
 	/** @param s Name of setting that was required.
 	 *  @param m Message.
 	 */
 	SettingError (std::string s, std::string m)
-		: StringError (m)
+		: std::runtime_error (m)
 		, _setting (s)
 	{}
 
@@ -183,6 +220,7 @@ private:
 	std::string _setting;
 };
 
+
 /** @class MissingSettingError.
  *  @brief Indicates that a Film is missing a setting that is required for some operation.
  */
@@ -190,122 +228,222 @@ class MissingSettingError : public SettingError
 {
 public:
 	/** @param s Name of setting that was required */
-	MissingSettingError (std::string s);
+	explicit MissingSettingError (std::string s);
 };
 
+
 /** @class BadSettingError
  *  @brief Indicates that a setting is bad in some way.
  */
 class BadSettingError : public SettingError
 {
 public:
-	/** @param s Name of setting that is bad */
+	/** @param s Name of setting that is bad.
+	 *  @param m Error message.
+	 */
 	BadSettingError (std::string s, std::string m)
 		: SettingError (s, m)
 	{}
 };
 
+
 /** @class NetworkError
  *  @brief Indicates some problem with communication on the network.
  */
-class NetworkError : public StringError
+class NetworkError : public std::runtime_error
 {
 public:
-	NetworkError (std::string s)
-		: StringError (s)
+	explicit NetworkError (std::string s)
+		: std::runtime_error (s)
 	{}
 };
 
+
 /** @class KDMError
  *  @brief A problem with a KDM.
  */
-class KDMError : public StringError
+class KDMError : public std::runtime_error
 {
 public:
-	KDMError (std::string s)
-		: StringError (s)
-	{}
+	KDMError (std::string s, std::string d);
+	~KDMError () throw() {}
+
+	std::string summary () const {
+		return _summary;
+	}
+
+	std::string detail () const {
+		return _detail;
+	}
+
+private:
+	std::string _summary;
+	std::string _detail;
 };
 
+
 /** @class PixelFormatError
  *  @brief A problem with an unsupported pixel format.
  */
-class PixelFormatError : public StringError
+class PixelFormatError : public std::runtime_error
 {
 public:
 	PixelFormatError (std::string o, AVPixelFormat f);
 };
 
-/** @class SubRipError
- *  @brief An error that occurs while parsing a SubRip file.
+
+/** @class TextSubtitleError
+ *  @brief An error that occurs while parsing a TextSubtitleError file.
  */
-class SubRipError : public FileError
+class TextSubtitleError : public FileError
 {
 public:
-	SubRipError (std::string, std::string, boost::filesystem::path);
+	TextSubtitleError (std::string, std::string, boost::filesystem::path);
 };
 
-class DCPError : public StringError
+
+class DCPError : public std::runtime_error
 {
 public:
-	DCPError (std::string s)
-		: StringError (s)
+	explicit DCPError (std::string s)
+		: std::runtime_error (s)
 	{}
 };
 
-class InvalidSignerError : public StringError
+
+/** @class ProjectFolderError
+ *  @brief An attempt has been made to read a DCP from a directory, but it looks
+ *  like the directory actually contains a DCP-o-matic project.
+ */
+class ProjectFolderError : public DCPError
+{
+public:
+	/* Code which catches this exception will provide their own message */
+	ProjectFolderError ()
+		: DCPError ("dummy")
+	{}
+};
+
+
+class InvalidSignerError : public std::runtime_error
 {
 public:
 	InvalidSignerError ();
+	explicit InvalidSignerError (std::string reason);
+};
+
+class ProgrammingError : public std::runtime_error
+
+{
+public:
+	ProgrammingError (std::string file, int line, std::string message = "");
+};
+
+
+class TextEncodingError : public std::runtime_error
+{
+public:
+	explicit TextEncodingError (std::string s)
+		: std::runtime_error (s)
+	{}
+};
+
+
+class MetadataError : public std::runtime_error
+{
+public:
+	explicit MetadataError (std::string s)
+		: std::runtime_error (s)
+	{}
+};
+
+
+class OldFormatError : public std::runtime_error
+{
+public:
+	explicit OldFormatError (std::string s)
+		: std::runtime_error (s)
+	{}
+};
+
+
+class KDMAsContentError : public std::runtime_error
+{
+public:
+	KDMAsContentError ();
+};
+
+
+class GLError : public std::runtime_error
+{
+public:
+	GLError (char const * last, int e);
+};
+
+
+/** @class CopyError
+ *  @brief An error which occurs when copying a DCP to a distribution drive.
+ */
+class CopyError : public std::runtime_error
+{
+public:
+	CopyError (std::string s, boost::optional<int> n = boost::optional<int>());
+	virtual ~CopyError () throw () {}
+
+	std::string message () const {
+		return _message;
+	}
+
+	boost::optional<int> number () const {
+		return _number;
+	}
+
+private:
+	std::string _message;
+	boost::optional<int> _number;
 };
 
-class ProgrammingError : public StringError
+
+/** @class CommunicationFailedError
+ *  @brief Communcation between dcpomatic2_disk and _disk_writer failed somehow.
+ */
+class CommunicationFailedError : public CopyError
 {
 public:
-	ProgrammingError (std::string file, int line);
+	CommunicationFailedError ();
 };
 
-/** @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 VerifyError
+ *  @brief An error which occurs when verifying a DCP that we copied to a distribution drive.
  */
-class ExceptionStore
+class VerifyError : public std::runtime_error
 {
 public:
-	void rethrow () {
-		boost::mutex::scoped_lock lm (_mutex);
-		if (_exception) {
-			boost::exception_ptr tmp = _exception;
-			_exception = boost::exception_ptr ();
-			boost::rethrow_exception (tmp);
-		}
+	VerifyError (std::string s, int n);
+	virtual ~VerifyError () throw () {}
+
+	std::string message () const {
+		return _message;
 	}
 
-protected:	
-	
-	void store_current () {
-		boost::mutex::scoped_lock lm (_mutex);
-		_exception = boost::current_exception ();
+	int number () const {
+		return _number;
 	}
 
 private:
-	boost::exception_ptr _exception;
-	mutable boost::mutex _mutex;
+	std::string _message;
+	int _number;
 };
 
+
+class PrivilegeError : public std::runtime_error
+{
+public:
+	explicit PrivilegeError (std::string s)
+			: std::runtime_error (s)
+		{}
+};
+
+
 #endif