Log.h

/* Copyright (c) Queen's Printer for Ontario, 2020. */
/* Copyright (c) His Majesty the King in Right of Canada as represented by the Minister of Natural Resources, 2024-2025. */
 
/* SPDX-License-Identifier: AGPL-3.0-or-later */
 
#pragma once
namespace fs::logging
{
static const int LOG_EXTENSIVE = 0;
static const int LOG_VERBOSE = 1;
static const int LOG_DEBUG = 2;
static const int LOG_INFO = 3;
static const int LOG_NOTE = 4;
static const int LOG_WARNING = 5;
static const int LOG_ERROR = 6;
static const int LOG_FATAL = 7;
static const int LOG_SILENT = 8;
 
class Log
{
  static int logging_level_;
public:
  static void setLogLevel(int log_level) noexcept;
  static void increaseLogLevel() noexcept;
  static void decreaseLogLevel() noexcept;
  static int getLogLevel() noexcept;
  static int openLogFile(const char* filename) noexcept;
  static int closeLogFile() noexcept;
};
string format_log_message(const char* prefix, const char* format, va_list* args);
void output(int log_level, const char* format, va_list* args)
#ifdef NDEBUG
  noexcept
#endif
  ;
void output(int log_level, const char* format, ...)
#ifdef NDEBUG
  noexcept
#endif
  ;
void extensive(const char* format, ...) noexcept;
void verbose(const char* format, ...) noexcept;
void debug(const char* format, ...) noexcept;
void info(const char* format, ...) noexcept;
void note(const char* format, ...) noexcept;
void warning(const char* format, ...) noexcept;
void error(const char* format, ...) noexcept;
void check_fatal(bool condition, const char* format, ...)
#ifdef NDEBUG
  noexcept
#endif
  ;
void check_equal(const MathSize lhs, const MathSize rhs, const char* name)
#ifdef NDEBUG
  noexcept
#endif
  ;
void check_equal(const char* lhs, const char* rhs, const char* name)
#ifdef NDEBUG
  noexcept
#endif
  ;
template <class V>
void check_equal(const V& lhs, const V& rhs, const char* name)
#ifdef NDEBUG
  noexcept
#endif
{
  logging::check_fatal(lhs != rhs,
                       "Expected %s to be %d but got %d",
                       name,
                       rhs,
                       lhs);
}
void fatal(const char* format, ...)
#ifdef NDEBUG
  noexcept
#endif
  ;
void fatal(const std::exception& ex);
void fatal(const std::exception& ex, const char* format, ...);
// templated so we can return it from any function and not get an error
// about not returning on all paths
template <class T>
T fatal(const char* format, va_list* args)
#ifdef NDEBUG
  noexcept
#endif
{
  // format message and then output so we don't parse args twice and can use for error
  auto msg = format_log_message("", format, args);
  output(LOG_FATAL, msg.c_str());
  Log::closeLogFile();
#ifdef NDEBUG
  exit(EXIT_FAILURE);
#else
  // HACK: just throw the format for a start - just want to see stack traces when debugging
  throw std::runtime_error(msg);
#endif
}
template <class T>
T fatal(const char* format, ...)
#ifdef NDEBUG
  noexcept
#endif
{
  va_list args;
  va_start(args, format);
  // cppcheck-suppress va_end_missing
  return fatal<T>(format, &args);
  //  va_end(args);
}
class SelfLogger
{
protected:
  virtual string add_log(const char* format) const noexcept = 0;
  void log_output(const int level, const char* format, ...) const noexcept;
  void log_extensive(const char* format, ...) const noexcept;
  void log_verbose(const char* format, ...) const noexcept;
  void log_debug(const char* format, ...) const noexcept;
  void log_info(const char* format, ...) const noexcept;
  void log_note(const char* format, ...) const noexcept;
  void log_warning(const char* format, ...) const noexcept;
  void log_error(const char* format, ...) const noexcept;
  void log_check_fatal(bool condition, const char* format, ...) const
#ifdef NDEBUG
    noexcept
#endif
    ;
  void log_fatal(const char* format, ...) const
#ifdef NDEBUG
    noexcept
#endif
    ;
};
}