core/Logger.h
author Nicholas Hastings <skamonkey@gmail.com>
Mon Feb 08 19:57:20 2010 -0800 (2010-02-08)
changeset 2914 bf5f9aa53abe
parent 2726 c96f3fab8211
child 3791 47e1ee9cea86
permissions -rw-r--r--
Fixed FindEntityByClassname crash in Synergy (bug 4235, r=dvander).
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_CLOGGER_H_
    33 #define _INCLUDE_SOURCEMOD_CLOGGER_H_
    34 
    35 #include <stdio.h>
    36 #include <sh_string.h>
    37 #include "sm_globals.h"
    38 
    39 using namespace SourceHook;
    40 
    41 enum LogType
    42 {
    43 	LogType_Normal,
    44 	LogType_Error
    45 };
    46 
    47 enum LoggingMode
    48 {
    49 	LoggingMode_Daily,
    50 	LoggingMode_PerMap,
    51 	LoggingMode_Game
    52 };
    53 
    54 class Logger : public SMGlobalClass
    55 {
    56 public:
    57 	Logger() : m_Mode(LoggingMode_Daily), m_ErrMapStart(false), 
    58 		m_Active(false), m_DelayedStart(false), m_DailyPrintHdr(false), 
    59 		m_InitialState(true)
    60 	{
    61 	}
    62 public: //SMGlobalClass
    63 	ConfigResult OnSourceModConfigChanged(const char *key, 
    64 		const char *value, 
    65 		ConfigSource source,
    66 		char *error, 
    67 		size_t maxlength);
    68 	void OnSourceModStartup(bool late);
    69 	void OnSourceModAllShutdown();
    70 	void OnSourceModLevelChange(const char *mapName);
    71 public:
    72 	void InitLogger(LoggingMode mode);
    73 	void CloseLogger();
    74 	void EnableLogging();
    75 	void DisableLogging();
    76 	void LogMessage(const char *msg, ...);
    77 	void LogError(const char *msg, ...);
    78 	void LogErrorEx(const char *msg, va_list ap); 
    79 	void LogFatal(const char *msg, ...);
    80 	void LogToOpenFile(FILE *fp, const char *msg, ...);
    81 	void LogToOpenFileEx(FILE *fp, const char *msg, va_list ap);
    82 	/* This version does not print to console, and is thus thread-safe */
    83 	void LogToFileOnly(FILE *fp, const char *msg, ...);
    84 	void LogToFileOnlyEx(FILE *fp, const char *msg, va_list ap);
    85 	void MapChange(const char *mapname);
    86 	const char *GetLogFileName(LogType type) const;
    87 	LoggingMode GetLoggingMode() const;
    88 private:
    89 	void _CloseFile();
    90 	void _NewMapFile();
    91 	void _PrintToGameLog(const char *fmt, va_list ap);
    92 private:
    93 	String m_NrmFileName;
    94 	String m_ErrFileName;
    95 	String m_CurMapName;
    96 	LoggingMode m_Mode;
    97 	int m_CurDay;
    98 	bool m_ErrMapStart;
    99 	bool m_Active;
   100 	bool m_DelayedStart;
   101 	bool m_DailyPrintHdr;
   102 	bool m_InitialState;
   103 };
   104 
   105 void Engine_LogPrintWrapper(const char *msg);
   106 
   107 extern bool g_in_game_log_hook;
   108 extern Logger g_Logger;
   109 
   110 #endif // _INCLUDE_SOURCEMOD_CLOGGER_H_