Debian Codegraph @

src/basic/env-util.h

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include "basic-forward.h"
5
6 #define ENVIRONMENT_ASSIGNMENTS_MAX 16384U
7
8 size_t sc_arg_max(void);
9
10 bool env_name_is_valid(const char *e);
11 bool env_value_is_valid(const char *e);
12 bool env_assignment_is_valid(const char *e);
13
14 typedef enum ReplaceEnvFlags {
15 REPLACE_ENV_USE_ENVIRONMENT = 1 << 0,
16 REPLACE_ENV_ALLOW_BRACELESS = 1 << 1,
17 REPLACE_ENV_ALLOW_EXTENDED = 1 << 2,
18 } ReplaceEnvFlags;
19
20 int replace_env_full(const char *format, size_t length, char **env, ReplaceEnvFlags flags, char **ret, char ***ret_unset_variables, char ***ret_bad_variables);
21 static inline int replace_env(const char *format, char **env, ReplaceEnvFlags flags, char **ret) {
22 return replace_env_full(format, SIZE_MAX, env, flags, ret, NULL, NULL);
23 }
24
25 int replace_env_argv(char **argv, char **env, char ***ret, char ***ret_unset_variables, char ***ret_bad_variables);
26
27 bool strv_env_is_valid(char * const *e);
28 bool strv_env_name_is_valid(char * const *l);
29 bool strv_env_name_or_assignment_is_valid(char * const *l);
30
31 char** strv_env_clean_with_callback(char **l, void (*invalid_callback)(const char *p, void *userdata), void *userdata);
32 #define strv_env_clean(l) strv_env_clean_with_callback(l, NULL, NULL)
33
34 char** _strv_env_merge(char **first, ...);
35 #define strv_env_merge(first, ...) _strv_env_merge(first, __VA_ARGS__, POINTER_MAX)
36 char** strv_env_delete(char **x, size_t n_lists, ...); /* New copy */
37
38 char** strv_env_unset(char **l, const char *p); /* In place ... */
39 char** strv_env_unset_many_internal(char **l, ...) _sentinel_;
40 #define strv_env_unset_many(l, ...) strv_env_unset_many_internal(l, __VA_ARGS__, NULL)
41 int strv_env_replace_consume(char ***l, char *p); /* In place ... */
42 int strv_env_replace_strdup(char ***l, const char *assignment);
43 int strv_env_replace_strdup_passthrough(char ***l, const char *assignment);
44 int strv_env_assign(char ***l, const char *key, const char *value);
45 int strv_env_assignf(char ***l, const char *key, const char *valuef, ...) _printf_(3, 4);
46 int _strv_env_assign_many(char ***l, ...) _sentinel_;
47 #define strv_env_assign_many(l, ...) _strv_env_assign_many(l, __VA_ARGS__, NULL)
48
49 char* strv_env_get_n(char * const *l, const char *name, size_t k, ReplaceEnvFlags flags);
50 static inline char* strv_env_get(char * const *x, const char *n) {
51 return strv_env_get_n(x, n, SIZE_MAX, 0);
52 }
53
54 char* strv_env_pairs_get(char **l, const char *name) _pure_;
55 int strv_env_get_merged(char **l, char ***ret);
56
57 int getenv_bool(const char *p);
58 int secure_getenv_bool(const char *p);
59
60 int secure_getenv_uint64(const char *p, uint64_t *ret);
61
62 /* Like setenv, but calls unsetenv if value == NULL. */
63 int set_unset_env(const char *name, const char *value, bool overwrite);
64
65 /* Like putenv, but duplicates the memory like setenv. */
66 int putenv_dup(const char *assignment, bool override);
67
68 int setenv_systemd_exec_pid(bool update_only);
69 int setenv_systemd_log_level(void);
70
71 /* Parses and does sanity checks on an environment variable containing
72 * PATH-like colon-separated absolute paths */
73 int getenv_path_list(const char *name, char ***ret_paths);
74
75 int getenv_steal_erase(const char *name, char **ret);
76
77 int setenvf(const char *name, bool overwrite, const char *valuef, ...) _printf_(3,4);