lix/src/nix/repl.cc

690 lines
20 KiB
C++
Raw Normal View History

#include <iostream>
#include <cstdlib>
#include <setjmp.h>
#include "shared.hh"
#include "eval.hh"
#include "eval-inline.hh"
#include "store-api.hh"
#include "common-opts.hh"
2013-09-06 12:58:53 +00:00
#include "get-drvs.hh"
#include "derivations.hh"
2013-09-06 19:00:36 +00:00
#include "affinity.hh"
#include "globals.hh"
2017-04-25 16:48:40 +00:00
#include "command.hh"
#include "finally.hh"
#include "src/linenoise/linenoise.h"
2017-04-25 16:48:40 +00:00
namespace nix {
2016-06-25 11:25:31 +00:00
#define ESC_RED "\033[31m"
#define ESC_GRE "\033[32m"
#define ESC_YEL "\033[33m"
#define ESC_BLU "\033[34;1m"
2016-06-25 11:25:31 +00:00
#define ESC_MAG "\033[35m"
#define ESC_CYA "\033[36m"
#define ESC_END "\033[0m"
struct NixRepl
{
string curDir;
EvalState state;
2013-09-09 14:02:46 +00:00
Strings loadedFiles;
2013-09-09 15:06:14 +00:00
const static int envSize = 32768;
StaticEnv staticEnv;
Env * env;
int displ;
2013-09-06 17:51:59 +00:00
StringSet varNames;
const Path historyFile;
NixRepl(const Strings & searchPath, nix::ref<Store> store);
2017-04-25 16:48:40 +00:00
~NixRepl();
void mainLoop(const Strings & files);
StringSet completePrefix(string prefix);
bool getLine(string & input, const std::string &prompt);
Path getDerivationPath(Value & v);
2013-09-09 13:02:56 +00:00
bool processLine(string line);
void loadFile(const Path & path);
2013-09-09 15:06:14 +00:00
void initEnv();
2013-09-09 14:02:46 +00:00
void reloadFiles();
void addAttrsToScope(Value & attrs);
void addVarToScope(const Symbol & name, Value & v);
Expr * parseString(string s);
void evalString(string s, Value & v);
typedef set<Value *> ValuesSeen;
std::ostream & printValue(std::ostream & str, Value & v, unsigned int maxDepth);
std::ostream & printValue(std::ostream & str, Value & v, unsigned int maxDepth, ValuesSeen & seen);
};
void printHelp()
{
std::cout
<< "Usage: nix-repl [--help] [--version] [-I path] paths...\n"
<< "\n"
<< "nix-repl is a simple read-eval-print loop (REPL) for the Nix package manager.\n"
<< "\n"
<< "Options:\n"
<< " --help\n"
<< " Prints out a summary of the command syntax and exits.\n"
<< "\n"
<< " --version\n"
<< " Prints out the Nix version number on standard output and exits.\n"
<< "\n"
<< " -I path\n"
<< " Add a path to the Nix expression search path. This option may be given\n"
<< " multiple times. See the NIX_PATH environment variable for information on\n"
<< " the semantics of the Nix search path. Paths added through -I take\n"
<< " precedence over NIX_PATH.\n"
<< "\n"
<< " paths...\n"
<< " A list of paths to files containing Nix expressions which nix-repl will\n"
<< " load and add to its scope.\n"
<< "\n"
<< " A path surrounded in < and > will be looked up in the Nix expression search\n"
<< " path, as in the Nix language itself.\n"
<< "\n"
<< " If an element of paths starts with http:// or https://, it is interpreted\n"
<< " as the URL of a tarball that will be downloaded and unpacked to a temporary\n"
<< " location. The tarball must include a single top-level directory containing\n"
<< " at least a file named default.nix.\n";
}
string removeWhitespace(string s)
{
s = chomp(s);
size_t n = s.find_first_not_of(" \n\r\t");
if (n != string::npos) s = string(s, n);
return s;
}
NixRepl::NixRepl(const Strings & searchPath, nix::ref<Store> store)
: state(searchPath, store)
, staticEnv(false, &state.staticBaseEnv)
, historyFile(getDataDir() + "/nix/repl-history")
{
curDir = absPath(".");
}
2017-04-25 16:48:40 +00:00
NixRepl::~NixRepl()
{
linenoiseHistorySave(historyFile.c_str());
}
static NixRepl * curRepl; // ugly
static void completionCallback(const char * s, linenoiseCompletions *lc)
{
/* Otherwise, return all symbols that start with the prefix. */
for (auto & c : curRepl->completePrefix(s))
linenoiseAddCompletion(lc, c.c_str());
2017-04-25 16:48:40 +00:00
}
void NixRepl::mainLoop(const Strings & files)
{
string error = ANSI_RED "error:" ANSI_NORMAL " ";
2017-04-25 16:48:40 +00:00
std::cout << "Welcome to Nix version " << nixVersion << ". Type :? for help." << std::endl << std::endl;
for (auto & i : files)
loadedFiles.push_back(i);
2013-09-09 14:02:46 +00:00
2013-09-09 15:06:14 +00:00
reloadFiles();
if (!loadedFiles.empty()) std::cout << std::endl;
createDirs(dirOf(historyFile));
linenoiseHistorySetMaxLen(1000);
linenoiseHistoryLoad(historyFile.c_str());
2013-09-06 11:14:28 +00:00
curRepl = this;
linenoiseSetCompletionCallback(completionCallback);
std::string input;
while (true) {
2016-02-18 13:04:55 +00:00
// When continuing input from previous lines, don't print a prompt, just align to the same
// number of chars as the prompt.
if (!getLine(input, input.empty() ? "nix-repl> " : " "))
2013-09-09 13:02:56 +00:00
break;
try {
if (!removeWhitespace(input).empty() && !processLine(input)) return;
} catch (ParseError & e) {
if (e.msg().find("unexpected $end") != std::string::npos) {
// For parse errors on incomplete input, we continue waiting for the next line of
// input without clearing the input so far.
continue;
} else {
printMsg(lvlError, format(error + "%1%%2%") % (settings.showTrace ? e.prefix() : "") % e.msg());
}
} catch (Error & e) {
printMsg(lvlError, format(error + "%1%%2%") % (settings.showTrace ? e.prefix() : "") % e.msg());
} catch (Interrupted & e) {
printMsg(lvlError, format(error + "%1%%2%") % (settings.showTrace ? e.prefix() : "") % e.msg());
}
// We handled the current input fully, so we should clear it
// and read brand new input.
linenoiseHistoryAdd(input.c_str());
input.clear();
std::cout << std::endl;
}
}
bool NixRepl::getLine(string & input, const std::string &prompt)
2013-09-06 17:51:59 +00:00
{
char * s = linenoise(prompt.c_str());
Finally doFree([&]() { linenoiseFree(s); });
if (!s) return false;
input += s;
return true;
2013-09-06 17:51:59 +00:00
}
StringSet NixRepl::completePrefix(string prefix)
2013-09-06 17:51:59 +00:00
{
StringSet completions;
2017-04-25 17:19:15 +00:00
size_t start = prefix.find_last_of(" \n\r\t(){}[]");
std::string prev, cur;
if (start == std::string::npos) {
prev = "";
cur = prefix;
2016-02-18 12:50:52 +00:00
} else {
prev = std::string(prefix, 0, start + 1);
cur = std::string(prefix, start + 1);
2013-09-06 17:51:59 +00:00
}
size_t slash, dot;
if ((slash = cur.rfind('/')) != string::npos) {
try {
auto dir = std::string(cur, 0, slash);
auto prefix2 = std::string(cur, slash + 1);
for (auto & entry : readDirectory(dir == "" ? "/" : dir)) {
if (entry.name[0] != '.' && hasPrefix(entry.name, prefix2))
completions.insert(prev + dir + "/" + entry.name);
}
} catch (Error &) {
}
} else if ((dot = cur.rfind('.')) == string::npos) {
/* This is a variable name; look it up in the current scope. */
StringSet::iterator i = varNames.lower_bound(cur);
while (i != varNames.end()) {
if (string(*i, 0, cur.size()) != cur) break;
completions.insert(prev + *i);
i++;
}
} else {
try {
/* This is an expression that should evaluate to an
attribute set. Evaluate it to get the names of the
attributes. */
string expr(cur, 0, dot);
string cur2 = string(cur, dot + 1);
Expr * e = parseString(expr);
Value v;
e->eval(state, *env, v);
state.forceAttrs(v);
for (auto & i : *v.attrs) {
string name = i.name;
if (string(name, 0, cur2.size()) != cur2) continue;
completions.insert(prev + expr + "." + name);
}
} catch (ParseError & e) {
// Quietly ignore parse errors.
} catch (EvalError & e) {
// Quietly ignore evaluation errors.
} catch (UndefinedVarError & e) {
// Quietly ignore undefined variable errors.
}
2013-09-06 17:51:59 +00:00
}
return completions;
2013-09-06 17:51:59 +00:00
}
2013-09-06 19:00:36 +00:00
static int runProgram(const string & program, const Strings & args)
{
2017-04-25 17:10:47 +00:00
Strings args2(args);
args2.push_front(program);
2013-09-06 19:00:36 +00:00
Pid pid;
pid = fork();
if (pid == -1) throw SysError("forking");
if (pid == 0) {
restoreAffinity();
2017-04-25 17:10:47 +00:00
execvp(program.c_str(), stringsToCharPtrs(args2).data());
2013-09-06 19:00:36 +00:00
_exit(1);
}
2017-04-25 14:55:03 +00:00
return pid.wait();
2013-09-06 19:00:36 +00:00
}
bool isVarName(const string & s)
{
if (s.size() == 0) return false;
char c = s[0];
if ((c >= '0' && c <= '9') || c == '-' || c == '\'') return false;
for (auto & i : s)
if (!((i >= 'a' && i <= 'z') ||
(i >= 'A' && i <= 'Z') ||
(i >= '0' && i <= '9') ||
i == '_' || i == '-' || i == '\''))
return false;
return true;
}
Path NixRepl::getDerivationPath(Value & v) {
auto drvInfo = getDerivation(state, v, false);
if (!drvInfo)
throw Error("expression does not evaluate to a derivation, so I can't build it");
Path drvPath = drvInfo->queryDrvPath();
if (drvPath == "" || !state.store->isValidPath(drvPath))
throw Error("expression did not evaluate to a valid derivation");
return drvPath;
}
2013-09-09 13:02:56 +00:00
bool NixRepl::processLine(string line)
{
2013-09-09 13:02:56 +00:00
if (line == "") return true;
string command, arg;
2013-09-09 13:02:56 +00:00
if (line[0] == ':') {
2016-02-18 12:59:51 +00:00
size_t p = line.find_first_of(" \n\r\t");
2013-09-09 13:02:56 +00:00
command = string(line, 0, p);
if (p != string::npos) arg = removeWhitespace(string(line, p));
} else {
arg = line;
}
2013-09-09 14:02:46 +00:00
if (command == ":?" || command == ":help") {
std::cout
<< "The following commands are available:\n"
2013-09-09 11:22:33 +00:00
<< "\n"
<< " <expr> Evaluate and print expression\n"
<< " <x> = <expr> Bind expression to variable\n"
<< " :a <expr> Add attributes from resulting set to scope\n"
<< " :b <expr> Build derivation\n"
<< " :i <expr> Build derivation, then install result into current profile\n"
<< " :l <path> Load Nix expression and add it to scope\n"
<< " :p <expr> Evaluate and print expression recursively\n"
2013-09-09 13:02:56 +00:00
<< " :q Exit nix-repl\n"
2013-09-09 14:02:46 +00:00
<< " :r Reload all files\n"
<< " :s <expr> Build dependencies of derivation, then start nix-shell\n"
<< " :t <expr> Describe result of evaluation\n"
2016-02-19 10:00:36 +00:00
<< " :u <expr> Build derivation, then start nix-shell\n";
2013-09-09 11:22:33 +00:00
}
2013-09-09 14:02:46 +00:00
else if (command == ":a" || command == ":add") {
Value v;
2013-09-09 13:02:56 +00:00
evalString(arg, v);
addAttrsToScope(v);
}
2013-09-09 14:02:46 +00:00
else if (command == ":l" || command == ":load") {
state.resetFileCache();
2013-09-09 13:02:56 +00:00
loadFile(arg);
}
2013-09-09 14:02:46 +00:00
else if (command == ":r" || command == ":reload") {
state.resetFileCache();
reloadFiles();
}
else if (command == ":t") {
Value v;
2013-09-09 13:02:56 +00:00
evalString(arg, v);
std::cout << showType(v) << std::endl;
2016-02-19 10:00:36 +00:00
} else if (command == ":u") {
Value v, f, result;
evalString(arg, v);
evalString("drv: (import <nixpkgs> {}).runCommand \"shell\" { buildInputs = [ drv ]; } \"\"", f);
state.callFunction(f, v, result, Pos());
Path drvPath = getDerivationPath(result);
2017-04-25 17:10:47 +00:00
runProgram(settings.nixBinDir + "/nix-shell", Strings{drvPath});
}
else if (command == ":b" || command == ":i" || command == ":s") {
2013-09-06 12:58:53 +00:00
Value v;
2013-09-09 13:02:56 +00:00
evalString(arg, v);
Path drvPath = getDerivationPath(v);
if (command == ":b") {
/* We could do the build in this process using buildPaths(),
but doing it in a child makes it easier to recover from
problems / SIGINT. */
2017-04-25 17:10:47 +00:00
if (runProgram(settings.nixBinDir + "/nix-store", Strings{"-r", drvPath}) == 0) {
2014-04-11 10:50:46 +00:00
Derivation drv = readDerivation(drvPath);
2013-09-09 13:02:56 +00:00
std::cout << std::endl << "this derivation produced the following outputs:" << std::endl;
for (auto & i : drv.outputs)
std::cout << format(" %1% -> %2%") % i.first % i.second.path << std::endl;
2013-09-09 13:02:56 +00:00
}
} else if (command == ":i") {
2017-04-25 17:10:47 +00:00
runProgram(settings.nixBinDir + "/nix-env", Strings{"-i", drvPath});
} else {
2017-04-25 17:10:47 +00:00
runProgram(settings.nixBinDir + "/nix-shell", Strings{drvPath});
}
}
2013-09-09 14:02:46 +00:00
else if (command == ":p" || command == ":print") {
Value v;
2013-09-09 13:02:56 +00:00
evalString(arg, v);
printValue(std::cout, v, 1000000000) << std::endl;
}
2013-09-09 13:02:56 +00:00
else if (command == ":q" || command == ":quit")
return false;
else if (command != "")
throw Error(format("unknown command %1%") % command);
2013-09-06 12:58:53 +00:00
else {
size_t p = line.find('=');
string name;
if (p != string::npos &&
p < line.size() &&
line[p + 1] != '=' &&
isVarName(name = removeWhitespace(string(line, 0, p))))
{
Expr * e = parseString(string(line, p + 1));
Value & v(*state.allocValue());
v.type = tThunk;
v.thunk.env = env;
v.thunk.expr = e;
addVarToScope(state.symbols.create(name), v);
} else {
Value v;
evalString(line, v);
printValue(std::cout, v, 1) << std::endl;
}
}
2013-09-09 13:02:56 +00:00
return true;
}
void NixRepl::loadFile(const Path & path)
{
2013-09-09 14:02:46 +00:00
loadedFiles.remove(path);
loadedFiles.push_back(path);
Value v, v2;
state.evalFile(lookupFileArg(state, path), v);
Bindings & bindings(*state.allocBindings(0));
state.autoCallFunction(bindings, v, v2);
addAttrsToScope(v2);
}
2013-09-09 15:06:14 +00:00
void NixRepl::initEnv()
{
env = &state.allocEnv(envSize);
env->up = &state.baseEnv;
displ = 0;
staticEnv.vars.clear();
2013-09-09 15:22:42 +00:00
varNames.clear();
for (auto & i : state.staticBaseEnv.vars)
varNames.insert(i.first);
2013-09-09 15:06:14 +00:00
}
2013-09-09 14:02:46 +00:00
void NixRepl::reloadFiles()
{
2013-09-09 15:06:14 +00:00
initEnv();
2013-09-09 14:02:46 +00:00
Strings old = loadedFiles;
loadedFiles.clear();
bool first = true;
for (auto & i : old) {
if (!first) std::cout << std::endl;
first = false;
std::cout << format("Loading %1%...") % i << std::endl;
loadFile(i);
2013-09-09 14:02:46 +00:00
}
}
void NixRepl::addAttrsToScope(Value & attrs)
{
state.forceAttrs(attrs);
for (auto & i : *attrs.attrs)
addVarToScope(i.name, *i.value);
std::cout << format("Added %1% variables.") % attrs.attrs->size() << std::endl;
}
void NixRepl::addVarToScope(const Symbol & name, Value & v)
{
2013-09-09 15:06:14 +00:00
if (displ >= envSize)
throw Error("environment full; cannot add more variables");
staticEnv.vars[name] = displ;
env->values[displ++] = &v;
2013-09-06 17:51:59 +00:00
varNames.insert((string) name);
}
Expr * NixRepl::parseString(string s)
{
Expr * e = state.parseExprFromString(s, curDir, staticEnv);
return e;
}
void NixRepl::evalString(string s, Value & v)
{
Expr * e = parseString(s);
e->eval(state, *env, v);
state.forceValue(v);
}
std::ostream & NixRepl::printValue(std::ostream & str, Value & v, unsigned int maxDepth)
{
ValuesSeen seen;
return printValue(str, v, maxDepth, seen);
}
std::ostream & printStringValue(std::ostream & str, const char * string) {
str << "\"";
for (const char * i = string; *i; i++)
if (*i == '\"' || *i == '\\') str << "\\" << *i;
else if (*i == '\n') str << "\\n";
else if (*i == '\r') str << "\\r";
else if (*i == '\t') str << "\\t";
else str << *i;
str << "\"";
return str;
}
// FIXME: lot of cut&paste from Nix's eval.cc.
std::ostream & NixRepl::printValue(std::ostream & str, Value & v, unsigned int maxDepth, ValuesSeen & seen)
{
str.flush();
checkInterrupt();
state.forceValue(v);
switch (v.type) {
case tInt:
2016-06-25 11:25:31 +00:00
str << ESC_CYA << v.integer << ESC_END;
break;
case tBool:
str << ESC_CYA << (v.boolean ? "true" : "false") << ESC_END;
break;
case tString:
2016-06-25 11:25:31 +00:00
str << ESC_YEL;
printStringValue(str, v.string.s);
2016-06-25 11:25:31 +00:00
str << ESC_END;
break;
case tPath:
2016-06-25 11:25:31 +00:00
str << ESC_GRE << v.path << ESC_END; // !!! escaping?
break;
case tNull:
2016-06-25 11:25:31 +00:00
str << ESC_CYA "null" ESC_END;
break;
case tAttrs: {
seen.insert(&v);
bool isDrv = state.isDerivation(v);
2014-01-28 09:40:02 +00:00
if (isDrv) {
str << "«derivation ";
Bindings::iterator i = v.attrs->find(state.sDrvPath);
PathSet context;
2014-04-11 10:50:46 +00:00
Path drvPath = i != v.attrs->end() ? state.coerceToPath(*i->pos, *i->value, context) : "???";
2014-01-28 09:40:02 +00:00
str << drvPath << "»";
}
else if (maxDepth > 0) {
str << "{ ";
typedef std::map<string, Value *> Sorted;
Sorted sorted;
for (auto & i : *v.attrs)
sorted[i.name] = i.value;
/* If this is a derivation, then don't show the
self-references ("all", "out", etc.). */
StringSet hidden;
if (isDrv) {
hidden.insert("all");
Bindings::iterator i = v.attrs->find(state.sOutputs);
if (i == v.attrs->end())
hidden.insert("out");
else {
state.forceList(*i->value);
for (unsigned int j = 0; j < i->value->listSize(); ++j)
hidden.insert(state.forceStringNoCtx(*i->value->listElems()[j]));
}
}
for (auto & i : sorted) {
if (isVarName(i.first))
str << i.first;
else
printStringValue(str, i.first.c_str());
str << " = ";
if (hidden.find(i.first) != hidden.end())
str << "«...»";
else if (seen.find(i.second) != seen.end())
str << "«repeated»";
else
try {
printValue(str, *i.second, maxDepth - 1, seen);
} catch (AssertionError & e) {
2016-06-25 11:25:31 +00:00
str << ESC_RED "«error: " << e.msg() << "»" ESC_END;
}
str << "; ";
}
2014-01-28 09:40:02 +00:00
str << "}";
} else
2014-01-28 09:40:02 +00:00
str << "{ ... }";
break;
}
case tList1:
case tList2:
case tListN:
seen.insert(&v);
str << "[ ";
if (maxDepth > 0)
for (unsigned int n = 0; n < v.listSize(); ++n) {
if (seen.find(v.listElems()[n]) != seen.end())
str << "«repeated»";
else
try {
printValue(str, *v.listElems()[n], maxDepth - 1, seen);
} catch (AssertionError & e) {
2016-06-25 11:25:31 +00:00
str << ESC_RED "«error: " << e.msg() << "»" ESC_END;
}
str << " ";
}
else
str << "... ";
str << "]";
break;
case tLambda: {
std::ostringstream s;
s << v.lambda.fun->pos;
str << ESC_BLU "«lambda @ " << filterANSIEscapes(s.str()) << "»" ESC_END;
break;
}
case tPrimOp:
2016-06-25 11:25:31 +00:00
str << ESC_MAG "«primop»" ESC_END;
break;
case tPrimOpApp:
2016-06-25 11:25:31 +00:00
str << ESC_BLU "«primop-app»" ESC_END;
break;
default:
str << ESC_RED "«unknown»" ESC_END;
break;
}
return str;
}
2017-04-25 16:48:40 +00:00
struct CmdRepl : StoreCommand
{
2017-04-25 16:48:40 +00:00
Strings files;
CmdRepl()
{
expectArgs("files", &files);
}
std::string name() override { return "repl"; }
std::string description() override
{
return "start an interactive environment for evaluating Nix expressions";
}
void run(ref<Store> store) override
{
// FIXME: pass searchPath
NixRepl repl({}, openStore());
repl.mainLoop(files);
2017-04-25 16:48:40 +00:00
}
};
static RegisterCommand r1(make_ref<CmdRepl>());
}