ktp.h 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. /** @file ktp.h
  2. *
  3. * @brief Klish Transfer Protocol
  4. */
  5. #ifndef _klish_ktp_h
  6. #define _klish_ktp_h
  7. #include <faux/msg.h>
  8. #define KTP_MAGIC 0x4b545020
  9. #define KTP_MAJOR 0x01
  10. #define KTP_MINOR 0x00
  11. typedef enum {
  12. KTP_NULL = '\0',
  13. KTP_STDIN = 'i',
  14. KTP_STDOUT = 'o',
  15. KTP_STDERR = 'e',
  16. KTP_CMD = 'c',
  17. KTP_CMD_ACK = 'C',
  18. KTP_COMPLETION = 'v',
  19. KTP_COMPLETION_ACK = 'V',
  20. KTP_HELP = 'h',
  21. KTP_HELP_ACK = 'H',
  22. KTP_NOTIFICATION = 'n',
  23. KTP_AUTH = 'a',
  24. KTP_AUTH_ACK = 'A',
  25. KTP_KEEPALIVE = 'k',
  26. } ktp_cmd_e;
  27. typedef enum {
  28. KTP_PARAM_NULL = '\0',
  29. KTP_PARAM_LINE = 'L',
  30. KTP_PARAM_PREFIX = 'P', // Same as line but differ by meaning
  31. KTP_PARAM_PROMPT = '$', // Same as line but differ by meaning
  32. KTP_PARAM_HOTKEY = 'H', // <key>'\0'<cmd>
  33. KTP_PARAM_WINCH = 'W', // <width><space><height>
  34. KTP_PARAM_ERROR = 'E',
  35. KTP_PARAM_RETCODE = 'R',
  36. } ktp_param_e;
  37. // Status field. Bitmap
  38. typedef enum {
  39. KTP_STATUS_NONE = (uint32_t)0x00000000,
  40. KTP_STATUS_ERROR = (uint32_t)0x00000001,
  41. KTP_STATUS_INCOMPLETED = (uint32_t)0x00000002,
  42. KTP_STATUS_INTERACTIVE = (uint32_t)0x00000100,
  43. KTP_STATUS_DRY_RUN = (uint32_t)0x00010000,
  44. KTP_STATUS_EXIT = (uint32_t)0x80000000,
  45. } ktp_status_e;
  46. #define KTP_STATUS_IS_ERROR(status) (status & KTP_STATUS_ERROR)
  47. #define KTP_STATUS_IS_INCOMPLETED(status) (status & KTP_STATUS_INCOMPLETED)
  48. #define KTP_STATUS_IS_INTERACTIVE(status) (status & KTP_STATUS_INTERACTIVE)
  49. #define KTP_STATUS_IS_DRY_RUN(status) (status & KTP_STATUS_DRY_RUN)
  50. #define KTP_STATUS_IS_EXIT(status) (status & KTP_STATUS_EXIT)
  51. #endif // _klish_ktp_h