DebugStream.h

// -*- C++ -*-

// Created by Lars Gullik BjЬnnes
// Copyright 1999 Lars Gullik BjЬnnes (larsbj@lyx.org)
// Released into the public domain.

// Implemented and tested on g++ 2.7.2.3

// Primarily developed for use in the LyX Project http://www.lyx.org/
// but should be adaptable to any project.

// (c) 2002 adapted for UniSet by Lav, GNU LGPL license
// Modify for UniSet by pv@eterspft.ru, GNU LGPL license

#ifndef DEBUGSTREAM_H
#define DEBUGSTREAM_H

//#ifdef __GNUG__
//#pragma interface
//#endif

#include <iostream>
#include <string>
#include <sigc++/sigc++.h>
#include "Debug.h"

#ifdef TEST_DEBUGSTREAM
#include <string>
struct Debug
{
    enum type
    {
        NONE = 0,
        INFO       = (1 << 0),   // 1
        WARN       = (1 << 1),   // 2
        CRIT       = (1 << 2)   // 4
    };
    static const type ANY = type(INFO | WARN | CRIT);
    static Debug::type value(std::string const& val)
    {
        if (val == "NONE") return Debug::NONE;

        if (val == "INFO") return Debug::INFO;

        if (val == "WARN") return Debug::WARN;

        if (val == "CRIT") return Debug::CRIT;

        return Debug::NONE;
    }
};
#endif

class DebugStream : public std::ostream
{
    public:
        explicit DebugStream(Debug::type t = Debug::NONE);

        explicit
        DebugStream(char const* f, Debug::type t = Debug::NONE, bool truncate = false );

        virtual ~DebugStream();

        typedef sigc::signal<void, const std::string&> StreamEvent_Signal;
        StreamEvent_Signal signal_stream_event();

        void level(Debug::type t) noexcept
        {
            dt = Debug::type(t & Debug::ANY);
        }

        Debug::type level() const noexcept
        {
            return dt;
        }

        void addLevel(Debug::type t) noexcept
        {
            dt = Debug::type(dt | t);
        }

        void delLevel(Debug::type t) noexcept
        {
            dt = Debug::type(dt & ~t);
        }

        virtual void logFile( const std::string& f, bool truncate = false );

        inline std::string getLogFile() const noexcept
        {
            return fname;
        }

        // имя лог файла можно установить отдельно, но не вклчать запись..
        inline void setLogFile( const std::string& n ) noexcept
        {
            fname = n;
        }

        // включена ли запись лог-файла
        inline bool isOnLogFile() const noexcept
        {
            return isWriteLogFile;
        }

        // включить запись лог файла
        inline void onLogFile( bool truncate = false )
        {
            logFile(fname, truncate);
        }

        // отключить запись логфайла
        inline void offLogFile() noexcept
        {
            logFile("");
        }

        inline bool debugging(Debug::type t = Debug::ANY) const noexcept
        {
            return (dt & t);
        }

        std::ostream& debug(Debug::type t = Debug::ANY) noexcept;
        //        if (dt & t) return *this;
        //        return nullstream;
        //    }


        std::ostream& operator[](Debug::type t) noexcept
        {
            return debug(t);
        }

        inline std::ostream& to_end(Debug::type t) noexcept
        {
            return this->operator()(t);
        }

        std::ostream& operator()(Debug::type t) noexcept;

        inline void showDateTime(bool s) noexcept
        {
            show_datetime = s;
        }

        inline void showMilliseconds( bool s ) noexcept
        {
            show_msec = s;
        }

        inline void showMicroseconds( bool s ) noexcept
        {
            show_usec = s;
        }

        inline void showLogType(bool s) noexcept
        {
            show_logtype = s;
        }

        inline std::ostream& log(Debug::type l) noexcept
        {
            return this->operator[](l);
        }

        // короткие функции (для удобства)
        // log.level1()  - вывод с датой и временем  "date time [LEVEL] ...",
        //    если вывод даты и времени не выключен при помощи showDateTime(false)
        // if( log.is_level1() ) - проверка включён ли лог.."

#define DMANIP(FNAME,LEVEL) \
    inline std::ostream& FNAME( bool showdatetime=true ) noexcept \
    {\
        if( showdatetime )\
            return operator[](Debug::LEVEL); \
        return  operator()(Debug::LEVEL); \
    } \
    \
    inline bool is_##FNAME() const  noexcept\
    { return debugging(Debug::LEVEL); }

        DMANIP(level1, LEVEL1)
        DMANIP(level2, LEVEL2)
        DMANIP(level3, LEVEL3)
        DMANIP(level4, LEVEL4)
        DMANIP(level5, LEVEL5)
        DMANIP(level6, LEVEL6)
        DMANIP(level7, LEVEL7)
        DMANIP(level8, LEVEL8)
        DMANIP(level9, LEVEL9)
        DMANIP(info, INFO)
        DMANIP(warn, WARN)
        DMANIP(crit, CRIT)
        DMANIP(repository, REPOSITORY)
        DMANIP(system, SYSTEM)
        DMANIP(exception, EXCEPTION)
        DMANIP(any, ANY)
#undef DMANIP

        std::ostream& printDate(Debug::type t, char brk = '/') noexcept;
        std::ostream& printTime(Debug::type t, char brk = ':') noexcept;
        std::ostream& printDateTime(Debug::type t) noexcept;

        std::ostream& pos(int x, int y) noexcept;

        const DebugStream& operator=(const DebugStream& r);

        inline void setLogName( const std::string& n ) noexcept
        {
            logname = n;
        }

        inline std::string  getLogName() const noexcept
        {
            return logname;
        }

        // ------------------------------------------------------------------------------------------------
        // RAII
        // https://stackoverflow.com/questions/2273330/restore-the-state-of-stdcout-after-manipulating-it
        class IosFlagSaver
        {
            public:
                explicit IosFlagSaver(std::ostream& _ios):
                    ios(_ios),
                    f(_ios.flags())
                {
                }
                ~IosFlagSaver()
                {
                    ios.flags(f);
                }

                IosFlagSaver(const IosFlagSaver& rhs) = delete;
                IosFlagSaver& operator= (const IosFlagSaver& rhs) = delete;

            private:
                std::ostream& ios;
                std::ios::fmtflags f;
        };
        // ------------------------------------------------------------------------------------------------

    protected:
        void sbuf_overflow( const std::string& s ) noexcept;

        // private:
        Debug::type dt = { Debug::NONE };
        std::ostream nullstream;
        struct debugstream_internal;
        debugstream_internal* internal = { 0 };
        bool show_datetime = { true };
        bool show_logtype = { true };
        bool show_msec = { false };
        bool show_usec = { false };
        std::string fname = { "" };

        StreamEvent_Signal s_stream;
        std::string logname = { "" };

        bool isWriteLogFile = { false };
};
// ------------------------------------------------------------------------------------------------
#endif