BackendOptions.h

#pragma once

#include "quill/core/Attributes.h"
#include "quill/core/LogLevel.h"

#include <array>
#include <chrono>
#include <cstdint>
#include <cstdio>
#include <functional>
#include <string>
#include <vector>

#if defined(__MINGW32__)
  #include <iostream>
#endif

QUILL_BEGIN_NAMESPACE

namespace detail
{
inline void backend_options_default_error_notifier(std::string const& error_message)
{
#if !defined(__MINGW32__)
  std::fprintf(stderr, "%s\n", error_message.data());
#else
  // fprintf crashes on mingw gcc 13 for unknown reason
  std::cerr << error_message.data() << "\n";
#endif
}

inline bool backend_options_default_check_printable_char(char c) noexcept
{
  return (c >= ' ' && c <= '~') || (c == '\n') || (c == '\t') || (c == '\r');
}
} // namespace detail

QUILL_BEGIN_EXPORT

struct BackendOptions
{
  BackendOptions() = default;

  std::string thread_name = "QuillBackend";

  bool enable_yield_when_idle = false;

  std::chrono::nanoseconds sleep_duration = std::chrono::microseconds{100};

  uint32_t transit_event_buffer_initial_capacity = 256;

  size_t transit_events_soft_limit = 8192;

  size_t transit_events_hard_limit = 65'536;

  std::chrono::microseconds log_timestamp_ordering_grace_period{5};

  bool ensure_monotonic_output_timestamps = false;

  bool wait_for_queues_to_empty_before_exit = true;

  std::vector<uint16_t> cpu_affinity;

  std::function<void(std::string const&)> error_notifier{detail::backend_options_default_error_notifier};

  std::function<void()> backend_worker_on_poll_begin = {};

  std::function<void()> backend_worker_on_poll_end = {};

  std::chrono::milliseconds rdtsc_resync_interval = std::chrono::milliseconds{500};

  std::chrono::milliseconds sink_min_flush_interval = std::chrono::milliseconds{200};

  std::function<bool(char c)> check_printable_char{detail::backend_options_default_check_printable_char};

  std::array<std::string, LogLevelCount> log_level_descriptions = {
    "TRACE_L3", "TRACE_L2", "TRACE_L1", "DEBUG",     "INFO", "NOTICE",
    "WARNING",  "ERROR",    "CRITICAL", "BACKTRACE", "NONE"};

  std::array<std::string, LogLevelCount> log_level_short_codes = {"T3", "T2", "T1", "D",  "I", "N",
                                                                  "W",  "E",  "C",  "BT", "_"};

  std::string mdc_format_pattern = " [{}: {}, ]";

  bool check_backend_singleton_instance = true;
};

QUILL_END_EXPORT

QUILL_END_NAMESPACE