shell_history.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_SHELL_HISTORY_H_
#define ZEPHYR_INCLUDE_SHELL_HISTORY_H_
 
#include <zephyr/kernel.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/dlist.h>
#include <zephyr/sys/ring_buffer.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
struct shell_history {
        struct ring_buf *ring_buf;
        sys_dlist_t list;
        sys_dnode_t *current;
};
 
#define Z_SHELL_HISTORY_DEFINE(_name, _size)                      \
        static uint8_t __noinit __aligned(sizeof(void *))         \
                        _name##_ring_buf_data[_size];             \
        static struct ring_buf _name##_ring_buf =                 \
                {                                                 \
                        .size = _size,                            \
                        .buffer = _name##_ring_buf_data           \
                };                                                \
        static struct shell_history _name = {                     \
                .ring_buf = &_name##_ring_buf                     \
        }
 
 
void z_shell_history_init(struct shell_history *history);
 
void z_shell_history_purge(struct shell_history *history);
 
void z_shell_history_mode_exit(struct shell_history *history);
 
bool z_shell_history_get(struct shell_history *history, bool up,
                         uint8_t *dst, uint16_t *len);
 
void z_shell_history_put(struct shell_history *history, uint8_t *line,
                         size_t len);
 
static inline bool z_shell_history_active(struct shell_history *history)
{
        return (history->current) ? true : false;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SHELL_HISTORY_H_ */