2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/exceptions.h
21 * @brief Our exceptions.
28 /** @class StringError
29 * @brief A parent class for exceptions using messages held in a std::string
31 class StringError : public std::exception
34 /** @param w Error message */
35 StringError (std::string w) {
39 virtual ~StringError () throw () {}
41 /** @return error message */
42 char const * what () const throw () {
43 return _what.c_str ();
51 /** @class DecodeError
52 * @brief A low-level problem with the decoder (possibly due to the nature
55 class DecodeError : public StringError
58 DecodeError (std::string s)
63 /** @class EncodeError
64 * @brief A low-level problem with an encoder.
66 class EncodeError : public StringError
69 EncodeError (std::string s)
75 * @brief Parent class for file-related errors.
77 class FileError : public StringError
80 /** @param m Error message.
81 * @param f Name of the file that this exception concerns.
83 FileError (std::string m, std::string f)
88 virtual ~FileError () throw () {}
90 /** @return name of the file that this exception concerns */
91 std::string file () const {
96 /** name of the file that this exception concerns */
101 /** @class OpenFileError.
102 * @brief Indicates that some error occurred when trying to open a file.
104 class OpenFileError : public FileError
107 /** @param f File that we were trying to open */
108 OpenFileError (std::string f)
109 : FileError ("could not open file " + f, f)
113 /** @class CreateFileError.
114 * @brief Indicates that some error occurred when trying to create a file.
116 class CreateFileError : public FileError
119 /** @param f File that we were trying to create */
120 CreateFileError (std::string f)
121 : FileError ("could not create file " + f, f)
126 /** @class ReadFileError.
127 * @brief Indicates that some error occurred when trying to read from a file
129 class ReadFileError : public FileError
132 /** @param f File that we were trying to read from.
133 * @param e errno value, or 0.
135 ReadFileError (std::string f, int e = 0)
139 s << "could not read from file " << f;
141 s << " (" << strerror (e) << ")";
147 /** @class WriteFileError.
148 * @brief Indicates that some error occurred when trying to write to a file
150 class WriteFileError : public FileError
153 /** @param f File that we were trying to write to.
154 * @param e errno value, or 0.
156 WriteFileError (std::string f, int e)
160 s << "could not write to file " << f;
162 s << " (" << strerror (e) << ")";
168 /** @class SettingError.
169 * @brief Indicates that something is wrong with a setting.
171 class SettingError : public StringError
174 /** @param s Name of setting that was required.
177 SettingError (std::string s, std::string m)
182 virtual ~SettingError () throw () {}
184 /** @return name of setting in question */
185 std::string setting () const {
190 std::string _setting;
193 /** @class MissingSettingError.
194 * @brief Indicates that a Film is missing a setting that is required for some operation.
196 class MissingSettingError : public SettingError
199 /** @param s Name of setting that was required */
200 MissingSettingError (std::string s)
201 : SettingError (s, "missing required setting " + s)
205 /** @class BadSettingError
206 * @brief Indicates that a setting is bad in some way.
208 class BadSettingError : public SettingError
211 /** @param s Name of setting that is bad */
212 BadSettingError (std::string s, std::string m)
213 : SettingError (s, m)
217 /** @class NetworkError.
218 * @brief Indicates some problem with communication on the network.
220 class NetworkError : public StringError
223 NetworkError (std::string s)