libexpr: Support structured error classes
While preparing PRs like #9753, I've had to change error messages in
dozens of code paths. It would be nice if instead of
EvalError("expected 'boolean' but found '%1%'", showType(v))
we could write
TypeError(v, "boolean")
or similar. Then, changing the error message could be a mechanical
refactor with the compiler pointing out places the constructor needs to
be changed, rather than the error-prone process of grepping through the
codebase. Structured errors would also help prevent the "same" error
from having multiple slightly different messages, and could be a first
step towards error codes / an error index.
This PR reworks the exception infrastructure in `libexpr` to
support exception types with different constructor signatures than
`BaseError`. Actually refactoring the exceptions to use structured data
will come in a future PR (this one is big enough already, as it has to
touch every exception in `libexpr`).
The core design is in `eval-error.hh`. Generally, errors like this:
state.error("'%s' is not a string", getAttrPathStr())
.debugThrow<TypeError>()
are transformed like this:
state.error<TypeError>("'%s' is not a string", getAttrPathStr())
.debugThrow()
The type annotation has moved from `ErrorBuilder::debugThrow` to
`EvalState::error`.
2024-01-23 03:08:29 +02:00
|
|
|
#include "eval-error.hh"
|
|
|
|
#include "eval.hh"
|
|
|
|
#include "value.hh"
|
|
|
|
|
|
|
|
namespace nix {
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::withExitStatus(unsigned int exitStatus)
|
|
|
|
{
|
|
|
|
error.withExitStatus(exitStatus);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::atPos(PosIdx pos)
|
|
|
|
{
|
|
|
|
error.err.pos = error.state.positions[pos];
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::atPos(Value & value, PosIdx fallback)
|
|
|
|
{
|
|
|
|
return atPos(value.determinePos(fallback));
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::withTrace(PosIdx pos, const std::string_view text)
|
|
|
|
{
|
|
|
|
error.err.traces.push_front(
|
|
|
|
Trace{.pos = error.state.positions[pos], .hint = hintfmt(std::string(text)), .frame = false});
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::withFrameTrace(PosIdx pos, const std::string_view text)
|
|
|
|
{
|
|
|
|
error.err.traces.push_front(
|
|
|
|
Trace{.pos = error.state.positions[pos], .hint = hintformat(std::string(text)), .frame = true});
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::withSuggestions(Suggestions & s)
|
|
|
|
{
|
|
|
|
error.err.suggestions = s;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::withFrame(const Env & env, const Expr & expr)
|
|
|
|
{
|
|
|
|
// NOTE: This is abusing side-effects.
|
|
|
|
// TODO: check compatibility with nested debugger calls.
|
|
|
|
// TODO: What side-effects??
|
|
|
|
error.state.debugTraces.push_front(DebugTrace{
|
|
|
|
.pos = error.state.positions[expr.getPos()],
|
|
|
|
.expr = expr,
|
|
|
|
.env = env,
|
|
|
|
.hint = hintformat("Fake frame for debugging purposes"),
|
|
|
|
.isError = true});
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
EvalErrorBuilder<T> & EvalErrorBuilder<T>::addTrace(PosIdx pos, hintformat hint, bool frame)
|
|
|
|
{
|
|
|
|
error.addTrace(error.state.positions[pos], hint, frame);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
template<typename... Args>
|
|
|
|
EvalErrorBuilder<T> &
|
|
|
|
EvalErrorBuilder<T>::addTrace(PosIdx pos, std::string_view formatString, const Args &... formatArgs)
|
|
|
|
{
|
|
|
|
|
|
|
|
addTrace(error.state.positions[pos], hintfmt(std::string(formatString), formatArgs...));
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
void EvalErrorBuilder<T>::debugThrow()
|
|
|
|
{
|
|
|
|
if (error.state.debugRepl && !error.state.debugTraces.empty()) {
|
|
|
|
const DebugTrace & last = error.state.debugTraces.front();
|
|
|
|
const Env * env = &last.env;
|
|
|
|
const Expr * expr = &last.expr;
|
|
|
|
error.state.runDebugRepl(&error, *env, *expr);
|
|
|
|
}
|
|
|
|
|
|
|
|
// `EvalState` is the only class that can construct an `EvalErrorBuilder`,
|
|
|
|
// and it does so in dynamic storage. This is the final method called on
|
2024-02-07 02:49:28 +02:00
|
|
|
// any such instance and must delete itself before throwing the underlying
|
libexpr: Support structured error classes
While preparing PRs like #9753, I've had to change error messages in
dozens of code paths. It would be nice if instead of
EvalError("expected 'boolean' but found '%1%'", showType(v))
we could write
TypeError(v, "boolean")
or similar. Then, changing the error message could be a mechanical
refactor with the compiler pointing out places the constructor needs to
be changed, rather than the error-prone process of grepping through the
codebase. Structured errors would also help prevent the "same" error
from having multiple slightly different messages, and could be a first
step towards error codes / an error index.
This PR reworks the exception infrastructure in `libexpr` to
support exception types with different constructor signatures than
`BaseError`. Actually refactoring the exceptions to use structured data
will come in a future PR (this one is big enough already, as it has to
touch every exception in `libexpr`).
The core design is in `eval-error.hh`. Generally, errors like this:
state.error("'%s' is not a string", getAttrPathStr())
.debugThrow<TypeError>()
are transformed like this:
state.error<TypeError>("'%s' is not a string", getAttrPathStr())
.debugThrow()
The type annotation has moved from `ErrorBuilder::debugThrow` to
`EvalState::error`.
2024-01-23 03:08:29 +02:00
|
|
|
// error.
|
|
|
|
auto error = std::move(this->error);
|
|
|
|
delete this;
|
|
|
|
|
|
|
|
throw error;
|
|
|
|
}
|
|
|
|
|
|
|
|
template class EvalErrorBuilder<EvalError>;
|
|
|
|
template class EvalErrorBuilder<AssertionError>;
|
|
|
|
template class EvalErrorBuilder<ThrownError>;
|
|
|
|
template class EvalErrorBuilder<Abort>;
|
|
|
|
template class EvalErrorBuilder<TypeError>;
|
|
|
|
template class EvalErrorBuilder<UndefinedVarError>;
|
|
|
|
template class EvalErrorBuilder<MissingArgumentError>;
|
|
|
|
template class EvalErrorBuilder<InfiniteRecursionError>;
|
|
|
|
template class EvalErrorBuilder<CachedEvalError>;
|
|
|
|
template class EvalErrorBuilder<InvalidPathError>;
|
|
|
|
|
|
|
|
}
|