glib/gdataset.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_DATASET_H__
  28 #define __G_DATASET_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gquark.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef struct _GData           GData;
  39
  40 typedef void            (*GDataForeachFunc)     (GQuark         key_id,
  41                                                  gpointer       data,
  42                                                  gpointer       user_data);
  43
  44 /* Keyed Data List
  45  */
  46 GLIB_AVAILABLE_IN_ALL
  47 void     g_datalist_init                (GData            **datalist);
  48 GLIB_AVAILABLE_IN_ALL
  49 void     g_datalist_clear               (GData            **datalist);
  50 GLIB_AVAILABLE_IN_ALL
  51 gpointer g_datalist_id_get_data         (GData            **datalist,
  52                                          GQuark             key_id);
  53 GLIB_AVAILABLE_IN_ALL
  54 void     g_datalist_id_set_data_full    (GData            **datalist,
  55                                          GQuark             key_id,
  56                                          gpointer           data,
  57                                          GDestroyNotify     destroy_func);
  58
  59 typedef gpointer (*GDuplicateFunc) (gpointer data, gpointer user_data);
  60
  61 GLIB_AVAILABLE_IN_2_34
  62 gpointer g_datalist_id_dup_data         (GData            **datalist,
  63                                          GQuark             key_id,
  64                                          GDuplicateFunc     dup_func,
  65                                          gpointer           user_data);
  66 GLIB_AVAILABLE_IN_2_34
  67 gboolean g_datalist_id_replace_data     (GData            **datalist,
  68                                          GQuark             key_id,
  69                                          gpointer           oldval,
  70                                          gpointer           newval,
  71                                          GDestroyNotify     destroy,
  72                                          GDestroyNotify    *old_destroy);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 gpointer g_datalist_id_remove_no_notify (GData            **datalist,
  76                                          GQuark             key_id);
  77 GLIB_AVAILABLE_IN_ALL
  78 void     g_datalist_foreach             (GData            **datalist,
  79                                          GDataForeachFunc   func,
  80                                          gpointer           user_data);
  81
  82 /**
  83  * G_DATALIST_FLAGS_MASK:
  84  *
  85  * A bitmask that restricts the possible flags passed to
  86  * g_datalist_set_flags(). Passing a flags value where
  87  * flags & ~G_DATALIST_FLAGS_MASK != 0 is an error.
  88  */
  89 #define G_DATALIST_FLAGS_MASK 0x3
  90
  91 GLIB_AVAILABLE_IN_ALL
  92 void     g_datalist_set_flags           (GData            **datalist,
  93                                          guint              flags);
  94 GLIB_AVAILABLE_IN_ALL
  95 void     g_datalist_unset_flags         (GData            **datalist,
  96                                          guint              flags);
  97 GLIB_AVAILABLE_IN_ALL
  98 guint    g_datalist_get_flags           (GData            **datalist);
  99
 100 #define   g_datalist_id_set_data(dl, q, d)      \
 101      g_datalist_id_set_data_full ((dl), (q), (d), NULL)
 102 #define   g_datalist_id_remove_data(dl, q)      \
 103      g_datalist_id_set_data ((dl), (q), NULL)
 104 #define   g_datalist_set_data_full(dl, k, d, f) \
 105      g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
 106 #define   g_datalist_remove_no_notify(dl, k)    \
 107      g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
 108 #define   g_datalist_set_data(dl, k, d)         \
 109      g_datalist_set_data_full ((dl), (k), (d), NULL)
 110 #define   g_datalist_remove_data(dl, k)         \
 111      g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
 112
 113 /* Location Associated Keyed Data
 114  */
 115 GLIB_AVAILABLE_IN_ALL
 116 void      g_dataset_destroy             (gconstpointer    dataset_location);
 117 GLIB_AVAILABLE_IN_ALL
 118 gpointer  g_dataset_id_get_data         (gconstpointer    dataset_location,
 119                                          GQuark           key_id);
 120 GLIB_AVAILABLE_IN_ALL
 121 gpointer  g_datalist_get_data            (GData  **datalist,
 122                                           const gchar *key);
 123 GLIB_AVAILABLE_IN_ALL
 124 void      g_dataset_id_set_data_full    (gconstpointer    dataset_location,
 125                                          GQuark           key_id,
 126                                          gpointer         data,
 127                                          GDestroyNotify   destroy_func);
 128 GLIB_AVAILABLE_IN_ALL
 129 gpointer  g_dataset_id_remove_no_notify (gconstpointer    dataset_location,
 130                                          GQuark           key_id);
 131 GLIB_AVAILABLE_IN_ALL
 132 void      g_dataset_foreach             (gconstpointer    dataset_location,
 133                                          GDataForeachFunc func,
 134                                          gpointer         user_data);
 135 #define   g_dataset_id_set_data(l, k, d)        \
 136      g_dataset_id_set_data_full ((l), (k), (d), NULL)
 137 #define   g_dataset_id_remove_data(l, k)        \
 138      g_dataset_id_set_data ((l), (k), NULL)
 139 #define   g_dataset_get_data(l, k)              \
 140      (g_dataset_id_get_data ((l), g_quark_try_string (k)))
 141 #define   g_dataset_set_data_full(l, k, d, f)   \
 142      g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
 143 #define   g_dataset_remove_no_notify(l, k)      \
 144      g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
 145 #define   g_dataset_set_data(l, k, d)           \
 146      g_dataset_set_data_full ((l), (k), (d), NULL)
 147 #define   g_dataset_remove_data(l, k)           \
 148      g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
 149
 150 G_END_DECLS
 151
 152 #endif /* __G_DATASET_H__ */