CArcLog.h

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcLog.h  ( GenIV )                                                                                     |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the ARC logging class. This is used for command logging.                             |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: Sept 25, 2014                                                               |
// |                                                                                                                  |
// |  Copyright 2013 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#ifdef _WINDOWS
    #pragma warning( disable: 4251 )
#endif
 
#ifdef __cpp_lib_format
    #include <format>
#endif
 
#include <mutex>
#include <queue>
#include <string>
#include <sstream>
#include <cstdint>
#include <cstdarg>
 
#include <CArcBase.h>
#include <CArcDeviceDllMain.h>
 
 
namespace arc
{
    namespace gen4
    {
 
        typedef std::queue<std::string>::size_type qsize_t;
 
 
        class GEN4_CARCDEVICE_API CArcLog : arc::gen4::CArcBase
        {
            public:
 
                CArcLog( void );
 
                ~CArcLog( void ) = default;
 
                void setMaxSize( const qsize_t uiSize = Q_MAX );
 
                void enable( const bool bEnable = true );
 
                bool isEnabled( void ) const noexcept;
 
                void put( const std::string& sText );
 
                #ifdef __cpp_lib_format
                    template <typename... Args>
                    void put( std::string_view sFormat, const Args&... args )
                    {
                        if ( !m_bEnabled ) { return; }
 
                        std::lock_guard<std::mutex> lockGaurd( m_mutex );
 
                        //
                        // Check the Q size. Dump the oldest if
                        // the Q is too big.
                        //
                        if ( m_sQueue.size() >= Q_MAX )
                        {
                            m_sQueue.pop();
                        }
 
                        m_sQueue.emplace( std::format( sFormat, std::forward<Args>( args )... ) );
                    }
                #else
                    void  put( const char* pszFmt, ... );
                #endif
 
                const std::string next( void );
 
                const std::string last( void );
 
                std::size_t count( void ) const noexcept;
 
                bool empty( void ) const noexcept;
 
                CArcLog& operator<<( std::string const& sText );
 
            private:
 
//              void queueInit( void );
 
                static qsize_t Q_MAX;
 
                std::queue<std::string> m_sQueue;
 
                mutable std::mutex m_mutex;
 
                bool m_bEnabled;
        };
 
 
        using pLogger_t = std::weak_ptr<arc::gen4::CArcLog>;
 
 
    }       // end gen4 namespace
}           // end arc namespace