aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/base/ILogOutputter.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/base/ILogOutputter.h')
-rw-r--r--src/lib/base/ILogOutputter.h69
1 files changed, 69 insertions, 0 deletions
diff --git a/src/lib/base/ILogOutputter.h b/src/lib/base/ILogOutputter.h
new file mode 100644
index 0000000..ab218fc
--- /dev/null
+++ b/src/lib/base/ILogOutputter.h
@@ -0,0 +1,69 @@
+/*
+ * barrier -- mouse and keyboard sharing utility
+ * Copyright (C) 2012-2016 Symless Ltd.
+ * Copyright (C) 2002 Chris Schoeneman
+ *
+ * This package is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * found in the file LICENSE that should have accompanied this file.
+ *
+ * This package 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "base/Log.h"
+#include "base/ELevel.h"
+#include "common/IInterface.h"
+
+//! Outputter interface
+/*!
+Type of outputter interface. The logger performs all output through
+outputters. ILogOutputter overrides must not call any log functions
+directly or indirectly.
+*/
+class ILogOutputter : public IInterface {
+public:
+ //! @name manipulators
+ //@{
+
+ //! Open the outputter
+ /*!
+ Opens the outputter for writing. Calling this method on an
+ already open outputter must have no effect.
+ */
+ virtual void open(const char* title) = 0;
+
+ //! Close the outputter
+ /*!
+ Close the outputter. Calling this method on an already closed
+ outputter must have no effect.
+ */
+ virtual void close() = 0;
+
+ //! Show the outputter
+ /*!
+ Causes the output to become visible. This generally only makes sense
+ for a logger in a graphical user interface. Other implementations
+ will do nothing. Iff \p showIfEmpty is \c false then the implementation
+ may optionally only show the log if it's not empty.
+ */
+ virtual void show(bool showIfEmpty) = 0;
+
+ //! Write a message with level
+ /*!
+ Writes \c message, which has the given \c level, to a log.
+ If this method returns true then Log will stop passing the
+ message to all outputters in the outputter chain, otherwise
+ it continues. Most implementations should return true.
+ */
+ virtual bool write(ELevel level, const char* message) = 0;
+
+ //@}
+};