tracer.h

/*
 * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
 *               http://!gearbox.sf.net/
 * Copyright (c) 2004-2010 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This distribution is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef GBXUTILACFR_TRACER_H
#define GBXUTILACFR_TRACER_H

#if defined (WIN32)
    #if defined (GBXUTILACFR_STATIC)
        #define GBXUTILACFR_EXPORT
    #elif defined (GBXUTILACFR_EXPORTS)
        #define GBXUTILACFR_EXPORT       __declspec (dllexport)
    #else
        #define GBXUTILACFR_EXPORT       __declspec (dllimport)
    #endif
#else
    #define GBXUTILACFR_EXPORT
#endif

#include <string>

namespace gbxutilacfr {

enum TraceType {
    InfoTrace=0,
    WarningTrace,
    ErrorTrace,
    DebugTrace,
    AnyTrace,
    NumberOfTraceTypes,
};

GBXUTILACFR_EXPORT std::string toString( TraceType type );

enum DestinationType {
    ToDisplay=0,
    ToNetwork,
    ToLog,
    ToFile,
    ToAny,
    NumberOfDestinationTypes
};

class GBXUTILACFR_EXPORT Tracer
{
public:
    virtual ~Tracer() {}; 

    struct Config
    {
        int verbosity[NumberOfTraceTypes][NumberOfDestinationTypes];
        bool addTimestamp;
    };

    
    virtual void print( const std::string &message ) = 0;

    virtual void info( const std::string &message, int level=1, bool localOnly=false )
        { info("",message,level,localOnly); }
    virtual void info( const std::string &subsystem, const std::string &message, int level=1, bool localOnly=false ) = 0;
    
    virtual void warning( const std::string &message, int level=1, bool localOnly=false )
        { warning("",message,level,localOnly); }
    virtual void warning( const std::string &subsystem, const std::string &message, int level=1, bool localOnly=false ) = 0;
    
    virtual void error( const std::string &message, int level=1, bool localOnly=false )
        { error("",message,level,localOnly); }
    virtual void error( const std::string &subsystem, const std::string &message, int level=1, bool localOnly=false ) = 0;

    virtual void debug( const std::string &message, int level=1, bool localOnly=false )
        { debug("",message,level,localOnly); }
    virtual void debug( const std::string &subsystem, const std::string &message, int level=1, bool localOnly=false ) = 0;

    virtual int verbosity( TraceType traceType, DestinationType destType=ToAny ) const = 0;

    virtual void setSubsystemDebugLevel( const std::string &subsystem, int level=0 ) {};

    virtual void subsystemDebug( const std::string &subsystem, const std::string &message, int level=1 ) 
    {
        debug( message, level );
    };
};

} 

#endif