ConsoleWriter.hpp

Go to the documentation of this file.

/*
    MIT No Attribution
 
    Copyright 2021-2023 Mr. Hands
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to
    deal in the Software without restriction, including without limitation the
    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
    sell copies of the Software, and to permit persons to whom the Software is
    furnished to do so.
 
    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.
*/
 
#pragma once
 
#include "data/ConsoleWriterConfig.hpp"
#include "writers/Writer.hpp"
 
namespace panini
{
 
    class ConsoleWriter
        : public ConfiguredWriter<ConsoleWriterConfig>
    {
 
    public:
        inline explicit ConsoleWriter(
            const ConsoleWriterConfig& config = ConsoleWriterConfig())
            : ConsoleWriter(std::cout, config)
        {
        }
 
        inline explicit ConsoleWriter(
            std::ostream& outputStream,
            const ConsoleWriterConfig& config = ConsoleWriterConfig())
            : ConfiguredWriter(config)
            , m_outputStream(outputStream)
        {
        }
 
    protected:
        inline void Write(const std::string& chunk) override
        {
            m_outputStream << chunk;
        }
 
        /*
            Flush the console output on a new line.
        */
        inline void WriteNewLine() override
        {
            m_outputStream << std::endl;
        }
 
        /*
            Always commit to the console when the writer is destroyed.
        */
        inline bool OnCommit(bool force) override
        {
            (void)force;
 
            return true;
        }
 
    protected:
        std::ostream& m_outputStream;
 
    };
 
};