Logging.hpp

Go to the documentation of this file.

/*
    Copyright (c) 2009-2010 Christopher A. Taylor.  All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of LibCat nor the names of its contributors may be used
      to endorse or promote products derived from this software without
      specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER 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 CAT_LOGGING_HPP
#define CAT_LOGGING_HPP

#include <cat/threads/RegionAllocator.hpp>

#if defined(CAT_OS_WINDOWS)
#include <cat/port/WindowsInclude.hpp>
#endif

namespace cat {



enum EventSeverity
{
    LVL_INANE,
    LVL_INFO,
    LVL_WARN,
    LVL_OOPS,
    LVL_FATAL,

    LVL_SILENT, // invalid for an actual event's level, valid value for a threshold
};



region_string HexDumpString(const void *vdata, u32 bytes);

// Write to console (and debug log in windows) then trigger a breakpoint and exit
void FatalStop(const char *message);

void DefaultLogCallback(EventSeverity severity, const char *source, region_ostringstream &msg);



typedef void (*LogCallback)(EventSeverity severity, const char *source, region_ostringstream &msg);

class Logging : public Singleton<Logging>
{
    CAT_SINGLETON(Logging);

    LogCallback _callback;

    friend class Recorder;
    void LogEvent(Recorder *recorder);

public:
    int _log_threshold;

public:
    void Initialize(EventSeverity min_severity = LVL_INANE);
    CAT_INLINE void SetThreshold(EventSeverity min_severity) { _log_threshold = min_severity; }
    void ReadSettings();
    void Shutdown();

protected:
    bool _service;
#if defined(CAT_OS_WINDOWS)
    HANDLE _event_source;
#endif

public:
    CAT_INLINE bool IsService() { return _service; }
    void EnableServiceMode(const char *service_name);
    void WriteServiceLog(EventSeverity severity, const char *line);

public:
    // Not thread-safe
    CAT_INLINE void SetLogCallback(LogCallback cb) { _callback = cb; }
};



class Recorder
{
    friend class Logging;
    EventSeverity _severity;
    const char *_subsystem;
    region_ostringstream _msg;

public:
    Recorder(const char *subsystem, EventSeverity severity);
    ~Recorder();

public:
    template<class T> inline Recorder &operator<<(const T &t)
    {
        _msg << t;
        return *this;
    }
};

// Because there is an IF statement in the macro, you cannot use the
// braceless if-else construction:
//  if (XYZ) WARN("SS") << "ERROR!"; else INFO("SS") << "OK!";       <-- bad
// Instead use:
//  if (XYZ) { WARN("SS") << "ERROR!"; } else INFO("SS") << "OK!";   <-- good
#define RECORD(subsystem, severity) \
    if (severity >= Logging::ii->_log_threshold) Recorder(subsystem, severity)

#define INANE(subsystem)    RECORD(subsystem, LVL_INANE)
#define INFO(subsystem)     RECORD(subsystem, LVL_INFO)
#define WARN(subsystem)     RECORD(subsystem, LVL_WARN)
#define OOPS(subsystem)     RECORD(subsystem, LVL_OOPS)
#define FATAL(subsystem)    RECORD(subsystem, LVL_FATAL)



class Enforcer
{
protected:
    std::ostringstream oss;

public:
    Enforcer(const char *locus);
    ~Enforcer();

public:
    template<class T> inline Enforcer &operator<<(const T &t)
    {
        oss << t;
        return *this;
    }
};


#define USE_ENFORCE_EXPRESSION_STRING
#define USE_ENFORCE_FILE_LINE_STRING


#if defined(USE_ENFORCE_EXPRESSION_STRING)
# define ENFORCE_EXPRESSION_STRING(exp) "Failed assertion (" #exp ")"
#else
# define ENFORCE_EXPRESSION_STRING(exp) "Failed assertion"
#endif

#if defined(USE_ENFORCE_FILE_LINE_STRING)
# define ENFORCE_FILE_LINE_STRING " at " __FILE__ ":" CAT_STRINGIZE(__LINE__)
#else
# define ENFORCE_FILE_LINE_STRING ""
#endif

// Because there is an IF statement in the macro, you cannot use the
// braceless if-else construction:
//  if (XYZ) ENFORCE(A == B) << "ERROR"; else INFO("SS") << "OK";       <-- bad!
// Instead use:
//  if (XYZ) { ENFORCE(A == B) << "ERROR"; } else INFO("SS") << "OK";   <-- good!

#define ENFORCE(exp) if ( (exp) == 0 ) Enforcer(ENFORCE_EXPRESSION_STRING(exp) ENFORCE_FILE_LINE_STRING "\n")
#define EXCEPTION() Enforcer("Exception" ENFORCE_FILE_LINE_STRING "\n")

#if defined(CAT_DEBUG)
# define DEBUG_ENFORCE(exp) ENFORCE(exp)
#else
# define DEBUG_ENFORCE(exp) if (0) ENFORCE(exp) /* hopefully will be optimized out of existence */
#endif


} // namespace cat

#endif // CAT_LOGGING_HPP