Skip to content

Commit

Permalink
Don't show flags from config settings in "nix --help"
Browse files Browse the repository at this point in the history
  • Loading branch information
@edolstra
edolstra committed Jun 7, 2017
1 parent aa952d5 commit 1865719
Show file tree
Hide file tree
Showing 9 changed files with 140 additions and 54 deletions.
8 changes: 6 additions & 2 deletions src/libmain/common-args.cc
View file
Expand Up @@ -18,8 +18,12 @@ MixCommonArgs::MixCommonArgs(const string & programName)
verbosity = lvlDebug;
});

mkFlag(0, "option", {"name", "value"}, "set a Nix configuration option (overriding nix.conf)", 2,
[](Strings ss) {
mkFlag()
.longName("option")
.labels({"name", "value"})
.description("set a Nix configuration option (overriding nix.conf)")
.arity(2)
.handler([](Strings ss) {
auto name = ss.front(); ss.pop_front();
auto value = ss.front();
try {
Expand Down
20 changes: 16 additions & 4 deletions src/libstore/globals.cc
View file
Expand Up @@ -98,11 +98,23 @@ template<> void BaseSetting<SandboxMode>::toJSON(JSONPlaceholder & out)
AbstractSetting::toJSON(out);
}

template<> void BaseSetting<SandboxMode>::convertToArg(Args & args)
template<> void BaseSetting<SandboxMode>::convertToArg(Args & args, const std::string & category)
{
args.mkFlag(0, name, {}, "Enable sandboxing.", 0, [=](Strings ss) { value = smEnabled; });
args.mkFlag(0, "no-" + name, {}, "Disable sandboxing.", 0, [=](Strings ss) { value = smDisabled; });
args.mkFlag(0, "relaxed-" + name, {}, "Enable sandboxing, but allow builds to disable it.", 0, [=](Strings ss) { value = smRelaxed; });
args.mkFlag()
.longName(name)
.description("Enable sandboxing.")
.handler([=](Strings ss) { value = smEnabled; })
.category(category);
args.mkFlag()
.longName("no-" + name)
.description("Disable sandboxing.")
.handler([=](Strings ss) { value = smDisabled; })
.category(category);
args.mkFlag()
.longName("relaxed-" + name)
.description("Enable sandboxing, but allow builds to disable it.")
.handler([=](Strings ss) { value = smRelaxed; })
.category(category);
}

void MaxBuildJobsSetting::set(const std::string & str)
Expand Down
26 changes: 20 additions & 6 deletions src/libutil/args.cc
View file
Expand Up @@ -3,6 +3,18 @@

namespace nix {

Args::FlagMaker Args::mkFlag()
{
return FlagMaker(*this);
}

Args::FlagMaker::~FlagMaker()
{
assert(flag->longName != "");
args.longFlags[flag->longName] = flag;
if (flag->shortName) args.shortFlags[flag->shortName] = flag;
}

void Args::parseCmdline(const Strings & _cmdline)
{
Strings pendingArgs;
Expand Down Expand Up @@ -71,11 +83,13 @@ void Args::printHelp(const string & programName, std::ostream & out)
void Args::printFlags(std::ostream & out)
{
Table2 table;
for (auto & flag : longFlags)
for (auto & flag : longFlags) {
if (hiddenCategories.count(flag.second->category)) continue;
table.push_back(std::make_pair(
(flag.second.shortName ? std::string("-") + flag.second.shortName + ", " : " ")
+ "--" + flag.first + renderLabels(flag.second.labels),
flag.second.description));
(flag.second->shortName ? std::string("-") + flag.second->shortName + ", " : " ")
+ "--" + flag.first + renderLabels(flag.second->labels),
flag.second->description));
}
printTable(out, table);
}

Expand All @@ -99,14 +113,14 @@ bool Args::processFlag(Strings::iterator & pos, Strings::iterator end)
if (string(*pos, 0, 2) == "--") {
auto i = longFlags.find(string(*pos, 2));
if (i == longFlags.end()) return false;
return process("--" + i->first, i->second);
return process("--" + i->first, *i->second);
}

if (string(*pos, 0, 1) == "-" && pos->size() == 2) {
auto c = (*pos)[1];
auto i = shortFlags.find(c);
if (i == shortFlags.end()) return false;
return process(std::string("-") + c, i->second);
return process(std::string("-") + c, *i->second);
}

return false;
Expand Down
83 changes: 57 additions & 26 deletions src/libutil/args.hh
View file
Expand Up @@ -29,15 +29,18 @@ protected:
/* Flags. */
struct Flag
{
char shortName;
typedef std::shared_ptr<Flag> ptr;
std::string longName;
char shortName = 0;
std::string description;
Strings labels;
size_t arity;
size_t arity = 0;
std::function<void(Strings)> handler;
std::string category;
};

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

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

Expand All @@ -55,33 +58,53 @@ protected:

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

std::set<std::string> hiddenCategories;

public:

class FlagMaker
{
Args & args;
Flag::ptr flag;
friend class Args;
FlagMaker(Args & args) : args(args), flag(std::make_shared<Flag>()) { };
public:
~FlagMaker();
FlagMaker & longName(const std::string & s) { flag->longName = s; return *this; };
FlagMaker & shortName(char s) { flag->shortName = s; return *this; };
FlagMaker & description(const std::string & s) { flag->description = s; return *this; };
FlagMaker & labels(const Strings & ls) { flag->labels = ls; return *this; };
FlagMaker & arity(size_t arity) { flag->arity = arity; return *this; };
FlagMaker & handler(std::function<void(Strings)> handler) { flag->handler = handler; return *this; };
FlagMaker & category(const std::string & s) { flag->category = s; return *this; };
};

FlagMaker mkFlag();

/* 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));
mkFlag()
.shortName(shortName)
.longName(longName)
.description(description)
.handler(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());
});
mkFlag()
.shortName(shortName)
.longName(longName)
.labels({label})
.description(description)
.arity(1)
.handler([=](Strings ss) { fun(ss.front()); });
}

void mkFlag(char shortName, const std::string & name,
Expand All @@ -105,9 +128,11 @@ public:
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;
});
mkFlag()
.shortName(shortName)
.longName(longName)
.description(description)
.handler([=](Strings ss) { *dest = value; });
}

template<class I>
Expand All @@ -123,12 +148,18 @@ public:
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);
});
mkFlag()
.shortName(shortName)
.longName(longName)
.labels({"N"})
.description(description)
.arity(1)
.handler([=](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. */
Expand Down
29 changes: 21 additions & 8 deletions src/libutil/config.cc
View file
Expand Up @@ -115,11 +115,11 @@ void Config::toJSON(JSONObject & out)
}
}

void Config::convertToArgs(Args & args)
void Config::convertToArgs(Args & args, const std::string & category)
{
for (auto & s : _settings)
if (!s.second.isAlias)
s.second.setting->convertToArg(args);
s.second.setting->convertToArg(args, category);
}

AbstractSetting::AbstractSetting(
Expand All @@ -135,7 +135,7 @@ void AbstractSetting::toJSON(JSONPlaceholder & out)
out.write(to_string());
}

void AbstractSetting::convertToArg(Args & args)
void AbstractSetting::convertToArg(Args & args, const std::string & category)
{
}

Expand All @@ -146,9 +146,14 @@ void BaseSetting<T>::toJSON(JSONPlaceholder & out)
}

template<typename T>
void BaseSetting<T>::convertToArg(Args & args)
void BaseSetting<T>::convertToArg(Args & args, const std::string & category)
{
args.mkFlag(0, name, {}, description, 1, [=](Strings ss) { set(*ss.begin()); });
args.mkFlag()
.longName(name)
.description(description)
.arity(1)
.handler([=](Strings ss) { set(*ss.begin()); })
.category(category);
}

template<> void BaseSetting<std::string>::set(const std::string & str)
Expand Down Expand Up @@ -191,10 +196,18 @@ template<> std::string BaseSetting<bool>::to_string()
return value ? "true" : "false";
}

template<> void BaseSetting<bool>::convertToArg(Args & args)
template<> void BaseSetting<bool>::convertToArg(Args & args, const std::string & category)
{
args.mkFlag(0, name, {}, description, 0, [=](Strings ss) { value = true; });
args.mkFlag(0, "no-" + name, {}, description, 0, [=](Strings ss) { value = false; });
args.mkFlag()
.longName(name)
.description(description)
.handler([=](Strings ss) { value = true; })
.category(category);
args.mkFlag()
.longName("no-" + name)
.description(description)
.handler([=](Strings ss) { value = false; })
.category(category);
}

template<> void BaseSetting<Strings>::set(const std::string & str)
Expand Down
6 changes: 3 additions & 3 deletions src/libutil/config.hh
View file
Expand Up @@ -72,7 +72,7 @@ public:

void toJSON(JSONObject & out);

void convertToArgs(Args & args);
void convertToArgs(Args & args, const std::string & category);
};

class AbstractSetting
Expand Down Expand Up @@ -109,7 +109,7 @@ protected:

virtual void toJSON(JSONPlaceholder & out);

virtual void convertToArg(Args & args);
virtual void convertToArg(Args & args, const std::string & category);

bool isOverriden() { return overriden; }
};
Expand Down Expand Up @@ -144,7 +144,7 @@ public:

std::string to_string() override;

void convertToArg(Args & args) override;
void convertToArg(Args & args, const std::string & category) override;

void toJSON(JSONPlaceholder & out) override;
};
Expand Down
4 changes: 3 additions & 1 deletion src/nix/main.cc
View file
Expand Up @@ -33,7 +33,9 @@ struct NixArgs : virtual MultiCommand, virtual MixCommonArgs

mkFlag(0, "version", "show version information", std::bind(printVersion, programName));

settings.convertToArgs(*this);
std::string cat = "config";
settings.convertToArgs(*this, cat);
hiddenCategories.insert(cat);
}

void printFlags(std::ostream & out) override
Expand Down
9 changes: 7 additions & 2 deletions src/nix/sigs.cc
View file
Expand Up @@ -13,8 +13,13 @@ struct CmdCopySigs : StorePathsCommand

CmdCopySigs()
{
mkFlag('s', "substituter", {"store-uri"}, "use signatures from specified store", 1,
[&](Strings ss) { substituterUris.push_back(ss.front()); });
mkFlag()
.longName("substituter")
.shortName('s')
.labels({"store-uri"})
.description("use signatures from specified store")
.arity(1)
.handler([&](Strings ss) { substituterUris.push_back(ss.front()); });
}

std::string name() override
Expand Down
9 changes: 7 additions & 2 deletions src/nix/verify.cc
View file
Expand Up @@ -19,8 +19,13 @@ struct CmdVerify : StorePathsCommand
{
mkFlag(0, "no-contents", "do not verify the contents of each store path", &noContents);
mkFlag(0, "no-trust", "do not verify whether each store path is trusted", &noTrust);
mkFlag('s', "substituter", {"store-uri"}, "use signatures from specified store", 1,
[&](Strings ss) { substituterUris.push_back(ss.front()); });
mkFlag()
.longName("substituter")
.shortName('s')
.labels({"store-uri"})
.description("use signatures from specified store")
.arity(1)
.handler([&](Strings ss) { substituterUris.push_back(ss.front()); });
mkIntFlag('n', "sigs-needed", "require that each path has at least N valid signatures", &sigsNeeded);
}

Expand Down

0 comments on commit 1865719

Please sign in to comment.