Initial commit of the synergy trunk sources from sf.net

lib/base/ILogOutputter.h

@@ -0,0 +1,81 @@
+/*
+ * synergy -- mouse and keyboard sharing utility
+ * 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 COPYING 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.
+ */
+
+#ifndef ILOGOUTPUTTER_H
+#define ILOGOUTPUTTER_H
+
+#include "IInterface.h"
+#include "CLog.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:
+	typedef CLog::ELevel ELevel;
+
+	//! @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 CLog 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;
+
+	//@}
+	//! @name accessors
+	//@{
+
+	//! Returns the newline sequence for the outputter
+	/*!
+	Different outputters use different character sequences for newlines.
+	This method returns the appropriate newline sequence for this
+	outputter.
+	*/
+	virtual const char*	getNewline() const = 0;
+
+	//@}
+};
+
+#endif