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

ONIXS_CONFLATEDUDP_LTWT_STRUCT LogSeverity
{
    typedef UInt32 Base;

    enum Enum 
    { 
        Important = 10, 
                    
        Regular = 50, 
                    
        Debug = 100
    };
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&,
    LogSeverity::Enum);

inline 
std::string
toStr(
    LogSeverity::Enum mode)
{
    std::string str;
    
    toStr(str, mode);
    
    return str;
}

ONIXS_CONFLATEDUDP_EXPORTED
bool
fromStr(
    LogSeverity::Enum&,
    const Char*,
    size_t);

ONIXS_CONFLATEDUDP_LTWT_STRUCT LogCategory
{
    // Enumeration base. 
    typedef UInt32 Base;

    enum Enum
    {
        Error,

        Warning,

        Info,

        Debug
    };
};

ONIXS_CONFLATEDUDP_EXPORTED
void
toStr(
    std::string&,
    LogCategory::Enum);

inline 
std::string
toStr(
    LogCategory::Enum mode)
{
    std::string str;
    
    toStr(str, mode);
    
    return str;
}

ONIXS_CONFLATEDUDP_EXPORTED
bool
fromStr(
    LogCategory::Enum&,
    const Char*,
    size_t);

ONIXS_CONFLATEDUDP_EXPORTED_CLASS LogEntry
{
public:
    virtual void category(LogCategory::Enum) = 0;

    virtual void source(const StrRef&) = 0;

    virtual std::string& message() = 0;

    virtual void commit() = 0;
 
protected:
    LogEntry()
    {
    }

    virtual ~LogEntry()
    {
    }
 
private:
    // Object copying is not supposed. 
 
    LogEntry(const LogEntry&);
    LogEntry& operator =(const LogEntry&);
};

ONIXS_CONFLATEDUDP_EXPORTED_CLASS Logger
{
    // Object copying is not supposed. 
 
    Logger(const Logger&);
    Logger& operator =(const Logger&);
 
protected:
    Logger()
    {
    }
 
public:
    virtual ~Logger()
    {
    }

    virtual 
    void 
    info(
        std::string&) = 0;

    virtual 
    LogEntry* 
    addEntry(
        LogSeverity::Enum) = 0;
};
 
ONIXS_CONFLATEDUDP_NAMESPACE_END