src/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 LIBDCP_EXCEPTIONS_H
  21 #define LIBDCP_EXCEPTIONS_H
  22
  23 /** @file  src/exceptions.h
  24  *  @brief Exceptions thrown by libdcp.
  25  */
  26
  27 namespace libdcp
  28 {
  29
  30 /** @brief An exception related to a file */
  31 class FileError : public std::exception
  32 {
  33 public:
  34         FileError (std::string const & message, std::string const & filename)
  35                 : _message (message)
  36                 , _filename (filename)
  37         {}
  38
  39         ~FileError () throw () {}
  40
  41         /** @return error message */
  42         char const * what () const throw () {
  43                 return _message.c_str ();
  44         }
  45
  46         /** @return filename of file that was involved */
  47         std::string filename () const {
  48                 return _filename;
  49         }
  50
  51 private:
  52         /** error message */
  53         std::string _message;
  54         /** filename of file that was involved */
  55         std::string _filename;
  56 };
  57
  58
  59 /** @brief A miscellaneous exception */
  60 class MiscError : public std::exception
  61 {
  62 public:
  63         MiscError (std::string const & message) : _message (message) {}
  64         ~MiscError () throw () {}
  65
  66         /** @return error message */
  67         char const * what () const throw () {
  68                 return _message.c_str ();
  69         }
  70
  71 private:
  72         /** error message */
  73         std::string _message;
  74 };
  75
  76 /** @brief A DCP read exception */
  77 class DCPReadError : public std::exception
  78 {
  79 public:
  80         DCPReadError (std::string const & message) : _message (message) {}
  81         ~DCPReadError () throw () {}
  82
  83         /** @return error message */
  84         char const * what () const throw () {
  85                 return _message.c_str ();
  86         }
  87
  88 private:
  89         /** error message */
  90         std::string _message;
  91 };
  92
  93 /** @brief An XML error */
  94 class XMLError : public std::exception
  95 {
  96 public:
  97         XMLError (std::string const & message) : _message (message) {}
  98         ~XMLError () throw () {}
  99
 100         /** @return error message */
 101         char const * what () const throw () {
 102                 return _message.c_str ();
 103         }
 104
 105 private:
 106         /** error message */
 107         std::string _message;
 108 };
 109
 110 }
 111
 112 #endif