#pragma once #include #include #include #include #include "util.hh" namespace nix { 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); /* Return a short one-line description of the command. */ virtual std::string description() { return ""; } /* Return documentation about this command, in Markdown format. */ virtual std::string doc() { return ""; } protected: static const size_t ArityAny = std::numeric_limits::max(); struct Handler { std::function)> fun; size_t arity; Handler() {} Handler(std::function)> && fun) : fun(std::move(fun)) , arity(ArityAny) { } Handler(std::function && handler) : fun([handler{std::move(handler)}](std::vector) { handler(); }) , arity(0) { } Handler(std::function && handler) : fun([handler{std::move(handler)}](std::vector ss) { handler(std::move(ss[0])); }) , arity(1) { } Handler(std::function && handler) : fun([handler{std::move(handler)}](std::vector ss) { handler(std::move(ss[0]), std::move(ss[1])); }) , arity(2) { } Handler(std::vector * dest) : fun([=](std::vector ss) { *dest = ss; }) , arity(ArityAny) { } template Handler(T * dest) : fun([=](std::vector ss) { *dest = ss[0]; }) , arity(1) { } template Handler(T * dest, const T & val) : fun([=](std::vector ss) { *dest = val; }) , arity(0) { } }; /* Flags. */ struct Flag { typedef std::shared_ptr ptr; std::string longName; char shortName = 0; std::string description; std::string category; Strings labels; Handler handler; std::function completer; static Flag mkHashTypeFlag(std::string && longName, HashType * ht); static Flag mkHashTypeOptFlag(std::string && longName, std::optional * oht); }; std::map longFlags; std::map shortFlags; virtual bool processFlag(Strings::iterator & pos, Strings::iterator end); virtual void printFlags(std::ostream & out); /* Positional arguments. */ struct ExpectedArg { std::string label; bool optional = false; Handler handler; std::function completer; }; std::list expectedArgs; virtual bool processArgs(const Strings & args, bool finish); virtual Strings::iterator rewriteArgs(Strings & args, Strings::iterator pos) { return pos; } std::set hiddenCategories; public: void addFlag(Flag && flag); /* Helper functions for constructing flags / positional arguments. */ void mkFlag1(char shortName, const std::string & longName, const std::string & label, const std::string & description, std::function fun) { addFlag({ .longName = longName, .shortName = shortName, .description = description, .labels = {label}, .handler = {[=](std::string s) { fun(s); }} }); } void mkFlag(char shortName, const std::string & name, const std::string & description, bool * dest) { mkFlag(shortName, name, description, dest, true); } template void mkFlag(char shortName, const std::string & longName, const std::string & description, T * dest, const T & value) { addFlag({ .longName = longName, .shortName = shortName, .description = description, .handler = {[=]() { *dest = value; }} }); } template void mkIntFlag(char shortName, const std::string & longName, const std::string & description, I * dest) { mkFlag(shortName, longName, description, [=](I n) { *dest = n; }); } template void mkFlag(char shortName, const std::string & longName, const std::string & description, std::function fun) { addFlag({ .longName = longName, .shortName = shortName, .description = description, .labels = {"N"}, .handler = {[=](std::string s) { I n; if (!string2Int(s, n)) throw UsageError("flag '--%s' requires a integer argument", longName); fun(n); }} }); } void expectArgs(ExpectedArg && arg) { expectedArgs.emplace_back(std::move(arg)); } /* Expect a string argument. */ void expectArg(const std::string & label, string * dest, bool optional = false) { expectArgs({ .label = label, .optional = optional, .handler = {dest} }); } /* Expect 0 or more arguments. */ void expectArgs(const std::string & label, std::vector * dest) { expectArgs({ .label = label, .handler = {dest} }); } virtual nlohmann::json toJSON(); friend class MultiCommand; }; /* A command is an argument parser that can be executed by calling its run() method. */ struct Command : virtual Args { friend class MultiCommand; virtual ~Command() { } virtual void prepare() { }; virtual void run() = 0; typedef int Category; static constexpr Category catDefault = 0; virtual Category category() { return catDefault; } }; typedef std::map()>> Commands; /* An argument parser that supports multiple subcommands, i.e. ‘ ’. */ class MultiCommand : virtual Args { public: Commands commands; std::map categories; // Selected command, if any. std::optional>> command; MultiCommand(const Commands & commands); void printHelp(const string & programName, std::ostream & out) override; bool processFlag(Strings::iterator & pos, Strings::iterator end) override; bool processArgs(const Strings & args, bool finish) override; nlohmann::json toJSON() override; }; 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> Table2; void printTable(std::ostream & out, const Table2 & table); struct Completion { std::string completion; std::string description; bool operator<(const Completion & other) const; }; class Completions : public std::set { public: void add(std::string completion, std::string description = ""); }; extern std::shared_ptr completions; extern bool pathCompletions; std::optional needsCompletion(std::string_view s); void completePath(size_t, std::string_view prefix); void completeDir(size_t, std::string_view prefix); }