treeconf.h

Go to the documentation of this file.

/*
** Copyright (C) 2004, 2005 by Kevin L. Mitchell <klmitch@mit.edu>
**
** This program 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.
**
** This program 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
**
** @(#)$Id: treeconf.h,v 1.10 2005/06/08 13:17:36 klmitch Exp $
*/
#ifndef __include_treeconf_h__
#define __include_treeconf_h__

#undef TC_BEGIN_C_DECLS
#undef TC_END_C_DECLS
#ifdef __cplusplus
# define TC_BEGIN_C_DECLS extern "C" {
# define TC_END_C_DECLS }
#else
# define TC_BEGIN_C_DECLS /* empty */
# define TC_END_C_DECLS   /* empty */
#endif

TC_BEGIN_C_DECLS

#ifndef __TREECONF_LIBRARY__
#include <treeconf/treeconf_err.h>
#include <treeconf/treeconf_version.h>
#endif /* __TREECONF_LIBRARY__ */

typedef struct _treeconf_ctx_s treeconf_ctx_t;

typedef struct _treeconf_node_s treeconf_node_t;

typedef struct _treeconf_str_s treeconf_str_t;

typedef struct _treeconf_subst_s treeconf_subst_t;

typedef enum {
  TC_NODETYPE_VARIABLE =    0,      
  TC_NODETYPE_NODE     =    1,      
  TC_NODETYPE_IMPLICIT = 0x10,      
  TC_NODETYPE_MASK     = 0x0f 
} treeconf_type_t;

typedef int (*treeconf_nodown_t)(treeconf_ctx_t *ctx, treeconf_node_t *parent,
                         treeconf_str_t *name, int elements);

typedef void (*treeconf_change_t)(treeconf_ctx_t *ctx, treeconf_node_t *node);

typedef unsigned int (*treeconf_file_t)(const char *file, void *data);

struct _treeconf_ctx_s {
  unsigned int          tx_magic;   
  treeconf_node_t      *tx_config;  
  unsigned int          tx_count;   
};

#define TREECONF_CTX_MAGIC 0x838290fd

#define TREECONF_CTX_INIT     { TREECONF_CTX_MAGIC, 0, 0 }

#define tx_verify(ctx)        ((ctx) &&                           \
                         (ctx)->tx_magic == TREECONF_CTX_MAGIC)

#define tx_config(ctx)        ((ctx)->tx_config)

#define tx_count(ctx)         ((ctx)->tx_count)

#define tc_init(ctx) do {                                         \
  treeconf_ctx_t *_ctx = (ctx);                                         \
  _ctx->tx_config = 0;                                            \
  _ctx->tx_count = 0;                                             \
  _ctx->tx_magic = TREECONF_CTX_MAGIC;                                  \
} while (0)

struct _treeconf_node_s {
  unsigned int          tn_magic;   
  treeconf_ctx_t       *tn_context; 
  treeconf_type_t tn_type;    
  treeconf_node_t      *tn_next;    
  treeconf_node_t      *tn_down;    
  treeconf_node_t      *tn_parent;  
  treeconf_nodown_t     tn_nodown;  
  treeconf_change_t     tn_change;  
  const char             *tn_value; 
  const char             *tn_default;     
  void                   *tn_assoc; 
  char                  tn_name[1]; 
};

#define TREECONF_NODE_MAGIC 0x80ab298d

#define tn_verify(node)       ((node) &&                          \
                         (node)->tn_magic == TREECONF_NODE_MAGIC)

#define tn_context(node)      ((node)->tn_context)

#define tn_type(node)         ((node)->tn_type)

#define tn_next(node)         ((node)->tn_next)

#define tn_down(node)         ((node)->tn_down)

#define tn_parent(node)       ((node)->tn_parent)

#define tn_nodown(node)       ((node)->tn_nodown)

#define tn_change(node)       ((node)->tn_change)

#define tn_value(node)        ((node)->tn_value)

#define tn_default(node)      ((node)->tn_default)

#define tn_assoc(node)        ((node)->tn_assoc)

#define tn_name(node)         ((node)->tn_name)

#define tn_isdef(node)        ((node)->tn_value == (node)->tn_default)

struct _treeconf_str_s {
  const char             *ts_string;      
  int             ts_length;  
};

#define ts_string(strs, n)    ((strs)[(n)].ts_string)

#define ts_length(strs, n)    ((strs)[(n)].ts_length)

struct _treeconf_subst_s {
  const char            tu_char;    
  const char             *tu_value; 
  unsigned int          tu_flags;   
};

#define TC_SUBST_INSECURE     0x01

#define TC_SUBST_IGNORE       0x02

#define TC_SUBST_INIT(chr, str, flags)                                  \
                        { (chr), (str), (flags) }

#define tu_char(sub)          ((sub)->tu_char)

#define tu_value(sub)         ((sub)->tu_value)

#define tu_flags(sub)         ((sub)->tu_flags)

unsigned int tc_break(treeconf_str_t **str_p, int *cnt_p, const char *name,
                  const char *delims);

unsigned int tc_path(const char *path, const char *def,
                 treeconf_subst_t substs[], int s_cnt,
                 unsigned int flags, treeconf_file_t call,
                 void *call_data);

#define TC_PATH_SECURE        TC_SUBST_INSECURE

#define TC_PATH_ALL           0x02

unsigned int tc_destroy(treeconf_ctx_t *ctx);

unsigned int tc_register(treeconf_ctx_t *ctx, const char *name,
                   const char *def, treeconf_node_t *parent,
                   treeconf_nodown_t nodown, treeconf_change_t change,
                   void *assoc);

unsigned int tc_set(treeconf_ctx_t *ctx, const char *name, const char *value,
                treeconf_node_t *parent);

unsigned int tc_get(treeconf_ctx_t *ctx, const char *name, const char **value,
                treeconf_node_t *parent);

unsigned int tc_find(treeconf_ctx_t *ctx, const char *name,
                 treeconf_node_t **node, treeconf_node_t *parent);

unsigned int tc_load(const char *file, void *ctx);

TC_END_C_DECLS

#endif /* __include_treeconf_h__ */

---