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/cmdline/exceptions.hpp
30/// Exception types raised by the cmdline module.
31
32#if !defined(UTILS_CMDLINE_EXCEPTIONS_HPP)
33#define UTILS_CMDLINE_EXCEPTIONS_HPP
34
35#include <stdexcept>
36#include <string>
37
38namespace utils {
39namespace cmdline {
40
41
42/// Base exception for cmdline errors.
43class error : public std::runtime_error {
44public:
45    explicit error(const std::string&);
46    ~error(void) throw();
47};
48
49
50/// Generic error to describe problems caused by the user.
51class usage_error : public error {
52public:
53    explicit usage_error(const std::string&);
54    ~usage_error(void) throw();
55};
56
57
58/// Error denoting that no argument was provided to an option that required one.
59class missing_option_argument_error : public usage_error {
60    /// Name of the option for which no required argument was specified.
61    std::string _option;
62
63public:
64    explicit missing_option_argument_error(const std::string&);
65    ~missing_option_argument_error(void) throw();
66
67    const std::string& option(void) const;
68};
69
70
71/// Error denoting that the argument provided to an option is invalid.
72class option_argument_value_error : public usage_error {
73    /// Name of the option for which the argument was invalid.
74    std::string _option;
75
76    /// Raw value of the invalid user-provided argument.
77    std::string _argument;
78
79    /// Reason describing why the argument is invalid.
80    std::string _reason;
81
82public:
83    explicit option_argument_value_error(const std::string&, const std::string&,
84                                         const std::string&);
85    ~option_argument_value_error(void) throw();
86
87    const std::string& option(void) const;
88    const std::string& argument(void) const;
89};
90
91
92/// Error denoting that the user specified an unknown option.
93class unknown_option_error : public usage_error {
94    /// Name of the option that was not known.
95    std::string _option;
96
97public:
98    explicit unknown_option_error(const std::string&);
99    ~unknown_option_error(void) throw();
100
101    const std::string& option(void) const;
102};
103
104
105}  // namespace cmdline
106}  // namespace utils
107
108
109#endif  // !defined(UTILS_CMDLINE_EXCEPTIONS_HPP)
110