Steve Checkoway
86 lines
3.2 KiB
C++
86 lines
3.2 KiB
C++
/* RageLog - Manages logging. */
|
|
|
|
#ifndef RAGE_LOG_H
|
|
#define RAGE_LOG_H
|
|
|
|
class RageLog
|
|
{
|
|
public:
|
|
RageLog();
|
|
~RageLog();
|
|
|
|
enum LogType
|
|
{
|
|
LogType_SongFile, // Refers to a sm, dwi, ksf, etc. file.
|
|
LogType_CourseFile, // Refers to a crs file.
|
|
LogType_EditFile, // Refers to an edit file.
|
|
LogType_SoundFile, // Refers to a .ogg, .mp3, .wav, etc. file.
|
|
LogType_GraphicFile, // Refers to a .jpg, .png, etc. file.
|
|
LogType_CacheFile, // Refers to any cache file.
|
|
LogType_Song, // Refers to an actual song (directory).
|
|
LogType_ThemeElement, // Refers to a theme element.
|
|
LogType_ThemeMetric, // Refers to a theme metric.
|
|
LogType_General, // Any other type of user log message. Ignores sPath.
|
|
NUM_LogType
|
|
};
|
|
|
|
void Trace( const char *fmt, ... ) PRINTF(2,3);
|
|
void Warn( const char *fmt, ... ) PRINTF(2,3);
|
|
void Info( const char *fmt, ... ) PRINTF(2,3);
|
|
void UserLog( LogType lt, const RString &sPath, const char *fmt, ... ) PRINTF(4,5);
|
|
void Flush();
|
|
|
|
void MapLog( const RString &key, const char *fmt, ... ) PRINTF(3,4);
|
|
void UnmapLog( const RString &key );
|
|
|
|
static const char *GetAdditionalLog();
|
|
static const char *GetInfo();
|
|
/* Returns NULL if past the last recent log. */
|
|
static const char *GetRecentLog( int n );
|
|
|
|
void SetShowLogOutput( bool show ); // enable or disable logging to stdout
|
|
void SetLogToDisk( bool b ); // enable or disable logging to file
|
|
void SetInfoToDisk( bool b ); // enable or disable logging info.txt to file
|
|
void SetUserLogToDisk( bool b); // enable or disable logging user.txt to file
|
|
void SetFlushing( bool b ); // enable or disable flushing
|
|
|
|
private:
|
|
bool m_bLogToDisk;
|
|
bool m_bInfoToDisk;
|
|
bool m_bUserLogToDisk;
|
|
bool m_bFlush;
|
|
bool m_bShowLogOutput;
|
|
void Write( int, const RString &str );
|
|
void UpdateMappedLog();
|
|
void AddToInfo( const RString &buf );
|
|
void AddToRecentLogs( const RString &buf );
|
|
};
|
|
|
|
extern RageLog* LOG; // global and accessable from anywhere in our program
|
|
#endif
|
|
|
|
/*
|
|
* Copyright (c) 2001-2004 Chris Danford, Glenn Maynard
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|