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 /** @brief An exception related to an MXF file */
  59 class MXFFileError : public FileError
  60 {
  61 public:
  62         MXFFileError (std::string const & message, std::string const & filename)
  63                 : FileError (message, filename)
  64         {}
  65 };
  66
  67 /** @brief A miscellaneous exception */
  68 class MiscError : public std::exception
  69 {
  70 public:
  71         MiscError (std::string const & message) : _message (message) {}
  72         ~MiscError () throw () {}
  73
  74         /** @return error message */
  75         char const * what () const throw () {
  76                 return _message.c_str ();
  77         }
  78
  79 private:
  80         /** error message */
  81         std::string _message;
  82 };
  83
  84 /** @brief A DCP read exception */
  85 class DCPReadError : public std::exception
  86 {
  87 public:
  88         DCPReadError (std::string const & message) : _message (message) {}
  89         ~DCPReadError () throw () {}
  90
  91         /** @return error message */
  92         char const * what () const throw () {
  93                 return _message.c_str ();
  94         }
  95
  96 private:
  97         /** error message */
  98         std::string _message;
  99 };
 100
 101 /** @brief An XML error */
 102 class XMLError : public std::exception
 103 {
 104 public:
 105         XMLError (std::string const & message) : _message (message) {}
 106         ~XMLError () throw () {}
 107
 108         /** @return error message */
 109         char const * what () const throw () {
 110                 return _message.c_str ();
 111         }
 112
 113 private:
 114         /** error message */
 115         std::string _message;
 116 };
 117
 118 }
 119
 120 #endif