Error Class

2010-09-05T17:58:46Z

Cleanup

← Older revision		Revision as of 17:58, 5 September 2010
(2 intermediate revisions not shown)
Line 1:		Line 1:
-	A list of error reporting macros. ~~Some are always compiled in, but most~~ are only compiled in with DEBUG~~.<br/>~~	+	A list of error reporting macros. They are only compiled in with DEBUG.<br/>
-	* err_msg: Extra non-fatal debugging information enabled by user's choice.<br/>	+
	* err_now: Fatal errors that are reported by default and the program terminates.<br/>		* err_now: Fatal errors that are reported by default and the program terminates.<br/>
		+	* err_when: Reports a stopping error if condition is met.<br/>
		+	* err_here: Same as err_now, but uses err.internal. Should be migrated to err_now.<br/>
		+	* err_if/err_else: Used to compile out condition blocks with err_now/err_here. This is ugly and should be migrated to err_when. Note that this will require changing err_when to give a message along with the error.<br/>
		+	<br/>
		+	Error class functions:<br/>
		+	Error::run(): Stop error function with printf formatting. Use directly if this is an error that should be reported even when not debugging. When only debugging, use the err_* functions.<br/>
		+	Error::internal(): Same Error::run() but prints a non-formatted string. Redundant? Should be migrated to Error::run().<br/>
		+	Error::msg(): Non-stopping error. Should this be removed? Possibly can still be used if the user needs to be notified graphically.<br/>
		+	Error::mem(): Memory error. This will remain for the Mem class.<br/>
		+	<br/>
		+	When compiled with DEBUG, there are also macros that help with logging:<br/>
		+	MSG(): Prints when the user explicitly turns on a channel<br/>
		+	ERR(): For serious messages that are always printed. WARNING--this does not stop the program. You still need to handle the error as appropriate.<br/>
		+	<br/>
		+	The SKDEBUG environment variable is a comma separated list of different logging channels to turn on.<br/>

Seven Kingdoms - Recent changes [en]

Error Class