1 // Copyright 2012 Google Inc.
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/config/exceptions.hpp
30 /// Exception types raised by the config module.
31 
32 #if !defined(UTILS_CONFIG_EXCEPTIONS_HPP)
33 #define UTILS_CONFIG_EXCEPTIONS_HPP
34 
35 #include <stdexcept>
36 
37 #include "utils/config/tree.hpp"
38 
39 namespace utils {
40 namespace config {
41 
42 
43 /// Base exceptions for config errors.
44 class error : public std::runtime_error {
45 public:
46     explicit error(const std::string&);
47     ~error(void) throw();
48 };
49 
50 
51 /// Exception denoting that a key was not found within a tree.
52 class invalid_key_error : public error {
53 public:
54     explicit invalid_key_error(const std::string&);
55     ~invalid_key_error(void) throw();
56 };
57 
58 
59 /// Exception denoting that a configuration file is invalid.
60 class syntax_error : public error {
61 public:
62     explicit syntax_error(const std::string&);
63     ~syntax_error(void) throw();
64 };
65 
66 
67 /// Exception denoting that a key was not found within a tree.
68 class unknown_key_error : public error {
69 public:
70     explicit unknown_key_error(const detail::tree_key&,
71                                const std::string& = "");
72     ~unknown_key_error(void) throw();
73 };
74 
75 
76 /// Exception denoting that a value was invalid.
77 class value_error : public error {
78 public:
79     explicit value_error(const std::string&);
80     ~value_error(void) throw();
81 };
82 
83 
84 }  // namespace config
85 }  // namespace utils
86 
87 
88 #endif  // !defined(UTILS_CONFIG_EXCEPTIONS_HPP)
89