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 #include <glib/gquark.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GData           GData;
  35
  36 typedef void            (*GDataForeachFunc)     (GQuark         key_id,
  37                                                  gpointer       data,
  38                                                  gpointer       user_data);
  39
  40 /* Keyed Data List
  41  */
  42 void      g_datalist_init                (GData          **datalist);
  43 void      g_datalist_clear               (GData          **datalist);
  44 gpointer  g_datalist_id_get_data         (GData          **datalist,
  45                                           GQuark           key_id);
  46 void      g_datalist_id_set_data_full    (GData          **datalist,
  47                                           GQuark           key_id,
  48                                           gpointer         data,
  49                                           GDestroyNotify   destroy_func);
  50 gpointer  g_datalist_id_remove_no_notify (GData          **datalist,
  51                                           GQuark           key_id);
  52 void      g_datalist_foreach             (GData          **datalist,
  53                                           GDataForeachFunc func,
  54                                           gpointer         user_data);
  55 #define   g_datalist_id_set_data(dl, q, d)      \
  56      g_datalist_id_set_data_full ((dl), (q), (d), NULL)
  57 #define   g_datalist_id_remove_data(dl, q)      \
  58      g_datalist_id_set_data ((dl), (q), NULL)
  59 #define   g_datalist_get_data(dl, k)            \
  60      (g_datalist_id_get_data ((dl), g_quark_try_string (k)))
  61 #define   g_datalist_set_data_full(dl, k, d, f) \
  62      g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
  63 #define   g_datalist_remove_no_notify(dl, k)    \
  64      g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
  65 #define   g_datalist_set_data(dl, k, d)         \
  66      g_datalist_set_data_full ((dl), (k), (d), NULL)
  67 #define   g_datalist_remove_data(dl, k)         \
  68      g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
  69
  70
  71 /* Location Associated Keyed Data
  72  */
  73 void      g_dataset_destroy             (gconstpointer    dataset_location);
  74 gpointer  g_dataset_id_get_data         (gconstpointer    dataset_location,
  75                                          GQuark           key_id);
  76 void      g_dataset_id_set_data_full    (gconstpointer    dataset_location,
  77                                          GQuark           key_id,
  78                                          gpointer         data,
  79                                          GDestroyNotify   destroy_func);
  80 gpointer  g_dataset_id_remove_no_notify (gconstpointer    dataset_location,
  81                                          GQuark           key_id);
  82 void      g_dataset_foreach             (gconstpointer    dataset_location,
  83                                          GDataForeachFunc func,
  84                                          gpointer         user_data);
  85 #define   g_dataset_id_set_data(l, k, d)        \
  86      g_dataset_id_set_data_full ((l), (k), (d), NULL)
  87 #define   g_dataset_id_remove_data(l, k)        \
  88      g_dataset_id_set_data ((l), (k), NULL)
  89 #define   g_dataset_get_data(l, k)              \
  90      (g_dataset_id_get_data ((l), g_quark_try_string (k)))
  91 #define   g_dataset_set_data_full(l, k, d, f)   \
  92      g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
  93 #define   g_dataset_remove_no_notify(l, k)      \
  94      g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
  95 #define   g_dataset_set_data(l, k, d)           \
  96      g_dataset_set_data_full ((l), (k), (d), NULL)
  97 #define   g_dataset_remove_data(l, k)           \
  98      g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
  99
 100 G_END_DECLS
 101
 102 #endif /* __G_DATASET_H__ */
 103
 104
 105
 106