git.sur5r.net Git - openldap/blob - servers/slapd/config.h

   1 /* config.h - configuration abstraction structure */
   2
   3 /* $OpenLDAP$ */
   4 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   5  *
   6  * Copyright 1998-2005 The OpenLDAP Foundation.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  13  * A copy of this license is available in the file LICENSE in the
  14  * top-level directory of the distribution or, alternatively, at
  15  * <http://www.OpenLDAP.org/license.html>.
  16  */
  17
  18 typedef struct ConfigTable {
  19         char *name;
  20         char *what;
  21         int min_args;
  22         int max_args;
  23         int length;
  24         unsigned int arg_type;
  25         void *arg_item;
  26         char *attribute;
  27         AttributeDescription *ad;
  28         void *notify;
  29 } ConfigTable;
  30
  31 #define ARGS_USERLAND   0x00000fff
  32 #define ARGS_TYPES      0x000ff000
  33 #define ARGS_POINTER    0x0001f000
  34 #define ARGS_NUMERIC    0x0000f000
  35 #define ARG_INT         0x00001000
  36 #define ARG_LONG        0x00002000
  37 #define ARG_BER_LEN_T   0x00004000
  38 #define ARG_ON_OFF      0x00008000
  39 #define ARG_STRING      0x00010000
  40 #define ARG_DN          0x00020000
  41 #define ARG_EXISTS      0x00040000      /* XXX not yet */
  42 #define ARG_IGNORED     0x00080000
  43
  44 #define ARGS_SYNTAX     0xfff00000
  45 #define ARG_PRE_BI      0x00100000
  46 #define ARG_PRE_DB      0x00200000
  47 #define ARG_DB          0x00400000      /* Only applies to DB */
  48 #define ARG_MAY_DB      0x00800000      /* May apply to DB */
  49 #define ARG_PAREN       0x01000000
  50 #define ARG_NONZERO     0x02000000
  51 #define ARG_UNIQUE      0x10000000
  52 #define ARG_MUTEX       0x20000000      /* modify in single-thread mode */
  53 #define ARG_OFFSET      0x40000000
  54 #define ARG_MAGIC       0x80000000
  55
  56 #define ARG_BAD_CONF    0xdead0000      /* overload return values */
  57 #define ARG_UNKNOWN     0xc0de0000
  58
  59 extern ConfigTable config_back_cf_table[];
  60
  61 typedef struct ConfigOCs {
  62         char *def;
  63         ObjectClass **oc;
  64 } ConfigOCs;
  65
  66 typedef struct config_args_s {
  67         int argc;
  68         char **argv;
  69         int argv_size;
  70         char *line;
  71         const char *fname;
  72         unsigned long lineno;
  73         char log[PATH_MAX + STRLENOF(": line 18446744073709551615") + 1];
  74         int depth;
  75         /* parsed first val for simple cases */
  76         union {
  77                 int v_int;
  78                 long v_long;
  79                 ber_len_t v_ber_t;
  80                 char *v_string;
  81                 struct {
  82                         struct berval vdn_dn;
  83                         struct berval vdn_ndn;
  84                 } v_dn;
  85         } values;
  86         /* return values for emit mode */
  87         BerVarray rvalue_vals;
  88         BerVarray rvalue_nvals;
  89         int emit;       /* emit instead of setting */
  90         int type;       /* ConfigTable.arg_type & ARGS_USERLAND */
  91         BackendDB *be;
  92         BackendInfo *bi;
  93 } ConfigArgs;
  94
  95 #define value_int values.v_int
  96 #define value_long values.v_long
  97 #define value_ber_t values.v_ber_t
  98 #define value_string values.v_string
  99 #define value_dn values.v_dn.vdn_dn
 100 #define value_ndn values.v_dn.vdn_ndn
 101
 102 typedef int (ConfigDriver)(ConfigArgs *c);
 103
 104 struct verb_mask_list { char *word; int mask; };
 105
 106 int config_get_vals(ConfigTable *ct, ConfigArgs *c);