#pragma once #include "ref.hh" #include "types.hh" #include #include #include #include #include #include "fmt.hh" /* Before 4.7, gcc's std::exception uses empty throw() specifiers for * its (virtual) destructor and what() in c++11 mode, in violation of spec */ #ifdef __GNUC__ #if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 7) #define EXCEPTION_NEEDS_THROW_SPEC #endif #endif namespace nix { /* This file defines two main structs/classes used in nix error handling. ErrorInfo provides a standard payload of error information, with conversion to string happening in the logger rather than at the call site. BaseError is the ancestor of nix specific exceptions (and Interrupted), and contains an ErrorInfo. ErrorInfo structs are sent to the logger as part of an exception, or directly with the logError or logWarning macros. See the error-demo.cc program for usage examples. */ typedef enum { lvlError = 0, lvlWarn, lvlInfo, lvlTalkative, lvlChatty, lvlDebug, lvlVomit } Verbosity; typedef enum { foFile, foStdin, foString } FileOrigin; // ErrPos indicates the location of an error in a nix file. struct ErrPos { int line = 0; int column = 0; string file; FileOrigin origin; operator bool() const { return line != 0; } // convert from the Pos struct, found in libexpr. template ErrPos& operator=(const P &pos) { origin = pos.origin; line = pos.line; column = pos.column; file = pos.file; return *this; } template ErrPos(const P &p) { *this = p; } }; struct NixCode { ErrPos errPos; std::optional prevLineOfCode; std::optional errLineOfCode; std::optional nextLineOfCode; }; struct Trace { std::optional pos; hintformat hint; }; struct ErrorInfo { Verbosity level; string name; string description; std::optional hint; std::optional errPos; std::list traces; static std::optional programName; }; std::ostream& operator<<(std::ostream &out, const ErrorInfo &einfo); /* BaseError should generally not be caught, as it has Interrupted as a subclass. Catch Error instead. */ class BaseError : public std::exception { protected: // string prefix_; // used for location traces etc. mutable ErrorInfo err; // mutable std::optional trace_; // const string& calcTrace() const; mutable std::optional what_; const string& calcWhat() const; public: unsigned int status = 1; // exit status template BaseError(unsigned int status, const Args & ... args) : err {.level = lvlError, .hint = hintfmt(args...) } , status(status) { } template BaseError(const std::string & fs, const Args & ... args) : err {.level = lvlError, .hint = hintfmt(fs, args...) } { } BaseError(hintformat hint) : err {.level = lvlError, .hint = hint } { } BaseError(ErrorInfo && e) : err(std::move(e)) { } BaseError(const ErrorInfo & e) : err(e) { } virtual const char* sname() const { return "BaseError"; } #ifdef EXCEPTION_NEEDS_THROW_SPEC ~BaseError() throw () { }; const char * what() const throw () { return calcWhat().c_str(); } #else const char * what() const noexcept override { return calcWhat().c_str(); } #endif const string & msg() const { return calcWhat(); } // const string & trace() const { return calcTrace(); } // BaseError & addPrefix(const FormatOrString & fs); BaseError & addTrace(std::optional e, hintformat hint); const ErrorInfo & info() { calcWhat(); return err; } }; #define MakeError(newClass, superClass) \ class newClass : public superClass \ { \ public: \ using superClass::superClass; \ virtual const char* sname() const override { return #newClass; } \ } MakeError(Error, BaseError); class SysError : public Error { public: int errNo; template SysError(const Args & ... args) : Error("") { errNo = errno; auto hf = hintfmt(args...); err.hint = hintfmt("%1%: %2%", normaltxt(hf.str()), strerror(errNo)); } virtual const char* sname() const override { return "SysError"; } }; }