about summary refs log tree commit diff
path: root/src/libutil/args.hh
blob: 6aa08aacac9e9691d6a85cb9a15464df2e8d4b75 (plain) (blame)
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
152
153
154
155
156
157
158
159
160
161
162
163
#pragma once

#include <iostream>
#include <map>
#include <memory>

#include "util.hh"

namespace nix {

MakeError(UsageError, nix::Error);

enum HashType : char;

class Args
{
public:

    /* Parse the command line, throwing a UsageError if something goes
       wrong. */
    void parseCmdline(const Strings & cmdline);

    virtual void printHelp(const string & programName, std::ostream & out);

    virtual std::string description() { return ""; }

protected:

    /* Flags. */
    struct Flag
    {
        char shortName;
        std::string description;
        Strings labels;
        size_t arity;
        std::function<void(Strings)> handler;
    };

    std::map<std::string, Flag> longFlags;
    std::map<char, Flag> shortFlags;

    virtual bool processFlag(Strings::iterator & pos, Strings::iterator end);

    void printFlags(std::ostream & out);

    /* Positional arguments. */
    struct ExpectedArg
    {
        std::string label;
        size_t arity; // 0 = any
        std::function<void(Strings)> handler;
    };

    std::list<ExpectedArg> expectedArgs;

    virtual bool processArgs(const Strings & args, bool finish);

public:

    /* Helper functions for constructing flags / positional
       arguments. */

    void mkFlag(char shortName, const std::string & longName,
        const Strings & labels, const std::string & description,
        size_t arity, std::function<void(Strings)> handler)
    {
        auto flag = Flag{shortName, description, labels, arity, handler};
        if (shortName) shortFlags[shortName] = flag;
        longFlags[longName] = flag;
    }

    void mkFlag(char shortName, const std::string & longName,
        const std::string & description, std::function<void()> fun)
    {
        mkFlag(shortName, longName, {}, description, 0, std::bind(fun));
    }

    void mkFlag1(char shortName, const std::string & longName,
        const std::string & label, const std::string & description,
        std::function<void(std::string)> fun)
    {
        mkFlag(shortName, longName, {label}, description, 1, [=](Strings ss) {
            fun(ss.front());
        });
    }

    void mkFlag(char shortName, const std::string & name,
        const std::string & description, bool * dest)
    {
        mkFlag(shortName, name, description, dest, true);
    }

    void mkFlag(char shortName, const std::string & longName,
        const std::string & label, const std::string & description,
        string * dest)
    {
        mkFlag1(shortName, longName, label, description, [=](std::string s) {
            *dest = s;
        });
    }

    void mkHashTypeFlag(const std::string & name, HashType * ht);

    template<class T>
    void mkFlag(char shortName, const std::string & longName, const std::string & description,
        T * dest, const T & value)
    {
        mkFlag(shortName, longName, {}, description, 0, [=](Strings ss) {
            *dest = value;
        });
    }

    template<class I>
    void mkIntFlag(char shortName, const std::string & longName,
        const std::string & description, I * dest)
    {
        mkFlag<I>(shortName, longName, description, [=](I n) {
            *dest = n;
        });
    }

    template<class I>
    void mkFlag(char shortName, const std::string & longName,
        const std::string & description, std::function<void(I)> fun)
    {
        mkFlag(shortName, longName, {"N"}, description, 1, [=](Strings ss) {
            I n;
            if (!string2Int(ss.front(), n))
                throw UsageError(format("flag ‘--%1%’ requires a integer argument") % longName);
            fun(n);
        });
    }

    /* Expect a string argument. */
    void expectArg(const std::string & label, string * dest)
    {
        expectedArgs.push_back(ExpectedArg{label, 1, [=](Strings ss) {
            *dest = ss.front();
        }});
    }

    /* Expect 0 or more arguments. */
    void expectArgs(const std::string & label, Strings * dest)
    {
        expectedArgs.push_back(ExpectedArg{label, 0, [=](Strings ss) {
            *dest = ss;
        }});
    }

    friend class MultiCommand;
};

Strings argvToStrings(int argc, char * * argv);

/* Helper function for rendering argument labels. */
std::string renderLabels(const Strings & labels);

/* Helper function for printing 2-column tables. */
typedef std::vector<std::pair<std::string, std::string>> Table2;

void printTable(std::ostream & out, const Table2 & table);

}