111be35a1SLionel Sambuc // Copyright 2010 Google Inc. 211be35a1SLionel Sambuc // All rights reserved. 311be35a1SLionel Sambuc // 411be35a1SLionel Sambuc // Redistribution and use in source and binary forms, with or without 511be35a1SLionel Sambuc // modification, are permitted provided that the following conditions are 611be35a1SLionel Sambuc // met: 711be35a1SLionel Sambuc // 811be35a1SLionel Sambuc // * Redistributions of source code must retain the above copyright 911be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer. 1011be35a1SLionel Sambuc // * Redistributions in binary form must reproduce the above copyright 1111be35a1SLionel Sambuc // notice, this list of conditions and the following disclaimer in the 1211be35a1SLionel Sambuc // documentation and/or other materials provided with the distribution. 1311be35a1SLionel Sambuc // * Neither the name of Google Inc. nor the names of its contributors 1411be35a1SLionel Sambuc // may be used to endorse or promote products derived from this software 1511be35a1SLionel Sambuc // without specific prior written permission. 1611be35a1SLionel Sambuc // 1711be35a1SLionel Sambuc // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1811be35a1SLionel Sambuc // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1911be35a1SLionel Sambuc // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2011be35a1SLionel Sambuc // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2111be35a1SLionel Sambuc // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2211be35a1SLionel Sambuc // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2311be35a1SLionel Sambuc // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2411be35a1SLionel Sambuc // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2511be35a1SLionel Sambuc // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2611be35a1SLionel Sambuc // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2711be35a1SLionel Sambuc // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2811be35a1SLionel Sambuc 2911be35a1SLionel Sambuc /// \file utils/cmdline/exceptions.hpp 3011be35a1SLionel Sambuc /// Exception types raised by the cmdline module. 3111be35a1SLionel Sambuc 3211be35a1SLionel Sambuc #if !defined(UTILS_CMDLINE_EXCEPTIONS_HPP) 3311be35a1SLionel Sambuc #define UTILS_CMDLINE_EXCEPTIONS_HPP 3411be35a1SLionel Sambuc 3511be35a1SLionel Sambuc #include <stdexcept> 36*84d9c625SLionel Sambuc #include <string> 3711be35a1SLionel Sambuc 3811be35a1SLionel Sambuc namespace utils { 3911be35a1SLionel Sambuc namespace cmdline { 4011be35a1SLionel Sambuc 4111be35a1SLionel Sambuc 4211be35a1SLionel Sambuc /// Base exception for cmdline errors. 4311be35a1SLionel Sambuc class error : public std::runtime_error { 4411be35a1SLionel Sambuc public: 4511be35a1SLionel Sambuc explicit error(const std::string&); 4611be35a1SLionel Sambuc ~error(void) throw(); 4711be35a1SLionel Sambuc }; 4811be35a1SLionel Sambuc 4911be35a1SLionel Sambuc 5011be35a1SLionel Sambuc /// Generic error to describe problems caused by the user. 5111be35a1SLionel Sambuc class usage_error : public error { 5211be35a1SLionel Sambuc public: 5311be35a1SLionel Sambuc explicit usage_error(const std::string&); 5411be35a1SLionel Sambuc ~usage_error(void) throw(); 5511be35a1SLionel Sambuc }; 5611be35a1SLionel Sambuc 5711be35a1SLionel Sambuc 5811be35a1SLionel Sambuc /// Error denoting that no argument was provided to an option that required one. 5911be35a1SLionel Sambuc class missing_option_argument_error : public usage_error { 6011be35a1SLionel Sambuc /// Name of the option for which no required argument was specified. 6111be35a1SLionel Sambuc std::string _option; 6211be35a1SLionel Sambuc 6311be35a1SLionel Sambuc public: 6411be35a1SLionel Sambuc explicit missing_option_argument_error(const std::string&); 6511be35a1SLionel Sambuc ~missing_option_argument_error(void) throw(); 6611be35a1SLionel Sambuc 6711be35a1SLionel Sambuc const std::string& option(void) const; 6811be35a1SLionel Sambuc }; 6911be35a1SLionel Sambuc 7011be35a1SLionel Sambuc 7111be35a1SLionel Sambuc /// Error denoting that the argument provided to an option is invalid. 7211be35a1SLionel Sambuc class option_argument_value_error : public usage_error { 7311be35a1SLionel Sambuc /// Name of the option for which the argument was invalid. 7411be35a1SLionel Sambuc std::string _option; 7511be35a1SLionel Sambuc 7611be35a1SLionel Sambuc /// Raw value of the invalid user-provided argument. 7711be35a1SLionel Sambuc std::string _argument; 7811be35a1SLionel Sambuc 7911be35a1SLionel Sambuc /// Reason describing why the argument is invalid. 8011be35a1SLionel Sambuc std::string _reason; 8111be35a1SLionel Sambuc 8211be35a1SLionel Sambuc public: 8311be35a1SLionel Sambuc explicit option_argument_value_error(const std::string&, const std::string&, 8411be35a1SLionel Sambuc const std::string&); 8511be35a1SLionel Sambuc ~option_argument_value_error(void) throw(); 8611be35a1SLionel Sambuc 8711be35a1SLionel Sambuc const std::string& option(void) const; 8811be35a1SLionel Sambuc const std::string& argument(void) const; 8911be35a1SLionel Sambuc }; 9011be35a1SLionel Sambuc 9111be35a1SLionel Sambuc 9211be35a1SLionel Sambuc /// Error denoting that the user specified an unknown option. 9311be35a1SLionel Sambuc class unknown_option_error : public usage_error { 9411be35a1SLionel Sambuc /// Name of the option that was not known. 9511be35a1SLionel Sambuc std::string _option; 9611be35a1SLionel Sambuc 9711be35a1SLionel Sambuc public: 9811be35a1SLionel Sambuc explicit unknown_option_error(const std::string&); 9911be35a1SLionel Sambuc ~unknown_option_error(void) throw(); 10011be35a1SLionel Sambuc 10111be35a1SLionel Sambuc const std::string& option(void) const; 10211be35a1SLionel Sambuc }; 10311be35a1SLionel Sambuc 10411be35a1SLionel Sambuc 10511be35a1SLionel Sambuc } // namespace cmdline 10611be35a1SLionel Sambuc } // namespace utils 10711be35a1SLionel Sambuc 10811be35a1SLionel Sambuc 10911be35a1SLionel Sambuc #endif // !defined(UTILS_CMDLINE_EXCEPTIONS_HPP) 110