src/basic/env-util.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2013 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <stdbool.h>
  24 #include <stddef.h>
  25 #include <stdio.h>
  26
  27 #include "macro.h"
  28
  29 bool env_name_is_valid(const char *e);
  30 bool env_value_is_valid(const char *e);
  31 bool env_assignment_is_valid(const char *e);
  32
  33 enum {
  34         REPLACE_ENV_USE_ENVIRONMENT = 1u,
  35         REPLACE_ENV_ALLOW_BRACELESS = 2u,
  36         REPLACE_ENV_ALLOW_EXTENDED  = 4u,
  37 };
  38
  39 char *replace_env_n(const char *format, size_t n, char **env, unsigned flags);
  40 char **replace_env_argv(char **argv, char **env);
  41
  42 static inline char *replace_env(const char *format, char **env, unsigned flags) {
  43         return replace_env_n(format, strlen(format), env, flags);
  44 }
  45
  46 bool strv_env_is_valid(char **e);
  47 #define strv_env_clean(l) strv_env_clean_with_callback(l, NULL, NULL)
  48 char **strv_env_clean_with_callback(char **l, void (*invalid_callback)(const char *p, void *userdata), void *userdata);
  49
  50 bool strv_env_name_is_valid(char **l);
  51 bool strv_env_name_or_assignment_is_valid(char **l);
  52
  53 char **strv_env_merge(unsigned n_lists, ...);
  54 char **strv_env_delete(char **x, unsigned n_lists, ...); /* New copy */
  55
  56 char **strv_env_set(char **x, const char *p); /* New copy ... */
  57 char **strv_env_unset(char **l, const char *p); /* In place ... */
  58 char **strv_env_unset_many(char **l, ...) _sentinel_;
  59 int strv_env_replace(char ***l, char *p); /* In place ... */
  60
  61 char *strv_env_get_n(char **l, const char *name, size_t k, unsigned flags) _pure_;
  62 char *strv_env_get(char **x, const char *n) _pure_;
  63
  64 int getenv_bool(const char *p);
  65 int getenv_bool_secure(const char *p);
  66
  67 int serialize_environment(FILE *f, char **environment);
  68 int deserialize_environment(char ***environment, const char *line);