rippled/beast/utility/Journal.h

//------------------------------------------------------------------------------
/*
    This file is part of Beast: https://github.com/vinniefalco/Beast
    Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>

    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.

    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================

#ifndef BEAST_UTILITY_JOURNAL_H_INCLUDED
#define BEAST_UTILITY_JOURNAL_H_INCLUDED

#include <sstream>

namespace beast
{

/** A generic endpoint for log messages. */
class Journal
{
public:
    class Sink;

private:
    Sink* m_sink;

public:
    /** Severity level of the message. */
    enum Severity
    {
        kLowestSeverity = 0,
        kTrace = kLowestSeverity,
        kDebug,
        kInfo,
        kWarning,
        kError,
        kFatal,

        kDisabled
    };

    //--------------------------------------------------------------------------

    /** Abstraction for the underlying message destination. */
    class Sink
    {
    public:
        virtual ~Sink () { }

        /** Write text to the sink at the specified severity. */
        virtual void write (Severity severity, std::string const& text) = 0;

        /** Returns `true` if text at the passed severity produces output. */
        virtual bool active (Severity severity) = 0;

        /** Returns `true` if a message is also written to the Output Window (MSVC). */
        virtual bool console () = 0;

        /** Set the minimum severity this sink will report. */
        virtual void set_severity (Severity severity) = 0;

        /** Set whether messages are also written to the Output Window (MSVC). */
        virtual void set_console (bool to_console) = 0;
    };

    /** Returns a Sink which does nothing. */
    static Sink& getNullSink ();

    //--------------------------------------------------------------------------
    
    class Stream;

    /** Scoped ostream-based container for writing messages to a Journal. */
    class ScopedStream
    {
    public:
        explicit ScopedStream (Stream const& stream);
        ScopedStream (ScopedStream const& other);

        template <typename T>
        ScopedStream (Stream const& stream, T const& t)
            : m_sink (stream.sink())
            , m_severity (stream.severity())
        {
            m_ostream << t;
        }

        ScopedStream (Stream const& stream, std::ostream& manip (std::ostream&));

        ~ScopedStream ();

        std::ostringstream& ostream () const;

        std::ostream& operator<< (std::ostream& manip (std::ostream&)) const;

        template <typename T>
        std::ostream& operator<< (T const& t) const
        {
            return m_ostream << t;
        }

    private:
        ScopedStream& operator= (ScopedStream const&); // disallowed

        Sink& m_sink;
        Severity const m_severity;
        std::ostringstream mutable m_ostream;
        bool m_toOutputWindow;
    };

    //--------------------------------------------------------------------------

    class Stream
    {
    public:
        /** Construct a stream which produces no logging output. */
        Stream ();

        /** Construct a stream that writes to the Sink at the given Severity. */
        Stream (Sink& sink, Severity severity);

        /** Construct or copy another Stream. */
        /** @{ */
        Stream (Stream const& other);
        Stream& operator= (Stream const& other);
        /** @} */

        /** Returns the Sink that this Stream writes to. */
        Sink& sink() const;

        /** Returns the Severity of messages this Stream reports. */
        Severity severity() const;

        /** Returns `true` if sink logs anything at this stream's severity. */
        bool active() const;

        /** Output stream support. */
        /** @{ */
        ScopedStream operator<< (std::ostream& manip (std::ostream&)) const;

        template <typename T>
        ScopedStream operator<< (T const& t) const
        {
            return ScopedStream (*this, t);
        }
        /** @} */

    private:
        Sink* m_sink;
        Severity m_severity;
    };

    //--------------------------------------------------------------------------

    Journal ();
    explicit Journal (Sink& sink);
    Journal (Journal const& other);
    ~Journal ();

    /** Returns the Sink associated with this Journal. */
    Sink& sink() const;

    /** Returns a stream for this sink, with the specified severity. */
    Stream stream (Severity severity) const;

    /** Returns `true` if any message would be logged at this severity level. */
    bool active (Severity severity) const;

    /** Convenience sink streams for each severity level. */
    Stream const trace;
    Stream const debug;
    Stream const info;
    Stream const warning;
    Stream const error;
    Stream const fatal;

private:
    Journal& operator= (Journal const& other); // disallowed
};

}

#endif