src/xbt/dict_private.h

   1 /* $Id$ */
   2
   3 /* dict_elm - elements of generic dictionnaries                             */
   4 /* This file is not to be loaded from anywhere but dict.c                   */
   5
   6 /* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
   7
   8 /* This program is free software; you can redistribute it and/or modify it
   9  * under the terms of the license (GNU LGPL) which comes with this package. */
  10
  11 #ifndef _XBT_DICT_ELM_T_
  12 #define _XBT_DICT_ELM_T_
  13
  14 #include "xbt/sysdep.h"
  15 #include "xbt/log.h"
  16 #include "xbt/error.h"
  17 #include "xbt/dynar.h"
  18 #include "xbt/dict.h"
  19
  20 /*####[ Type definition ]####################################################*/
  21 typedef struct xbt_dictelm_ {
  22   char           *key;
  23   int             key_len;
  24   int             offset; /* offset on the key */
  25   void           *content;
  26   void_f_pvoid_t *free_f; /*pointer to the function to call to free this ctn*/
  27
  28   xbt_dynar_t    sub; /* sub */
  29 } s_xbt_dictelm_t, *xbt_dictelm_t;
  30
  31 typedef struct xbt_dict_ {
  32   s_xbt_dictelm_t *head;
  33 } s_xbt_dict_t;
  34
  35 typedef struct xbt_dict_cursor_ s_xbt_dict_cursor_t;
  36
  37 /*####[ Function prototypes ]################################################*/
  38 void xbt_dictelm_free      (s_xbt_dictelm_t **pp_elm);
  39
  40 void xbt_dictelm_set       (s_xbt_dictelm_t **pp_head,
  41                              const char      *_key,
  42                              void            *data,
  43                              void_f_pvoid_t  *free_ctn);
  44 void xbt_dictelm_set_ext   (s_xbt_dictelm_t **pp_head,
  45                              const char      *_key,
  46                              int              key_len,
  47                              void            *data,
  48                              void_f_pvoid_t  *free_ctn);
  49
  50 xbt_error_t xbt_dictelm_get       (s_xbt_dictelm_t *p_head,
  51                                      const char     *key,
  52                                      /* OUT */void **data);
  53 xbt_error_t xbt_dictelm_get_ext   (s_xbt_dictelm_t *p_head,
  54                                      const char     *key,
  55                                      int             key_len,
  56                                      /* OUT */void **data);
  57
  58 xbt_error_t xbt_dictelm_remove    (s_xbt_dictelm_t *p_head,
  59                                      const char  *key);
  60 xbt_error_t xbt_dictelm_remove_ext(s_xbt_dictelm_t *p_head,
  61                                        const char  *key,
  62                                        int          key_len);
  63
  64 void         xbt_dictelm_dump      (s_xbt_dictelm_t *p_head,
  65                                      void_f_pvoid_t *output);
  66
  67 void         xbt_dictelm_print_fct (void *data);
  68
  69 #endif  /* _XBT_DICT_ELM_T_ */
  70