aboutsummaryrefslogtreecommitdiff
path: root/src/libutil/config.hh
blob: fb2d48e9c834dd4ca7ebd44a27e6d3e5f24e5085 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
#include <map>
#include <set>

#include "types.hh"

#pragma once

namespace nix {

class Args;
class AbstractSetting;

/* A class to simplify providing configuration settings. The typical
   use is to inherit Config and add Setting<T> members:

   class MyClass : private Config
   {
     Setting<int> foo{this, 123, "foo", "the number of foos to use"};
     Setting<std::string> bar{this, "blabla", "bar", "the name of the bar"};

     MyClass() : Config(readConfigFile("/etc/my-app.conf"))
     {
       std::cout << foo << "\n"; // will print 123 unless overriden
     }
   };
*/

class Config
{
    friend class AbstractSetting;

    struct SettingData
    {
        bool isAlias = false;
        AbstractSetting * setting;
    };

    std::map<std::string, SettingData> _settings;

    StringMap initials;

public:

    Config(const StringMap & initials)
        : initials(initials)
    { }

    void set(const std::string & name, const std::string & value);

    void add(AbstractSetting * setting);

    void warnUnused();

    std::string dump();
};

class AbstractSetting
{
    friend class Config;

public:

    const std::string name;
    const std::string description;
    const std::set<std::string> aliases;

    int created = 123;

protected:

    AbstractSetting(
        const std::string & name,
        const std::string & description,
        const std::set<std::string> & aliases);

    virtual ~AbstractSetting()
    {
        // Check against a gcc miscompilation causing our constructor
        // not to run.
        assert(created == 123);
    }

    virtual void set(const std::string & value) = 0;

    virtual std::string to_string() = 0;
};

/* A setting of type T. */
template<typename T>
class Setting : public AbstractSetting
{
protected:

    T value;

public:

    Setting(Config * options,
        const T & def,
        const std::string & name,
        const std::string & description,
        const std::set<std::string> & aliases = {})
        : AbstractSetting(name, description, aliases)
        , value(def)
    {
        options->add(this);
    }

    operator const T &() const { return value; }
    bool operator ==(const T & v2) const { return value == v2; }
    bool operator !=(const T & v2) const { return value != v2; }
    void operator =(const T & v) { value = v; }

    void set(const std::string & str) override;

    std::string to_string() override;
};

template<typename T>
std::ostream & operator <<(std::ostream & str, const Setting<T> & opt)
{
    str << (const T &) opt;
    return str;
}

/* A special setting for Paths. These are automatically canonicalised
   (e.g. "/foo//bar/" becomes "/foo/bar"). */
class PathSetting : public Setting<Path>
{
    bool allowEmpty;

public:

    PathSetting(Config * options,
        bool allowEmpty,
        const Path & def,
        const std::string & name,
        const std::string & description,
        const std::set<std::string> & aliases = {})
        : Setting<Path>(options, def, name, description, aliases)
        , allowEmpty(allowEmpty)
    {
        set(value);
    }

    void set(const std::string & str) override;

    Path operator +(const char * p) const { return value + p; }
};

}