summaryrefslogtreecommitdiff
path: root/src/exceptions.h
blob: 268446fcf994512d38e4f5b2c9d89d464d551e71 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef LIBDCP_EXCEPTIONS_H
#define LIBDCP_EXCEPTIONS_H

#include <boost/filesystem.hpp>

/** @file  src/exceptions.h
 *  @brief Exceptions thrown by libdcp.
 */

namespace dcp
{

/** @class FileError
 *  @brief An exception related to a file
 */
class FileError : public std::runtime_error
{
public:
	FileError (std::string message, boost::filesystem::path filename, int number);
	~FileError () throw () {}

	/** @return filename of file that was involved */
	boost::filesystem::path filename () const {
		return _filename;
	}

	/** @return error number of the error */
	int number () const {
		return _number;
	}

private:
	/** filename of file that was involved */
	boost::filesystem::path _filename;
	int _number;
};

/** @class MXFFileError
 *  @brief An exception related to an MXF file
 */
class MXFFileError : public FileError
{
public:
	MXFFileError (std::string message, boost::filesystem::path filename, int number)
		: FileError (message, filename, number)
	{}
};

/** @class MiscError
 *  @brief A miscellaneous exception
 */
class MiscError : public std::runtime_error
{
public:
	MiscError (std::string message)
		: std::runtime_error (message)
	{}
};

/** @class PackageReadError
 *  @brief An error while reading a package
 */
class PackageReadError : public std::runtime_error
{
public:
	PackageReadError (std::string message)
		: std::runtime_error (message)
	{}
};

/** @class MissingAssetError
 *  @brief An error of a missing asset.
 */
class MissingAssetError : public PackageReadError
{
public:
	enum AssetType {
		MAIN_PICTURE,  //< main picture is missing
		MAIN_SOUND,    //< main sound is missing
		MAIN_SUBTITLE, //< main subtitle is missing
		UNKNOWN        //< something is missing but we don't know what
	};

	MissingAssetError (boost::filesystem::path, AssetType = UNKNOWN);
	~MissingAssetError () throw () {}
};

/** @class XMLError
 *  @brief An XML error
 */
class XMLError : public std::runtime_error
{
public:
	XMLError (std::string message)
		: std::runtime_error (message)
	{}
};

/** @class UnresolvedRefError
 *  @brief An exception caused by a reference (by UUID) to something which is not known
 */
class UnresolvedRefError : public std::runtime_error
{
public:
	UnresolvedRefError (std::string id);
};

/** @class TimeFormatError
 *  @brief A an error with a string passed to LocalTime.
 */
class TimeFormatError : public std::runtime_error
{
public:
	TimeFormatError (std::string bad_time);
};

/** @class NotEncryptedError
 *  @brief An error raised when creating a DecryptedKDM object for assets that are not
 *  encrypted.
 */
class NotEncryptedError : public std::runtime_error
{
public:
	NotEncryptedError (std::string const & what);
	~NotEncryptedError () throw () {}
};

/** @class ProgrammingError
 *  @brief An exception thrown when a DCP_ASSERT fails; something that should not happen.
 */
class ProgrammingError : public std::runtime_error
{
public:
	ProgrammingError (std::string file, int line);
};

}

#endif