lix/src/libutil/error.hh

293 lines
6.4 KiB
C++
Raw Normal View History

#ifndef error_hh
#define error_hh
2020-03-27 16:55:09 +00:00
#include "ansicolor.hh"
#include <string>
#include <optional>
2020-03-24 17:21:35 +00:00
#include <iostream>
2020-03-27 16:03:02 +00:00
#include <iomanip>
2020-03-27 16:55:09 +00:00
#include <boost/format.hpp>
namespace nix {
2020-04-01 22:20:20 +00:00
typedef enum {
2020-04-02 20:25:43 +00:00
elWarning,
elError
} ErrLevel;
class ColumnRange {
2020-04-01 22:20:20 +00:00
public:
unsigned int start;
unsigned int len;
};
2020-03-24 17:21:35 +00:00
class ErrorInfo;
class ErrLine {
2020-04-01 22:20:20 +00:00
public:
int lineNumber;
std::optional<ColumnRange> columnRange;
std::optional<string> prevLineOfCode;
2020-04-01 22:20:20 +00:00
string errLineOfCode;
std::optional<string> nextLineOfCode;
2020-03-24 17:21:35 +00:00
};
class NixCode {
2020-04-01 22:20:20 +00:00
public:
std::optional<string> nixFile;
std::optional<ErrLine> errLine;
2020-04-01 22:20:20 +00:00
ErrLine& ensureErrLine()
{
if (!this->errLine.has_value())
this->errLine = std::optional(ErrLine());
2020-04-01 22:20:20 +00:00
return *this->errLine;
}
2020-03-24 17:21:35 +00:00
};
// -------------------------------------------------
// ErrorInfo.
2020-04-01 22:20:20 +00:00
// Forward friend class declarations. "builder classes"
2020-03-24 17:21:35 +00:00
template <class T>
class AddName;
template <class T>
class AddDescription;
template <class T>
class AddNixCode;
template <class T>
class AddNixFile;
template <class T>
class AddErrLine;
template <class T>
class AddLineNumber;
template <class T>
class AddColumnRange;
template <class T>
class AddLOC;
// The error info class itself.
class ErrorInfo {
2020-04-01 22:20:20 +00:00
public:
ErrLevel level;
string name;
string description;
std::optional<NixCode> nixCode;
std::optional<string> hint;
2020-04-01 22:20:20 +00:00
ErrorInfo& GetEI() { return *this; }
static std::optional<string> programName;
2020-04-01 22:20:20 +00:00
// give these access to the private constructor,
// when they are direct descendants (children but not grandchildren).
friend AddName<ErrorInfo>;
friend AddDescription<ErrorInfo>;
friend AddNixCode<ErrorInfo>;
friend AddNixFile<ErrorInfo>;
friend AddErrLine<ErrorInfo>;
friend AddLineNumber<ErrorInfo>;
friend AddColumnRange<ErrorInfo>;
friend AddLOC<ErrorInfo>;
NixCode& ensureNixCode()
{
if (!this->nixCode.has_value())
this->nixCode = std::optional(NixCode());
2020-04-01 22:20:20 +00:00
return *this->nixCode;
}
protected:
// constructor is protected, so only the builder classes can create an ErrorInfo.
ErrorInfo(ErrLevel level) { this->level = level; }
2020-03-24 17:21:35 +00:00
};
2020-03-25 16:52:03 +00:00
// Init as error
2020-03-24 17:21:35 +00:00
class EIError : public ErrorInfo
{
2020-04-01 22:20:20 +00:00
protected:
EIError() : ErrorInfo(elError) {}
2020-03-24 17:21:35 +00:00
};
2020-03-25 16:52:03 +00:00
// Init as warning
2020-03-24 17:21:35 +00:00
class EIWarning : public ErrorInfo
{
2020-04-01 22:20:20 +00:00
protected:
EIWarning() : ErrorInfo(elWarning) {}
};
2020-03-25 16:52:03 +00:00
// Builder class definitions.
2020-03-24 15:18:23 +00:00
template <class T>
class AddName : private T
{
2020-04-01 22:20:20 +00:00
public:
T& name(const std::string &name){
GetEI().name = name;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
2020-03-24 15:18:23 +00:00
};
template <class T>
class AddDescription : private T
{
2020-04-01 22:20:20 +00:00
public:
T& description(const std::string &description){
GetEI().description = description;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
2020-03-24 15:18:23 +00:00
};
template <class T>
2020-03-27 16:03:02 +00:00
class AddNixFile : private T
{
2020-04-01 22:20:20 +00:00
public:
T& nixFile(string filename) {
GetEI().ensureNixCode().nixFile = filename;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
};
template <class T>
2020-03-27 16:03:02 +00:00
class AddLineNumber : private T
2020-03-24 17:21:35 +00:00
{
2020-04-01 22:20:20 +00:00
public:
T& lineNumber(int lineNumber) {
GetEI().ensureNixCode().ensureErrLine().lineNumber = lineNumber;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
2020-03-24 17:21:35 +00:00
};
template <class T>
2020-03-27 16:03:02 +00:00
class AddColumnRange : private T
{
2020-04-01 22:20:20 +00:00
public:
T& columnRange(unsigned int start, unsigned int len) {
GetEI().ensureNixCode().ensureErrLine().columnRange = { start, len };
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
};
template <class T>
2020-03-27 16:03:02 +00:00
class AddLOC : private T
{
2020-04-01 22:20:20 +00:00
public:
T& linesOfCode(std::optional<string> prevloc, string loc, std::optional<string> nextloc) {
2020-04-01 22:20:20 +00:00
GetEI().ensureNixCode().ensureErrLine().prevLineOfCode = prevloc;
GetEI().ensureNixCode().ensureErrLine().errLineOfCode = loc;
GetEI().ensureNixCode().ensureErrLine().nextLineOfCode = nextloc;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
};
// ----------------------------------------------------------------
// format for hints. same as boost format, except templated values
// are always in yellow.
2020-03-27 16:03:02 +00:00
template <class T>
class yellowify
{
public:
2020-04-01 22:20:20 +00:00
yellowify(T &s) : value(s) {}
T &value;
2020-03-27 16:03:02 +00:00
};
template <class T>
std::ostream& operator<<(std::ostream &out, const yellowify<T> &y)
{
2020-04-01 22:20:20 +00:00
return out << ANSI_YELLOW << y.value << ANSI_NORMAL;
2020-03-27 16:03:02 +00:00
}
class hintfmt
{
2020-04-01 22:20:20 +00:00
public:
hintfmt(string format) :fmt(format) {
fmt.exceptions(boost::io::all_error_bits ^ boost::io::too_many_args_bit);
}
2020-04-01 22:20:20 +00:00
template<class T>
hintfmt& operator%(const T &value) { fmt % yellowify(value); return *this; }
template <typename U>
friend class AddHint;
private:
format fmt;
2020-03-27 16:03:02 +00:00
};
// the template layer for adding a hint.
2020-03-27 16:03:02 +00:00
template <class T>
class AddHint : private T
{
2020-04-01 22:20:20 +00:00
public:
T& hint(hintfmt &hfmt) {
GetEI().hint = std::optional(hfmt.fmt.str());
2020-04-01 22:20:20 +00:00
return *this;
}
T& nohint() {
GetEI().hint = std::nullopt;
return *this;
}
protected:
ErrorInfo& GetEI() { return T::GetEI(); }
2020-03-27 16:03:02 +00:00
};
// --------------------------------------------------------
// error types
2020-03-27 16:55:09 +00:00
typedef AddName<
AddDescription<
AddHint<
2020-03-31 17:56:37 +00:00
EIError>>> ProgramError;
2020-03-31 18:42:41 +00:00
2020-03-27 16:55:09 +00:00
typedef AddName<
AddDescription<
AddHint<
2020-03-31 17:56:37 +00:00
EIWarning>>> ProgramWarning;
2020-03-24 17:21:35 +00:00
typedef AddName<
AddDescription<
AddNixFile<
AddLineNumber<
AddColumnRange<
2020-03-27 16:03:02 +00:00
AddLOC<
2020-03-27 16:55:09 +00:00
AddHint<
2020-03-31 17:56:37 +00:00
EIError>>>>>>> NixLangError;
2020-03-31 18:42:41 +00:00
typedef AddName<
AddDescription<
AddNixFile<
AddLineNumber<
AddColumnRange<
2020-03-27 16:55:09 +00:00
AddLOC<
AddHint<
2020-03-31 17:56:37 +00:00
EIWarning>>>>>>> NixLangWarning;
2020-03-24 15:18:23 +00:00
2020-03-27 16:03:02 +00:00
// --------------------------------------------------------
// error printing
// just to cout for now.
2020-03-27 16:03:02 +00:00
void printErrorInfo(ErrorInfo &einfo);
}
#endif