xref: /freebsd/contrib/kyua/utils/sqlite/exceptions.hpp (revision d4eeb02986980bf33dd56c41ceb9fc5f180c0d47)
1 // Copyright 2011 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 utils/sqlite/exceptions.hpp
30 /// Exception types raised by the sqlite module.
31 
32 #if !defined(UTILS_SQLITE_EXCEPTIONS_HPP)
33 #define UTILS_SQLITE_EXCEPTIONS_HPP
34 
35 #include <stdexcept>
36 #include <string>
37 
38 #include "utils/fs/path_fwd.hpp"
39 #include "utils/optional.hpp"
40 #include "utils/sqlite/database_fwd.hpp"
41 
42 namespace utils {
43 namespace sqlite {
44 
45 
46 /// Base exception for sqlite errors.
47 class error : public std::runtime_error {
48     /// Path to the database that raised this error.
49     utils::optional< utils::fs::path > _db_filename;
50 
51 public:
52     explicit error(const utils::optional< utils::fs::path >&,
53                    const std::string&);
54     virtual ~error(void) throw();
55 
56     const utils::optional< utils::fs::path >& db_filename(void) const;
57 };
58 
59 
60 /// Exception for errors raised by the SQLite 3 API library.
61 class api_error : public error {
62     /// The name of the SQLite 3 C API function that caused this error.
63     std::string _api_function;
64 
65 public:
66     explicit api_error(const utils::optional< utils::fs::path >&,
67                        const std::string&, const std::string&);
68     virtual ~api_error(void) throw();
69 
70     static api_error from_database(database&, const std::string&);
71 
72     const std::string& api_function(void) const;
73 };
74 
75 
76 /// The caller requested a non-existent column name.
77 class invalid_column_error : public error {
78     /// The name of the invalid column.
79     std::string _column_name;
80 
81 public:
82     explicit invalid_column_error(const utils::optional< utils::fs::path >&,
83                                   const std::string&);
84     virtual ~invalid_column_error(void) throw();
85 
86     const std::string& column_name(void) const;
87 };
88 
89 
90 }  // namespace sqlite
91 }  // namespace utils
92 
93 
94 #endif  // !defined(UTILS_SQLITE_EXCEPTIONS_HPP)
95