Logger.hpp

Go to the documentation of this file.

/***************************************************************************
  tag: Peter Soetens  Mon Jan 10 15:59:16 CET 2005  Logger.hpp

                        Logger.hpp -  description
                           -------------------
    begin                : Mon January 10 2005
    copyright            : (C) 2005 Peter Soetens
    email                : peter.soetens@mech.kuleuven.ac.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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 General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef ORO_CORELIB_lOGGER_HPP
#define ORO_CORELIB_lOGGER_HPP

#include "rtt-config.h"
#ifndef OROBLD_DISABLE_LOGGING
#include <ostream>
#include <sstream>
#else
#include <iosfwd>
#endif
#include <string>
#ifndef OROSEM_PRINTF_LOGGING
#include <iostream>            // for std::cerr
#endif

#include "os/TimeService.hpp"
#include "os/Mutex.hpp"
#include "os/MutexLock.hpp"

namespace RTT
{
    class RTT_API Logger
    {
        struct D;
        D* d;
        os::Mutex& inpguard;
        std::ostream& logline;
        std::ostream& fileline;
    public:

        os::TimeService::ticks getReferenceTime()const;

        enum LogLevel { Never = 0, Fatal, Critical, Error, Warning, Info, Debug, RealTime };

        void allowRealTime();

        void disallowRealTime();

        void mayLogStdOut(bool tf);

        void mayLogFile(bool tf);

        struct RTT_API In {
            In(const std::string& module);
            ~In();
            std::string oldmod;
        };

        Logger& in(const std::string& modname);

        Logger& out(const std::string& modname);

        std::string getLogModule() const;

        typedef std::ostream& (*LogFunction)(std::ostream&);

        static std::ostream& nl(std::ostream& __os);

        /*
         * Insert a newline '\n' in the ostream and flush. (Copy of the standard)
         */
        static std::ostream& endl(std::ostream& __os);

        static std::ostream& flush(std::ostream& __os);

        static Logger* Instance(std::ostream& str=std::cerr);

        static void Release();

        static Logger& log();

        static Logger& log(LogLevel ll);

        void startup();

        void shutdown();

        std::string getLogLine();

        void setStdStream( std::ostream& stdos  );

        template< class T>
        Logger& operator<<( const T &t );

        Logger& operator<<(LogLevel ll);

        Logger& operator<<(const std::string&);

        Logger& operator<<(const char*);

        Logger& operator<<(std::ostream& (*pf)(std::ostream&));

        void setLogLevel( LogLevel ll );

        LogLevel getLogLevel() const;

        void logflush();

        void logendl();

        void lognl();

#ifdef  OROSEM_LOG4CPP_LOGGING

        static const std::string log4cppCategoryName;
#endif

    private:
        bool mayLog() const;
        bool mayLogStdOut() const;
        bool mayLogFile() const;

        Logger(std::ostream& str=std::cerr);
        ~Logger();

        static Logger* _instance;
    };

    enum LoggerLevel { Never = 0, Fatal, Critical, Error, Warning, Info, Debug, RealTime };

    static inline Logger& log() { return Logger::log(); }

    static inline Logger& log(LoggerLevel ll) { return Logger::log(Logger::LogLevel(ll)); }

    static inline Logger::LogFunction endlog() {return Logger::endl; }

    static inline Logger::LogFunction endlog(LoggerLevel ll) { log(ll); return Logger::endl; }

    static inline Logger::LogFunction nlog() {return Logger::nl; }

    static inline Logger::LogFunction flushlog() {return Logger::flush; }
}

#include "Logger.inl"

#endif