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/ConflatedUDP/String.h>
#include <OnixS/CME/ConflatedUDP/Integral.h>
#include <OnixS/CME/ConflatedUDP/Decimal.h>
#include <OnixS/CME/ConflatedUDP/Time.h>
 
#include <OnixS/CME/ConflatedUDP/Logger.h>
 
ONIXS_CONFLATEDUDP_NAMESPACE_BEGIN

ONIXS_CONFLATEDUDP_LTWT_CLASS LogEvent
{
    LogEntry& entry_;
    std::string& message_;
 
    // Object copying is not assumed. 
 
    LogEvent(const LogEvent&);
    LogEvent& operator =(const LogEvent&);
 
public:
    LogEvent(
        LogEntry& entry,
        LogCategory::Enum category,
        const 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_;
    }
};
 
// A few descendants for a particular purposes.

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

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

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

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

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

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

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

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

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

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

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

    LogDebug(
        LogEntry& entry,
        const std::string& source)
        : LogEvent(
            entry,
            LogCategory::Debug,
            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 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, 
    const StrRef& strRef)
{
    toStr(
        event.message(),
        strRef);
 
    return event;
}

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

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

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

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

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

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

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

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

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

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