#define _LOGSTREAM_H
#include <simgear/compiler.h>
+#include <simgear/debug/debug_types.h>
-#ifdef _MSC_VER
-# include <windows.h>
-#endif
+#include <sstream>
+#include <vector>
+
+// forward decls
+class SGPath;
+
+namespace simgear
+{
+
+class LogCallback
+{
+public:
+ virtual ~LogCallback() {}
+ virtual void operator()(sgDebugClass c, sgDebugPriority p,
+ const char* file, int line, const std::string& aMessage) = 0;
-#include <streambuf>
-#include <ostream>
+ void setLogLevels(sgDebugClass c, sgDebugPriority p);
+protected:
+ LogCallback(sgDebugClass c, sgDebugPriority p);
-#include <simgear/debug/debug_types.h>
+ bool shouldLog(sgDebugClass c, sgDebugPriority p) const;
+private:
+ sgDebugClass m_class;
+ sgDebugPriority m_priority;
+};
-using std::streambuf;
-using std::ostream;
+/**
+ * Helper force a console on platforms where it might optional, when
+ * we need to show a console. This basically means Windows at the
+ * moment - on other plaforms it's a no-op
+ */
+void requestConsole();
-//
-// TODO:
-//
-// 1. Change output destination. Done.
-// 2. Make logbuf thread safe.
-// 3. Read environment for default debugClass and debugPriority.
-//
+void shutdownLogging();
+
+} // of namespace simgear
/**
- * logbuf is an output-only streambuf with the ability to disable sets of
- * messages at runtime. Only messages with priority >= logbuf::logPriority
- * and debugClass == logbuf::logClass are output.
+ * Class to manage the debug logging stream.
*/
-#ifdef SG_NEED_STREAMBUF_HACK
-class logbuf : public __streambuf
-#else
-class logbuf : public std::streambuf
-#endif
+class logstream
{
public:
- // logbuf( streambuf* sb ) : sbuf(sb) {}
- /** Constructor */
- logbuf();
-
- /** Destructor */
- ~logbuf();
-
- /**
- * Is logging enabled?
- * @return true or false*/
- bool enabled() { return logging_enabled; }
-
+ ~logstream();
+
+ static void initGlobalLogstream();
/**
- * Set the logging level of subsequent messages.
+ * Set the global log class and priority level.
* @param c debug class
* @param p priority
*/
- void set_log_state( sgDebugClass c, sgDebugPriority p );
+ void setLogLevels( sgDebugClass c, sgDebugPriority p );
- bool would_log( sgDebugClass c, sgDebugPriority p ) const;
+ bool would_log( sgDebugClass c, sgDebugPriority p ) const;
- /**
- * Set the global logging level.
- * @param c debug class
- * @param p priority
- */
- static void set_log_level( sgDebugClass c, sgDebugPriority p );
+ void logToFile( const SGPath& aPath, sgDebugClass c, sgDebugPriority p );
+ void set_log_priority( sgDebugPriority p);
+
+ void set_log_classes( sgDebugClass c);
+
+ sgDebugClass get_log_classes() const;
+
+ sgDebugPriority get_log_priority() const;
/**
- * Set the allowed logging classes.
- * @param c All enabled logging classes anded together.
+ * the core logging method
*/
- static void set_log_classes (sgDebugClass c);
-
+ void log( sgDebugClass c, sgDebugPriority p,
+ const char* fileName, int line, const std::string& msg);
/**
- * Get the logging classes currently enabled.
- * @return All enabled debug logging anded together.
+ * support for the SG_POPUP logging class
+ * set the content of the popup message
*/
- static sgDebugClass get_log_classes ();
-
+ void popup( const std::string& msg);
/**
- * Set the logging priority.
- * @param c The priority cutoff for logging messages.
+ * retrieve the contents of the popup message and clear it's internal
+ * content. The return value may be an empty string.
*/
- static void set_log_priority (sgDebugPriority p);
-
+ std::string get_popup();
/**
- * Get the current logging priority.
- * @return The priority cutoff for logging messages.
+ * return true if a new popup message is available. false otherwise.
*/
- static sgDebugPriority get_log_priority ();
-
-
+ bool has_popup();
+
+ /**
+ * \relates logstream
+ * Return the one and only logstream instance.
+ * We use a function instead of a global object so we are assured that cerr
+ * has been initialised.
+ * @return current logstream
+ */
+ friend logstream& sglog();
+
/**
- * Set the stream buffer
- * @param sb stream buffer
+ * register a logging callback. Note callbacks are run in a
+ * dedicated thread, so callbacks which pass data to other threads
+ * must use appropriate locking.
*/
- void set_sb( std::streambuf* sb );
-
-#ifdef _MSC_VER
- static void has_no_console() { has_console = false; }
-#endif
-
-protected:
-
- /** sync/flush */
- inline virtual int sync();
-
- /** overflow */
- int_type overflow( int ch );
- // int xsputn( const char* s, istreamsize n );
-
-private:
-
- // The streambuf used for actual output. Defaults to cerr.rdbuf().
- static std::streambuf* sbuf;
-
- static bool logging_enabled;
-#ifdef _MSC_VER
- static bool has_console;
-#endif
- static sgDebugClass logClass;
- static sgDebugPriority logPriority;
+ void addCallback(simgear::LogCallback* cb);
+
+ void removeCallback(simgear::LogCallback* cb);
private:
+ // constructor
+ logstream();
- // Not defined.
- logbuf( const logbuf& );
- void operator= ( const logbuf& );
-};
-
-inline int
-logbuf::sync()
-{
- return sbuf->pubsync();
-}
-
-inline void
-logbuf::set_log_state( sgDebugClass c, sgDebugPriority p )
-{
- logging_enabled = ((c & logClass) != 0 && p >= logPriority);
-}
-
-inline bool
-logbuf::would_log( sgDebugClass c, sgDebugPriority p ) const
-{
- return ((c & logClass) != 0 && p >= logPriority);
-}
-
-inline logbuf::int_type
-logbuf::overflow( int c )
-{
-#ifdef _MSC_VER
- if ( logging_enabled ) {
- if ( !has_console ) {
- AllocConsole();
- freopen("conin$", "r", stdin);
- freopen("conout$", "w", stdout);
- freopen("conout$", "w", stderr);
- has_console = true;
- }
- return sbuf->sputc(c);
- }
- else
- return EOF == 0 ? 1: 0;
-#else
- return logging_enabled ? sbuf->sputc(c) : (EOF == 0 ? 1: 0);
-#endif
-}
-
-/**
- * logstream manipulator for setting the log level of a message.
- */
-struct loglevel
-{
- loglevel( sgDebugClass c, sgDebugPriority p )
- : logClass(c), logPriority(p) {}
-
- sgDebugClass logClass;
- sgDebugPriority logPriority;
-};
-
-/**
- * A helper class that ensures a streambuf and ostream are constructed and
- * destroyed in the correct order. The streambuf must be created before the
- * ostream but bases are constructed before members. Thus, making this class
- * a private base of logstream, declared to the left of ostream, we ensure the
- * correct order of construction and destruction.
- */
-struct logstream_base
-{
- // logstream_base( streambuf* sb ) : lbuf(sb) {}
- logstream_base() {}
-
- logbuf lbuf;
-};
-
-/**
- * Class to manage the debug logging stream.
- */
-class logstream : private logstream_base, public std::ostream
-{
-public:
- /**
- * The default is to send messages to cerr.
- * @param out output stream
- */
- logstream( std::ostream& out )
- // : logstream_base(out.rdbuf()),
- : logstream_base(),
- std::ostream(&lbuf) { lbuf.set_sb(out.rdbuf());}
-
- /**
- * Set the output stream
- * @param out output stream
- */
- void set_output( std::ostream& out ) { lbuf.set_sb( out.rdbuf() ); }
-
- /**
- * Set the global log class and priority level.
- * @param c debug class
- * @param p priority
- */
- void setLogLevels( sgDebugClass c, sgDebugPriority p );
-
- bool would_log( sgDebugClass c, sgDebugPriority p ) const
- {
- return lbuf.would_log( c, p );
- };
-
- /**
- * Output operator to capture the debug level and priority of a message.
- * @param l log level
- */
- inline std::ostream& operator<< ( const loglevel& l );
- friend logstream& sglog();
- static logstream *initGlobalLogstream();
-protected:
- static logstream *global_logstream;
+ std::vector<std::string> popup_msgs;
};
-inline std::ostream&
-logstream::operator<< ( const loglevel& l )
-{
- lbuf.set_log_state( l.logClass, l.logPriority );
- return *this;
-}
+logstream& sglog();
-/**
- * \relates logstream
- * Return the one and only logstream instance.
- * We use a function instead of a global object so we are assured that cerr
- * has been initialised.
- * @return current logstream
- */
-inline logstream&
-sglog()
-{
- return *logstream::initGlobalLogstream();
-}
/** \def SG_LOG(C,P,M)
* @param P priority
* @param M message
*/
+# define SG_LOGX(C,P,M) \
+ do { if(sglog().would_log(C,P)) { \
+ std::ostringstream os; os << M; \
+ sglog().log(C, P, __FILE__, __LINE__, os.str()); \
+ if (P == SG_POPUP) sglog().popup(os.str()); \
+ } } while(0)
#ifdef FG_NDEBUG
-# define SG_LOG(C,P,M)
+# define SG_LOG(C,P,M) do { if(P == SG_POPUP) SG_LOGX(C,P,M) } while(0)
#else
-# define SG_LOG(C,P,M) do { \
- logstream& __tmplogstreamref(sglog()); \
- if(__tmplogstreamref.would_log(C,P)) { \
- __tmplogstreamref << loglevel(C,P) << M << std::endl; } \
- } while(0)
+# define SG_LOG(C,P,M) SG_LOGX(C,P,M)
#endif
#define SG_ORIGIN __FILE__ ":" SG_STRINGIZE(__LINE__)
projects / simgear.git / blobdiff