xref: /minix3/external/bsd/kyua-cli/dist/utils/cmdline/exceptions.cpp (revision 11be35a165022172ed3cea20f2b5df0307540b0e)
1*11be35a1SLionel Sambuc // Copyright 2010 Google Inc.
2*11be35a1SLionel Sambuc // All rights reserved.
3*11be35a1SLionel Sambuc //
4*11be35a1SLionel Sambuc // Redistribution and use in source and binary forms, with or without
5*11be35a1SLionel Sambuc // modification, are permitted provided that the following conditions are
6*11be35a1SLionel Sambuc // met:
7*11be35a1SLionel Sambuc //
8*11be35a1SLionel Sambuc // * Redistributions of source code must retain the above copyright
9*11be35a1SLionel Sambuc //   notice, this list of conditions and the following disclaimer.
10*11be35a1SLionel Sambuc // * Redistributions in binary form must reproduce the above copyright
11*11be35a1SLionel Sambuc //   notice, this list of conditions and the following disclaimer in the
12*11be35a1SLionel Sambuc //   documentation and/or other materials provided with the distribution.
13*11be35a1SLionel Sambuc // * Neither the name of Google Inc. nor the names of its contributors
14*11be35a1SLionel Sambuc //   may be used to endorse or promote products derived from this software
15*11be35a1SLionel Sambuc //   without specific prior written permission.
16*11be35a1SLionel Sambuc //
17*11be35a1SLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*11be35a1SLionel Sambuc // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*11be35a1SLionel Sambuc // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*11be35a1SLionel Sambuc // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*11be35a1SLionel Sambuc // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*11be35a1SLionel Sambuc // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*11be35a1SLionel Sambuc // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*11be35a1SLionel Sambuc // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*11be35a1SLionel Sambuc // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*11be35a1SLionel Sambuc // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*11be35a1SLionel Sambuc // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*11be35a1SLionel Sambuc 
29*11be35a1SLionel Sambuc #include "utils/cmdline/exceptions.hpp"
30*11be35a1SLionel Sambuc 
31*11be35a1SLionel Sambuc #include "utils/format/macros.hpp"
32*11be35a1SLionel Sambuc #include "utils/sanity.hpp"
33*11be35a1SLionel Sambuc 
34*11be35a1SLionel Sambuc namespace cmdline = utils::cmdline;
35*11be35a1SLionel Sambuc 
36*11be35a1SLionel Sambuc 
37*11be35a1SLionel Sambuc #define VALIDATE_OPTION_NAME(option) PRE_MSG( \
38*11be35a1SLionel Sambuc     (option.length() == 2 && (option[0] == '-' && option[1] != '-')) || \
39*11be35a1SLionel Sambuc     (option.length() > 2 && (option[0] == '-' && option[1] == '-')), \
40*11be35a1SLionel Sambuc     F("The option name %s must be fully specified") % option);
41*11be35a1SLionel Sambuc 
42*11be35a1SLionel Sambuc 
43*11be35a1SLionel Sambuc /// Constructs a new error with a plain-text message.
44*11be35a1SLionel Sambuc ///
45*11be35a1SLionel Sambuc /// \param message The plain-text error message.
error(const std::string & message)46*11be35a1SLionel Sambuc cmdline::error::error(const std::string& message) :
47*11be35a1SLionel Sambuc     std::runtime_error(message)
48*11be35a1SLionel Sambuc {
49*11be35a1SLionel Sambuc }
50*11be35a1SLionel Sambuc 
51*11be35a1SLionel Sambuc 
52*11be35a1SLionel Sambuc /// Destructor for the error.
~error(void)53*11be35a1SLionel Sambuc cmdline::error::~error(void) throw()
54*11be35a1SLionel Sambuc {
55*11be35a1SLionel Sambuc }
56*11be35a1SLionel Sambuc 
57*11be35a1SLionel Sambuc 
58*11be35a1SLionel Sambuc /// Constructs a new usage_error.
59*11be35a1SLionel Sambuc ///
60*11be35a1SLionel Sambuc /// \param message The reason behind the usage error.
usage_error(const std::string & message)61*11be35a1SLionel Sambuc cmdline::usage_error::usage_error(const std::string& message) :
62*11be35a1SLionel Sambuc     error(message)
63*11be35a1SLionel Sambuc {
64*11be35a1SLionel Sambuc }
65*11be35a1SLionel Sambuc 
66*11be35a1SLionel Sambuc 
67*11be35a1SLionel Sambuc /// Destructor for the error.
~usage_error(void)68*11be35a1SLionel Sambuc cmdline::usage_error::~usage_error(void) throw()
69*11be35a1SLionel Sambuc {
70*11be35a1SLionel Sambuc }
71*11be35a1SLionel Sambuc 
72*11be35a1SLionel Sambuc 
73*11be35a1SLionel Sambuc /// Constructs a new missing_option_argument_error.
74*11be35a1SLionel Sambuc ///
75*11be35a1SLionel Sambuc /// \param option_ The option for which no argument was provided.  The option
76*11be35a1SLionel Sambuc ///     name must be fully specified (with - or -- in front).
missing_option_argument_error(const std::string & option_)77*11be35a1SLionel Sambuc cmdline::missing_option_argument_error::missing_option_argument_error(
78*11be35a1SLionel Sambuc     const std::string& option_) :
79*11be35a1SLionel Sambuc     usage_error(F("Missing required argument for option %s") % option_),
80*11be35a1SLionel Sambuc     _option(option_)
81*11be35a1SLionel Sambuc {
82*11be35a1SLionel Sambuc     VALIDATE_OPTION_NAME(option_);
83*11be35a1SLionel Sambuc }
84*11be35a1SLionel Sambuc 
85*11be35a1SLionel Sambuc 
86*11be35a1SLionel Sambuc /// Destructor for the error.
~missing_option_argument_error(void)87*11be35a1SLionel Sambuc cmdline::missing_option_argument_error::~missing_option_argument_error(void)
88*11be35a1SLionel Sambuc     throw()
89*11be35a1SLionel Sambuc {
90*11be35a1SLionel Sambuc }
91*11be35a1SLionel Sambuc 
92*11be35a1SLionel Sambuc 
93*11be35a1SLionel Sambuc /// Returns the option name for which no argument was provided.
94*11be35a1SLionel Sambuc ///
95*11be35a1SLionel Sambuc /// \return The option name.
96*11be35a1SLionel Sambuc const std::string&
option(void) const97*11be35a1SLionel Sambuc cmdline::missing_option_argument_error::option(void) const
98*11be35a1SLionel Sambuc {
99*11be35a1SLionel Sambuc     return _option;
100*11be35a1SLionel Sambuc }
101*11be35a1SLionel Sambuc 
102*11be35a1SLionel Sambuc 
103*11be35a1SLionel Sambuc /// Constructs a new option_argument_value_error.
104*11be35a1SLionel Sambuc ///
105*11be35a1SLionel Sambuc /// \param option_ The option to which an invalid argument was passed.  The
106*11be35a1SLionel Sambuc ///     option name must be fully specified (with - or -- in front).
107*11be35a1SLionel Sambuc /// \param argument_ The invalid argument.
108*11be35a1SLionel Sambuc /// \param reason_ The reason describing why the argument is invalid.
option_argument_value_error(const std::string & option_,const std::string & argument_,const std::string & reason_)109*11be35a1SLionel Sambuc cmdline::option_argument_value_error::option_argument_value_error(
110*11be35a1SLionel Sambuc     const std::string& option_, const std::string& argument_,
111*11be35a1SLionel Sambuc     const std::string& reason_) :
112*11be35a1SLionel Sambuc     usage_error(F("Invalid argument '%s' for option %s: %s") % argument_ %
113*11be35a1SLionel Sambuc                 option_ % reason_),
114*11be35a1SLionel Sambuc     _option(option_),
115*11be35a1SLionel Sambuc     _argument(argument_),
116*11be35a1SLionel Sambuc     _reason(reason_)
117*11be35a1SLionel Sambuc {
118*11be35a1SLionel Sambuc     VALIDATE_OPTION_NAME(option_);
119*11be35a1SLionel Sambuc }
120*11be35a1SLionel Sambuc 
121*11be35a1SLionel Sambuc 
122*11be35a1SLionel Sambuc /// Destructor for the error.
~option_argument_value_error(void)123*11be35a1SLionel Sambuc cmdline::option_argument_value_error::~option_argument_value_error(void)
124*11be35a1SLionel Sambuc     throw()
125*11be35a1SLionel Sambuc {
126*11be35a1SLionel Sambuc }
127*11be35a1SLionel Sambuc 
128*11be35a1SLionel Sambuc 
129*11be35a1SLionel Sambuc /// Returns the option to which the invalid argument was passed.
130*11be35a1SLionel Sambuc ///
131*11be35a1SLionel Sambuc /// \return The option name.
132*11be35a1SLionel Sambuc const std::string&
option(void) const133*11be35a1SLionel Sambuc cmdline::option_argument_value_error::option(void) const
134*11be35a1SLionel Sambuc {
135*11be35a1SLionel Sambuc     return _option;
136*11be35a1SLionel Sambuc }
137*11be35a1SLionel Sambuc 
138*11be35a1SLionel Sambuc 
139*11be35a1SLionel Sambuc /// Returns the invalid argument value.
140*11be35a1SLionel Sambuc ///
141*11be35a1SLionel Sambuc /// \return The invalid argument.
142*11be35a1SLionel Sambuc const std::string&
argument(void) const143*11be35a1SLionel Sambuc cmdline::option_argument_value_error::argument(void) const
144*11be35a1SLionel Sambuc {
145*11be35a1SLionel Sambuc     return _argument;
146*11be35a1SLionel Sambuc }
147*11be35a1SLionel Sambuc 
148*11be35a1SLionel Sambuc 
149*11be35a1SLionel Sambuc /// Constructs a new unknown_option_error.
150*11be35a1SLionel Sambuc ///
151*11be35a1SLionel Sambuc /// \param option_ The unknown option. The option name must be fully specified
152*11be35a1SLionel Sambuc ///     (with - or -- in front).
unknown_option_error(const std::string & option_)153*11be35a1SLionel Sambuc cmdline::unknown_option_error::unknown_option_error(
154*11be35a1SLionel Sambuc     const std::string& option_) :
155*11be35a1SLionel Sambuc     usage_error(F("Unknown option %s") % option_),
156*11be35a1SLionel Sambuc     _option(option_)
157*11be35a1SLionel Sambuc {
158*11be35a1SLionel Sambuc     VALIDATE_OPTION_NAME(option_);
159*11be35a1SLionel Sambuc }
160*11be35a1SLionel Sambuc 
161*11be35a1SLionel Sambuc 
162*11be35a1SLionel Sambuc /// Destructor for the error.
~unknown_option_error(void)163*11be35a1SLionel Sambuc cmdline::unknown_option_error::~unknown_option_error(void) throw()
164*11be35a1SLionel Sambuc {
165*11be35a1SLionel Sambuc }
166*11be35a1SLionel Sambuc 
167*11be35a1SLionel Sambuc 
168*11be35a1SLionel Sambuc /// Returns the unknown option name.
169*11be35a1SLionel Sambuc ///
170*11be35a1SLionel Sambuc /// \return The unknown option.
171*11be35a1SLionel Sambuc const std::string&
option(void) const172*11be35a1SLionel Sambuc cmdline::unknown_option_error::option(void) const
173*11be35a1SLionel Sambuc {
174*11be35a1SLionel Sambuc     return _option;
175*11be35a1SLionel Sambuc }
176