Log.h

/*--------------------------------------------------------------------------------------------
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/InfoPipe.h>
#include <NDEVR/Set.h>
#include <NDEVR/LogMessage.h>
#include <NDEVR/Dictionary.h>
#include <mutex>
namespace NDEVR
{
    class String;

    class Log final : public InfoPipe, 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 void addMessage(uint04 id, const LogMessage& message) final override;

        NDEVR_BASE_API void addMessage(uint04 id, const StringView& message, uint01 log_level = 10) final override;

        NDEVR_BASE_API void addMessage(uint04 id, const TranslatedString& message, uint01 log_level = 10) final override;

        NDEVR_BASE_API void addMessages(uint04 id, const Buffer<LogMessage>& messages) final override;

        NDEVR_BASE_API void insertMessages(uint04 index, const Buffer<LogMessage>& messages);

        NDEVR_BASE_API void concatenate(const Log& log);

        NDEVR_BASE_API void sortMessagesByPriority();

        NDEVR_BASE_API void sortMessagesByTime();

        NDEVR_BASE_API void setProgressIdx(uint04 idx, fltp04 percent) final override;

        NDEVR_BASE_API fltp04 progressIdx(uint04 idx) const final override;

        NDEVR_BASE_API void addInput(const StringView& s, uint04 idx) final override;

        NDEVR_BASE_API void addInput(const StringView& s) final override;
    private:
        NDEVR_BASE_API uint04 addProgressSource(const TranslatedString& name, fltp04 progress) final override;

        NDEVR_BASE_API void removeProgressSource(uint04 idx) final override;

        NDEVR_BASE_API uint04 addCancelGuard(const TranslatedString& name) final override;

        NDEVR_BASE_API void removeCancelGuard(uint04 idx) final override;

        NDEVR_BASE_API bool cancelRequested() const final override;

        NDEVR_BASE_API bool cancelRequestedIdx(uint04 idx) const final override;

        NDEVR_BASE_API void requestCancel() final override;

        NDEVR_BASE_API void requestCancel(uint04) final override;

        NDEVR_BASE_API virtual void addProgressSource(const TranslatedString& name, uint04 idx, fltp04 progress) final override;

        NDEVR_BASE_API virtual void addCancelGuard(const TranslatedString& name, uint04 idx) final override;

        NDEVR_BASE_API uint04 addInputGuard(const TranslatedString& name) final override;

        NDEVR_BASE_API void addInputGuard(const TranslatedString& name, uint04 idx) final override;

        NDEVR_BASE_API void removeInputGuard(uint04 idx) final override;

        NDEVR_BASE_API void getInputIdx(String& s, uint04 idx, bool clear) final override;

        NDEVR_BASE_API void clearInputIdx(uint04 idx) final override;

        NDEVR_BASE_API LogMessage getSafe(uint04 idx) const;
    protected:
        Dictionary<uint04, bool> m_request_cancel; 
        Dictionary<uint04, ProgressSource> m_progress; 
        Dictionary<uint04, String> m_input; 
    private:
        static constexpr fltp08 s_progress_epsilon = 0.001f; 
        Buffer<LogStream*> m_streams; 
        mutable std::mutex m_mtx; 
    };
}