#pragma once #include "args.hh" #include "common-eval-args.hh" #include "path.hh" namespace nix { extern std::string programPath; struct Value; class Bindings; class EvalState; struct Pos; class Store; /* A command that requires a Nix store. */ struct StoreCommand : virtual Command { StoreCommand(); void run() override; ref getStore(); virtual ref createStore(); virtual void run(ref) = 0; private: std::shared_ptr _store; }; struct Buildable { std::optional drvPath; std::map outputs; }; typedef std::vector Buildables; struct Installable { virtual ~Installable() { } virtual std::string what() = 0; virtual Buildables toBuildables() { throw Error("argument '%s' cannot be built", what()); } Buildable toBuildable(); virtual Value * toValue(EvalState & state) { throw Error("argument '%s' cannot be evaluated", what()); } }; struct SourceExprCommand : virtual Args, StoreCommand, MixEvalArgs { Path file; SourceExprCommand(); /* Return a value representing the Nix expression from which we are installing. This is either the file specified by ‘--file’, or an attribute set constructed from $NIX_PATH, e.g. ‘{ nixpkgs = import ...; bla = import ...; }’. */ Value * getSourceExpr(EvalState & state); ref getEvalState(); private: std::shared_ptr evalState; Value * vSourceExpr = 0; }; enum RealiseMode { Build, NoBuild, DryRun }; /* 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> installables; InstallablesCommand() { expectArgs("installables", &_installables); } void prepare() override; virtual bool useDefaultInstallables() { return true; } private: std::vector _installables; }; /* A command that operates on exactly one "installable" */ struct InstallableCommand : virtual Args, SourceExprCommand { std::shared_ptr installable; InstallableCommand() { expectArg("installable", &_installable); } 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; protected: RealiseMode realiseMode = NoBuild; public: StorePathsCommand(bool recursive = false); using StoreCommand::run; virtual void run(ref store, std::vector storePaths) = 0; void run(ref 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, const StorePath & storePath) = 0; void run(ref store) override; }; /* A helper class for registering commands globally. */ struct RegisterCommand { static Commands * commands; RegisterCommand(const std::string & name, std::function()> command) { if (!commands) commands = new Commands; commands->emplace(name, command); } }; template static RegisterCommand registerCommand(const std::string & name) { return RegisterCommand(name, [](){ return make_ref(); }); } std::shared_ptr parseInstallable( SourceExprCommand & cmd, ref store, const std::string & installable, bool useDefaultInstallables); Buildables build(ref store, RealiseMode mode, std::vector> installables); std::set toStorePaths(ref store, RealiseMode mode, std::vector> installables); StorePath toStorePath(ref store, RealiseMode mode, std::shared_ptr installable); std::set toDerivations(ref store, std::vector> installables, bool useDeriver = false); /* Helper function to generate args that invoke $EDITOR on filename:lineno. */ Strings editorFor(const Pos & pos); }