Kiibohd Controller
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

cli.h 2.2KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /* Copyright (C) 2014 by Jacob Alexander
  2. *
  3. * Permission is hereby granted, free of charge, to any person obtaining a copy
  4. * of this software and associated documentation files (the "Software"), to deal
  5. * in the Software without restriction, including without limitation the rights
  6. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. * copies of the Software, and to permit persons to whom the Software is
  8. * furnished to do so, subject to the following conditions:
  9. *
  10. * The above copyright notice and this permission notice shall be included in
  11. * all copies or substantial portions of the Software.
  12. *
  13. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19. * THE SOFTWARE.
  20. */
  21. #ifndef cli_h__
  22. #define cli_h__
  23. // ----- Includes -----
  24. // Compiler Includes
  25. #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
  26. #elif defined(_mk20dx128_)
  27. #include "arm/usb_serial.h"
  28. #endif
  29. // ----- Defines -----
  30. #define CLILineBufferMaxSize 100
  31. #define CLIMaxDictionaries 5
  32. // ----- Structs -----
  33. // Each item has a name, description, and function pointer with an argument for arguments
  34. typedef struct CLIDictItem {
  35. char* name;
  36. char* description;
  37. void (*function)(char*);
  38. } CLIDictItem;
  39. // ----- Variables -----
  40. char CLILineBuffer[CLILineBufferMaxSize+1]; // +1 for an additional NULL
  41. uint8_t CLILineBufferCurrent;
  42. // Main command dictionary
  43. CLIDictItem *CLIDict[CLIMaxDictionaries];
  44. uint8_t CLIDictionariesUsed;
  45. // ----- Functions and Corresponding Function Aliases -----
  46. void init_cli();
  47. void process_cli();
  48. void registerDictionary_cli( CLIDictItem *cmdDict );
  49. void argumentIsolation_cli( char* string, char** first, char** second );
  50. void commandLookup_cli();
  51. // CLI Command Functions
  52. void cliFunc_help ( char* args );
  53. void cliFunc_version( char* args );
  54. #endif