xref: /freebsd/contrib/kyua/utils/format/exceptions.hpp (revision 3078531de10dcae44b253a35125c949ff4235284)
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 utils/format/exceptions.hpp
30 /// Exception types raised by the format module.
31 
32 #if !defined(UTILS_FORMAT_EXCEPTIONS_HPP)
33 #define UTILS_FORMAT_EXCEPTIONS_HPP
34 
35 #include <stdexcept>
36 #include <string>
37 
38 namespace utils {
39 namespace format {
40 
41 
42 /// Base exception for format 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 denoting a bad format string.
51 class bad_format_error : public error {
52     /// The format string that caused the error.
53     std::string _format;
54 
55 public:
56     explicit bad_format_error(const std::string&, const std::string&);
57     virtual ~bad_format_error(void) throw();
58 
59     const std::string& format(void) const;
60 };
61 
62 
63 /// Error denoting too many arguments for the format string.
64 class extra_args_error : public error {
65     /// The format string that was passed too many arguments.
66     std::string _format;
67 
68     /// The first argument that caused the error.
69     std::string _arg;
70 
71 public:
72     explicit extra_args_error(const std::string&, const std::string&);
73     virtual ~extra_args_error(void) throw();
74 
75     const std::string& format(void) const;
76     const std::string& arg(void) const;
77 };
78 
79 
80 }  // namespace format
81 }  // namespace utils
82 
83 
84 #endif  // !defined(UTILS_FORMAT_EXCEPTIONS_HPP)
85