cfg.h

/*
 * $Id$
 *
 * Copyright (C) 2007 iptelorg GmbH
 *
 * This file is part of SIP-router, a free SIP server.
 *
 * SIP-router is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * SIP-router is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History
 * -------
 *  2007-12-03  Initial version (Miklos)
 */

#ifndef _CFG_H
#define _CFG_H

#include "../str.h"

/* variable type */
#define CFG_VAR_UNSET           0U
#define CFG_VAR_INT             1U
#define CFG_VAR_STRING          2U
#define CFG_VAR_STR             3U
#define CFG_VAR_POINTER         4U

/* number of bits required for the variable type */
#define CFG_INPUT_SHIFT         3

/* input type */
#define CFG_INPUT_INT           (CFG_VAR_INT << CFG_INPUT_SHIFT)
#define CFG_INPUT_STRING        (CFG_VAR_STRING << CFG_INPUT_SHIFT)
#define CFG_INPUT_STR           (CFG_VAR_STR << CFG_INPUT_SHIFT)

#define CFG_VAR_MASK(x)         ((x)&((1U<<CFG_INPUT_SHIFT)-1))
#define CFG_INPUT_MASK(x)       ((x)&((1U<<(2*CFG_INPUT_SHIFT))-(1U<<CFG_INPUT_SHIFT)))

/* atomic change is allowed */
#define CFG_ATOMIC              (1U<<(2*CFG_INPUT_SHIFT))
/* variable is read-only */
#define CFG_READONLY            (1U<<(2*CFG_INPUT_SHIFT+1))
/* per-child process callback needs to be called only once */
#define CFG_CB_ONLY_ONCE        (1U<<(2*CFG_INPUT_SHIFT+2))

typedef int (*cfg_on_change)(void *, str *, str *, void **);
typedef void (*cfg_on_set_child)(str *, str *);

/* strutrure to be used by the module interface */
typedef struct _cfg_def {
        char    *name;
        unsigned int    type;
        int     min;
        int     max;
        cfg_on_change   on_change_cb;
        cfg_on_set_child        on_set_child_cb;
        char    *descr;
} cfg_def_t;

/* declares a new cfg group
 * handler is set to the memory area where the variables are stored
 * return value is -1 on error
 */
int cfg_declare(char *group_name, cfg_def_t *def, void *values, int def_size,
                        void **handler);

#define cfg_sizeof(gname) \
        sizeof(struct cfg_group_##gname)

#define cfg_get(gname, handle, var) \
        ((struct cfg_group_##gname *)handle)->var

/* declares a single variable with integer type */
int cfg_declare_int(char *group_name, char *var_name,
                int val, int min, int max, char *descr);

/* declares a single variable with str type */
int cfg_declare_str(char *group_name, char *var_name, char *val, char *descr);

/* Add a varibale to a group instance with integer type.
 * The group instance is created if it does not exist.
 * wrapper function for new_add_var()
 */
int cfg_ginst_var_int(char *group_name, unsigned int group_id, char *var_name,
                        int val);

/* Add a varibale to a group instance with string type.
 * The group instance is created if it does not exist.
 * wrapper function for new_add_var()
 */
int cfg_ginst_var_string(char *group_name, unsigned int group_id, char *var_name,
                        char *val);

/* Create a new group instance.
 * wrapper function for new_add_var()
 */
int cfg_new_ginst(char *group_name, unsigned int group_id);

/* returns the handle of a cfg group */
void **cfg_get_handle(char *gname);

#endif /* _CFG_H */