Tidy up some error handling a little.

[dcpomatic.git] / src / lib / exceptions.h

diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h
index f6b3bd902dd7a0cc8df5201ded9c08122bdd6989..8bce0c8abac7137a9ea3f62bdb396dfa774be696 100644 (file)
--- a/src/lib/exceptions.h
+++ b/src/lib/exceptions.h
@@ -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.
 
@@ -25,10 +25,12 @@
 #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>
 
@@ -42,6 +44,14 @@ public:
        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
@@ -73,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)
        {}
 
@@ -103,11 +113,33 @@ public:
 class OpenFileError : public FileError
 {
 public:
+       enum Mode {
+               READ,
+               WRITE,
+               READ_WRITE
+       };
+
        /** @param f File that we were trying to open.
         *  @param error Code of error that occurred.
-        *  @param reading true if we were opening to read, false if opening to write.
+        *  @param mode Mode that we tried to open the file in.
         */
-       OpenFileError (boost::filesystem::path f, int error, bool reading);
+       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.
@@ -242,6 +274,21 @@ public:
        {}
 };
 
+
+/** @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:
@@ -291,5 +338,68 @@ 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