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/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 <map>
36#include <string>
37#include <vector>
38
39namespace utils {
40namespace cmdline {
41
42
43class base_option;
44
45
46/// Replacement for argc and argv to represent a command line.
47///
48/// TODO(jmmv): This type should be somewhere else.  base_command.hpp should not
49/// be including this file to just get this type.
50typedef std::vector< std::string > args_vector;
51
52
53/// Collection of options to be used during parsing.
54///
55/// TODO(jmmv): This type should be somewhere else.  base_command.hpp should not
56/// be including this file to just get this type.
57typedef std::vector< const base_option* > options_vector;
58
59
60/// Representation of a parsed command line.
61///
62/// This class is returned by the command line parsing algorithm and provides
63/// methods to query the values of the options and the value of the arguments.
64/// All the values fed into this class can considered to be sane (i.e. the
65/// arguments to the options and the arguments to the command are valid), as all
66/// validation happens during parsing (before this class is instantiated).
67class parsed_cmdline {
68    /// Mapping of option names to all the values provided.
69    std::map< std::string, std::vector< std::string > > _option_values;
70
71    /// Collection of arguments with all options removed.
72    args_vector _arguments;
73
74    const std::vector< std::string >& get_option_raw(const std::string&) const;
75
76public:
77    parsed_cmdline(const std::map< std::string, std::vector< std::string > >&,
78                   const args_vector&);
79
80    bool has_option(const std::string&) const;
81
82    template< typename Option >
83    typename Option::option_type get_option(const std::string&) const;
84
85    template< typename Option >
86    std::vector< typename Option::option_type > get_multi_option(
87        const std::string&) const;
88
89    const args_vector& arguments(void) const;
90};
91
92
93parsed_cmdline parse(const args_vector&, const options_vector&);
94parsed_cmdline parse(const int, const char* const*, const options_vector&);
95
96
97}  // namespace cmdline
98}  // namespace utils
99
100#endif  // !defined(UTILS_CMDLINE_PARSER_HPP)
101