amiro-os / core / src / aos_shell.c @ 2e69d671
History | View | Annotate | Download (46.2 KB)
1 |
/*
|
---|---|
2 |
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
|
3 |
Copyright (C) 2016..2018 Thomas Schöpping et al.
|
4 |
|
5 |
This program is free software: you can redistribute it and/or modify
|
6 |
it under the terms of the GNU General Public License as published by
|
7 |
the Free Software Foundation, either version 3 of the License, or
|
8 |
(at your option) any later version.
|
9 |
|
10 |
This program is distributed in the hope that it will be useful,
|
11 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
12 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
13 |
GNU General Public License for more details.
|
14 |
|
15 |
You should have received a copy of the GNU General Public License
|
16 |
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
17 |
*/
|
18 |
|
19 |
/**
|
20 |
* @file aos_shell.c
|
21 |
* @brief Shell code.
|
22 |
* @details Shell code as well as shell related channels and streams.
|
23 |
*
|
24 |
* @addtogroup aos_shell
|
25 |
* @{
|
26 |
*/
|
27 |
|
28 |
#include <aos_shell.h> |
29 |
|
30 |
#if (AMIROOS_CFG_SHELL_ENABLE == true) |
31 |
#include <aos_debug.h> |
32 |
#include <aos_time.h> |
33 |
#include <aos_system.h> |
34 |
#include <string.h> |
35 |
|
36 |
/**
|
37 |
* @brief Event mask to be set on OS related events.
|
38 |
*/
|
39 |
#define AOS_SHELL_EVENTMASK_OS EVENT_MASK(0) |
40 |
|
41 |
/**
|
42 |
* @brief Event mask to be set on a input event.
|
43 |
*/
|
44 |
#define AOS_SHELL_EVENTMASK_INPUT EVENT_MASK(1) |
45 |
|
46 |
/**
|
47 |
* @brief Implementation of the BaseAsynchronous write() method (inherited from BaseSequentialStream).
|
48 |
*/
|
49 |
static size_t _channelwrite(void *instance, const uint8_t *bp, size_t n) |
50 |
{ |
51 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
|
52 |
return streamWrite(((AosShellChannel*)instance)->asyncchannel, bp, n);
|
53 |
} else {
|
54 |
return 0; |
55 |
} |
56 |
} |
57 |
|
58 |
/**
|
59 |
* @brief Implementation of the BaseAsynchronous read() method (inherited from BaseSequentialStream).
|
60 |
*/
|
61 |
static size_t _channelread(void *instance, uint8_t *bp, size_t n) |
62 |
{ |
63 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
|
64 |
return streamRead(((AosShellChannel*)instance)->asyncchannel, bp, n);
|
65 |
} else {
|
66 |
return 0; |
67 |
} |
68 |
} |
69 |
|
70 |
/**
|
71 |
* @brief Implementation of the BaseAsynchronous put() method (inherited from BaseSequentialStream).
|
72 |
*/
|
73 |
static msg_t _channelput(void *instance, uint8_t b) |
74 |
{ |
75 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
|
76 |
return streamPut(((AosShellChannel*)instance)->asyncchannel, b);
|
77 |
} else {
|
78 |
return MSG_RESET;
|
79 |
} |
80 |
} |
81 |
|
82 |
/**
|
83 |
* @brief Implementation of the BaseAsynchronous get() method (inherited from BaseSequentialStream).
|
84 |
*/
|
85 |
static msg_t _channelget(void *instance) |
86 |
{ |
87 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
|
88 |
return streamGet(((AosShellChannel*)instance)->asyncchannel);
|
89 |
} else {
|
90 |
return MSG_RESET;
|
91 |
} |
92 |
} |
93 |
|
94 |
/**
|
95 |
* @brief Implementation of the BaseAsynchronous putt() method.
|
96 |
*/
|
97 |
static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time) |
98 |
{ |
99 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
|
100 |
return chnPutTimeout(((AosShellChannel*)instance)->asyncchannel, b, time);
|
101 |
} else {
|
102 |
return MSG_RESET;
|
103 |
} |
104 |
} |
105 |
|
106 |
/**
|
107 |
* @brief Implementation of the BaseAsynchronous gett() method.
|
108 |
*/
|
109 |
static msg_t _channelgett(void *instance, sysinterval_t time) |
110 |
{ |
111 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
|
112 |
return chnGetTimeout(((AosShellChannel*)instance)->asyncchannel, time);
|
113 |
} else {
|
114 |
return MSG_RESET;
|
115 |
} |
116 |
} |
117 |
|
118 |
/**
|
119 |
* @brief Implementation of the BaseAsynchronous writet() method.
|
120 |
*/
|
121 |
static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time) |
122 |
{ |
123 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
|
124 |
return chnWriteTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
|
125 |
} else {
|
126 |
return 0; |
127 |
} |
128 |
} |
129 |
|
130 |
/**
|
131 |
* @brief Implementation of the BaseAsynchronous readt() method.
|
132 |
*/
|
133 |
static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time) |
134 |
{ |
135 |
if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
|
136 |
return chnReadTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
|
137 |
} else {
|
138 |
return 0; |
139 |
} |
140 |
} |
141 |
|
142 |
/**
|
143 |
* @brief Implementation of the BaseAsynchronousChannel ctl() method.
|
144 |
*/
|
145 |
static msg_t _channelctl(void *instance, unsigned int operation, void *arg) { |
146 |
(void) instance;
|
147 |
|
148 |
switch (operation) {
|
149 |
case CHN_CTL_NOP:
|
150 |
osalDbgCheck(arg == NULL);
|
151 |
break;
|
152 |
case CHN_CTL_INVALID:
|
153 |
osalDbgAssert(false, "invalid CTL operation"); |
154 |
break;
|
155 |
default:
|
156 |
break;
|
157 |
} |
158 |
return MSG_OK;
|
159 |
} |
160 |
|
161 |
static const struct AosShellChannelVMT _channelvmt = { |
162 |
(size_t) 0,
|
163 |
_channelwrite, |
164 |
_channelread, |
165 |
_channelput, |
166 |
_channelget, |
167 |
_channelputt, |
168 |
_channelgett, |
169 |
_channelwritet, |
170 |
_channelreadt, |
171 |
_channelctl, |
172 |
}; |
173 |
|
174 |
static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n) |
175 |
{ |
176 |
aosDbgCheck(instance != NULL);
|
177 |
|
178 |
// local variables
|
179 |
AosShellChannel* channel = ((AosShellStream*)instance)->channel; |
180 |
size_t bytes; |
181 |
size_t maxbytes = 0;
|
182 |
|
183 |
// iterate through the list of channels
|
184 |
while (channel != NULL) { |
185 |
bytes = streamWrite(channel, bp, n); |
186 |
maxbytes = (bytes > maxbytes) ? bytes : maxbytes; |
187 |
channel = channel->next; |
188 |
} |
189 |
|
190 |
return maxbytes;
|
191 |
} |
192 |
|
193 |
static size_t _stremread(void *instance, uint8_t *bp, size_t n) |
194 |
{ |
195 |
(void)instance;
|
196 |
(void)bp;
|
197 |
(void)n;
|
198 |
|
199 |
return 0; |
200 |
} |
201 |
|
202 |
static msg_t _streamput(void *instance, uint8_t b) |
203 |
{ |
204 |
aosDbgCheck(instance != NULL);
|
205 |
|
206 |
// local variables
|
207 |
AosShellChannel* channel = ((AosShellStream*)instance)->channel; |
208 |
msg_t ret = MSG_OK; |
209 |
|
210 |
// iterate through the list of channels
|
211 |
while (channel != NULL) { |
212 |
msg_t ret_ = streamPut(channel, b); |
213 |
ret = (ret_ < ret) ? ret_ : ret; |
214 |
channel = channel->next; |
215 |
} |
216 |
|
217 |
return ret;
|
218 |
} |
219 |
|
220 |
static msg_t _streamget(void *instance) |
221 |
{ |
222 |
(void)instance;
|
223 |
|
224 |
return 0; |
225 |
} |
226 |
|
227 |
static const struct AosShellStreamVMT _streamvmt = { |
228 |
(size_t) 0,
|
229 |
_streamwrite, |
230 |
_stremread, |
231 |
_streamput, |
232 |
_streamget, |
233 |
}; |
234 |
|
235 |
/**
|
236 |
* @brief Enumerator of special keyboard keys.
|
237 |
*/
|
238 |
typedef enum special_key { |
239 |
KEY_UNKNOWN, /**< any/unknow key */
|
240 |
KEY_AMBIGUOUS, /**< key is ambiguous */
|
241 |
KEY_TAB, /**< tabulator key */
|
242 |
KEY_ESCAPE, /**< escape key */
|
243 |
KEY_BACKSPACE, /**< backspace key */
|
244 |
KEY_INSERT, /**< insert key */
|
245 |
KEY_DELETE, /**< delete key */
|
246 |
KEY_HOME, /**< home key */
|
247 |
KEY_END, /**< end key */
|
248 |
KEY_PAGE_UP, /**< page up key */
|
249 |
KEY_PAGE_DOWN, /**< page down key */
|
250 |
KEY_ARROW_UP, /**< arrow up key */
|
251 |
KEY_ARROW_DOWN, /**< arrow down key */
|
252 |
KEY_ARROW_LEFT, /**< arrow left key */
|
253 |
KEY_ARROW_RIGHT, /**< arrow right key */
|
254 |
} special_key_t; |
255 |
|
256 |
/**
|
257 |
* @brief Enumerator for case (in)sensitive character matching.
|
258 |
*/
|
259 |
typedef enum charmatch { |
260 |
CHAR_MATCH_NOT = 0, /**< Characters do not match at all. */ |
261 |
CHAR_MATCH_NCASE = 1, /**< Characters would match case insensitive. */ |
262 |
CHAR_MATCH_CASE = 2, /**< Characters do match with case. */ |
263 |
} charmatch_t; |
264 |
|
265 |
/**
|
266 |
* @brief Print the shell prompt
|
267 |
* @details Depending on the configuration flags, the system uptime is printed before the prompt string.
|
268 |
*
|
269 |
* @param[in] shell Pointer to the shell object.
|
270 |
*/
|
271 |
static void _printPrompt(aos_shell_t* shell) |
272 |
{ |
273 |
aosDbgCheck(shell != NULL);
|
274 |
|
275 |
// print some time informattion before prompt if configured
|
276 |
if (shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) {
|
277 |
// printf the system uptime
|
278 |
if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_UPTIME) {
|
279 |
// get current system uptime
|
280 |
aos_timestamp_t uptime; |
281 |
aosSysGetUptime(&uptime); |
282 |
|
283 |
chprintf((BaseSequentialStream*)&shell->stream, "[%01u:%02u:%02u:%02u:%03u:%03u] ",
|
284 |
(uint32_t)(uptime / MICROSECONDS_PER_DAY), |
285 |
(uint8_t)(uptime % MICROSECONDS_PER_DAY / MICROSECONDS_PER_HOUR), |
286 |
(uint8_t)(uptime % MICROSECONDS_PER_HOUR / MICROSECONDS_PER_MINUTE), |
287 |
(uint8_t)(uptime % MICROSECONDS_PER_MINUTE / MICROSECONDS_PER_SECOND), |
288 |
(uint16_t)(uptime % MICROSECONDS_PER_SECOND / MICROSECONDS_PER_MILLISECOND), |
289 |
(uint16_t)(uptime % MICROSECONDS_PER_MILLISECOND / MICROSECONDS_PER_MICROSECOND)); |
290 |
} |
291 |
else if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_DATETIME) { |
292 |
// get current RTC time
|
293 |
struct tm dt;
|
294 |
aosSysGetDateTime(&dt); |
295 |
chprintf((BaseSequentialStream*)&shell->stream, "[%02u-%02u-%04u|%02u:%02u:%02u] ",
|
296 |
dt.tm_mday, |
297 |
dt.tm_mon + 1,
|
298 |
dt.tm_year + 1900,
|
299 |
dt.tm_hour, |
300 |
dt.tm_min, |
301 |
dt.tm_sec); |
302 |
} |
303 |
else {
|
304 |
aosDbgAssert(false);
|
305 |
} |
306 |
} |
307 |
|
308 |
// print the actual prompt string
|
309 |
if (shell->prompt && !(shell->config & AOS_SHELL_CONFIG_PROMPT_MINIMAL)) {
|
310 |
chprintf((BaseSequentialStream*)&shell->stream, "%s$ ", shell->prompt);
|
311 |
} else {
|
312 |
chprintf((BaseSequentialStream*)&shell->stream, "%>$ ");
|
313 |
} |
314 |
|
315 |
return;
|
316 |
} |
317 |
|
318 |
/**
|
319 |
* @brief Interprete a escape sequence
|
320 |
*
|
321 |
* @param[in] seq Character sequence to interprete.
|
322 |
* Must be terminated by NUL byte.
|
323 |
*
|
324 |
* @return A @p special_key value.
|
325 |
*/
|
326 |
static special_key_t _interpreteEscapeSequence(const char seq[]) |
327 |
{ |
328 |
// local variables
|
329 |
bool ambiguous = false; |
330 |
int cmp = 0; |
331 |
|
332 |
// TAB
|
333 |
/* not supported yet; use "\x09" instead */
|
334 |
|
335 |
// BACKSPACE
|
336 |
/* not supported yet; use "\x08" instead */
|
337 |
|
338 |
// ESCAPE
|
339 |
cmp = strcmp(seq, "\x1B");
|
340 |
if (cmp == 0) { |
341 |
return KEY_ESCAPE;
|
342 |
} else {
|
343 |
ambiguous |= (cmp < 0);
|
344 |
} |
345 |
|
346 |
// INSERT
|
347 |
cmp = strcmp(seq, "\x1B\x5B\x32\x7E");
|
348 |
if (cmp == 0) { |
349 |
return KEY_INSERT;
|
350 |
} else {
|
351 |
ambiguous |= (cmp < 0);
|
352 |
} |
353 |
|
354 |
// DELETE
|
355 |
cmp = strcmp(seq, "\x1B\x5B\x33\x7E");
|
356 |
if (cmp == 0) { |
357 |
return KEY_DELETE;
|
358 |
} else {
|
359 |
ambiguous |= (cmp < 0);
|
360 |
} |
361 |
|
362 |
// HOME
|
363 |
cmp = strcmp(seq, "\x1B\x4F\x48");
|
364 |
if (cmp == 0) { |
365 |
return KEY_HOME;
|
366 |
} else {
|
367 |
ambiguous |= (cmp < 0);
|
368 |
} |
369 |
|
370 |
// END
|
371 |
cmp = strcmp(seq, "\x1B\x4F\x46");
|
372 |
if (cmp == 0) { |
373 |
return KEY_END;
|
374 |
} else {
|
375 |
ambiguous |= (cmp < 0);
|
376 |
} |
377 |
|
378 |
// PAGE UP
|
379 |
cmp = strcmp(seq, "\x1B\x5B\x35\x7E");
|
380 |
if (cmp == 0) { |
381 |
return KEY_PAGE_UP;
|
382 |
} else {
|
383 |
ambiguous |= (cmp < 0);
|
384 |
} |
385 |
|
386 |
// PAGE DOWN
|
387 |
cmp = strcmp(seq, "\x1B\x5B\x36\x7E");
|
388 |
if (cmp == 0) { |
389 |
return KEY_PAGE_DOWN;
|
390 |
} else {
|
391 |
ambiguous |= (cmp < 0);
|
392 |
} |
393 |
|
394 |
// ARROW UP
|
395 |
cmp = strcmp(seq, "\x1B\x5B\x41");
|
396 |
if (cmp == 0) { |
397 |
return KEY_ARROW_UP;
|
398 |
} else {
|
399 |
ambiguous |= (cmp < 0);
|
400 |
} |
401 |
|
402 |
// ARROW DOWN
|
403 |
cmp = strcmp(seq, "\x1B\x5B\x42");
|
404 |
if (cmp == 0) { |
405 |
return KEY_ARROW_DOWN;
|
406 |
} else {
|
407 |
ambiguous |= (cmp < 0);
|
408 |
} |
409 |
|
410 |
// ARROW LEFT
|
411 |
cmp = strcmp(seq, "\x1B\x5B\x44");
|
412 |
if (cmp == 0) { |
413 |
return KEY_ARROW_LEFT;
|
414 |
} else {
|
415 |
ambiguous |= (cmp < 0);
|
416 |
} |
417 |
|
418 |
// ARROW RIGHT
|
419 |
cmp = strcmp(seq, "\x1B\x5B\x43");
|
420 |
if (cmp == 0) { |
421 |
return KEY_ARROW_RIGHT;
|
422 |
} else {
|
423 |
ambiguous |= (cmp < 0);
|
424 |
} |
425 |
|
426 |
return ambiguous ? KEY_AMBIGUOUS : KEY_UNKNOWN;
|
427 |
} |
428 |
|
429 |
/**
|
430 |
* @brief Move the cursor in the terminal
|
431 |
*
|
432 |
* @param[in] shell Pointer to the shell object.
|
433 |
* @param[in] from Starting position of the cursor.
|
434 |
* @param[in] to Target position to move the cursor to.
|
435 |
*
|
436 |
* @return The number of positions moved.
|
437 |
*/
|
438 |
static int _moveCursor(aos_shell_t* shell, const size_t from, const size_t to) |
439 |
{ |
440 |
aosDbgCheck(shell != NULL);
|
441 |
|
442 |
// local variables
|
443 |
size_t pos = from; |
444 |
|
445 |
// move cursor left by printing backspaces
|
446 |
while (pos > to) {
|
447 |
streamPut(&shell->stream, '\b');
|
448 |
--pos; |
449 |
} |
450 |
|
451 |
// move cursor right by printing line content
|
452 |
while (pos < to) {
|
453 |
streamPut(&shell->stream, shell->line[pos]); |
454 |
++pos; |
455 |
} |
456 |
|
457 |
return (int)pos - (int)from; |
458 |
} |
459 |
|
460 |
/**
|
461 |
* @brief Print content of the shell line
|
462 |
*
|
463 |
* @param[in] shell Pointer to the shell object.
|
464 |
* @param[in] from First position to start printing from.
|
465 |
* @param[in] to Position after the last character to print.
|
466 |
*
|
467 |
* @return Number of characters printed.
|
468 |
*/
|
469 |
static inline size_t _printLine(aos_shell_t* shell, const size_t from, const size_t to) |
470 |
{ |
471 |
aosDbgCheck(shell != NULL);
|
472 |
|
473 |
// local variables
|
474 |
size_t cnt; |
475 |
|
476 |
for (cnt = 0; from + cnt < to; ++cnt) { |
477 |
streamPut(&shell->stream, shell->line[from + cnt]); |
478 |
} |
479 |
|
480 |
return cnt;
|
481 |
} |
482 |
|
483 |
/**
|
484 |
* @brief Compare two characters.
|
485 |
*
|
486 |
* @param[in] lhs First character to compare.
|
487 |
* @param[in] rhs Second character to compare.
|
488 |
*
|
489 |
* @return How well the characters match.
|
490 |
*/
|
491 |
static inline charmatch_t _charcmp(char lhs, char rhs) |
492 |
{ |
493 |
// if lhs is a upper case letter and rhs is a lower case letter
|
494 |
if (lhs >= 'A' && lhs <= 'Z' && rhs >= 'a' && rhs <= 'z') { |
495 |
return (lhs == (rhs - 'a' + 'A')) ? CHAR_MATCH_NCASE : CHAR_MATCH_NOT; |
496 |
} |
497 |
// if lhs is a lower case letter and rhs is a upper case letter
|
498 |
else if (lhs >= 'a' && lhs <= 'z' && rhs >= 'A' && rhs <= 'Z') { |
499 |
return ((lhs - 'a' + 'A') == rhs) ? CHAR_MATCH_NCASE : CHAR_MATCH_NOT; |
500 |
} |
501 |
// default
|
502 |
else {
|
503 |
return (lhs == rhs) ? CHAR_MATCH_CASE : CHAR_MATCH_NOT;
|
504 |
} |
505 |
} |
506 |
|
507 |
/**
|
508 |
* @brief Maps an character from ASCII to a modified custom encoding.
|
509 |
* @details The custom character encoding is very similar to ASCII and has the following structure:
|
510 |
* 0x00=NULL ... 0x40='@' (identically to ASCII)
|
511 |
* 0x4A='a'; 0x4B='A'; 0x4C='b'; 0x4D='B' ... 0x73='z'; 0x74='Z' (custom letter order)
|
512 |
* 0x75='[' ... 0x7A='`' (0x5B..0x60 is ASCII)
|
513 |
* 0x7B='{' ... 0x7F=DEL (identically to ASCII)
|
514 |
*
|
515 |
* @param[in] c Character to map to the custom encoding.
|
516 |
*
|
517 |
* @return The customly encoded character.
|
518 |
*/
|
519 |
static inline char _mapAscii2Custom(const char c) |
520 |
{ |
521 |
if (c >= 'A' && c <= 'Z') { |
522 |
return ((c - 'A') * 2) + 'A' + 1; |
523 |
} else if (c > 'Z' && c < 'a') { |
524 |
return c + ('z' - 'a') + 1; |
525 |
} else if (c >= 'a' && c <= 'z') { |
526 |
return ((c - 'a') * 2) + 'A'; |
527 |
} else {
|
528 |
return c;
|
529 |
} |
530 |
} |
531 |
|
532 |
/**
|
533 |
* @brief Compares two strings wrt letter case.
|
534 |
* @details Comparisson uses a custom character encoding or mapping.
|
535 |
* See @p _mapAscii2Custom for details.
|
536 |
*
|
537 |
* @param[in] str1 First string to compare.
|
538 |
* @param[in] str2 Second string to compare.
|
539 |
* @param[in] cs Flag indicating whether comparison shall be case sensitive.
|
540 |
* @param[in,out] n Maximum number of character to compare (in) and number of matching characters (out).
|
541 |
* If a null pointer is specified, this parameter is ignored.
|
542 |
* If the value pointed to is zero, comarison will not be limited.
|
543 |
* @param[out] m Optional indicator whether there was at least one case mismatch.
|
544 |
*
|
545 |
* @return Integer value indicating the relationship between the strings.
|
546 |
* @retval <0 The first character that does not match has a lower value in str1 than in str2.
|
547 |
* @retval 0 The contents of both strings are equal.
|
548 |
* @retval >0 The first character that does not match has a greater value in str1 than in str2.
|
549 |
*/
|
550 |
static int _strccmp(const char *str1, const char *str2, bool cs, size_t* n, charmatch_t* m) |
551 |
{ |
552 |
aosDbgCheck(str1 != NULL);
|
553 |
aosDbgCheck(str2 != NULL);
|
554 |
|
555 |
// initialize variables
|
556 |
if (m) {
|
557 |
*m = CHAR_MATCH_NOT; |
558 |
} |
559 |
size_t i = 0;
|
560 |
|
561 |
// iterate through the strings
|
562 |
while ((n == NULL) || (*n == 0) || (*n > 0 && i < *n)) { |
563 |
// break on NUL
|
564 |
if (str1[i] == '\0' || str2[i] == '\0') { |
565 |
if (n) {
|
566 |
*n = i; |
567 |
} |
568 |
break;
|
569 |
} |
570 |
// compare character
|
571 |
const charmatch_t match = _charcmp(str1[i], str2[i]);
|
572 |
if ((match == CHAR_MATCH_CASE) || (!cs && match == CHAR_MATCH_NCASE)) {
|
573 |
if (m != NULL && *m != CHAR_MATCH_NCASE) { |
574 |
*m = match; |
575 |
} |
576 |
++i; |
577 |
} else {
|
578 |
if (n) {
|
579 |
*n = i; |
580 |
} |
581 |
break;
|
582 |
} |
583 |
} |
584 |
|
585 |
return _mapAscii2Custom(str1[i]) - _mapAscii2Custom(str2[i]);
|
586 |
} |
587 |
|
588 |
static aos_status_t _readChannel(aos_shell_t* shell, AosShellChannel* channel, size_t* n)
|
589 |
{ |
590 |
aosDbgCheck(shell != NULL);
|
591 |
aosDbgCheck(channel != NULL);
|
592 |
aosDbgCheck(n != NULL);
|
593 |
|
594 |
// local variables
|
595 |
aos_shellaction_t action = AOS_SHELL_ACTION_NONE; |
596 |
char c;
|
597 |
special_key_t key; |
598 |
|
599 |
// initialize output variables
|
600 |
*n = 0;
|
601 |
|
602 |
// read character by character from the channel
|
603 |
while (chnReadTimeout(channel, (uint8_t*)&c, 1, TIME_IMMEDIATE)) { |
604 |
key = KEY_UNKNOWN; |
605 |
|
606 |
// parse escape sequence
|
607 |
if (shell->inputdata.escp > 0) { |
608 |
shell->inputdata.escseq[shell->inputdata.escp] = c; |
609 |
++shell->inputdata.escp; |
610 |
key = _interpreteEscapeSequence(shell->inputdata.escseq); |
611 |
if (key == KEY_AMBIGUOUS) {
|
612 |
// read next byte to resolve ambiguity
|
613 |
continue;
|
614 |
} else {
|
615 |
/*
|
616 |
* If the escape sequence could either be parsed sucessfully
|
617 |
* or there is no match (KEY_UNKNOWN),
|
618 |
* reset the sequence variable and interprete key/character
|
619 |
*/
|
620 |
shell->inputdata.escp = 0;
|
621 |
memset(shell->inputdata.escseq, '\0', sizeof(shell->inputdata.escseq)*sizeof(shell->inputdata.escseq[0])); |
622 |
} |
623 |
} |
624 |
|
625 |
/* interprete keys or character */
|
626 |
{ |
627 |
// default
|
628 |
action = AOS_SHELL_ACTION_NONE; |
629 |
|
630 |
// printable character
|
631 |
if (key == KEY_UNKNOWN && c >= '\x20' && c <= '\x7E') { |
632 |
action = AOS_SHELL_ACTION_READCHAR; |
633 |
} |
634 |
|
635 |
// tab key or character
|
636 |
else if (key == KEY_TAB || c == '\x09') { |
637 |
/*
|
638 |
* pressing tab once applies auto fill
|
639 |
* pressing tab a second time prints suggestions
|
640 |
*/
|
641 |
if (shell->inputdata.lastaction == AOS_SHELL_ACTION_AUTOFILL || shell->inputdata.lastaction == AOS_SHELL_ACTION_SUGGEST) {
|
642 |
action = AOS_SHELL_ACTION_SUGGEST; |
643 |
} else {
|
644 |
action = AOS_SHELL_ACTION_AUTOFILL; |
645 |
} |
646 |
} |
647 |
|
648 |
// INS key
|
649 |
else if (key == KEY_INSERT) { |
650 |
action = AOS_SHELL_ACTION_INSERTTOGGLE; |
651 |
} |
652 |
|
653 |
// DEL key or character
|
654 |
else if (key == KEY_DELETE || c == '\x7F') { |
655 |
// ignore if cursor is at very right
|
656 |
if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
|
657 |
action = AOS_SHELL_ACTION_DELETEFORWARD; |
658 |
} |
659 |
} |
660 |
|
661 |
// backspace key or character
|
662 |
else if (key == KEY_BACKSPACE || c == '\x08') { |
663 |
// ignore if cursor is at very left
|
664 |
if (shell->inputdata.cursorpos > 0) { |
665 |
action = AOS_SHELL_ACTION_DELETEBACKWARD; |
666 |
} |
667 |
} |
668 |
|
669 |
// 'page up' of 'arrow up' key
|
670 |
else if (key == KEY_PAGE_UP || key == KEY_ARROW_UP) { |
671 |
// ignore if there was some input
|
672 |
if (shell->inputdata.noinput) {
|
673 |
action = AOS_SHELL_ACTION_RECALLLAST; |
674 |
} |
675 |
} |
676 |
|
677 |
// 'page down' key, 'arrow done' key, 'end of test' character or 'end of transmission' character
|
678 |
else if (key == KEY_PAGE_DOWN || key == KEY_ARROW_DOWN || c == '\x03' || c == '\x03') { |
679 |
// ignore if line is empty
|
680 |
if (shell->inputdata.lineend > 0) { |
681 |
action = AOS_SHELL_ACTION_CLEAR; |
682 |
} |
683 |
} |
684 |
|
685 |
// 'home' key
|
686 |
else if (key == KEY_HOME) { |
687 |
// ignore if cursor is very left
|
688 |
if (shell->inputdata.cursorpos > 0) { |
689 |
action = AOS_SHELL_ACTION_CURSOR2START; |
690 |
} |
691 |
} |
692 |
|
693 |
// 'end' key
|
694 |
else if (key == KEY_END) { |
695 |
// ignore if cursos is very right
|
696 |
if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
|
697 |
action = AOS_SHELL_ACTION_CURSOR2END; |
698 |
} |
699 |
} |
700 |
|
701 |
// 'arrow left' key
|
702 |
else if (key == KEY_ARROW_LEFT) { |
703 |
// ignore if cursor is very left
|
704 |
if (shell->inputdata.cursorpos > 0) { |
705 |
action = AOS_SHELL_ACTION_CURSORLEFT; |
706 |
} |
707 |
} |
708 |
|
709 |
// 'arrow right' key
|
710 |
else if (key == KEY_ARROW_RIGHT) { |
711 |
// irgnore if cursor is very right
|
712 |
if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
|
713 |
action = AOS_SHELL_ACTION_CURSORRIGHT; |
714 |
} |
715 |
} |
716 |
|
717 |
// carriage return ('\r') or line feed ('\n') character
|
718 |
else if (c == '\x0D' || c == '\x0A') { |
719 |
action = AOS_SHELL_ACTION_EXECUTE; |
720 |
} |
721 |
|
722 |
// ESC key or [ESCAPE] character
|
723 |
else if (key == KEY_ESCAPE || c == '\x1B') { |
724 |
action = AOS_SHELL_ACTION_ESCSTART; |
725 |
} |
726 |
} |
727 |
|
728 |
/* handle function */
|
729 |
switch (action) {
|
730 |
case AOS_SHELL_ACTION_READCHAR:
|
731 |
{ |
732 |
// line is full
|
733 |
if (shell->inputdata.lineend + 1 >= shell->linesize) { |
734 |
_moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
735 |
chprintf((BaseSequentialStream*)&shell->stream, "\n\tmaximum line width reached\n");
|
736 |
_printPrompt(shell); |
737 |
_printLine(shell, 0, shell->inputdata.lineend);
|
738 |
_moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos); |
739 |
} |
740 |
// read character
|
741 |
else {
|
742 |
// clear old line content on first input
|
743 |
if (shell->inputdata.noinput) {
|
744 |
memset(shell->line, '\0', shell->linesize);
|
745 |
shell->inputdata.noinput = false;
|
746 |
} |
747 |
// overwrite content
|
748 |
if (shell->config & AOS_SHELL_CONFIG_INPUT_OVERWRITE) {
|
749 |
shell->line[shell->inputdata.cursorpos] = c; |
750 |
++shell->inputdata.cursorpos; |
751 |
shell->inputdata.lineend = (shell->inputdata.cursorpos > shell->inputdata.lineend) ? shell->inputdata.cursorpos : shell->inputdata.lineend; |
752 |
streamPut(&shell->stream, (uint8_t)c); |
753 |
} |
754 |
// insert character
|
755 |
else {
|
756 |
memmove(&(shell->line[shell->inputdata.cursorpos+1]), &(shell->line[shell->inputdata.cursorpos]), shell->inputdata.lineend - shell->inputdata.cursorpos);
|
757 |
shell->line[shell->inputdata.cursorpos] = c; |
758 |
++shell->inputdata.lineend; |
759 |
_printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
760 |
++shell->inputdata.cursorpos; |
761 |
_moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos); |
762 |
} |
763 |
} |
764 |
break;
|
765 |
} |
766 |
|
767 |
case AOS_SHELL_ACTION_AUTOFILL:
|
768 |
{ |
769 |
const char* fill = shell->line; |
770 |
size_t cmatch = shell->inputdata.cursorpos; |
771 |
charmatch_t matchlevel = CHAR_MATCH_NOT; |
772 |
size_t n; |
773 |
// iterate through command list
|
774 |
for (aos_shellcommand_t* cmd = shell->commands; cmd != NULL; cmd = cmd->next) { |
775 |
// compare current match with command
|
776 |
n = cmatch; |
777 |
charmatch_t mlvl = CHAR_MATCH_NOT; |
778 |
_strccmp(fill, cmd->name, shell->config & AOS_SHELL_CONFIG_MATCH_CASE, (n == 0) ? NULL : &n, &mlvl); |
779 |
const int cmp = (n < cmatch) ? |
780 |
(n - cmatch) : |
781 |
(cmd->name[n] != '\0') ?
|
782 |
strlen(cmd->name) - n : |
783 |
0;
|
784 |
// if an exact match was found
|
785 |
if (cmatch + cmp == shell->inputdata.cursorpos) {
|
786 |
cmatch = shell->inputdata.cursorpos; |
787 |
fill = cmd->name; |
788 |
// break the loop only if there are no case mismatches with the input
|
789 |
n = shell->inputdata.cursorpos; |
790 |
_strccmp(fill, shell->line, false, &n, &mlvl);
|
791 |
if (mlvl == CHAR_MATCH_CASE) {
|
792 |
break;
|
793 |
} |
794 |
} |
795 |
// if a not exact match was found
|
796 |
else if (cmatch + cmp > shell->inputdata.cursorpos) { |
797 |
// if this is the first one
|
798 |
if (fill == shell->line) {
|
799 |
cmatch += cmp; |
800 |
fill = cmd->name; |
801 |
} |
802 |
// if this is a worse one
|
803 |
else if ((cmp < 0) || (cmp == 0 && mlvl == CHAR_MATCH_CASE)) { |
804 |
cmatch += cmp; |
805 |
} |
806 |
} |
807 |
// non matching commands are ignored
|
808 |
else {}
|
809 |
} |
810 |
// evaluate if there are case mismatches
|
811 |
n = cmatch; |
812 |
_strccmp(shell->line, fill, shell->config & AOS_SHELL_CONFIG_MATCH_CASE, &n, &matchlevel); |
813 |
// print the auto fill if any
|
814 |
if (cmatch > shell->inputdata.cursorpos || (cmatch == shell->inputdata.cursorpos && matchlevel == CHAR_MATCH_NCASE)) {
|
815 |
shell->inputdata.noinput = false;
|
816 |
// limit auto fill so it will not overflow the line width
|
817 |
if (shell->inputdata.lineend + (cmatch - shell->inputdata.cursorpos) > shell->linesize) {
|
818 |
cmatch = shell->linesize - shell->inputdata.lineend + shell->inputdata.cursorpos; |
819 |
} |
820 |
// move trailing memory further in the line
|
821 |
memmove(&(shell->line[cmatch]), &(shell->line[shell->inputdata.cursorpos]), shell->inputdata.lineend - shell->inputdata.cursorpos); |
822 |
shell->inputdata.lineend += cmatch - shell->inputdata.cursorpos; |
823 |
// if there was no incorrect case when matching
|
824 |
if (matchlevel == CHAR_MATCH_CASE) {
|
825 |
// insert fill command name to line
|
826 |
memcpy(&(shell->line[shell->inputdata.cursorpos]), &(fill[shell->inputdata.cursorpos]), cmatch - shell->inputdata.cursorpos); |
827 |
// print the output
|
828 |
_printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
829 |
} else {
|
830 |
// overwrite line with fill command name
|
831 |
memcpy(shell->line, fill, cmatch); |
832 |
// reprint the whole line
|
833 |
_moveCursor(shell, shell->inputdata.cursorpos, 0);
|
834 |
_printLine(shell, 0, shell->inputdata.lineend);
|
835 |
} |
836 |
// move cursor to the end of the matching sequence
|
837 |
shell->inputdata.cursorpos = cmatch; |
838 |
_moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos); |
839 |
} |
840 |
break;
|
841 |
} |
842 |
|
843 |
case AOS_SHELL_ACTION_SUGGEST:
|
844 |
{ |
845 |
unsigned int matches = 0; |
846 |
// iterate through command list
|
847 |
for (aos_shellcommand_t* cmd = shell->commands; cmd != NULL; cmd = cmd->next) { |
848 |
// compare line content with command, excpet if cursorpos=0
|
849 |
size_t i = shell->inputdata.cursorpos; |
850 |
if (shell->inputdata.cursorpos > 0) { |
851 |
_strccmp(shell->line, cmd->name, true, &i, NULL); |
852 |
} |
853 |
const int cmp = (i < shell->inputdata.cursorpos) ? |
854 |
(i - shell->inputdata.cursorpos) : |
855 |
(cmd->name[i] != '\0') ?
|
856 |
strlen(cmd->name) - i : |
857 |
0;
|
858 |
// if a match was found
|
859 |
if (cmp > 0) { |
860 |
// if this is the first one
|
861 |
if (matches == 0) { |
862 |
_moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
863 |
streamPut(&shell->stream, '\n');
|
864 |
} |
865 |
// print the command
|
866 |
chprintf((BaseSequentialStream*)&shell->stream, "\t%s\n", cmd->name);
|
867 |
++matches; |
868 |
} |
869 |
} |
870 |
// reprint the prompt and line if any matches have been found
|
871 |
if (matches > 0) { |
872 |
_printPrompt(shell); |
873 |
_printLine(shell, 0, shell->inputdata.lineend);
|
874 |
_moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos); |
875 |
shell->inputdata.noinput = false;
|
876 |
} |
877 |
break;
|
878 |
} |
879 |
|
880 |
case AOS_SHELL_ACTION_INSERTTOGGLE:
|
881 |
{ |
882 |
if (shell->config & AOS_SHELL_CONFIG_INPUT_OVERWRITE) {
|
883 |
shell->config &= ~AOS_SHELL_CONFIG_INPUT_OVERWRITE; |
884 |
} else {
|
885 |
shell->config |= AOS_SHELL_CONFIG_INPUT_OVERWRITE; |
886 |
} |
887 |
break;
|
888 |
} |
889 |
|
890 |
case AOS_SHELL_ACTION_DELETEFORWARD:
|
891 |
{ |
892 |
--shell->inputdata.lineend; |
893 |
memmove(&(shell->line[shell->inputdata.cursorpos]), &(shell->line[shell->inputdata.cursorpos+1]), shell->inputdata.lineend - shell->inputdata.cursorpos);
|
894 |
_printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
895 |
streamPut(&shell->stream, ' ');
|
896 |
_moveCursor(shell, shell->inputdata.lineend + 1, shell->inputdata.cursorpos);
|
897 |
break;
|
898 |
} |
899 |
|
900 |
case AOS_SHELL_ACTION_DELETEBACKWARD:
|
901 |
{ |
902 |
--shell->inputdata.cursorpos; |
903 |
memmove(&(shell->line[shell->inputdata.cursorpos]), &(shell->line[shell->inputdata.cursorpos+1]), shell->inputdata.lineend - shell->inputdata.cursorpos);
|
904 |
--shell->inputdata.lineend; |
905 |
shell->line[shell->inputdata.lineend] = '\0';
|
906 |
_moveCursor(shell, shell->inputdata.cursorpos + 1, shell->inputdata.cursorpos);
|
907 |
_printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
908 |
streamPut(&shell->stream, ' ');
|
909 |
_moveCursor(shell, shell->inputdata.lineend+1, shell->inputdata.cursorpos);
|
910 |
break;
|
911 |
} |
912 |
|
913 |
case AOS_SHELL_ACTION_RECALLLAST:
|
914 |
{ |
915 |
// replace any intermediate NUL bytes with spaces
|
916 |
shell->inputdata.lineend = 0;
|
917 |
size_t nul_start = 0;
|
918 |
size_t nul_end = 0;
|
919 |
// search line for a NUL byte
|
920 |
while (nul_start < shell->linesize) {
|
921 |
if (shell->line[nul_start] == '\0') { |
922 |
nul_end = nul_start + 1;
|
923 |
// keep searcjing for a byte that is not NUL
|
924 |
while (nul_end < shell->linesize) {
|
925 |
if (shell->line[nul_end] != '\0') { |
926 |
// an intermediate NUL sequence was found
|
927 |
memset(&(shell->line[nul_start]), ' ', nul_end - nul_start);
|
928 |
shell->inputdata.lineend = nul_end + 1;
|
929 |
break;
|
930 |
} else {
|
931 |
++nul_end; |
932 |
} |
933 |
} |
934 |
nul_start = nul_end + 1;
|
935 |
} else {
|
936 |
++shell->inputdata.lineend; |
937 |
++nul_start; |
938 |
} |
939 |
} |
940 |
shell->inputdata.cursorpos = shell->inputdata.lineend; |
941 |
// print the line
|
942 |
shell->inputdata.noinput = _printLine(shell, 0, shell->inputdata.lineend) == 0; |
943 |
break;
|
944 |
} |
945 |
|
946 |
case AOS_SHELL_ACTION_CLEAR:
|
947 |
{ |
948 |
// clear output
|
949 |
_moveCursor(shell, shell->inputdata.cursorpos, 0);
|
950 |
for (shell->inputdata.cursorpos = 0; shell->inputdata.cursorpos < shell->inputdata.lineend; ++shell->inputdata.cursorpos) { |
951 |
streamPut(&shell->stream, ' ');
|
952 |
} |
953 |
_moveCursor(shell, shell->inputdata.lineend, 0);
|
954 |
shell->inputdata.cursorpos = 0;
|
955 |
shell->inputdata.lineend = 0;
|
956 |
shell->inputdata.noinput = true;
|
957 |
break;
|
958 |
} |
959 |
|
960 |
case AOS_SHELL_ACTION_CURSOR2START:
|
961 |
{ |
962 |
_moveCursor(shell, shell->inputdata.cursorpos, 0);
|
963 |
shell->inputdata.cursorpos = 0;
|
964 |
break;
|
965 |
} |
966 |
|
967 |
case AOS_SHELL_ACTION_CURSOR2END:
|
968 |
{ |
969 |
_moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.lineend); |
970 |
shell->inputdata.cursorpos = shell->inputdata.lineend; |
971 |
break;
|
972 |
} |
973 |
|
974 |
case AOS_SHELL_ACTION_CURSORLEFT:
|
975 |
{ |
976 |
_moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.cursorpos-1);
|
977 |
--shell->inputdata.cursorpos; |
978 |
break;
|
979 |
} |
980 |
|
981 |
case AOS_SHELL_ACTION_CURSORRIGHT:
|
982 |
{ |
983 |
_moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.cursorpos+1);
|
984 |
++shell->inputdata.cursorpos; |
985 |
break;
|
986 |
} |
987 |
|
988 |
case AOS_SHELL_ACTION_EXECUTE:
|
989 |
{ |
990 |
streamPut(&shell->stream, '\n');
|
991 |
// set the number of read bytes and return
|
992 |
if (!shell->inputdata.noinput) {
|
993 |
*n = shell->linesize - shell->inputdata.lineend; |
994 |
// fill the remainder of the line with NUL bytes
|
995 |
memset(&(shell->line[shell->inputdata.lineend]), '\0', *n);
|
996 |
// reset static variables
|
997 |
shell->inputdata.noinput = true;
|
998 |
} |
999 |
return AOS_SUCCESS;
|
1000 |
break;
|
1001 |
} |
1002 |
|
1003 |
case AOS_SHELL_ACTION_ESCSTART:
|
1004 |
{ |
1005 |
shell->inputdata.escseq[0] = c;
|
1006 |
++shell->inputdata.escp; |
1007 |
break;
|
1008 |
} |
1009 |
|
1010 |
case AOS_SHELL_ACTION_NONE:
|
1011 |
default:
|
1012 |
{ |
1013 |
// do nothing (ignore input) and read next byte
|
1014 |
continue;
|
1015 |
break;
|
1016 |
} |
1017 |
} /* end of switch */
|
1018 |
|
1019 |
shell->inputdata.lastaction = action; |
1020 |
} /* end of while */
|
1021 |
|
1022 |
// no more data could be read from the channel
|
1023 |
return AOS_WARNING;
|
1024 |
} |
1025 |
|
1026 |
/**
|
1027 |
* @brief Parses the content of the input buffer (line) to separate arguments.
|
1028 |
*
|
1029 |
* @param[in] shell Pointer to the shell object.
|
1030 |
*
|
1031 |
* @return Number of arguments found.
|
1032 |
*/
|
1033 |
static size_t _parseArguments(aos_shell_t* shell)
|
1034 |
{ |
1035 |
aosDbgCheck(shell != NULL);
|
1036 |
|
1037 |
/*
|
1038 |
* States for a very small FSM.
|
1039 |
*/
|
1040 |
typedef enum { |
1041 |
START, |
1042 |
SPACE, |
1043 |
TEXT, |
1044 |
END, |
1045 |
} state_t; |
1046 |
|
1047 |
// local variables
|
1048 |
state_t state = START; |
1049 |
size_t arg = 0;
|
1050 |
|
1051 |
// iterate through the line
|
1052 |
for (char* c = shell->line; c < shell->line + shell->linesize; ++c) { |
1053 |
// terminate at first NUL byte
|
1054 |
if (*c == '\0') { |
1055 |
state = END; |
1056 |
break;
|
1057 |
} |
1058 |
// spaces become NUL bytes
|
1059 |
else if (*c == ' ') { |
1060 |
*c = '\0';
|
1061 |
state = SPACE; |
1062 |
} |
1063 |
// handle non-NUL bytes
|
1064 |
else {
|
1065 |
switch (state) {
|
1066 |
case START:
|
1067 |
case SPACE:
|
1068 |
// ignore too many arguments
|
1069 |
if (arg < shell->arglistsize) {
|
1070 |
shell->arglist[arg] = c; |
1071 |
} |
1072 |
++arg; |
1073 |
break;
|
1074 |
case TEXT:
|
1075 |
case END:
|
1076 |
default:
|
1077 |
break;
|
1078 |
} |
1079 |
state = TEXT; |
1080 |
} |
1081 |
} |
1082 |
|
1083 |
// set all remaining argument pointers to NULL
|
1084 |
for (size_t a = arg; a < shell->arglistsize; ++a) {
|
1085 |
shell->arglist[a] = NULL;
|
1086 |
} |
1087 |
|
1088 |
return arg;
|
1089 |
} |
1090 |
|
1091 |
/**
|
1092 |
* @brief Initializes a shell object with the specified parameters.
|
1093 |
*
|
1094 |
* @param[in] shell Pointer to the shell object.
|
1095 |
* @param[in] stream I/O stream to use.
|
1096 |
* @param[in] prompt Prompt line to print (NULL = use default prompt).
|
1097 |
* @param[in] line Pointer to the input buffer.
|
1098 |
* @param[in] linesize Size of the input buffer.
|
1099 |
* @param[in] arglist Pointer to the argument buffer.
|
1100 |
* @param[in] arglistsize Size of te argument buffer.
|
1101 |
*/
|
1102 |
void aosShellInit(aos_shell_t* shell, event_source_t* oseventsource, const char* prompt, char* line, size_t linesize, char** arglist, size_t arglistsize) |
1103 |
{ |
1104 |
aosDbgCheck(shell != NULL);
|
1105 |
aosDbgCheck(oseventsource != NULL);
|
1106 |
aosDbgCheck(line != NULL);
|
1107 |
aosDbgCheck(arglist != NULL);
|
1108 |
|
1109 |
// set parameters
|
1110 |
shell->thread = NULL;
|
1111 |
chEvtObjectInit(&shell->eventSource); |
1112 |
shell->os.eventSource = oseventsource; |
1113 |
aosShellStreamInit(&shell->stream); |
1114 |
shell->prompt = prompt; |
1115 |
shell->commands = NULL;
|
1116 |
shell->execstatus.command = NULL;
|
1117 |
shell->execstatus.retval = 0;
|
1118 |
shell->line = line; |
1119 |
shell->linesize = linesize; |
1120 |
shell->inputdata.lastaction = AOS_SHELL_ACTION_NONE; |
1121 |
shell->inputdata.escp = 0;
|
1122 |
memset(shell->inputdata.escseq, '\0', sizeof(shell->inputdata.escseq)*sizeof(shell->inputdata.escseq[0])); |
1123 |
shell->inputdata.cursorpos = 0;
|
1124 |
shell->inputdata.lineend = 0;
|
1125 |
shell->inputdata.noinput = true;
|
1126 |
shell->arglist = arglist; |
1127 |
shell->arglistsize = arglistsize; |
1128 |
shell->config = 0x00;
|
1129 |
|
1130 |
// initialize arrays
|
1131 |
memset(shell->line, '\0', shell->linesize);
|
1132 |
for (size_t a = 0; a < shell->arglistsize; ++a) { |
1133 |
shell->arglist[a] = NULL;
|
1134 |
} |
1135 |
|
1136 |
return;
|
1137 |
} |
1138 |
|
1139 |
/**
|
1140 |
* @brief Initialize an AosShellStream object.
|
1141 |
*
|
1142 |
* @param[in] stream The AosShellStrem to initialize.
|
1143 |
*/
|
1144 |
void aosShellStreamInit(AosShellStream* stream)
|
1145 |
{ |
1146 |
aosDbgCheck(stream != NULL);
|
1147 |
|
1148 |
stream->vmt = &_streamvmt; |
1149 |
stream->channel = NULL;
|
1150 |
|
1151 |
return;
|
1152 |
} |
1153 |
|
1154 |
/**
|
1155 |
* @brief Initialize an AosShellChannel object with the specified parameters.
|
1156 |
*
|
1157 |
* @param[in] channel The AosShellChannel to initialize.
|
1158 |
* @param[in] asyncchannel An BaseAsynchronousChannel this AosShellChannel is associated with.
|
1159 |
*/
|
1160 |
void aosShellChannelInit(AosShellChannel* channel, BaseAsynchronousChannel* asyncchannel)
|
1161 |
{ |
1162 |
aosDbgCheck(channel != NULL);
|
1163 |
aosDbgCheck(asyncchannel != NULL);
|
1164 |
|
1165 |
channel->vmt = &_channelvmt; |
1166 |
channel->asyncchannel = asyncchannel; |
1167 |
channel->listener.wflags = 0;
|
1168 |
channel->next = NULL;
|
1169 |
channel->flags = 0;
|
1170 |
|
1171 |
return;
|
1172 |
} |
1173 |
|
1174 |
/**
|
1175 |
* @brief Inserts a command to the shells list of commands.
|
1176 |
*
|
1177 |
* @param[in] shell Pointer to the shell object.
|
1178 |
* @param[in] cmd Pointer to the command to add.
|
1179 |
*
|
1180 |
* @return A status value.
|
1181 |
* @retval AOS_SUCCESS The command was added successfully.
|
1182 |
* @retval AOS_ERROR Another command with identical name already exists.
|
1183 |
*/
|
1184 |
aos_status_t aosShellAddCommand(aos_shell_t *shell, aos_shellcommand_t *cmd) |
1185 |
{ |
1186 |
aosDbgCheck(shell != NULL);
|
1187 |
aosDbgCheck(cmd != NULL);
|
1188 |
aosDbgCheck(cmd->name != NULL && strlen(cmd->name) > 0 && strchr(cmd->name, ' ') == NULL && strchr(cmd->name, '\t') == NULL); |
1189 |
aosDbgCheck(cmd->callback != NULL);
|
1190 |
aosDbgCheck(cmd->next == NULL);
|
1191 |
|
1192 |
aos_shellcommand_t* prev = NULL;
|
1193 |
aos_shellcommand_t** curr = &(shell->commands); |
1194 |
|
1195 |
// insert the command to the list wrt lexographical order (exception: lower case characters preceed upper their uppercase counterparts)
|
1196 |
while (*curr != NULL) { |
1197 |
// iterate through the list as long as the command names are 'smaller'
|
1198 |
const int cmp = _strccmp((*curr)->name, cmd->name, true, NULL, NULL); |
1199 |
if (cmp < 0) { |
1200 |
prev = *curr; |
1201 |
curr = &((*curr)->next); |
1202 |
continue;
|
1203 |
} |
1204 |
// error if the command already exists
|
1205 |
else if (cmp == 0) { |
1206 |
return AOS_ERROR;
|
1207 |
} |
1208 |
// insert the command as soon as a 'larger' name was found
|
1209 |
else /* if (cmpval > 0) */ { |
1210 |
cmd->next = *curr; |
1211 |
// special case: the first command is larger
|
1212 |
if (prev == NULL) { |
1213 |
shell->commands = cmd; |
1214 |
} else {
|
1215 |
prev->next = cmd; |
1216 |
} |
1217 |
return AOS_SUCCESS;
|
1218 |
} |
1219 |
} |
1220 |
// the end of the list has been reached
|
1221 |
|
1222 |
// append the command
|
1223 |
*curr = cmd; |
1224 |
return AOS_SUCCESS;
|
1225 |
} |
1226 |
|
1227 |
/**
|
1228 |
* @brief Removes a command from the shells list of commands.
|
1229 |
*
|
1230 |
* @param[in] shell Pointer to the shell object.
|
1231 |
* @param[in] cmd Name of the command to removde.
|
1232 |
* @param[out] removed Optional pointer to the command that was removed.
|
1233 |
*
|
1234 |
* @return A status value.
|
1235 |
* @retval AOS_SUCCESS The command was removed successfully.
|
1236 |
* @retval AOS_ERROR The command name was not found.
|
1237 |
*/
|
1238 |
aos_status_t aosShellRemoveCommand(aos_shell_t *shell, char *cmd, aos_shellcommand_t **removed)
|
1239 |
{ |
1240 |
aosDbgCheck(shell != NULL);
|
1241 |
aosDbgCheck(cmd != NULL && strlen(cmd) > 0); |
1242 |
|
1243 |
aos_shellcommand_t* prev = NULL;
|
1244 |
aos_shellcommand_t** curr = &(shell->commands); |
1245 |
|
1246 |
// iterate through the list and seach for the specified command name
|
1247 |
while (curr != NULL) { |
1248 |
const int cmpval = strcmp((*curr)->name, cmd); |
1249 |
// iterate through the list as long as the command names are 'smaller'
|
1250 |
if (cmpval < 0) { |
1251 |
prev = *curr; |
1252 |
curr = &((*curr)->next); |
1253 |
continue;
|
1254 |
} |
1255 |
// remove the command when found
|
1256 |
else if (cmpval == 0) { |
1257 |
// special case: the first command matches
|
1258 |
if (prev == NULL) { |
1259 |
shell->commands = (*curr)->next; |
1260 |
} else {
|
1261 |
prev->next = (*curr)->next; |
1262 |
} |
1263 |
(*curr)->next = NULL;
|
1264 |
// set the optional output argument
|
1265 |
if (removed != NULL) { |
1266 |
*removed = *curr; |
1267 |
} |
1268 |
return AOS_SUCCESS;
|
1269 |
} |
1270 |
// break the loop if the command names are 'larger'
|
1271 |
else /* if (cmpval > 0) */ { |
1272 |
break;
|
1273 |
} |
1274 |
} |
1275 |
|
1276 |
// if the command was not found, return an error
|
1277 |
return AOS_ERROR;
|
1278 |
} |
1279 |
|
1280 |
/**
|
1281 |
* @brief Add a channel to a AosShellStream.
|
1282 |
*
|
1283 |
* @param[in] stream The AosShellStream to extend.
|
1284 |
* @param[in] channel The channel to be added to the stream.
|
1285 |
*/
|
1286 |
void aosShellStreamAddChannel(AosShellStream* stream, AosShellChannel* channel)
|
1287 |
{ |
1288 |
aosDbgCheck(stream != NULL);
|
1289 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL && channel->next == NULL && (channel->flags & AOS_SHELLCHANNEL_ATTACHED) == 0); |
1290 |
|
1291 |
// prepend the new channel
|
1292 |
chSysLock(); |
1293 |
channel->flags |= AOS_SHELLCHANNEL_ATTACHED; |
1294 |
channel->next = stream->channel; |
1295 |
stream->channel = channel; |
1296 |
chSysUnlock(); |
1297 |
|
1298 |
return;
|
1299 |
} |
1300 |
|
1301 |
/**
|
1302 |
* @brief Remove a channel from an AosShellStream.
|
1303 |
*
|
1304 |
* @param[in] stream The AosShellStream to modify.
|
1305 |
* @param[in] channel The channel to remove.
|
1306 |
* @return
|
1307 |
*/
|
1308 |
aos_status_t aosShellStreamRemoveChannel(AosShellStream* stream, AosShellChannel* channel) |
1309 |
{ |
1310 |
aosDbgCheck(stream != NULL);
|
1311 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL && channel->flags & AOS_SHELLCHANNEL_ATTACHED); |
1312 |
|
1313 |
// local varibales
|
1314 |
AosShellChannel* prev = NULL;
|
1315 |
AosShellChannel* curr = stream->channel; |
1316 |
|
1317 |
// iterate through the list and search for the specified channel
|
1318 |
while (curr != NULL) { |
1319 |
// if the channel was found
|
1320 |
if (curr == channel) {
|
1321 |
chSysLock(); |
1322 |
// special case: the first channel matches (prev is NULL)
|
1323 |
if (prev == NULL) { |
1324 |
stream->channel = curr->next; |
1325 |
} else {
|
1326 |
prev->next = channel->next; |
1327 |
} |
1328 |
curr->next = NULL;
|
1329 |
curr->flags &= ~AOS_SHELLCHANNEL_ATTACHED; |
1330 |
chSysUnlock(); |
1331 |
return AOS_SUCCESS;
|
1332 |
} |
1333 |
} |
1334 |
|
1335 |
// if the channel was not found, return an error
|
1336 |
return AOS_ERROR;
|
1337 |
} |
1338 |
|
1339 |
/**
|
1340 |
* @brief Enable a AosSheööChannel as input.
|
1341 |
*
|
1342 |
* @param[in] channel The channel to enable as input.
|
1343 |
*/
|
1344 |
void aosShellChannelInputEnable(AosShellChannel* channel)
|
1345 |
{ |
1346 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL); |
1347 |
|
1348 |
chSysLock(); |
1349 |
channel->listener.wflags |= CHN_INPUT_AVAILABLE; |
1350 |
channel->flags |= AOS_SHELLCHANNEL_INPUT_ENABLED; |
1351 |
chSysUnlock(); |
1352 |
|
1353 |
return;
|
1354 |
} |
1355 |
|
1356 |
/**
|
1357 |
* @brief Disable a AosSheööChannel as input.
|
1358 |
*
|
1359 |
* @param[in] channel The channel to disable as input.
|
1360 |
*/
|
1361 |
void aosShellChannelInputDisable( AosShellChannel* channel)
|
1362 |
{ |
1363 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL); |
1364 |
|
1365 |
chSysLock(); |
1366 |
channel->listener.wflags &= ~CHN_INPUT_AVAILABLE; |
1367 |
channel->flags &= ~AOS_SHELLCHANNEL_INPUT_ENABLED; |
1368 |
chSysUnlock(); |
1369 |
|
1370 |
return;
|
1371 |
} |
1372 |
|
1373 |
/**
|
1374 |
* @brief Enable a AosSheööChannel as output.
|
1375 |
*
|
1376 |
* @param[in] channel The channel to enable as output.
|
1377 |
*/
|
1378 |
void aosShellChannelOutputEnable(AosShellChannel* channel)
|
1379 |
{ |
1380 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL); |
1381 |
|
1382 |
channel->flags |= AOS_SHELLCHANNEL_OUTPUT_ENABLED; |
1383 |
|
1384 |
return;
|
1385 |
} |
1386 |
|
1387 |
/**
|
1388 |
* @brief Disable a AosSheööChannel as output.
|
1389 |
*
|
1390 |
* @param[in] channel The channel to disable as output.
|
1391 |
*/
|
1392 |
void aosShellChannelOutputDisable(AosShellChannel* channel)
|
1393 |
{ |
1394 |
aosDbgCheck(channel != NULL && channel->asyncchannel != NULL); |
1395 |
|
1396 |
channel->flags &= ~AOS_SHELLCHANNEL_OUTPUT_ENABLED; |
1397 |
|
1398 |
return;
|
1399 |
} |
1400 |
|
1401 |
/**
|
1402 |
* @brief Thread main function.
|
1403 |
*
|
1404 |
* @param[in] aosShellThread Name of the function;
|
1405 |
* @param[in] shell Pointer to the shell object.
|
1406 |
*/
|
1407 |
void aosShellThread(void* shell) |
1408 |
{ |
1409 |
aosDbgCheck(shell != NULL);
|
1410 |
|
1411 |
// local variables
|
1412 |
eventmask_t eventmask; |
1413 |
eventflags_t eventflags; |
1414 |
AosShellChannel* channel; |
1415 |
aos_status_t readeval; |
1416 |
size_t nchars = 0;
|
1417 |
size_t nargs = 0;
|
1418 |
aos_shellcommand_t* cmd; |
1419 |
|
1420 |
|
1421 |
// register OS related events
|
1422 |
chEvtRegisterMask(((aos_shell_t*)shell)->os.eventSource, &(((aos_shell_t*)shell)->os.eventListener), AOS_SHELL_EVENTMASK_OS); |
1423 |
// register events to all input channels
|
1424 |
for (channel = ((aos_shell_t*)shell)->stream.channel; channel != NULL; channel = channel->next) { |
1425 |
chEvtRegisterMaskWithFlags(&(channel->asyncchannel->event), &(channel->listener), AOS_SHELL_EVENTMASK_INPUT, channel->listener.wflags); |
1426 |
} |
1427 |
|
1428 |
// fire start event
|
1429 |
chEvtBroadcastFlags(&(((aos_shell_t*)shell)->eventSource), AOS_SHELL_EVTFLAG_START); |
1430 |
|
1431 |
// print the prompt for the first time
|
1432 |
_printPrompt((aos_shell_t*)shell); |
1433 |
|
1434 |
// enter thread loop
|
1435 |
while (!chThdShouldTerminateX()) {
|
1436 |
// wait for event and handle it accordingly
|
1437 |
eventmask = chEvtWaitOne(ALL_EVENTS); |
1438 |
|
1439 |
// handle event
|
1440 |
switch (eventmask) {
|
1441 |
|
1442 |
// OS related events
|
1443 |
case AOS_SHELL_EVENTMASK_OS:
|
1444 |
{ |
1445 |
eventflags = chEvtGetAndClearFlags(&((aos_shell_t*)shell)->os.eventListener); |
1446 |
// handle shutdown/restart events
|
1447 |
if (eventflags & AOS_SYSTEM_EVENTFLAGS_SHUTDOWN) {
|
1448 |
chThdTerminate(((aos_shell_t*)shell)->thread); |
1449 |
} else {
|
1450 |
// print an error message
|
1451 |
chprintf((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, "\nERROR: unknown OS event received (0x%08X)\n", eventflags);
|
1452 |
} |
1453 |
break;
|
1454 |
} |
1455 |
|
1456 |
// input events
|
1457 |
case AOS_SHELL_EVENTMASK_INPUT:
|
1458 |
{ |
1459 |
// check and handle all channels
|
1460 |
channel = ((aos_shell_t*)shell)->stream.channel; |
1461 |
while (channel != NULL) { |
1462 |
eventflags = chEvtGetAndClearFlags(&channel->listener); |
1463 |
// if there is new input
|
1464 |
if (eventflags & CHN_INPUT_AVAILABLE) {
|
1465 |
// read input from channel
|
1466 |
readeval = _readChannel((aos_shell_t*)shell, channel, &nchars); |
1467 |
// parse input line to argument list only if the input shall be executed
|
1468 |
nargs = (readeval == AOS_SUCCESS && nchars > 0) ? _parseArguments((aos_shell_t*)shell) : 0; |
1469 |
// check number of arguments
|
1470 |
if (nargs > ((aos_shell_t*)shell)->arglistsize) {
|
1471 |
// error too many arguments
|
1472 |
chprintf((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, "\ttoo many arguments\n");
|
1473 |
} else if (nargs > 0) { |
1474 |
// search command list for arg[0] and execute callback
|
1475 |
cmd = ((aos_shell_t*)shell)->commands; |
1476 |
while (cmd != NULL) { |
1477 |
if (strcmp(((aos_shell_t*)shell)->arglist[0], cmd->name) == 0) { |
1478 |
((aos_shell_t*)shell)->execstatus.command = cmd; |
1479 |
chEvtBroadcastFlags(&(((aos_shell_t*)shell)->eventSource), AOS_SHELL_EVTFLAG_EXEC); |
1480 |
((aos_shell_t*)shell)->execstatus.retval = cmd->callback((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, nargs, ((aos_shell_t*)shell)->arglist); |
1481 |
chEvtBroadcastFlags(&(((aos_shell_t*)shell)->eventSource), AOS_SHELL_EVTFLAG_DONE); |
1482 |
// notify if the command was not successful
|
1483 |
if (((aos_shell_t*)shell)->execstatus.retval != 0) { |
1484 |
chprintf((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, "command returned exit status %d\n", ((aos_shell_t*)shell)->execstatus.retval);
|
1485 |
} |
1486 |
break;
|
1487 |
} |
1488 |
cmd = cmd->next; |
1489 |
} /* end of while */
|
1490 |
|
1491 |
// if no matching command was found, print an error
|
1492 |
if (cmd == NULL) { |
1493 |
chprintf((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, "%s: command not found\n", ((aos_shell_t*)shell)->arglist[0]); |
1494 |
} |
1495 |
} |
1496 |
|
1497 |
// reset some internal variables and eprint a new prompt
|
1498 |
if (readeval == AOS_SUCCESS && !chThdShouldTerminateX()) {
|
1499 |
((aos_shell_t*)shell)->inputdata.cursorpos = 0;
|
1500 |
((aos_shell_t*)shell)->inputdata.lineend = 0;
|
1501 |
_printPrompt((aos_shell_t*)shell); |
1502 |
} |
1503 |
} |
1504 |
|
1505 |
// iterate to next channel
|
1506 |
channel = channel->next; |
1507 |
} |
1508 |
break;
|
1509 |
} |
1510 |
|
1511 |
// other events
|
1512 |
default:
|
1513 |
{ |
1514 |
// print an error message
|
1515 |
chprintf((BaseSequentialStream*)&((aos_shell_t*)shell)->stream, "\nSHELL: ERROR: unknown event received (0x%08X)\n", eventmask);
|
1516 |
break;
|
1517 |
} |
1518 |
|
1519 |
} /* end of switch */
|
1520 |
|
1521 |
} /* end of while */
|
1522 |
|
1523 |
// fire event and exit the thread
|
1524 |
chSysLock(); |
1525 |
chEvtBroadcastFlagsI(&(((aos_shell_t*)shell)->eventSource), AOS_SHELL_EVTFLAG_EXIT); |
1526 |
chThdExitS(MSG_OK); |
1527 |
// no chSysUnlock() required since the thread has been terminated an all waiting threads have been woken up
|
1528 |
} |
1529 |
|
1530 |
#endif /* AMIROOS_CFG_SHELL_ENABLE == true */ |
1531 |
|
1532 |
/** @} */
|