LogMessage.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: LogMessage
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Time.h>
#include <NDEVR/String.h>
 
namespace NDEVR
{
    class TranslatedString;
    class Font;
    struct TextBlock;

    class NDEVR_BASE_API LogMessage
    {
    public:
        enum ApplicationMessagePriority : uint01
        {
              e_success = 0           
            , e_debug = 1             
            , e_logged_debug = 2      
            , e_notification = 5      
            , e_warning = 50          
            , e_error = 150           
            , e_critical_error = 250  
        };
    public:
        LogMessage();
        LogMessage(const Time& time, const StringView& message, const uint01 error_level, uint02 session);
        LogMessage(const Time& time, const StringView& message, const uint01 error_level = e_notification);
        explicit LogMessage(const StringView& message, const uint01 error_level = e_notification);
        explicit LogMessage(const TranslatedString& message, const uint01 error_level = e_notification);
        StringAllocatingView message(bool include_new_lines, bool include_tabs, bool include_colors) const;
        void appendMessage(StringAllocatingView& message, bool include_new_lines, bool include_tabs, bool include_colors) const;
        const String& rawMessage() const { return m_message; }
        String& rawMessage() { return m_message; }
        Buffer<std::pair<String, String>> ansiiEscapeBlocks() const;
        AlocatingAlignedBuffer<TextBlock, 64> messageBlocks(const Font& default_font) const;
        bool hasFormatting() const;
        static constexpr StringView LogSessionStart() { return "\\--------------------------------------------------------------------------------------------------|"; }
        static constexpr StringView LogSessionEnd() { return "/--------------------------------------------------------------------------------------------------|"; }
        bool isSessionStart() const { return m_message == LogSessionStart(); }
        bool isSessionEnd() const { return m_message == LogSessionStart(); }
        bool hasSubString(const StringView& s, bool ignore_case = false) const;
        inline Time recordTime() const {
            return m_time;
        }

        inline void setRecordTime(const Time& time) {
            m_time = time;
        }

        inline uint01 logRecordLevel() const {
            return m_error_level;
        }

        inline void setErrorLevel(uint01 level) {
            m_error_level = level;
        }

        inline void setSessionNumber(uint02 session) {
            m_session_number = session;
        }

        uint02 sessionNumber() const { return m_session_number; }
        bool isFromCurrentSession() const;
    public:
        static uint02 CurrentLogSession();
    protected:
        String m_message;       
        Time m_time;            
        uint02 m_session_number; 
        uint01 m_error_level;   
    };
    template class NDEVR_BASE_API StringStream<LogMessage>;
}