src/basic/env-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   Copyright 2013 Lennart Poettering
   6 ***/
   7
   8 #include <stdbool.h>
   9 #include <stddef.h>
  10 #include <stdio.h>
  11
  12 #include "macro.h"
  13
  14 bool env_name_is_valid(const char *e);
  15 bool env_value_is_valid(const char *e);
  16 bool env_assignment_is_valid(const char *e);
  17
  18 enum {
  19         REPLACE_ENV_USE_ENVIRONMENT = 1u,
  20         REPLACE_ENV_ALLOW_BRACELESS = 2u,
  21         REPLACE_ENV_ALLOW_EXTENDED  = 4u,
  22 };
  23
  24 char *replace_env_n(const char *format, size_t n, char **env, unsigned flags);
  25 char **replace_env_argv(char **argv, char **env);
  26
  27 static inline char *replace_env(const char *format, char **env, unsigned flags) {
  28         return replace_env_n(format, strlen(format), env, flags);
  29 }
  30
  31 bool strv_env_is_valid(char **e);
  32 #define strv_env_clean(l) strv_env_clean_with_callback(l, NULL, NULL)
  33 char **strv_env_clean_with_callback(char **l, void (*invalid_callback)(const char *p, void *userdata), void *userdata);
  34
  35 bool strv_env_name_is_valid(char **l);
  36 bool strv_env_name_or_assignment_is_valid(char **l);
  37
  38 char **strv_env_merge(size_t n_lists, ...);
  39 char **strv_env_delete(char **x, size_t n_lists, ...); /* New copy */
  40
  41 char **strv_env_set(char **x, const char *p); /* New copy ... */
  42 char **strv_env_unset(char **l, const char *p); /* In place ... */
  43 char **strv_env_unset_many(char **l, ...) _sentinel_;
  44 int strv_env_replace(char ***l, char *p); /* In place ... */
  45
  46 char *strv_env_get_n(char **l, const char *name, size_t k, unsigned flags) _pure_;
  47 char *strv_env_get(char **x, const char *n) _pure_;
  48
  49 int getenv_bool(const char *p);
  50 int getenv_bool_secure(const char *p);
  51
  52 int serialize_environment(FILE *f, char **environment);
  53 int deserialize_environment(char ***environment, const char *line);