Blame glib/glib/gdataset.h

Packit db3073
/* GLIB - Library of useful routines for C programming
Packit db3073
 * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
Packit db3073
 *
Packit db3073
 * This library is free software; you can redistribute it and/or
Packit db3073
 * modify it under the terms of the GNU Lesser General Public
Packit db3073
 * License as published by the Free Software Foundation; either
Packit db3073
 * version 2 of the License, or (at your option) any later version.
Packit db3073
 *
Packit db3073
 * This library is distributed in the hope that it will be useful,
Packit db3073
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit db3073
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
Packit db3073
 * Lesser General Public License for more details.
Packit db3073
 *
Packit db3073
 * You should have received a copy of the GNU Lesser General Public
Packit db3073
 * License along with this library; if not, write to the
Packit db3073
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Packit db3073
 * Boston, MA 02111-1307, USA.
Packit db3073
 */
Packit db3073
Packit db3073
/*
Packit db3073
 * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
Packit db3073
 * file for a list of people on the GLib Team.  See the ChangeLog
Packit db3073
 * files for a list of changes.  These files are distributed with
Packit db3073
 * GLib at ftp://ftp.gtk.org/pub/gtk/.
Packit db3073
 */
Packit db3073
Packit db3073
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
Packit db3073
#error "Only <glib.h> can be included directly."
Packit db3073
#endif
Packit db3073
Packit db3073
#ifndef __G_DATASET_H__
Packit db3073
#define __G_DATASET_H__
Packit db3073
Packit db3073
#include <glib/gquark.h>
Packit db3073
Packit db3073
G_BEGIN_DECLS
Packit db3073
Packit db3073
typedef struct _GData           GData;
Packit db3073
Packit db3073
typedef void            (*GDataForeachFunc)     (GQuark         key_id,
Packit db3073
                                                 gpointer       data,
Packit db3073
                                                 gpointer       user_data);
Packit db3073
Packit db3073
/* Keyed Data List
Packit db3073
 */
Packit db3073
void     g_datalist_init                (GData            **datalist);
Packit db3073
void     g_datalist_clear               (GData            **datalist);
Packit db3073
gpointer g_datalist_id_get_data         (GData            **datalist,
Packit db3073
					 GQuark             key_id);
Packit db3073
void     g_datalist_id_set_data_full    (GData            **datalist,
Packit db3073
					 GQuark             key_id,
Packit db3073
					 gpointer           data,
Packit db3073
					 GDestroyNotify     destroy_func);
Packit db3073
gpointer g_datalist_id_remove_no_notify (GData            **datalist,
Packit db3073
					 GQuark             key_id);
Packit db3073
void     g_datalist_foreach             (GData            **datalist,
Packit db3073
					 GDataForeachFunc   func,
Packit db3073
					 gpointer           user_data);
Packit db3073
Packit db3073
/**
Packit db3073
 * G_DATALIST_FLAGS_MASK:
Packit db3073
 *
Packit db3073
 * A bitmask that restricts the possible flags passed to
Packit db3073
 * g_datalist_set_flags(). Passing a flags value where
Packit db3073
 * flags & ~G_DATALIST_FLAGS_MASK != 0 is an error.
Packit db3073
 */
Packit db3073
#define G_DATALIST_FLAGS_MASK 0x3
Packit db3073
Packit db3073
void     g_datalist_set_flags           (GData            **datalist,
Packit db3073
					 guint              flags);
Packit db3073
void     g_datalist_unset_flags         (GData            **datalist,
Packit db3073
					 guint              flags);
Packit db3073
guint    g_datalist_get_flags           (GData            **datalist);
Packit db3073
Packit db3073
#define   g_datalist_id_set_data(dl, q, d)      \
Packit db3073
     g_datalist_id_set_data_full ((dl), (q), (d), NULL)
Packit db3073
#define   g_datalist_id_remove_data(dl, q)      \
Packit db3073
     g_datalist_id_set_data ((dl), (q), NULL)
Packit db3073
#define   g_datalist_set_data_full(dl, k, d, f) \
Packit db3073
     g_datalist_id_set_data_full ((dl), g_quark_from_string (k), (d), (f))
Packit db3073
#define   g_datalist_remove_no_notify(dl, k)    \
Packit db3073
     g_datalist_id_remove_no_notify ((dl), g_quark_try_string (k))
Packit db3073
#define   g_datalist_set_data(dl, k, d)         \
Packit db3073
     g_datalist_set_data_full ((dl), (k), (d), NULL)
Packit db3073
#define   g_datalist_remove_data(dl, k)         \
Packit db3073
     g_datalist_id_set_data ((dl), g_quark_try_string (k), NULL)
Packit db3073
Packit db3073
Packit db3073
/* Location Associated Keyed Data
Packit db3073
 */
Packit db3073
void      g_dataset_destroy             (gconstpointer    dataset_location);
Packit db3073
gpointer  g_dataset_id_get_data         (gconstpointer    dataset_location,
Packit db3073
                                         GQuark           key_id);
Packit db3073
gpointer  g_datalist_get_data            (GData	 **datalist,
Packit db3073
					  const gchar *key);
Packit db3073
void      g_dataset_id_set_data_full    (gconstpointer    dataset_location,
Packit db3073
                                         GQuark           key_id,
Packit db3073
                                         gpointer         data,
Packit db3073
                                         GDestroyNotify   destroy_func);
Packit db3073
gpointer  g_dataset_id_remove_no_notify (gconstpointer    dataset_location,
Packit db3073
                                         GQuark           key_id);
Packit db3073
void      g_dataset_foreach             (gconstpointer    dataset_location,
Packit db3073
                                         GDataForeachFunc func,
Packit db3073
                                         gpointer         user_data);
Packit db3073
#define   g_dataset_id_set_data(l, k, d)        \
Packit db3073
     g_dataset_id_set_data_full ((l), (k), (d), NULL)
Packit db3073
#define   g_dataset_id_remove_data(l, k)        \
Packit db3073
     g_dataset_id_set_data ((l), (k), NULL)
Packit db3073
#define   g_dataset_get_data(l, k)              \
Packit db3073
     (g_dataset_id_get_data ((l), g_quark_try_string (k)))
Packit db3073
#define   g_dataset_set_data_full(l, k, d, f)   \
Packit db3073
     g_dataset_id_set_data_full ((l), g_quark_from_string (k), (d), (f))
Packit db3073
#define   g_dataset_remove_no_notify(l, k)      \
Packit db3073
     g_dataset_id_remove_no_notify ((l), g_quark_try_string (k))
Packit db3073
#define   g_dataset_set_data(l, k, d)           \
Packit db3073
     g_dataset_set_data_full ((l), (k), (d), NULL)
Packit db3073
#define   g_dataset_remove_data(l, k)           \
Packit db3073
     g_dataset_id_set_data ((l), g_quark_try_string (k), NULL)
Packit db3073
Packit db3073
G_END_DECLS
Packit db3073
Packit db3073
#endif /* __G_DATASET_H__ */