Tracer.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2007-2013 (http://safir.sourceforge.net)
*
* Created by: Lars Hagström / stlrha
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
#ifndef __SWRE_TRACER_H__
#define __SWRE_TRACER_H__

#include <Safir/Application/Internal/SwReportExportDefs.h>
#include <Safir/Application/Internal/TraceStreamBuffer.h>
#include <Safir/Dob/ConnectionBase.h>
#include <iostream>

namespace Safir
{
namespace Application
{
    class SWRE_INTERFACE_CPP_API TracerBackdoor
    {
    public:
        static void Start(const Safir::Dob::ConnectionBase& connection);

        static void Stop();
    };


    class SWRE_INTERFACE_CPP_API Tracer
    {
    private:
        typedef std::basic_ios<wchar_t, std::char_traits<wchar_t> > ios_type;
    public:
        typedef std::basic_ostream<wchar_t, std::char_traits<wchar_t> > stream_type;

        explicit Tracer(const std::wstring & prefix);

        ~Tracer();

        void Enable(const bool enabled) {if (m_isEnabled == NULL) {InitializeEnabledHandling();} *m_isEnabled = enabled;}

        inline bool IsEnabled() const {if (m_isEnabled == NULL) {InitializeEnabledHandling();} return *m_isEnabled;}

        inline const Tracer & operator << (stream_type & (* _Pfn)(stream_type&)) const
        {
            if (IsEnabled())
            {
                (*_Pfn)(m_ostream);
            }
            return *this;
        }

        inline const Tracer & operator << (std::ios_base & (* _Pfn)(std::ios_base &)) const
        {
            if (IsEnabled())
            {
                (*_Pfn)(m_ostream);
            }
            return *this;
        }

        inline const Tracer & operator<<(ios_type & (*_Pfn)(ios_type&)) const
        {
            if (IsEnabled())
            {
                (*_Pfn)(m_ostream);
            }
            return *this;
        }

        template <class T>
        inline const Tracer & operator << (const T & data) const
        {
            if (IsEnabled())
            {
                m_ostream << data;
            }
            return *this;
        }

        stream_type & stream() const {return m_ostream;}
    private:
        void InitializeEnabledHandling() const;

        mutable stream_type m_ostream;
        mutable Internal::TraceStreamBuffer m_buf;
        mutable volatile bool * m_isEnabled;
    };

}
}
#endif