luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 22:16:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Deprecate GCache

Browse Source 
Ryan said it would be 'deprecated soon in GLib', when he removed
the use of this in GTK+. That was a year ago, so its about time
we act on it.
This commit is contained in:
Matthias Clasen 2011-10-12 19:55:02 -04:00
parent 39ae59c47e
commit 2da83bbd36
5 changed files with 67 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/glib/glib-docs.sgml
View File

@ -119,7 +119,6 @@ synchronize their operation.
<xi:include href="xml/quarks.xml" /> <xi:include href="xml/quarks.xml" />
<xi:include href="xml/datalist.xml" /> <xi:include href="xml/datalist.xml" />
<xi:include href="xml/datasets.xml" /> <xi:include href="xml/datasets.xml" />
<xi:include href="xml/caches.xml" />
<xi:include href="xml/gvarianttype.xml"/> <xi:include href="xml/gvarianttype.xml"/>
<xi:include href="xml/gvariant.xml"/> <xi:include href="xml/gvariant.xml"/>
<xi:include href="gvariant-varargs.xml"/> <xi:include href="gvariant-varargs.xml"/>
@ -129,6 +128,7 @@ synchronize their operation.
<chapter id="deprecated"> <chapter id="deprecated">
<title>Deprecated APIs</title> <title>Deprecated APIs</title>
<xi:include href="xml/threads-deprecated.xml"/> <xi:include href="xml/threads-deprecated.xml"/>
<xi:include href="xml/caches.xml" />
<xi:include href="xml/relations.xml" /> <xi:include href="xml/relations.xml" />
<xi:include href="xml/completion.xml" /> <xi:include href="xml/completion.xml" />
</chapter> </chapter>

4
glib/Makefile.am
View File

@ -113,6 +113,7 @@ uninstall-ms-lib:
deprecated_sources = \ deprecated_sources = \
deprecated/gallocator.c \ deprecated/gallocator.c \
deprecated/gcache.c \
deprecated/gcompletion.c \ deprecated/gcompletion.c \
deprecated/grel.c \ deprecated/grel.c \
deprecated/gthread-deprecated.c deprecated/gthread-deprecated.c
@ -131,7 +132,6 @@ libglib_2_0_la_SOURCES = \
gbsearcharray.h \ gbsearcharray.h \
gbuffer.c \ gbuffer.c \
gbufferprivate.h \ gbufferprivate.h \
gcache.c \
gchecksum.c \ gchecksum.c \
gconvert.c \ gconvert.c \
gdataset.c \ gdataset.c \
@ -241,6 +241,7 @@ glibinclude_HEADERS = \
deprecatedincludedir=$(includedir)/glib-2.0/glib/deprecated deprecatedincludedir=$(includedir)/glib-2.0/glib/deprecated
deprecatedinclude_HEADERS = \ deprecatedinclude_HEADERS = \
deprecated/gallocator.h \ deprecated/gallocator.h \
deprecated/gcache.h \
deprecated/gcompletion.h \ deprecated/gcompletion.h \
deprecated/grel.h \ deprecated/grel.h \
deprecated/gthread.h deprecated/gthread.h
@ -255,7 +256,6 @@ glibsubinclude_HEADERS = \
gbase64.h \ gbase64.h \
gbitlock.h \ gbitlock.h \
gbookmarkfile.h \ gbookmarkfile.h \
gcache.h \
gchecksum.h \ gchecksum.h \
gconvert.h \ gconvert.h \
gdataset.h \ gdataset.h \

100
glib/gcache.c → glib/deprecated/gcache.c
View File

@ -45,14 +45,12 @@
* A #GCache allows sharing of complex data structures, in order to * A #GCache allows sharing of complex data structures, in order to
* save system resources. * save system resources.
* *
* GTK+ uses caches for #GtkStyles and #GdkGCs. These consume a lot of * GCache uses keys and values. A GCache key describes the properties
* resources, so a #GCache is used to see if a #GtkStyle or #GdkGC with * of a particular resource. A GCache value is the actual resource.
* the required properties already exists. If it does, then the
* existing object is used instead of creating a new one.
* *
* #GCache uses keys and values. A #GCache key describes the properties * GCache has been marked as deprecated, since this API is rarely
* of a particular resource. A #GCache value is the actual resource. * used and not very actively maintained.
**/ */
typedef struct _GCacheNode GCacheNode; typedef struct _GCacheNode GCacheNode;
@ -69,7 +67,9 @@ struct _GCacheNode
* The #GCache struct is an opaque data structure containing * The #GCache struct is an opaque data structure containing
* information about a #GCache. It should only be accessed via the * information about a #GCache. It should only be accessed via the
* following functions. * following functions.
**/ *
* Deprecated:2.32: Use a #GHashTable instead
*/
struct _GCache struct _GCache
{ {
/* Called to create a value from a key */ /* Called to create a value from a key */
@ -110,54 +110,60 @@ g_cache_node_destroy (GCacheNode *node)
* g_cache_new: * g_cache_new:
* @value_new_func: a function to create a new object given a key. * @value_new_func: a function to create a new object given a key.
* This is called by g_cache_insert() if an object * This is called by g_cache_insert() if an object
* with the given key does not already exist. * with the given key does not already exist
* @value_destroy_func: a function to destroy an object. It is called * @value_destroy_func: a function to destroy an object. It is called
* by g_cache_remove() when the object is no * by g_cache_remove() when the object is no
* longer needed (i.e. its reference count drops * longer needed (i.e. its reference count drops
* to 0). * to 0)
* @key_dup_func: a function to copy a key. It is called by * @key_dup_func: a function to copy a key. It is called by
* g_cache_insert() if the key does not already exist in * g_cache_insert() if the key does not already exist in
* the #GCache. * the #GCache
* @key_destroy_func: a function to destroy a key. It is called by * @key_destroy_func: a function to destroy a key. It is called by
* g_cache_remove() when the object is no longer * g_cache_remove() when the object is no longer
* needed (i.e. its reference count drops to 0). * needed (i.e. its reference count drops to 0)
* @hash_key_func: a function to create a hash value from a key. * @hash_key_func: a function to create a hash value from a key
* @hash_value_func: a function to create a hash value from a value. * @hash_value_func: a function to create a hash value from a value
* @key_equal_func: a function to compare two keys. It should return * @key_equal_func: a function to compare two keys. It should return
* %TRUE if the two keys are equivalent. * %TRUE if the two keys are equivalent
* @Returns: a new #GCache.
* *
* Creates a new #GCache. * Creates a new #GCache.
**/ *
* Returns: a new #GCache
*
* Deprecated:2.32: Use a #GHashTable instead
*/
/** /**
* GCacheNewFunc: * GCacheNewFunc:
* @key: a #GCache key. * @key: a #GCache key
* @Returns: a new #GCache value corresponding to the key. * @Returns: a new #GCache value corresponding to the key.
* *
* Specifies the type of the @value_new_func function passed to * Specifies the type of the @value_new_func function passed to
* g_cache_new(). It is passed a #GCache key and should create the * g_cache_new(). It is passed a #GCache key and should create the
* value corresponding to the key. * value corresponding to the key.
**/ */
/** /**
* GCacheDestroyFunc: * GCacheDestroyFunc:
* @value: the #GCache value to destroy. * @value: the #GCache value to destroy
* *
* Specifies the type of the @value_destroy_func and @key_destroy_func * Specifies the type of the @value_destroy_func and @key_destroy_func
* functions passed to g_cache_new(). The functions are passed a * functions passed to g_cache_new(). The functions are passed a
* pointer to the #GCache key or #GCache value and should free any * pointer to the #GCache key or #GCache value and should free any
* memory and other resources associated with it. * memory and other resources associated with it.
**/ */
/** /**
* GCacheDupFunc: * GCacheDupFunc:
* @value: the #GCache key to destroy (<emphasis>not</emphasis> a * @value: the #GCache key to destroy (<emphasis>not</emphasis> a
* #GCache value as it seems). * #GCache value as it seems)
* @Returns: a copy of the #GCache key. * @Returns: a copy of the #GCache key
* *
* Specifies the type of the @key_dup_func function passed to * Specifies the type of the @key_dup_func function passed to
* g_cache_new(). The function is passed a key * g_cache_new(). The function is passed a key
* (<emphasis>not</emphasis> a value as the prototype implies) and * (<emphasis>not</emphasis> a value as the prototype implies) and
* should return a duplicate of the key. * should return a duplicate of the key.
**/ */
GCache* GCache*
g_cache_new (GCacheNewFunc value_new_func, g_cache_new (GCacheNewFunc value_new_func,
GCacheDestroyFunc value_destroy_func, GCacheDestroyFunc value_destroy_func,
@ -190,13 +196,15 @@ g_cache_new (GCacheNewFunc value_new_func,
/** /**
* g_cache_destroy: * g_cache_destroy:
* @cache: a #GCache. * @cache: a #GCache
* *
* Frees the memory allocated for the #GCache. * Frees the memory allocated for the #GCache.
* *
* Note that it does not destroy the keys and values which were * Note that it does not destroy the keys and values which were
* contained in the #GCache. * contained in the #GCache.
**/ *
* Deprecated:2.32: Use a #GHashTable instead
*/
void void
g_cache_destroy (GCache *cache) g_cache_destroy (GCache *cache)
{ {
@ -209,9 +217,8 @@ g_cache_destroy (GCache *cache)
/** /**
* g_cache_insert: * g_cache_insert:
* @cache: a #GCache. * @cache: a #GCache
* @key: a key describing a #GCache object. * @key: a key describing a #GCache object
* @Returns: a pointer to a #GCache value.
* *
* Gets the value corresponding to the given key, creating it if * Gets the value corresponding to the given key, creating it if
* necessary. It first checks if the value already exists in the * necessary. It first checks if the value already exists in the
@ -221,7 +228,11 @@ g_cache_destroy (GCache *cache)
* exist, if is created by calling the @value_new_func. The key is * exist, if is created by calling the @value_new_func. The key is
* duplicated by calling @key_dup_func and the duplicated key and value * duplicated by calling @key_dup_func and the duplicated key and value
* are inserted into the #GCache. * are inserted into the #GCache.
**/ *
* Returns: a pointer to a #GCache value
*
* Deprecated:2.32: Use a #GHashTable instead
*/
gpointer gpointer
g_cache_insert (GCache *cache, g_cache_insert (GCache *cache,
gpointer key) gpointer key)
@ -250,13 +261,15 @@ g_cache_insert (GCache *cache,
/** /**
* g_cache_remove: * g_cache_remove:
* @cache: a #GCache. * @cache: a #GCache
* @value: the value to remove. * @value: the value to remove
* *
* Decreases the reference count of the given value. If it drops to 0 * Decreases the reference count of the given value. If it drops to 0
* then the value and its corresponding key are destroyed, using the * then the value and its corresponding key are destroyed, using the
* @value_destroy_func and @key_destroy_func passed to g_cache_new(). * @value_destroy_func and @key_destroy_func passed to g_cache_new().
**/ *
* Deprecated:2.32: Use a #GHashTable instead
*/
void void
g_cache_remove (GCache *cache, g_cache_remove (GCache *cache,
gconstpointer value) gconstpointer value)
@ -285,9 +298,9 @@ g_cache_remove (GCache *cache,
/** /**
* g_cache_key_foreach: * g_cache_key_foreach:
* @cache: a #GCache. * @cache: a #GCache
* @func: the function to call with each #GCache key. * @func: the function to call with each #GCache key
* @user_data: user data to pass to the function. * @user_data: user data to pass to the function
* *
* Calls the given function for each of the keys in the #GCache. * Calls the given function for each of the keys in the #GCache.
* *
@ -295,7 +308,9 @@ g_cache_remove (GCache *cache,
* entry and the @user_data. The order of value and key is different * entry and the @user_data. The order of value and key is different
* from the order in which g_hash_table_foreach() passes key-value * from the order in which g_hash_table_foreach() passes key-value
* pairs to its callback function ! * pairs to its callback function !
**/ *
* Deprecated:2.32: Use a #GHashTable instead
*/
void void
g_cache_key_foreach (GCache *cache, g_cache_key_foreach (GCache *cache,
GHFunc func, GHFunc func,
@ -309,16 +324,15 @@ g_cache_key_foreach (GCache *cache,
/** /**
* g_cache_value_foreach: * g_cache_value_foreach:
* @cache: a #GCache. * @cache: a #GCache
* @func: the function to call with each #GCache value. * @func: the function to call with each #GCache value
* @user_data: user data to pass to the function. * @user_data: user data to pass to the function
* *
* Calls the given function for each of the values in the #GCache. * Calls the given function for each of the values in the #GCache.
* *
* Deprecated:2.10: The reason is that it passes pointers to internal * Deprecated:2.10: The reason is that it passes pointers to internal
* data structures to @func; use g_cache_key_foreach() * data structures to @func; use g_cache_key_foreach() instead
* instead */
**/
void void
g_cache_value_foreach (GCache *cache, g_cache_value_foreach (GCache *cache,
GHFunc func, GHFunc func,

9
glib/gcache.h → glib/deprecated/gcache.h
View File

@ -43,6 +43,7 @@ typedef void (*GCacheDestroyFunc) (gpointer value);
/* Caches /* Caches
*/ */
GLIB_DEPRECATED
GCache* g_cache_new (GCacheNewFunc value_new_func, GCache* g_cache_new (GCacheNewFunc value_new_func,
GCacheDestroyFunc value_destroy_func, GCacheDestroyFunc value_destroy_func,
GCacheDupFunc key_dup_func, GCacheDupFunc key_dup_func,
@ -50,20 +51,22 @@ GCache* g_cache_new (GCacheNewFunc value_new_func,
GHashFunc hash_key_func, GHashFunc hash_key_func,
GHashFunc hash_value_func, GHashFunc hash_value_func,
GEqualFunc key_equal_func); GEqualFunc key_equal_func);
GLIB_DEPRECATED
void g_cache_destroy (GCache *cache); void g_cache_destroy (GCache *cache);
GLIB_DEPRECATED
gpointer g_cache_insert (GCache *cache, gpointer g_cache_insert (GCache *cache,
gpointer key); gpointer key);
GLIB_DEPRECATED
void g_cache_remove (GCache *cache, void g_cache_remove (GCache *cache,
gconstpointer value); gconstpointer value);
GLIB_DEPRECATED
void g_cache_key_foreach (GCache *cache, void g_cache_key_foreach (GCache *cache,
GHFunc func, GHFunc func,
gpointer user_data); gpointer user_data);
#ifndef G_DISABLE_DEPRECATED GLIB_DEPRECATED
GLIB_DEPRECATED_FOR(g_cache_key_foreach)
void g_cache_value_foreach (GCache *cache, void g_cache_value_foreach (GCache *cache,
GHFunc func, GHFunc func,
gpointer user_data); gpointer user_data);
#endif
G_END_DECLS G_END_DECLS

2
glib/glib.h
View File

@ -37,7 +37,6 @@
#include <glib/gbase64.h> #include <glib/gbase64.h>
#include <glib/gbitlock.h> #include <glib/gbitlock.h>
#include <glib/gbookmarkfile.h> #include <glib/gbookmarkfile.h>
#include <glib/gcache.h>
#include <glib/gchecksum.h> #include <glib/gchecksum.h>
#include <glib/gconvert.h> #include <glib/gconvert.h>
#include <glib/gdataset.h> #include <glib/gdataset.h>
@ -96,6 +95,7 @@
#ifndef G_DISABLE_DEPRECATED #ifndef G_DISABLE_DEPRECATED
#include <glib/deprecated/gallocator.h> #include <glib/deprecated/gallocator.h>
#include <glib/deprecated/gcache.h>
#include <glib/deprecated/gcompletion.h> #include <glib/deprecated/gcompletion.h>
#include <glib/deprecated/grel.h> #include <glib/deprecated/grel.h>
#include <glib/deprecated/gthread.h> #include <glib/deprecated/gthread.h>