ericw-tools/include/common/log.hh

/*  Copyright (C) 2000-2006  Kevin Shanahan

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

    See file, 'COPYING', for details.
*/

/*
 * common/log.h
 *
 * Stuff for logging selected output to a file
 * as well as the stdout.
 */

#pragma once

#include <atomic>
#include <cstdarg>
#include <filesystem>
#include <fmt/format.h>
#include <common/bitflags.hh>
#include <common/fs.hh>

// forward declaration
namespace settings
{
class common_settings;
}

namespace logging
{
enum class flag : uint8_t
{
    NONE = 0, // none of the below (still prints though)
    DEFAULT = nth_bit(0), // prints everywhere
    VERBOSE = nth_bit(1), // prints everywhere, if enabled
    PROGRESS = nth_bit(2), // prints only to stdout
    PERCENT = nth_bit(3), // prints everywhere, if enabled
    STAT = nth_bit(4), // prints everywhere, if enabled
    CLOCK_ELAPSED = nth_bit(5), // overrides displayElapsed if disabled
    ALL = 0xFF
};

extern bitflags<flag> mask;

// initialize logging subsystem
void init(const fs::path &filename, const settings::common_settings &settings);

// shutdown logging subsystem
void close();

// print to respective targets based on log flag
void print(flag logflag, const char *str);

// print to default targets
inline void print(const char *str)
{
    print(flag::DEFAULT, str);
}

// format print to specified targets
template<typename... Args>
inline void print(flag type, const char *fmt, const Args &...args)
{
    if (mask & type) {
        print(type, fmt::format(fmt, std::forward<const Args &>(args)...).c_str());
    }
}

// format print to default targets
template<typename... Args>
inline void print(const char *fmt, const Args &...args)
{
    print(flag::DEFAULT, fmt::format(fmt, std::forward<const Args &>(args)...).c_str());
}

inline void header(const char *name)
{
    print(flag::PROGRESS, "---- {} ----\n", name);
}

// TODO: C++20 source_location
#ifdef _MSC_VER
#define funcprint(fmt, ...) print("{}: " fmt, __FUNCTION__, ##__VA_ARGS__)
#define funcheader() header(__FUNCTION__)
#else
#define funcprint(fmt, ...) print("{}: " fmt, __func__, ##__VA_ARGS__)
#define funcheader() header(__func__)
#endif

inline void assert_(bool success, const char *expr, const char *file, int line)
{
    if (!success) {
        print("{}:{}: Q_assert({}) failed.\n", file, line, expr);
        // assert(0);
#ifdef _WIN32
        __debugbreak();
#endif
        exit(1);
    }
}

// Display a percent timer. This also keeps track of how long the
// current task is taking to execute. Note that only one of these
// can be active at a time. Once `count` == `max`, the progress
// bar will "finish" and be inoperable.
// Only use this by hand if you absolutely need to; otherwise,
// use <common/parallel.h>'s parallel_for(_each)
void percent(uint64_t count, uint64_t max, bool displayElapsed = true);

// use this as "max" (and on the final run, "count") to indicate that
// the counter does not have a determinating maximum factor.
constexpr uint64_t indeterminate = std::numeric_limits<uint64_t>::max();

#include <atomic>

// simple wrapper to percent() to use it in an object-oriented manner. you can
// call print() to explicitly end the clock, or allow it to run out of scope.
struct percent_clock
{
    std::atomic<uint64_t> max;
    bool displayElapsed = true;
    std::atomic<uint64_t> count = 0;
    bool ready = true;

    // runs a tick immediately to show up on stdout
    // unless max is zero
    inline percent_clock(uint64_t max = indeterminate) :
        max(max)
    {
        if (max != 0) {
            percent(0, max, displayElapsed);
        }
    }

    // increase count by 1
    inline void increase()
    {
        if (count == max) {
            logging::print("ERROR TO FIX LATER: clock counter increased to end, but not finished yet\n");
        }

        percent(count++, max, displayElapsed);
    }
    
    // increase count by 1
    inline void operator()()
    {
        increase();
    }
    
    // increase count by 1
    inline void operator++(int)
    {
        increase();
    }

    // prints & ends the clock; class is invalid after this call.
    void print();

    // implicitly calls print()
    inline ~percent_clock() { print(); }
};

#include <list>

// base class intended to be inherited for stat trackers;
// they will automatically print the results at the end,
// in the order of registration.
struct stat_tracker_t
{
    struct stat
    {
        const char *name;
        bool show_even_if_zero;
        std::atomic_size_t count = 0;

        inline stat(const char *name, bool show_even_if_zero) :
            name(name),
            show_even_if_zero(show_even_if_zero)
        {
        }
        
        inline std::atomic_size_t::value_type operator++(int) noexcept { return count++; }
        inline std::atomic_size_t::value_type operator++() noexcept { return ++count; }
        inline std::atomic_size_t::value_type operator+=(std::atomic_size_t::value_type v) noexcept { return count += v; }
        inline std::atomic_size_t::value_type operator++(int) volatile noexcept { return count++; }
        inline std::atomic_size_t::value_type operator++() volatile noexcept { return ++count; }
        inline std::atomic_size_t::value_type operator+=(std::atomic_size_t::value_type v) volatile noexcept { return count += v; }
    };

    std::list<stat> stats;

    inline stat &register_stat(const char *name, bool show_even_if_zero = false)
    {
        return stats.emplace_back(name, show_even_if_zero);
    }

    ~stat_tracker_t()
    {
        for (auto &stat : stats) {
            if (stat.show_even_if_zero || stat.count) {
                print(flag::STAT, "     {:8} {}\n", stat.count, stat.name);
            }
        }
    }
};
}; // namespace logging