lib/util/parmlist.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Generic parameter parsing interface
   4    Copyright (C) Jelmer Vernooij                                          2009
   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 3 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, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef _PARMLIST_H /* _PARMLIST_H */
  21 #define _PARMLIST_H
  22
  23 struct parmlist_entry {
  24         struct parmlist_entry *prev, *next;
  25         char *key;
  26         char *value;
  27         char **list; /* For the source3 parametric options, to save the parsed list */
  28         int priority;
  29 };
  30
  31 struct parmlist {
  32         struct parmlist_entry *entries;
  33 };
  34
  35 /** Retrieve an integer from a parameter list. If not found, return default_v. */
  36 int parmlist_get_int(struct parmlist *ctx, const char *name, int default_v);
  37
  38 /** Retrieve a string from a parameter list. If not found, return default_v. */
  39 const char *parmlist_get_string(struct parmlist *ctx, const char *name,
  40                                                                 const char *default_v);
  41
  42 /** Retrieve the struct for an entry in a parmlist. */
  43 struct parmlist_entry *parmlist_get(struct parmlist *ctx, const char *name);
  44
  45 /** Retrieve a string list from a parameter list.
  46  * separator can contain characters to consider separators or can be
  47  * NULL for the default set. */
  48 const char **parmlist_get_string_list(struct parmlist *ctx, const char *name,
  49                                                                           const char *separator);
  50
  51 /** Retrieve boolean from a parameter list. If not set, return default_v. */
  52 bool parmlist_get_bool(struct parmlist *ctx, const char *name, bool default_v);
  53
  54 /** Set a parameter. */
  55 int parmlist_set_string(struct parmlist *ctx, const char *name, const char *value);
  56
  57 #endif /* _PARMLIST_H */