shell.h

Go to the documentation of this file.

/*
 * Copyright (C) 2026 Kamil Lulko <kamil.lulko@gmail.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 * This file is part of oveRTOS.
 */
 
#ifndef OVE_SHELL_H
#define OVE_SHELL_H
 
#include "ove/types.h"
#include "ove_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define OVE_SHELL_MAX_ARGS 8
 
typedef void (*ove_shell_cmd_fn)(int argc, const char *argv[]);
 
struct ove_shell_cmd {
    const char *name; 
    const char *help; 
    ove_shell_cmd_fn handler; 
};
 
typedef void (*ove_shell_output_hook_t)(const char *data, size_t len);
 
#ifdef CONFIG_OVE_SHELL
 
int ove_shell_init(void);
 
int ove_shell_register_cmd(const struct ove_shell_cmd *cmd);
 
void ove_shell_process_char(int c);
 
void ove_shell_process_line(const char *line);
 
void ove_shell_set_output_hook(ove_shell_output_hook_t hook);
 
#else /* !CONFIG_OVE_SHELL */
 
static inline int ove_shell_init(void)
{
    return OVE_ERR_NOT_SUPPORTED;
}
static inline int ove_shell_register_cmd(const struct ove_shell_cmd *c)
{
    (void)c;
    return OVE_ERR_NOT_SUPPORTED;
}
static inline void ove_shell_process_char(int c)
{
    (void)c;
}
static inline void ove_shell_process_line(const char *l)
{
    (void)l;
}
static inline void ove_shell_set_output_hook(ove_shell_output_hook_t h)
{
    (void)h;
}
 
#endif /* CONFIG_OVE_SHELL */
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* OVE_SHELL_H */