cli.c 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. #include "cli_i.h"
  2. #include "cli_commands.h"
  3. Cli* cli_alloc() {
  4. Cli* cli = furi_alloc(sizeof(Cli));
  5. CliCommandDict_init(cli->commands);
  6. cli->mutex = osMutexNew(NULL);
  7. furi_check(cli->mutex);
  8. cli_reset_state(cli);
  9. return cli;
  10. }
  11. void cli_free(Cli* cli) {
  12. free(cli);
  13. }
  14. void cli_reset_state(Cli* cli) {
  15. // Release allocated buffer, reset state
  16. string_clear(cli->line);
  17. string_init(cli->line);
  18. }
  19. void cli_putc(char c) {
  20. api_hal_vcp_tx((uint8_t*)&c, 1);
  21. }
  22. void cli_read(char* buffer, size_t size) {
  23. api_hal_vcp_rx((uint8_t*)buffer, size);
  24. }
  25. void cli_print(const char* str) {
  26. api_hal_vcp_tx((uint8_t*)str, strlen(str));
  27. }
  28. void cli_print_version() {
  29. cli_print("Build date:" BUILD_DATE ". "
  30. "Git Commit:" GIT_COMMIT ". "
  31. "Git Branch:" GIT_BRANCH ". "
  32. "Commit Number:" GIT_BRANCH_NUM ".");
  33. }
  34. void cli_motd() {
  35. cli_print("Flipper cli.\r\n");
  36. cli_print_version();
  37. }
  38. void cli_nl() {
  39. cli_print("\r\n");
  40. }
  41. void cli_prompt() {
  42. cli_print("\r\n>: ");
  43. }
  44. void cli_backspace(Cli* cli) {
  45. size_t s = string_size(cli->line);
  46. if(s > 0) {
  47. s--;
  48. string_left(cli->line, s);
  49. cli_putc(CliSymbolAsciiBackspace);
  50. cli_putc(CliSymbolAsciiSpace);
  51. cli_putc(CliSymbolAsciiBackspace);
  52. } else {
  53. cli_putc(CliSymbolAsciiBell);
  54. }
  55. }
  56. void cli_enter(Cli* cli) {
  57. // Normalize input
  58. string_strim(cli->line);
  59. if(string_size(cli->line) == 0) {
  60. cli_prompt();
  61. return;
  62. }
  63. // Get first word as command name
  64. string_t command;
  65. string_init(command);
  66. size_t ws = string_search_char(cli->line, ' ');
  67. if(ws == STRING_FAILURE) {
  68. string_set(command, cli->line);
  69. string_clear(cli->line);
  70. string_init(cli->line);
  71. } else {
  72. string_set_n(command, cli->line, 0, ws);
  73. string_right(cli->line, ws);
  74. string_strim(cli->line);
  75. }
  76. // Search for command
  77. furi_check(osMutexAcquire(cli->mutex, osWaitForever) == osOK);
  78. CliCommand* cli_command = CliCommandDict_get(cli->commands, command);
  79. furi_check(osMutexRelease(cli->mutex) == osOK);
  80. if(cli_command) {
  81. cli_nl();
  82. cli_command->callback(cli->line, cli_command->context);
  83. cli_prompt();
  84. } else {
  85. cli_nl();
  86. cli_print("Command not found: ");
  87. cli_print(string_get_cstr(command));
  88. cli_prompt();
  89. cli_putc(CliSymbolAsciiBell);
  90. }
  91. string_clear(command);
  92. // Always finish with clean state
  93. cli_reset_state(cli);
  94. }
  95. void cli_process_input(Cli* cli) {
  96. char c;
  97. size_t r;
  98. r = api_hal_vcp_rx((uint8_t*)&c, 1);
  99. if(r == 0) {
  100. cli_reset_state(cli);
  101. }
  102. if(c == CliSymbolAsciiTab) {
  103. cli_putc(CliSymbolAsciiBell);
  104. } else if(c == CliSymbolAsciiSOH) {
  105. cli_motd();
  106. cli_prompt();
  107. } else if(c == CliSymbolAsciiEOT) {
  108. cli_reset_state(cli);
  109. } else if(c == CliSymbolAsciiEsc) {
  110. r = api_hal_vcp_rx((uint8_t*)&c, 1);
  111. if(r && c == '[') {
  112. api_hal_vcp_rx((uint8_t*)&c, 1);
  113. } else {
  114. cli_putc(CliSymbolAsciiBell);
  115. }
  116. } else if(c == CliSymbolAsciiBackspace || c == CliSymbolAsciiDel) {
  117. cli_backspace(cli);
  118. } else if(c == CliSymbolAsciiCR) {
  119. cli_enter(cli);
  120. } else if(c >= 0x20 && c < 0x7F) {
  121. string_push_back(cli->line, c);
  122. cli_putc(c);
  123. } else {
  124. cli_putc(CliSymbolAsciiBell);
  125. }
  126. }
  127. void cli_add_command(Cli* cli, const char* name, CliCallback callback, void* context) {
  128. string_t name_str;
  129. string_init_set_str(name_str, name);
  130. string_strim(name_str);
  131. size_t name_replace;
  132. do {
  133. name_replace = string_replace_str(name_str, " ", "_");
  134. } while(name_replace != STRING_FAILURE);
  135. CliCommand c;
  136. c.callback = callback;
  137. c.context = context;
  138. furi_check(osMutexAcquire(cli->mutex, osWaitForever) == osOK);
  139. CliCommandDict_set_at(cli->commands, name_str, c);
  140. furi_check(osMutexRelease(cli->mutex) == osOK);
  141. string_clear(name_str);
  142. }
  143. void cli_task(void* p) {
  144. Cli* cli = cli_alloc();
  145. // Init basic cli commands
  146. cli_commands_init(cli);
  147. furi_record_create("cli", cli);
  148. while(1) {
  149. cli_process_input(cli);
  150. }
  151. }