granicus.if.org Git - fcron/blob - env_list.h

   1 /*
   2  * FCRON - periodic command scheduler
   3  *
   4  *  Copyright 2000-2014 Thibault Godouet <fcron@free.fr>
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  The GNU General Public License can also be found in the file
  21  *  `LICENSE' that comes with the fcron source distribution.
  22  */
  23
  24
  25 /* List of jobs currently being executed.
  26  * This is a wrapper for an u_list (unordered list) (see u_list.h and u_list.c),
  27  * to make the rest of the code clearer and as a way to ensure the compiler can checks
  28  * the type in the rest of the code (u_list extensively uses the void type) */
  29
  30 #ifndef __ENV_LIST_H__
  31 #define __ENV_LIST_H__
  32
  33 #include "u_list.h"
  34
  35 /* One environment variable assignation */
  36 typedef struct env_t {
  37     char *e_envvar;
  38 } env_t;
  39
  40 typedef struct u_list_t env_list_t;
  41
  42 /* functions prototypes */
  43 extern env_list_t *env_list_init(void);
  44 extern env_list_t *env_list_copy(env_list_t * list);
  45 /* WARNING: - These functions are NOT re-entrant.
  46  *            i.e. there should always be a unique iteration loop based on
  47  *            u_list_first()/u_list_next() running at any one time in the code
  48  *          - setenv, putenv, getenv  use an iteration internally
  49  *            so they cannot be called when already iterating */
  50 extern env_t *env_list_setenv(env_list_t * list, char *name, char *value,
  51                               int overwrite);
  52 extern env_t *env_list_putenv(env_list_t * list, char *envvar, int overwrite);
  53 extern char *env_list_getenv(env_list_t * list, char *name);
  54 extern env_t *env_list_first(env_list_t * list);
  55 extern env_t *env_list_next(env_list_t * list);
  56 extern void env_list_end_iteration(env_list_t * list);
  57 extern env_list_t *env_list_destroy(env_list_t * list);
  58
  59 extern char **env_list_export_envp(env_list_t * list);
  60 extern void env_list_free_envp(char **envp);
  61
  62
  63 #endif                          /* __ENV_LIST_H__ */