it_bus/logging_support.h

#ifndef _IT_BUS_LOGGING_SUPPORT_H_
#define _IT_BUS_LOGGING_SUPPORT_H_

// @Copyright 2004 IONA Technologies, Plc. All Rights Reserved.
//

// prevent logging_support.h being included !!!!
#ifdef _IT_BUS_BUS_LOGGER_H_
#error  logging_support.h should not be used with bus_logger.h
#endif

#include <stdio.h>
#include <stdarg.h>

#include <it_bus/api_defines.h>
#include <it_dsa/vector.h>
#include <it_bus/types.h>
#include <it_bus/logging_defs.h>

namespace IT_Bus
{
    namespace Logging
    {
        class ServiceNameRetriever;
    }
}

namespace CORBA
{
    class ORB;
}

namespace IT_Logging
{
    class EventLog;
}

extern "C"
{
    extern IT_AFC_API IT_TraceLevel it_g_log_filter;
    extern IT_AFC_API IT_TraceLevel it_get_subsystem_log_filter(const char * subsystem);

    void IT_AFC_API it_set_global_log_filter(IT_TraceLevel trace_level);

    void IT_AFC_API it_set_logging_default_ORB(CORBA::ORB* orb);

    void IT_AFC_API
    it_write_log_record(
        IT_Logging::EventLog* event_log,
        IT_Bus::Logging::ServiceNameRetriever* snr,
        const char * subsystem,
        IT_TraceLevel trace_level,
        const char* description,
        ...);

    void IT_AFC_API
    it_write_log_record_with_CDATA(
        IT_Logging::EventLog* event_log,
        IT_Bus::Logging::ServiceNameRetriever* snr,
        const char * subsystem, 
        IT_TraceLevel trace_level,
        const char* description,
        const char* data_buffer,
        long buffer_size
    );

    void IT_AFC_API
    it_write_log_record_with_binary(
        IT_Logging::EventLog* event_log,
        IT_Bus::Logging::ServiceNameRetriever* snr,
        const char * subsystem,
        IT_TraceLevel trace_level,
        const char* description,
        const char* data_buffer,
        long buffer_size
    );

    IT_Bool IT_AFC_API
    _it_test_ignore_service(
        char* serviceNameBuffer,
        const char* subsystem,
        int sn_len,
        IT_Bool& _it_ignore,
        IT_Bool& _it_init_done
    );
}

//These are for writing data buffers
//binary buffers are written in a hex dump format.  
//to see output from these, include INFO_MED in your event_log:filters
#define IT_LOG_BUFFER(event_log, Entry, Length) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_binary(event_log, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, "Buffer Output", Entry, Length); \
    } 

#define IT_LOG_CDATA(event_log, description, Entry) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_CDATA(event_log, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, Entry, 0); \
    }

#define IT_LOG_CDATA_SIZE(event_log, description, Entry, Size) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_CDATA(event_log, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, Entry, Size); \
    }

#define IT_LOG_CDATA_BINARY_BUFFER(event_log, description, bbData) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_binary(event_log, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, bbData.get_const_pointer(), bbData.get_size()); \
    }


// these are used for controlled tracing operations.  description is a printf format string
// they allow specifying the trace level so callers can control visibility
#define IT_LOG_GUARDED0(event_log, snr, subsystem, trace_level, description) \
    if ((it_g_log_filter & trace_level) != 0) \
        it_write_log_record(event_log, snr, subsystem, trace_level, description); 

#define IT_LOG_GUARDED(event_log, snr, subsystem, trace_level, description) \
    IT_LOG_GUARDED0(event_log, snr, subsystem, trace_level, description)

#define IT_LOG_GUARDED1(event_log, snr, subsystem, trace_level, description, Arg1) \
    if ((it_g_log_filter & trace_level) != 0) \
    { \
            it_write_log_record(event_log, snr, subsystem, trace_level, description, Arg1); \
    } 

#define IT_LOG_GUARDED2(event_log, snr, subsystem, trace_level, description, Arg1, Arg2) \
    if ((it_g_log_filter & trace_level) != 0) \
    { \
            it_write_log_record(event_log, snr, subsystem, trace_level, description, Arg1, Arg2); \
    } 

#define IT_LOG_GUARDED3(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3) \
    if ((it_g_log_filter & trace_level) != 0) \
    { \
            it_write_log_record(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3); \
    } 

#define IT_LOG_GUARDED4(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    if ((it_g_log_filter & trace_level) != 0) \
    { \
            it_write_log_record(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3, Arg4); \
    } 

#define IT_LOG_GUARDED5(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    if ((it_g_log_filter & trace_level) != 0) \
    { \
            it_write_log_record(event_log, snr, subsystem, trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5); \
    } 


//these are used to guard a code block from executing when the purpose of the code
//block is solely for formatting a trace statement.  It prevents the code from 
//executing when the trace_level is filtered out and wouldn't be used anyway.
#define BEGIN_TRACE(trace_level)                                        \
    if ((it_g_log_filter & trace_level) != 0)                                \
    {                                                                                                    

#define BEGIN_SUBSYSTEM_TRACE(subsystem_filter, trace_level)                                        \
    if ((subsystem_filter & trace_level) != 0)                                \
    {                                                                                                    

#define END_TRACE                                                                        \
    }


//all the macros that follow are just short hand for the previous ones, but they
//default the event_log to 0, which uses the first one that was loaded (usually
//the only one unless you are using multiple orb names in your cfg file

//These are for writing data buffers
//binary buffers are written in a hex dump format.  
//to see output from these, include INFO_MED in your event_log:filters
#define TRACELOGBUFFER(Entry, Length) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_binary(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, "Buffer Output", Entry, Length); \
    } 

#define TRACELOG_CDATA(description, Entry) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_CDATA(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, Entry, 0); \
    }

#define TRACELOG_CDATA_SIZE(description, Entry, Size) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_CDATA(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, Entry, Size); \
    }

#define SUBSYSTEM_TRACELOG_CDATA_SIZE(subsystem, subsystem_filter, priority, description, Entry, Size) \
    if ((subsystem_filter & priority) != 0) \
    { \
        it_write_log_record_with_CDATA(0, 0, subsystem , IT_TRACE_BUFFER, description, Entry, Size); \
    }


#define SUBSYSTEM_TRACELOG(subsystem, subsystem_filter, priority, description) \
    if ((subsystem_filter & priority) != 0) \
    { \
        it_write_log_record(0, 0, subsystem , IT_TRACE_BUFFER, description); \
    }

#define TRACELOG_CDATA_BINARY_BUFFER(description, bbData) \
    if ((it_g_log_filter & IT_TRACE_BUFFER) != 0) \
    { \
        it_write_log_record_with_binary(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_BUFFER, description, bbData.get_const_pointer(), bbData.get_size()); \
    }

//These are used for method level tracing
//to see output from these, include INFO_LOW in your event_log:filters
#define BEGIN_INTERNAL_METHOD(Name) \
    const char *FuncName = Name; \
    if ((it_g_log_filter & IT_TRACE_METHODS_INTERNAL) != 0) \
        it_write_log_record(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_METHODS_INTERNAL, FuncName); 

#define END_INTERNAL_METHOD    

#define BEGIN_METHOD(Name) \
    const char *FuncName = Name; \
    if ((it_g_log_filter & IT_TRACE_METHODS_INTERNAL) != 0) \
        it_write_log_record(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE_METHODS, FuncName);    

#define END_METHOD        


//these are used for controlled tracing operations.  description is a printf format string
//they allow specifying the trace level so callers can control visibility
#define TRACELOG_WITH_LEVEL0(trace_level, description) \
    IT_LOG_GUARDED(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description)

#define TRACELOG_WITH_LEVEL(trace_level, description) \
    IT_LOG_GUARDED(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description)

#define TRACELOG_WITH_LEVEL1(trace_level, description, Arg1) \
    IT_LOG_GUARDED1(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1)

#define TRACELOG_WITH_LEVEL2(trace_level, description, Arg1, Arg2) \
    IT_LOG_GUARDED2(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2)

#define TRACELOG_WITH_LEVEL3(trace_level, description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3)

#define TRACELOG_WITH_LEVEL4(trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_WITH_LEVEL5(trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5)

// as above but these are used as above but where service name logging 
// is enabled but not available in the current scope
#define TRACELOG_NSN_WITH_LEVEL0(trace_level, description) \
    IT_LOG_GUARDED(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description)

#define TRACELOG_NSN_WITH_LEVEL(trace_level, description) \
    IT_LOG_GUARDED(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description)

#define TRACELOG_NSN_WITH_LEVEL1(trace_level, description, Arg1) \
    IT_LOG_GUARDED1(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1)

#define TRACELOG_NSN_WITH_LEVEL2(trace_level, description, Arg1, Arg2) \
    IT_LOG_GUARDED2(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2)

#define TRACELOG_NSN_WITH_LEVEL3(trace_level, description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3)

#define TRACELOG_NSN_WITH_LEVEL4(trace_level, description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_NSN_WITH_LEVEL5(trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(0, 0, _IT_SUBSYSTEM_SCOPE , trace_level, description, Arg1, Arg2, Arg3, Arg4, Arg5)


//these are used for normal tracing operations.  description is a printf format string
//they default the trace level to IT_TRACE, if you want to use another level see the previous set
#define TRACELOG(description) \
    IT_LOG_GUARDED(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description)

#define TRACELOG0(description) \
    IT_LOG_GUARDED(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description)

#define TRACELOG1(description, Arg1) \
    IT_LOG_GUARDED1(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1)

#define TRACELOG2(description, Arg1, Arg2) \
    IT_LOG_GUARDED2(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2)

#define TRACELOG3(description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3)

#define TRACELOG4(description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG5(description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(0, _IT_SUBSYSTEM_SERVICE, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3, Arg4, Arg5)

// as above but these are used as above but where service name logging 
// is enabled but not available in the current scope
#define TRACELOG_NSN(description) \
    IT_LOG_GUARDED(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description)

#define TRACELOG_NSN0(description) \
    IT_LOG_GUARDED(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description)

#define TRACELOG_NSN1(description, Arg1) \
    IT_LOG_GUARDED1(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1)

#define TRACELOG_NSN2(description, Arg1, Arg2) \
    IT_LOG_GUARDED2(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2)

#define TRACELOG_NSN3(description, Arg1, Arg2, Arg3) \
    IT_LOG_GUARDED3(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3)

#define TRACELOG_NSN4(description, Arg1, Arg2, Arg3, Arg4) \
    IT_LOG_GUARDED4(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3, Arg4)

#define TRACELOG_NSN5(description, Arg1, Arg2, Arg3, Arg4, Arg5) \
    IT_LOG_GUARDED5(0, 0, _IT_SUBSYSTEM_SCOPE , IT_TRACE , description, Arg1, Arg2, Arg3, Arg4, Arg5)



#ifdef _IT_IN_WSDL_CPP_CLIENT_STUBS
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS.STUB.CLIENT"
#endif
#ifdef _IT_IN_WSDL_CPP_SERVER_STUBS
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS.STUB.SERVER"
#endif
#ifndef _IT_SUBSYSTEM_SCOPE
    #define _IT_SUBSYSTEM_SCOPE "IT_BUS"
#endif

#ifdef _IT_LOGGING_SERVICE_NAME_RETRIEVER_INSTANCE_
    #define _IT_SUBSYSTEM_SERVICE _IT_LOGGING_SERVICE_NAME_RETRIEVER_INSTANCE_
#else
    #define _IT_SUBSYSTEM_SERVICE 0
#endif

#define IT_INIT_BUS_LOGGER_MEM(bus) _it_bus_logger = 0;
#define IT_NULL_BUS_LOGGER_MEM _it_bus_logger = 0;
#define IT_FINALISE_BUS_LOGGER_MEM(bus) _it_bus_logger = 0;

#endif  

---