CLog.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section:  Vision Components
//  Project:  GenApi
//    Author:  Fritz Dierks
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group.
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef LOG_CLOG_H_
#define LOG_CLOG_H_

#pragma warning (push, 3)
#pragma warning(disable:4706)  // assignment within conditional expression

#include <log4cpp/Portability.hh>
#include <log4cpp/Priority.hh>

namespace LOG4CPP_NS
{
    class Category;
    class Appender;
}

#include <stdio.h>
#include <Base/GCBase.h>
#include <Log/LogDll.h>

namespace GENICAM_NAMESPACE
{

    class LOG_DECL CLog
    {
    public:

        static LOG4CPP_NS::Category& GetRootLogger( void );

        static LOG4CPP_NS::Category& GetLogger( const gcstring &LoggerName );
        static LOG4CPP_NS::Category& GetLogger( const char LoggerName[] );

        static bool Exists( const gcstring &LoggerName );
        static bool Exists( const char LoggerName[] );

        static void PushNDC( const gcstring &ContextName );
        static void PushNDC( const char ContextName[] );

        static void PopNDC( void );

        static void Initialize( void );

        static void ShutDown( void );

        static void ConfigureDefault();

        static bool ConfigureFromFile( const gcstring &FileName );
        static bool ConfigureFromFile( const char FileName[] );

        static bool ConfigureFromEnvironment( void );

        static bool ConfigureFromString( const gcstring &ConfigData );
        static bool ConfigureFromString( const char ConfigData[] );

        static void RemoveAllAppenders(void);

        static LOG4CPP_NS::Appender *CreateFileAppender( const gcstring &aName, const gcstring &aPath, bool aAppend = false, const gcstring &aPattern = "" );

        static void AddAppender( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Appender *aAppender );

        static void RemoveAppender( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Appender *aAppender );


        static void SetPriorityInfo( LOG4CPP_NS::Category *aCategory );
        static void SetPriorityError( LOG4CPP_NS::Category *aCategory );

        static bool IsInfoEnabled( LOG4CPP_NS::Category *aCategory );
        static bool IsWarnEnabled( LOG4CPP_NS::Category *aCategory );
        static bool IsDebugEnabled( LOG4CPP_NS::Category *aCategory );

        static void LogPush( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Priority::Value aPriority, const char *aStringFormat, ... );
        static void LogPop( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Priority::Value aPriority, const char *aStringFormat, ... );
        static void Log( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Priority::Value aPriority, const char *aStringFormat, ... );
        static void LogVA( LOG4CPP_NS::Category *aCategory, LOG4CPP_NS::Priority::Value aPriority, const char *aStringFormat, va_list arg );

    private:
        static void MakeSureLoggerHasBeenFound( void );

        static int g_RefCount;
        
        static const void *g_pLog4cpp;

#if defined (_WIN32)
        typedef  HMODULE lib_handle_t;
#else
        typedef void * lib_handle_t;
#endif
        
        static lib_handle_t g_pLibHandle;

        static lib_handle_t OpenLibrary( const gcstring Name );

        static void *FindSymbol( lib_handle_t Handle, const gcstring Name );
        
        static bool g_HasFoundLogger;

    };

}

// Logging macros (can be replaced by real functions for compilers not supporting it?)
#define GCLOGINFO( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::Log( cat, LOG4CPP_NS::Priority::INFO, ##__VA_ARGS__ )
#define GCLOGINFOPUSH( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::LogPush( cat, LOG4CPP_NS::Priority::INFO, ##__VA_ARGS__ )
#define GCLOGINFOPOP( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::LogPop( cat, LOG4CPP_NS::Priority::INFO, ##__VA_ARGS__ )
#define GCLOGWARN( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::Log( cat, LOG4CPP_NS::Priority::WARN, ##__VA_ARGS__ )
#define GCLOGERROR( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::Log( cat, LOG4CPP_NS::Priority::ERROR, ##__VA_ARGS__ )
#define GCLOGDEBUG( cat, ... ) if(cat != NULL) GENICAM_NAMESPACE::CLog::Log( cat, LOG4CPP_NS::Priority::DEBUG,  ##__VA_ARGS__ )


#endif // LOG_CLOG_H_