Report errors passed back from DCP::read when exceptions aren't used.

[libdcp.git] / src / exceptions.h

diff --git a/src/exceptions.h b/src/exceptions.h
index 801bfb019a92d80f309407fe9fd7d754ed536398..17b18eb2876f38ee74b58bc85524e099d545bb75 100644 (file)
--- a/src/exceptions.h
+++ b/src/exceptions.h
@@ -1,26 +1,41 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp 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,
+    libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
 #ifndef LIBDCP_EXCEPTIONS_H
 #define LIBDCP_EXCEPTIONS_H
 
 #include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 
 /** @file  src/exceptions.h
  *  @brief Exceptions thrown by libdcp.
@@ -71,7 +86,7 @@ public:
 class MiscError : public std::runtime_error
 {
 public:
-       MiscError (std::string message)
+       explicit MiscError (std::string message)
                : std::runtime_error (message)
        {}
 };
@@ -82,9 +97,26 @@ public:
 class DCPReadError : public std::runtime_error
 {
 public:
-       DCPReadError (std::string message)
-               : std::runtime_error (message)
+       explicit DCPReadError (std::string message)
+               : std::runtime_error(message)
+               , _message(message)
        {}
+
+       DCPReadError (std::string message, std::string detail);
+
+       ~DCPReadError() 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
@@ -102,6 +134,19 @@ public:
 
        MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
        ~MissingAssetError () throw () {}
+
+       boost::filesystem::path path () const {
+               return _path;
+       }
+
+private:
+       boost::filesystem::path _path;
+};
+
+class BadContentKindError : public DCPReadError
+{
+public:
+       BadContentKindError (std::string content_kind);
 };
 
 /** @class XMLError
@@ -110,7 +155,7 @@ public:
 class XMLError : public std::runtime_error
 {
 public:
-       XMLError (std::string message)
+       explicit XMLError (std::string message)
                : std::runtime_error (message)
        {}
 };
@@ -121,7 +166,7 @@ public:
 class UnresolvedRefError : public std::runtime_error
 {
 public:
-       UnresolvedRefError (std::string id);
+       explicit UnresolvedRefError (std::string id);
 };
 
 /** @class TimeFormatError
@@ -130,7 +175,7 @@ public:
 class TimeFormatError : public std::runtime_error
 {
 public:
-       TimeFormatError (std::string bad_time);
+       explicit TimeFormatError (std::string bad_time);
 };
 
 /** @class NotEncryptedError
@@ -140,7 +185,7 @@ public:
 class NotEncryptedError : public std::runtime_error
 {
 public:
-       NotEncryptedError (std::string const & what);
+       explicit NotEncryptedError (std::string const & what);
        ~NotEncryptedError () throw () {}
 };
 
@@ -153,6 +198,55 @@ public:
        ProgrammingError (std::string file, int line);
 };
 
+class MismatchedStandardError : public DCPReadError
+{
+public:
+       MismatchedStandardError ();
+};
+
+class KDMDecryptionError : public std::runtime_error
+{
+public:
+       KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax);
+};
+
+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 EmptyAssetPathError : public DCPReadError
+{
+public:
+       EmptyAssetPathError (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;
+};
+
 }
 
 #endif