Tidy up some error handling a little.
[dcpomatic.git] / src / lib / exceptions.h
index 1a32b5402194ba7357dfa385764c2b4b10d71b48..8bce0c8abac7137a9ea3f62bdb396dfa774be696 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 #ifndef DCPOMATIC_EXCEPTIONS_H
 #define DCPOMATIC_EXCEPTIONS_H
 
+#include "compose.hpp"
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
 #include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 #include <stdexcept>
 #include <cstring>
 
@@ -39,7 +41,23 @@ extern "C" {
 class DecodeError : public std::runtime_error
 {
 public:
-       DecodeError (std::string s)
+       explicit DecodeError (std::string s)
+               : std::runtime_error (s)
+       {}
+
+       explicit DecodeError (std::string function, std::string caller)
+               : std::runtime_error (String::compose("%1 failed in %2", function, caller))
+       {}
+
+       explicit DecodeError (std::string function, std::string caller, int error)
+               : std::runtime_error (String::compose("%1 failed in %2 (%3)", function, caller, error))
+       {}
+};
+
+class CryptoError : public std::runtime_error
+{
+public:
+       explicit CryptoError (std::string s)
                : std::runtime_error (s)
        {}
 };
@@ -50,7 +68,7 @@ public:
 class EncodeError : public std::runtime_error
 {
 public:
-       EncodeError (std::string s)
+       explicit EncodeError (std::string s)
                : std::runtime_error (s)
        {}
 };
@@ -65,7 +83,7 @@ public:
         *  @param f Name of the file that this exception concerns.
         */
        FileError (std::string m, boost::filesystem::path f)
-               : std::runtime_error (m)
+               : std::runtime_error (String::compose("%1 with %2", m, f.string()))
                , _file (f)
        {}
 
@@ -84,7 +102,7 @@ private:
 class JoinError : public std::runtime_error
 {
 public:
-       JoinError (std::string s)
+       explicit JoinError (std::string s)
                : std::runtime_error (s)
        {}
 };
@@ -95,8 +113,33 @@ public:
 class OpenFileError : public FileError
 {
 public:
-       /** @param f File that we were trying to open */
-       OpenFileError (boost::filesystem::path f, int error);
+       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 FileNotFoundError : public std::runtime_error
+{
+public:
+       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;
 };
 
 /** @class ReadFileError.
@@ -155,7 +198,7 @@ class MissingSettingError : public SettingError
 {
 public:
        /** @param s Name of setting that was required */
-       MissingSettingError (std::string s);
+       explicit MissingSettingError (std::string s);
 };
 
 /** @class BadSettingError
@@ -164,7 +207,9 @@ public:
 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)
        {}
@@ -176,7 +221,7 @@ public:
 class NetworkError : public std::runtime_error
 {
 public:
-       NetworkError (std::string s)
+       explicit NetworkError (std::string s)
                : std::runtime_error (s)
        {}
 };
@@ -187,9 +232,20 @@ public:
 class KDMError : public std::runtime_error
 {
 public:
-       KDMError (std::string s)
-               : std::runtime_error (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
@@ -213,29 +269,137 @@ public:
 class DCPError : public std::runtime_error
 {
 public:
-       DCPError (std::string s)
+       explicit DCPError (std::string s)
                : std::runtime_error (s)
        {}
 };
 
+
+/** @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);
+       ProgrammingError (std::string file, int line, std::string message = "");
 };
 
 class TextEncodingError : public std::runtime_error
 {
 public:
-       TextEncodingError (std::string s)
+       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 CommunicationFailedError
+ *  @brief Communcation between dcpomatic2_disk and _disk_writer failed somehow.
+ */
+class CommunicationFailedError : public CopyError
+{
+public:
+       CommunicationFailedError ();
+};
+
+
+/** @class VerifyError
+ *  @brief An error which occurs when verifying a DCP that we copied to a distribution drive.
+ */
+class VerifyError : public std::runtime_error
+{
+public:
+       VerifyError (std::string s, int n);
+       virtual ~VerifyError () throw () {}
+
+       std::string message () const {
+               return _message;
+       }
+
+       int number () const {
+               return _number;
+       }
+
+private:
+       std::string _message;
+       int _number;
+};
+
+
+class PrivilegeError : public std::runtime_error
+{
+public:
+       explicit PrivilegeError (std::string s)
+                       : std::runtime_error (s)
+               {}
+};
+
 #endif