ResInsight/ApplicationCode/Application/RiaLogging.cpp

/////////////////////////////////////////////////////////////////////////////////
//
//  Copyright (C) 2017     Statoil ASA
// 
//  ResInsight 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 3 of the License, or
//  (at your option) any later version.
// 
//  ResInsight 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 at <http://www.gnu.org/licenses/gpl.html> 
//  for more details.
//
/////////////////////////////////////////////////////////////////////////////////

#include "RiaLogging.h"

#include <sstream>

#ifdef WIN32
#pragma warning (push)
#pragma warning (disable: 4668)
#include <windows.h>
#pragma warning (pop)
#else
#include <cstring>
#include <cstdio>
#endif




//==================================================================================================
//
// 
//
//==================================================================================================
class RiaDefaultConsoleLogger : public RiaLogger
{
public:
    RiaDefaultConsoleLogger();

    virtual int     level() const;
    virtual void    setLevel(int logLevel);
    virtual void    error(  const char* message, const char* fileName, int lineNumber);
    virtual void    warning(const char* message, const char* fileName, int lineNumber);
    virtual void    info(   const char* message, const char* fileName, int lineNumber);
    virtual void    debug(  const char* message, const char* fileName, int lineNumber);

private:
    static void         writeMessageToConsole(const char* prefix, const char* message, const char* fileName, int lineNumber);
    static void         writeToConsole(const std::string& str);

private:
    int     m_logLevel;
};



//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RiaDefaultConsoleLogger::RiaDefaultConsoleLogger()
    : m_logLevel(RI_LL_WARNING)
{
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
int RiaDefaultConsoleLogger::level() const
{
    return m_logLevel;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::setLevel(int logLevel)
{
    m_logLevel = logLevel;
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::error(const char* message, const char* fileName, int lineNumber)
{
    writeMessageToConsole("ERROR: ", message, fileName, lineNumber);
}

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::warning(const char* message, const char*, int)
{
    writeMessageToConsole("warn:  ", message, NULL, 0);
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::info(const char* message, const char*, int)
{
    writeMessageToConsole("info:  ", message, NULL, 0);
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::debug(const char* message, const char*, int)
{
    writeMessageToConsole("debug: ", message, NULL, 0);
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::writeMessageToConsole(const char* prefix, const char* message, const char* fileName, int lineNumber)
{
    std::ostringstream oss;

//    VF_ASSERT(prefix);
    oss << prefix;

    if (message)
    {
        oss << message << std::endl;
    }
    else
    {
        oss << "<no message>" << std::endl;
    }

    if (fileName)
    {
        oss << "        -file " << RiaLogger::shortFileName(fileName) << ", line " << lineNumber << std::endl;
    }

    writeToConsole(oss.str());
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaDefaultConsoleLogger::writeToConsole(const std::string& str)
{
#ifdef WIN32
    AllocConsole();
    HANDLE hStdOutputHandle = GetStdHandle(STD_OUTPUT_HANDLE);
    if (hStdOutputHandle)
    {
        DWORD stringLength = static_cast<DWORD>(str.length());

        unsigned long iDum = 0;
        WriteConsoleA(hStdOutputHandle, str.c_str(), stringLength, &iDum, NULL);
    }
#else
    fputs(str.c_str(), stderr);
#endif
}


//==================================================================================================
//
// 
//
//==================================================================================================

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
const char* RiaLogger::shortFileName(const char* fileName)
{
//    VF_ASSERT(fileName);

    const char* ptrToLastSlash = strrchr(fileName, '/');

#ifdef WIN32
    const char* ptrToLastBwdSlash = strrchr(fileName, '\\');
    if (ptrToLastBwdSlash > ptrToLastSlash)
    {
        ptrToLastSlash = ptrToLastBwdSlash;
    }
#endif

    if (ptrToLastSlash)
    {
        return ptrToLastSlash + 1;
    }
    else
    {
        return fileName;
    }
}





//==================================================================================================
//
// 
//
//==================================================================================================

RiaLogger* RiaLogging::sm_logger = new RiaDefaultConsoleLogger;

//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
RiaLogger* RiaLogging::loggerInstance()
{
    return sm_logger;
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaLogging::setLoggerInstance(RiaLogger* loggerInstance)
{
    // Only delete if we're currently using our own default impl
    if (dynamic_cast<RiaDefaultConsoleLogger*>(sm_logger))
    {
        delete sm_logger;
    }

//    VF_ASSERT(loggerInstance);
    sm_logger = loggerInstance;
}


//--------------------------------------------------------------------------------------------------
/// 
//--------------------------------------------------------------------------------------------------
void RiaLogging::deleteLoggerInstance()
{
    delete sm_logger;
    sm_logger = NULL;
}