Tidy up parameters in VerificationNote.

[libdcp.git] / src / exceptions.h

diff --git a/src/exceptions.h b/src/exceptions.h
index 2688ee86000666ee419580a61fc44feacd888a9e..76a66808d3a83caa524576081380e8b9913b1382 100644 (file)
--- a/src/exceptions.h
+++ b/src/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 libdcp.
 
@@ -35,6 +35,7 @@
 #define LIBDCP_EXCEPTIONS_H
 
 #include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 
 /** @file  src/exceptions.h
  *  @brief Exceptions thrown by libdcp.
@@ -90,32 +91,52 @@ public:
        {}
 };
 
-/** @class DCPReadError
- *  @brief A DCP read exception
+
+/** @class ReadError
+ *  @brief Any error that occurs when reading data from a DCP.
  */
-class DCPReadError : public std::runtime_error
+class ReadError : public std::runtime_error
 {
 public:
-       explicit DCPReadError (std::string message)
-               : std::runtime_error (message)
+       explicit ReadError (std::string message)
+               : std::runtime_error(message)
+               , _message(message)
        {}
+
+       ReadError (std::string message, std::string detail);
+
+       ~ReadError() throw () {}
+
+       std::string message () const {
+               return _message;
+       }
+
+       boost::optional<std::string> detail () const {
+               return _detail;
+       }
+
+private:
+       std::string _message;
+       boost::optional<std::string> _detail;
 };
 
-/** @class MissingAssetError
- *  @brief An error of a missing asset.
+
+/** @class J2KDecompressionError
+ *  @brief An error that occurs during decompression of JPEG2000 data.
  */
-class MissingAssetError : public DCPReadError
+class J2KDecompressionError : public ReadError
 {
 public:
-       enum AssetType {
-               MAIN_PICTURE,  //< main picture is missing
-               MAIN_SOUND,    //< main sound is missing
-               MAIN_SUBTITLE, //< main subtitle is missing
-               UNKNOWN        //< something is missing but we don't know what
-       };
+       explicit J2KDecompressionError (std::string message)
+               : ReadError (message)
+       {}
+};
 
-       MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
-       ~MissingAssetError () throw () {}
+
+class BadContentKindError : public ReadError
+{
+public:
+       BadContentKindError (std::string content_kind);
 };
 
 /** @class XMLError
@@ -167,16 +188,105 @@ public:
        ProgrammingError (std::string file, int line);
 };
 
-class MismatchedStandardError : public DCPReadError
+class KDMDecryptionError : public std::runtime_error
 {
 public:
-       MismatchedStandardError ();
+       KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax);
 };
 
-class KDMDecryptionError : public std::runtime_error
+class KDMFormatError : public std::runtime_error
+{
+public:
+       KDMFormatError (std::string message);
+};
+
+class CertificateChainError : public std::runtime_error
+{
+public:
+       CertificateChainError (std::string message);
+};
+
+class MissingSubtitleImageError : public std::runtime_error
+{
+public:
+       MissingSubtitleImageError (std::string id);
+};
+
+class BadKDMDateError : public std::runtime_error
+{
+public:
+       BadKDMDateError (bool starts_too_early);
+
+       bool starts_too_early () const {
+               return _starts_too_early;
+       }
+
+private:
+       bool _starts_too_early;
+};
+
+
+class StartCompressionError : public std::runtime_error
+{
+public:
+       explicit StartCompressionError (boost::optional<int> code = boost::optional<int>());
+       ~StartCompressionError () throw () {}
+
+       boost::optional<int> code () const {
+               return _code;
+       }
+
+private:
+       boost::optional<int> _code;
+};
+
+
+class CombineError : public std::runtime_error
+{
+public:
+       explicit CombineError (std::string message);
+};
+
+
+class LanguageTagError : public std::runtime_error
+{
+public:
+       LanguageTagError (std::string message);
+};
+
+
+class BadSettingError : public std::runtime_error
+{
+public:
+       BadSettingError (std::string message);
+};
+
+
+class DuplicateIdError : public std::runtime_error
+{
+public:
+       DuplicateIdError (std::string message);
+};
+
+
+class MainSoundConfigurationError : public std::runtime_error
+{
+public:
+       MainSoundConfigurationError (std::string s);
+};
+
+
+class UnknownChannelIdError : public std::runtime_error
+{
+public:
+       UnknownChannelIdError (std::string s);
+};
+
+
+class NoReelsError : public std::runtime_error
 {
 public:
-       KDMDecryptionError (std::string message);
+       NoReelsError ();
 };
 
 }