Throw a better error on bad content kind.
[libdcp.git] / src / exceptions.h
index e613c980d037c872d52177b24499d77a6b1c2cba..d66e89449632eb13a9d8b823464a1b2657446625 100644 (file)
@@ -1,26 +1,41 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 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.
 namespace dcp
 {
 
-/** @class StringError
- *  @brief An exception that uses a std::string to store its error message.
- */
-class StringError : public std::exception
-{
-public:
-       StringError () {}
-       StringError (std::string message)
-               : _message (message)
-       {}
-                           
-       ~StringError () throw () {}
-
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
-
-protected:
-       std::string _message;
-};
-
 /** @class FileError
  *  @brief An exception related to a file
  */
-class FileError : public StringError
+class FileError : public std::runtime_error
 {
 public:
        FileError (std::string message, boost::filesystem::path filename, int number);
@@ -86,30 +79,44 @@ public:
                : FileError (message, filename, number)
        {}
 };
-       
+
 /** @class MiscError
  *  @brief A miscellaneous exception
  */
-class MiscError : public StringError
+class MiscError : public std::runtime_error
 {
 public:
-       MiscError (std::string message)
-               : StringError (message)
+       explicit MiscError (std::string message)
+               : std::runtime_error (message)
        {}
 };
 
 /** @class DCPReadError
  *  @brief A DCP read exception
  */
-class DCPReadError : public StringError
+class DCPReadError : public std::runtime_error
 {
 public:
-       DCPReadError (std::string message)
-               : StringError (message)
+       explicit DCPReadError (std::string message)
+               : std::runtime_error(message)
+               , _message(message)
        {}
 
-protected:
-       DCPReadError () {}
+       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
@@ -124,64 +131,90 @@ public:
                MAIN_SUBTITLE, //< main subtitle is missing
                UNKNOWN        //< something is missing but we don't know what
        };
-       
+
        MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
        ~MissingAssetError () throw () {}
+};
 
-private:
-       boost::filesystem::path _path;
-       AssetType _type;
+class BadContentKindError : public DCPReadError
+{
+public:
+       BadContentKindError (std::string content_kind);
 };
 
 /** @class XMLError
  *  @brief An XML error
  */
-class XMLError : public StringError
+class XMLError : public std::runtime_error
 {
 public:
-       XMLError (std::string message)
-               : StringError (message)
+       explicit XMLError (std::string message)
+               : std::runtime_error (message)
        {}
 };
 
 /** @class UnresolvedRefError
  *  @brief An exception caused by a reference (by UUID) to something which is not known
  */
-class UnresolvedRefError : public StringError
+class UnresolvedRefError : public std::runtime_error
 {
 public:
-       UnresolvedRefError (std::string id);
+       explicit UnresolvedRefError (std::string id);
 };
 
 /** @class TimeFormatError
  *  @brief A an error with a string passed to LocalTime.
  */
-class TimeFormatError : public StringError
+class TimeFormatError : public std::runtime_error
 {
 public:
-       TimeFormatError (std::string bad_time);
+       explicit TimeFormatError (std::string bad_time);
 };
 
 /** @class NotEncryptedError
  *  @brief An error raised when creating a DecryptedKDM object for assets that are not
  *  encrypted.
  */
-class NotEncryptedError : public StringError
+class NotEncryptedError : public std::runtime_error
 {
 public:
-       NotEncryptedError (std::string const & what);
+       explicit NotEncryptedError (std::string const & what);
        ~NotEncryptedError () throw () {}
 };
 
 /** @class ProgrammingError
  *  @brief An exception thrown when a DCP_ASSERT fails; something that should not happen.
  */
-class ProgrammingError : public StringError
+class ProgrammingError : public std::runtime_error
 {
 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);
+};
+
 }
 
 #endif