2 * Copyright (c) <2010>, Intel Corporation
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
17 * - Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
32 * OF THE POSSIBILITY OF SUCH DAMAGE.
36 * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
37 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions are met:
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * * Neither the name of the University of California, Berkeley nor the
47 * names of its contributors may be used to endorse or promote products
48 * derived from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
51 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
52 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
53 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
54 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
55 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
56 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
57 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
58 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
59 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
66 * This file is a small equivalent to the GNU readline library, but it
67 * was originally designed for small systems, like Atmel AVR
68 * microcontrollers (8 bits). Indeed, we don't use any malloc that is
69 * sometimes not implemented (or just not recommended) on such
72 * Obviously, it does not support as many things as the GNU readline,
73 * but at least it supports some interresting features like a kill
74 * buffer and a command history.
76 * It also have a feature that does not have the GNU readline (as far
77 * as I know): we can have several instances of it running at the same
78 * time, even on a monothread program, since it works with callbacks.
80 * The lib is designed for a client-side or a server-side use:
81 * - server-side: the server receives all data from a socket, including
82 * control chars, like arrows, tabulations, ... The client is
83 * very simple, it can be a telnet or a minicom through a serial line.
84 * - client-side: the client receives its data through its stdin for
88 #include <cmdline_cirbuf.h>
89 #include <cmdline_vt100.h>
92 #define RDLINE_BUF_SIZE 256
93 #define RDLINE_PROMPT_SIZE 32
94 #define RDLINE_VT100_BUF_SIZE 8
95 #define RDLINE_HISTORY_BUF_SIZE BUFSIZ
96 #define RDLINE_HISTORY_MAX_LINE 64
106 typedef int (rdline_write_char_t)(struct rdline *rdl, char);
107 typedef void (rdline_validate_t)(struct rdline *rdl,
108 const char *buf, unsigned int size);
109 typedef int (rdline_complete_t)(struct rdline *rdl, const char *buf,
110 char *dstbuf, unsigned int dstsize,
114 enum rdline_status status;
118 char left_buf[RDLINE_BUF_SIZE+2]; /* reserve 2 chars for the \n\0 */
119 char right_buf[RDLINE_BUF_SIZE];
121 char prompt[RDLINE_PROMPT_SIZE];
122 unsigned int prompt_size;
124 #ifndef NO_RDLINE_KILL_BUF
125 char kill_buf[RDLINE_BUF_SIZE];
126 unsigned int kill_size;
129 #ifndef NO_RDLINE_HISTORY
131 struct cirbuf history;
132 char history_buf[RDLINE_HISTORY_BUF_SIZE];
133 int history_cur_line;
136 /* callbacks and func pointers */
137 rdline_write_char_t *write_char;
138 rdline_validate_t *validate;
139 rdline_complete_t *complete;
142 struct cmdline_vt100 vt100;
149 * Init fields for a struct rdline. Call this only once at the beginning
151 * \param rdl A pointer to an uninitialized struct rdline
152 * \param write_char The function used by the function to write a character
153 * \param validate A pointer to the function to execute when the
154 * user validates the buffer.
155 * \param complete A pointer to the function to execute when the
156 * user completes the buffer.
158 void rdline_init(struct rdline *rdl,
159 rdline_write_char_t *write_char,
160 rdline_validate_t *validate,
161 rdline_complete_t *complete);
165 * Init the current buffer, and display a prompt.
166 * \param rdl A pointer to a struct rdline
167 * \param prompt A string containing the prompt
169 void rdline_newline(struct rdline *rdl, const char *prompt);
172 * Call it and all received chars will be ignored.
173 * \param rdl A pointer to a struct rdline
175 void rdline_stop(struct rdline *rdl);
178 * Same than rdline_stop() except that next calls to rdline_char_in()
179 * will return RDLINE_RES_EXITED.
180 * \param rdl A pointer to a struct rdline
182 void rdline_quit(struct rdline *rdl);
185 * Restart after a call to rdline_stop() or rdline_quit()
186 * \param rdl A pointer to a struct rdline
188 void rdline_restart(struct rdline *rdl);
191 * Redisplay the current buffer
192 * \param rdl A pointer to a struct rdline
194 void rdline_redisplay(struct rdline *rdl);
197 /* return status for rdline_char_in() */
198 #define RDLINE_RES_SUCCESS 0
199 #define RDLINE_RES_VALIDATED 1
200 #define RDLINE_RES_COMPLETE 2
201 #define RDLINE_RES_NOT_RUNNING -1
202 #define RDLINE_RES_EOF -2
203 #define RDLINE_RES_EXITED -3
206 * append a char to the readline buffer.
207 * Return RDLINE_RES_VALIDATE when the line has been validated.
208 * Return RDLINE_RES_COMPLETE when the user asked to complete the buffer.
209 * Return RDLINE_RES_NOT_RUNNING if it is not running.
210 * Return RDLINE_RES_EOF if EOF (ctrl-d on an empty line).
211 * Else return RDLINE_RES_SUCCESS.
212 * XXX error case when the buffer is full ?
214 * \param rdl A pointer to a struct rdline
215 * \param c The character to append
217 int rdline_char_in(struct rdline *rdl, char c);
220 * Return the current buffer, terminated by '\0'.
221 * \param rdl A pointer to a struct rdline
223 const char *rdline_get_buffer(struct rdline *rdl);
227 * Add the buffer to history.
228 * return < 0 on error.
229 * \param rdl A pointer to a struct rdline
230 * \param buf A buffer that is terminated by '\0'
232 int rdline_add_history(struct rdline *rdl, const char *buf);
235 * Clear current history
236 * \param rdl A pointer to a struct rdline
238 void rdline_clear_history(struct rdline *rdl);
241 * Get the i-th history item
243 char *rdline_get_history_item(struct rdline *rdl, unsigned int i);
245 #endif /* _RDLINE_H_ */