aboutsummaryrefslogtreecommitdiff
path: root/0.8.0/paludis/util/log.hh
diff options
context:
space:
mode:
Diffstat (limited to '0.8.0/paludis/util/log.hh')
-rw-r--r--0.8.0/paludis/util/log.hh119
1 files changed, 119 insertions, 0 deletions
diff --git a/0.8.0/paludis/util/log.hh b/0.8.0/paludis/util/log.hh
new file mode 100644
index 0000000..a101105
--- /dev/null
+++ b/0.8.0/paludis/util/log.hh
@@ -0,0 +1,119 @@
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+
+/*
+ * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ *
+ * This file is part of the Paludis package manager. Paludis is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU General
+ * Public License version 2, as published by the Free Software Foundation.
+ *
+ * Paludis 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
+ */
+
+#ifndef PALUDIS_GUARD_PALUDIS_LOG_HH
+#define PALUDIS_GUARD_PALUDIS_LOG_HH 1
+
+#include <iosfwd>
+#include <paludis/util/instantiation_policy.hh>
+#include <paludis/util/private_implementation_pattern.hh>
+
+/** \file
+ * Declarations for Log and related classes.
+ *
+ * \ingroup grplog
+ */
+
+namespace paludis
+{
+ /**
+ * Specifies the level of a log message.
+ *
+ * Keep this in order. When deciding whether to display a message, Log
+ * uses message log level >= current log level, so it's important that
+ * least critical levels have lower numeric values.
+ *
+ * When modifying this, you will probably also want to take a look at
+ * ebuild/echo_functions.bash and the command_line source files.
+ *
+ * \ingroup grplog
+ */
+ enum LogLevel
+ {
+ ll_debug, ///< Debug message
+ ll_qa, ///< QA messages
+ ll_warning, ///< Warning message
+ ll_silent, ///< Silent (for set_log_level)
+ last_ll, ///< Number of items
+ initial_ll = ll_debug ///< Initial value
+ };
+
+ /**
+ * Specifies whether a log message has context.
+ *
+ * \ingroup grplog
+ */
+ enum LogContext
+ {
+ lc_no_context,
+ lc_context,
+ last_lc
+ };
+
+ /**
+ * Singleton class that handles log messages.
+ *
+ * \ingroup grplog
+ */
+ class PALUDIS_VISIBLE Log :
+ public InstantiationPolicy<Log, instantiation_method::SingletonAsNeededTag>,
+ private PrivateImplementationPattern<Log>
+ {
+ friend class InstantiationPolicy<Log, instantiation_method::SingletonAsNeededTag>;
+
+ private:
+ Log();
+
+ public:
+ /**
+ * Destructor, to be called only by our InstantiationPolicy.
+ */
+ ~Log();
+
+ /**
+ * Only display messages of at least this level.
+ */
+ void set_log_level(const LogLevel);
+
+ /**
+ * Fetch the current log level.
+ */
+ LogLevel log_level() const;
+
+ /**
+ * Log a message at the specified level.
+ */
+ void message(const LogLevel, const LogContext, const std::string &);
+
+ /**
+ * Change the log stream.
+ */
+ void set_log_stream(std::ostream * const);
+
+ /**
+ * Set our program name.
+ */
+ void set_program_name(const std::string &);
+ };
+
+ std::ostream &
+ operator<< (std::ostream &, const LogLevel &) PALUDIS_VISIBLE;
+}
+
+#endif