MacroMetadata.h

#pragma once

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

#include <cstddef>
#include <cstdint>
#include <string_view>

QUILL_BEGIN_NAMESPACE

QUILL_BEGIN_EXPORT

class MacroMetadata
{
public:
  enum Event : uint8_t
  {
    None,
    Log,
    InitBacktrace,
    FlushBacktrace,
    Flush,
    LogWithRuntimeMetadataDeepCopy,
    LogWithRuntimeMetadataHybridCopy,
    LogWithRuntimeMetadataShallowCopy,
    LoggerRemovalRequest,
    Metric,
    MdcSet,
    MdcErase,
    MdcClear
  };

  constexpr MacroMetadata() = default;

  constexpr MacroMetadata(char const* source_location, char const* caller_function,
                          char const* message_format, char const* tags, LogLevel log_level, Event event) noexcept
    : _source_location(source_location),
      _caller_function(caller_function),
      _message_format(message_format),
      _tags(tags),
      _colon_separator_pos(_calc_colon_separator_pos()),
      _file_name_pos(_calc_file_name_pos()),
      _log_level(log_level),
      _event(event)
  {
  }

  QUILL_NODISCARD char const* source_location() const noexcept { return _source_location; }

  QUILL_NODISCARD char const* caller_function() const noexcept { return _caller_function; }

  QUILL_NODISCARD char const* message_format() const noexcept { return _message_format; }

  QUILL_NODISCARD char const* line() const noexcept
  {
    if (QUILL_UNLIKELY(_source_location[_colon_separator_pos] == '\0'))
    {
      return _source_location + _colon_separator_pos;
    }

    return _source_location + _colon_separator_pos + 1;
  }

  QUILL_NODISCARD std::string_view full_path() const noexcept
  {
    return std::string_view{_source_location, _colon_separator_pos};
  }

  QUILL_NODISCARD std::string_view file_name() const noexcept
  {
    return std::string_view{_source_location + _file_name_pos,
                            static_cast<size_t>(_colon_separator_pos - _file_name_pos)};
  }

  QUILL_NODISCARD char const* short_source_location() const noexcept
  {
    return _source_location + _file_name_pos;
  }

  QUILL_NODISCARD LogLevel log_level() const noexcept { return _log_level; }

  QUILL_NODISCARD char const* tags() const noexcept { return _tags; }

  QUILL_NODISCARD constexpr bool has_named_args() const noexcept
  {
    return contains_named_args(_message_format);
  }

  QUILL_NODISCARD Event event() const noexcept { return _event; }

  /***/
  QUILL_NODISCARD static constexpr bool contains_named_args(std::string_view fmt) noexcept
  {
    uint32_t pos{0};
    bool found_named_arg{false};

    // Iterates the format string and checks if any characters are contained inside `{}`
    while (pos < fmt.length())
    {
      if (fmt[pos] == '{')
      {
        ++pos; // consume {
        if (pos >= fmt.length())
        {
          break;
        }

        // first character after the {
        auto const fc = fmt[pos];
        if (fc == '{')
        {
          // this means first '{' was escaped, so we ignore both of them
          ++pos;
          continue;
        }

        // else look for the next '}'
        uint32_t char_cnt{0};
        while (pos < fmt.length())
        {
          if (fmt[pos] == '}')
          {
            ++pos; // consume }
            if (pos >= fmt.length())
            {
              break;
            }

            if (fmt[pos] == '}')
            {
              // this means first '}', was escaped ignore it
              ++pos;
              ++char_cnt;
              continue;
            }

            // we found '{' match, we can break
            break;
          }

          ++pos;
          ++char_cnt;
        }

        if ((char_cnt != 0) && ((fc >= 'a' && fc <= 'z') || (fc >= 'A' && fc <= 'Z') || (fc == '_')))
        {
          found_named_arg = true;
        }
        continue;
      }
      ++pos;
    }

    return found_named_arg;
  }

private:
  /***/
  QUILL_NODISCARD constexpr uint16_t _calc_file_name_pos() const noexcept
  {
    char const* source_location = _source_location;
    char const* file = source_location;
    while (*source_location)
    {
      char cur = *source_location++;
      if (cur == '/' || cur == detail::PATH_PREFERRED_SEPARATOR)
      {
        file = source_location;
      }
    }
    return static_cast<uint16_t>(file - _source_location);
  }

  /***/
  QUILL_NODISCARD constexpr uint16_t _calc_colon_separator_pos() const noexcept
  {
    // std::string_view::rfind is only constexpr from C++20
    size_t length = 0;
    while (_source_location[length] != '\0')
    {
      ++length;
    }

    for (size_t i = length; i > 0; --i)
    {
      if (_source_location[i - 1] == ':')
      {
        return static_cast<uint16_t>(i - 1);
      }
    }

    return static_cast<uint16_t>(length);
  }

private:
  char const* _source_location{nullptr};
  char const* _caller_function{nullptr};
  char const* _message_format{nullptr};
  char const* _tags{nullptr};
  uint16_t _colon_separator_pos{0};
  uint16_t _file_name_pos{0};
  LogLevel _log_level{LogLevel::None};
  Event _event{Event::None};
};

QUILL_END_EXPORT

static_assert(sizeof(MacroMetadata) <= detail::QUILL_CACHE_LINE_SIZE,
              "Size of MacroMetadata exceeds the cache line size");

QUILL_END_NAMESPACE