shell.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2009-2013 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include "periph/pm.h"
 
#include "modules.h"
#include "xfa.h"
 
#ifndef __cplusplus
#include "flash_utils.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef CONFIG_SHELL_SHUTDOWN_ON_EXIT
/* Some systems (e.g Ubuntu 20.04) close stdin on CTRL-D / EOF
 * That means we can't just re-start the shell.
 * Instead terminate RIOT, which is also the behavior a user would
 * expect from a CLI application.
 */
#  if defined(CPU_NATIVE) && !IS_ACTIVE(MODULE_SHELL_LOCK)
#    define CONFIG_SHELL_SHUTDOWN_ON_EXIT 1
#  else
#    define CONFIG_SHELL_SHUTDOWN_ON_EXIT 0
#  endif
#endif

#ifndef CONFIG_SHELL_NO_ECHO
#define CONFIG_SHELL_NO_ECHO 0
#endif

#ifndef CONFIG_SHELL_NO_PROMPT
#define CONFIG_SHELL_NO_PROMPT 0
#endif


#define SHELL_DEFAULT_BUFSIZE   (128)

void shell_post_readline_hook(void);

void shell_pre_command_hook(int argc, char **argv);

void shell_post_command_hook(int ret, int argc, char **argv);

typedef int (*shell_command_handler_t)(int argc, char **argv);

typedef struct shell_command_t {
    const char *name; 
    const char *desc; 
    shell_command_handler_t handler; 
} shell_command_t;
 
#ifndef __cplusplus
typedef struct {
    FLASH_ATTR const char *name; 
    FLASH_ATTR const char *desc; 
    shell_command_handler_t handler; 
} shell_command_xfa_t;
#endif /* __cplusplus */

void shell_run_once(const shell_command_t *commands, char *line_buf, int len);

static inline void shell_run_forever(const shell_command_t *commands,
                                     char *line_buf, int len)
{
    while (1) {
        shell_run_once(commands, line_buf, len);
 
        if (IS_ACTIVE(CONFIG_SHELL_SHUTDOWN_ON_EXIT)) {
            pm_off();
        }
    }
}

static inline void shell_run(const shell_command_t *commands,
                             char *line_buf, int len)
{
    shell_run_forever(commands, line_buf, len);
}

int shell_handle_input_line(const shell_command_t *commands, char *line);

int shell_parse_file(const shell_command_t *commands,
                     const char *filename, unsigned *line_nr);

int shell_readline(char *buf, size_t size);
 
#ifndef __cplusplus
#define SHELL_COMMAND(cmd, help, func) \
    XFA_USE_CONST(shell_command_xfa_t, shell_commands_xfa_v2); \
    static FLASH_ATTR const char _xfa_ ## cmd ## _cmd_name[] = #cmd; \
    static FLASH_ATTR const char _xfa_ ## cmd ## _cmd_desc[] = help; \
    XFA_CONST(shell_command_xfa_t, shell_commands_xfa_v2, 0) _xfa_ ## cmd ## _cmd = { \
        .name = _xfa_ ## cmd ## _cmd_name, \
        .desc = _xfa_ ## cmd ## _cmd_desc, \
        .handler = &func \
    };
#endif /* __cplusplus */
 
#ifdef __cplusplus
}
#endif