xref: /freebsd/contrib/kyua/engine/exceptions.hpp (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file engine/exceptions.hpp
30 /// Exception types raised by the engine module.
31 
32 #if !defined(ENGINE_EXCEPTIONS_HPP)
33 #define ENGINE_EXCEPTIONS_HPP
34 
35 #include <stdexcept>
36 
37 #include "utils/fs/path.hpp"
38 
39 namespace engine {
40 
41 
42 /// Base exception for engine errors.
43 class error : public std::runtime_error {
44 public:
45     explicit error(const std::string&);
46     virtual ~error(void) throw();
47 };
48 
49 
50 /// Error while processing data.
51 class format_error : public error {
52 public:
53     explicit format_error(const std::string&);
54     virtual ~format_error(void) throw();
55 };
56 
57 
58 /// Error while parsing external data.
59 class load_error : public error {
60 public:
61     /// The path to the file that caused the load error.
62     utils::fs::path file;
63 
64     /// The reason for the error; may not include the file name.
65     std::string reason;
66 
67     explicit load_error(const utils::fs::path&, const std::string&);
68     virtual ~load_error(void) throw();
69 };
70 
71 
72 }  // namespace engine
73 
74 
75 #endif  // !defined(ENGINE_EXCEPTIONS_HPP)
76