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/parser.hpp 30 /// Routines and data types to parse command line options and arguments. 31 32 #if !defined(UTILS_CMDLINE_PARSER_HPP) 33 #define UTILS_CMDLINE_PARSER_HPP 34 35 #include "utils/cmdline/parser_fwd.hpp" 36 37 #include <map> 38 #include <string> 39 #include <vector> 40 41 namespace utils { 42 namespace cmdline { 43 44 45 /// Representation of a parsed command line. 46 /// 47 /// This class is returned by the command line parsing algorithm and provides 48 /// methods to query the values of the options and the value of the arguments. 49 /// All the values fed into this class can considered to be sane (i.e. the 50 /// arguments to the options and the arguments to the command are valid), as all 51 /// validation happens during parsing (before this class is instantiated). 52 class parsed_cmdline { 53 /// Mapping of option names to all the values provided. 54 std::map< std::string, std::vector< std::string > > _option_values; 55 56 /// Collection of arguments with all options removed. 57 args_vector _arguments; 58 59 const std::vector< std::string >& get_option_raw(const std::string&) const; 60 61 public: 62 parsed_cmdline(const std::map< std::string, std::vector< std::string > >&, 63 const args_vector&); 64 65 bool has_option(const std::string&) const; 66 67 template< typename Option > 68 typename Option::option_type get_option(const std::string&) const; 69 70 template< typename Option > 71 std::vector< typename Option::option_type > get_multi_option( 72 const std::string&) const; 73 74 const args_vector& arguments(void) const; 75 }; 76 77 78 parsed_cmdline parse(const args_vector&, const options_vector&); 79 parsed_cmdline parse(const int, const char* const*, const options_vector&); 80 81 82 } // namespace cmdline 83 } // namespace utils 84 85 #endif // !defined(UTILS_CMDLINE_PARSER_HPP) 86