light.h 3.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. #ifndef LIGHT_H
  2. #define LIGHT_H
  3. #include "helpers.h"
  4. #include <sys/types.h>
  5. #include <dirent.h>
  6. #define LIGHT_VER_MAJOR 0
  7. #define LIGHT_VER_MINOR 9
  8. #define LIGHT_VER_TYPE "beta"
  9. #define LIGHT_YEAR 2014
  10. #define LIGHT_AUTHOR "Fredrik Haikarainen"
  11. #define ASSERT_OPSET() \
  12. if(opSet)\
  13. {\
  14. printf("Operation arguments can not be used in conjunction.\n");\
  15. return FALSE;\
  16. }\
  17. opSet = TRUE;
  18. #define ASSERT_TARGETSET() \
  19. if(targetSet)\
  20. {\
  21. printf("Target arguments can not be used in conjunction.\n");\
  22. return FALSE;\
  23. }\
  24. targetSet = TRUE;
  25. #define ASSERT_CTRLSET()\
  26. if(ctrlSet)\
  27. {\
  28. printf("Controller arguments can not be used in conjunction.\n");\
  29. return FALSE;\
  30. }\
  31. ctrlSet = TRUE;
  32. #define ASSERT_VALSET()\
  33. if(valSet)\
  34. {\
  35. printf("Value arguments can not be used in conjunction.\n");\
  36. return FALSE;\
  37. }\
  38. valSet = TRUE;
  39. typedef enum LIGHT_TARGET {
  40. LIGHT_BRIGHTNESS = 0,
  41. LIGHT_MAX_BRIGHTNESS,
  42. LIGHT_MIN_CAP
  43. } LIGHT_TARGET;
  44. typedef enum LIGHT_CTRL_MODE {
  45. LIGHT_AUTO = 0,
  46. LIGHT_SPECIFY
  47. } LIGHT_CTRL_MODE;
  48. typedef enum LIGHT_OP_MODE {
  49. LIGHT_GET = 0,
  50. LIGHT_SET,
  51. LIGHT_ADD,
  52. LIGHT_SUB,
  53. LIGHT_PRINT_HELP, /* Prints help and exits */
  54. LIGHT_PRINT_VERSION, /* Prints version info and exits */
  55. LIGHT_LIST_CTRL
  56. } LIGHT_OP_MODE;
  57. typedef enum LIGHT_VAL_MODE {
  58. LIGHT_RAW = 0,
  59. LIGHT_PERCENT
  60. } LIGHT_VAL_MODE;
  61. typedef struct light_runtimeArguments_s {
  62. /* Which controller to use */
  63. LIGHT_CTRL_MODE controllerMode;
  64. char specifiedController[256];
  65. /* What to do with the controller */
  66. LIGHT_OP_MODE operationMode;
  67. LIGHT_VAL_MODE valueMode;
  68. unsigned long specifiedValueRaw; /* The specified value in raw mode */
  69. double specifiedValuePercent; /* The specified value in percent */
  70. LIGHT_TARGET target;
  71. } light_runtimeArguments, *light_runtimeArguments_p;
  72. /* -- Global variables that handles iterating controllers -- */
  73. struct dirent *light_iterator;
  74. DIR *light_iteratorDir;
  75. char light_currentController[256];
  76. /* -- Global variable holding the settings for the current run -- */
  77. light_runtimeArguments light_Configuration;
  78. /* Sets default values for the configuration */
  79. void light_defaultConfig();
  80. /* Parses the program arguments and sets the configuration accordingly (unsanitized) */
  81. LIGHT_BOOL light_parseArguments(int argc, char** argv);
  82. /* Prints a header if verbosity level > 0 */
  83. void light_printVersion(void);
  84. /* Prints help regardless of verbosity level */
  85. void light_printHelp(void);
  86. /* -- SECTION: Main code -- */
  87. /* Initializes the application */
  88. LIGHT_BOOL light_initialize(int argc, char** argv);
  89. /* Does the work */
  90. LIGHT_BOOL light_execute(void);
  91. /* Frees up resources */
  92. void light_free();
  93. /* SECTION: Controller functionality */
  94. /* WARNING: `buffer` HAS to be freed by the user if not null once returned!
  95. * Size is always 256 */
  96. LIGHT_BOOL light_genPath(char const *controller, LIGHT_TARGET type, char **buffer);
  97. LIGHT_BOOL light_getBrightness(char const *controller, unsigned long *v);
  98. LIGHT_BOOL light_getMaxBrightness(char const *controller, unsigned long *v);
  99. LIGHT_BOOL light_setBrightness(char const *controller, unsigned long v);
  100. LIGHT_BOOL light_controllerAccessible(char const *controller);
  101. LIGHT_BOOL light_iterateControllers(void);
  102. /* WARNING: `controller` HAS to be at least 256 bytes */
  103. LIGHT_BOOL light_getBestController(char *controller);
  104. LIGHT_BOOL light_getMinCap(char const *controller, LIGHT_BOOL *hasMinCap, unsigned long *minCap);
  105. LIGHT_BOOL light_setMinCap(char const *controller, unsigned long v);
  106. LIGHT_BOOL light_listControllers();
  107. #endif /* LIGHT_H */