Add some more DecodeError constructors.
[dcpomatic.git] / src / lib / exceptions.h
index 0f8a2eda27a6b9fa7a42dab355331953ea51a691..5cbf6994154dadaeda169130cd82ac2ddaf48637 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 /** @file  src/lib/exceptions.h
  *  @brief Our exceptions.
  */
 
+
 #ifndef DCPOMATIC_EXCEPTIONS_H
 #define DCPOMATIC_EXCEPTIONS_H
 
+
 #include "compose.hpp"
 extern "C" {
 #include <libavutil/pixfmt.h>
 }
 #include <boost/filesystem.hpp>
-#include <stdexcept>
+#include <boost/optional.hpp>
 #include <cstring>
+#include <stdexcept>
+
 
 /** @class DecodeError
  *  @brief A low-level problem with the decoder (possibly due to the nature
@@ -43,8 +48,25 @@ public:
        explicit DecodeError (std::string s)
                : std::runtime_error (s)
        {}
+
+       DecodeError (std::string function, std::string caller)
+               : std::runtime_error (String::compose("%1 failed [%2]", function, caller))
+       {}
+
+       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()))
+       {}
+
+       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 CryptoError : public std::runtime_error
 {
 public:
@@ -53,6 +75,7 @@ public:
        {}
 };
 
+
 /** @class EncodeError
  *  @brief A low-level problem with an encoder.
  */
@@ -62,8 +85,17 @@ public:
        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.
  */
@@ -90,6 +122,7 @@ private:
        boost::filesystem::path _file;
 };
 
+
 class JoinError : public std::runtime_error
 {
 public:
@@ -98,6 +131,7 @@ public:
        {}
 };
 
+
 /** @class OpenFileError.
  *  @brief Indicates that some error occurred when trying to open a file.
  */
@@ -117,6 +151,7 @@ public:
        OpenFileError (boost::filesystem::path f, int error, Mode mode);
 };
 
+
 class FileNotFoundError : public std::runtime_error
 {
 public:
@@ -133,6 +168,7 @@ private:
        boost::filesystem::path _file;
 };
 
+
 /** @class ReadFileError.
  *  @brief Indicates that some error occurred when trying to read from a file
  */
@@ -145,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
  */
@@ -157,6 +194,7 @@ public:
        WriteFileError (boost::filesystem::path f, int e);
 };
 
+
 /** @class SettingError.
  *  @brief Indicates that something is wrong with a setting.
  */
@@ -182,6 +220,7 @@ private:
        std::string _setting;
 };
 
+
 /** @class MissingSettingError.
  *  @brief Indicates that a Film is missing a setting that is required for some operation.
  */
@@ -192,6 +231,7 @@ public:
        explicit MissingSettingError (std::string s);
 };
 
+
 /** @class BadSettingError
  *  @brief Indicates that a setting is bad in some way.
  */
@@ -206,6 +246,7 @@ public:
        {}
 };
 
+
 /** @class NetworkError
  *  @brief Indicates some problem with communication on the network.
  */
@@ -217,6 +258,7 @@ public:
        {}
 };
 
+
 /** @class KDMError
  *  @brief A problem with a KDM.
  */
@@ -239,6 +281,7 @@ private:
        std::string _detail;
 };
 
+
 /** @class PixelFormatError
  *  @brief A problem with an unsupported pixel format.
  */
@@ -248,6 +291,7 @@ public:
        PixelFormatError (std::string o, AVPixelFormat f);
 };
 
+
 /** @class TextSubtitleError
  *  @brief An error that occurs while parsing a TextSubtitleError file.
  */
@@ -257,6 +301,7 @@ public:
        TextSubtitleError (std::string, std::string, boost::filesystem::path);
 };
 
+
 class DCPError : public std::runtime_error
 {
 public:
@@ -265,6 +310,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:
@@ -273,11 +333,13 @@ public:
 };
 
 class ProgrammingError : public std::runtime_error
+
 {
 public:
        ProgrammingError (std::string file, int line, std::string message = "");
 };
 
+
 class TextEncodingError : public std::runtime_error
 {
 public:
@@ -286,6 +348,7 @@ public:
        {}
 };
 
+
 class MetadataError : public std::runtime_error
 {
 public:
@@ -294,6 +357,7 @@ public:
        {}
 };
 
+
 class OldFormatError : public std::runtime_error
 {
 public:
@@ -302,40 +366,54 @@ public:
        {}
 };
 
+
 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, int n);
+       CopyError (std::string s, boost::optional<int> n = boost::optional<int>());
        virtual ~CopyError () throw () {}
 
        std::string message () const {
                return _message;
        }
 
-       int number () const {
+       boost::optional<int> number () const {
                return _number;
        }
 
 private:
        std::string _message;
-       int _number;
+       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.
  */
@@ -357,4 +435,15 @@ private:
        std::string _message;
        int _number;
 };
+
+
+class PrivilegeError : public std::runtime_error
+{
+public:
+       explicit PrivilegeError (std::string s)
+                       : std::runtime_error (s)
+               {}
+};
+
+
 #endif