/***************************************************************************
                         qgslogger.h  -  description
                             -------------------
    begin                : April 2006
    copyright            : (C) 2006 by Marco Hugentobler
    email                : marco.hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSLOGGER_H
#define QGSLOGGER_H

#include "qgsconfig.h"

#include <iostream>
#include <sstream>

#include "qgis_core.h"
#include "qgis_sip.h"

#include <QString>
#include <QTime>

using namespace Qt::StringLiterals;

class QFile;

#ifndef SIP_RUN

#ifdef QGISDEBUG
#define QgsDebugError( str ) QgsLogger::debug( QString( str ), 0, __FILE__, __FUNCTION__, __LINE__ )
#define QgsDebugMsgLevel( str, level )                                               \
  if ( ( level ) <= QgsLogger::debugLevel() )                                        \
  {                                                                                  \
    QgsLogger::debug( QString( str ), ( level ), __FILE__, __FUNCTION__, __LINE__ ); \
  }                                                                                  \
  ( void ) ( 0 )
#define QgsDebugErrorLoc( str, file, func, line ) QgsLogger::debug( QString( str ), 0, ( file ), ( func ), ( line ) )
#define QgsDebugMsgLevelLoc( str, level, file, func, line )                      \
  if ( ( level ) <= QgsLogger::debugLevel() )                                    \
  {                                                                              \
    QgsLogger::debug( QString( str ), ( level ), ( file ), ( func ), ( line ) ); \
  }                                                                              \
  ( void ) ( 0 )
#define QgsDebugCall QgsScopeLogger _qgsScopeLogger( __FILE__, __FUNCTION__, __LINE__ )
#else
#define QgsDebugCall \
  do                 \
  {                  \
  } while ( false )
#define QgsDebugError( str ) \
  do                         \
  {                          \
  } while ( false )
#define QgsDebugMsgLevel( str, level ) \
  do                                   \
  {                                    \
  } while ( false )
#define QgsDebugErrorLoc( str, file, func, line ) \
  do                                              \
  {                                               \
  } while ( false )
#define QgsDebugMsgLevelLoc( str, level, file, func, line ) \
  do                                                        \
  {                                                         \
  } while ( false )
#endif

#endif


/**
 * \ingroup core
 * \brief Responsible for printing debug/warning/error messages to the console.
 *
 * The advantage of this class over iostream & co. is that the
 * output can be controlled with environment variables:
 * QGIS_DEBUG is an int describing what debug messages are written to the console.
 * If the debug level of a message is <= QGIS_DEBUG, the message is written to the
 * console. It the variable QGIS_DEBUG is not defined, it defaults to 1 for debug
 * mode and to 0 for release mode
 * QGIS_DEBUG_FILE may contain a file name. Only the messages from this file are
 * printed (provided they have the right debuglevel). If QGIS_DEBUG_FILE is not
 * set, messages from all files are printed
 *
 * QGIS_LOG_FILE may contain a file name. If set, all messages will be appended
 * to this file rather than to stdout.
*/

class CORE_EXPORT QgsLogger
{
  public:
    /**
     * Goes to qDebug.
     * \param msg the message to be printed
     * \param debuglevel
     * \param file file name where the message comes from
     * \param function function where the message comes from
     * \param line place in file where the message comes from
    */
    static void debug( const QString &msg, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );

    //! Similar to the previous method, but prints a variable int-value pair
    static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );

    /**
     * Similar to the previous method, but prints a variable double-value pair
     * \note not available in Python bindings
     */
    static void debug( const QString &var, double val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ) SIP_SKIP SIP_SKIP;

    /**
     * Prints out a variable/value pair for types with overloaded operator<<
     * \note not available in Python bindings
     */
    template<typename T> static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr, int line = -1, int debuglevel = 1 ) SIP_SKIP SIP_SKIP
    {
      std::ostringstream os;
      os << var.toLocal8Bit().data() << " = " << val;
      debug( var, os.str().c_str(), file, function, line, debuglevel );
    }

    //! Goes to qWarning.
    static void warning( const QString &msg );

    //! Goes to qCritical.
    static void critical( const QString &msg );

    //! Goes to qFatal.
    static void fatal( const QString &msg );

    /**
     * Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set,
     * the function returns 1 if QGISDEBUG is defined and 0 if not.
    */
    static int debugLevel()
    {
      if ( sDebugLevel == -999 )
        init();
      return sDebugLevel;
    }

    //! Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any.
    static void logMessageToFile( const QString &message );

    /**
     * Reads the environment variable QGIS_LOG_FILE.
     *
     * Returns an empty string if the variable is not set, otherwise returns a file name for writing log messages to.
     *
     * Calling this method initializes the logging system by reading
     * the environment variables QGIS_LOG_FILE, QGIS_DEBUG, and QGIS_DEBUG_FILE.
     *
     * This method must be called before any call to logMessageToFile(),
     * otherwise messages will not be written to the log file.
     *
     * Returns the log file path used by QgsLogger.
    */
    static QString logFile();

  private:
    static void init();

    //! Current debug level
    static int sDebugLevel;
    static int sPrefixLength;
};

/**
 * \ingroup core
 * \brief Logs the location of the call.
 */
class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three
{
  public:
    QgsScopeLogger( const char *file, const char *func, int line )
      : _file( file )
      , _func( func )
      , _line( line )
    {
      QgsLogger::debug( u"Entering."_s, 2, _file, _func, _line );
    }
    ~QgsScopeLogger() { QgsLogger::debug( u"Leaving."_s, 2, _file, _func, _line ); }

  private:
    const char *_file = nullptr;
    const char *_func = nullptr;
    int _line;
};

#endif
