spdlog::pattern_formatter Class Reference

#include <pattern_formatter.h>

Inheritance diagram for spdlog::pattern_formatter:

Public Member Functions
	pattern_formatter (std::string pattern, pattern_time_type time_type=pattern_time_type::local, std::string eol=spdlog::details::os::default_eol)
	pattern_formatter (pattern_time_type time_type=pattern_time_type::local, std::string eol=spdlog::details::os::default_eol)
	pattern_formatter (const pattern_formatter &other)=delete
pattern_formatter &	operator= (const pattern_formatter &other)=delete
std::unique_ptr< formatter >	clone () const override
void	format (const details::log_msg &msg, fmt::memory_buffer &dest) override
Public Member Functions inherited from spdlog::formatter
virtual	~formatter ()=default

Private Member Functions
std::tm	get_time_ (const details::log_msg &msg)
void	handle_flag_ (char flag, details::padding_info padding)
details::padding_info	handle_padspec_ (std::string::const_iterator &it, std::string::const_iterator end)
void	compile_pattern_ (const std::string &pattern)

Private Attributes
std::string	pattern_
std::string	eol_
pattern_time_type	pattern_time_type_
std::tm	cached_tm_
std::chrono::seconds	last_log_secs_
std::vector< std::unique_ptr< details::flag_formatter > >	formatters_

Detailed Description

Definition at line 1014 of file pattern_formatter.h.

Constructor & Destructor Documentation

spdlog::pattern_formatter::pattern_formatter ( std::string  pattern, pattern_time_type  time_type = pattern_time_type::local, std::string  eol = spdlog::details::os::default_eol  )

inlineexplicit

Definition at line 1017 of file pattern_formatter.h.

        : pattern_(std::move(pattern))
        , eol_(std::move(eol))
        , pattern_time_type_(time_type)
        , last_log_secs_(0)
    {
        std::memset(&cached_tm_, 0, sizeof(cached_tm_));
        compile_pattern_(pattern_);
    }

spdlog::pattern_formatter::pattern_formatter ( pattern_time_type  time_type = pattern_time_type::local, std::string  eol = spdlog::details::os::default_eol  )

inlineexplicit

Definition at line 1029 of file pattern_formatter.h.

        : pattern_("%+")
        , eol_(std::move(eol))
        , pattern_time_type_(time_type)
        , last_log_secs_(0)
    {
        std::memset(&cached_tm_, 0, sizeof(cached_tm_));
        formatters_.push_back(details::make_unique<details::full_formatter>(details::padding_info{}));
    }

spdlog::pattern_formatter::pattern_formatter ( const pattern_formatter &  other )

delete

Member Function Documentation

std::unique_ptr<formatter> spdlog::pattern_formatter::clone ( ) const

inlineoverridevirtual

Implements spdlog::formatter.

Definition at line 1042 of file pattern_formatter.h.

    {
        return details::make_unique<pattern_formatter>(pattern_, pattern_time_type_, eol_);
    }

void spdlog::pattern_formatter::compile_pattern_ ( const std::string &  pattern )

inlineprivate

Definition at line 1296 of file pattern_formatter.h.

    {
        auto end = pattern.end();
        std::unique_ptr<details::aggregate_formatter> user_chars;
        formatters_.clear();
        for (auto it = pattern.begin(); it != end; ++it)
        {
            if (*it == '%')
            {
                if (user_chars) // append user chars found so far
                {
                    formatters_.push_back(std::move(user_chars));
                }

                auto padding = handle_padspec_(++it, end);

                if (it != end)
                {
                    handle_flag_(*it, padding);
                }
                else
                {
                    break;
                }
            }
            else // chars not following the % sign should be displayed as is
            {
                if (!user_chars)
                {
                    user_chars = details::make_unique<details::aggregate_formatter>();
                }
                user_chars->add_ch(*it);
            }
        }
        if (user_chars) // append raw chars found so far
        {
            formatters_.push_back(std::move(user_chars));
        }
    }

void spdlog::pattern_formatter::format ( const details::log_msg &  msg, fmt::memory_buffer &  dest  )

inlineoverridevirtual

Implements spdlog::formatter.

Definition at line 1047 of file pattern_formatter.h.

    {
#ifndef SPDLOG_NO_DATETIME
        auto secs = std::chrono::duration_cast<std::chrono::seconds>(msg.time.time_since_epoch());
        if (secs != last_log_secs_)
        {
            cached_tm_ = get_time_(msg);
            last_log_secs_ = secs;
        }
#endif
        for (auto &f : formatters_)
        {
            f->format(msg, cached_tm_, dest);
        }
        // write eol
        details::fmt_helper::append_string_view(eol_, dest);
    }

std::tm spdlog::pattern_formatter::get_time_ ( const details::log_msg &  msg )

inlineprivate

Definition at line 1074 of file pattern_formatter.h.

    {
        if (pattern_time_type_ == pattern_time_type::local)
        {
            return details::os::localtime(log_clock::to_time_t(msg.time));
        }
        return details::os::gmtime(log_clock::to_time_t(msg.time));
    }

void spdlog::pattern_formatter::handle_flag_ ( char  flag, details::padding_info  padding  )

inlineprivate

Definition at line 1083 of file pattern_formatter.h.

    {
        switch (flag)
        {

        case ('+'): // default formatter
            formatters_.push_back(details::make_unique<details::full_formatter>(padding));
            break;

        case 'n': // logger name
            formatters_.push_back(details::make_unique<details::name_formatter>(padding));
            break;

        case 'l': // level
            formatters_.push_back(details::make_unique<details::level_formatter>(padding));
            break;

        case 'L': // short level
            formatters_.push_back(details::make_unique<details::short_level_formatter>(padding));
            break;

        case ('t'): // thread id
            formatters_.push_back(details::make_unique<details::t_formatter>(padding));
            break;

        case ('v'): // the message text
            formatters_.push_back(details::make_unique<details::v_formatter>(padding));
            break;

        case ('a'): // weekday
            formatters_.push_back(details::make_unique<details::a_formatter>(padding));
            break;

        case ('A'): // short weekday
            formatters_.push_back(details::make_unique<details::A_formatter>(padding));
            break;

        case ('b'):
        case ('h'): // month
            formatters_.push_back(details::make_unique<details::b_formatter>(padding));
            break;

        case ('B'): // short month
            formatters_.push_back(details::make_unique<details::B_formatter>(padding));
            break;

        case ('c'): // datetime
            formatters_.push_back(details::make_unique<details::c_formatter>(padding));
            break;

        case ('C'): // year 2 digits
            formatters_.push_back(details::make_unique<details::C_formatter>(padding));
            break;

        case ('Y'): // year 4 digits
            formatters_.push_back(details::make_unique<details::Y_formatter>(padding));
            break;

        case ('D'):
        case ('x'): // datetime MM/DD/YY
            formatters_.push_back(details::make_unique<details::D_formatter>(padding));
            break;

        case ('m'): // month 1-12
            formatters_.push_back(details::make_unique<details::m_formatter>(padding));
            break;

        case ('d'): // day of month 1-31
            formatters_.push_back(details::make_unique<details::d_formatter>(padding));
            break;

        case ('H'): // hours 24
            formatters_.push_back(details::make_unique<details::H_formatter>(padding));
            break;

        case ('I'): // hours 12
            formatters_.push_back(details::make_unique<details::I_formatter>(padding));
            break;

        case ('M'): // minutes
            formatters_.push_back(details::make_unique<details::M_formatter>(padding));
            break;

        case ('S'): // seconds
            formatters_.push_back(details::make_unique<details::S_formatter>(padding));
            break;

        case ('e'): // milliseconds
            formatters_.push_back(details::make_unique<details::e_formatter>(padding));
            break;

        case ('f'): // microseconds
            formatters_.push_back(details::make_unique<details::f_formatter>(padding));
            break;

        case ('F'): // nanoseconds
            formatters_.push_back(details::make_unique<details::F_formatter>(padding));
            break;

        case ('E'): // seconds since epoch
            formatters_.push_back(details::make_unique<details::E_formatter>(padding));
            break;

        case ('p'): // am/pm
            formatters_.push_back(details::make_unique<details::p_formatter>(padding));
            break;

        case ('r'): // 12 hour clock 02:55:02 pm
            formatters_.push_back(details::make_unique<details::r_formatter>(padding));
            break;

        case ('R'): // 24-hour HH:MM time
            formatters_.push_back(details::make_unique<details::R_formatter>(padding));
            break;

        case ('T'):
        case ('X'): // ISO 8601 time format (HH:MM:SS)
            formatters_.push_back(details::make_unique<details::T_formatter>(padding));
            break;

        case ('z'): // timezone
            formatters_.push_back(details::make_unique<details::z_formatter>(padding));
            break;

        case ('P'): // pid
            formatters_.push_back(details::make_unique<details::pid_formatter>(padding));
            break;

#ifdef SPDLOG_ENABLE_MESSAGE_COUNTER
        case ('i'):
            formatters_.push_back(details::make_unique<details::i_formatter>(padding));
            break;
#endif
        case ('^'): // color range start
            formatters_.push_back(details::make_unique<details::color_start_formatter>(padding));
            break;

        case ('$'): // color range end
            formatters_.push_back(details::make_unique<details::color_stop_formatter>(padding));
            break;

        case ('@'): // source location (filename:filenumber)
            formatters_.push_back(details::make_unique<details::source_location_formatter>(padding));
            break;

        case ('s'): // source filename
            formatters_.push_back(details::make_unique<details::source_filename_formatter>(padding));
            break;

        case ('#'): // source line number
            formatters_.push_back(details::make_unique<details::source_linenum_formatter>(padding));
            break;

        case ('!'): // source funcname
            formatters_.push_back(details::make_unique<details::source_funcname_formatter>(padding));
            break;

        case ('%'): // % char
            formatters_.push_back(details::make_unique<details::ch_formatter>('%'));
            break;

        default: // Unknown flag appears as is
            auto unknown_flag = details::make_unique<details::aggregate_formatter>();
            unknown_flag->add_ch('%');
            unknown_flag->add_ch(flag);
            formatters_.push_back((std::move(unknown_flag)));
            break;
        }
    }

details::padding_info spdlog::pattern_formatter::handle_padspec_ ( std::string::const_iterator &  it, std::string::const_iterator  end  )

inlineprivate

Definition at line 1256 of file pattern_formatter.h.

    {
        using details::padding_info;
        using details::scoped_pad;
        const size_t max_width = 128;
        if (it == end)
        {
            return padding_info{};
        }

        padding_info::pad_side side;
        switch (*it)
        {
        case '-':
            side = padding_info::right;
            ++it;
            break;
        case '=':
            side = padding_info::center;
            ++it;
            break;
        default:
            side = details::padding_info::left;
            break;
        }

        if (it == end || !std::isdigit(static_cast<unsigned char>(*it)))
        {
            return padding_info{0, side};
        }

        auto width = static_cast<size_t>(*it - '0');
        for (++it; it != end && std::isdigit(static_cast<unsigned char>(*it)); ++it)
        {
            auto digit = static_cast<size_t>(*it - '0');
            width = width * 10 + digit;
        }
        return details::padding_info{std::min<size_t>(width, max_width), side};
    }

pattern_formatter& spdlog::pattern_formatter::operator= ( const pattern_formatter &  other )

delete

Member Data Documentation

std::tm spdlog::pattern_formatter::cached_tm_

private

Definition at line 1069 of file pattern_formatter.h.

std::string spdlog::pattern_formatter::eol_

private

Definition at line 1067 of file pattern_formatter.h.

std::vector<std::unique_ptr<details::flag_formatter> > spdlog::pattern_formatter::formatters_

private

Definition at line 1072 of file pattern_formatter.h.

std::chrono::seconds spdlog::pattern_formatter::last_log_secs_

private

Definition at line 1070 of file pattern_formatter.h.

std::string spdlog::pattern_formatter::pattern_

private

Definition at line 1066 of file pattern_formatter.h.

pattern_time_type spdlog::pattern_formatter::pattern_time_type_

private

Definition at line 1068 of file pattern_formatter.h.

---

The documentation for this class was generated from the following file:

• wire-cell-build/util/inc/spdlog/details/pattern_formatter.h