shell_dummy.h

Go to the documentation of this file.

/*
 * Shell backend used for testing
 *
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_SHELL_SHELL_DUMMY_H_
#define ZEPHYR_INCLUDE_SHELL_SHELL_DUMMY_H_
 
#include <zephyr/shell/shell.h>
 
#ifdef __cplusplus
extern "C" {
#endif

extern const struct shell_transport_api shell_dummy_transport_api;
 
struct shell_dummy {
        bool initialized;

        size_t len;

        char buf[CONFIG_SHELL_BACKEND_DUMMY_BUF_SIZE];

        size_t input_len;

        size_t input_pos;

        char input_buf[CONFIG_SHELL_BACKEND_DUMMY_BUF_SIZE];

        shell_transport_handler_t handler;

        void *context;
};


#define SHELL_DUMMY_DEFINE(_name)                                       \
        static struct shell_dummy _name##_shell_dummy;                  \
        struct shell_transport _name = {                                \
                .api = &shell_dummy_transport_api,                      \
                .ctx = (struct shell_dummy *)&_name##_shell_dummy       \
        }

const struct shell *shell_backend_dummy_get_ptr(void);

const char *shell_backend_dummy_get_output(const struct shell *sh,
                                           size_t *sizep);

void shell_backend_dummy_clear_output(const struct shell *sh);

int shell_backend_dummy_push_input(const struct shell *sh, const char *data, size_t len);

void shell_backend_dummy_clear_input(const struct shell *sh);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SHELL_SHELL_DUMMY_H_ */