api/cpp/shell_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/shell.h>

#include <ove/types.hpp>

#include <ove/error.hpp>


#ifdef CONFIG_OVE_SHELL


namespace ove::shell

{


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

{

    return from_rc(ove_shell_init());

}


[[nodiscard]] inline Result<void> register_cmd(const struct ove_shell_cmd *cmd) noexcept

{

    return from_rc(ove_shell_register_cmd(cmd));

}


inline void process_char(int c)

{

    ove_shell_process_char(c);

}


inline void process_line(const char *line)

{

    ove_shell_process_line(line);

}


inline void set_output_hook(ove_shell_output_hook_t hook)

{

    ove_shell_set_output_hook(hook);

}


} /* namespace ove::shell */


#endif /* CONFIG_OVE_SHELL */

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

ove::shell
Thin C++ wrappers around the oveRTOS interactive shell API.
Definition shell.hpp:23

ove::shell::process_char
void process_char(int c)
Feeds a single character into the shell input processor.
Definition shell.hpp:60

ove::shell::process_line
void process_line(const char *line)
Process a complete input line through the shell.
Definition shell.hpp:69

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

ove::shell::register_cmd
Result< void > register_cmd(const struct ove_shell_cmd *cmd) noexcept
Registers a shell command.
Definition shell.hpp:48

ove::shell::set_output_hook
void set_output_hook(ove_shell_output_hook_t hook)
Set a hook to capture shell output.
Definition shell.hpp:78

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.