X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fexceptions.h;h=17b18eb2876f38ee74b58bc85524e099d545bb75;hb=4c1a8e66f754d26e3db9c4c651e19ff4b6a94bb9;hp=bc5e83d17e3855326799650ef31037aa3ea34715;hpb=bfb33feb40c5b014e9eae3958b1ecb8161f1d090;p=libdcp.git diff --git a/src/exceptions.h b/src/exceptions.h index bc5e83d1..17b18eb2 100644 --- a/src/exceptions.h +++ b/src/exceptions.h @@ -1,26 +1,41 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2019 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. @@ -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,82 +79,174 @@ 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) + , _message(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 detail () const { + return _detail; } private: - /** error message */ std::string _message; + boost::optional _detail; }; -/** @class XMLError - * @brief An XML error +/** @class MissingAssetError + * @brief An error of a missing asset. */ -class XMLError : public std::exception +class MissingAssetError : public DCPReadError { public: - XMLError (std::string message) : _message (message) {} - ~XMLError () throw () {} - - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); + 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 () {} + + boost::filesystem::path path () const { + return _path; } private: - /** error message */ - std::string _message; + boost::filesystem::path _path; +}; + +class BadContentKindError : public DCPReadError +{ +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::exception +class UnresolvedRefError : public std::runtime_error { public: - UnresolvedRefError (std::string id); - ~UnresolvedRefError () throw () {} + explicit UnresolvedRefError (std::string id); +}; - /** @return error message */ - char const * what () const throw () { - return _message.c_str (); +/** @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 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: - std::string _message; + bool _starts_too_early; }; - + } #endif