Diagnostics.h

// Stuff related to ROSE diagnostics
#ifndef ROSE_Diagnostics_H
#define ROSE_Diagnostics_H
 
#include "Sawyer/Assert.h"
#include "Sawyer/Message.h"
 
#include <rosedll.h>
 
// How failed assertions behave
#define ROSE_ASSERTION_ABORT    1                       // call abort()
#define ROSE_ASSERTION_EXIT     2                       // call exit(1)
#define ROSE_ASSERTION_THROW    3                       // throw Rose::Diagnostics::FailedAssertion
 
namespace Rose {
 
namespace Diagnostics {
 
// Make Sawyer message importance levels available here. That way, we don't have to "use namespace Sawyer::Message", which
// also sucks in a lot of other stuff.
using Sawyer::Message::DEBUG;                           // very low-level debugging mostly for developers
using Sawyer::Message::TRACE;                           // more low-level debugging but maybe more interesting to users
using Sawyer::Message::WHERE;                           // higher-level debugging to help users understand ROSE flow
using Sawyer::Message::MARCH;                           // progress bars and other high-frequency messages
using Sawyer::Message::INFO;                            // useful information about normal behavior such as stats
using Sawyer::Message::WARN;                            // warnings that users should almost certainly see at least once
using Sawyer::Message::ERROR;                           // recoverable errors, possibly followed by throw
using Sawyer::Message::FATAL;                           // errors which are immediately followed by exit, abort, or similar
 
using Sawyer::Message::Stream;                          // one message stream, e.g., 'mlog[INFO]'
using Sawyer::Message::Facility;                        // collection of related streams, e.g., 'mlog'
 
ROSE_DLL_API extern Sawyer::Message::DestinationPtr destination;
 
ROSE_DLL_API extern Sawyer::Message::PrefixPtr mprefix;
 
ROSE_DLL_API extern Sawyer::Message::Facility mlog;
 
using Sawyer::Message::mfacilities;
    
ROSE_DLL_API void initialize();
 
ROSE_DLL_API bool isInitialized();
 
ROSE_DLL_API void initAndRegister(Facility *mlog, const std::string &name);
 
ROSE_DLL_API void deregister(Facility *mlog);
 
class StreamPrintf {
    std::ostream &stream;
public:
    StreamPrintf(std::ostream &stream): stream(stream) {}
#ifdef _MSC_VER
    int operator()(const char *fmt, ...);
#else
    int operator()(const char *fmt, ...) __attribute__((format(printf, 2, 3)));
#endif
};
 
StreamPrintf mfprintf(std::ostream &stream);
 
// See mfprintf. "mlog" must be resolved at point where macro is expanded.
#define mprintf Rose::Diagnostics::mfprintf(mlog[Rose::Diagnostics::DEBUG]) 
 
} // namespace
} // namespace
 
#endif