Class GCodeException

src/GCodes/GCodeException.h:32–78

This class is mostly used to throw exceptions when processing GCode. It is also used to store error messages that need to be retrieved later. Field "message" should always point to a constant string in flash memory, or be null. The error message may have a string, int32_t or uint32_t parameter

// Field "message" should always point to a constant string in flash memory, or be null.
// The error message may have a string, int32_t or uint32_t parameter
class GCodeException
{
public:
	GCodeException() noexcept : line(-1), column(-1), message(nullptr), source(GCodeExceptionSource::other) { }
	explicit GCodeException(const char *_ecv_array msg, int32_t iparam = 0) noexcept: line(-1), column(-1), message(msg), source(GCodeExceptionSource::other) { param.i = iparam; }

	GCodeException(int lin, int col, const char *_ecv_array msg) noexcept : line(lin), column(col), message(msg), source(GCodeExceptionSource::other)  { }

	GCodeException(int lin, int col, const char *_ecv_array msg, const char *_ecv_array sparam) noexcept : line(lin), column(col), message(msg), source(GCodeExceptionSource::other)
	{
		stringParam.copy(sparam);
	}

	GCodeException(int lin, int col, const char *_ecv_array msg, uint32_t uparam) noexcept : line(lin), column(col), message(msg), source(GCodeExceptionSource::other)
	{
		param.u = uparam;
	}

	GCodeException(int lin, int col, const char *_ecv_array msg, int32_t iparam) noexcept : line(lin), column(col), message(msg), source(GCodeExceptionSource::other)
	{
		param.i = iparam;
	}

	GCodeException(const GCodeBuffer *null gb, int col, const char *_ecv_array msg) noexcept;

	GCodeException(const GCodeBuffer *null gb, int col, const char *_ecv_array msg, uint32_t uparam) noexcept;

	GCodeException(const GCodeBuffer *null gb, int col, const char *_ecv_array msg, const char *_ecv_array sparam) noexcept;

	void GetMessage(const StringRef& reply, const GCodeBuffer *null gb) const noexcept;

	void DebugPrint() const noexcept;

	bool IsNull() const noexcept { return message == nullptr; }

private:
	int line;
	int column;
	const char *_ecv_array _ecv_null message;
	GCodeExceptionSource source;
	union
	{
		int32_t i;
		uint32_t u;
	} param;
	String<StringLength50> stringParam;
};

// Functions to create and throw an exception. Using these avoids allocating the GCodeException object on the local stack when it is not going to be used.
[[noreturn]] void __attribute__((noinline)) ThrowGCodeException(const char *_ecv_array errMsg) THROWS(GCodeException);