src/exceptions.h

   1 /*
   2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34 #ifndef LIBDCP_EXCEPTIONS_H
  35 #define LIBDCP_EXCEPTIONS_H
  36
  37 #include <boost/filesystem.hpp>
  38 #include <boost/optional.hpp>
  39
  40 /** @file  src/exceptions.h
  41  *  @brief Exceptions thrown by libdcp.
  42  */
  43
  44 namespace dcp
  45 {
  46
  47 /** @class FileError
  48  *  @brief An exception related to a file
  49  */
  50 class FileError : public std::runtime_error
  51 {
  52 public:
  53         FileError (std::string message, boost::filesystem::path filename, int number);
  54         ~FileError () throw () {}
  55
  56         /** @return filename of file that was involved */
  57         boost::filesystem::path filename () const {
  58                 return _filename;
  59         }
  60
  61         /** @return error number of the error */
  62         int number () const {
  63                 return _number;
  64         }
  65
  66 private:
  67         /** filename of file that was involved */
  68         boost::filesystem::path _filename;
  69         int _number;
  70 };
  71
  72 /** @class MXFFileError
  73  *  @brief An exception related to an MXF file
  74  */
  75 class MXFFileError : public FileError
  76 {
  77 public:
  78         MXFFileError (std::string message, boost::filesystem::path filename, int number)
  79                 : FileError (message, filename, number)
  80         {}
  81 };
  82
  83 /** @class MiscError
  84  *  @brief A miscellaneous exception
  85  */
  86 class MiscError : public std::runtime_error
  87 {
  88 public:
  89         explicit MiscError (std::string message)
  90                 : std::runtime_error (message)
  91         {}
  92 };
  93
  94
  95 /** @class ReadError
  96  *  @brief Any error that occurs when reading data from a DCP.
  97  */
  98 class ReadError : public std::runtime_error
  99 {
 100 public:
 101         explicit ReadError (std::string message)
 102                 : std::runtime_error(message)
 103                 , _message(message)
 104         {}
 105
 106         ReadError (std::string message, std::string detail);
 107
 108         ~ReadError() throw () {}
 109
 110         std::string message () const {
 111                 return _message;
 112         }
 113
 114         boost::optional<std::string> detail () const {
 115                 return _detail;
 116         }
 117
 118 private:
 119         std::string _message;
 120         boost::optional<std::string> _detail;
 121 };
 122
 123
 124 class BadContentKindError : public ReadError
 125 {
 126 public:
 127         BadContentKindError (std::string content_kind);
 128 };
 129
 130 /** @class XMLError
 131  *  @brief An XML error
 132  */
 133 class XMLError : public std::runtime_error
 134 {
 135 public:
 136         explicit XMLError (std::string message)
 137                 : std::runtime_error (message)
 138         {}
 139 };
 140
 141 /** @class UnresolvedRefError
 142  *  @brief An exception caused by a reference (by UUID) to something which is not known
 143  */
 144 class UnresolvedRefError : public std::runtime_error
 145 {
 146 public:
 147         explicit UnresolvedRefError (std::string id);
 148 };
 149
 150 /** @class TimeFormatError
 151  *  @brief A an error with a string passed to LocalTime.
 152  */
 153 class TimeFormatError : public std::runtime_error
 154 {
 155 public:
 156         explicit TimeFormatError (std::string bad_time);
 157 };
 158
 159 /** @class NotEncryptedError
 160  *  @brief An error raised when creating a DecryptedKDM object for assets that are not
 161  *  encrypted.
 162  */
 163 class NotEncryptedError : public std::runtime_error
 164 {
 165 public:
 166         explicit NotEncryptedError (std::string const & what);
 167         ~NotEncryptedError () throw () {}
 168 };
 169
 170 /** @class ProgrammingError
 171  *  @brief An exception thrown when a DCP_ASSERT fails; something that should not happen.
 172  */
 173 class ProgrammingError : public std::runtime_error
 174 {
 175 public:
 176         ProgrammingError (std::string file, int line);
 177 };
 178
 179 class KDMDecryptionError : public std::runtime_error
 180 {
 181 public:
 182         KDMDecryptionError (std::string message, int cipher_length, int modulus_dmax);
 183 };
 184
 185 class KDMFormatError : public std::runtime_error
 186 {
 187 public:
 188         KDMFormatError (std::string message);
 189 };
 190
 191 class CertificateChainError : public std::runtime_error
 192 {
 193 public:
 194         CertificateChainError (std::string message);
 195 };
 196
 197 class MissingSubtitleImageError : public std::runtime_error
 198 {
 199 public:
 200         MissingSubtitleImageError (std::string id);
 201 };
 202
 203 class BadKDMDateError : public std::runtime_error
 204 {
 205 public:
 206         BadKDMDateError (bool starts_too_early);
 207
 208         bool starts_too_early () const {
 209                 return _starts_too_early;
 210         }
 211
 212 private:
 213         bool _starts_too_early;
 214 };
 215
 216
 217 class StartCompressionError : public std::runtime_error
 218 {
 219 public:
 220         explicit StartCompressionError (boost::optional<int> code = boost::optional<int>());
 221
 222         boost::optional<int> code () const {
 223                 return _code;
 224         }
 225
 226 private:
 227         boost::optional<int> _code;
 228 };
 229
 230 }
 231
 232 #endif