summaryrefslogtreecommitdiff
path: root/src/mongo/util/options_parser/option_description.h
blob: 6f3320e1e79a0d93b68160dfc4681a1f6bf79202 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/* Copyright 2013 10gen Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <iostream>

#include "mongo/base/status.h"
#include "mongo/util/options_parser/value.h"

namespace mongo {
namespace optionenvironment {

    /**
     * An OptionType is an enum of all the types we support in the OptionsParser
     */
    enum OptionType {
        StringVector,     // po::value< std::vector<std::string> >
        Bool,             // po::value<bool>
        Double,           // po::value<double>
        Int,              // po::value<int>
        Long,             // po::value<long>
        String,           // po::value<std::string>
        UnsignedLongLong, // po::value<unsigned long long>
        Unsigned,         // po::value<unsigned>
        Switch            // po::bool_switch
    };

    /**
     * The OptionDescription and PositionalOptionDescription classes are containers for information
     * about the options we are expecting either on the command line or in config files.  These
     * should be registered in an OptionSection instance and passed to an OptionsParser.
     */
    class OptionDescription {
    public:
        OptionDescription(const std::string& dottedName,
                const std::string& singleName,
                const OptionType type,
                const std::string& description,
                const bool isVisible = true,
                const Value defaultValue = Value(),
                const Value implicitValue = Value(),
                const bool isComposing = false)
            : _dottedName(dottedName),
            _singleName(singleName),
            _type(type),
            _description(description),
            _isVisible(isVisible),
            _default(defaultValue),
            _implicit(implicitValue),
            _isComposing(isComposing) { }

        std::string _dottedName; // Used for JSON config and in Environment
        std::string _singleName; // Used for boost command line and INI
        OptionType _type; // Storage type of the argument value, or switch type (bool)
                          // (required by boost)
        std::string _description; // Description of option printed in help output
        bool _isVisible; // Visible in help output
        Value _default; // Value if option is not specified
        Value _implicit; // Value if option is specified with no argument
        bool _isComposing; // Aggregate values from different sources instead of overriding
    };

    class PositionalOptionDescription {
    public:
        PositionalOptionDescription(const std::string& name,
                const OptionType type,
                int count = 1)
            : _name(name),
                _type(type),
                _count(count) { }

        std::string _name; // Name used to access the value of this option after parsing
        OptionType _type; // Storage type of the positional argument (required by boost)
        int _count; // Max number of times this option can be specified.  -1 = unlimited
    };

} // namespace optionenvironment
} // namespace mongo