Log.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: Log
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/LogMessage.h>
#include <NDEVR/LogStream.h>
#include <NDEVR/ProgressInfo.h>
#include <NDEVR/LogMessage.h>
#include <mutex>
namespace NDEVR
{
    class String;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Serves as the primary program interface for processes to report issues and allows any number of 
        LogStreams to subscribe and receive the log information in real-time.
    **/
    class Log final : public ProgressInfo, public Buffer<LogMessage>
    {
        friend class LogManager;
    public:
        NDEVR_BASE_API explicit Log(uint08 id = 0);
        NDEVR_BASE_API Log(const Log& log);
        NDEVR_BASE_API virtual ~Log();
    public:
        NDEVR_BASE_API void addStream(LogStream* stream, bool add_all) final override;
        NDEVR_BASE_API void removeStream(LogStream* stream) final override;
        NDEVR_BASE_API bool addMessage(const LogMessage& message) override;
        NDEVR_BASE_API bool addMessage(const String& message, uint01 log_level = 10) override;
        NDEVR_BASE_API bool addMessage(const char* const message, uint01 log_level = 10) final override;
        NDEVR_BASE_API bool addMessage(const TranslatedString& message, uint01 log_level = 10) override;
        NDEVR_BASE_API void insertMessages(uint04 index, const Buffer<LogMessage>& messages);
        bool cancelRequested() const override { return m_request_cancel; }
        void setCancelRequest(bool cancel) override { 
            m_request_cancel = cancel; 
        }
 
        NDEVR_BASE_API void concatenate(const Log& log);
        NDEVR_BASE_API void sortMessagesByPriority();
        NDEVR_BASE_API void sortMessagesByTime();
        NDEVR_BASE_API void allowCancel(bool cancel) override;
        NDEVR_BASE_API bool setProgress(fltp04 percent) final override;
    protected: 
        bool m_request_cancel;
        fltp04 m_progress;
    private:
        static constexpr fltp08 s_progress_epsilon = 0.001f;
        Buffer<LogStream*> m_streams;
        std::mutex m_mtx;
    };
}