api/cpp/console_8hpp_source.html

/*

 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>

 *

 * SPDX-License-Identifier: GPL-3.0-or-later

 *

 * This file is part of oveRTOS.

 */


#pragma once


#include <ove/console.h>

#include <ove/types.hpp>

#include <ove/error.hpp>


#ifdef CONFIG_OVE_CONSOLE


namespace ove::console

{


[[nodiscard]] inline Result<void> init() noexcept

{

    return from_rc(ove_console_init());

}


/* Some C libraries (NuttX, glibc) define getchar/putchar as macros;

   undefine them so the C++ inline wrappers compile cleanly. */

#ifdef getchar

#undef getchar

#endif

#ifdef putchar

#undef putchar

#endif


inline int getchar()

{

    return ove_console_getchar();

}


inline void putchar(int c)

{

    ove_console_putchar(c);

}


inline void write(const char *data, unsigned int len)

{

    ove_console_write(data, len);

}


} /* namespace ove::console */


#endif /* CONFIG_OVE_CONSOLE */

error.hpp
Strong ove::Error type, Result<T> alias, and std::error_code interop for the oveRTOS C++ binding.

ove::console
Thin C++ wrappers around the oveRTOS console (serial I/O) API.
Definition console.hpp:23

ove::console::write
void write(const char *data, unsigned int len)
Writes a buffer of bytes to the console output.
Definition console.hpp:76

ove::console::getchar
int getchar()
Reads one character from the console, blocking until one is available.
Definition console.hpp:57

ove::console::putchar
void putchar(int c)
Writes a single character to the console output.
Definition console.hpp:66

ove::console::init
Result< void > init() noexcept
Initialises the console subsystem.
Definition console.hpp:38

ove::from_rc
Result< void > from_rc(int rc) noexcept
Lifts a substrate rc-code into a Result<void>.
Definition error.hpp:254

ove::Result
std::expected< T, Error > Result
std::expected-based result alias.
Definition error.hpp:139

types.hpp
Common type definitions and concepts for the C++ wrapper layer.