p4tools/common/lib/logging.h

/*
 * SPDX-FileCopyrightText: 2023 The P4 Language Consortium
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef BACKENDS_P4TOOLS_COMMON_LIB_LOGGING_H_
#define BACKENDS_P4TOOLS_COMMON_LIB_LOGGING_H_
 
#include <filesystem>
#include <optional>
#include <string>
#include <utility>
 
#include <boost/format.hpp>
 
#include "lib/log.h"
 
namespace P4::P4Tools {

inline std::string logHelper(boost::format &f) { return f.str(); }

template <class T, class... Args>
std::string logHelper(boost::format &f, T &&t, Args &&...args) {
    return logHelper(f % std::forward<T>(t), std::forward<Args>(args)...);
}

// https://stackoverflow.com/a/25859856
template <typename... Arguments>
void printFeature(const std::string &label, int level, const std::string &fmt,
                  Arguments &&...args) {
    // Do not print logging messages when logging is not enabled.
    if (!Log::fileLogLevelIsAtLeast(label.c_str(), level)) {
        return;
    }
 
    boost::format f(fmt);
    LOG_FEATURE(label.c_str(), level, logHelper(f, std::forward<Arguments>(args)...));
}

template <typename... Arguments>
void printInfo(const std::string &fmt, Arguments &&...args) {
    printFeature("tools_info", 4, fmt, std::forward<Arguments>(args)...);
}

template <typename... Arguments>
void printDebug(const std::string &fmt, Arguments &&...args) {
    printFeature("tools_debug", 4, fmt, std::forward<Arguments>(args)...);
}

void enableInformationLogging();

void enablePerformanceLogging();

void printPerformanceReport(const std::optional<std::filesystem::path> &basePath = std::nullopt);
 
}  // namespace P4::P4Tools
 
#endif /* BACKENDS_P4TOOLS_COMMON_LIB_LOGGING_H_ */