src/lib/exceptions.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_EXCEPTIONS_H
  21 #define DCPOMATIC_EXCEPTIONS_H
  22
  23 /** @file  src/exceptions.h
  24  *  @brief Our exceptions.
  25  */
  26
  27 #include <stdexcept>
  28 #include <cstring>
  29 #include <boost/exception/all.hpp>
  30 #include <boost/filesystem.hpp>
  31 #include <boost/thread.hpp>
  32 extern "C" {
  33 #include <libavutil/pixfmt.h>
  34 }
  35
  36 /** @class StringError
  37  *  @brief A parent class for exceptions using messages held in a std::string
  38  */
  39 class StringError : public std::exception
  40 {
  41 public:
  42         /** @param w Error message */
  43         StringError (std::string w) {
  44                 _what = w;
  45         }
  46
  47         virtual ~StringError () throw () {}
  48
  49         /** @return error message */
  50         char const * what () const throw () {
  51                 return _what.c_str ();
  52         }
  53
  54 protected:
  55         /** error message */
  56         std::string _what;
  57 };
  58
  59 /** @class DecodeError
  60  *  @brief A low-level problem with the decoder (possibly due to the nature
  61  *  of a source file).
  62  */
  63 class DecodeError : public StringError
  64 {
  65 public:
  66         DecodeError (std::string s)
  67                 : StringError (s)
  68         {}
  69 };
  70
  71 /** @class EncodeError
  72  *  @brief A low-level problem with an encoder.
  73  */
  74 class EncodeError : public StringError
  75 {
  76 public:
  77         EncodeError (std::string s)
  78                 : StringError (s)
  79         {}
  80 };
  81
  82 /** @class FileError.
  83  *  @brief Parent class for file-related errors.
  84  */
  85 class FileError : public StringError
  86 {
  87 public:
  88         /** @param m Error message.
  89          *  @param f Name of the file that this exception concerns.
  90          */
  91         FileError (std::string m, boost::filesystem::path f)
  92                 : StringError (m)
  93                 , _file (f)
  94         {}
  95
  96         virtual ~FileError () throw () {}
  97
  98         /** @return name of the file that this exception concerns */
  99         boost::filesystem::path file () const {
 100                 return _file;
 101         }
 102
 103 private:
 104         /** name of the file that this exception concerns */
 105         boost::filesystem::path _file;
 106 };
 107
 108
 109 /** @class OpenFileError.
 110  *  @brief Indicates that some error occurred when trying to open a file.
 111  */
 112 class OpenFileError : public FileError
 113 {
 114 public:
 115         /** @param f File that we were trying to open */
 116         OpenFileError (boost::filesystem::path f);
 117 };
 118
 119 /** @class CreateFileError.
 120  *  @brief Indicates that some error occurred when trying to create a file.
 121  */
 122 class CreateFileError : public FileError
 123 {
 124 public:
 125         /** @param f File that we were trying to create */
 126         CreateFileError (boost::filesystem::path f);
 127 };
 128
 129
 130 /** @class ReadFileError.
 131  *  @brief Indicates that some error occurred when trying to read from a file
 132  */
 133 class ReadFileError : public FileError
 134 {
 135 public:
 136         /** @param f File that we were trying to read from.
 137          *  @param e errno value, or 0.
 138          */
 139         ReadFileError (boost::filesystem::path f, int e = 0);
 140 };
 141
 142 /** @class WriteFileError.
 143  *  @brief Indicates that some error occurred when trying to write to a file
 144  */
 145 class WriteFileError : public FileError
 146 {
 147 public:
 148         /** @param f File that we were trying to write to.
 149          *  @param e errno value, or 0.
 150          */
 151         WriteFileError (boost::filesystem::path f, int e);
 152 };
 153
 154 /** @class SettingError.
 155  *  @brief Indicates that something is wrong with a setting.
 156  */
 157 class SettingError : public StringError
 158 {
 159 public:
 160         /** @param s Name of setting that was required.
 161          *  @param m Message.
 162          */
 163         SettingError (std::string s, std::string m)
 164                 : StringError (m)
 165                 , _setting (s)
 166         {}
 167
 168         virtual ~SettingError () throw () {}
 169
 170         /** @return name of setting in question */
 171         std::string setting () const {
 172                 return _setting;
 173         }
 174
 175 private:
 176         std::string _setting;
 177 };
 178
 179 /** @class MissingSettingError.
 180  *  @brief Indicates that a Film is missing a setting that is required for some operation.
 181  */
 182 class MissingSettingError : public SettingError
 183 {
 184 public:
 185         /** @param s Name of setting that was required */
 186         MissingSettingError (std::string s);
 187 };
 188
 189 /** @class BadSettingError
 190  *  @brief Indicates that a setting is bad in some way.
 191  */
 192 class BadSettingError : public SettingError
 193 {
 194 public:
 195         /** @param s Name of setting that is bad */
 196         BadSettingError (std::string s, std::string m)
 197                 : SettingError (s, m)
 198         {}
 199 };
 200
 201 /** @class NetworkError.
 202  *  @brief Indicates some problem with communication on the network.
 203  */
 204 class NetworkError : public StringError
 205 {
 206 public:
 207         NetworkError (std::string s)
 208                 : StringError (s)
 209         {}
 210 };
 211
 212 class KDMError : public StringError
 213 {
 214 public:
 215         KDMError (std::string s)
 216                 : StringError (s)
 217         {}
 218 };
 219
 220 class PixelFormatError : public StringError
 221 {
 222 public:
 223         PixelFormatError (std::string o, AVPixelFormat f);
 224 };
 225
 226 class ExceptionStore
 227 {
 228 public:
 229         bool thrown () const {
 230                 boost::mutex::scoped_lock lm (_mutex);
 231                 return _exception;
 232         }
 233
 234         void rethrow () {
 235                 boost::mutex::scoped_lock lm (_mutex);
 236                 boost::rethrow_exception (_exception);
 237         }
 238
 239 protected:
 240
 241         void store_current () {
 242                 boost::mutex::scoped_lock lm (_mutex);
 243                 _exception = boost::current_exception ();
 244         }
 245
 246 private:
 247         boost::exception_ptr _exception;
 248         mutable boost::mutex _mutex;
 249 };
 250
 251
 252
 253 #endif