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