console.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (c) 2026 ForestHub. All rights reserved.
// For commercial licensing, visit https://github.com/ForestHubAI/fh-sdk
 
#ifndef FORESTHUB_PLATFORM_CONSOLE_HPP
#define FORESTHUB_PLATFORM_CONSOLE_HPP

 
#include <cstdarg>
#include <string>
 
#include "foresthub/util/optional.hpp"
 
namespace foresthub {
namespace platform {

class ConsoleInterface {
public:
    virtual ~ConsoleInterface() = default;

    virtual void Begin() = 0;

    virtual bool Available() const noexcept = 0;

    virtual char Read() = 0;

    virtual std::string ReadLine(size_t max_length = 256, unsigned long timeout_ms = 0, bool echo = true) = 0;

    virtual Optional<std::string> TryReadLine(size_t max_length = 256, bool echo = true) = 0;

    virtual void ClearLineBuffer() = 0;

    virtual void Write(const std::string& data) = 0;

#if defined(__GNUC__) || defined(__clang__)
    // GCC/Clang: Enable compile-time format string checking.
    // Argument indices: 2 = format string (1 is implicit 'this'), 3 = first vararg
    virtual void Printf(const char* format, ...) __attribute__((format(printf, 2, 3))) = 0;
#else
    virtual void Printf(const char* format, ...) = 0;
#endif

    virtual void Flush() noexcept = 0;
};
 
}  // namespace platform
}  // namespace foresthub
 
#endif  // FORESTHUB_PLATFORM_CONSOLE_HPP