X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fexceptions.h;h=99f0a5d8735e83c9fca7a57f8b4f2fafc40846ba;hp=213be6186d523a713a0a3f167f77127e0047164e;hb=94ee305348f7d3eb548fd44ca4aa1c57645056b1;hpb=a79d78d8bb6d51f6662f1f63b9f8fd19e1a0c5f1 diff --git a/src/lib/exceptions.h b/src/lib/exceptions.h index 213be6186..99f0a5d87 100644 --- a/src/lib/exceptions.h +++ b/src/lib/exceptions.h @@ -1,95 +1,80 @@ /* - 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 DCP-o-matic. + + DCP-o-matic 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, + DCP-o-matic 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 DCP-o-matic. If not, see . */ -#ifndef DCPOMATIC_EXCEPTIONS_H -#define DCPOMATIC_EXCEPTIONS_H - -/** @file src/exceptions.h +/** @file src/lib/exceptions.h * @brief Our exceptions. */ -#include -#include -#include -#include -#include +#ifndef DCPOMATIC_EXCEPTIONS_H +#define DCPOMATIC_EXCEPTIONS_H + +#include "compose.hpp" extern "C" { #include } +#include +#include +#include -/** @class StringError - * @brief A parent class for exceptions using messages held in a std::string +/** @class DecodeError + * @brief A low-level problem with the decoder (possibly due to the nature + * of a source file). */ -class StringError : public std::exception +class DecodeError : public std::runtime_error { public: - /** @param w Error message */ - StringError (std::string w) { - _what = w; - } - - virtual ~StringError () throw () {} - - /** @return error message */ - char const * what () const throw () { - return _what.c_str (); - } - -protected: - /** error message */ - std::string _what; + explicit DecodeError (std::string s) + : std::runtime_error (s) + {} }; -/** @class DecodeError - * @brief A low-level problem with the decoder (possibly due to the nature - * of a source file). - */ -class DecodeError : public StringError +class CryptoError : public std::runtime_error { public: - DecodeError (std::string s) - : StringError (s) + explicit CryptoError (std::string s) + : std::runtime_error (s) {} }; /** @class EncodeError * @brief A low-level problem with an encoder. */ -class EncodeError : public StringError +class EncodeError : public std::runtime_error { public: - EncodeError (std::string s) - : StringError (s) + explicit EncodeError (std::string s) + : std::runtime_error (s) {} }; /** @class FileError. * @brief Parent class for file-related errors. */ -class FileError : public StringError +class FileError : public std::runtime_error { public: /** @param m Error message. * @param f Name of the file that this exception concerns. */ FileError (std::string m, boost::filesystem::path f) - : StringError (m) + : std::runtime_error (String::compose("%1 with %2", m, f.string())) , _file (f) {} @@ -105,11 +90,11 @@ private: boost::filesystem::path _file; }; -class JoinError : public StringError +class JoinError : public std::runtime_error { public: - JoinError (std::string s) - : StringError (s) + explicit JoinError (std::string s) + : std::runtime_error (s) {} }; @@ -119,21 +104,19 @@ public: class OpenFileError : public FileError { public: - /** @param f File that we were trying to open */ - OpenFileError (boost::filesystem::path f); -}; - -/** @class CreateFileError. - * @brief Indicates that some error occurred when trying to create a file. - */ -class CreateFileError : public FileError -{ -public: - /** @param f File that we were trying to create */ - CreateFileError (boost::filesystem::path f); + enum Mode { + READ, + WRITE, + READ_WRITE + }; + + /** @param f File that we were trying to open. + * @param error Code of error that occurred. + * @param mode Mode that we tried to open the file in. + */ + OpenFileError (boost::filesystem::path f, int error, Mode mode); }; - /** @class ReadFileError. * @brief Indicates that some error occurred when trying to read from a file */ @@ -161,14 +144,14 @@ public: /** @class SettingError. * @brief Indicates that something is wrong with a setting. */ -class SettingError : public StringError +class SettingError : public std::runtime_error { public: /** @param s Name of setting that was required. * @param m Message. */ SettingError (std::string s, std::string m) - : StringError (m) + : std::runtime_error (m) , _setting (s) {} @@ -190,7 +173,7 @@ class MissingSettingError : public SettingError { public: /** @param s Name of setting that was required */ - MissingSettingError (std::string s); + explicit MissingSettingError (std::string s); }; /** @class BadSettingError @@ -199,83 +182,114 @@ public: class BadSettingError : public SettingError { public: - /** @param s Name of setting that is bad */ + /** @param s Name of setting that is bad. + * @param m Error message. + */ BadSettingError (std::string s, std::string m) : SettingError (s, m) {} }; -/** @class NetworkError. +/** @class NetworkError * @brief Indicates some problem with communication on the network. */ -class NetworkError : public StringError +class NetworkError : public std::runtime_error { public: - NetworkError (std::string s) - : StringError (s) + explicit NetworkError (std::string s) + : std::runtime_error (s) {} }; -class KDMError : public StringError +/** @class KDMError + * @brief A problem with a KDM. + */ +class KDMError : public std::runtime_error { public: - KDMError (std::string s) - : StringError (s) - {} + KDMError (std::string s, std::string d); + ~KDMError () throw() {} + + std::string summary () const { + return _summary; + } + + std::string detail () const { + return _detail; + } + +private: + std::string _summary; + std::string _detail; }; -class PixelFormatError : public StringError +/** @class PixelFormatError + * @brief A problem with an unsupported pixel format. + */ +class PixelFormatError : public std::runtime_error { public: PixelFormatError (std::string o, AVPixelFormat f); }; -/** An error that occurs while parsing a SubRip file */ -class SubRipError : public FileError +/** @class TextSubtitleError + * @brief An error that occurs while parsing a TextSubtitleError file. + */ +class TextSubtitleError : public FileError { public: - SubRipError (std::string, std::string, boost::filesystem::path); + TextSubtitleError (std::string, std::string, boost::filesystem::path); }; -/** A parent class for classes which have a need to catch and - * re-throw exceptions. This is intended for classes - * which run their own thread; they should do something like - * - * void my_thread () - * try { - * // do things which might throw exceptions - * } catch (...) { - * store_current (); - * } - * - * and then in another thread call rethrow(). If any - * exception was thrown by my_thread it will be stored by - * store_current() and then rethrow() will re-throw it where - * it can be handled. - */ -class ExceptionStore +class DCPError : public std::runtime_error { public: - void rethrow () { - boost::mutex::scoped_lock lm (_mutex); - if (_exception) { - boost::rethrow_exception (_exception); - _exception = boost::exception_ptr (); - } - } + explicit DCPError (std::string s) + : std::runtime_error (s) + {} +}; -protected: - - void store_current () { - boost::mutex::scoped_lock lm (_mutex); - _exception = boost::current_exception (); - } +class InvalidSignerError : public std::runtime_error +{ +public: + InvalidSignerError (); + explicit InvalidSignerError (std::string reason); +}; -private: - boost::exception_ptr _exception; - mutable boost::mutex _mutex; +class ProgrammingError : public std::runtime_error +{ +public: + ProgrammingError (std::string file, int line, std::string message = ""); }; - +class TextEncodingError : public std::runtime_error +{ +public: + explicit TextEncodingError (std::string s) + : std::runtime_error (s) + {} +}; + +class MetadataError : public std::runtime_error +{ +public: + explicit MetadataError (std::string s) + : std::runtime_error (s) + {} +}; + +class OldFormatError : public std::runtime_error +{ +public: + explicit OldFormatError (std::string s) + : std::runtime_error (s) + {} +}; + +class KDMAsContentError : public std::runtime_error +{ +public: + KDMAsContentError (); +}; #endif