Remove old warning.
[libdcp.git] / src / exceptions.h
index 7446e352522fefaee4bdd2a4f7de860b2b3696f2..2871ee86598f7696373ca452ec2ee26e8c5d9c39 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.
@@ -32,17 +47,12 @@ namespace dcp
 /** @class FileError
  *  @brief An exception related to a file
  */
-class FileError : public std::exception
+class FileError : public std::runtime_error
 {
 public:
        FileError (std::string message, boost::filesystem::path filename, int number);
        ~FileError () throw () {}
 
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
-       
        /** @return filename of file that was involved */
        boost::filesystem::path filename () const {
                return _filename;
@@ -54,8 +64,6 @@ public:
        }
 
 private:
-       /** message part */
-       std::string _message;
        /** filename of file that was involved */
        boost::filesystem::path _filename;
        int _number;
@@ -71,98 +79,133 @@ public:
                : FileError (message, filename, number)
        {}
 };
-       
+
 /** @class MiscError
  *  @brief A miscellaneous exception
  */
-class MiscError : public std::exception
+class MiscError : public std::runtime_error
 {
 public:
-       MiscError (std::string message) : _message (message) {}
-       ~MiscError () throw () {}
-
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
-
-private:
-       /** error message */
-       std::string _message;
+       explicit MiscError (std::string message)
+               : std::runtime_error (message)
+       {}
 };
 
 /** @class DCPReadError
  *  @brief A DCP read exception
  */
-class DCPReadError : public std::exception
+class DCPReadError : public std::runtime_error
 {
 public:
-       DCPReadError (std::string message) : _message (message) {}
-       ~DCPReadError () throw () {}
+       explicit DCPReadError (std::string message)
+               : std::runtime_error(message)
+       {}
+
+       DCPReadError (std::string message, std::string detail);
+
+       ~DCPReadError() throw () {}
+
+       std::string message () const {
+               return _message;
+       }
 
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
+       boost::optional<std::string> detail () const {
+               return _detail;
        }
 
 private:
-       /** error message */
        std::string _message;
+       boost::optional<std::string> _detail;
+};
+
+/** @class MissingAssetError
+ *  @brief An error of a missing asset.
+ */
+class MissingAssetError : public DCPReadError
+{
+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
+       };
+
+       MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
+       ~MissingAssetError () throw () {}
 };
 
 /** @class XMLError
  *  @brief An XML error
  */
-class XMLError : public std::exception
+class XMLError : public std::runtime_error
 {
 public:
-       XMLError (std::string message) : _message (message) {}
-       ~XMLError () throw () {}
-
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
-
-private:
-       /** error message */
-       std::string _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 std::exception
+class UnresolvedRefError : public std::runtime_error
 {
 public:
-       UnresolvedRefError (std::string id);
-       ~UnresolvedRefError () throw () {}
-
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
-
-private:
-       std::string _message;
+       explicit UnresolvedRefError (std::string id);
 };
 
 /** @class TimeFormatError
  *  @brief A an error with a string passed to LocalTime.
  */
-class TimeFormatError : public std::exception
+class TimeFormatError : public std::runtime_error
 {
 public:
-       TimeFormatError (std::string bad_time);
-       ~TimeFormatError () throw () {}
+       explicit TimeFormatError (std::string bad_time);
+};
 
-       /** @return error message */
-       char const * what () const throw () {
-               return _message.c_str ();
-       }
+/** @class NotEncryptedError
+ *  @brief An error raised when creating a DecryptedKDM object for assets that are not
+ *  encrypted.
+ */
+class NotEncryptedError : public std::runtime_error
+{
+public:
+       explicit NotEncryptedError (std::string const & what);
+       ~NotEncryptedError () throw () {}
+};
 
-private:
-       std::string _message;
+/** @class ProgrammingError
+ *  @brief An exception thrown when a DCP_ASSERT fails; something that should not happen.
+ */
+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);
 };
 
 }