Log.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
 
#ifndef DRAIN_LOG_H_
#define DRAIN_LOG_H_
 
#include <cstddef> // nullptr
#include <stdlib.h>
#include <sstream>
#include <string>
#include <iostream>
#include <fstream>
#include <stdexcept>
 
//#include <ctime>
#include <sys/time.h>
#include <string.h> // strrchr()
 
#include <syslog.h>
#include <map>
 
#include "StringBuilder.h"
// #include "TextStyle.h"
#include "TextStyleVT100.h"
/*
#define LOG_EMERG   0   // system is unusable //
#define LOG_ALERT   1   // action must be taken immediately //  RACK examples
#define LOG_CRIT    2   // critical conditions //
#define LOG_ERR     3   // error conditions //              //  File read/write failed
#define LOG_WARNING 4   // warning conditions //            //  HDF5 empty or contains no relevant data
#define LOG_NOTICE  5   // normal but significant condition //  No volumes used for a composite
#define LOG_INFO    6   // informational //                 //  Read/Write File, start/end of operator
#define LOG_DEBUG   7   // debug-level messages             //  Store variable
                   10                                       //  Write control files (function input, output)
                   11                                       //  Write intermediate results in files
                   15                                       //  Debug 1D loops
                   20                                       //  Debug 2D loops
 
Compare with Python: https://docs.python.org/3/library/logging.html#logging-levels
 */
 
 
/*
#ifdef __GNUC__
    inline std::string className(const std::string & prettyFunction)
    {
        const size_t colons = prettyFunction.find("::");
        if (colons == std::string::npos){
            return "::";
        }
        else {
            const size_t begin = prettyFunction.substr(0, colons).rfind(" ") + 1;
            const size_t end = colons - begin;
            return prettyFunction.substr(begin,end);
        }
}
#define CLASSNAME className(__PRETTY_FUNCTION__)
#else
#define CLASSNAME __FILE__
#endif
*/
 
namespace drain {
 
// using namespace std;
 
struct Notification {
 
    /*
    Notification(const std::string & key="", int vt100color=35){
        set(key, vt100color);
    };
    */
 
    template <typename ... T>
    Notification(const std::string & key, const T &... args){
 
        this->key = key;
 
        TextStyleVT100 vt100;
        std::stringstream sstr;
        //vt100.write(sstr, args..., key);
        vt100.append(sstr, args...);
        vt100color = sstr.str();
    };
 
 
    //void set(const std::string & key, int vt100color);
 
 
    std::string key;
    std::string vt100color;
 
};
 
// extern unsigned int Debug;  // getting obsolete
 
class Logger;
 
 
class Log  {
 
public:
 
    typedef unsigned short level_t;
 
    //typedef std::vector<Notification> notif_dict_t;
    typedef std::map<int,std::string> status_dict_t;
 
    const
    static status_dict_t statusDict;
 
    // experimental
    int id = 0;
 
 
    inline
    Log(std::ostream & ostr=std::cerr, int verbosityLevel=LOG_WARNING) : ostrPtr(&ostr), verbosityLevel(verbosityLevel) // VT100(true),
    {
        resetTime();
        //std::cerr << "start monitor, level=" << verbosityLevel << std::endl;
    };
 
    inline
    Log(const Log &m) : ostrPtr(m.ostrPtr), verbosityLevel(m.verbosityLevel) { // VT100(m.VT100),
        resetTime();
    };
 
    inline
    ~Log(){
        close(); // Note: external ofstream will not be closed.
        /*
        if (ostrPtr != nullptr){ // it never is...
            ostrPtr->close();
        }
        */
    }
 
 
    inline
    void setOstr(std::ostream & ostr){
        /*
        if (ostrPtr != nullptr){ // it never is...
            ostrPtr->close();
        }
        */
        close();
        ostrPtr = &ostr;
    }
 
    inline
    void setOstr(const std::string & filename){
        /*
        if (ostrPtr != nullptr){ // it never is...
            ostrPtr->close();
        }
        */
        close();
        ofstr.open(filename, std::ios::out);
        ostrPtr = &ofstr;
    }
 
    void close(){
        if (ofstr.is_open()){
            ostrPtr = nullptr; // or what, std::cerr ?
            ofstr.close();
        }
    }
 
    //
    inline
    void setVerbosity(level_t level){
        verbosityLevel = level;
    };
 
    void setVerbosity(const std::string & level);
 
    inline
    int getVerbosity() const {
        return verbosityLevel;
    };
 
    void flush(level_t level, const std::string & prefix, const std::stringstream & sstr);
 
    //void flush(level_t level, const Notification & notif, const std::string & prefix, const std::ostream & sstr);
    void flush(level_t level, const Notification & notif, const std::string & prefix, const std::stringstream & sstr);
 
 
    inline
    long getRelativeMilliseconds(){
        return getMilliseconds() - millisecondsStart;
    }
 
    static inline
    long getMilliseconds(){
        timeval time;
        gettimeofday(&time, NULL);
        return (time.tv_sec * 1000) + (time.tv_usec / 1000);
    }
 
    inline
    void resetTime(){
        millisecondsStart = getMilliseconds();
    };
 
    static
    bool USE_VT100; // = true;
 
    // static
    // const notif_dict_t & getDict();
 
protected:
 
    std::ostream *ostrPtr;
 
    std::ofstream ofstr;
 
    level_t verbosityLevel;
 
    long millisecondsStart;
 
    //drain::Dictionary<int, Notification> dict;
 
};
 
//extern Log monitor;
 
Log & getLog();
 
namespace image {
 
Log & getImgLog();
 
}  // namespace image
 
 
class DrainException : public std::runtime_error {
 
public:
 
 
 
    // Either this or previous is unneeded?
    template<typename T,typename ... TT>
    DrainException(const T &elem, const TT &... rest) : std::runtime_error(drain::StringBuilder<>(elem, rest...)){
    }
 
 
};
 
#define DRAIN_LOG_VAR(name) '#', #name, '=', name
 
 
//class Logger : public std::stringstream {
class Logger : public StreamBuilder<0> {
 
    std::stringstream & message;
 
public:
 
 
 
    typedef Log::level_t level_t;
 
 
    template <typename ... TT>
    Logger(const char *filename, const TT & ...args);
    //Logger(const char *filename, const std::string & name = "");
 
 
    template <typename ... TT>
    Logger(Log &log, const char *filename, const TT & ...args); //const char *className = NULL);
    //Logger(Log &log, const char *filename, const std::string & name = ""); //const char *className = NULL);
 
    ~Logger();
 
 
    inline
    bool isLevel(level_t l){
        return (monitor.getVerbosity() >= l);
    };
 
 
    inline
    bool isDebug(level_t l=0){
        return isLevel(LOG_DEBUG+l);
        //return (monitor.getVerbosity() >= (LOG_DEBUG+l));
    };
 
 
 
    template <int L, typename ... TT>
    inline
    Logger & start(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::DIM); //, TextStyle::BOLD
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<typename ... TT>
    inline
    Logger & quit(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::PURPLE, TextStyle::REVERSE, TextStyle::BOLD);
        initMessage<LOG_EMERG>(notif);
        flush(args...);
        return *this;
    };
 
    template<typename ... TT>
    inline
    Logger & alert(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::PURPLE, TextStyle::BOLD);
        initMessage<LOG_ALERT>(notif);
        flush(args...);
        return *this;
    };
 
    template<typename ... TT>
    inline
    Logger & critical(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::RED, TextStyle::REVERSE);
        initMessage<LOG_CRIT>(notif);
        flush(args...);
        return *this;
    };
 
    /*
    inline
    Logger & error(){
        return initMessage<LOG_ERR>();
    };
    */
 
    template<typename ... TT>
    inline
    Logger & error(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::RED, TextStyle::BOLD);
        // error();
        initMessage<LOG_ERR>(notif);
        flush(args...);
        return *this;
    };
 
 
    // LOG_WARNING
 
    template<typename ... TT>
    inline
    Logger & warn(const TT &... args){
        // warn();
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::BOLD);
        initMessage<LOG_WARNING>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_WARNING,typename ... TT>
    inline
    Logger & discouraged(const TT &... args){
        //static const Notification notif(__FUNCTION__, 35);
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_WARNING,typename ... TT>
    inline
    Logger & fail(const TT &... args){
        //static const Notification notif(__FUNCTION__, 33);
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    //  Valid alternative should be displayed.
    template<int L=LOG_WARNING,typename ... TT>
    inline
    Logger & obsolete(const TT &... args){
        //static const Notification notif(__FUNCTION__, 35);
        static const Notification notif(__FUNCTION__, TextStyle::PURPLE, TextStyle::DIM, TextStyle::UNDERLINE);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_WARNING,typename ... TT>
    inline
    Logger & attention(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::CYAN, TextStyle::REVERSE, TextStyle::DIM); // 46);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    // LOG_NOTICE
 
    template<typename ... TT>
    inline
    Logger & note(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::BOLD);
        initMessage<LOG_NOTICE>(notif);
        //initMessage<LOG_NOTICE>();
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & suspicious(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & unimplemented(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::OVERLINE); // , 35);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & deprecating(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::DIM, TextStyle::UNDERLINE); //33);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & special(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::CYAN); //36);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & experimental(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::CYAN, TextStyle::REVERSE); // 94);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_NOTICE,typename ... TT>
    inline
    Logger & advice(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::UNDERLINE);// 40);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    // LOG_INFO
 
    template<typename ... TT>
    inline
    Logger & info(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::WHITE); //32);
        initMessage<LOG_INFO>(notif);
        // initMessage<LOG_INFO>();
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & ok(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::GREEN); //32);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & accept(const TT &... args){
        //static const Notification notif(__FUNCTION__, 42);
        static const Notification notif(__FUNCTION__, TextStyle::GREEN, TextStyle::REVERSE, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & pending(const TT &... args){
        //static const Notification notif(__FUNCTION__, 42);
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::REVERSE, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & reject(const TT &... args){
        // static const Notification notif(__FUNCTION__, 41);
        static const Notification notif(__FUNCTION__, TextStyle::RED, TextStyle::REVERSE, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & success(const TT &... args){
        // static const Notification notif(__FUNCTION__, 92);
        static const Notification notif(__FUNCTION__, TextStyle::GREEN, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & hint(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::CYAN, TextStyle::DIM, TextStyle::UNDERLINE);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
 
    template<int L=LOG_INFO,typename ... TT>
    inline
    Logger & revised(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::YELLOW, TextStyle::DIM);
        initMessage<L>(notif);
        flush(args...);
        return *this;
    };
 
    /*
    template<typename ... TT>
    inline
    Logger & timing(const TT &... args){
        static const Notification notif(__FUNCTION__, 7);
        if (TIMING){ // ok here (also?)
            initMessage<LOG_WARNING>(notif); // can be low, say WARNING level, because restricted with TIMING
            flush(args...);
            //std::cerr << args...;
        };
        return *this;
    };
    */
 
 
 
    template<typename ... TT>
    inline
    Logger & debug(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::DIM);
        initMessage<LOG_DEBUG>(notif);
        flush(args...);
        return *this;
    };
 
    template<typename ... TT>
    inline
    Logger & debug2(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::DIM, TextStyle::ITALIC);
        initMessage<LOG_DEBUG+1>(notif);
        flush(args...);
        return *this;
    };
 
    template<typename ... TT>
    inline
    Logger & debug3(const TT &... args){
        static const Notification notif(__FUNCTION__, TextStyle::CYAN, TextStyle::DIM, TextStyle::ITALIC);
        initMessage<LOG_DEBUG+2>(notif);
        flush(args...);
        return *this;
    };
 
 
    /*
    inline
    Logger & debug(level_t level){
        static const Notification notif("DEBUG*", 49);
        return initMessage<LOG_DEBUG+1>(notif); // obsolete
        //return *this;
    };
    */
 
    inline
    Logger & log(level_t level){
        initMessage(level); // avoid
        return *this;
    };
 
    // Experimental! For mout.log(level)(args); !
    template<typename ... TT>
    inline
    Logger & operator()(const TT &... args){
        flush(args...);
        return *this;
    };
 
 
    static bool TIMING; // = false;
    static char MARKER;
 
    bool timing;
 
    //Logger & timestamp(const std::string & label);
 
    inline
    void startTiming(){
        if (TIMING && !timing){
            initTiming(this->prefix);
        }
    };
 
    template<typename ... TT>
    void startTiming(const TT &... args){
        if (TIMING && !timing){  // consider error if already timing?
            initTiming(args...);
        }
    };
 
    //template<typename ... TT>
    //void endTiming(const TT &... args){
    void endTiming(){
        if (timing){
            time = monitor.getMilliseconds() - time;
            std::cerr << "TIMING:" << MARKER << "</div> ";
            //describeTiming(args...); // STORE timing label?
            // << ": "
            std::cerr << "<b>"  << (static_cast<float>(time)/1000.0f) << "</b>" << "<br/>" << '\n';
            /*
            std::cerr << "TIMING:" << MARKER << "</ol> ";
            //describeTiming(args...); // STORE timing label?
            // << ": "
            std::cerr << "<b>"  << (static_cast<float>(time)/1000.0f) << "</b>" << "</li>" << '\n';
            */
            timing = false;
        }
    }
 
 
public:
 
 
    // Logger & timestamp();
 
 
 
    Logger &operator<<(const std::ostream & sstr) {
        // TODO if (!message.empty())
        if (level <= monitor.getVerbosity())
            message << sstr.rdbuf();
        return *this;
    }
 
 
 
    template <class T>
    Logger &operator<<(const T & x) {
        //cerr << "source input:" << x << '\n';
        if (level <= monitor.getVerbosity())
            message << x;
        return *this;
    }
 
    typedef void * oper;
    static oper endl;
 
 
    inline
    void end(){
        monitor.flush(level, *notif_ptr, prefix, message);
    }
 
    inline
    Logger &operator<<(oper op){
        monitor.flush(level, *notif_ptr, prefix, message);
        return *this; // <- drop this?
    }
 
    inline
    Logger &operator<<(const Logger & l){
 
        if (&l != this){
            message << " NOTE: Logger" << __FUNCTION__ << " flush with non-this Logger";
        }
        monitor.flush(level, *notif_ptr, prefix, message);
        return *this;
    }
 
    inline
    int getVerbosity() const {
        return monitor.getVerbosity();
    };
 
protected:
 
    Log & monitor;
 
    std::string prefix;
 
    level_t level;
    time_t time;
 
    const Notification * notif_ptr;
 
protected:
 
    template<typename ... TT>
    void initTiming(const TT &... args){
        timing = true; // consider error if already timing?
        std::cerr << "TIMING:" << MARKER; // << "<li>";
        describeTiming(args...);
        // std::cerr << " [" <<  prefix  << "] <ol>" << '\n';
        //std::cerr << " <ol>" << '\n';
        std::cerr << " <div>" << '\n';
        time = monitor.getMilliseconds();
    };
 
 
    template<typename T, typename ... TT>
    void describeTiming(const T & arg, const TT &... args){
        std::cerr << arg;
        describeTiming(args...);
    };
 
    inline
    void describeTiming(){
    };
 
 
    template<typename ... TT>
    inline
    //void setPrefix(const char * filename, const char * func_name, const TT &... args){
    void setPrefix(const char * filename, const TT &... args){
 
        std::stringstream sstr;
 
        if (filename){
 
            if (*filename != '\0'){
 
                const char * s2 = strrchr(filename, '/');
                if (s2 == nullptr)
                    s2 = filename;
                else
                    ++s2;
 
                const char * s3 = strrchr(s2, '.');
                if (s3 == nullptr)
                    sstr << s2;
                    //prefix.assign(s2);
                else
                    //prefix.assign(s2, s3-s2);
                    sstr.write(s2, size_t(s3-s2));
                // prefix.append(":");
                // sstr << ':';
            }
        }
        // NEW  sstr << func_name << ": ";
        //appendPrefix(sstr, func_name, args...);
        appendPrefix(sstr, args...);
        prefix = sstr.str();
    }
 
    /*
    template<typename T, typename ... TT>
    inline
    void setPrefix(const TT &... args){
        std::stringstream sstr;
        appendPrefix(sstr, args...);
        prefix = sstr.str();
    }
    */
 
 
    inline
    void appendPrefix(std::stringstream & sstr){
    }
 
    template<typename T, typename ... TT>
    void appendPrefix(std::stringstream & sstr, const T & arg, const TT &... args){
        sstr << ":" << arg;
        appendPrefix(sstr, args...);
    }
 
    template <level_t L>
    Logger & initMessage(const Notification & notif){
        this->notif_ptr = & notif;
        this->level = L;
        this->message.str("");
        return *this;
    }
    //void initMessage(level_t level);
 
    /*
    template <level_t L>
    Logger & initMessage(){
 
        static
        const Notification & notif = Log::getDict()[L];
 
        this->notif_ptr = &notif;
        this->level = L;
        this->message.str("");
        return *this;
    }
    */
 
    Logger & initMessage(level_t level);
 
    /*
    inline
    Logger & initMessage(level_t level){
        static const Notification notif(__FUNCTION__); // TextStyle::DIM, TextStyle::ITALIC);
        this->notif_ptr = & notif; // Log::getDict()[level];
        this->level = level;
        this->message.str("");
        return *this;
    }
    */
 
    template<typename T, typename ... TT>
    inline
    Logger & flush(const T & arg, const TT &... rest){
        //*this << arg;
        append(arg);
        flush(rest...);
        return *this;
    };
 
    template<typename T>
    inline
    Logger & flush(const T & arg){
        // *this << arg;
        append(arg);
        monitor.flush(level, *notif_ptr, prefix, message);
        return *this;
    };
 
    inline
    Logger & flush(){
        return *this;
    };
 
    template<typename T>
    inline
    void append(const T & arg){
        *this << arg;
    }
 
    /*
    inline
    Logger & flush(){
        monitor.flush(level, *notif_ptr, prefix, message);
        return *this;
    };
    */
 
 
};
 
 
template <>
inline
void Logger::append(const TextStyle::Colour & colour){
    *this << "<color>";
}
 
 
template <typename ... TT>
Logger::Logger(const char *filename, const TT & ...args):
                message(*this),
                timing(false),
                monitor(getLog()),
                level(LOG_NOTICE),
                time(getLog().getMilliseconds()),
                notif_ptr(NULL){
    setPrefix(filename, args...);
}
 
template <typename ... TT>
Logger::Logger(Log &log, const char *filename, const TT & ...args):
                message(*this),
                timing(false),
                monitor(log),
                level(LOG_NOTICE),
                time(log.getMilliseconds()),
                notif_ptr(NULL){
    setPrefix(filename, args...);
}
//std::ostream &operator<<(std::ostream &ostr, const Log &error);
 
 
}
 
//const std::string FEELU(__FILE__);
 
#endif /* DEBUG_H_ */
 
// Drain