lix/src/libutil/error.cc

224 lines
6 KiB
C++
Raw Normal View History

#include "error.hh"
#include <iostream>
2020-03-25 16:52:03 +00:00
#include <optional>
#include "serialise.hh"
2020-05-14 18:28:18 +00:00
#include <sstream>
2020-04-29 03:06:08 +00:00
namespace nix {
2020-04-24 20:57:51 +00:00
const std::string nativeSystem = SYSTEM;
2020-06-04 17:53:19 +00:00
// addPrefix is used for show-trace. Strings added with addPrefix
// will print ahead of the error itself.
2020-04-24 20:57:51 +00:00
BaseError & BaseError::addPrefix(const FormatOrString & fs)
{
prefix_ = fs.s + prefix_;
return *this;
}
2020-06-04 17:53:19 +00:00
// c++ std::exception descendants must have a 'const char* what()' function.
// This stringifies the error and caches it for use by what(), or similarly by msg().
2020-05-14 18:28:18 +00:00
const string& BaseError::calcWhat() const
{
if (what_.has_value())
return *what_;
else {
err.name = sname();
std::ostringstream oss;
oss << err;
what_ = oss.str();
return *what_;
}
}
std::optional<string> ErrorInfo::programName = std::nullopt;
2020-04-15 16:09:43 +00:00
std::ostream& operator<<(std::ostream &os, const hintformat &hf)
{
return os << hf.str();
}
2020-04-08 15:07:58 +00:00
string showErrPos(const ErrPos &errPos)
{
if (errPos.line > 0) {
if (errPos.column > 0) {
return fmt("(%1%:%2%)", errPos.line, errPos.column);
} else {
return fmt("(%1%)", errPos.line);
}
}
else {
return "";
}
}
2020-06-04 17:53:19 +00:00
// if nixCode contains lines of code, print them to the ostream, indicating the error column.
void printCodeLines(std::ostream &out, const string &prefix, const NixCode &nixCode)
{
2020-04-08 15:48:21 +00:00
// previous line of code.
if (nixCode.prevLineOfCode.has_value()) {
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
prefix,
(nixCode.errPos.line - 1),
*nixCode.prevLineOfCode);
2020-04-08 15:48:21 +00:00
}
2020-04-02 22:02:40 +00:00
if (nixCode.errLineOfCode.has_value()) {
// line of code containing the error.
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
prefix,
(nixCode.errPos.line),
*nixCode.errLineOfCode);
// error arrows for the column range.
if (nixCode.errPos.column > 0) {
int start = nixCode.errPos.column;
std::string spaces;
for (int i = 0; i < start; ++i) {
spaces.append(" ");
}
std::string arrows("^");
2020-04-01 22:20:20 +00:00
out << std::endl
<< fmt("%1% |%2%" ANSI_RED "%3%" ANSI_NORMAL,
prefix,
spaces,
arrows);
}
}
2020-04-08 15:48:21 +00:00
// next line of code.
if (nixCode.nextLineOfCode.has_value()) {
out << std::endl
<< fmt("%1% %|2$5d|| %3%",
prefix,
(nixCode.errPos.line + 1),
*nixCode.nextLineOfCode);
2020-04-08 15:48:21 +00:00
}
}
std::ostream& operator<<(std::ostream &out, const ErrorInfo &einfo)
{
2020-04-01 22:20:20 +00:00
int errwidth = 80;
string prefix = "";
2020-04-01 22:20:20 +00:00
string levelString;
2020-04-02 22:02:40 +00:00
switch (einfo.level) {
case Verbosity::lvlError: {
levelString = ANSI_RED;
levelString += "error:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlWarn: {
levelString = ANSI_YELLOW;
levelString += "warning:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlInfo: {
levelString = ANSI_GREEN;
levelString += "info:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlTalkative: {
levelString = ANSI_GREEN;
levelString += "talk:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlChatty: {
levelString = ANSI_GREEN;
levelString += "chat:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlVomit: {
levelString = ANSI_GREEN;
levelString += "vomit:";
levelString += ANSI_NORMAL;
break;
}
case Verbosity::lvlDebug: {
levelString = ANSI_YELLOW;
levelString += "debug:";
levelString += ANSI_NORMAL;
break;
}
default: {
levelString = fmt("invalid error level: %1%", einfo.level);
break;
}
}
2020-04-01 22:20:20 +00:00
int ndl = prefix.length() + levelString.length() + 3 + einfo.name.length() + einfo.programName.value_or("").length();
2020-04-02 22:02:40 +00:00
int dashwidth = ndl > (errwidth - 3) ? 3 : errwidth - ndl;
2020-04-01 22:20:20 +00:00
string dashes;
for (int i = 0; i < dashwidth; ++i)
dashes.append("-");
// divider.
if (einfo.name != "")
2020-04-29 03:06:08 +00:00
out << fmt("%1%%2%" ANSI_BLUE " --- %3% %4% %5%" ANSI_NORMAL,
2020-04-29 16:14:32 +00:00
prefix,
levelString,
einfo.name,
dashes,
einfo.programName.value_or(""));
else
2020-04-29 03:06:08 +00:00
out << fmt("%1%%2%" ANSI_BLUE " -----%3% %4%" ANSI_NORMAL,
2020-04-29 16:14:32 +00:00
prefix,
levelString,
dashes,
einfo.programName.value_or(""));
bool nl = false; // intersperse newline between sections.
2020-04-02 22:02:40 +00:00
if (einfo.nixCode.has_value()) {
if (einfo.nixCode->errPos.file != "") {
// filename, line, column.
out << std::endl << fmt("%1%in file: " ANSI_BLUE "%2% %3%" ANSI_NORMAL,
2020-04-29 16:14:32 +00:00
prefix,
einfo.nixCode->errPos.file,
showErrPos(einfo.nixCode->errPos));
2020-04-02 22:02:40 +00:00
} else {
out << std::endl << fmt("%1%from command line argument", prefix);
2020-04-01 22:20:20 +00:00
}
nl = true;
2020-04-01 22:20:20 +00:00
}
2020-04-01 22:20:20 +00:00
// description
if (einfo.description != "") {
if (nl)
out << std::endl << prefix;
out << std::endl << prefix << einfo.description;
nl = true;
}
2020-04-01 22:20:20 +00:00
// lines of code.
2020-05-12 20:41:30 +00:00
if (einfo.nixCode.has_value() && einfo.nixCode->errLineOfCode.has_value()) {
if (nl)
out << std::endl << prefix;
printCodeLines(out, prefix, *einfo.nixCode);
nl = true;
2020-04-01 22:20:20 +00:00
}
// hint
2020-04-02 22:02:40 +00:00
if (einfo.hint.has_value()) {
if (nl)
out << std::endl << prefix;
out << std::endl << prefix << *einfo.hint;
nl = true;
2020-04-01 22:20:20 +00:00
}
return out;
}
}