Log.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------------
//
// Pro-Vocation Light Engine (PVLE)
// Copyright (C) 2007-2009  Sukender, KinoX & Buzib
// For more information, contact us : sukender@free.fr
//
// This program 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; either version 3 of the License, or
// (at your option) any later version.
//
// For any use that is not compatible with the terms of the GNU 
// General Public License, please contact the authors for alternative
// licensing options.
//
// This program 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
//-----------------------------------------------------------------------------------

#ifndef UTILS_LOG_H
#define UTILS_LOG_H

#include <PVLE/Export.h>
#include <osg/Notify>

// --------------------------------------------
// Defines
// --------------------------------------------

// __PVLE_METHOD__ is a macro that axpands to the current function or method
#ifdef _MSC_VER
    // Note : For visual 6 and 7, BOOST_PP_IF doesn't work
    #define __PVLE_METHOD__ __FUNCTION__
#elif defined(__GNUC__)
    // GCC
    #define __PVLE_METHOD__ __func__
#else
    // All other compilers

    // Force empty defines (to be used with BOOST_PP_IS_EMPTY) if not already defined
    #ifndef __METHOD__
        #define __METHOD__
    #endif
    #ifndef __FUNCTION__
        #define __FUNCTION__
    #endif
    #ifndef __func__
        #define __func__
    #endif
    #ifndef __FUNC__
        #define __FUNC__
    #endif

    #include <boost/preprocessor/control/if.hpp>
    #include <boost/preprocessor/control/expr_if.hpp>
    #include <boost/preprocessor/facilities/is_empty.hpp>

    // This macro says : defines __PVLE_METHOD__ to be __METHOD__ if it exists, or __FUNCTION__, __func, or __FUNC.
    #define __PVLE_METHOD__ BOOST_PP_IF( BOOST_PP_IS_EMPTY(__METHOD__), \
        BOOST_PP_IF( BOOST_PP_IS_EMPTY(__FUNCTION__), \
            BOOST_PP_IF( BOOST_PP_IS_EMPTY(__func__), \
                BOOST_PP_IF( BOOST_PP_IS_EMPTY(__FUNC__), \
                    "Unknown method", \
                    __FUNC__), \
                __func__), \
            __FUNCTION__), \
        __METHOD__)
#endif


// PVLE_TRACE_INFO : Trace information is a text to prepend to the log text
#ifdef PVLE_NO_TRACE_INFO
    #define PVLE_TRACE_INFO ""
#else
    #ifdef PVLE_LIGHT_TRACE_INFO
        #define PVLE_TRACE_INFO __PVLE_METHOD__ " : "
    #else
        #define PVLE_TRACE_INFO "File " << __FILE__ << " (line " << __LINE__ << ") " << __PVLE_METHOD__ " : "
    #endif
#endif


// Define PVLE_FORCE_TRACE_LOG to add a trace info to all logs using LOG_* defines
#ifdef PVLE_FORCE_TRACE_LOG
    #define FORCED_LOG << PVLE_TRACE_INFO
#else
    #define FORCED_LOG
#endif


// Log defines
#define LOG_ALWAYS      osg::notify(osg::ALWAYS) FORCED_LOG
#define LOG_FATAL       osg::notify(osg::FATAL) FORCED_LOG
#define LOG_ERROR       osg::notify(osg::FATAL) FORCED_LOG          
#define LOG_WARN        osg::notify(osg::WARN) FORCED_LOG
#define LOG_NOTICE      osg::notify(osg::NOTICE) FORCED_LOG
#define LOG_INFO        osg::notify(osg::INFO) FORCED_LOG
#define LOG_DEBUG_INFO  osg::notify(osg::DEBUG_INFO) FORCED_LOG
#define LOG_DEBUG_FP    osg::notify(osg::DEBUG_FP) FORCED_LOG


// --------------------------------------------
// Utility << operators
// --------------------------------------------
#include <ostream>

// Forward declarations
namespace osg {
    class Vec3f;
    class Vec4f;
    class Quat;
    class Matrixf;
}

PVLE_EXPORT std::ostream& operator<<(std::ostream& stream, const osg::Vec3f& v);
PVLE_EXPORT std::ostream& operator<<(std::ostream& stream, const osg::Vec4f& v);
PVLE_EXPORT std::ostream& operator<<(std::ostream& stream, const osg::Quat& q);
PVLE_EXPORT std::ostream& operator<<(std::ostream& stream, const osg::Matrixf& m);

#endif // UTILS_LOG_H

---