include/dlvhex2/Logger.h

Go to the documentation of this file.

/* dlvhex -- Answer-Set Programming with external interfaces.
 * Copyright (C) 2005-2007 Roman Schindlauer
 * Copyright (C) 2006-2015 Thomas Krennwallner
 * Copyright (C) 2009-2016 Peter Schüller
 * Copyright (C) 2011-2016 Christoph Redl
 * Copyright (C) 2015-2016 Tobias Kaminski
 * Copyright (C) 2015-2016 Antonius Weinzierl
 *
 * This file is part of dlvhex.
 *
 * dlvhex is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * dlvhex is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with dlvhex; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 */

#ifndef LOGGER_HPP_INCLUDED__17092010
#define LOGGER_HPP_INCLUDED__17092010

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "dlvhex2/PlatformDefinitions.h"

#include <boost/preprocessor/cat.hpp>
#include <boost/optional.hpp>
#include <boost/cstdint.hpp>

#include <boost/thread/mutex.hpp>
#include <boost/thread/tss.hpp>

#ifndef NDEBUG
# define LOG_SCOPED_LOCK(varname) boost::mutex::scoped_lock varname(Logger::Mutex());
#else
# define LOG_SCOPED_LOCK(varname) do { } while(false)
#endif

#include <iostream>
#include <iomanip>
#include <sstream>

class DLVHEX_EXPORT Logger
{
    public:
        typedef uint32_t Levels;
        static const Levels DBG =     0x01;
        static const Levels INFO =    0x02;
        static const Levels WARNING = 0x04;
        static const Levels ERROR =   0x08;

        // this is now very dlvhex-specific
        static const Levels PLUGIN =  0x10;
        static const Levels ANALYZE = 0x20;
        static const Levels MODELB =  0x40;
        static const Levels STATS  =  0x80;

    private:
        std::ostream& out;
        boost::thread_specific_ptr<std::string> indent;
        Levels printlevels;
        int levelwidth;

    private:
        Logger():
        out(std::cerr), printlevels(~static_cast<Levels>(0)), levelwidth(1) {}

        ~Logger() {
            stream() << std::endl;
            startline(DBG);
        #ifndef NDEBUG
            stream() << "clean exit!" << std::endl;
        #endif
        }

    public:
        static Logger& Instance();
        static boost::mutex& Mutex();

        inline std::ostream& stream()
            { return out; }

        void setPrintLevels(Levels levels);
        void setPrintLevelWidth(int width);
        Levels getPrintLevels() const;

        inline void startline(Levels forlevel) {
            if (!indent.get()) indent.reset(new std::string(""));
            if( levelwidth == 0 ) {
                out << *indent;
            }
            else {
                out << std::hex << std::setw(levelwidth) << forlevel << std::dec << " " << *indent;
            }
        }

        inline bool shallPrint(Levels forlevel)
            { return (printlevels & forlevel) != 0; }

        friend class Closure;
        class Closure
        {
            private:
                Logger& l;
                Levels level;
                unsigned cutoff;
                bool message;

                inline void sayHello() {
                    // hello message
                    if( message ) {
                        l.startline(level);
                        l.stream() << "ENTRY" << std::endl;
                    }
                }

                inline void sayGoodbye() {
                    // goodbye message
                    if( message ) {
                        l.startline(level);
                        l.stream() << "EXIT" << std::endl;
                    }
                }

            public:
                Closure(Logger& l, Levels level, const std::string& str, bool message):
                l(l), level(level), message(message) {
                    if (!l.indent.get()) l.indent.reset(new std::string(""));
                    cutoff = l.indent->size();

                    if( l.shallPrint(level) ) {
                        LOG_SCOPED_LOCK(lock);
                        *l.indent += str + " ";
                        sayHello();
                    }
                }

                Closure(Logger& l, Levels level, const std::string& str, const void* const val, bool message):
                l(l), level(level), message(message) {
                    if (!l.indent.get()) l.indent.reset(new std::string(""));
                    cutoff = l.indent->size();

                    if( l.shallPrint(level) ) {
                        LOG_SCOPED_LOCK(lock);
                        std::stringstream ss;
                        ss << str << "/" << val << " ";
                        *l.indent += ss.str();
                        sayHello();
                    }
                }

                ~Closure() {
                    if (!l.indent.get()) l.indent.reset(new std::string(""));
                    if( l.shallPrint(level) ) {
                        LOG_SCOPED_LOCK(lock);
                        sayGoodbye();
                        // restore indentation level
                        l.indent->erase(cutoff);
                    }
                }
        };

        class Init
        {
            public:
                Init(Levels levels) {
                    Logger::Instance().setPrintLevels(levels);
                }
        };
};

// the following will always be realized
//#ifndef NDEBUG
#  define LOG(level,streamout) do { LOG_SCOPED_LOCK(lock); \
        if( Logger::Instance().shallPrint(Logger:: level) ) \
        { \
            Logger::Instance().startline(Logger:: level); \
            Logger::Instance().stream() << streamout << std::endl; \
        } \
    } while(false);
#    define LOG_CLOSURE_ID BOOST_PP_CAT(log_closure_,__LINE__)
#  define LOG_INDENT(level)              Logger::Closure LOG_CLOSURE_ID (Logger::Instance(), Logger:: level, "  ", false)
#  define LOG_SCOPE(level,name,msg)      Logger::Closure LOG_CLOSURE_ID (Logger::Instance(), Logger:: level, name, msg)
#  define LOG_VSCOPE(level,name,val,msg) Logger::Closure LOG_CLOSURE_ID (Logger::Instance(), Logger:: level, name, reinterpret_cast<const void* const>(val), msg)
    /*
    #else
    #  define LOG(level,streamout)          do { } while(false)
    #  define LOG_CLOSURE_ID BOOST_PP_CAT(log_closure_,__LINE__) do { } while(false)
    #  define LOG_INDENT(level)                 do { } while(false)
    #  define LOG_SCOPE(level,name,msg)         do { } while(false)
    #  define LOG_VSCOPE(level,name,val,msg)    do { } while(false)
    #endif
    */

#  define LOG_INIT(setlevel)             namespace { Logger::Init LOG_CLOSURE_ID (setlevel); }

    // the following are debug-flag dependant
#ifndef NDEBUG
#  define DBGLOG(level,streamout)           LOG(level,streamout)
#  define DBGLOG_INDENT(level)              LOG_INDENT(level)
#  define DBGLOG_SCOPE(level,name,msg)      LOG_SCOPE(level,name,msg)
#  define DBGLOG_VSCOPE(level,name,val,msg) LOG_VSCOPE(level,name,val,msg)
#else
#  define DBGLOG(level,streamout)           do { } while(false)
#  define DBGLOG_INDENT(level)              do { } while(false)
#  define DBGLOG_SCOPE(level,name,msg)      do { } while(false)
#  define DBGLOG_VSCOPE(level,name,val,msg) do { } while(false)
#endif
#endif                           // LOGGER_HPP_INCLUDED__17092010

// vim:expandtab:ts=4:sw=4:
// mode: C++
// End: