Zephyr API Documentation
4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
shell_history.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2018 Nordic Semiconductor ASA
3
*
4
* SPDX-License-Identifier: Apache-2.0
5
*/
6
7
#ifndef ZEPHYR_INCLUDE_SHELL_HISTORY_H_
8
#define ZEPHYR_INCLUDE_SHELL_HISTORY_H_
9
10
#include <
zephyr/kernel.h
>
11
#include <
zephyr/sys/util.h
>
12
#include <
zephyr/sys/dlist.h
>
13
#include <
zephyr/sys/ring_buffer.h
>
14
#include <
stdbool.h
>
15
16
#ifdef __cplusplus
17
extern
"C"
{
18
#endif
19
20
21
struct
shell_history
{
22
struct
k_heap
*
heap
;
23
sys_dlist_t
list
;
24
sys_dnode_t
*
current
;
25
};
26
33
#define Z_SHELL_HISTORY_DEFINE(_name, _size) \
34
K_HEAP_DEFINE(_name##_heap, _size); \
35
static struct shell_history _name = { \
36
.heap = &_name##_heap, \
37
.list = SYS_DLIST_STATIC_INIT(&_name.list), \
38
}
39
48
void
z_shell_history_purge(
struct
shell_history
*history);
49
55
void
z_shell_history_mode_exit(
struct
shell_history
*history);
56
69
bool
z_shell_history_get(
struct
shell_history
*history,
bool
up,
70
uint8_t
*dst,
uint16_t
*len);
71
82
void
z_shell_history_put(
struct
shell_history
*history,
uint8_t
*line,
83
size_t
len);
84
92
static
inline
bool
z_shell_history_active(
struct
shell_history
*history)
93
{
94
return
(history->
current
) ?
true
:
false
;
95
}
96
97
#ifdef __cplusplus
98
}
99
#endif
100
101
#endif
/* ZEPHYR_INCLUDE_SHELL_HISTORY_H_ */
dlist.h
sys_dnode_t
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition
dlist.h:54
sys_dlist_t
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition
dlist.h:50
kernel.h
Public kernel APIs.
ring_buffer.h
stdbool.h
true
#define true
Definition
stdbool.h:14
uint8_t
__UINT8_TYPE__ uint8_t
Definition
stdint.h:88
uint16_t
__UINT16_TYPE__ uint16_t
Definition
stdint.h:89
k_heap
Definition
kernel.h:5790
shell_history
Definition
shell_history.h:21
shell_history::heap
struct k_heap * heap
Definition
shell_history.h:22
shell_history::current
sys_dnode_t * current
Definition
shell_history.h:24
shell_history::list
sys_dlist_t list
Definition
shell_history.h:23
util.h
Misc utilities.
zephyr
shell
shell_history.h
Generated on
for Zephyr API Documentation by
1.14.0