cli.c 4.5 KB

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