FGLog.h

/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 Header:       FGLog.h
 Author:       Bertrand Coconnier
 Date started: 05/03/24
 
 ------------- Copyright (C) 2024 Bertrand Coconnier -------------
 
 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser 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 Lesser General Public License for more
 details.
 
 You should have received a copy of the GNU Lesser 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.
 
 Further information about the GNU Lesser General Public License can also be
 found on the world wide web at http://www.gnu.org.
 
HISTORY
--------------------------------------------------------------------------------
05/03/24   BC    Created
 
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
SENTRY
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#ifndef FGLOG_H
#define FGLOG_H
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
INCLUDES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
#include <iomanip>
#include <memory>
#include <sstream>
#include <string>
 
#include "simgear/misc/sg_path.hxx"
#include "FGJSBBase.h"
#include "math/FGColumnVector3.h"
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
FORWARD DECLARATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
namespace JSBSim {
 
class Element;
 
// The return type of these functions is unspecified by the C++ standard so we
// need some C++ magic to be able to overload the operator<< for these functions.
using setprecision_t = decltype(std::setprecision(0));
// For MSVC set_precision_t and setw_t are the same type
#ifndef _MSC_VER
using setw_t = decltype(std::setw(0));
#endif
 
enum class LogLevel {
  BULK,  // For frequent messages
  DEBUG, // Less frequent debug type messages
  INFO,  // Informatory messages
  WARN,  // Possible impending problem
  ERROR, // Problem that can be recovered
  FATAL, // Fatal problem => an exception will be thrown
  STDOUT // Standard output - unconditionally displayed.
};
 
enum class LogFormat {
  RESET,
  RED,
  BLUE,
  CYAN,
  GREEN,
  DEFAULT,
  BOLD,
  NORMAL,
  UNDERLINE_ON,
  UNDERLINE_OFF
};
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DOCUMENTATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
/*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CLASS DECLARATION
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%*/
 
class JSBSIM_API FGLogger
{
public:
  virtual ~FGLogger() {}
  virtual void SetLevel(LogLevel level) { log_level = level;}
  virtual void FileLocation(const std::string& filename, int line) {}
  virtual void Message(const std::string& message) = 0;
  virtual void Format(LogFormat format) {}
  virtual void Flush(void) {}
protected:
  LogLevel log_level = LogLevel::BULK;
};
 
using FGLogger_ptr = std::shared_ptr<FGLogger>;
 
JSBSIM_API void SetLogger(FGLogger_ptr logger);
 
JSBSIM_API FGLogger_ptr GetLogger(void);
 
class JSBSIM_API FGLogging
{
public:
  FGLogging(LogLevel level);
 
  virtual ~FGLogging() { Flush(); }
  FGLogging& operator<<(const char* message) { buffer << message ; return *this; }
  FGLogging& operator<<(const std::string& message) { buffer << message ; return *this; }
  // Operator for ints and anonymous enums
  FGLogging& operator<<(int value) { buffer << value; return *this; }
  // Operator for other numerical types
  template<typename T, typename = std::enable_if_t<std::is_arithmetic<T>::value>>
    FGLogging& operator<<(T value) { buffer << value; return *this; }
  FGLogging& operator<<(std::ostream& (*manipulator)(std::ostream&)) { buffer << manipulator; return *this; }
  FGLogging& operator<<(std::ios_base& (*manipulator)(std::ios_base&)) { buffer << manipulator; return *this; }
  FGLogging& operator<<(setprecision_t value) { buffer << value; return *this; }
  // Avoid duplicate definition for MSVC for which set_precision_t and setw_t
  // are the same type
#ifndef _MSC_VER
  FGLogging& operator<<(setw_t value) { buffer << value; return *this; }
#endif
  FGLogging& operator<<(const SGPath& path) { buffer << path; return *this; }
  FGLogging& operator<<(const FGColumnVector3& vec) { buffer << vec; return *this; }
  FGLogging& operator<<(LogFormat format);
  std::streambuf* rdbuf() { return buffer.rdbuf(); }
  void Flush(void);
protected:
  FGLogging(FGLogger_ptr l) : logger(l) {}
 
  FGLogger_ptr logger;
  std::ostringstream buffer;
};
 
class JSBSIM_API FGXMLLogging : public FGLogging
{
public:
  FGXMLLogging(Element* el, LogLevel level);
};
 
class JSBSIM_API FGLogConsole : public FGLogger
{
public:
  void SetMinLevel(LogLevel level) { min_level = level; }
  void FileLocation(const std::string& filename, int line) override
  { buffer.append("\nIn file " + filename + ": line " + std::to_string(line) + "\n"); }
  void Message(const std::string& message) override { buffer.append(message); }
  void Format(LogFormat format) override;
  void Flush(void) override;
  ~FGLogConsole() override { Flush(); }
 
protected:
  std::string buffer;
  LogLevel min_level = LogLevel::BULK;
};
 
class JSBSIM_API LogException : public BaseException, public FGLogging
{
public:
  LogException();
  LogException(LogException& other);
  const char* what() const noexcept override;
};
 
class JSBSIM_API XMLLogException : public LogException
{
public:
  // Construct an XMLLogException using the current thread-local logger
  // and the supplied Element to add file/line location information.
  XMLLogException(Element* el);
  XMLLogException(LogException& exception, Element* el);
};
} // namespace JSBSim
#endif