1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
#pragma once
#include <stdint.h>
#include <stdbool.h>
#include <limits.h> // NAME_MAX
#include <stddef.h> // NULL
#include "config.h"
#define LIGHT_YEAR "2012 - 2018"
#define LIGHT_AUTHOR "Fredrik Haikarainen"
struct _light_device_target_t;
typedef struct _light_device_target_t light_device_target_t;
struct _light_device_t;
typedef struct _light_device_t light_device_t;
struct _light_device_enumerator_t;
typedef struct _light_device_enumerator_t light_device_enumerator_t;
/* Function pointers that implementations have to set for device targets */
typedef bool (*LFUNCVALSET)(light_device_target_t*, uint64_t);
typedef bool (*LFUNCVALGET)(light_device_target_t*, uint64_t*);
typedef bool (*LFUNCMAXVALGET)(light_device_target_t*, uint64_t*);
typedef bool (*LFUNCCUSTOMCMD)(light_device_target_t*, char const *);
/* Describes a target within a device (for example a led on a keyboard, or a controller for a backlight) */
struct _light_device_target_t
{
char name[256];
LFUNCVALSET set_value;
LFUNCVALGET get_value;
LFUNCMAXVALGET get_max_value;
LFUNCCUSTOMCMD custom_command;
void *device_target_data;
light_device_t *device;
};
/* Describes a device (a backlight, a keyboard, a led-strip) */
struct _light_device_t
{
char name[256];
light_device_target_t **targets;
uint64_t num_targets;
void *device_data;
light_device_enumerator_t *enumerator;
};
typedef bool (*LFUNCENUMINIT)(light_device_enumerator_t*);
typedef bool (*LFUNCENUMFREE)(light_device_enumerator_t*);
/* An enumerator that is responsible for creating and freeing devices as well as their targets */
struct _light_device_enumerator_t
{
char name[256];
LFUNCENUMINIT init;
LFUNCENUMFREE free;
light_device_t **devices;
uint64_t num_devices;
};
typedef struct _light_context_t light_context_t;
// A command that can be run (set, get, add, subtract, print help, print version, list devices etc.)
typedef bool (*LFUNCCOMMAND)(light_context_t *);
struct _light_context_t
{
struct
{
LFUNCCOMMAND command; // What command was issued
// Only one of value and raw_value is populated; which one depends on the command
uint64_t value; // The input value, in raw mode
float float_value; // The input value as a float
bool raw_mode; // Whether or not we use raw or percentage mode
light_device_target_t *device_target; // The device target to act on
} run_params;
struct
{
char conf_dir[NAME_MAX]; // The path to the application cache directory
} sys_params;
light_device_enumerator_t **enumerators;
uint64_t num_enumerators;
};
// The different available commands
bool light_cmd_print_help(light_context_t *ctx); // H,h
bool light_cmd_print_version(light_context_t *ctx); // V
bool light_cmd_list_devices(light_context_t *ctx); // L
bool light_cmd_set_brightness(light_context_t *ctx); // S
bool light_cmd_get_brightness(light_context_t *ctx); // G
bool light_cmd_get_max_brightness(light_context_t *ctx); // M
bool light_cmd_set_min_brightness(light_context_t *ctx); // N
bool light_cmd_get_min_brightness(light_context_t *ctx); // P
bool light_cmd_add_brightness(light_context_t *ctx); // A
bool light_cmd_sub_brightness(light_context_t *ctx); // U
bool light_cmd_mul_brightness(light_context_t *ctx); // T
bool light_cmd_save_brightness(light_context_t *ctx); // O
bool light_cmd_restore_brightness(light_context_t *ctx); // I
/* Initializes the application, given the command-line. Returns a context. */
light_context_t* light_initialize(int argc, char **argv);
/* Executes the given context. Returns true on success, false on failure. */
bool light_execute(light_context_t*);
/* Frees the given context */
void light_free(light_context_t*);
/* Create a device enumerator in the given context */
light_device_enumerator_t * light_create_enumerator(light_context_t *ctx, char const * name, LFUNCENUMINIT, LFUNCENUMFREE);
/* Initializes all the device enumerators (and its devices, targets) */
bool light_init_enumerators(light_context_t *ctx);
/* Frees all the device enumerators (and its devices, targets) */
bool light_free_enumerators(light_context_t *ctx);
/* Use this to create a device. Will automatically be added to enumerator. */
light_device_t *light_create_device(light_device_enumerator_t *enumerator, char const *name, void *device_data);
/* Use this to delete a device. */
void light_delete_device(light_device_t *device);
/* Use this to create a device target. Will automatically be added to device. */
light_device_target_t *light_create_device_target(light_device_t *device, char const *name, LFUNCVALSET setfunc, LFUNCVALGET getfunc, LFUNCMAXVALGET getmaxfunc, LFUNCCUSTOMCMD cmdfunc, void *target_data);
/* Use this to delete a device target. */
void light_delete_device_target(light_device_target_t *device_target);
typedef struct _light_target_path_t light_target_path_t;
struct _light_target_path_t
{
char enumerator[NAME_MAX];
char device[NAME_MAX];
char target[NAME_MAX];
};
bool light_split_target_path(char const * in_path, light_target_path_t *out_path);
/* Returns the found device target, or null. Name should be enumerator/device/target */
light_device_target_t* light_find_device_target(light_context_t *ctx, char const * name);
|
