forked from lix-project/lix
eldritch horrors
512c1f05c3
Previously, there were two mostly-identical value printers -- one in
`libexpr/eval.cc` (which didn't force values) and one in
`libcmd/repl.cc` (which did force values and also printed ANSI color
codes).
This PR unifies both of these printers into `print.cc` and provides a
`PrintOptions` struct for controlling the output, which allows for
toggling whether values are forced, whether repeated values are tracked,
and whether ANSI color codes are displayed.
Additionally, `PrintOptions` allows tuning the maximum number of
attributes, list items, and bytes in a string that will be displayed;
this makes it ideal for contexts where printing too much output (e.g.
all of Nixpkgs) is distracting. (As requested by @roberth in
https://github.com/NixOS/nix/pull/9554#issuecomment-1845095735)
Please read the tests for example output.
Future work:
- It would be nice to provide this function as a builtin, perhaps
`builtins.toStringDebug` -- a printing function that never fails would
be useful when debugging Nix code.
- It would be nice to support customizing `PrintOptions` members on the
command line, e.g. `--option to-string-max-attrs 1000`.
(cherry picked from commit 0fa08b451682fb3311fe58112ff05c4fe5bee3a4, )
===
Restore ambiguous value printer for `nix-instantiate`
The Nix team has requested that this output format remain unchanged.
I've added a warning to the man page explaining that `nix-instantiate
--eval` output will not parse correctly in many situations.
(cherry picked from commit df84dd4d8dd3fd6381ac2ca3064432ab31a16b79)
Change-Id: I7cca6b4b53cd0642f2d49af657d5676a8554c9f8
200 lines
6.6 KiB
C++
200 lines
6.6 KiB
C++
#include "globals.hh"
|
|
#include "print-ambiguous.hh"
|
|
#include "shared.hh"
|
|
#include "eval.hh"
|
|
#include "eval-inline.hh"
|
|
#include "get-drvs.hh"
|
|
#include "attr-path.hh"
|
|
#include "value-to-xml.hh"
|
|
#include "value-to-json.hh"
|
|
#include "util.hh"
|
|
#include "store-api.hh"
|
|
#include "local-fs-store.hh"
|
|
#include "common-eval-args.hh"
|
|
#include "legacy.hh"
|
|
|
|
#include <map>
|
|
#include <iostream>
|
|
|
|
|
|
using namespace nix;
|
|
|
|
|
|
static Path gcRoot;
|
|
static int rootNr = 0;
|
|
|
|
|
|
enum OutputKind { okPlain, okXML, okJSON };
|
|
|
|
void processExpr(EvalState & state, const Strings & attrPaths,
|
|
bool parseOnly, bool strict, Bindings & autoArgs,
|
|
bool evalOnly, OutputKind output, bool location, Expr * e)
|
|
{
|
|
if (parseOnly) {
|
|
e->show(state.symbols, std::cout);
|
|
std::cout << "\n";
|
|
return;
|
|
}
|
|
|
|
Value vRoot;
|
|
state.eval(e, vRoot);
|
|
|
|
for (auto & i : attrPaths) {
|
|
Value & v(*findAlongAttrPath(state, i, autoArgs, vRoot).first);
|
|
state.forceValue(v, v.determinePos(noPos));
|
|
|
|
NixStringContext context;
|
|
if (evalOnly) {
|
|
Value vRes;
|
|
if (autoArgs.empty())
|
|
vRes = v;
|
|
else
|
|
state.autoCallFunction(autoArgs, v, vRes);
|
|
if (output == okXML)
|
|
printValueAsXML(state, strict, location, vRes, std::cout, context, noPos);
|
|
else if (output == okJSON) {
|
|
printValueAsJSON(state, strict, vRes, v.determinePos(noPos), std::cout, context);
|
|
std::cout << std::endl;
|
|
} else {
|
|
if (strict) state.forceValueDeep(vRes);
|
|
std::set<const void *> seen;
|
|
printAmbiguous(vRes, state.symbols, std::cout, &seen, std::numeric_limits<int>::max());
|
|
std::cout << std::endl;
|
|
}
|
|
} else {
|
|
DrvInfos drvs;
|
|
getDerivations(state, v, "", autoArgs, drvs, false);
|
|
for (auto & i : drvs) {
|
|
auto drvPath = i.requireDrvPath();
|
|
auto drvPathS = state.store->printStorePath(drvPath);
|
|
|
|
/* What output do we want? */
|
|
std::string outputName = i.queryOutputName();
|
|
if (outputName == "")
|
|
throw Error("derivation '%1%' lacks an 'outputName' attribute", drvPathS);
|
|
|
|
if (gcRoot == "")
|
|
printGCWarning();
|
|
else {
|
|
Path rootName = absPath(gcRoot);
|
|
if (++rootNr > 1) rootName += "-" + std::to_string(rootNr);
|
|
auto store2 = state.store.dynamic_pointer_cast<LocalFSStore>();
|
|
if (store2)
|
|
drvPathS = store2->addPermRoot(drvPath, rootName);
|
|
}
|
|
std::cout << fmt("%s%s\n", drvPathS, (outputName != "out" ? "!" + outputName : ""));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
static int main_nix_instantiate(int argc, char * * argv)
|
|
{
|
|
{
|
|
Strings files;
|
|
bool readStdin = false;
|
|
bool fromArgs = false;
|
|
bool findFile = false;
|
|
bool evalOnly = false;
|
|
bool parseOnly = false;
|
|
OutputKind outputKind = okPlain;
|
|
bool xmlOutputSourceLocation = true;
|
|
bool strict = false;
|
|
Strings attrPaths;
|
|
bool wantsReadWrite = false;
|
|
|
|
struct MyArgs : LegacyArgs, MixEvalArgs
|
|
{
|
|
using LegacyArgs::LegacyArgs;
|
|
};
|
|
|
|
MyArgs myArgs(std::string(baseNameOf(argv[0])), [&](Strings::iterator & arg, const Strings::iterator & end) {
|
|
if (*arg == "--help")
|
|
showManPage("nix-instantiate");
|
|
else if (*arg == "--version")
|
|
printVersion("nix-instantiate");
|
|
else if (*arg == "-")
|
|
readStdin = true;
|
|
else if (*arg == "--expr" || *arg == "-E")
|
|
fromArgs = true;
|
|
else if (*arg == "--eval" || *arg == "--eval-only")
|
|
evalOnly = true;
|
|
else if (*arg == "--read-write-mode")
|
|
wantsReadWrite = true;
|
|
else if (*arg == "--parse" || *arg == "--parse-only")
|
|
parseOnly = evalOnly = true;
|
|
else if (*arg == "--find-file")
|
|
findFile = true;
|
|
else if (*arg == "--attr" || *arg == "-A")
|
|
attrPaths.push_back(getArg(*arg, arg, end));
|
|
else if (*arg == "--add-root")
|
|
gcRoot = getArg(*arg, arg, end);
|
|
else if (*arg == "--indirect")
|
|
;
|
|
else if (*arg == "--xml")
|
|
outputKind = okXML;
|
|
else if (*arg == "--json")
|
|
outputKind = okJSON;
|
|
else if (*arg == "--no-location")
|
|
xmlOutputSourceLocation = false;
|
|
else if (*arg == "--strict")
|
|
strict = true;
|
|
else if (*arg == "--dry-run")
|
|
settings.readOnlyMode = true;
|
|
else if (*arg != "" && arg->at(0) == '-')
|
|
return false;
|
|
else
|
|
files.push_back(*arg);
|
|
return true;
|
|
});
|
|
|
|
myArgs.parseCmdline(argvToStrings(argc, argv));
|
|
|
|
if (evalOnly && !wantsReadWrite)
|
|
settings.readOnlyMode = true;
|
|
|
|
auto store = openStore();
|
|
auto evalStore = myArgs.evalStoreUrl ? openStore(*myArgs.evalStoreUrl) : store;
|
|
|
|
auto state = std::make_unique<EvalState>(myArgs.searchPath, evalStore, store);
|
|
state->repair = myArgs.repair;
|
|
|
|
Bindings & autoArgs = *myArgs.getAutoArgs(*state);
|
|
|
|
if (attrPaths.empty()) attrPaths = {""};
|
|
|
|
if (findFile) {
|
|
for (auto & i : files) {
|
|
auto p = state->findFile(i);
|
|
if (auto fn = p.getPhysicalPath())
|
|
std::cout << fn->abs() << std::endl;
|
|
else
|
|
throw Error("'%s' has no physical path", p);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
if (readStdin) {
|
|
Expr * e = state->parseStdin();
|
|
processExpr(*state, attrPaths, parseOnly, strict, autoArgs,
|
|
evalOnly, outputKind, xmlOutputSourceLocation, e);
|
|
} else if (files.empty() && !fromArgs)
|
|
files.push_back("./default.nix");
|
|
|
|
for (auto & i : files) {
|
|
Expr * e = fromArgs
|
|
? state->parseExprFromString(i, state->rootPath(CanonPath::fromCwd()))
|
|
: state->parseExprFromFile(resolveExprPath(state->checkSourcePath(lookupFileArg(*state, i))));
|
|
processExpr(*state, attrPaths, parseOnly, strict, autoArgs,
|
|
evalOnly, outputKind, xmlOutputSourceLocation, e);
|
|
}
|
|
|
|
state->maybePrintStats();
|
|
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
static RegisterLegacyCommand r_nix_instantiate("nix-instantiate", main_nix_instantiate);
|