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 /* Authors: Martin Quinson                                                  */
   7 /* Copyright (C) 2003,2004 Martin Quinson.                                  */
   8
   9 /* This program is free software; you can redistribute it and/or modify it
  10    under the terms of the license (GNU LGPL) which comes with this package. */
  11
  12 #ifndef _GRAS_DICT_ELM_T_
  13 #define _GRAS_DICT_ELM_T_
  14
  15 #include "xbt/sysdep.h"
  16 #include "xbt/log.h"
  17 #include "xbt/error.h"
  18 #include "xbt/dynar.h"
  19 #include "xbt/dict.h"
  20
  21 /*####[ Type definition ]####################################################*/
  22 typedef struct gras_dictelm_ {
  23   char           *key;
  24   int             key_len;
  25   int             offset; /* offset on the key */
  26   void           *content;
  27   void_f_pvoid_t *free_f; /*pointer to the function to call to free this ctn*/
  28
  29   gras_dynar_t    sub; /* sub */
  30 } s_gras_dictelm_t, *gras_dictelm_t;
  31
  32 typedef struct gras_dict_ {
  33   s_gras_dictelm_t *head;
  34 } s_gras_dict_t;
  35
  36 typedef struct gras_dict_cursor_ s_gras_dict_cursor_t;
  37
  38 /*####[ Function prototypes ]################################################*/
  39 void gras_dictelm_free      (s_gras_dictelm_t **pp_elm);
  40
  41 void gras_dictelm_set       (s_gras_dictelm_t **pp_head,
  42                              const char      *_key,
  43                              void            *data,
  44                              void_f_pvoid_t  *free_ctn);
  45 void gras_dictelm_set_ext   (s_gras_dictelm_t **pp_head,
  46                              const char      *_key,
  47                              int              key_len,
  48                              void            *data,
  49                              void_f_pvoid_t  *free_ctn);
  50
  51 gras_error_t gras_dictelm_get       (s_gras_dictelm_t *p_head,
  52                                      const char     *key,
  53                                      /* OUT */void **data);
  54 gras_error_t gras_dictelm_get_ext   (s_gras_dictelm_t *p_head,
  55                                      const char     *key,
  56                                      int             key_len,
  57                                      /* OUT */void **data);
  58
  59 gras_error_t gras_dictelm_remove    (s_gras_dictelm_t *p_head,
  60                                      const char  *key);
  61 gras_error_t gras_dictelm_remove_ext(s_gras_dictelm_t *p_head,
  62                                        const char  *key,
  63                                        int          key_len);
  64
  65 void         gras_dictelm_dump      (s_gras_dictelm_t *p_head,
  66                                      void_f_pvoid_t *output);
  67
  68 void         gras_dictelm_print_fct (void *data);
  69
  70 #endif  /* _GRAS_DICT_ELM_T_ */
  71