ryzom/server/src/entities_game_service/admin_log.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2016  Winch Gate Property Limited
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU Affero General Public License as
   6 // published by the Free Software Foundation, either version 3 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU Affero General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU Affero General Public License
  15 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18
  19 #ifndef RY_ADMIN_LOG_H
  20 #define RY_ADMIN_LOG_H
  21
  22 #include "nel/misc/log.h"
  23 #include "nel/misc/debug.h"
  24 #include "nel/misc/variable.h"
  25
  26
  27 /**
  28  * separate log system for admin commands. Logs are in egs_mission.log. use ADMINLOG to log in this file
  29  * \author Ulukyn
  30  * \date 2016
  31  */
  32 class CAdminLog
  33 {
  34 public:
  35         /// init the log
  36         void init(const std::string & logFile);
  37         ///release the log
  38         void release();
  39         ///\return the name of the log file
  40         inline const std::string & getLogFile(){return _LogFile;}
  41
  42         void display(const char *format, ...);
  43
  44         /// the NEL log used for in the mission log
  45         NLMISC::CLog                    *Log;
  46 private:
  47         /// the file displayer used to log the mission information
  48         NLMISC::CFileDisplayer  _Fd;
  49         /// log file name
  50         std::string                             _LogFile;
  51 };
  52
  53 /// the mission log
  54 extern CAdminLog        AdminLog;
  55
  56 /// macro used to log missions script error
  57 #define ADMINLOG AdminLog.display
  58
  59 #endif // RY_ADMIN_LOG_H
  60
  61 /* End of admin_log.h */
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82