new log file

stepmania/src/RageLog.cpp

@@ -5,8 +5,9 @@
 
  Desc: See header.
 
- Copyright (c) 2001-2002 by the person(s) listed below.  All rights reserved.
+ Copyright (c) 2001-2003 by the person(s) listed below.  All rights reserved.
 	Chris Danford
+	Glenn Maynard
 -----------------------------------------------------------------------------
 */
 
@@ -18,48 +19,84 @@
 
 RageLog* LOG;		// global and accessable from anywhere in the program
 
+/* We have a couple log types and a couple logs.
+ *
+ * Traces are for very verbose debug information.  Use them as much as you want.
+ *
+ * Warnings are for things that shouldn't happen, but can be dealt with.  (If
+ * they can't be dealt with, use RageException::Throw, which will also send a
+ * warning.)
+ *
+ * Info is for important bits of information.  These should be used selectively.
+ * Try to keep Info text dense; lots of information is fine, but try to keep
+ * it to a reasonable total length.
+ *
+ * log.txt receives all logs.  This file can get rather large.
+ *
+ * info.txt receives warnings and infos.  This file should be fairly small; small
+ * enough to be mailed without having to be edited or zipped, and small enough
+ * to be very easily read.
+ *
+ */
+
 // constants
 #define LOG_FILE_NAME "log.txt"
+#define INFO_FILE_NAME "info.txt"
+
+
+/* staticlog gets info.txt
+ * crashlog gets log.txt */
+enum {
+	TO_LOG = 0x01,
+	TO_INFO = 0x02,
+};
 
 RageLog::RageLog()
 {
 	// delete old log files
 	remove( LOG_FILE_NAME );
+	remove( INFO_FILE_NAME );
 
 	// Open log file and leave it open.
 	m_fileLog = fopen( LOG_FILE_NAME, "w" );
-
-	SYSTEMTIME st;
-    GetLocalTime( &st );
+	m_fileInfo = fopen( INFO_FILE_NAME, "w" );
 
 #if defined(_MSC_VER)
 	this->Trace( "Last compiled on %s.", __TIMESTAMP__ );
 #endif
 
+	SYSTEMTIME st;
+    GetLocalTime( &st );
 	this->Trace( "Log starting %.4d-%.2d-%.2d %.2d:%.2d:%.2d", 
 					 st.wYear, st.wMonth, st.wDay, st.wHour, st.wMinute, st.wSecond );
 	this->Trace( "\n" );
+
+	ShowConsole();
 }
 
 RageLog::~RageLog()
 {
 	Flush();
 	FreeConsole();
-	if( m_fileLog )
-		fclose( m_fileLog );
+	if(m_fileLog) fclose( m_fileLog );
+	if(m_fileInfo) fclose( m_fileInfo );
 }
 
 void RageLog::ShowConsole()
 {
+#if defined(WIN32)
 	// create a new console window and attach standard handles
 	AllocConsole();
 	freopen("CONOUT$","wb",stdout);
 	freopen("CONOUT$","wb",stderr);
+#endif
 }
 
 void RageLog::HideConsole()
 {
+#if defined(WIN32)
 	FreeConsole();
+#endif
 }
 
 void RageLog::Trace( const char *fmt, ...)
@@ -69,14 +106,7 @@ void RageLog::Trace( const char *fmt, ...)
     CString sBuff = vssprintf( fmt, va );
     va_end(va);
 
-	if( m_fileLog )
-		fprintf( m_fileLog, "%s\n", sBuff.GetString() ); 
-	printf( "%s\n", sBuff.GetString() ); 
-	CrashLog(sBuff);
-
-#ifdef DEBUG
-	this->Flush();	// implicit flush
-#endif
+	Write(0, sBuff);
 }
 
 /* Use this for more important information; it'll always be included
@@ -87,8 +117,8 @@ void RageLog::Info( const char *fmt, ...)
     va_start(va, fmt);
     CString sBuff = vssprintf( fmt, va );
     va_end(va);
-	Trace("%s", sBuff.GetString());
-	StaticLog(sBuff);
+
+	Write(TO_INFO, sBuff);
 }
 
 void RageLog::Warn( const char *fmt, ...)
@@ -98,10 +128,33 @@ void RageLog::Warn( const char *fmt, ...)
     CString sBuff = vssprintf( fmt, va );
     va_end(va);
 
-	Trace(  "/////////////////////////////////////////\n"
-			"WARNING:  %s\n"
-			"/////////////////////////////////////////",
-			sBuff.GetString() ); 
+	Write(TO_INFO, ssprintf(
+		"/////////////////////////////////////////\n"
+		"WARNING:  %s\n"
+		"/////////////////////////////////////////", sBuff.GetString()));
+}
+
+void RageLog::Write( int where, CString str)
+{
+	if( m_fileLog )
+		fprintf(m_fileLog, "%s\n", str.GetString() );
+
+	if( where & TO_INFO )
+	{
+		if( m_fileInfo )
+			fprintf(m_fileInfo, "%s\n", str.GetString() );
+		StaticLog(str);
+	}
+
+	printf("%s\n", str.GetString() );
+	CrashLog(str);
+
+#ifdef DEBUG
+	Flush();
+#else
+	if(where & TO_INFO)
+		Flush();
+#endif
 }
 
 void RageLog::Flush()

stepmania/src/RageLog.h

@@ -28,8 +28,9 @@ public:
 	void ShowConsole();
 	void HideConsole();
 
-protected:
-	FILE* m_fileLog;
+private:
+	FILE *m_fileLog, *m_fileInfo;
+	void Write( int, CString );
 };
 
 extern RageLog*	LOG;	// global and accessable from anywhere in our program