shell.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2026 Grzegorz Grzęda
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#ifndef HOME_CORE_SHELL_H
#define HOME_CORE_SHELL_H
/*---------------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif
/*---------------------------------------------------------------------------*/
#include <stddef.h>
#include <stdint.h>
#include "homecore/session/session.h"
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
typedef session_t shell_context_t;
/*---------------------------------------------------------------------------*/
typedef int (*shell_command_handler_t)(shell_context_t *context, int argc, char **argv);
/*---------------------------------------------------------------------------*/
void shell_init(void);
/*---------------------------------------------------------------------------*/
void shell_register_command(const char *name, const char *help, shell_command_handler_t handler);
/*---------------------------------------------------------------------------*/
int shell_read_line(char *buffer, size_t max_length);
/*---------------------------------------------------------------------------*/
int shell_execute_line(shell_context_t *context, char *line);
/*---------------------------------------------------------------------------*/
void shell_run(void);
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
#if defined(__cplusplus)
}
#endif
/*---------------------------------------------------------------------------*/
#endif // HOME_CORE_SHELL_H
/*---------------------------------------------------------------------------*/