/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDK_SAMPLE_CONSOLE_CONSOLEPRINTER_H_
#define ACSDK_SAMPLE_CONSOLE_CONSOLEPRINTER_H_

#include <mutex>
#include <string>

#include <AVSCommon/Utils/Logger/Logger.h>
#include <AVSCommon/Utils/Logger/LogStringFormatter.h>

namespace alexaClientSDK {
namespace sampleApplications {
namespace common {

/**
 * A simple class that prints to the screen.
 */
class ConsolePrinter : public avsCommon::utils::logger::Logger {
public:
    /**
     * Constructor.
     *
     * @deprecated (instances of ConsolePrinter needlessly duplicate ConsoleLogger functionality.)
     */
    ConsolePrinter();

    /**
     * Prints a simple message along with an \n.
     *
     * @param stringToPrint The string to print.
     */
    static void simplePrint(const std::string& stringToPrint);

    /**
     * Prints a message with a pretty format with a \n after.
     *
     * @param stringToPrint The string to print.
     */
    static void prettyPrint(const std::string& stringToPrint);

    /**
     * Prints a multi-line message with a pretty format with a \n after.
     *
     * @param lines The strings to print.
     */
    static void prettyPrint(std::initializer_list<std::string> lines);

    /**
     * Prints a decorated multi-line message with a pretty format with a newline after,
     * along with an "Alexa Says" header, used for outputting captions.
     *
     * @param lines The strings representing captions from Alexa's voice.
     */
    static void captionsPrint(const std::vector<std::string>& lines);

    /// @name Logger methods
    /// @{
    void emit(
        avsCommon::utils::logger::Level level,
        std::chrono::system_clock::time_point time,
        const char* threadMoniker,
        const char* text) override;
    /// @}

private:
    /**
     * Holding a shared pointer to the mutex
     * to make sure the mutex is not already destroyed
     * when called from global's destructor
     */
    std::shared_ptr<std::mutex> m_mutex;

    /**
     * Object used to format strings for log messages.
     */
    avsCommon::utils::logger::LogStringFormatter m_logFormatter;
};

}  // namespace common
}  // namespace sampleApplications
}  // namespace alexaClientSDK

#endif  // ACSDK_SAMPLE_CONSOLE_CONSOLEPRINTER_H_
