D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlCore/Log.hpp

Go to the documentation of this file.

/**************************************************************************************/
/*                                                                                    */
/*  Visualization Library                                                             */
/*  http://www.visualizationlibrary.com                                               */
/*                                                                                    */
/*  Copyright (c) 2005-2010, Michele Bosi                                             */
/*  All rights reserved.                                                              */
/*                                                                                    */
/*  Redistribution and use in source and binary forms, with or without modification,  */
/*  are permitted provided that the following conditions are met:                     */
/*                                                                                    */
/*  - Redistributions of source code must retain the above copyright notice, this     */
/*  list of conditions and the following disclaimer.                                  */
/*                                                                                    */
/*  - Redistributions in binary form must reproduce the above copyright notice, this  */
/*  list of conditions and the following disclaimer in the documentation and/or       */
/*  other materials provided with the distribution.                                   */
/*                                                                                    */
/*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND   */
/*  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED     */
/*  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE            */
/*  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR  */
/*  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES    */
/*  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;      */
/*  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON    */
/*  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT           */
/*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS     */
/*  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                      */
/*                                                                                    */
/**************************************************************************************/

#ifndef Log_INCLUDE_ONCE
#define Log_INCLUDE_ONCE

#include <vlCore/String.hpp>
#include <vlCore/IMutex.hpp>
#include <fstream>

namespace vl
{
  //------------------------------------------------------------------------------
  // Log
  //-----------------------------------------------------------------------------
  class VLCORE_EXPORT Log: public Object
  {
  protected:
    typedef enum 
    { 
      LogBug,
      LogError,
      LogWarning,
      LogNormal,
      LogInfo,
      LogDebug,
    } ELogLevel;

  public:
    virtual const char* className() { return "vl::Log"; }

    Log()
    {
      VL_DEBUG_SET_OBJECT_NAME()
    }

  protected:
    virtual void printImplementation(ELogLevel level, const String& message) = 0;

    // ---  static methods ---

  public:
    static void setLogMutex(IMutex* mutex) { mLogMutex = mutex; }

    static IMutex* logMutex() { return mLogMutex; }

    /* Logs the specified message.
     * \note Log generated only if verbosity level != vl::VEL_VERBOSITY_SILENT */
    static void print(const String& message);
    
    static void info(const String& message);

    static void debug(const String& message);

    static void warning(const String& message);

    static void error(const String& message);

    static void bug(const String& message);

    static void logSystemInfo();

  private:
    static IMutex* mLogMutex;
  };

  //-----------------------------------------------------------------------------
  // Default logger
  //-----------------------------------------------------------------------------
  VLCORE_EXPORT void setDefLogger(Log* logger);

  VLCORE_EXPORT Log* defLogger();

  //-----------------------------------------------------------------------------
  // StandardLog
  //-----------------------------------------------------------------------------
  class VLCORE_EXPORT StandardLog: public Log
  {
  public:
    virtual const char* className() { return "vl::StandardLog"; }
    void setLogFile(const String& file);
    const String& logFile() const { return mLogFile; }

  protected:
    virtual void printImplementation(ELogLevel level, const String& message);
    String mLogFile;
    std::ofstream mFile;
  };
}

#endif