forked from TMaxElectronics/UD3-Fibernet-Firmware
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TTerm.c
1108 lines (957 loc) · 41.6 KB
/
TTerm.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* TTerm
*
* Copyright (c) 2020 Thorben Zethoff
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#if PIC32 == 1
#include <xc.h>
#endif
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdarg.h>
#include "FreeRTOS.h"
#include "task.h"
#include "stream_buffer.h"
#include "UART.h"
#include "TTerm.h"
#include "TTerm_cmd.h"
#include "TTerm_AC.h"
#include "TTerm_cwd.h"
#include "apps/apps.h"
TermCommandDescriptor TERM_cmdListHead = {.nextCmd = 0, .commandLength = 0};
unsigned TERM_baseCMDsAdded = 0;
#if EXTENDED_PRINTF == 1
TERMINAL_HANDLE * TERM_createNewHandle(TermPrintHandler printFunction, void * port, unsigned echoEnabled, TermCommandDescriptor * cmdListHead, TermErrorPrinter errorPrinter, const char * usr){
#else
TERMINAL_HANDLE * TERM_createNewHandle(TermPrintHandler printFunction, unsigned echoEnabled, TermCommandDescriptor * cmdListHead, TermErrorPrinter errorPrinter, const char * usr){
#endif
TERMINAL_HANDLE * ret = pvPortMalloc(sizeof(TERMINAL_HANDLE));
memset(ret, 0, sizeof(TERMINAL_HANDLE));
ret->inputBuffer = pvPortMalloc(TERM_INPUTBUFFER_SIZE);
ret->print = printFunction;
#if EXTENDED_PRINTF == 1
ret->port = port;
#endif
ret->echoEnabled = echoEnabled;
ret->cmdListHead = cmdListHead;
ret->currUserName = pvPortMalloc(strlen(usr) + 1 + strlen(TERM_getVT100Code(_VT100_FOREGROUND_COLOR, _VT100_YELLOW)) + strlen(TERM_getVT100Code(_VT100_RESET_ATTRIB, 0)));
sprintf(ret->currUserName, "%s%s%s", TERM_getVT100Code(_VT100_FOREGROUND_COLOR, _VT100_BLUE), usr, TERM_getVT100Code(_VT100_RESET_ATTRIB, 0));
ret->currEscSeqPos = 0xff;
if(errorPrinter == 0){
ret->errorPrinter = TERM_defaultErrorPrinter;
}else{
ret->errorPrinter = errorPrinter;
}
#ifdef TERM_SUPPORT_CWD
ret->cwdPath = pvPortMalloc(2);
strcpy(ret->cwdPath, "/");
#endif
//if this is the first console we initialize we need to add the static commands
if(!TERM_baseCMDsAdded){
TERM_baseCMDsAdded = 1;
TERM_addCommand(CMD_help, "help", "Displays this help message", 0, &TERM_cmdListHead);
TERM_addCommand(CMD_cls, "cls", "Clears the screen", 0, &TERM_cmdListHead);
TERM_addCommand(CMD_reset, "reset", "resets the fibernet", 0, &TERM_cmdListHead);
REGISTER_apps(&TERM_cmdListHead);
#ifdef TERM_SUPPORT_CWD
TERM_addCommand(CMD_ls, "ls", "List directory", 0, &TERM_cmdListHead);
TERM_addCommand(CMD_cd, "cd", "Change directory", 0, &TERM_cmdListHead);
TERM_addCommand(CMD_mkdir, "mkdir", "Make directory", 0, &TERM_cmdListHead);
#endif
TermCommandDescriptor * test = TERM_addCommand(CMD_testCommandHandler, "test", "tests stuff", 0, &TERM_cmdListHead);
head = ACL_create();
ACL_add(head, "-ra");
ACL_add(head, "-r");
ACL_add(head, "-aa");
TERM_addCommandAC(test, ACL_defaultCompleter, head);
}
#ifdef TERM_ENABLE_STARTUP_TEXT
//TODO VT100 reset at boot
//TODO add min start frame to signal that debugging started and print this again
//TODO colors in the boot message
TERM_printBootMessage(ret);
#endif
return ret;
}
void TERM_destroyHandle(TERMINAL_HANDLE * handle){
if(handle->currProgram != NULL){
//try to gracefully shutdown the running program
(*handle->currProgram->inputHandler)(handle, 0x03);
}
vPortFree(handle->inputBuffer);
vPortFree(handle->currUserName);
uint8_t currHistoryPos = 0;
for(;currHistoryPos < TERM_HISTORYSIZE; currHistoryPos++){
if(handle->historyBuffer[currHistoryPos] != 0){
vPortFree(handle->historyBuffer[currHistoryPos]);
handle->historyBuffer[currHistoryPos] = 0;
}
}
vPortFree(handle->autocompleteBuffer);
handle->autocompleteBuffer = NULL;
vPortFree(handle);
}
void TERM_printDebug(TERMINAL_HANDLE * handle, char * format, ...){
//TODO make this nicer... we don't need a double buffer allocation, we should instead send the va_list to the print function. But it is way to late at night for me to code this now...
//TODO implement a debug level control in the terminal handle (permission level?)
va_list arg;
va_start(arg, format);
char * buff = (char*) pvPortMalloc(256);
vsnprintf(buff, 256,format, arg);
ttprintfEcho("\r\n%s", buff);
if(handle->currBufferLength == 0){
ttprintfEcho("%s@%s>", handle->currUserName, TERM_DEVICE_NAME);
}else{
ttprintfEcho("%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
if(handle->inputBuffer[handle->currBufferPosition] != 0) TERM_sendVT100Code(handle, _VT100_CURSOR_BACK_BY, handle->currBufferLength - handle->currBufferPosition);
}
vPortFree(buff);
va_end(arg);
}
#define ESC_IDLE 0xff
#define ESC_START 0
uint8_t TERM_processBuffer(uint8_t * data, uint16_t length, TERMINAL_HANDLE * handle){
uint16_t currPos = 0;
for(;currPos < length; currPos++){
//ttprintfEcho("checking 0x%02x\r\n", data[currPos]);
switch(handle->currEscSeqPos){
case ESC_IDLE:
if(data[currPos] == _CODE_ESC){ //ESC for V100 control sequences
handle->currEscSeqPos = ESC_START;
}else{
TERM_handleInput(data[currPos], handle);
}
break;
case ESC_START:
switch(data[currPos]){
case '[':
handle->escSeqBuff[handle->currEscSeqPos] = data[currPos];
handle->currEscSeqPos++;
break;
case 'c':
handle->currEscSeqPos = ESC_IDLE;
TERM_handleInput(_VT100_RESET, handle);
break;
case _CODE_ESC:
handle->currEscSeqPos = ESC_START;
break;
default:
handle->currEscSeqPos = ESC_IDLE;
TERM_handleInput(_CODE_ESC, handle);
TERM_handleInput(data[currPos], handle);
break;
}
break;
default:
if(isACIILetter(data[currPos])){
switch (data[currPos]){
case 'n':
if(handle->currEscSeqPos == 2){
if(handle->escSeqBuff[0] == '5'){ //Query device status
}else if(handle->escSeqBuff[0] == '6'){ //Query cursor position
}
}
break;
case 'c': //Query device code
if(handle->currEscSeqPos == 1);
break;
case 'F': //end
if(handle->currEscSeqPos == 1){
TERM_handleInput(_VT100_KEY_END, handle);
}
break;
case 'H': //pos1
if(handle->currEscSeqPos == 1){
TERM_handleInput(_VT100_KEY_POS1, handle);
}
break;
case 'C': //cursor forward
if(handle->currEscSeqPos > 1){
handle->escSeqBuff[handle->currEscSeqPos] = 0;
}else{
TERM_handleInput(_VT100_CURSOR_FORWARD, handle);
}
break;
case 'D': //cursor backward
if(handle->currEscSeqPos > 1){
handle->escSeqBuff[handle->currEscSeqPos] = 0;
}else{
TERM_handleInput(_VT100_CURSOR_BACK, handle);
}
break;
case 'A': //cursor up
if(handle->currEscSeqPos > 1){
handle->escSeqBuff[handle->currEscSeqPos] = 0;
}else{
TERM_handleInput(_VT100_CURSOR_UP, handle);
}
break;
case 'B': //cursor down
if(handle->currEscSeqPos > 1){
handle->escSeqBuff[handle->currEscSeqPos] = 0;
}else{
TERM_handleInput(_VT100_CURSOR_DOWN, handle);
}
break;
case 'Z': //shift tab or ident request(at least from exp.; didn't find any official spec containing this)
TERM_handleInput(_VT100_BACKWARDS_TAB, handle);
break;
case '~': //Tilde the end of a special key command (Esc[{keyID}~)
switch(handle->escSeqBuff[1]){
case 0x32:
TERM_handleInput(_VT100_KEY_INS, handle);
break;
case 0x33:
TERM_handleInput(_VT100_KEY_DEL, handle);
break;
case 0x35:
TERM_handleInput(_VT100_KEY_PAGE_UP, handle);
break;
case 0x36:
TERM_handleInput(_VT100_KEY_PAGE_DOWN, handle);
break;
default:
TERM_handleInput(_VT100_INVALID, handle);
break;
}
break;
default: //others
handle->escSeqBuff[handle->currEscSeqPos+1] = 0;
break;
}
handle->currEscSeqPos = ESC_IDLE;
}else{
handle->escSeqBuff[handle->currEscSeqPos] = data[currPos];
handle->currEscSeqPos++;
}
break;
}
}
}
unsigned isACIILetter(char c){
return (c > 64 && c < 91) || (c > 96 && c < 122) || c == '~';
}
void TERM_printBootMessage(TERMINAL_HANDLE * handle){
TERM_sendVT100Code(handle, _VT100_RESET, 0); TERM_sendVT100Code(handle, _VT100_CURSOR_POS1, 0); TERM_sendVT100Code(handle, _VT100_WRAP_OFF, 0);
ttprintfEcho("\r\n\n\n%s\r\n", TERM_startupText1);
ttprintfEcho("%s\r\n", TERM_startupText2);
ttprintfEcho("%s\r\n", TERM_startupText3);
ttprintfEcho("\r\n\n%s%sWARNING%s: You are now in the FiberNet console\r\n", UART_getVT100Code(_VT100_BACKGROUND_COLOR, _VT100_RED), UART_getVT100Code(_VT100_BLINK, 0), UART_getVT100Code(_VT100_RESET_ATTRIB, 0)); TERM_sendVT100Code(handle, _VT100_WRAP_ON, 0);
if(handle->currBufferLength == 0){
ttprintfEcho("\r\n\r\n%s@%s>", handle->currUserName, TERM_DEVICE_NAME);
}else{
ttprintfEcho("\r\n\r\n%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
if(handle->inputBuffer[handle->currBufferPosition] != 0) TERM_sendVT100Code(handle, _VT100_CURSOR_BACK_BY, handle->currBufferLength - handle->currBufferPosition);
}
}
BaseType_t ptr_is_in_ram(void* ptr){
if(ptr > (void*)START_OF_FLASH && ptr < (void*)END_OF_FLASH){
return pdFALSE;
}
return pdTRUE;
}
uint8_t TERM_defaultErrorPrinter(TERMINAL_HANDLE * handle, uint32_t retCode){
switch(retCode){
case TERM_CMD_EXIT_SUCCESS:
ttprintfEcho("\r\n%s@%s>", handle->currUserName, TERM_DEVICE_NAME);
break;
case TERM_CMD_EXIT_ERROR:
ttprintfEcho("\r\nTask returned with error code %d\r\n%s@%s>", retCode, handle->currUserName, TERM_DEVICE_NAME);
break;
case TERM_CMD_EXIT_NOT_FOUND:
ttprintfEcho("\"%s\" is not a valid command. Type \"help\" to see a list of available ones\r\n%s@%s>", handle->inputBuffer, handle->currUserName, TERM_DEVICE_NAME);
break;
}
return 0;
}
uint8_t TERM_handleInput(uint16_t c, TERMINAL_HANDLE * handle){
//ttprintfEcho("received 0x%04x\r\n", c);
if(handle->currProgram != NULL){
//call the handler of the current override
uint8_t currRetCode = (*handle->currProgram->inputHandler)(handle, c);
(*handle->errorPrinter)(handle, currRetCode);
if(c == 0x03){
ttprintfEcho("^C");
}
return 1;
}
switch(c){
case '\r': //enter
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
if(handle->currBufferLength != 0){
ttprintfEcho("\r\n", handle->inputBuffer);
if(handle->historyBuffer[handle->currHistoryWritePosition] != 0){
vPortFree(handle->historyBuffer[handle->currHistoryWritePosition]);
handle->historyBuffer[handle->currHistoryWritePosition] = 0;
}
handle->historyBuffer[handle->currHistoryWritePosition] = pvPortMalloc(handle->currBufferLength + 1);
memcpy(handle->historyBuffer[handle->currHistoryWritePosition], handle->inputBuffer, handle->currBufferLength + 1);
if(++handle->currHistoryWritePosition >= TERM_HISTORYSIZE) handle->currHistoryWritePosition = 0;
handle->currHistoryReadPosition = handle->currHistoryWritePosition;
uint8_t retCode = TERM_interpretCMD(handle->inputBuffer, handle->currBufferLength, handle);
(*handle->errorPrinter)(handle, retCode);
handle->currBufferPosition = 0;
handle->currBufferLength = 0;
handle->inputBuffer[handle->currBufferPosition] = 0;
}else{
ttprintfEcho("\r\n%s@%s>", handle->currUserName, TERM_DEVICE_NAME);
}
break;
case 0x03: //CTRL+c
//TODO reset current buffer
ttprintfEcho("^C");
break;
case 0x08: //backspace (used by xTerm)
case 0x7f: //DEL (used by hTerm)
case _VT100_KEY_DEL:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
if(handle->currBufferPosition < handle->currBufferLength && c == _VT100_KEY_DEL){
handle->currBufferPosition ++;
TERM_sendVT100Code(handle, _VT100_CURSOR_FORWARD, 0);
}else if (c == _VT100_KEY_DEL) {
break;
}
if(handle->currBufferPosition == 0) break;
if(handle->inputBuffer[handle->currBufferPosition] != 0){ //check if we are at the end of our command
//we are somewhere in the middle -> move back existing characters
strsft(handle->inputBuffer, handle->currBufferPosition - 1, -1);
ttprintfEcho("\x08");
TERM_sendVT100Code(handle, _VT100_ERASE_LINE_END, 0);
ttprintfEcho("%s", &handle->inputBuffer[handle->currBufferPosition - 1]);
TERM_sendVT100Code(handle, _VT100_CURSOR_BACK_BY, handle->currBufferLength - handle->currBufferPosition);
handle->currBufferPosition --;
handle->currBufferLength --;
}else{
//we are somewhere at the end -> just delete the current one
handle->inputBuffer[--handle->currBufferPosition] = 0;
ttprintfEcho("\x08 \x08");
handle->currBufferLength --;
}
break;
case _VT100_KEY_END:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
//TODO move cursor to EOL
break;
case _VT100_KEY_POS1:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
//TODO move cursor to BOL
break;
case _VT100_CURSOR_FORWARD:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
if(handle->currBufferPosition < handle->currBufferLength){
handle->currBufferPosition ++;
TERM_sendVT100Code(handle, _VT100_CURSOR_FORWARD, 0);
}
break;
case _VT100_CURSOR_BACK:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
if(handle->currBufferPosition > 0){
handle->currBufferPosition --;
TERM_sendVT100Code(handle, _VT100_CURSOR_BACK, 0);
}
break;
case _VT100_CURSOR_UP:
TERM_checkForCopy(handle, TERM_CHECK_COMP);
do{
if(--handle->currHistoryReadPosition >= TERM_HISTORYSIZE) handle->currHistoryReadPosition = TERM_HISTORYSIZE - 1;
if(handle->historyBuffer[handle->currHistoryReadPosition] != 0){
break;
}
}while(handle->currHistoryReadPosition != handle->currHistoryWritePosition);
//print out the command at the current history read position
if(handle->currHistoryReadPosition == handle->currHistoryWritePosition){
ttprintfEcho("\x07"); //rings a bell doesn't it?
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
}else{
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->historyBuffer[handle->currHistoryReadPosition]);
}
break;
case _VT100_CURSOR_DOWN:
TERM_checkForCopy(handle, TERM_CHECK_COMP);
while(handle->currHistoryReadPosition != handle->currHistoryWritePosition){
if(++handle->currHistoryReadPosition >= TERM_HISTORYSIZE) handle->currHistoryReadPosition = 0;
if(handle->historyBuffer[handle->currHistoryReadPosition] != 0){
break;
}
}
//print out the command at the current history read position
if(handle->currHistoryReadPosition == handle->currHistoryWritePosition){
ttprintfEcho("\x07"); //rings a bell doesn't it?
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
}else{
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->historyBuffer[handle->currHistoryReadPosition]);
}
break;
case '\t': //tab
TERM_checkForCopy(handle, TERM_CHECK_HIST);
if(handle->autocompleteBuffer == NULL){
TERM_doAutoComplete(handle);
}
if(++handle->currAutocompleteCount > handle->autocompleteBufferLength) handle->currAutocompleteCount = 0;
if(handle->currAutocompleteCount == 0){
ttprintfEcho("\x07");
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
}else{
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
unsigned printQuotationMarks = strchr(handle->autocompleteBuffer[handle->currAutocompleteCount - 1], ' ') != 0;
ttprintfEcho(printQuotationMarks ? "\r%s@%s>%.*s\"%s\"" : "\r%s@%s>%.*s%s", handle->currUserName, TERM_DEVICE_NAME, handle->autocompleteStart, handle->inputBuffer, handle->autocompleteBuffer[handle->currAutocompleteCount - 1]);
}
break;
case _VT100_BACKWARDS_TAB:
TERM_checkForCopy(handle, TERM_CHECK_HIST);
if(handle->autocompleteBuffer == NULL){
TERM_doAutoComplete(handle);
}
if(--handle->currAutocompleteCount > handle->autocompleteBufferLength - 1) handle->currAutocompleteCount = handle->autocompleteBufferLength - 1;
if(handle->currAutocompleteCount == 0){
ttprintfEcho("\x07");
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
ttprintfEcho("\r%s@%s>%s", handle->currUserName, TERM_DEVICE_NAME, handle->inputBuffer);
}else{
TERM_sendVT100Code(handle, _VT100_ERASE_LINE, 0);
unsigned printQuotationMarks = strchr(handle->autocompleteBuffer[handle->currAutocompleteCount - 1], ' ') != 0;
ttprintfEcho(printQuotationMarks ? "\r%s@%s>%.*s\"%s\"" : "\r%s@%s>%.*s%s", handle->currUserName, TERM_DEVICE_NAME, handle->autocompleteStart, handle->inputBuffer, handle->autocompleteBuffer[handle->currAutocompleteCount - 1]);
}
break;
case _VT100_RESET:
TERM_printBootMessage(handle);
break;
case 32 ... 126:
TERM_checkForCopy(handle, TERM_CHECK_COMP_AND_HIST);
//TODO check for string length overflow
if(handle->inputBuffer[handle->currBufferPosition] != 0){ //check if we are at the end of our command
strsft(handle->inputBuffer, handle->currBufferPosition, 1);
handle->inputBuffer[handle->currBufferPosition] = c;
TERM_sendVT100Code(handle, _VT100_ERASE_LINE_END, 0);
ttprintfEcho("%s", &handle->inputBuffer[handle->currBufferPosition]);
TERM_sendVT100Code(handle, _VT100_CURSOR_BACK_BY, handle->currBufferLength - handle->currBufferPosition);
handle->currBufferLength ++;
handle->currBufferPosition ++;
}else{
//we are at the end -> just delete the current one
handle->inputBuffer[handle->currBufferPosition++] = c;
handle->inputBuffer[handle->currBufferPosition] = 0;
handle->currBufferLength ++;
ttprintfEcho("%c", c);
}
break;
default:
TERM_printDebug(handle, "unknown code received: 0x%02x\r\n", c);
break;
}
}
void TERM_checkForCopy(TERMINAL_HANDLE * handle, COPYCHECK_MODE mode){
if((mode & TERM_CHECK_COMP) && handle->autocompleteBuffer != NULL){
if(handle->currAutocompleteCount != 0){
char * dst = (char *) ((uint32_t) handle->inputBuffer + handle->autocompleteStart);
if(strchr(handle->autocompleteBuffer[handle->currAutocompleteCount - 1], ' ') != 0){
sprintf(dst, "\"%s\"", handle->autocompleteBuffer[handle->currAutocompleteCount - 1]);
}else{
strcpy(dst, handle->autocompleteBuffer[handle->currAutocompleteCount - 1]);
}
handle->currBufferLength = strlen(handle->inputBuffer);
handle->currBufferPosition = handle->currBufferLength;
handle->inputBuffer[handle->currBufferPosition] = 0;
}
vPortFree(handle->autocompleteBuffer);
handle->autocompleteBuffer = NULL;
}
if((mode & TERM_CHECK_HIST) && handle->currHistoryWritePosition != handle->currHistoryReadPosition){
strcpy(handle->inputBuffer, handle->historyBuffer[handle->currHistoryReadPosition]);
handle->currBufferLength = strlen(handle->inputBuffer);
handle->currBufferPosition = handle->currBufferLength;
handle->currHistoryReadPosition = handle->currHistoryWritePosition;
}
}
char * strnchr(char * str, char c, uint32_t length){
uint32_t currPos = 0;
for(;currPos < length && str[currPos] != 0; currPos++){
if(str[currPos] == c) return &str[currPos];
}
return NULL;
}
void strsft(char * src, int32_t startByte, int32_t offset){
if(offset == 0) return;
if(offset > 0){ //shift forward
uint32_t currPos = strlen(src) + offset;
src[currPos--] = 0;
for(; currPos >= startByte; currPos--){
if(currPos == 0){
src[currPos] = ' ';
break;
}
src[currPos] = src[currPos - offset];
}
return;
}else{ //shift backward
uint32_t currPos = startByte;
for(; src[currPos - offset] != 0; currPos++){
src[currPos] = src[currPos - offset];
}
src[currPos] = src[currPos - offset];
return;
}
}
TermCommandDescriptor * TERM_findCMD(TERMINAL_HANDLE * handle){
uint8_t currPos = 0;
uint16_t cmdLength = handle->currBufferLength;
char * firstSpace = strchr(handle->inputBuffer, ' ');
if(firstSpace != 0){
cmdLength = (uint16_t) ((uint32_t) firstSpace - (uint32_t) handle->inputBuffer);
}
TermCommandDescriptor * currCmd = handle->cmdListHead->nextCmd;
for(;currPos < handle->cmdListHead->commandLength; currPos++){
if(currCmd->commandLength == cmdLength && strncmp(handle->inputBuffer, currCmd->command, cmdLength) == 0) return currCmd;
currCmd = currCmd->nextCmd;
}
return NULL;
}
uint8_t TERM_interpretCMD(char * data, uint16_t dataLength, TERMINAL_HANDLE * handle){
TermCommandDescriptor * cmd = TERM_findCMD(handle);
if(cmd != 0){
uint16_t argCount = TERM_countArgs(data, dataLength);
if(argCount == TERM_ARGS_ERROR_STRING_LITERAL){
ttprintfEcho("\r\nError: unclosed string literal in command\r\n");
return TERM_CMD_EXIT_ERROR;
}
char ** args = 0;
if(argCount != 0){
args = pvPortMalloc(sizeof(char*) * argCount);
TERM_seperateArgs(data, dataLength, args);
}
uint8_t retCode = TERM_CMD_EXIT_ERROR;
if(cmd->function != 0){
configASSERT((cmd->function > 0x9d000000) && (cmd->function < 0x9d040000));
retCode = (*cmd->function)(handle, argCount, args);
}
if(argCount != 0) vPortFree(args);
return retCode;
}
return TERM_CMD_EXIT_NOT_FOUND;
}
uint8_t TERM_seperateArgs(char * data, uint16_t dataLength, char ** buff){
uint8_t count = 0;
uint8_t currPos = 0;
unsigned quoteMark = 0;
char * currStringStart = 0;
char * lastSpace = 0;
for(;currPos<dataLength; currPos++){
switch(data[currPos]){
case ' ':
if(!quoteMark){
data[currPos] = 0;
lastSpace = &data[currPos + 1];
}
break;
case '"':
if(quoteMark){
quoteMark = 0;
if(currStringStart){
data[currPos] = 0;
buff[count++] = currStringStart;
}
}else{
quoteMark = 1;
currStringStart = &data[currPos+1];
}
break;
default:
if(!quoteMark){
if(lastSpace != 0){
buff[count++] = lastSpace;
lastSpace = 0;
}
}
break;
}
}
if(quoteMark) TERM_ARGS_ERROR_STRING_LITERAL;
return count;
}
uint16_t TERM_countArgs(const char * data, uint16_t dataLength){
uint8_t count = 0;
uint8_t currPos = 0;
unsigned quoteMark = 0;
const char * currStringStart = NULL;
const char * lastSpace = NULL;
for(;currPos<dataLength; currPos++){
switch(data[currPos]){
case ' ':
if(!quoteMark){
lastSpace = &data[currPos + 1];
}
break;
case '"':
if(quoteMark){
quoteMark = 0;
if(currStringStart){
count ++;
}
}else{
quoteMark = 1;
currStringStart = &data[currPos+1];
}
break;
case 0:
configASSERT(0);
default:
if(!quoteMark){
if(lastSpace){
count ++;
lastSpace = NULL;
}
}
break;
}
}
if(quoteMark) TERM_ARGS_ERROR_STRING_LITERAL;
return count;
}
void TERM_freeCommandList(TermCommandDescriptor ** cl, uint16_t length){
/*uint8_t currPos = 0;
for(;currPos < length; currPos++){
vPortFree(cl[currPos]);
}*/
vPortFree(cl);
}
TermCommandDescriptor * TERM_addCommand(TermCommandFunction function, const char * command, const char * description, uint8_t minPermissionLevel, TermCommandDescriptor * head){
if(head->commandLength == 0xff) return 0;
TermCommandDescriptor * newCMD = pvPortMalloc(sizeof(TermCommandDescriptor));
newCMD->command = command;
newCMD->commandDescription = description;
newCMD->commandLength = strlen(command);
newCMD->function = function;
newCMD->minPermissionLevel = minPermissionLevel;
newCMD->ACHandler = 0;
TERM_LIST_add(newCMD, head);
return newCMD;
}
void TERM_LIST_add(TermCommandDescriptor * item, TermCommandDescriptor * head){
uint32_t currPos = 0;
TermCommandDescriptor ** lastComp = &head->nextCmd;
TermCommandDescriptor * currComp = head->nextCmd;
while(currPos < head->commandLength){
if(TERM_isSorted(currComp, item)){
*lastComp = item;
item->nextCmd = currComp;
head->commandLength ++;
return;
}
if(currComp->nextCmd == 0){
item->nextCmd = currComp->nextCmd;
currComp->nextCmd = item;
head->commandLength ++;
return;
}
lastComp = &currComp->nextCmd;
currComp = currComp->nextCmd;
}
item->nextCmd = 0;
*lastComp = item;
head->commandLength ++;
}
/*
void ACL_remove(AC_LIST_HEAD * head, char * string){
if(head->isConst || head->elementCount == 0) return;
uint32_t currPos = 0;
AC_LIST_ELEMENT ** lastComp = &head->first;
AC_LIST_ELEMENT * currComp = head->first;
for(;currPos < head->elementCount; currPos++){
if((strlen(currComp->string) == strlen(string)) && (strcmp(currComp->string, string) == 0)){
*lastComp = currComp->next;
//TODO make this portable
if(ptr_is_in_ram(currComp->string)){
vPortFree(currComp->string);
}
vPortFree(currComp);
head->elementCount --;
return;
}
if(currComp->next == 0) break;
lastComp = &currComp->next;
currComp = currComp->next;
}
}
*/
unsigned TERM_isSorted(TermCommandDescriptor * a, TermCommandDescriptor * b){
uint8_t currPos = 0;
//compare the lowercase ASCII values of each character in the command (They are alphabetically sorted)
for(;currPos < a->commandLength && currPos < b->commandLength; currPos++){
char letterA = toLowerCase(a->command[currPos]);
char letterB = toLowerCase(b->command[currPos]);
//if the letters are different we return 1 if a is smaller than b (they are correctly sorted) or zero if its the other way around
if(letterA > letterB){
return 1;
}else if(letterB > letterA){
return 0;
}
}
//the two commands have identical letters for their entire length we check which one is longer (the shortest should come first)
if(a->commandLength > b->commandLength){
return 1;
}else if(b->commandLength > a->commandLength){
return 0;
}else{
//it might happen that a command is added twice (or two identical ones are added), in which case we just say they are sorted correctly and print an error in the console
//TODO implement an alarm here
//UART_print("WARNING: Found identical commands: \"%S\" and \"%S\"\r\n", a->command, b->command);
return 1;
}
}
char toLowerCase(char c){
if(c > 65 && c < 90){
return c + 32;
}
switch(c){
case 'Ü':
return 'ü';
case 'Ä':
return 'ä';
case 'Ö':
return 'ö';
default:
return c;
}
}
void TERM_setCursorPos(TERMINAL_HANDLE * handle, uint16_t x, uint16_t y){
}
void TERM_sendVT100Code(TERMINAL_HANDLE * handle, uint16_t cmd, uint8_t var){
switch(cmd){
case _VT100_RESET:
ttprintfEcho("%cc", 0x1b);
break;
case _VT100_CURSOR_BACK:
ttprintfEcho("\x1b[D");
break;
case _VT100_CURSOR_FORWARD:
ttprintfEcho("\x1b[C");
break;
case _VT100_CURSOR_POS1:
ttprintfEcho("\x1b[H");
break;
case _VT100_CURSOR_END:
ttprintfEcho("\x1b[F");
break;
case _VT100_FOREGROUND_COLOR:
ttprintfEcho("\x1b[%dm", var+30);
break;
case _VT100_BACKGROUND_COLOR:
ttprintfEcho("\x1b[%dm", var+40);
break;
case _VT100_RESET_ATTRIB:
ttprintfEcho("\x1b[0m");
break;
case _VT100_BRIGHT:
ttprintfEcho("\x1b[1m");
break;
case _VT100_DIM:
ttprintfEcho("\x1b[2m");
break;
case _VT100_UNDERSCORE:
ttprintfEcho("\x1b[4m");
break;
case _VT100_BLINK:
ttprintfEcho("\x1b[5m");
break;
case _VT100_REVERSE:
ttprintfEcho("\x1b[7m");
break;
case _VT100_HIDDEN:
ttprintfEcho("\x1b[8m");
break;
case _VT100_ERASE_SCREEN:
ttprintfEcho("\x1b[2J");
break;
case _VT100_ERASE_LINE:
ttprintfEcho("\x1b[2K");
break;
case _VT100_FONT_G0:
ttprintfEcho("\x1b(");
break;
case _VT100_FONT_G1:
ttprintfEcho("\x1b)");
break;
case _VT100_WRAP_ON:
ttprintfEcho("\x1b[7h");
break;
case _VT100_WRAP_OFF:
ttprintfEcho("\x1b[7l");
break;
case _VT100_ERASE_LINE_END:
ttprintfEcho("\x1b[K");
break;
case _VT100_CURSOR_BACK_BY:
ttprintfEcho("\x1b[%dD", var);
break;
case _VT100_CURSOR_FORWARD_BY:
ttprintfEcho("\x1b[%dC", var);
break;
case _VT100_CURSOR_SAVE_POSITION:
ttprintfEcho("\x1b" "7");
break;
case _VT100_CURSOR_RESTORE_POSITION:
ttprintfEcho("\x1b" "8");
break;
case _VT100_CURSOR_ENABLE:
ttprintfEcho("\x1b[?25h");
break;
case _VT100_CURSOR_DISABLE:
ttprintfEcho("\x1b[?25l");
break;
case _VT100_CLS:
ttprintfEcho("\x1b[2J\033[1;1H");
break;
case _VT100_CURSOR_DOWN_BY:
ttprintfEcho("\x1b[%dB", var);
break;
}
}
//returns a static pointer to the requested VT100 code, so it can be used in printf without needing any free() call afterwards
const char * TERM_getVT100Code(uint16_t cmd, uint8_t var){
//INFO this is deprecated since all of the VT100 functions are handled by the terminal now
switch(cmd){
case _VT100_RESET:
return "\x1b" "C";
case _VT100_CURSOR_BACK:
return "\x1b[D";
case _VT100_CURSOR_FORWARD:
return "\x1b[C";
case _VT100_CURSOR_POS1:
return "\x1b[H";
case _VT100_CURSOR_END:
return "\x1b[F";
case _VT100_FOREGROUND_COLOR:
switch(var){
case 0:
return "\x1b[30m";
case 1:
return "\x1b[31m";
case 2:
return "\x1b[32m";
case 3:
return "\x1b[33m";
case 4:
return "\x1b[34m";
case 5:
return "\x1b[35m";
case 6:
return "\x1b[36m";
case 7:
return "\x1b[37m";
default:
return "\x1b[30m";
}
case _VT100_BACKGROUND_COLOR:
switch(var){
case 0:
return "\x1b[40m";
case 1:
return "\x1b[41m";