lix/src/nix/command.hh

244 lines
5.3 KiB
C++
Raw Normal View History

#pragma once
#include "args.hh"
#include "common-eval-args.hh"
#include <optional>
namespace nix {
extern std::string programPath;
2017-04-25 10:06:32 +00:00
struct Value;
class Bindings;
2017-04-25 10:06:32 +00:00
class EvalState;
class Store;
namespace flake {
enum HandleLockFile : unsigned int;
}
/* A command that require a Nix store. */
struct StoreCommand : virtual Command
{
StoreCommand();
void run() override;
ref<Store> getStore();
virtual ref<Store> createStore();
virtual void run(ref<Store>) = 0;
private:
std::shared_ptr<Store> _store;
};
2017-09-06 14:03:22 +00:00
struct Buildable
{
Path drvPath; // may be empty
std::map<std::string, Path> outputs;
};
typedef std::vector<Buildable> Buildables;
struct App
{
PathSet context;
Path program;
// FIXME: add args, sandbox settings, metadata, ...
2019-06-17 15:59:57 +00:00
App(EvalState & state, Value & vApp);
};
2017-04-25 10:06:32 +00:00
struct Installable
{
virtual std::string what() = 0;
2017-09-06 14:03:22 +00:00
virtual Buildables toBuildables()
2017-04-25 10:06:32 +00:00
{
throw Error("argument '%s' cannot be built", what());
2017-04-25 10:06:32 +00:00
}
2017-09-06 14:03:22 +00:00
Buildable toBuildable();
App toApp(EvalState & state);
2017-04-25 10:06:32 +00:00
virtual Value * toValue(EvalState & state)
{
throw Error("argument '%s' cannot be evaluated", what());
2017-04-25 10:06:32 +00:00
}
/* Return a value only if this installable is a store path or a
symlink to it. */
virtual std::optional<Path> getStorePath()
{
return {};
}
2017-04-25 10:06:32 +00:00
};
struct EvalCommand : virtual StoreCommand, MixEvalArgs
{
ref<EvalState> getEvalState();
private:
std::shared_ptr<EvalState> evalState;
};
struct MixFlakeOptions : virtual Args
2017-04-25 10:06:32 +00:00
{
2019-05-01 09:38:48 +00:00
bool recreateLockFile = false;
bool saveLockFile = true;
bool useRegistries = true;
MixFlakeOptions();
flake::HandleLockFile getLockFileMode();
};
struct SourceExprCommand : virtual Args, EvalCommand, MixFlakeOptions
{
std::optional<Path> file;
SourceExprCommand();
2019-04-08 14:11:17 +00:00
std::vector<std::shared_ptr<Installable>> parseInstallables(
ref<Store> store, std::vector<std::string> ss);
std::shared_ptr<Installable> parseInstallable(
ref<Store> store, const std::string & installable);
virtual Strings getDefaultFlakeAttrPaths()
{
return {"defaultPackage"};
}
virtual Strings getDefaultFlakeAttrPathPrefixes()
{
return {
// As a convenience, look for the attribute in
// 'outputs.packages'.
"packages.",
// As a temporary hack until Nixpkgs is properly converted
// to provide a clean 'packages' set, look in 'legacyPackages'.
"legacyPackages."
};
}
2017-07-17 17:02:56 +00:00
};
enum RealiseMode { Build, NoBuild, DryRun };
2017-07-17 17:02:56 +00:00
/* A command that operates on a list of "installables", which can be
store paths, attribute paths, Nix expressions, etc. */
struct InstallablesCommand : virtual Args, SourceExprCommand
{
std::vector<std::shared_ptr<Installable>> installables;
InstallablesCommand()
{
expectArgs("installables", &_installables);
}
2017-04-25 10:06:32 +00:00
void prepare() override;
virtual bool useDefaultInstallables() { return true; }
2017-04-25 10:06:32 +00:00
private:
std::vector<std::string> _installables;
2017-04-25 10:06:32 +00:00
};
struct InstallableCommand : virtual Args, SourceExprCommand
{
std::shared_ptr<Installable> installable;
InstallableCommand()
{
expectArg("installable", &_installable, true);
}
void prepare() override;
private:
std::string _installable{"."};
};
/* A command that operates on zero or more store paths. */
struct StorePathsCommand : public InstallablesCommand
{
private:
bool recursive = false;
bool all = false;
public:
2017-09-27 16:28:54 +00:00
StorePathsCommand(bool recursive = false);
using StoreCommand::run;
virtual void run(ref<Store> store, Paths storePaths) = 0;
void run(ref<Store> store) override;
bool useDefaultInstallables() override { return !all; }
};
/* A command that operates on exactly one store path. */
struct StorePathCommand : public InstallablesCommand
{
using StoreCommand::run;
virtual void run(ref<Store> store, const Path & storePath) = 0;
void run(ref<Store> store) override;
};
/* A helper class for registering commands globally. */
struct RegisterCommand
{
static Commands * commands;
RegisterCommand(const std::string & name,
std::function<ref<Command>()> command)
{
if (!commands) commands = new Commands;
commands->emplace(name, command);
}
};
template<class T>
static RegisterCommand registerCommand(const std::string & name)
{
return RegisterCommand(name, [](){ return make_ref<T>(); });
}
2018-02-09 15:42:32 +00:00
Buildables build(ref<Store> store, RealiseMode mode,
std::vector<std::shared_ptr<Installable>> installables);
PathSet toStorePaths(ref<Store> store, RealiseMode mode,
std::vector<std::shared_ptr<Installable>> installables);
Path toStorePath(ref<Store> store, RealiseMode mode,
std::shared_ptr<Installable> installable);
PathSet toDerivations(ref<Store> store,
std::vector<std::shared_ptr<Installable>> installables,
bool useDeriver = false);
struct MixProfile : virtual Args, virtual StoreCommand
{
std::optional<Path> profile;
MixProfile();
/* If 'profile' is set, make it point at 'storePath'. */
void updateProfile(const Path & storePath);
/* If 'profile' is set, make it point at the store path produced
by 'buildables'. */
void updateProfile(const Buildables & buildables);
};
}