LogEvents.h

Go to the documentation of this file.

// Copyright Onix Solutions Limited [OnixS]. All rights reserved.
//
// This software owned by Onix Solutions Limited [OnixS] and is
// protected by copyright law and international copyright treaties.
//
// Access to and use of the software is governed by the terms of the applicable
// OnixS Software Services Agreement (the Agreement) and Customer end user license
// agreements granting a non-assignable, non-transferable and non-exclusive license
// to use the software for it's own data processing purposes under the terms defined
// in the Agreement.
//
// Except as otherwise granted within the terms of the Agreement, copying or
// reproduction of any part of this source code or associated reference material
// to any other location for further reproduction or redistribution, and any
// amendments to this copyright notice, are expressly prohibited.
//
// Any reproduction or redistribution for sale or hiring of the Software not in
// accordance with the terms of the Agreement is a violation of copyright law.
//
 
#pragma once
 
#include <OnixS/CME/MDH/messaging/StrRef.h>
#include <OnixS/CME/MDH/messaging/Integral.h>
#include <OnixS/CME/MDH/messaging/Decimal.h>
#include <OnixS/CME/MDH/messaging/Time.h>
 
#include <OnixS/CME/MDH/Logger.h>
 
ONIXS_CMEMDH_NAMESPACE_BEGIN

class ONIXS_CMEMDH_LTWT LogEvent
{
public:
    LogEvent(LogEntry& entry, LogCategory::Enum category, Messaging::StrRef source)
        : entry_(entry)
        , message_(entry.message())
    {
        entry_.category(category);
        entry_.source(source);
    }

    ~LogEvent()
    {
        entry_.commit();
    }

    std::string& message()
    {
        return message_;
    }

    const std::string& message() const
    {
        return message_;
    }
 
private:
    LogEntry& entry_;
    std::string& message_;
 
    // Object copying is not assumed.
 
    LogEvent(const LogEvent&);
    LogEvent& operator=(const LogEvent&);
};
 
// A few descendants for a particular purposes.

struct ONIXS_CMEMDH_LTWT LogError : LogEvent
{
    LogError(LogEntry& entry, const Messaging::Char* source)
        : LogEvent(entry, LogCategory::Error, Messaging::toStrRef(source))
    {
    }

    LogError(LogEntry& entry, Messaging::StrRef source)
        : LogEvent(entry, LogCategory::Error, source)
    {
    }

    LogError(LogEntry& entry, const std::string& source)
        : LogEvent(entry, LogCategory::Error, Messaging::toStrRef(source))
    {
    }
};

struct ONIXS_CMEMDH_LTWT LogWarning : LogEvent
{
    LogWarning(LogEntry& entry, const Messaging::Char* source)
        : LogEvent(entry, LogCategory::Warning, Messaging::toStrRef(source))
    {
    }

    LogWarning(LogEntry& entry, Messaging::StrRef source)
        : LogEvent(entry, LogCategory::Warning, source)
    {
    }

    LogWarning(LogEntry& entry, const std::string& source)
        : LogEvent(entry, LogCategory::Warning, Messaging::toStrRef(source))
    {
    }
};

struct ONIXS_CMEMDH_LTWT LogInfo : LogEvent
{
    LogInfo(LogEntry& entry, const Messaging::Char* source)
        : LogEvent(entry, LogCategory::Info, Messaging::toStrRef(source))
    {
    }

    LogInfo(LogEntry& entry, Messaging::StrRef source)
        : LogEvent(entry, LogCategory::Info, source)
    {
    }

    LogInfo(LogEntry& entry, const std::string& source)
        : LogEvent(entry, LogCategory::Info, Messaging::toStrRef(source))
    {
    }
};

struct ONIXS_CMEMDH_LTWT LogDebug : LogEvent
{
    LogDebug(LogEntry& entry, const Messaging::Char* source)
        : LogEvent(entry, LogCategory::Debug, Messaging::toStrRef(source))
    {
    }

    LogDebug(LogEntry& entry, Messaging::StrRef source)
        : LogEvent(entry, LogCategory::Debug, source)
    {
    }

    LogDebug(LogEntry& entry, const std::string& source)
        : LogEvent(entry, LogCategory::Debug, Messaging::toStrRef(source))
    {
    }
};
 
// Sugar-coat for adding basic type data to log entry.

template <typename Undefined>
LogEvent& operator<<(LogEvent& event, Undefined undefined)
{
    struct DefineOperatorForGivenType
    {
    } var = undefined;
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, const Messaging::Char* cStr)
{
    event.message() += cStr;
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, const std::string& str)
{
    event.message() += str;
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::StrRef strRef)
{
    Messaging::toStr(event.message(), strRef);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::Char character)
{
    event.message() += character;
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::Int8 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::UInt8 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::Int16 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::UInt16 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::Int32 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::UInt32 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::Int64 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, Messaging::UInt64 number)
{
    Messaging::toStr(event.message(), number);
 
    return event;
}

template <class Mantissa, class Exponent>
inline LogEvent& operator<<(LogEvent& event, const Messaging::FixedPointDecimal<Mantissa, Exponent>& number)
{
    toStr(event.message(), number);
 
    return event;
}
 
// Logs timestamp.
inline LogEvent& operator<<(LogEvent& event, const Messaging::Timestamp& timestamp)
{
    toStr(event.message(), timestamp);
 
    return event;
}

inline LogEvent& operator<<(LogEvent& event, const Messaging::TimeSpan& timeSpan)
{
    toStr(event.message(), timeSpan);
 
    return event;
}
 
ONIXS_CMEMDH_NAMESPACE_END