User Manual, Developers Guide and API Documentation

Logger.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_LOGGER_LOGGER_HPP
#define WNS_LOGGER_LOGGER_HPP

#include <WNS/logger/Message.hpp>
#include <WNS/logger/Master.hpp>
#include <WNS/pyconfig/View.hpp>

/* The two macros defined below shall help using messages and disabling them
 * when compiling an optimized version, speak defining WNS_NO_LOGGING. Example on
 * how to use these macros (assume you've a Logger called "log" which should be
 * a member of your class where you're trying to log something):
 *
 * MESSAGE_BEGIN(NORMAL, log, specifyAnyVariableNameYouLike, "Foo");
 * specifyAnyVariableNameYouLike << "bar";
 * MESSAGE_END();
 *
 * Make sure that the code between MESSAGE_BEGIN and MESSAGE_END is only used
 * for creating the message, since it's not evaluated if you define WNS_NO_LOGGING.
 */
#ifndef WNS_NO_LOGGING

#define MESSAGE_BEGIN(L, LOGGER, M, STRINGSTREAM) { const wns::logger::Logger& neverUseThisAsLoggerName = (LOGGER); if((LOGGER).getMaster() != NULL && (LOGGER).getMaster()->isEnabled() && (LOGGER).getLevel() >= wns::logger::L) {\
wns::logger::Message M("", wns::logger::L);\
wns::logger::Message& _neverUseThis = M;\
if ((LOGGER).isShowFunction()==true) {_neverUseThis << __PRETTY_FUNCTION__ << "\n";}\
_neverUseThis << STRINGSTREAM;

#define MESSAGE_END()  neverUseThisAsLoggerName.send(_neverUseThis);}}

#define MESSAGE_SINGLE(L, LOGGER, STRINGSTREAM) { if((LOGGER).getMaster() != NULL && (LOGGER).getMaster()->isEnabled() && (LOGGER).getLevel() >= wns::logger::L) {\
wns::logger::Message _neverUseThis("", wns::logger::L);\
if ((LOGGER).isShowFunction()==true) {_neverUseThis << __PRETTY_FUNCTION__ << "\n";}\
_neverUseThis << STRINGSTREAM;\
(LOGGER).send(_neverUseThis);}}

#else

#define MESSAGE_BEGIN(L, LOGGER, M, STRINGSTREAM) {if(0) {wns::logger::Message M;

#define MESSAGE_END() }}

#define MESSAGE_SINGLE(L, LOGGER, STRINGSTREAM) {}

#endif

namespace wns { namespace logger {
    class Master;

    enum Level { OFF=0, QUIET=1, NORMAL=2, VERBOSE=3, MAXLEVEL };

    class Logger {
        friend class LoggerTest;
    public:
        Logger(
            const std::string& moduleName,
            const std::string& loggerName,
            logger::Master* master);

        Logger(
            const std::string& moduleName,
            const std::string& loggerName);

        Logger(
            const pyconfig::View& pyConfigView,
            logger::Master* master);

        explicit
        Logger(const pyconfig::View& pyConfigView);

        explicit
        Logger();

        virtual
        ~Logger();

        Logger(const Logger& other);

        Logger&
        operator=(const Logger& other);

        void
        configure(const wns::pyconfig::View& config);

        void
        send(const Message& m) const;

        void
        switchOn();

        void
        switchOff();

        long int
        getLevel() const;

        void
        setLevel(long int _level);

        const std::string&
        getModuleName() const;

        const std::string&
        getLoggerName() const;

        Master*
        getMaster() const;

        bool
        isShowFunction() const;

    protected:
        std::string mName;

        std::string lName;

        logger::Master* masterLogger;

        bool enabled;

        long int level;

        bool showFunction;
    }; // Logger
} // logger
} // wns
#endif // NOT defined WNS_LOGGER_LOGGER_HPP

---