def.hpp

Go to the documentation of this file.

 
#ifndef DEF_HPP
#define DEF_HPP
#include <fstream>
#include <map>
#include <memory>
#include <vector>
#include <string>
#include <unordered_map>
 
#include <cstdlib>
#include <chrono>
#include <sstream>
#include <iostream>
#include <filesystem>
#include <stdlib.h>
#include <fstream>
#include <signal.h>
#include <csignal>
#include <cstring>
 
#include <stdexcept>
 
#if defined(linux) || defined(__linux) || defined(__linux__)
#define FIMS_LINUX
#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__) || \
    defined(__DragonFly__)
#define FIMS_BSD
#elif defined(sun) || defined(__sun)
#define FIMS_SOLARIS
#elif defined(__sgi)
#define FIMS_IRIX
#elif defined(__hpux)
#define FIMS_HPUX
#elif defined(__CYGWIN__)
#define FIMS_CYGWIN
#elif defined(_WIN32) || defined(__WIN32__) || defined(WIN32)
#define FIMS_WIN32
#elif defined(_WIN64) || defined(__WIN64__) || defined(WIN64)
#define FIMS_WIN64
#elif defined(__BEOS__)
#define FIMS_BEOS
#elif defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
#define FIMS_MACOS
#elif defined(__IBMCPP__) || defined(_AIX)
#define FIMS_AIX
#elif defined(__amigaos__)
#define FIMS_AMIGAOS
#elif defined(__QNXNTO__)
#define FIMS_QNXNTO
#endif
 
#if defined(FIMS_WIN32) || defined(FIMS_WIN64)
#define FIMS_WINDOWS
#endif
 
#ifdef FIMS_WINDOWS
#ifndef NOMINMAX
#define NOMINMAX
#endif
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <Windows.h>
#undef TRUE
#undef FALSE
#undef GetObject
#include <Lmcons.h>  // for UNLEN
#elif defined(FIMS_LINUX) || defined(FIMS_MACOS) || defined(FIMS_BSD)
#include <unistd.h>
#include <pwd.h>
#endif
 
#if !defined(__PRETTY_FUNCTION__) && !defined(__GNUC__)
#ifdef FIMS_WINDOWS
#define __PRETTY_FUNCTION__ __FUNCTION__
#endif
#endif
 
// The following rows initialize default log files for outputting model progress
// comments used to assist in diagnosing model issues and tracking progress.
 
#ifdef TMB_MODEL
// simplify access to singletons
#define TMB_FIMS_REAL_TYPE double
#define TMBAD_FIMS_TYPE TMBad::ad_aug
#endif
 
/* Dictionary block for shared documentation.
  [params_for_message]
  @param str Log message text.
  @param line Source line number where the message originated.
  @param file Source file where the message originated.
  @param func Function or method name where the message originated.
  [params_for_message]
*/
 
/* Dictionary block for shared documentation.
  [param_MESSAGE]
  @param MESSAGE Human-readable log message describing what happened and why.
  [param_MESSAGE]
*/
 
namespace fims {
 
struct LogEntry {
  std::string timestamp;
  std::string message;
  std::string level;
  size_t rank;
  std::string user;
  std::string wd;
  std::string file;
  std::string routine;
  int line;
 
  std::string to_string() {
    std::stringstream ss;
    ss << "\"timestamp\": " << "\"" << this->timestamp << "\"" << ",\n";
    ss << "\"level\": " << "\"" << this->level << "\",\n";
    ss << "\"message\": " << "\"" << this->message << "\",\n";
    ss << "\"id\": " << "\"" << this->rank << "\",\n";
    ss << "\"user\": " << "\"" << this->user << "\",\n";
    ss << "\"wd\": " << "\"" << this->wd << "\",\n";
    ss << "\"file\": " << "\"" << this->file << "\",\n";
    ss << "\"routine\": " << "\"" << this->routine << "\",\n";
    ss << "\"line\": " << "\"" << this->line << "\"\n";
    return ss.str();
  }
};
 
class FIMSLog {
  std::vector<std::string> entries;
  std::vector<LogEntry> log_entries;
  size_t entry_number = 0;
  std::string path = "fims.log";
  size_t warning_count = 0;
  size_t error_count = 0;
 
  std::string get_user() {
#ifdef FIMS_WINDOWS
    char username[UNLEN + 1];
    DWORD username_len = UNLEN + 1;
    if (GetUserNameA(username, &username_len)) {
      return std::string(username);
    } else {
      return "[unknown user]";
    }
 
#elif defined(FIMS_LINUX) || defined(FIMS_MACOS) || defined(FIMS_BSD)
    const char* user_env = getenv("USER");
    if (user_env) return std::string(user_env);
 
    uid_t uid = getuid();
    struct passwd* pw = getpwuid(uid);
    if (pw && pw->pw_name) {
      return std::string(pw->pw_name);
    } else {
      return "[unknown user]";
    }
 
#else
    return "[unsupported platform]";
#endif
  }
 
 public:
  bool write_on_exit = true;
  bool throw_on_error = false;
  static std::shared_ptr<FIMSLog> fims_log;
 
  FIMSLog() {}
 
  ~FIMSLog() {
    if (this->write_on_exit) {
      std::ofstream log(this->path);
      log << this->get_log();
      log.close();
    }
  }
 
  std::filesystem::path getAbsolutePathWithoutDotDot(
      const std::filesystem::path& relativePath) {
    std::filesystem::path absolutePath =
        std::filesystem::absolute(relativePath);
 
    std::filesystem::path result;
    for (const auto& part : absolutePath) {
      if (part == "..") {
        if (!result.empty()) {
          result = result.parent_path();
        }
      } else {
        result /= part;
      }
    }
 
    return result.generic_string();
  }
 
  void set_path(std::string path) { this->path = path; }
 
  std::string get_path() { return this->path; }
 
  void info_message(std::string str, int line, const char* file,
                    const char* func) {
    std::filesystem::path relativePath = file;
    std::filesystem::path absolutePath =
        getAbsolutePathWithoutDotDot(relativePath);
    std::filesystem::path cwd = std::filesystem::current_path();
    std::stringstream ss;
    auto now = std::chrono::system_clock::now();
    std::time_t now_time = std::chrono::system_clock::to_time_t(now);
    std::string ctime_no_newline = strtok(ctime(&now_time), "\n");
 
    LogEntry l;
    l.timestamp = ctime_no_newline;
    l.message = str;
    l.level = "info";
    l.rank = this->log_entries.size();
    l.user = this->get_user();
    l.wd = cwd.generic_string();
    l.file = absolutePath.string();
    l.line = line;
    l.routine = func;
    this->log_entries.push_back(l);
  }
 
  void error_message(std::string str, int line, const char* file,
                     const char* func) {
    this->error_count++;
    std::filesystem::path relativePath = file;
    std::filesystem::path absolutePath =
        getAbsolutePathWithoutDotDot(relativePath);
    std::filesystem::path cwd = std::filesystem::current_path();
 
    std::stringstream ss;
    auto now = std::chrono::system_clock::now();
    std::time_t now_time = std::chrono::system_clock::to_time_t(now);
    std::string ctime_no_newline = strtok(ctime(&now_time), "\n");
 
    LogEntry l;
    l.timestamp = ctime_no_newline;
    l.message = str;
    l.level = "error";
    l.rank = this->log_entries.size();
    l.user = this->get_user();
    l.wd = cwd.generic_string();
    l.file = absolutePath.string();
    l.line = line;
    l.routine = func;
    this->log_entries.push_back(l);
 
    if (this->throw_on_error) {
      std::stringstream ss;
      ss << "\n\n" << l.to_string() << "\n\n";
      throw std::runtime_error(ss.str().c_str());
    }
  }
 
  void warning_message(std::string str, int line, const char* file,
                       const char* func) {
    this->warning_count++;
    std::filesystem::path relativePath = file;
    std::filesystem::path absolutePath =
        getAbsolutePathWithoutDotDot(relativePath);
    std::filesystem::path cwd = std::filesystem::current_path();
 
    std::stringstream ss;
    auto now = std::chrono::system_clock::now();
    std::time_t now_time = std::chrono::system_clock::to_time_t(now);
    std::string ctime_no_newline = strtok(ctime(&now_time), "\n");
 
    LogEntry l;
    l.timestamp = ctime_no_newline;
    l.message = str;
    l.level = "warning";
    l.rank = this->log_entries.size();
    l.user = this->get_user();
    l.wd = cwd.generic_string();
    l.file = absolutePath.string();
    l.line = line;
    l.routine = func;
    this->log_entries.push_back(l);
  }
 
  std::string get_log() {
    std::stringstream ss;
    if (log_entries.size() == 0) {
      ss << "[\n]";
    } else {
      ss << "[\n";
      for (size_t i = 0; i < log_entries.size() - 1; i++) {
        ss << "{\n" << this->log_entries[i].to_string() << "},\n";
      }
      ss << "{\n"
         << this->log_entries[log_entries.size() - 1].to_string() << "}\n]";
    }
    return ss.str();
  }
 
  std::string get_errors() {
    std::stringstream ss;
    std::vector<LogEntry> errors;
    for (size_t i = 0; i < log_entries.size(); i++) {
      if (log_entries[i].level == "error") {
        errors.push_back(this->log_entries[i]);
      }
    }
 
    if (errors.size() == 0) {
      ss << "[\n]";
    } else {
      ss << "[\n";
      for (size_t i = 0; i < errors.size() - 1; i++) {
        ss << "{\n" << errors[i].to_string() << "},\n";
      }
 
      ss << "{\n" << errors[errors.size() - 1].to_string() << "}\n]";
    }
    return ss.str();
  }
 
  std::string get_warnings() {
    std::stringstream ss;
    std::vector<LogEntry> warnings;
    for (size_t i = 0; i < log_entries.size(); i++) {
      if (log_entries[i].level == "warning") {
        warnings.push_back(this->log_entries[i]);
      }
    }
 
    if (warnings.size() == 0) {
      ss << "[\n]";
    } else {
      ss << "[\n";
      for (size_t i = 0; i < warnings.size() - 1; i++) {
        ss << "{\n" << warnings[i].to_string() << "},\n";
      }
 
      ss << "{\n" << warnings[warnings.size() - 1].to_string() << "}\n]";
    }
    return ss.str();
  }
 
  std::string get_info() {
    std::stringstream ss;
    std::vector<LogEntry> info;
    for (size_t i = 0; i < log_entries.size(); i++) {
      if (log_entries[i].level == "info") {
        info.push_back(this->log_entries[i]);
      }
    }
 
    if (info.size() == 0) {
      ss << "[\n]";
    } else {
      ss << "[\n";
      for (size_t i = 0; i < info.size() - 1; i++) {
        ss << "{\n" << info[i].to_string() << "},\n";
      }
 
      ss << "{\n" << info[info.size() - 1].to_string() << "}\n]";
    }
    return ss.str();
  }
 
  size_t get_error_count() const { return error_count; }
 
  size_t get_warning_count() const { return warning_count; }
 
  void clear() {
    this->entries.clear();
    this->log_entries.clear();
    this->error_count = 0;
    this->warning_count = 0;
    this->entry_number = 0;
  }
};
 
#ifdef FIMS_HEADER_ONLY
std::shared_ptr<FIMSLog> FIMSLog::fims_log = std::make_shared<FIMSLog>();
#endif
 
}  // namespace fims
 
#define FIMS_INFO_LOG(MESSAGE)                                       \
  fims::FIMSLog::fims_log->info_message(MESSAGE, __LINE__, __FILE__, \
                                        __PRETTY_FUNCTION__);
 
#define FIMS_WARNING_LOG(MESSAGE)                                       \
  fims::FIMSLog::fims_log->warning_message(MESSAGE, __LINE__, __FILE__, \
                                           __PRETTY_FUNCTION__);
 
#define FIMS_ERROR_LOG(MESSAGE)                                       \
  fims::FIMSLog::fims_log->error_message(MESSAGE, __LINE__, __FILE__, \
                                         __PRETTY_FUNCTION__);
 
#define FIMS_STR(s) #s
 
namespace fims {
 
inline void WriteAtExit(int sig) {
  std::string signal_error = "NA";
  switch (sig) {
    case SIGSEGV:
      signal_error = "Invalid memory access (segmentation fault)";
      break;
    case SIGINT:
      signal_error = "External interrupt, possibly initiated by the user.";
      break;
    case SIGABRT:
      signal_error =
          "Abnormal termination condition, possible call to std::abort.";
      break;
    case SIGFPE:
      signal_error = "Erroneous arithmetic operation.";
      break;
    case SIGILL:
      signal_error = "Invalid program image or invalid instruction";
      break;
    case SIGTERM:
      signal_error = "Termination request, sent to the program.";
      break;
    default:
      signal_error = "Unknown signal thrown";
  }
 
  FIMSLog::fims_log->error_message(signal_error, -999, "?", "?");
 
  if (FIMSLog::fims_log->write_on_exit) {
    std::ofstream log(FIMSLog::fims_log->get_path());
    log << FIMSLog::fims_log->get_log();
    log.close();
  }
  std::signal(sig, SIG_DFL);
  raise(sig);
}
 
template <typename T>
std::string to_string(T v) {
  std::stringstream ss;
  ss << v;
  return ss.str();
}
 
}  // namespace fims
 
#endif /* TRAITS_HPP */