X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fexceptions.h;h=76a66808d3a83caa524576081380e8b9913b1382;hb=3924dd859ad3de1d4a207d04e841f699bd27490a;hp=4c53a66dd1664c10d1dc1352ac99306f71cbcfdd;hpb=ed6a471b61d36a3ba7e8696fa3e5606406c5cf62;p=libdcp.git diff --git a/src/exceptions.h b/src/exceptions.h index 4c53a66d..76a66808 100644 --- a/src/exceptions.h +++ b/src/exceptions.h @@ -1,120 +1,294 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington - 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 . + + 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 +#include + /** @file src/exceptions.h * @brief Exceptions thrown by libdcp. */ -namespace libdcp +namespace dcp { -/** @brief An exception related to a file */ -class FileError : public std::exception +/** @class FileError + * @brief An exception related to a file + */ +class FileError : public std::runtime_error { public: - FileError (std::string const & message, std::string const & filename) - : _message (message) - , _filename (filename) - {} - + 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 */ - std::string filename () const { + boost::filesystem::path filename () const { return _filename; } + /** @return error number of the error */ + int number () const { + return _number; + } + private: - /** error message */ - std::string _message; /** filename of file that was involved */ - std::string _filename; + boost::filesystem::path _filename; + int _number; }; -/** @brief An exception related to an MXF file */ +/** @class MXFFileError + * @brief An exception related to an MXF file + */ class MXFFileError : public FileError { public: - MXFFileError (std::string const & message, std::string const & filename) - : FileError (message, filename) + MXFFileError (std::string message, boost::filesystem::path filename, int number) + : FileError (message, filename, number) + {} +}; + +/** @class MiscError + * @brief A miscellaneous exception + */ +class MiscError : public std::runtime_error +{ +public: + explicit MiscError (std::string message) + : std::runtime_error (message) {} }; - -/** @brief A miscellaneous exception */ -class MiscError : public std::exception + + +/** @class ReadError + * @brief Any error that occurs when reading data from a DCP. + */ +class ReadError : public std::runtime_error { public: - MiscError (std::string const & message) : _message (message) {} - ~MiscError () throw () {} + explicit ReadError (std::string message) + : std::runtime_error(message) + , _message(message) + {} + + ReadError (std::string message, std::string detail); - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); + ~ReadError() throw () {} + + std::string message () const { + return _message; + } + + boost::optional detail () const { + return _detail; } private: - /** error message */ std::string _message; + boost::optional _detail; }; -/** @brief A DCP read exception */ -class DCPReadError : public std::exception + +/** @class J2KDecompressionError + * @brief An error that occurs during decompression of JPEG2000 data. + */ +class J2KDecompressionError : public ReadError { public: - DCPReadError (std::string const & message) : _message (message) {} - ~DCPReadError () throw () {} + explicit J2KDecompressionError (std::string message) + : ReadError (message) + {} +}; + + +class BadContentKindError : public ReadError +{ +public: + BadContentKindError (std::string content_kind); +}; + +/** @class XMLError + * @brief An XML error + */ +class XMLError : public std::runtime_error +{ +public: + 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::runtime_error +{ +public: + explicit UnresolvedRefError (std::string id); +}; + +/** @class TimeFormatError + * @brief A an error with a string passed to LocalTime. + */ +class TimeFormatError : public std::runtime_error +{ +public: + 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 std::runtime_error +{ +public: + 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 std::runtime_error +{ +public: + ProgrammingError (std::string file, int line); +}; - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); +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 BadKDMDateError : public std::runtime_error +{ +public: + BadKDMDateError (bool starts_too_early); + + bool starts_too_early () const { + return _starts_too_early; } private: - /** error message */ - std::string _message; + bool _starts_too_early; }; -/** @brief An XML error */ -class XMLError : public std::exception + +class StartCompressionError : public std::runtime_error { public: - XMLError (std::string const & message) : _message (message) {} - ~XMLError () throw () {} + explicit StartCompressionError (boost::optional code = boost::optional()); + ~StartCompressionError () throw () {} - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); + boost::optional code () const { + return _code; } private: - /** error message */ - std::string _message; + boost::optional _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: + NoReelsError (); +}; + } #endif