diff options
Diffstat (limited to 'src/common.h')
| -rw-r--r-- | src/common.h | 413 |
1 files changed, 343 insertions, 70 deletions
diff --git a/src/common.h b/src/common.h index ebf63e0..704e64a 100644 --- a/src/common.h +++ b/src/common.h @@ -1,5 +1,7 @@ -/* common.h -- Common header file for Redshift source files - * This file is part of redshift-ng. +/* redshift-ng - Automatically adjust display colour temperature according the Sun + * + * Copyright (c) 2009-2018 Jon Lund Steffensen <jonlst@gmail.com> + * Copyright (c) 2014-2016, 2025 Mattias Andrée <m@maandree.se> * * redshift-ng is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -13,9 +15,6 @@ * * You should have received a copy of the GNU General Public License * along with redshift-ng. If not, see <http://www.gnu.org/licenses/>. - * - * Copyright (c) 2009-2017 Jon Lund Steffensen <jonlst@gmail.com> - * Copyright (c) 2014, 2015, 2016, 2025 Mattias Andrée <m@maandree.se> */ #ifndef REDSHIFT_COMMON_H #define REDSHIFT_COMMON_H @@ -31,6 +30,7 @@ #include <sys/stat.h> #include <sys/types.h> +#include <ctype.h> #include <dirent.h> #include <errno.h> #include <fcntl.h> @@ -116,56 +116,82 @@ */ #define WITHIN(LO, X, UP) ((LO) <= (X) && (X) <= (UP)) +/** + * Check whether a value is within a bounded, open range + * + * @param LO The lower bound + * @param X The value to check + * @param UP The upper bound + * @return :int 1 if `X` is within (`LO`, `UP`), 0 otherwise + */ +#define BETWEEN(LO, X, UP) ((LO) < (X) && (X) < (UP)) + + +/** + * Symbol used to delimit paths in environment + * variables listing multiple paths + */ +#ifdef WINDOWS +# define PATH_DELIMITER ';' +#else +# define PATH_DELIMITER ':' +#endif + +/** + * The number of seconds in a day + */ +#define ONE_DAY ((time_t)(24L * 60L * 60L)) + /** * Minimum valid latitude */ -#define MIN_LATITUDE -90.0 +#define MIN_LATITUDE -90.0 /** * Maximum valid latitude */ -#define MAX_LATITUDE 90.0 +#define MAX_LATITUDE 90.0 /** * Minimum valid longitude */ -#define MIN_LONGITUDE -180.0 +#define MIN_LONGITUDE -180.0 /** * Maximum valid longitude */ -#define MAX_LONGITUDE 180.0 +#define MAX_LONGITUDE 180.0 /** * Minimum allowed colour temperature */ -#define MIN_TEMPERATURE ((unsigned long int)LIBRED_LOWEST_TEMPERATURE) +#define MIN_TEMPERATURE ((unsigned long int)LIBRED_LOWEST_TEMPERATURE) /** * Maximum allowed colour temperature */ -#define MAX_TEMPERATURE ULONG_MAX +#define MAX_TEMPERATURE ULONG_MAX /** * Minimum allowed whitepoint brightness */ -#define MIN_BRIGHTNESS 0.1 +#define MIN_BRIGHTNESS 0.1 /** * Maximum allowed whitepoint brightness */ -#define MAX_BRIGHTNESS 1.0 +#define MAX_BRIGHTNESS 1.0 /** * Minimum allowed gamma */ -#define MIN_GAMMA 0.1 +#define MIN_GAMMA 0.1 /** * Maximum allowed gamma */ -#define MAX_GAMMA 10.0 +#define MAX_GAMMA 10.0 /** @@ -186,6 +212,49 @@ /** + * Default daytime colour temperature + */ +#define DEFAULT_DAY_TEMPERATURE 6500UL + +/** + * Default night colour temperature + */ +#define DEFAULT_NIGHT_TEMPERATURE 4500UL + +/** + * Default daytime whitepoint brightness level + */ +#define DEFAULT_DAY_BRIGHTNESS NEUTRAL_BRIGHTNESS + +/** + * Default night whitepoint brightness level + */ +#define DEFAULT_NIGHT_BRIGHTNESS NEUTRAL_BRIGHTNESS + +/** + * Default daytime gamma value + */ +#define DEFAULT_DAY_GAMMA NEUTRAL_GAMMA + +/** + * Default night gamma value + */ +#define DEFAULT_NIGHT_GAMMA NEUTRAL_GAMMA + +/** + * The solar elevation, in degrees, that marks the + * threshold to daytime + */ +#define DEFAULT_HIGH_ELEVATION 3.0 + +/** + * The solar elevation, in degrees, that marks the + * threshold to night + */ +#define DEFAULT_LOW_ELEVATION LIBRED_SOLAR_ELEVATION_CIVIL_DUSK_DAWN + + +/** * Initialiser for `struct colour_setting` * * Sets all values to their neutral values (no effects applied) @@ -230,6 +299,83 @@ enum program_mode { /** + * By what the effects of the application change + */ +enum scheme_type { + /** + * Effects are dependent on the Sun's elevation + */ + SOLAR_SCHEME, + + /** + * Effects are dependent on the wall clock time + */ + CLOCK_SCHEME, + + /** + * Effects do not change + */ + STATIC_SCHEME +}; + + +/** + * The sources where an setting was been loaded from + * + * Higher valued sources have higher priority + * + * This is a bitmask `enum` + */ +enum setting_source { + /** + * No setting loaded, default value set + */ + SETTING_DEFAULT = 0x00, + + /** + * Setting loaded from configuration file + */ + SETTING_CONFIGFILE = 0x01, + + /** + * Setting loaded from command line arguments + */ + SETTING_CMDLINE = 0x02 +}; + + +/** + * Specification for a path that consists of a two parts: + * the first being defined by the environment, and the + * seocnd being a static string + */ +struct env_path { + /** + * Whether the environment variable referenced by `.prefix` + * should be split at each colon (:) into multiple paths to + * test + * + * On Windows semicolon (;) is used instead of colon + */ + int multidir_env; + + /** + * Environment variable to use as the first part of the path + * + * `NULL` if the user's home directory should be used + * + * The empty string if `.suffix` should be used as is + */ + const char *prefix_env; + + /** + * The second part of the path + */ + const char *suffix; +}; + + +/** * Geographical location, using GPS coordinates */ struct location { @@ -270,22 +416,34 @@ struct colour_setting { /* Time range. Fields are offsets from midnight in seconds. */ struct time_range { - int start; - int end; + time_t start; + time_t end; +}; + + +struct time_period { + time_t start; + double day_level; + double diff_over_duration; + const struct time_period *next; }; /* Transition scheme. - The solar elevations at which the transition begins/ends, - and the association colour settings. */ -struct transition_scheme { - double high; - double low; - int use_time; /* When enabled, ignore elevation and use time ranges. */ - struct time_range dawn; - struct time_range dusk; - struct colour_setting day; - struct colour_setting night; + The solar elevations at which the transition begins/ends */ +union scheme { + enum scheme_type type; + struct { + enum scheme_type type; + double high; + double low; + double range; + } elevation; + struct { + enum scheme_type type; + const struct time_period *periods; + struct time_period periods_array[4]; + } time; }; @@ -308,20 +466,51 @@ struct config_ini_state { }; -struct options { +struct setting_i { + enum setting_source source; + int value; +}; + +struct setting_lu { + enum setting_source source; + unsigned long int value; +}; + +struct setting_f { + enum setting_source source; + double value; +}; + +struct setting_f3 { + enum setting_source source; + double value[3]; +}; + +struct setting_time { + enum setting_source source; + time_t value; +}; + +struct settings { /* Path to config file */ - char *config_filepath; + const char *config_file; - struct transition_scheme scheme; - enum program_mode mode; - int verbose; + struct config_ini_state config; + + struct { + struct setting_lu temperature; + struct setting_f brightness; + struct setting_f3 gamma; + } day, night; + struct setting_i preserve_gamma; /* Whether to preserve gamma ramps if supported by gamma method. */ + struct setting_i use_fade; /* Whether to fade between large skips in colour temperature. */ - /* Temperature to set in manual mode. */ - unsigned long int temp_set; - /* Whether to fade between large skips in colour temperature. */ - int use_fade; - /* Whether to preserve gamma ramps if supported by gamma method. */ - int preserve_gamma; + struct setting_f elevation_high; /* TODO no cmdline option */ + struct setting_f elevation_low; /* TODO no cmdline option */ + struct { + struct setting_time start; + struct setting_time end; + } dawn, dusk; /* TODO no cmdline option */ /* Selected gamma method. */ const struct gamma_method *method; @@ -332,6 +521,10 @@ struct options { const struct location_provider *provider; /* Arguments for location provider. */ char *provider_args; + + enum program_mode mode; + int verbose; + enum scheme_type scheme_type; }; @@ -397,6 +590,33 @@ extern const struct gamma_method *gamma_methods[]; */ extern const struct location_provider *location_providers[]; +/** + * Set to 1 once the process has received a signal to terminate + */ +extern volatile sig_atomic_t exiting; + +/** + * Set to 1 once the process has received a signal to remove its effect + */ +extern volatile sig_atomic_t disable; + +/** + * The colour settings applied at daytime + */ +extern struct colour_setting day_settings; + +/** + * The colour settings applied at nighttime + */ +extern struct colour_setting night_settings; + +/** + * The colour settings applied at nighttime + */ +extern union scheme scheme; + + +/* colour.c */ #define LIST_RAMPS_STOP_VALUE_TYPES(X, D)\ X(u8, uint8_t, UINT8_MAX, 8) D\ @@ -418,13 +638,15 @@ extern const struct location_provider *location_providers[]; * @param size_b The number of stops in `gamma_b` * @param settings The colour settings to apply (temperature, brightness, gamma) */\ - void colourramp_fill_##SUFFIX(TYPE *gamma_r, TYPE *gamma_g, TYPE *gamma_b,\ - size_t size_r, size_t size_g, size_t size_b,\ - const struct colour_setting *setting) + void fill_ramps_##SUFFIX(TYPE *gamma_r, TYPE *gamma_g, TYPE *gamma_b,\ + size_t size_r, size_t size_g, size_t size_b,\ + const struct colour_setting *setting) LIST_RAMPS_STOP_VALUE_TYPES(X, ;); #undef X +/* config-ini.c */ + /** * Load the configuration file * @@ -453,61 +675,112 @@ GCC_ONLY(__attribute__((__pure__))) struct config_ini_section *config_ini_get_section(struct config_ini_state *state, const char *name); -void options_init(struct options *options); -void options_parse_args(struct options *options, int argc, char *argv[]); -void options_parse_config_file(struct options *options, struct config_ini_state *config_state); -void options_set_defaults(struct options *options); +/* config.c */ + +/** + * Load settings + * + * @param settings Output parameter for the settings + * @param argc Number of command line arguments + * @param argv `NULL` terminated list of command line arguments, + * including argument zero + */ +void load_settings(struct settings *settings, int argc, char *argv[]); + + +/* gamma.c */ + +void acquire_adjustment_method(struct settings *settings, GAMMA_STATE **method_state_out); -void hooks_signal_period_change(enum period prev_period, enum period period); +/* location.c */ +int get_location(const struct location_provider *provider, LOCATION_STATE *state, int timeout, struct location *loc); + +void acquire_location_provider(struct settings *settings, LOCATION_STATE **location_state_out); + + +/* hooks.c */ /** - * Create a pipe(7) where both ends have O_NONBLOCK applied + * Run hooks with a signal that the period changed * - * @param pipefds Output parameter for the pipe's file descriptors: - * 0) reading file descriptor, and - * 1) writing file descriptor. - * @return 0 on success, -1 on failure + * @param prev_period The previous period + * @param period The new current period */ -int pipeutils_create_nonblocking(int pipefds[2]); +void run_period_change_hooks(enum period prev_period, enum period period); -void pipeutils_signal(int write_fd); -void pipeutils_handle_signal(int read_fd); +/* signals.c */ /** - * Set to 1 once the process has received a signal to terminate + * Install signal handlers for the process */ -extern volatile sig_atomic_t exiting; +void install_signal_handlers(void); + + +/* util.c */ /** - * Set to 1 once the process has received a signal to remove its effect + * Remove trailing whitespace + * + * @param s The string to trim, will be truncated + * @param end The current end of `s`; will be looked up if `NULL` + * @return `s` */ -extern volatile sig_atomic_t disable; +char *rtrim(char *s, char *end); /** - * Install signal handlers for the process + * Remove leading whitespace + * + * @param s The string to trim (will not be modified) + * @return `s` with an offset */ -void signals_install_handlers(void); - +GCC_ONLY(__attribute__((__warn_unused_result__, __pure__))) +char *ltrim(char *s); /** - * Get the current time in seconds since the Unix epoch + * Get the user's home directory * - * @return The current time + * This function looks up the user's home directory + * once and caches the result, later calls to this + * function will use the cached result + * + * @return The user's home directory; the empty string if not found */ -double systemtime_get_time(void); +const char *get_home(void); /** - * Suspend the process for a short time - * - * The process may be resumed earily, specifically - * if it receives a signal + * Search for a file and open it for reading + * + * @param path_spec Specification for the path to try + * @param path_out Output parameter for the found file + * @param pathbuf_out Output parameter for the memory allocation for `*path_out`; + * shall be free(3)d by the caller + * @return `FILE` object for the reading the file; `NULL` if not found + */ +FILE *try_path_fopen(const struct env_path *path_spec, const char **path_out, char **pathbuf_out); + +/** + * Search for a directory and open it for reading + * + * @param path_spec Specification for the path to try + * @param path_out Output parameter for the found directory + * @param pathbuf_out Output parameter for the memory allocation for `*path_out`; + * shall be free(3)d by the caller + * @return `DIR` object for the reading the directory; `NULL` if not found + */ +DIR *try_path_opendir(const struct env_path *path_spec, const char **path_out, char **pathbuf_out); + +/** + * Create a pipe(7) where both ends have `O_NONBLOCK` applied * - * @param msecs The number of milliseconds to sleep + * @param pipefds Output parameter for the pipe's file descriptors: + * 0) reading file descriptor, and + * 1) writing file descriptor + * @return 0 on success, -1 on failure */ -void systemtime_msleep(unsigned int msecs); +int pipe_nonblock(int pipefds[2]); extern const struct gamma_method dummy_gamma_method; |