#pragma once #include "installables.hh" #include "args.hh" #include "common-eval-args.hh" #include "path.hh" #include "flake/lockfile.hh" #include namespace nix { extern std::string programPath; extern char * * savedArgv; class EvalState; struct Pos; class Store; static constexpr Command::Category catSecondary = 100; static constexpr Command::Category catUtility = 101; static constexpr Command::Category catNixInstallation = 102; static constexpr auto installablesCategory = "Options that change the interpretation of installables"; struct NixMultiCommand : virtual MultiCommand, virtual Command { nlohmann::json toJSON() override; }; /* 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; }; /* A command that copies something between `--from` and `--to` stores. */ struct CopyCommand : virtual StoreCommand { std::string srcUri, dstUri; CopyCommand(); ref createStore() override; ref getDstStore(); }; struct EvalCommand : virtual StoreCommand, MixEvalArgs { bool startReplOnEvalErrors = false; EvalCommand(); ~EvalCommand(); ref getEvalStore(); ref getEvalState(); private: std::shared_ptr evalStore; std::shared_ptr evalState; }; struct MixFlakeOptions : virtual Args, EvalCommand { flake::LockFlags lockFlags; std::optional needsFlakeInputCompletion = {}; MixFlakeOptions(); virtual std::vector getFlakesForCompletion() { return {}; } void completeFlakeInput(std::string_view prefix); void completionHook() override; }; struct SourceExprCommand : virtual Args, MixFlakeOptions { std::optional file; std::optional expr; bool readOnlyMode = false; // FIXME: move this; not all commands (e.g. 'nix run') use it. OperateOn operateOn = OperateOn::Output; SourceExprCommand(bool supportReadOnlyMode = false); std::vector> parseInstallables( ref store, std::vector ss); std::shared_ptr parseInstallable( ref store, const std::string & installable); virtual Strings getDefaultFlakeAttrPaths(); virtual Strings getDefaultFlakeAttrPathPrefixes(); void completeInstallable(std::string_view prefix); }; /* 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(); void prepare() override; virtual bool useDefaultInstallables() { return true; } std::vector getFlakesForCompletion() override; private: std::vector _installables; }; /* A command that operates on exactly one "installable" */ struct InstallableCommand : virtual Args, SourceExprCommand { std::shared_ptr installable; InstallableCommand(bool supportReadOnlyMode = false); void prepare() override; std::vector getFlakesForCompletion() override { return {_installable}; } private: std::string _installable{"."}; }; /* A command that operates on zero or more store paths. */ struct BuiltPathsCommand : public InstallablesCommand { private: bool recursive = false; bool all = false; protected: Realise realiseMode = Realise::Derivation; public: BuiltPathsCommand(bool recursive = false); using StoreCommand::run; virtual void run(ref store, BuiltPaths && paths) = 0; void run(ref store) override; bool useDefaultInstallables() override { return !all; } }; struct StorePathsCommand : public BuiltPathsCommand { StorePathsCommand(bool recursive = false); using BuiltPathsCommand::run; virtual void run(ref store, std::vector && storePaths) = 0; void run(ref store, BuiltPaths && paths) override; }; /* A command that operates on exactly one store path. */ struct StorePathCommand : public StorePathsCommand { using StorePathsCommand::run; virtual void run(ref store, const StorePath & storePath) = 0; void run(ref store, std::vector && storePaths) override; }; /* A helper class for registering commands globally. */ struct RegisterCommand { typedef std::map, std::function()>> Commands; static Commands * commands; RegisterCommand(std::vector && name, std::function()> command) { if (!commands) commands = new Commands; commands->emplace(name, command); } static nix::Commands getCommandsFor(const std::vector & prefix); }; template static RegisterCommand registerCommand(const std::string & name) { return RegisterCommand({name}, [](){ return make_ref(); }); } template static RegisterCommand registerCommand2(std::vector && name) { return RegisterCommand(std::move(name), [](){ return make_ref(); }); } /* Helper function to generate args that invoke $EDITOR on filename:lineno. */ Strings editorFor(const Path & file, uint32_t line); struct MixProfile : virtual StoreCommand { std::optional profile; MixProfile(); /* If 'profile' is set, make it point at 'storePath'. */ void updateProfile(const StorePath & storePath); /* If 'profile' is set, make it point at the store path produced by 'buildables'. */ void updateProfile(const BuiltPaths & buildables); }; struct MixDefaultProfile : MixProfile { MixDefaultProfile(); }; struct MixEnvironment : virtual Args { StringSet keep, unset; Strings stringsEnv; std::vector vectorEnv; bool ignoreEnvironment; MixEnvironment(); /* Modify global environ based on ignoreEnvironment, keep, and unset. It's expected that exec will be called before this class goes out of scope, otherwise environ will become invalid. */ void setEnviron(); }; void completeFlakeRef(ref store, std::string_view prefix); void completeFlakeRefWithFragment( ref evalState, flake::LockFlags lockFlags, Strings attrPathPrefixes, const Strings & defaultFlakeAttrPaths, std::string_view prefix); std::string showVersions(const std::set & versions); void printClosureDiff( ref store, const StorePath & beforePath, const StorePath & afterPath, std::string_view indent); void runRepl( ref evalState, const ValMap & extraEnv); }