Support out of band messages

8 files changed, 53 insertions, 1 deletions

diff --git a/paludis/util/files.m4 b/paludis/util/files.m4
index 44526f4ca..6e7e05568 100644
--- a/paludis/util/files.m4
+++ b/paludis/util/files.m4
@@ -46,7 +46,7 @@ add(`named_value',                       `hh', `cc', `fwd')
 add(`no_type',                           `hh')
 add(`operators',                         `hh')
 add(`options',                           `hh', `fwd', `cc', `test')
-add(`output_manager',                    `hh', `fwd', `cc')
+add(`output_manager',                    `hh', `fwd', `cc', `se')
 add(`output_wrapper',                    `test', `testscript')
 add(`pipe',                              `hh', `cc')
 add(`pretty_print',                      `hh', `cc', `test')
diff --git a/paludis/util/output_manager-fwd.hh b/paludis/util/output_manager-fwd.hh
index 12928c43c..3c650aacf 100644
--- a/paludis/util/output_manager-fwd.hh
+++ b/paludis/util/output_manager-fwd.hh
@@ -20,8 +20,14 @@
 #ifndef PALUDIS_GUARD_PALUDIS_UTIL_OUTPUT_MANAGER_FWD_HH
 #define PALUDIS_GUARD_PALUDIS_UTIL_OUTPUT_MANAGER_FWD_HH 1
 
+#include <paludis/util/attributes.hh>
+#include <iosfwd>
+
 namespace paludis
 {
+
+#include <paludis/util/output_manager-se.hh>
+
     class OutputManager;
 }
 
diff --git a/paludis/util/output_manager.cc b/paludis/util/output_manager.cc
index 7fe0767e0..0b7732634 100644
--- a/paludis/util/output_manager.cc
+++ b/paludis/util/output_manager.cc
@@ -18,9 +18,14 @@
  */
 
 #include <paludis/util/output_manager.hh>
+#include <paludis/util/stringify.hh>
+#include <paludis/util/exception.hh>
+#include <ostream>
 
 using namespace paludis;
 
+#include <paludis/util/output_manager-se.cc>
+
 OutputManager::~OutputManager()
 {
 }
diff --git a/paludis/util/output_manager.hh b/paludis/util/output_manager.hh
index 736394de9..98588d439 100644
--- a/paludis/util/output_manager.hh
+++ b/paludis/util/output_manager.hh
@@ -37,6 +37,15 @@ namespace paludis
             virtual std::ostream & stderr_stream() PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
 
             /**
+             * An out of band message that might want to be logged or handled
+             * in a special way.
+             *
+             * The caller must still also display the message to
+             * stdout_stream() as appropriate.
+             */
+            virtual void message(const MessageType, const std::string &) = 0;
+
+            /**
              * Called if an action succeeds. This can be used to, for example,
              * unlink the files behind a to-disk logged output manager.
              *
diff --git a/paludis/util/output_manager.se b/paludis/util/output_manager.se
new file mode 100644
index 000000000..61698440f
--- /dev/null
+++ b/paludis/util/output_manager.se
@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+# vim: set sw=4 sts=4 et ft=sh :
+
+make_enum_MessageType()
+{
+    prefix mt
+
+    key mt_debug                        "A message only to be kept when debugging"
+    key mt_info                         "An informational message"
+    key mt_warn                         "A warning message"
+    key mt_error                        "An error message"
+    key mt_log                          "A message explicitly marked for logging"
+
+    doxygen_comment << "END"
+        /**
+         * Type of message for OutputManager.
+         *
+         * \see OutputManager
+         */
+END
+}
+
diff --git a/paludis/util/standard_output_manager.cc b/paludis/util/standard_output_manager.cc
index b819e6f33..7416f8d0e 100644
--- a/paludis/util/standard_output_manager.cc
+++ b/paludis/util/standard_output_manager.cc
@@ -47,3 +47,8 @@ StandardOutputManager::succeeded()
 {
 }
 
+void
+StandardOutputManager::message(const MessageType, const std::string &)
+{
+}
+
diff --git a/paludis/util/standard_output_manager.hh b/paludis/util/standard_output_manager.hh
index 87523526e..afe2fbc08 100644
--- a/paludis/util/standard_output_manager.hh
+++ b/paludis/util/standard_output_manager.hh
@@ -36,6 +36,7 @@ namespace paludis
             virtual std::ostream & stderr_stream() PALUDIS_ATTRIBUTE((warn_unused_result));
 
             virtual void succeeded();
+            virtual void message(const MessageType, const std::string &);
     };
 }
 
diff --git a/src/clients/cave/cmd_sync.cc b/src/clients/cave/cmd_sync.cc
index e40411495..d25d1384b 100644
--- a/src/clients/cave/cmd_sync.cc
+++ b/src/clients/cave/cmd_sync.cc
@@ -92,6 +92,10 @@ namespace
         void succeeded()
         {
         }
+
+        virtual void message(const MessageType, const std::string &)
+        {
+        }
     };
 
     struct SyncCommandLine :