Make source location info in the XML output optional.

* src/libexpr/expr-to-xml.cc (nix::showAttrs): Add `location'
  parameter.  Provide location XML attributes when it's true.  Update
  callers.
  (nix::printTermAsXML): Likewise.

* src/libexpr/expr-to-xml.hh (nix::printTermAsXML): Update prototype;
  have `location' default to `false'.

* src/nix-instantiate/nix-instantiate.cc (printResult, processExpr): Add
  `location' parameter; update callers.
  (run): Add support for `--no-location'.

* src/nix-instantiate/help.txt: Update accordingly.

* tests/lang.sh: Invoke `nix-instantiate' with `--no-location' for the
  XML tests.

* tests/lang/eval-okay-toxml.exp, tests/lang/eval-okay-to-xml.nix: New
  files.
This commit is contained in:
Ludovic Courtès 2010-03-31 12:38:31 +00:00
parent 471419d1fa
commit 09381cccff
7 changed files with 29 additions and 19 deletions

View File

@ -24,11 +24,11 @@ typedef set<Expr> ExprSet;
static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context, static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context,
ExprSet & drvsSeen); ExprSet & drvsSeen, bool location);
static void showAttrs(const ATermMap & attrs, XMLWriter & doc, static void showAttrs(const ATermMap & attrs, XMLWriter & doc,
PathSet & context, ExprSet & drvsSeen) PathSet & context, ExprSet & drvsSeen, bool location)
{ {
StringSet names; StringSet names;
for (ATermMap::const_iterator i = attrs.begin(); i != attrs.end(); ++i) for (ATermMap::const_iterator i = attrs.begin(); i != attrs.end(); ++i)
@ -43,7 +43,7 @@ static void showAttrs(const ATermMap & attrs, XMLWriter & doc,
if(matchAttrRHS(attrRHS, attr, pos)) { if(matchAttrRHS(attrRHS, attr, pos)) {
ATerm path; ATerm path;
int line, column; int line, column;
if (matchPos(pos, path, line, column)) { if (location && matchPos(pos, path, line, column)) {
xmlAttrs["path"] = aterm2String(path); xmlAttrs["path"] = aterm2String(path);
xmlAttrs["line"] = (format("%1%") % line).str(); xmlAttrs["line"] = (format("%1%") % line).str();
xmlAttrs["column"] = (format("%1%") % column).str(); xmlAttrs["column"] = (format("%1%") % column).str();
@ -52,7 +52,7 @@ static void showAttrs(const ATermMap & attrs, XMLWriter & doc,
abort(); // Should not happen. abort(); // Should not happen.
XMLOpenElement _(doc, "attr", xmlAttrs); XMLOpenElement _(doc, "attr", xmlAttrs);
printTermAsXML(attr, doc, context, drvsSeen); printTermAsXML(attr, doc, context, drvsSeen, location);
} }
} }
@ -83,7 +83,7 @@ static void printPatternAsXML(Pattern pat, XMLWriter & doc)
static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context, static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context,
ExprSet & drvsSeen) ExprSet & drvsSeen, bool location)
{ {
XMLAttrs attrs; XMLAttrs attrs;
string s; string s;
@ -137,28 +137,28 @@ static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context,
if (drvsSeen.find(e) == drvsSeen.end()) { if (drvsSeen.find(e) == drvsSeen.end()) {
drvsSeen.insert(e); drvsSeen.insert(e);
showAttrs(attrs, doc, context, drvsSeen); showAttrs(attrs, doc, context, drvsSeen, location);
} else } else
doc.writeEmptyElement("repeated"); doc.writeEmptyElement("repeated");
} }
else { else {
XMLOpenElement _(doc, "attrs"); XMLOpenElement _(doc, "attrs");
showAttrs(attrs, doc, context, drvsSeen); showAttrs(attrs, doc, context, drvsSeen, location);
} }
} }
else if (matchList(e, es)) { else if (matchList(e, es)) {
XMLOpenElement _(doc, "list"); XMLOpenElement _(doc, "list");
for (ATermIterator i(es); i; ++i) for (ATermIterator i(es); i; ++i)
printTermAsXML(*i, doc, context, drvsSeen); printTermAsXML(*i, doc, context, drvsSeen, location);
} }
else if (matchFunction(e, pat, body, pos)) { else if (matchFunction(e, pat, body, pos)) {
ATerm path; ATerm path;
int line, column; int line, column;
XMLAttrs xmlAttrs; XMLAttrs xmlAttrs;
if (matchPos(pos, path, line, column)) { if (location && matchPos(pos, path, line, column)) {
xmlAttrs["path"] = aterm2String(path); xmlAttrs["path"] = aterm2String(path);
xmlAttrs["line"] = (format("%1%") % line).str(); xmlAttrs["line"] = (format("%1%") % line).str();
xmlAttrs["column"] = (format("%1%") % column).str(); xmlAttrs["column"] = (format("%1%") % column).str();
@ -172,12 +172,12 @@ static void printTermAsXML(Expr e, XMLWriter & doc, PathSet & context,
} }
void printTermAsXML(Expr e, std::ostream & out, PathSet & context) void printTermAsXML(Expr e, std::ostream & out, PathSet & context, bool location)
{ {
XMLWriter doc(true, out); XMLWriter doc(true, out);
XMLOpenElement root(doc, "expr"); XMLOpenElement root(doc, "expr");
ExprSet drvsSeen; ExprSet drvsSeen;
printTermAsXML(e, doc, context, drvsSeen); printTermAsXML(e, doc, context, drvsSeen, location);
} }

View File

@ -9,7 +9,7 @@
namespace nix { namespace nix {
void printTermAsXML(Expr e, std::ostream & out, PathSet & context); void printTermAsXML(Expr e, std::ostream & out, PathSet & context, bool location = false);
} }

View File

@ -22,6 +22,8 @@ Options:
For --eval-only / --parse-only: For --eval-only / --parse-only:
--xml: print an XML representation of the abstract syntax tree --xml: print an XML representation of the abstract syntax tree
--no-location: don't provide source location information in the
output XML tree
For --eval-only: For --eval-only:

View File

@ -38,13 +38,13 @@ static bool indirectRoot = false;
static void printResult(EvalState & state, Expr e, static void printResult(EvalState & state, Expr e,
bool evalOnly, bool xmlOutput, const ATermMap & autoArgs) bool evalOnly, bool xmlOutput, bool location, const ATermMap & autoArgs)
{ {
PathSet context; PathSet context;
if (evalOnly) if (evalOnly)
if (xmlOutput) if (xmlOutput)
printTermAsXML(e, std::cout, context); printTermAsXML(e, std::cout, context, location);
else else
std::cout << format("%1%\n") % canonicaliseExpr(e); std::cout << format("%1%\n") % canonicaliseExpr(e);
@ -67,7 +67,7 @@ static void printResult(EvalState & state, Expr e,
void processExpr(EvalState & state, const Strings & attrPaths, void processExpr(EvalState & state, const Strings & attrPaths,
bool parseOnly, bool strict, const ATermMap & autoArgs, bool parseOnly, bool strict, const ATermMap & autoArgs,
bool evalOnly, bool xmlOutput, Expr e) bool evalOnly, bool xmlOutput, bool location, Expr e)
{ {
for (Strings::const_iterator i = attrPaths.begin(); i != attrPaths.end(); ++i) { for (Strings::const_iterator i = attrPaths.begin(); i != attrPaths.end(); ++i) {
Expr e2 = findAlongAttrPath(state, *i, autoArgs, e); Expr e2 = findAlongAttrPath(state, *i, autoArgs, e);
@ -76,7 +76,7 @@ void processExpr(EvalState & state, const Strings & attrPaths,
e2 = strictEvalExpr(state, e2); e2 = strictEvalExpr(state, e2);
else else
e2 = evalExpr(state, e2); e2 = evalExpr(state, e2);
printResult(state, e2, evalOnly, xmlOutput, autoArgs); printResult(state, e2, evalOnly, xmlOutput, location, autoArgs);
} }
} }
@ -89,6 +89,7 @@ void run(Strings args)
bool evalOnly = false; bool evalOnly = false;
bool parseOnly = false; bool parseOnly = false;
bool xmlOutput = false; bool xmlOutput = false;
bool xmlOutputSourceLocation = true;
bool strict = false; bool strict = false;
Strings attrPaths; Strings attrPaths;
ATermMap autoArgs(128); ATermMap autoArgs(128);
@ -124,6 +125,8 @@ void run(Strings args)
indirectRoot = true; indirectRoot = true;
else if (arg == "--xml") else if (arg == "--xml")
xmlOutput = true; xmlOutput = true;
else if (arg == "--no-location")
xmlOutputSourceLocation = false;
else if (arg == "--strict") else if (arg == "--strict")
strict = true; strict = true;
else if (arg[0] == '-') else if (arg[0] == '-')
@ -139,7 +142,7 @@ void run(Strings args)
if (readStdin) { if (readStdin) {
Expr e = parseStdin(state); Expr e = parseStdin(state);
processExpr(state, attrPaths, parseOnly, strict, autoArgs, processExpr(state, attrPaths, parseOnly, strict, autoArgs,
evalOnly, xmlOutput, e); evalOnly, xmlOutput, xmlOutputSourceLocation, e);
} }
for (Strings::iterator i = files.begin(); for (Strings::iterator i = files.begin();
@ -148,7 +151,7 @@ void run(Strings args)
Path path = absPath(*i); Path path = absPath(*i);
Expr e = parseExprFromFile(state, path); Expr e = parseExprFromFile(state, path);
processExpr(state, attrPaths, parseOnly, strict, autoArgs, processExpr(state, attrPaths, parseOnly, strict, autoArgs,
evalOnly, xmlOutput, e); evalOnly, xmlOutput, xmlOutputSourceLocation, e);
} }
printEvalStats(state); printEvalStats(state);

View File

@ -54,7 +54,8 @@ for i in lang/eval-okay-*.nix; do
fi fi
if test -e lang/$i.exp.xml; then if test -e lang/$i.exp.xml; then
if ! $nixinstantiate --eval-only --xml --strict lang/$i.nix > lang/$i.out.xml; then if ! $nixinstantiate --eval-only --xml --no-location --strict \
lang/$i.nix > lang/$i.out.xml; then
echo "FAIL: $i should evaluate" echo "FAIL: $i should evaluate"
fail=1 fail=1
elif ! cmp -s lang/$i.out.xml lang/$i.exp.xml; then elif ! cmp -s lang/$i.out.xml lang/$i.exp.xml; then

View File

@ -0,0 +1 @@
Str("<?xml version='1.0' encoding='utf-8'?>\n<expr>\n <attrs>\n <attr name=\"a\">\n <string value=\"s\" />\n </attr>\n </attrs>\n</expr>\n",[])

View File

@ -0,0 +1,3 @@
# Make sure the expected XML output is produced; in particular, make sure it
# doesn't contain source location information.
builtins.toXML { a = "s"; }