File: LogStream.h

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (44 lines) | stat: -rw-r--r-- 1,148 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#pragma once

#include <ostream>
#include <mutex>
#include "LogStreamBuf.h"

namespace applog
{

/**
 * greebo: A LogStream is a specialised std::ostream making
 * use of a customised std::streambuf (LogStreamBuf). 
 *
 * Several application-wide LogStream instances exist, one for
 * each LogLevel. The underlying LogStreamBuf will write
 * all output to the LogWriter singleton, which in turn
 * dispatches the text to the various LogDevices.
 *
 * Application code needs to include the itextstream.h header
 * and use the rMessage(), rWarning() and rError() shortcuts
 * to stream data to the log.
 */
class LogStream :
	public std::ostream
{
private:
    static std::mutex _streamLock;
public:
    LogStream(LogLevel logLevel);

    virtual ~LogStream();

    // Gets called immediately after entering main()
    // Sets up the stream references for rMessage(), redirects std::cout, etc.
    static void InitialiseStreams(ILogWriter& logWriter);

    // Hands back the original streambuf to std::cout
    static void ShutdownStreams();

    // The one and only lock for logging
    static std::mutex& GetStreamLock();
};

} // namespace applog