Statistics
| Branch: | Tag: | Revision:

amiro-os / core / src / aos_shell.c @ 7de0cc90

History | View | Annotate | Download (49.698 KB)

1
/*
2
AMiRo-OS is an operating system designed for the Autonomous Mini Robot (AMiRo) platform.
3
Copyright (C) 2016..2019  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 <amiroos.h>
29
#include <string.h>
30

    
31
#if (AMIROOS_CFG_SHELL_ENABLE == true) || (AMIROOS_CFG_TESTS_ENABLE == true)
32

    
33
/******************************************************************************/
34
/* LOCAL DEFINITIONS                                                          */
35
/******************************************************************************/
36

    
37
/**
38
 * @brief   Event mask to be set on OS related events.
39
 */
40
#define AOS_SHELL_EVENTMASK_OS                  EVENT_MASK(0)
41

    
42
/**
43
 * @brief   Event mask to be set on a input event.
44
 */
45
#define AOS_SHELL_EVENTMASK_INPUT               EVENT_MASK(1)
46

    
47
/******************************************************************************/
48
/* EXPORTED VARIABLES                                                         */
49
/******************************************************************************/
50

    
51
/******************************************************************************/
52
/* LOCAL TYPES                                                                */
53
/******************************************************************************/
54

    
55
/*
56
 * forward declarations
57
 */
58
static size_t _channelwrite(void *instance, const uint8_t *bp, size_t n);
59
static size_t _channelread(void *instance, uint8_t *bp, size_t n);
60
static msg_t _channelput(void *instance, uint8_t b);
61
static msg_t _channelget(void *instance);
62
static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time);
63
static msg_t _channelgett(void *instance, sysinterval_t time);
64
static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time);
65
static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time);
66
static msg_t _channelctl(void *instance, unsigned int operation, void *arg);
67
static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n);
68
static size_t _stremread(void *instance, uint8_t *bp, size_t n);
69
static msg_t _streamput(void *instance, uint8_t b);
70
static msg_t _streamget(void *instance);
71

    
72
static const struct AosShellChannelVMT _channelvmt = {
73
  (size_t) 0,
74
  _channelwrite,
75
  _channelread,
76
  _channelput,
77
  _channelget,
78
  _channelputt,
79
  _channelgett,
80
  _channelwritet,
81
  _channelreadt,
82
  _channelctl,
83
};
84

    
85
static const struct AosShellStreamVMT _streamvmt = {
86
  (size_t) 0,
87
  _streamwrite,
88
  _stremread,
89
  _streamput,
90
  _streamget,
91
};
92

    
93
/**
94
 * @brief   Enumerator of special keyboard keys.
95
 */
96
typedef enum special_key {
97
  KEY_UNKNOWN,      /**< any/unknow key */
98
  KEY_AMBIGUOUS,    /**< key is ambiguous */
99
  KEY_TAB,          /**< tabulator key */
100
  KEY_ESCAPE,       /**< escape key */
101
  KEY_BACKSPACE,    /**< backspace key */
102
  KEY_INSERT,       /**< insert key */
103
  KEY_DELETE,       /**< delete key */
104
  KEY_HOME,         /**< home key */
105
  KEY_END,          /**< end key */
106
  KEY_PAGE_UP,      /**< page up key */
107
  KEY_PAGE_DOWN,    /**< page down key */
108
  KEY_ARROW_UP,     /**< arrow up key */
109
  KEY_ARROW_DOWN,   /**< arrow down key */
110
  KEY_ARROW_LEFT,   /**< arrow left key */
111
  KEY_ARROW_RIGHT,  /**< arrow right key */
112
} special_key_t;
113

    
114
/**
115
 * @brief   Enumerator for case (in)sensitive character matching.
116
 */
117
typedef enum charmatch {
118
  CHAR_MATCH_NOT    = 0,  /**< Characters do not match at all. */
119
  CHAR_MATCH_NCASE  = 1,  /**< Characters would match case insensitive. */
120
  CHAR_MATCH_CASE   = 2,  /**< Characters do match with case. */
121
} charmatch_t;
122

    
123
/******************************************************************************/
124
/* LOCAL VARIABLES                                                            */
125
/******************************************************************************/
126

    
127
/******************************************************************************/
128
/* LOCAL FUNCTIONS                                                            */
129
/******************************************************************************/
130

    
131
/**
132
 * @brief   Implementation of the BaseAsynchronous write() method (inherited from BaseSequentialStream).
133
 */
134
static size_t _channelwrite(void *instance, const uint8_t *bp, size_t n)
135
{
136
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
137
    return streamWrite(((AosShellChannel*)instance)->asyncchannel, bp, n);
138
  } else {
139
    return 0;
140
  }
141
}
142

    
143
/**
144
 * @brief   Implementation of the BaseAsynchronous read() method (inherited from BaseSequentialStream).
145
 */
146
static size_t _channelread(void *instance, uint8_t *bp, size_t n)
147
{
148
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
149
    return streamRead(((AosShellChannel*)instance)->asyncchannel, bp, n);
150
  } else {
151
    return 0;
152
  }
153
}
154

    
155
/**
156
 * @brief   Implementation of the BaseAsynchronous put() method (inherited from BaseSequentialStream).
157
 */
158
static msg_t _channelput(void *instance, uint8_t b)
159
{
160
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
161
    return streamPut(((AosShellChannel*)instance)->asyncchannel, b);
162
  } else {
163
    return MSG_RESET;
164
  }
165
}
166

    
167
/**
168
 * @brief   Implementation of the BaseAsynchronous get() method (inherited from BaseSequentialStream).
169
 */
170
static msg_t _channelget(void *instance)
171
{
172
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
173
    return streamGet(((AosShellChannel*)instance)->asyncchannel);
174
  } else {
175
    return MSG_RESET;
176
  }
177
}
178

    
179
/**
180
 * @brief   Implementation of the BaseAsynchronous putt() method.
181
 */
182
static msg_t _channelputt(void *instance, uint8_t b, sysinterval_t time)
183
{
184
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
185
    return chnPutTimeout(((AosShellChannel*)instance)->asyncchannel, b, time);
186
  } else {
187
    return MSG_RESET;
188
  }
189
}
190

    
191
/**
192
 * @brief   Implementation of the BaseAsynchronous gett() method.
193
 */
194
static msg_t _channelgett(void *instance, sysinterval_t time)
195
{
196
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
197
    return chnGetTimeout(((AosShellChannel*)instance)->asyncchannel, time);
198
  } else {
199
    return MSG_RESET;
200
  }
201
}
202

    
203
/**
204
 * @brief   Implementation of the BaseAsynchronous writet() method.
205
 */
206
static size_t _channelwritet(void *instance, const uint8_t *bp, size_t n, sysinterval_t time)
207
{
208
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_OUTPUT_ENABLED) {
209
    return chnWriteTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
210
  } else {
211
    return 0;
212
  }
213
}
214

    
215
/**
216
 * @brief   Implementation of the BaseAsynchronous readt() method.
217
 */
218
static size_t _channelreadt(void *instance, uint8_t *bp, size_t n, sysinterval_t time)
219
{
220
  if (((AosShellChannel*)instance)->flags & AOS_SHELLCHANNEL_INPUT_ENABLED) {
221
    return chnReadTimeout(((AosShellChannel*)instance)->asyncchannel, bp, n, time);
222
  } else {
223
    return 0;
224
  }
225
}
226

    
227
/**
228
 * @brief   Implementation of the BaseAsynchronousChannel ctl() method.
229
 */
230
static msg_t _channelctl(void *instance, unsigned int operation, void *arg)
231
{
232
  (void) instance;
233

    
234
  switch (operation) {
235
  case CHN_CTL_NOP:
236
    osalDbgCheck(arg == NULL);
237
    break;
238
  case CHN_CTL_INVALID:
239
    osalDbgAssert(false, "invalid CTL operation");
240
    break;
241
  default:
242
    break;
243
  }
244
  return MSG_OK;
245
}
246

    
247
static size_t _streamwrite(void *instance, const uint8_t *bp, size_t n)
248
{
249
  aosDbgCheck(instance != NULL);
250

    
251
  // local variables
252
  AosShellChannel* channel = ((AosShellStream*)instance)->channel;
253
  size_t bytes;
254
  size_t maxbytes = 0;
255

    
256
  // iterate through the list of channels
257
  while (channel != NULL) {
258
    bytes = streamWrite(channel, bp, n);
259
    maxbytes = (bytes > maxbytes) ? bytes : maxbytes;
260
    channel = channel->next;
261
  }
262

    
263
  return maxbytes;
264
}
265

    
266
static size_t _stremread(void *instance, uint8_t *bp, size_t n)
267
{
268
  (void)instance;
269
  (void)bp;
270
  (void)n;
271

    
272
  return 0;
273
}
274

    
275
static msg_t _streamput(void *instance, uint8_t b)
276
{
277
  aosDbgCheck(instance != NULL);
278

    
279
  // local variables
280
  AosShellChannel* channel = ((AosShellStream*)instance)->channel;
281
  msg_t ret = MSG_OK;
282

    
283
  // iterate through the list of channels
284
  while (channel != NULL) {
285
    msg_t ret_ = streamPut(channel, b);
286
    ret = (ret_ < ret) ? ret_ : ret;
287
    channel = channel->next;
288
  }
289

    
290
  return ret;
291
}
292

    
293
static msg_t _streamget(void *instance)
294
{
295
  (void)instance;
296

    
297
  return 0;
298
}
299

    
300
/**
301
 * @brief   Print the shell prompt
302
 * @details Depending on the configuration flags, the system uptime is printed before the prompt string.
303
 *
304
 * @param[in] shell   Pointer to the shell object.
305
 */
306
static void _printPrompt(aos_shell_t* shell)
307
{
308
  aosDbgCheck(shell != NULL);
309

    
310
  // print some time informattion before prompt if configured
311
  if (shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) {
312
    // printf the system uptime
313
    if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_UPTIME) {
314
      // get current system uptime
315
      aos_timestamp_t uptime;
316
      aosSysGetUptime(&uptime);
317

    
318
      chprintf((BaseSequentialStream*)&shell->stream, "[%01u:%02u:%02u:%02u:%03u:%03u] ",
319
               (uint32_t)(uptime / MICROSECONDS_PER_DAY),
320
               (uint8_t)(uptime % MICROSECONDS_PER_DAY / MICROSECONDS_PER_HOUR),
321
               (uint8_t)(uptime % MICROSECONDS_PER_HOUR / MICROSECONDS_PER_MINUTE),
322
               (uint8_t)(uptime % MICROSECONDS_PER_MINUTE / MICROSECONDS_PER_SECOND),
323
               (uint16_t)(uptime % MICROSECONDS_PER_SECOND / MICROSECONDS_PER_MILLISECOND),
324
               (uint16_t)(uptime % MICROSECONDS_PER_MILLISECOND / MICROSECONDS_PER_MICROSECOND));
325
    }
326
#if (HAL_USE_RTC == TRUE)
327
    else if ((shell->config & (AOS_SHELL_CONFIG_PROMPT_UPTIME | AOS_SHELL_CONFIG_PROMPT_DATETIME)) == AOS_SHELL_CONFIG_PROMPT_DATETIME) {
328
      // get current RTC time
329
      struct tm dt;
330
      aosSysGetDateTime(&dt);
331
      chprintf((BaseSequentialStream*)&shell->stream, "[%02u-%02u-%04u|%02u:%02u:%02u] ",
332
               dt.tm_mday,
333
               dt.tm_mon + 1,
334
               dt.tm_year + 1900,
335
               dt.tm_hour,
336
               dt.tm_min,
337
               dt.tm_sec);
338
    }
339
#endif /* (HAL_USE_RTC == TRUE) */
340
    else {
341
      aosDbgAssert(false);
342
    }
343
  }
344

    
345
  // print the actual prompt string
346
  if (shell->prompt && !(shell->config & AOS_SHELL_CONFIG_PROMPT_MINIMAL)) {
347
    chprintf((BaseSequentialStream*)&shell->stream, "%s$ ", shell->prompt);
348
  } else {
349
    chprintf((BaseSequentialStream*)&shell->stream, "%>$ ");
350
  }
351

    
352
  return;
353
}
354

    
355
/**
356
 * @brief   Interprete a escape sequence
357
 * @details This function interpretes escape sequences (starting with ASCII
358
 *          "Escape" character 0x1B) according to the VT100 / VT52 ANSI escape
359
 *          sequence definitions.
360
 * @note    Only the most important escape sequences are implemented yet.
361
 *
362
 * @param[in] seq   Character sequence to interprete.
363
 *                  Must be terminated by NUL byte.
364
 *
365
 * @return          A @p special_key value.
366
 */
367
static special_key_t _interpreteEscapeSequence(const char seq[])
368
{
369
  // local variables
370
  bool ambiguous = false;
371
  int cmp = 0;
372

    
373
  // TAB
374
  /* not supported yet; use "\x09" instead */
375

    
376
  // BACKSPACE
377
  /* not supported yet; use "\x08" instead */
378

    
379
  // ESCAPE
380
  cmp = strcmp(seq, "\x1B");
381
  if (cmp == 0) {
382
    return KEY_ESCAPE;
383
  } else {
384
    ambiguous |= (cmp < 0);
385
  }
386

    
387
  // INSERT
388
  cmp = strcmp(seq, "\x1B\x5B\x32\x7E");
389
  if (cmp == 0) {
390
    return KEY_INSERT;
391
  } else {
392
    ambiguous |= (cmp < 0);
393
  }
394

    
395
  // DELETE
396
  cmp = strcmp(seq, "\x1B\x5B\x33\x7E");
397
  if (cmp == 0) {
398
    return KEY_DELETE;
399
  } else {
400
    ambiguous |= (cmp < 0);
401
  }
402

    
403
  // HOME
404
  cmp = strcmp(seq, "\x1B\x5B\x48");
405
  if (cmp == 0) {
406
    return KEY_HOME;
407
  } else {
408
    ambiguous |= (cmp < 0);
409
  }
410

    
411
  // END
412
  cmp = strcmp(seq, "\x1B\x5B\x46");
413
  if (cmp == 0) {
414
    return KEY_END;
415
  } else {
416
    ambiguous |= (cmp < 0);
417
  }
418

    
419
  // PAGE UP
420
  cmp = strcmp(seq, "\x1B\x5B\x35\x7E");
421
  if (cmp == 0) {
422
    return KEY_PAGE_UP;
423
  } else {
424
    ambiguous |= (cmp < 0);
425
  }
426

    
427
  // PAGE DOWN
428
  cmp = strcmp(seq, "\x1B\x5B\x36\x7E");
429
  if (cmp == 0) {
430
    return KEY_PAGE_DOWN;
431
  } else {
432
    ambiguous |= (cmp < 0);
433
  }
434

    
435
  // ARROW UP
436
  cmp = strcmp(seq, "\x1B\x5B\x41");
437
  if (cmp == 0) {
438
    return KEY_ARROW_UP;
439
  } else {
440
    ambiguous |= (cmp < 0);
441
  }
442

    
443
  // ARROW DOWN
444
  cmp = strcmp(seq, "\x1B\x5B\x42");
445
  if (cmp == 0) {
446
    return KEY_ARROW_DOWN;
447
  } else {
448
    ambiguous |= (cmp < 0);
449
  }
450

    
451
  // ARROW LEFT
452
  cmp = strcmp(seq, "\x1B\x5B\x44");
453
  if (cmp == 0) {
454
    return KEY_ARROW_LEFT;
455
  } else {
456
    ambiguous |= (cmp < 0);
457
  }
458

    
459
  // ARROW RIGHT
460
  cmp = strcmp(seq, "\x1B\x5B\x43");
461
  if (cmp == 0) {
462
    return KEY_ARROW_RIGHT;
463
  } else {
464
    ambiguous |= (cmp < 0);
465
  }
466

    
467
  return ambiguous ? KEY_AMBIGUOUS : KEY_UNKNOWN;
468
}
469

    
470
/**
471
 * @brief   Move the cursor in the terminal
472
 *
473
 * @param[in] shell   Pointer to the shell object.
474
 * @param[in] from    Starting position of the cursor.
475
 * @param[in] to      Target position to move the cursor to.
476
 *
477
 * @return            The number of positions moved.
478
 */
479
static int _moveCursor(aos_shell_t* shell, const size_t from, const size_t to)
480
{
481
  aosDbgCheck(shell != NULL);
482

    
483
  // local variables
484
  size_t pos = from;
485

    
486
  // move cursor left by printing backspaces
487
  while (pos > to) {
488
    streamPut(&shell->stream, '\b');
489
    --pos;
490
  }
491

    
492
  // move cursor right by printing line content
493
  while (pos < to) {
494
    streamPut(&shell->stream, shell->line[pos]);
495
    ++pos;
496
  }
497

    
498
  return (int)pos - (int)from;
499
}
500

    
501
/**
502
 * @brief   Print content of the shell line
503
 *
504
 * @param[in] shell   Pointer to the shell object.
505
 * @param[in] from    First position to start printing from.
506
 * @param[in] to      Position after the last character to print.
507
 *
508
 * @return            Number of characters printed.
509
 */
510
static inline size_t _printLine(aos_shell_t* shell, const size_t from, const size_t to)
511
{
512
  aosDbgCheck(shell != NULL);
513

    
514
  // local variables
515
  size_t cnt;
516

    
517
  for (cnt = 0; from + cnt < to; ++cnt) {
518
    streamPut(&shell->stream, shell->line[from + cnt]);
519
  }
520

    
521
  return cnt;
522
}
523

    
524
/**
525
 * @brief   Compare two characters.
526
 *
527
 * @param[in] lhs       First character to compare.
528
 * @param[in] rhs       Second character to compare.
529
 *
530
 * @return              How well the characters match.
531
 */
532
static inline charmatch_t _charcmp(char lhs, char rhs)
533
{
534
  // if lhs is a upper case letter and rhs is a lower case letter
535
  if (lhs >= 'A' && lhs <= 'Z' && rhs >= 'a' && rhs <= 'z') {
536
    return (lhs == (rhs - 'a' + 'A')) ? CHAR_MATCH_NCASE : CHAR_MATCH_NOT;
537
  }
538
  // if lhs is a lower case letter and rhs is a upper case letter
539
  else if (lhs >= 'a' && lhs <= 'z' && rhs >= 'A' && rhs <= 'Z') {
540
    return ((lhs - 'a' + 'A') == rhs) ? CHAR_MATCH_NCASE : CHAR_MATCH_NOT;
541
  }
542
  // default
543
  else {
544
    return (lhs == rhs) ? CHAR_MATCH_CASE : CHAR_MATCH_NOT;
545
  }
546
}
547

    
548
/**
549
 * @brief   Maps an character from ASCII to a modified custom encoding.
550
 * @details The custom character encoding is very similar to ASCII and has the following structure:
551
 *          0x00=NULL ... 0x40='@' (identically to ASCII)
552
 *          0x4A='a'; 0x4B='A'; 0x4C='b'; 0x4D='B' ... 0x73='z'; 0x74='Z' (custom letter order)
553
 *          0x75='[' ... 0x7A='`' (0x5B..0x60 is ASCII)
554
 *          0x7B='{' ... 0x7F=DEL (identically to ASCII)
555
 *
556
 * @param[in] c   Character to map to the custom encoding.
557
 *
558
 * @return    The customly encoded character.
559
 */
560
static inline char _mapAscii2Custom(const char c)
561
{
562
  if (c >= 'A' && c <= 'Z') {
563
    return ((c - 'A') * 2) + 'A' + 1;
564
  } else if (c > 'Z' && c < 'a') {
565
    return c + ('z' - 'a') + 1;
566
  } else if (c >= 'a' && c <= 'z') {
567
    return ((c - 'a') * 2) + 'A';
568
  } else {
569
    return c;
570
  }
571
}
572

    
573
/**
574
 * @brief   Compares two strings wrt letter case.
575
 * @details Comparisson uses a custom character encoding or mapping.
576
 *          See @p _mapAscii2Custom for details.
577
 *
578
 * @param[in] str1    First string to compare.
579
 * @param[in] str2    Second string to compare.
580
 * @param[in] cs      Flag indicating whether comparison shall be case sensitive.
581
 * @param[in,out] n   Maximum number of character to compare (in) and number of matching characters (out).
582
 *                    If a null pointer is specified, this parameter is ignored.
583
 *                    If the value pointed to is zero, comarison will not be limited.
584
 * @param[out] m      Optional indicator whether there was at least one case mismatch.
585
 *
586
 * @return      Integer value indicating the relationship between the strings.
587
 * @retval <0   The first character that does not match has a lower value in str1 than in str2.
588
 * @retval  0   The contents of both strings are equal.
589
 * @retval >0   The first character that does not match has a greater value in str1 than in str2.
590
 */
591
static int _strccmp(const char *str1, const char *str2, bool cs, size_t* n, charmatch_t* m)
592
{
593
  aosDbgCheck(str1 != NULL);
594
  aosDbgCheck(str2 != NULL);
595

    
596
  // initialize variables
597
  if (m) {
598
    *m = CHAR_MATCH_NOT;
599
  }
600
  size_t i = 0;
601

    
602
  // iterate through the strings
603
  while ((n == NULL) || (*n == 0) || (*n > 0 && i < *n)) {
604
    // break on NUL
605
    if (str1[i] == '\0' || str2[i] == '\0') {
606
      if (n) {
607
        *n = i;
608
      }
609
      break;
610
    }
611
    // compare character
612
    const charmatch_t match = _charcmp(str1[i], str2[i]);
613
    if ((match == CHAR_MATCH_CASE) || (!cs && match == CHAR_MATCH_NCASE)) {
614
      if (m != NULL && *m != CHAR_MATCH_NCASE) {
615
        *m = match;
616
      }
617
      ++i;
618
    } else {
619
      if (n) {
620
        *n = i;
621
      }
622
      break;
623
    }
624
  }
625

    
626
  return _mapAscii2Custom(str1[i]) - _mapAscii2Custom(str2[i]);
627
}
628

    
629
/**
630
 * @brief   Read input from a channel as long as there is data available.
631
 *
632
 * @param[in]   shell     Pointer to the shell object.
633
 * @param[in]   channel   The channel to read from.
634
 * @param[out]  n         Pointer to a variable to store the number of read characters to.
635
 *
636
 * @return
637
 */
638
static aos_status_t _readChannel(aos_shell_t* shell, AosShellChannel* channel, size_t* n)
639
{
640
  aosDbgCheck(shell != NULL);
641
  aosDbgCheck(channel != NULL);
642
  aosDbgCheck(n != NULL);
643

    
644
  // local variables
645
  aos_shellaction_t action = AOS_SHELL_ACTION_NONE;
646
  char c;
647
  special_key_t key;
648

    
649
  // initialize output variables
650
  *n = 0;
651

    
652
  // read character by character from the channel
653
  while (chnReadTimeout(channel, (uint8_t*)&c, 1, TIME_IMMEDIATE)) {
654
    key = KEY_UNKNOWN;
655

    
656
    // parse escape sequence
657
    if (shell->inputdata.escp > 0) {
658
      shell->inputdata.escseq[shell->inputdata.escp] = c;
659
      ++shell->inputdata.escp;
660
      key = _interpreteEscapeSequence(shell->inputdata.escseq);
661
      if (key == KEY_AMBIGUOUS) {
662
        // read next byte to resolve ambiguity
663
        continue;
664
      } else {
665
        /*
666
         * If the escape sequence could either be parsed sucessfully
667
         * or there is no match (KEY_UNKNOWN),
668
         * reset the sequence variable and interprete key/character
669
         */
670
        shell->inputdata.escp = 0;
671
        memset(shell->inputdata.escseq, '\0', sizeof(shell->inputdata.escseq)*sizeof(shell->inputdata.escseq[0]));
672
      }
673
    }
674

    
675
    /* interprete keys or character */
676
    {
677
      // default
678
      action = AOS_SHELL_ACTION_NONE;
679

    
680
      // printable character
681
      if (key == KEY_UNKNOWN && c >= '\x20' && c <= '\x7E') {
682
        action = AOS_SHELL_ACTION_READCHAR;
683
      }
684

    
685
      // tab key or character
686
      else if (key == KEY_TAB || c == '\x09') {
687
        /*
688
         * pressing tab once applies auto fill
689
         * pressing tab a second time prints suggestions
690
         */
691
        if (shell->inputdata.lastaction == AOS_SHELL_ACTION_AUTOFILL || shell->inputdata.lastaction == AOS_SHELL_ACTION_SUGGEST) {
692
          action = AOS_SHELL_ACTION_SUGGEST;
693
        } else {
694
          action = AOS_SHELL_ACTION_AUTOFILL;
695
        }
696
      }
697

    
698
      // INS key
699
      else if (key == KEY_INSERT) {
700
        action = AOS_SHELL_ACTION_INSERTTOGGLE;
701
      }
702

    
703
      // DEL key or character
704
      else if (key == KEY_DELETE || c == '\x7F') {
705
        // ignore if cursor is at very right
706
        if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
707
          action = AOS_SHELL_ACTION_DELETEFORWARD;
708
        }
709
      }
710

    
711
      // backspace key or character
712
      else if (key == KEY_BACKSPACE || c == '\x08') {
713
        // ignore if cursor is at very left
714
        if (shell->inputdata.cursorpos > 0) {
715
          action = AOS_SHELL_ACTION_DELETEBACKWARD;
716
        }
717
      }
718

    
719
      // 'page up' of 'arrow up' key
720
      else if (key == KEY_PAGE_UP || key == KEY_ARROW_UP) {
721
        // ignore if there was some input
722
        if (shell->inputdata.noinput) {
723
          action = AOS_SHELL_ACTION_RECALLLAST;
724
        }
725
      }
726

    
727
      // 'page down' key, 'arrow done' key, 'end of test' character or 'end of transmission' character
728
      else if (key == KEY_PAGE_DOWN || key == KEY_ARROW_DOWN || c == '\x03' || c == '\x03') {
729
        // ignore if line is empty
730
        if (shell->inputdata.lineend > 0) {
731
          action = AOS_SHELL_ACTION_CLEAR;
732
        }
733
      }
734

    
735
      // 'home' key
736
      else if (key == KEY_HOME) {
737
        // ignore if cursor is very left
738
        if (shell->inputdata.cursorpos > 0) {
739
          action = AOS_SHELL_ACTION_CURSOR2START;
740
        }
741
      }
742

    
743
      // 'end' key
744
      else if (key == KEY_END) {
745
        // ignore if cursos is very right
746
        if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
747
          action = AOS_SHELL_ACTION_CURSOR2END;
748
        }
749
      }
750

    
751
      // 'arrow left' key
752
      else if (key == KEY_ARROW_LEFT) {
753
        // ignore if cursor is very left
754
        if (shell->inputdata.cursorpos > 0) {
755
          action = AOS_SHELL_ACTION_CURSORLEFT;
756
        }
757
      }
758

    
759
      // 'arrow right' key
760
      else if (key == KEY_ARROW_RIGHT) {
761
        // irgnore if cursor is very right
762
        if (shell->inputdata.cursorpos < shell->inputdata.lineend) {
763
          action = AOS_SHELL_ACTION_CURSORRIGHT;
764
        }
765
      }
766

    
767
      // carriage return ('\r') or line feed ('\n') character
768
      else if (c == '\x0D' || c == '\x0A') {
769
        action = AOS_SHELL_ACTION_EXECUTE;
770
      }
771

    
772
      // ESC key or [ESCAPE] character
773
      else if (key == KEY_ESCAPE || c == '\x1B') {
774
        action = AOS_SHELL_ACTION_ESCSTART;
775
      }
776
    }
777

    
778
    /* handle function */
779
    switch (action) {
780
      case AOS_SHELL_ACTION_READCHAR:
781
      {
782
        // line is full
783
        if (shell->inputdata.lineend + 1 >= shell->linesize) {
784
          _moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.lineend);
785
          chprintf((BaseSequentialStream*)&shell->stream, "\n\tmaximum line width reached\n");
786
          _printPrompt(shell);
787
          _printLine(shell, 0, shell->inputdata.lineend);
788
          _moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos);
789
        }
790
        // read character
791
        else {
792
          // clear old line content on first input
793
          if (shell->inputdata.noinput) {
794
            memset(shell->line, '\0', shell->linesize);
795
            shell->inputdata.noinput = false;
796
          }
797
          // overwrite content
798
          if (shell->config & AOS_SHELL_CONFIG_INPUT_OVERWRITE) {
799
            shell->line[shell->inputdata.cursorpos] = c;
800
            ++shell->inputdata.cursorpos;
801
            shell->inputdata.lineend = (shell->inputdata.cursorpos > shell->inputdata.lineend) ? shell->inputdata.cursorpos : shell->inputdata.lineend;
802
            streamPut(&shell->stream, (uint8_t)c);
803
          }
804
          // insert character
805
          else {
806
            memmove(&(shell->line[shell->inputdata.cursorpos+1]), &(shell->line[shell->inputdata.cursorpos]), shell->inputdata.lineend - shell->inputdata.cursorpos);
807
            shell->line[shell->inputdata.cursorpos] = c;
808
            ++shell->inputdata.lineend;
809
            _printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend);
810
            ++shell->inputdata.cursorpos;
811
            _moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos);
812
          }
813
        }
814
        break;
815
      }
816

    
817
      case AOS_SHELL_ACTION_AUTOFILL:
818
      {
819
        const char* fill = shell->line;
820
        size_t cmatch = shell->inputdata.cursorpos;
821
        charmatch_t matchlevel = CHAR_MATCH_NOT;
822
        size_t n;
823
        // iterate through command list
824
        for (aos_shellcommand_t* cmd = shell->commands; cmd != NULL; cmd = cmd->next) {
825
          // compare current match with command
826
          n = cmatch;
827
          charmatch_t mlvl = CHAR_MATCH_NOT;
828
          _strccmp(fill, cmd->name, shell->config & AOS_SHELL_CONFIG_MATCH_CASE, (n == 0) ? NULL : &n, &mlvl);
829
          const int cmp = (n < cmatch) ?
830
                            (n - cmatch) :
831
                            (cmd->name[n] != '\0') ?
832
                              strlen(cmd->name) - n :
833
                              0;
834
          // if an exact match was found
835
          if (cmatch + cmp == shell->inputdata.cursorpos) {
836
            cmatch = shell->inputdata.cursorpos;
837
            fill = cmd->name;
838
            // break the loop only if there are no case mismatches with the input
839
            n = shell->inputdata.cursorpos;
840
            _strccmp(fill, shell->line, false, &n, &mlvl);
841
            if (mlvl == CHAR_MATCH_CASE) {
842
              break;
843
            }
844
          }
845
          // if a not exact match was found
846
          else if (cmatch + cmp > shell->inputdata.cursorpos) {
847
            // if this is the first one
848
            if (fill == shell->line) {
849
              cmatch += cmp;
850
              fill = cmd->name;
851
            }
852
            // if this is a worse one
853
            else if ((cmp < 0) || (cmp == 0 && mlvl == CHAR_MATCH_CASE)) {
854
              cmatch += cmp;
855
            }
856
          }
857
          // non matching commands are ignored
858
          else {}
859
        }
860
        // evaluate if there are case mismatches
861
        n = cmatch;
862
        _strccmp(shell->line, fill, shell->config & AOS_SHELL_CONFIG_MATCH_CASE, &n, &matchlevel);
863
        // print the auto fill if any
864
        if (cmatch > shell->inputdata.cursorpos || (cmatch == shell->inputdata.cursorpos && matchlevel == CHAR_MATCH_NCASE)) {
865
          shell->inputdata.noinput = false;
866
          // limit auto fill so it will not overflow the line width
867
          if (shell->inputdata.lineend + (cmatch - shell->inputdata.cursorpos) > shell->linesize) {
868
            cmatch = shell->linesize - shell->inputdata.lineend + shell->inputdata.cursorpos;
869
          }
870
          // move trailing memory further in the line
871
          memmove(&(shell->line[cmatch]), &(shell->line[shell->inputdata.cursorpos]), shell->inputdata.lineend - shell->inputdata.cursorpos);
872
          shell->inputdata.lineend += cmatch - shell->inputdata.cursorpos;
873
          // if there was no incorrect case when matching
874
          if (matchlevel == CHAR_MATCH_CASE) {
875
            // insert fill command name to line
876
            memcpy(&(shell->line[shell->inputdata.cursorpos]), &(fill[shell->inputdata.cursorpos]), cmatch - shell->inputdata.cursorpos);
877
            // print the output
878
            _printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend);
879
          } else {
880
            // overwrite line with fill command name
881
            memcpy(shell->line, fill, cmatch);
882
            // reprint the whole line
883
            _moveCursor(shell, shell->inputdata.cursorpos, 0);
884
            _printLine(shell, 0, shell->inputdata.lineend);
885
          }
886
          // move cursor to the end of the matching sequence
887
          shell->inputdata.cursorpos = cmatch;
888
          _moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos);
889
        }
890
        break;
891
      }
892

    
893
      case AOS_SHELL_ACTION_SUGGEST:
894
      {
895
        unsigned int matches = 0;
896
        // iterate through command list
897
        for (aos_shellcommand_t* cmd = shell->commands; cmd != NULL; cmd = cmd->next) {
898
          // compare line content with command, excpet if cursorpos=0
899
          size_t i = shell->inputdata.cursorpos;
900
          if (shell->inputdata.cursorpos > 0) {
901
            _strccmp(shell->line, cmd->name, true, &i, NULL);
902
          }
903
          const int cmp = (i < shell->inputdata.cursorpos) ?
904
                            (i - shell->inputdata.cursorpos) :
905
                            (cmd->name[i] != '\0') ?
906
                              strlen(cmd->name) - i :
907
                              0;
908
          // if a match was found
909
          if (cmp > 0) {
910
            // if this is the first one
911
            if (matches == 0) {
912
              _moveCursor(shell, shell->inputdata.cursorpos, shell->inputdata.lineend);
913
              streamPut(&shell->stream, '\n');
914
            }
915
            // print the command
916
            chprintf((BaseSequentialStream*)&shell->stream, "\t%s\n", cmd->name);
917
            ++matches;
918
          }
919
        }
920
        // reprint the prompt and line if any matches have been found
921
        if (matches > 0) {
922
          _printPrompt(shell);
923
          _printLine(shell, 0, shell->inputdata.lineend);
924
          _moveCursor(shell, shell->inputdata.lineend, shell->inputdata.cursorpos);
925
          shell->inputdata.noinput = false;
926
        }
927
        break;
928
      }
929

    
930
      case AOS_SHELL_ACTION_INSERTTOGGLE:
931
      {
932
        if (shell->config & AOS_SHELL_CONFIG_INPUT_OVERWRITE) {
933
          shell->config &= ~AOS_SHELL_CONFIG_INPUT_OVERWRITE;
934
        } else {
935
          shell->config |= AOS_SHELL_CONFIG_INPUT_OVERWRITE;
936
        }
937
        break;
938
      }
939

    
940
      case AOS_SHELL_ACTION_DELETEFORWARD:
941
      {
942
        --shell->inputdata.lineend;
943
        memmove(&(shell->line[shell->inputdata.cursorpos]), &(shell->line[shell->inputdata.cursorpos+1]), shell->inputdata.lineend - shell->inputdata.cursorpos);
944
        _printLine(shell, shell->inputdata.cursorpos, shell->inputdata.lineend);
945
        streamPut(&s