luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-27 07:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity
7b53edbf26
glib/glib/glib-autocleanups.h

106 lines
4.8 KiB
C
Raw Normal View History

glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
/*
* Copyright © 2015 Canonical Limited
*
glib: Add SPDX license headers automatically Add SPDX license (but not copyright) headers to all files which follow a certain pattern in their existing non-machine-readable header comment. This commit was entirely generated using the command: ``` git ls-files glib/*.[ch] | xargs perl -0777 -pi -e 's/\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/\n \*\n \* SPDX-License-Identifier: LGPL-2.1-or-later\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/igs' ``` Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Helps: #1415
2022-05-18 10:15:38 +02:00
* SPDX-License-Identifier: LGPL-2.1-or-later
*
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
glib/: LGPLv2+ -> LGPLv2.1+ All glib/*.{c,h} files have been processed, as well as gtester-report. 12 of those files are not licensed under LGPL: gbsearcharray.h gconstructor.h glibintl.h gmirroringtable.h gscripttable.h gtranslit-data.h gunibreak.h gunichartables.h gunicomp.h gunidecomp.h valgrind.h win_iconv.c Some of them are generated files, some are licensed under a BSD-style license and win_iconv.c is in the public domain. Sub-directories inside glib/: deprecated/: processed in a previous commit glib-mirroring-tab/: already LGPLv2.1+ gnulib/: not modified, the code is copied from gnulib libcharset/: a copy pcre/: a copy tests/: processed in a previous commit https://bugzilla.gnome.org/show_bug.cgi?id=776504
2017-01-05 12:47:07 +01:00
* version 2.1 of the License, or (at your option) any later version.
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Author: Ryan Lortie <desrt@desrt.ca>
*/
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
#error "Only <glib.h> can be included directly."
#endif
Add g_autofree The g_autoptr() being associated with the type name works out really well for things like GHashTable. However, it's a bit more awkward to associate with "gchar". Also because one can't use "char". Similarly, there are a lot of other "bare primitive array" types that one might reasonably use. This patch does not remove the autoptr for "gchar", even though I think it's rather awkward and strange. Also while we're here, add a test case for the cleanup bits. https://bugzilla.gnome.org/show_bug.cgi?id=744747
2015-02-15 14:58:44 +01:00
static inline void
g_autoptr_cleanup_generic_gfree (void *p)
Remove useless NULL check before g_free()
2015-09-21 16:50:38 +02:00
{
Add g_autofree The g_autoptr() being associated with the type name works out really well for things like GHashTable. However, it's a bit more awkward to associate with "gchar". Also because one can't use "char". Similarly, there are a lot of other "bare primitive array" types that one might reasonably use. This patch does not remove the autoptr for "gchar", even though I think it's rather awkward and strange. Also while we're here, add a test case for the cleanup bits. https://bugzilla.gnome.org/show_bug.cgi?id=744747
2015-02-15 14:58:44 +01:00
void **pp = (void**)p;
Remove useless NULL check before g_free()
2015-09-21 16:50:38 +02:00
g_free (*pp);
Add g_autofree The g_autoptr() being associated with the type name works out really well for things like GHashTable. However, it's a bit more awkward to associate with "gchar". Also because one can't use "char". Similarly, there are a lot of other "bare primitive array" types that one might reasonably use. This patch does not remove the autoptr for "gchar", even though I think it's rather awkward and strange. Also while we're here, add a test case for the cleanup bits. https://bugzilla.gnome.org/show_bug.cgi?id=744747
2015-02-15 14:58:44 +01:00
}
autocleanups: Add GString type https://bugzilla.gnome.org/show_bug.cgi?id=754831
2015-09-10 14:08:35 +02:00
static inline void
g_autoptr_cleanup_gstring_free (GString *string)
{
if (string)
g_string_free (string, TRUE);
}
glib: Ignore deprecations when declaring autocleanups We may need to declare autocleanups for new types, which will be marked as ‘deprecated’ if the code which includes GLib doesn’t declare a high enough `GLIB_VERSION_MAX_ALLOWED`. Despite that, we still need to declare the autocleanups. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-10-23 12:25:48 +02:00
/* Ignore deprecations in case we refer to a type which was added in a more
* recent GLib version than the user’s #GLIB_VERSION_MAX_ALLOWED definition. */
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
tests: Add many autoptr tests I love Emacs keyboard macros, used them to convert the list of defines cleverly into a list of tests, then iterated and filled in the necessary constructor arguments.
2015-02-23 14:32:36 +01:00
/* If adding a cleanup here, please also add a test case to
autocleanups: Add GString type https://bugzilla.gnome.org/show_bug.cgi?id=754831
2015-09-10 14:08:35 +02:00
* glib/tests/autoptr.c
tests: Add many autoptr tests I love Emacs keyboard macros, used them to convert the list of defines cleverly into a list of tests, then iterated and filled in the necessary constructor arguments.
2015-02-23 14:32:36 +01:00
*/
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GAsyncQueue, g_async_queue_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GBookmarkFile, g_bookmark_file_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GBytes, g_bytes_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GChecksum, g_checksum_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GDateTime, g_date_time_unref)
glib-autocleanups: Define the cleanup function for GDate Add an autoptr test as well.
2019-11-27 17:07:06 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GDate, g_date_free)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GDir, g_dir_close)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GError, g_error_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GHashTable, g_hash_table_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GHmac, g_hmac_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GIOChannel, g_io_channel_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GKeyFile, g_key_file_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GList, g_list_free)
autocleanups: Add G*Array types Not sure how these were omitted. Probably few people are really using this yet...and we don't have test cases (that's in the other patch). https://bugzilla.gnome.org/show_bug.cgi?id=744830
2015-02-20 00:31:29 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GArray, g_array_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GPtrArray, g_ptr_array_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GByteArray, g_byte_array_unref)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMainContext, g_main_context_unref)
gmain: Add GMainContextPusher convenience API This is like `GMutexLocker`, in that if you are able to use `g_autoptr()`, it makes popping a `GMainContext` off the thread-default main context stack easier when exiting a function. A few uses of `G_GNUC_{BEGIN,END}_IGNORE_DEPRECATIONS` are needed to avoid warnings when building apps against GLib with `GLIB_VERSION_MAX_ALLOWED < GLIB_VERSION_2_64`. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-10-23 12:35:58 +02:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMainContextPusher, g_main_context_pusher_free)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMainLoop, g_main_loop_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GSource, g_source_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMappedFile, g_mapped_file_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMarkupParseContext, g_markup_parse_context_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GNode, g_node_destroy)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GOptionContext, g_option_context_free)
autocleanups: Use g_option_context_unref() This fixes a use of a deprecated API.
2015-02-17 19:36:20 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GOptionGroup, g_option_group_unref)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GPatternSpec, g_pattern_spec_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GQueue, g_queue_free)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GQueue, g_queue_clear)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRand, g_rand_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRegex, g_regex_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMatchInfo, g_match_info_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GScanner, g_scanner_destroy)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GSequence, g_sequence_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GSList, g_slist_free)
autocleanups: Add GString type https://bugzilla.gnome.org/show_bug.cgi?id=754831
2015-09-10 14:08:35 +02:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GString, g_autoptr_cleanup_gstring_free)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GStringChunk, g_string_chunk_free)
gstrvbuilder: Add a new object to make NULL-terminated string arrays. GLib uses NULL-terminated string arrays (GStrv) in a number of places, however these are quite hard to construct in C when the number of elements is not known in advance. GStrvBuilder wraps GPtrArray to make these easy to create with type safety and does the memory management for you.
2020-10-14 13:01:24 +02:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GStrvBuilder, g_strv_builder_unref)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GThread, g_thread_unref)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GMutex, g_mutex_clear)
Add GMutexLocker https://bugzilla.gnome.org/show_bug.cgi?id=744012
2015-02-05 16:35:42 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GMutexLocker, g_mutex_locker_free)
Add GRecMutexLocker This is the same as GMutexLocker, just for recursive mutexes.
2018-12-12 12:03:13 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRecMutexLocker, g_rec_mutex_locker_free)
Add autoptr support for GRWLock
2019-05-09 16:27:47 +02:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRWLockWriterLocker, g_rw_lock_writer_locker_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRWLockReaderLocker, g_rw_lock_reader_locker_free)
glib: add support for g_auto() and g_autoptr() Add support to the libglib types for the new cleanup macros. https://bugzilla.gnome.org/show_bug.cgi?id=743640
2015-01-28 12:45:26 +01:00
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GCond, g_cond_clear)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GTimer, g_timer_destroy)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GTimeZone, g_time_zone_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GTree, g_tree_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GVariant, g_variant_unref)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GVariantBuilder, g_variant_builder_unref)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GVariantBuilder, g_variant_builder_clear)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GVariantIter, g_variant_iter_free)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GVariantDict, g_variant_dict_unref)
G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC(GVariantDict, g_variant_dict_clear)
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GVariantType, g_variant_type_free)
Move GStrv typedef to glib.h instead of gobject.h GStrv was historically only needed for the boxed G_TYPE_STRV, but it is now useful for g_auto(GStrv) as well. This is not an ABI change. https://bugzilla.gnome.org/show_bug.cgi?id=755355
2015-09-21 16:41:00 +02:00
G_DEFINE_AUTO_CLEANUP_FREE_FUNC(GStrv, g_strfreev, NULL)
misc: code style Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
2020-06-09 15:57:17 +02:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GRefString, g_ref_string_release)
guri: new URI parsing and generating functions Add a set of new URI parsing and generating functions, including a new parsed-URI type GUri. Move all the code from gurifuncs.c into guri.c, reimplementing some of those functions (and g_string_append_uri_encoded()) in terms of the new code. Fixes: https://gitlab.gnome.org/GNOME/glib/issues/110 Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
2019-01-17 07:38:20 +01:00
G_DEFINE_AUTOPTR_CLEANUP_FUNC(GUri, g_uri_unref)
glib: Ignore deprecations when declaring autocleanups We may need to declare autocleanups for new types, which will be marked as ‘deprecated’ if the code which includes GLib doesn’t declare a high enough `GLIB_VERSION_MAX_ALLOWED`. Despite that, we still need to declare the autocleanups. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-10-23 12:25:48 +02:00
G_GNUC_END_IGNORE_DEPRECATIONS
Reference in New Issue Copy Permalink