---

ErrorReporting.h

/*****************************************************************************
 * Author:   Valient Gough <vgough@pobox.com>
 *
 *****************************************************************************
 * Copyright (c) 2001, Valient Gough
 *
 * This library is free software; you can distribute it and/or modify it under
 * the terms of the GNU Lesser General Public License (LGPL), as published by
 * the Free Software Foundation; either version 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library 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 LGPL in the file COPYING for more
 * details.
 *
 */

#ifndef _ErrorReporting_incl
#define _ErrorReporting_incl

#include <rel/SmartPtr.h>

#include <stdio.h>
#include <errno.h>

namespace rel
{

    class DebugChannel
    {
    public:
        enum MsgType
        {
            Debug,
            Info,
            Warning,
            Error,
            Fatal
        };

        DebugChannel(MsgType type);
        virtual ~DebugChannel();

        // emit message on channel..
        virtual void emit(const char *file, int line, const char *message);

    private:
        MsgType type;

    };



    // formats message and calls channel->emit() to emit message..
    void rLogMessage(DebugChannel *channel,
                     const char *file,
                     int lineNum,
                     const char *format, ...)
#ifdef __GNUC__
                     __attribute((format (printf, 4, 5)))
#endif
                     ;

    // initialize default channels (debug/info/warning/error/fatal) - the
    // default is to send all output to stderr..
    void initializeDebugChannels();

} // namespace rel


// some predefined channels.  The defaults can be replaced by assigning he
// pointers to point to new handlers..
extern rel::SmartPtr<rel::DebugChannel> gDebugChannel;
extern rel::SmartPtr<rel::DebugChannel> gInfoChannel;
extern rel::SmartPtr<rel::DebugChannel> gWarningChannel;
extern rel::SmartPtr<rel::DebugChannel> gErrorChannel;
extern rel::SmartPtr<rel::DebugChannel> gFatalChannel;


#define rMessage(Channel,Format,args...) \
    rel::rLogMessage(Channel, __FILE__,__LINE__,Format , ## args)

// rDebug() macro: log to 'debug' channel
#define rDebug(Format, args...) \
    rMessage(gDebugChannel.get(),Format , ## args)

// rInfo() macro: log to 'info' channel
#define rInfo(Format, args...) \
    rMessage(gInfoChannel.get(),Format , ## args)

// rWarning() macro: log to 'warning' channel
#define rWarning(Format, args...)  \
    rMessage(gWarningChannel.get(),Format , ## args)

// rError() macro: log to 'error' channel
#define rError(Format, args...) \
    rMessage(gErrorChannel.get(),Format , ## args)

// rFatal() macro: log to 'fatal' channel
#define rFatal(Format, args...) \
    rMessage(gFatalChannel.get(),Format , ## args)



// for reporting system errors
#define rPerror(Format,args...) \
{ \
    rError(Format, ## args); \
    if(errno < sys_nerr) \
        rError("errno = %i: %s", errno, sys_errlist[errno]); \
    else \
        rError("errno = %i", errno); \
}

// ASSERT checks
#define assert_rError(CMD) \
if(! (CMD) ) \
    rError("Assert failure: " #CMD);

#define assert_rFatal(CMD) \
if(! (CMD) ) \
    rFatal("Assert failure: " #CMD);


#endif // _ErrorReporting_incl

---