log.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008 by Kutumov Alexey                                  *
 *   ru.pixel@gmail.com                                                    *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef __log__header__
#define __log__header__

#include "gpucalc/object.h"

namespace gpucalc
{
 const char _LogClassName [] = "Log";


 const int Log_Threshold = 4;


 enum LoggingLevel
 {
  LL_Low = 1,
  LL_Normal = 2,
  LL_Verbose = 3
 };


 enum LogMessageLevel
 {
  LML_Trivial = 1,
  LML_Normal = 2,
  LML_Critical = 3
 };

 const char _LogListenerClassName [] = "LogListener";

 class _GpuCalcExport LogListener: public Object
 {
  public:

   LogListener(const std::string & LogListenerName): Object(_LogListenerClassName, LogListenerName)
   {}

   virtual ~LogListener()
   {
   }


   virtual void MessageLogged(const std::string & message, LogMessageLevel lml,
    bool maskDebug, const std::string & logName) = 0;
 };


 class _GpuCalcExport Log: public Object
 {
  public:
   Log(const std::string & LogName, unsigned int LogClassNameAlignment = 15, unsigned int LogObjectNameAlignment = 20,
    bool DebugOutput = true, bool SuppressFileOutput = false, bool SuppressObjectInfo = false);


   ~Log();


   void logMessage(const Object & object, const std::string & Message,
    LogMessageLevel lml = LML_Normal, bool maskDebug = false);


   void logMessage(const Object * object, const std::string & Message,
    LogMessageLevel lml = LML_Normal, bool maskDebug = false);


   bool isDebugOutputEnabled() const
   {
    return mDebugOutput;
   }


   bool isFileOutputSuppressed() const
   {
    return mSuppressFile;
   }


   void setDebugOutputEnabled(bool debugOutput)
   {
    mDebugOutput = debugOutput;
   }


   void setLogDetail(LoggingLevel ll)
   {
    mLogLevel = ll;
   }


   void setTimeOutputEnabled(bool TimeOutput)
   {
    mTimeOutput = TimeOutput;
   }


   LoggingLevel getLogDetail()
   {
    return mLogLevel;
   }


   LoggingLevel getLogDetail() const
   {
    return mLogLevel;
   }


   void addListener(LogListener * listener);


   void removeListener(LogListener * listener);


  private:
   std::ofstream mfpLog;
   LoggingLevel mLogLevel;
   bool mDebugOutput;
   bool mSuppressFile;
   bool mSuppressObjectInfo;
   bool mTimeOutput;
   unsigned int mLogClassNameAlignment;
   unsigned int mLogObjectNameAlignment;

   typedef std::list<LogListener *> mtLogListener;
   mtLogListener mListeners;

   void logMessage(const std::string & message, LogMessageLevel lml = LML_Normal, bool maskDebug = false);

 };
}

#endif