Home - Forums - Documentation - Gallery - Bugs


Step Four: : Setup the logging system


The Crystal Space SDK contents a built-in reporter system. You can sending messages to the following places:

  • stdout : Your message will be sent to the standard output.
  • stderr : Your message will be sent to standard error channel.
  • alert  : Your message will be displayed in a information window.
  • console: Your message will be displayed on the console output.
  • debug  : Your massage will be logged into the debug log file.
  • popup  :

Adding some log-related config options

Let's create an optional log file. First, we add to our cim.cfg the following options:

Cim.Settings.EnableLogging = true; Cim.Settings.DebugFileName = /cim/debug.log Cim.Settings.AppendLogFile = false

When the EnableLogging option is true, the game writes the report messages in the log file. The DebugFileName decides the name of the log file. The AppendLogFile option controls, the app creates a new log file or appends the messages to the old one (if any).

Ok, let's go to load this options in the cimGame::LoadConfig():

bool cimGame::LoadConfig()
	csRef<iConfigManager> confman (CS_QUERY_REGISTRY (GetObjectRegistry(), iConfigManager));
	startmap = confman->GetStr("Cim.Settings.StartLevel","terrain");
	use_console = confman->GetBool("Cim.Settings.EnableConsole",false);
	enable_logging = confman->GetBool("Cim.Settings.EnableLogging",false);
	debug_filename = confman->GetStr("Cim.Settings.DebugFileName","/cim/debug.log");
	append_logfile = confman->GetBool("Cim.Settings.AppendLogFile",true);
	return true;

Listening the reports

Crystal Space provides us the iStandardReporterListener interface to do this. Let's query this:

listener = CS_QUERY_REGISTRY(GetObjectRegistry(),iStandardReporterListener);

Ok, we have a the listener, let's customize it. As we said, Crystal Space ensures you many channel to your reports. Crystal Space uses 5 severity level:

  • CS_REPORTER_SEVERITY_BUG: his is the worst thing that can happen. It means that some code detected a bug in Crystal Space.
  • CS_REPORTER_SEVERITY_ERROR: There was an error of some kind. Usually this is an error while reading data.
  • CS_REPORTER_SEVERITY_WARNING: There was some condition which is non fatal but is suspicious.
  • CS_REPORTER_SEVERITY_NOTIFY: This is for debugging and it will usually generate an entry in some log.

We can define, on what messaging channel listening what severity levels. iStandardReporterLIstener has a SetMessageDestination function:

virtual void SetMessageDestination (int severity,
  	bool do_stdout, bool do_stderr, bool do_console,
	bool do_alert, bool do_debug, bool do_popup = false) = 0;

We want to use the standard output, the console and the debug file. So the code is:


Now we set up the log filename:


Time stamps

Current date and time is not so important in 3D apps, but a coll looking log file contents the starting time at least in a headline. We write the current date and time into string, using the _strdate and _strtime functions (you have to include "time.h" :

char dateStr [9];
	  char timeStr [9];
	  _strdate( dateStr);
	  _strtime( timeStr );

Ok, now we create a head line, using the date and time info:

csString logStr("---------------------------------------");
	  logStr+="Cim started at ";
	  logStr+=" : ";


Calling the csReporterHelper::Report (or the csReport macro) the head line goes to the log file.

That's it. See the code for all changes. Get the sources from here

Tutorial Home

| Article | Discussion | View source | History |