G3D::Log Class Reference

#include <Log.h>

Public Member Functions
	Log (const std::string &filename="log.txt", int stripFromStackBottom=0)
virtual	~Log ()
FILE *	getFile () const
void	section (const std::string &s)
void __cdecl	printf (const char *fmt,...) G3D_CHECK_PRINTF_METHOD_ARGS
void __cdecl	vprintf (const char *, va_list argPtr) G3D_CHECK_VPRINTF_METHOD_ARGS
void __cdecl	lazyvprintf (const char *, va_list argPtr) G3D_CHECK_VPRINTF_METHOD_ARGS
void	print (const std::string &s)
void	println (const std::string &s)

Static Public Member Functions
static Log *	common ()
static std::string	getCommonLogFilename ()

Public Attributes
int	stripFromStackBottom

Private Attributes
FILE *	logFile
std::string	filename

Static Private Attributes
static Log *	commonLog = NULL

Detailed Description

System log for debugging purposes. The first log opened is the "common log" and can be accessed with the static method common(). If you access common() and a common log does not yet exist, one is created for you.

Constructor & Destructor Documentation

Log::Log	(	const std::string &	filename = "log.txt",
		int	stripFromStackBottom = 0
	)

Parameters

stripFromStackBottom

Number of call stacks to strip from the bottom of the stack when printing a trace. Useful for hiding routines like "main" and "WinMain". If the specified file cannot be opened for some reason, tries to open "c:/tmp/log.txt" or "c:/temp/log.txt" instead.

 : 
 stripFromStackBottom(stripFromStackBottom) {

 this->filename = filename;

 logFile = FileSystem::fopen(filename.c_str(), "w");

 if (logFile == NULL) {
 std::string drive, base, ext;
 Array<std::string> path;
 parseFilename(filename, drive, path, base, ext);
 std::string logName = base + ((ext != "") ? ("." + ext) : ""); 

 // Write time is greater than 1ms. This may be a network drive.... try another file.
 #ifdef G3D_WINDOWS
 logName = std::string(std::getenv("TEMP")) + logName;
 #else
 logName = std::string("/tmp/") + logName;
 #endif

 logFile = FileSystem::fopen(logName.c_str(), "w");
 }

 // Use a large buffer (although we flush in logPrintf)
 setvbuf(logFile, NULL, _IOFBF, 2048);

 fprintf(logFile, "Application Log\n");
 time_t t;
 time(&t);
 fprintf(logFile, "Start: %s\n", ctime(&t));
 fflush(logFile);

 if (commonLog == NULL) {
 commonLog = this;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Log::~Log ( )

virtual

 {
 section("Shutdown");
 println("Closing log file");
 
 // Make sure we don't leave a dangling pointer
 if (Log::commonLog == this) {
 Log::commonLog = NULL;
 }

 if (logFile) {
 FileSystem::fclose(logFile);
 }
}

Here is the call graph for this function:

Member Function Documentation

Log * Log::common ( )

static

 {
 if (commonLog == NULL) {
 commonLog = new Log();
 }
 return commonLog;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string Log::getCommonLogFilename ( )

static

 {
 return common()->filename;
}

Here is the call graph for this function:

FILE * Log::getFile

(

)

const

Returns the handle to the file log.

 {
 return logFile;
}

void __cdecl Log::lazyvprintf	(	const char *	fmt,
		va_list	argPtr
	)

Does not flush

 {
 vfprintf(logFile, fmt, argPtr);
}

Here is the caller graph for this function:

void Log::print

(

const std::string &

s

)

 {
 fprintf(logFile, "%s", s.c_str());
 fflush(logFile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void __cdecl Log::printf	(	const char *	fmt,
			...
	)

Given arguments like printf, writes characters to the debug text overlay.

 {
 va_list arg_list;
 va_start(arg_list, fmt);
 print(vformat(fmt, arg_list));
 va_end(arg_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Log::println

(

const std::string &

s

)

 {
 fprintf(logFile, "%s\n", s.c_str());
 fflush(logFile);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Log::section

(

const std::string &

s

)

Marks the beginning of a logfile section.

 {
 fprintf(logFile, "_____________________________________________________\n");
 fprintf(logFile, "\n ### %s ###\n\n", s.c_str());
}

Here is the call graph for this function:

Here is the caller graph for this function:

void __cdecl Log::vprintf	(	const char *	fmt,
		va_list	argPtr
	)

 {
 vfprintf(logFile, fmt, argPtr);
 fflush(logFile);
}

Here is the caller graph for this function:

Member Data Documentation

Log * Log::commonLog = NULL

staticprivate

std::string G3D::Log::filename

private

FILE* G3D::Log::logFile

private

Log messages go here.

int G3D::Log::stripFromStackBottom

---

The documentation for this class was generated from the following files:

• dep/g3dlite/include/G3D/Log.h
• dep/g3dlite/source/Log.cpp