X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fexceptions.h;h=78d0943e6eac7b6d5b683abd6ee8d156f0dc5089;hb=4bd57fbbac67ac04ec47a9765b9f278aa1691851;hp=5d8000d710418db8ebd80ade1de5f70ab0d92244;hpb=e64f6002a413f7aaffca60387d82c2e91b931ab9;p=libdcp.git diff --git a/src/exceptions.h b/src/exceptions.h index 5d8000d7..78d0943e 100644 --- a/src/exceptions.h +++ b/src/exceptions.h @@ -1,48 +1,63 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2021 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. */ + +/** @file src/exceptions.h + * @brief Exceptions thrown by libdcp + */ + + #ifndef LIBDCP_EXCEPTIONS_H #define LIBDCP_EXCEPTIONS_H + #include +#include -/** @file src/exceptions.h - * @brief Exceptions thrown by libdcp. - */ 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,13 +69,12 @@ public: } private: - /** message part */ - std::string _message; /** filename of file that was involved */ boost::filesystem::path _filename; int _number; }; + /** @class MXFFileError * @brief An exception related to an MXF file */ @@ -71,123 +85,239 @@ 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 () {} + explicit MiscError (std::string message) + : std::runtime_error (message) + {} +}; + + +/** @class ReadError + * @brief Any error that occurs when reading data from a DCP + */ +class ReadError : public std::runtime_error +{ +public: + 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; }; -/** @class DCPReadError - * @brief A DCP read exception + +/** @class J2KDecompressionError + * @brief An error that occurs during decompression of JPEG2000 data */ -class DCPReadError : public std::exception +class J2KDecompressionError : public ReadError { public: - DCPReadError (std::string message) : _message (message) {} - ~DCPReadError () throw () {} + explicit J2KDecompressionError (std::string message) + : ReadError (message) + {} +}; - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); - } -protected: - DCPReadError () {} - - /** error message */ - std::string _message; +class BadContentKindError : public ReadError +{ +public: + BadContentKindError (std::string content_kind); }; -/** @class MissingAssetError - * @brief An error of a missing asset. + +/** @class MissingAssetmapError + * @brief Thrown when no ASSETMAP was found when trying to read a DCP */ -class MissingAssetError : public DCPReadError +class MissingAssetmapError : 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 - }; - - MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN); - ~MissingAssetError () throw () {} - -private: - boost::filesystem::path _path; - AssetType _type; + explicit MissingAssetmapError (boost::filesystem::path dir); }; + /** @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: + 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); +}; + + +class KDMDecryptionError : public std::runtime_error { public: - UnresolvedRefError (std::string id); - ~UnresolvedRefError () throw () {} + KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax); +}; - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); + +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: - std::string _message; + bool _starts_too_early; }; -/** @class TimeFormatError - * @brief A an error with a string passed to LocalTime. - */ -class TimeFormatError : public std::exception + +class StartCompressionError : public std::runtime_error { public: - TimeFormatError (std::string bad_time); - ~TimeFormatError () 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: - 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