logstream.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/basesystem/baselog.h"
#include "gwnavruntime/containers/stringstream.h"

namespace Kaim
{

// LogStream useful to print to log with << semantics, usage:
// LogStream stream;
// stream << "x = " << x << '\n';
// stream << "x = " << x << Kaim::Endl;
// stream << "x = " << x << " meters\n";
class LogStream
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Kaim::Stat_Default_Mem)
    KY_CLASS_WITHOUT_COPY(LogStream)
public:
    LogStream() {}

#ifndef KY_NO_LOG_OUTPUT
    void EndLineChar(char value)
    {
        if (value == '\n')
            Flush();
    }

    void EndLineString(const char* value)
    {
        size_t length = SFstrlen(value);
        if (value[length-1] == '\n')
            Flush();
    }

    void Flush()
    {
        BaseLog* log = Kaim::BaseLog::GetGlobalBaseLog();
        if (log)
            log->LogMessage("%s", m_ss.CStr());
        m_ss.Clear();
    }

    StringStream m_ss;
#endif
};


#ifndef KY_NO_LOG_OUTPUT
    inline LogStream& operator<<(LogStream& s, KyInt32 value)     { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, KyUInt32 value)    { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, KyInt64 value)     { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, KyUInt64 value)    { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, float value)       { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, double value)      { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, bool value)        { s.m_ss << value; return s; }
    inline LogStream& operator<<(LogStream& s, char value)        { s.m_ss << value; s.EndLineChar(value);   return s; }
    inline LogStream& operator<<(LogStream& s, const char* value) { s.m_ss << value; s.EndLineString(value); return s; }
#else
    inline LogStream& operator<<(LogStream& s, KyInt32 value)     { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, KyUInt32 value)    { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, KyInt64 value)     { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, KyUInt64 value)    { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, float value)       { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, double value)      { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, bool value)        { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, char value)        { KY_UNUSED(value); return s; }
    inline LogStream& operator<<(LogStream& s, const char* value) { KY_UNUSED(value); return s; }
#endif

}

#define KY_LOG_BIG_TITLE_BEGIN(prefix, title) \
       prefix << "==============================================================\n" \
    << prefix << "======== " << title << Kaim::Endl << Kaim::Endl

#define KY_LOG_BIG_TITLE_END(prefix, title) \
       prefix << "======== " << title << Kaim::Endl \
    << prefix << "==============================================================" << Kaim::Endl << Kaim::Endl

#define KY_LOG_SMALL_TITLE_BEGIN(prefix, title) \
       prefix << "------------------------------------------------------ " << Kaim::Endl \
    << prefix << "---- " << title << Kaim::Endl

#define KY_LOG_SMALL_TITLE_END(prefix, title) \
       prefix << "---- " << title << Kaim::Endl \
    << prefix << "------------------------------------------------------ " << Kaim::Endl << Kaim::Endl