cfacter 3.11.0.rc.20180314

data/ext/facter/leatherman/logging/CMakeLists.txt

@@ -0,0 +1,43 @@
+find_package(Boost 1.54 REQUIRED COMPONENTS log log_setup thread date_time filesystem system chrono regex)
+find_package(Threads)
+
+add_leatherman_deps(${Boost_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+add_leatherman_includes("${Boost_INCLUDE_DIRS}")
+
+leatherman_dependency(nowide)
+leatherman_dependency(locale)
+
+if (CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME MATCHES "SunOS")
+    add_leatherman_deps(rt)
+endif()
+
+if (BUILDING_LEATHERMAN)
+    leatherman_logging_namespace("leatherman.logging")
+    leatherman_logging_line_numbers()
+endif()
+
+if(WIN32)
+    set(PLATFORM_SRCS "src/windows/logging.cc")
+    set(PLATFORM_TEST_SRCS "tests/windows/logging.cc")
+else()
+    set(PLATFORM_SRCS "src/posix/logging.cc")
+    set(PLATFORM_TEST_SRCS "tests/posix/logging.cc")
+endif()
+
+if (LEATHERMAN_USE_LOCALES AND GETTEXT_ENABLED)
+    list(APPEND PLATFORM_TEST_SRCS tests/logging_i18n.cc)
+endif()
+
+add_leatherman_library(src/logging.cc ${PLATFORM_SRCS})
+add_leatherman_test(
+    tests/logging.cc
+    tests/logging_stream.cc
+    tests/logging_stream_lines.cc
+    tests/logging_on_message.cc
+    ${PLATFORM_TEST_SRCS})
+add_leatherman_headers(inc/leatherman)
+
+if (LEATHERMAN_USE_LOCALES AND BUILDING_LEATHERMAN)
+    project(leatherman_logging)
+    add_subdirectory(locales)
+endif()

data/ext/facter/leatherman/logging/inc/leatherman/logging/logging.hpp

@@ -0,0 +1,264 @@
+/**
+ * @file
+ * Declares the logging functions and macros.
+ */
+#pragma once
+
+// To use this header, you must:
+// - Have Boost on the include path
+// - Link in Boost.Log
+// - Configure Boost.Log at runtime before any logging takes place
+/**
+ * See Boost.Log's documentation.
+ */
+#include <leatherman/locale/locale.hpp>
+#include <boost/log/core.hpp>
+#include <boost/log/expressions.hpp>
+#include <cstdio>
+#include <functional>
+
+/**
+ * Defines the logging namespace.
+ */
+#ifndef LEATHERMAN_LOGGING_NAMESPACE
+#error "LEATHERMAN_LOGGING_NAMESPACE must be set. This is typically done via CMake."
+#else
+#define LOG_NAMESPACE LEATHERMAN_LOGGING_NAMESPACE
+#endif
+
+
+/**
+ * Logs a message.
+ * @param level The logging level for the message.
+ * @param line_num The source line number of the logging call.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#ifdef LEATHERMAN_LOGGING_LINE_NUMBERS
+#define LOG_MESSAGE(level, line_num, format, ...) \
+    if (leatherman::logging::is_enabled(level)) { \
+        leatherman::logging::log(LOG_NAMESPACE, level, line_num, format, ##__VA_ARGS__); \
+    }
+#else
+#define LOG_MESSAGE(level, line_num, format, ...) \
+    if (leatherman::logging::is_enabled(level)) { \
+        leatherman::logging::log(LOG_NAMESPACE, level, 0, format, ##__VA_ARGS__); \
+    }
+#endif
+/**
+ * Logs a trace message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_TRACE(format, ...) LOG_MESSAGE(leatherman::logging::log_level::trace, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Logs a debug message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_DEBUG(format, ...) LOG_MESSAGE(leatherman::logging::log_level::debug, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Logs an info message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_INFO(format, ...) LOG_MESSAGE(leatherman::logging::log_level::info, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Logs a warning message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_WARNING(format, ...) LOG_MESSAGE(leatherman::logging::log_level::warning, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Logs an error message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_ERROR(format, ...) LOG_MESSAGE(leatherman::logging::log_level::error, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Logs a fatal message.
+ * @param format The format message.
+ * @param ... The format message parameters.
+ */
+#define LOG_FATAL(format, ...) LOG_MESSAGE(leatherman::logging::log_level::fatal, __LINE__, format, ##__VA_ARGS__)
+/**
+ * Determines if the trace logging level is enabled.
+ * @returns Returns true if trace logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_TRACE_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::trace)
+/**
+ * Determines if the debug logging level is enabled.
+ * @returns Returns true if debug logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_DEBUG_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::debug)
+/**
+ * Determines if the info logging level is enabled.
+ * @returns Returns true if info logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_INFO_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::info)
+/**
+ * Determines if the warning logging level is enabled.
+ * @returns Returns true if warning logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_WARNING_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::warning)
+/**
+ * Determines if the error logging level is enabled.
+ * @returns Returns true if error logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_ERROR_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::error)
+/**
+ * Determines if the fatal logging level is enabled.
+ * @returns Returns true if fatal logging is enabled or false if it is not enabled.
+ */
+#define LOG_IS_FATAL_ENABLED() leatherman::logging::is_enabled(leatherman::logging::log_level::fatal)
+
+namespace leatherman { namespace logging {
+
+    /**
+     * Represents the supported logging levels.
+     */
+    enum class log_level
+    {
+        none,
+        trace,
+        debug,
+        info,
+        warning,
+        error,
+        fatal
+    };
+
+    /**
+     * Reads a log level from an input stream.
+     * This is used in boost::lexical_cast<log_level>.
+     * @param in The input stream.
+     * @param level The returned log level.
+     * @returns Returns the input stream.
+     */
+    std::istream& operator>>(std::istream& in, log_level& level);
+
+    /**
+     * Produces the printed representation of logging level.
+     * @param strm The stream to write.
+     * @param level The logging level to print.
+     * @return Returns the stream after writing to it.
+     */
+    std::ostream& operator<<(std::ostream& strm, log_level level);
+
+    /**
+     * Sets up logging for the given stream.
+     * The logging level is set to warning by default.
+     * @param dst Destination stream for logging output.
+     * @param locale The locale identifier to use for logging.
+     * @param domain The catalog domain to use for i18n via gettext.
+     * @param use_locale Whether to use locales in logging setup. If locales are disabled this parameter is ignored.
+     */
+    void setup_logging(std::ostream &dst, std::string locale = "", std::string domain = PROJECT_NAME, bool use_locale = true);
+
+    /**
+     * Sets the current log level.
+     * @param level The new current log level to set.
+     */
+    void set_level(log_level level);
+
+    /**
+     * Gets the current log level.
+     * @return Returns the current log level.
+     */
+    log_level get_level();
+
+    /**
+     * Sets whether or not log output is colorized.
+     * @param color Pass true if log output is colorized or false if it is not colorized.
+     */
+    void set_colorization(bool color);
+
+    /**
+     * Gets whether or not the log output is colorized.
+     * @return Returns true if log output is colorized or false if it is not colorized.
+     */
+    bool get_colorization();
+
+    /**
+     * Provides a callback for when a message is logged.
+     * If the callback returns false, the message will not be logged.
+     * @param callback The callback to call when a message is about to be logged.
+     */
+    void on_message(std::function<bool(log_level, std::string const&)> callback);
+
+    /**
+     * Determines if the given log level is enabled for the given logger.
+     * @param level The logging level to check.
+     * @return Returns true if the logging level is enabled or false if it is not.
+     */
+    bool is_enabled(log_level level);
+
+    /**
+     * Determine if an error has been logged
+     * @return Returns true if an error or critical message has been logged
+     */
+    bool error_has_been_logged();
+
+    /**
+     * Clear the flag that indicates an error has been logged.
+     * This is necessary for testing the flagging functionality. This function should
+     * not be used by library consumers.
+     */
+    void clear_error_logged_flag();
+
+    /**
+     * Logs a given message to the given logger with the specified line number (if > 0).
+     * Does no translation on the message.
+     * @param logger The logger to log the message to.
+     * @param level The logging level to log with.
+     * @param line_num The source line number of the logging call.
+     * @param message The message to log.
+     */
+    void log_helper(const std::string &logger, log_level level, int line_num, std::string const& message);
+
+
+    /**
+     * Logs a given message to the given logger with the specified line number (if > 0).
+     * If LEATHERMAN_I18N is specified it does translation on the message.
+     * @param logger The logger to log to.
+     * @param level The logging level to log with.
+     * @param line_num The source line number of the logging call.
+     * @param msg The message format.
+     */
+    static inline void log(const std::string &logger, log_level level, int line_num, std::string const& msg)
+    {
+        log_helper(logger, level, line_num, leatherman::locale::translate(msg));
+    }
+
+    /**
+     * Logs a given format message to the given logger with the specified line number (if > 0).
+     * If LEATHERMAN_I18N is specified, does translation on the format string, but not following arguments.
+     * @tparam TArgs The types of the arguments to format the message with.
+     * @param logger The logger to log to.
+     * @param level The logging level to log with.
+     * @param line_num The source line number of the logging call.
+     * @param format The message format.
+     * @param args The remaining arguments to the message.
+     */
+    template <typename... TArgs>
+    static void log(const std::string &logger, log_level level, int line_num, std::string const& fmt, TArgs... args)
+    {
+        log_helper(logger, level, line_num, leatherman::locale::format(fmt, std::forward<TArgs>(args)...));
+    }
+
+    /**
+     * Starts colorizing for the given log level.
+     * This is a no-op on platforms that don't natively support terminal colors.
+     * @param dst The stream to colorize.
+     * @param level The log level to colorize for. Defaults to none, which resets colorization.
+     */
+    void colorize(std::ostream &dst, log_level level = log_level::none);
+
+    /**
+     * Returns whether terminal colors are supported.
+     * @param dst The stream to check.
+     * @return True if terminal colors are supported for the specified stream on this platform, else false.
+     */
+    bool color_supported(std::ostream &dst);
+
+}}  // namespace leatherman::logging

data/ext/facter/leatherman/logging/locales/CMakeLists.txt

@@ -0,0 +1,6 @@
+if (LEATHERMAN_TOPLEVEL)
+    gettext_templates(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/../tests/logging_i18n.cc)
+endif()
+gettext_compile(${CMAKE_CURRENT_SOURCE_DIR} share/locale)
+SET_DIRECTORY_PROPERTIES(PROPERTIES CLEAN_NO_CUSTOM TRUE)
+

data/ext/facter/leatherman/logging/locales/fr.po

@@ -0,0 +1,72 @@
+# French translations for leatherman_logging package.
+# Copyright (C) 2016 Puppet <docs@puppet.com>
+# This file is distributed under the same license as the leatherman_logging package.
+# Automatically generated, 2016.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: leatherman_logging \n"
+"Report-Msgid-Bugs-To: docs@puppet.com\n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\n"
+"Language: fr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. debug
+#: logging/locales/../tests/logging_i18n.cc
+msgid "debug logging"
+msgstr "l'enregistrement de débogage"
+
+#. debug
+#: logging/locales/../tests/logging_i18n.cc
+msgid "debug logging is {1}"
+msgstr "l'enregistrement de débogage est {1}"
+
+#. info
+#: logging/locales/../tests/logging_i18n.cc
+msgid "info logging"
+msgstr "info exploitation forestière"
+
+#. info
+#: logging/locales/../tests/logging_i18n.cc
+msgid "info logging is {1}"
+msgstr "info exploitation forestière est {1}"
+
+#. warning
+#: logging/locales/../tests/logging_i18n.cc
+msgid "warning logging"
+msgstr "journalisation d'avertissement"
+
+#. warning
+#: logging/locales/../tests/logging_i18n.cc
+msgid "warning logging is {1}"
+msgstr "journalisation d'avertissement est {1}"
+
+#. error
+#: logging/locales/../tests/logging_i18n.cc
+msgid "error message"
+msgstr "message d'erreur"
+
+#. error
+#: logging/locales/../tests/logging_i18n.cc
+msgid "error message is {1}"
+msgstr "un message d'erreur est {1}"
+
+#. fatal
+#: logging/locales/../tests/logging_i18n.cc
+msgid "fatal message"
+msgstr "un message fatal"
+
+#. fatal
+#: logging/locales/../tests/logging_i18n.cc
+msgid "fatal message is {1}"
+msgstr "un message fatal est {1}"
+
+#: logging/locales/../tests/logging_i18n.cc
+msgid "™❄Λ"
+msgstr "Λ❄™"

data/ext/facter/leatherman/logging/locales/leatherman_logging.pot

@@ -0,0 +1,72 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR Puppet <docs@puppet.com>
+# This file is distributed under the same license as the leatherman_logging package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: leatherman_logging \n"
+"Report-Msgid-Bugs-To: docs@puppet.com\n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+#. debug
+#: logging/locales/../tests/logging_i18n.cc
+msgid "debug logging"
+msgstr ""
+
+#. debug
+#: logging/locales/../tests/logging_i18n.cc
+msgid "debug logging is {1}"
+msgstr ""
+
+#. info
+#: logging/locales/../tests/logging_i18n.cc
+msgid "info logging"
+msgstr ""
+
+#. info
+#: logging/locales/../tests/logging_i18n.cc
+msgid "info logging is {1}"
+msgstr ""
+
+#. warning
+#: logging/locales/../tests/logging_i18n.cc
+msgid "warning logging"
+msgstr ""
+
+#. warning
+#: logging/locales/../tests/logging_i18n.cc
+msgid "warning logging is {1}"
+msgstr ""
+
+#. error
+#: logging/locales/../tests/logging_i18n.cc
+msgid "error message"
+msgstr ""
+
+#. error
+#: logging/locales/../tests/logging_i18n.cc
+msgid "error message is {1}"
+msgstr ""
+
+#. fatal
+#: logging/locales/../tests/logging_i18n.cc
+msgid "fatal message"
+msgstr ""
+
+#. fatal
+#: logging/locales/../tests/logging_i18n.cc
+msgid "fatal message is {1}"
+msgstr ""
+
+#: logging/locales/../tests/logging_i18n.cc
+msgid "™❄Λ"
+msgstr ""