forked from lix-project/lix
bc23a44c54
Already, we had classes like `BuiltPathsCommand` and `StorePathsCommand`
which provided alternative `run` virtual functions providing the
implementation with more arguments. This was a very nice and easy way to
make writing command; just fill in the virtual functions and it is
fairly clear what to do.
However, exception to this pattern were `Installable{,s}Command`. These
two classes instead just had a field where the installables would be
stored, and various side-effecting `prepare` and `load` machinery too
fill them in. Command would wish out those fields.
This isn't so clear to use.
What this commit does is make those command classes like the others,
with richer `run` functions.
Not only does this restore the pattern making commands easier to write,
it has a number of other benefits:
- `prepare` and `load` are gone entirely! One command just hands just
hands off to the next.
- `useDefaultInstallables` because `defaultInstallables`. This takes
over `prepare` for the one case that needs it, and provides enough
flexiblity to handle `nix repl`'s idiosyncratic migration.
- We can use `ref` instead of `std::shared_ptr`. The former must be
initialized (so it is like Rust's `Box` rather than `Option<Box>`,
This expresses the invariant that the installable are in fact
initialized much better.
This is possible because since we just have local variables not
fields, we can stop worrying about the not-yet-initialized case.
- Fewer lines of code! (Finally I have a large refactor that makes the
number go down not up...)
- `nix repl` is now implemented in a clearer way.
The last item deserves further mention. `nix repl` is not like the other
installable commands because instead working from once-loaded
installables, it needs to be able to load them again and again.
To properly support this, we make a new superclass
`RawInstallablesCommand`. This class has the argument parsing and
completion logic, but does *not* hand off parsed installables but
instead just the raw string arguments.
This is exactly what `nix repl` needs, and allows us to instead of
having the logic awkwardly split between `prepare`,
`useDefaultInstallables,` and `load`, have everything right next to each
other. I think this will enable future simplifications of that argument
defaulting logic, but I am saving those for a future PR --- best to keep
code motion and more complicated boolean expression rewriting separate
steps.
The "diagnostic ignored `-Woverloaded-virtual`" pragma helps because C++
doesn't like our many `run` methods. In our case, we don't mind the
shadowing it all --- it is *intentional* that the derived class only
provides a `run` method, and doesn't call any of the overridden `run`
methods.
Helps with https://github.com/NixOS/rfcs/pull/134
83 lines
2.4 KiB
C++
83 lines
2.4 KiB
C++
#include "command.hh"
|
|
#include "common-args.hh"
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using namespace nix;
|
|
|
|
struct CmdRealisation : virtual NixMultiCommand
|
|
{
|
|
CmdRealisation() : MultiCommand(RegisterCommand::getCommandsFor({"realisation"}))
|
|
{ }
|
|
|
|
std::string description() override
|
|
{
|
|
return "manipulate a Nix realisation";
|
|
}
|
|
|
|
Category category() override { return catUtility; }
|
|
|
|
void run() override
|
|
{
|
|
if (!command)
|
|
throw UsageError("'nix realisation' requires a sub-command.");
|
|
command->second->run();
|
|
}
|
|
};
|
|
|
|
static auto rCmdRealisation = registerCommand<CmdRealisation>("realisation");
|
|
|
|
struct CmdRealisationInfo : BuiltPathsCommand, MixJSON
|
|
{
|
|
std::string description() override
|
|
{
|
|
return "query information about one or several realisations";
|
|
}
|
|
|
|
std::string doc() override
|
|
{
|
|
return
|
|
#include "realisation/info.md"
|
|
;
|
|
}
|
|
|
|
Category category() override { return catSecondary; }
|
|
|
|
void run(ref<Store> store, BuiltPaths && paths) override
|
|
{
|
|
settings.requireExperimentalFeature(Xp::CaDerivations);
|
|
RealisedPath::Set realisations;
|
|
|
|
for (auto & builtPath : paths) {
|
|
auto theseRealisations = builtPath.toRealisedPaths(*store);
|
|
realisations.insert(theseRealisations.begin(), theseRealisations.end());
|
|
}
|
|
|
|
if (json) {
|
|
nlohmann::json res = nlohmann::json::array();
|
|
for (auto & path : realisations) {
|
|
nlohmann::json currentPath;
|
|
if (auto realisation = std::get_if<Realisation>(&path.raw))
|
|
currentPath = realisation->toJSON();
|
|
else
|
|
currentPath["opaquePath"] = store->printStorePath(path.path());
|
|
|
|
res.push_back(currentPath);
|
|
}
|
|
logger->cout("%s", res);
|
|
}
|
|
else {
|
|
for (auto & path : realisations) {
|
|
if (auto realisation = std::get_if<Realisation>(&path.raw)) {
|
|
logger->cout("%s %s",
|
|
realisation->id.to_string(),
|
|
store->printStorePath(realisation->outPath));
|
|
} else
|
|
logger->cout("%s", store->printStorePath(path.path()));
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
static auto rCmdRealisationInfo = registerCommand2<CmdRealisationInfo>({"realisation", "info"});
|