mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2025-12-30 15:30:11 +01:00
904e8b8ca0
These cleanup macros are unused by NetworkManager code. Note that since "shared/nm-utils" is used by applet and VPN plugins, theoretically, they could be used there. I didn't check that, but breaking API of "shared/nm-utils" is fine (as long as we catch it with a compilation error). Historically, we use libgsystem's gsystem-local-alloc header and their "gs_*" macros. However, they are not really our style and don't have a nm-prefix (like the rest of our code). We keep the gs_ names, because they are wildly used and because we wanted to keep gsystem-local-alloc in sync with upstream (which is no longer the case). Our own cleanup macros are always called "nm_auto_*". So, at least for the unused "gs_*" macros, rename them to "nm_auto_*". Don't drop them, despite they being unused. The reason is, that we should make use of cleanup functions more eagerly. Dropping them now -- because they are momentarily unused -- hampers using them in the future. We often don't use the cleanup macros at places where I think we should, so by dropping them, we hamper future use.
165 lines
5 KiB
C
165 lines
5 KiB
C
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
|
|
*
|
|
* Copyright (C) 2012 Colin Walters <walters@verbum.org>.
|
|
*
|
|
* 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
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* 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, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __GSYSTEM_LOCAL_ALLOC_H__
|
|
#define __GSYSTEM_LOCAL_ALLOC_H__
|
|
|
|
#define GS_DEFINE_CLEANUP_FUNCTION_VOID(CastType, name, func) \
|
|
static inline void name (void *v) \
|
|
{ \
|
|
func (*((CastType *) v)); \
|
|
}
|
|
|
|
#define GS_DEFINE_CLEANUP_FUNCTION_VOID0(CastType, name, func) \
|
|
static inline void name (void *v) \
|
|
{ \
|
|
if (*((CastType *) v)) \
|
|
func (*((CastType *) v)); \
|
|
}
|
|
|
|
#define GS_DEFINE_CLEANUP_FUNCTION(Type, name, func) \
|
|
static inline void name (Type *v) \
|
|
{ \
|
|
func (*v); \
|
|
}
|
|
|
|
#define GS_DEFINE_CLEANUP_FUNCTION0(Type, name, func) \
|
|
static inline void name (Type *v) \
|
|
{ \
|
|
if (*v) \
|
|
func (*v); \
|
|
}
|
|
|
|
#define GS_DEFINE_CLEANUP_FUNCTION_STRUCT(Type, name, func) \
|
|
static inline void name (Type *v) \
|
|
{ \
|
|
func (v); \
|
|
}
|
|
|
|
/* These functions shouldn't be invoked directly;
|
|
* they are stubs that:
|
|
* 1) Take a pointer to the location (typically itself a pointer).
|
|
* 2) Provide %NULL-safety where it doesn't exist already (e.g. g_object_unref)
|
|
*/
|
|
|
|
/**
|
|
* gs_free:
|
|
*
|
|
* Call g_free() on a variable location when it goes out of scope.
|
|
*/
|
|
#define gs_free __attribute__ ((cleanup(gs_local_free)))
|
|
GS_DEFINE_CLEANUP_FUNCTION_VOID (void *, gs_local_free, g_free)
|
|
|
|
/**
|
|
* gs_unref_object:
|
|
*
|
|
* Call g_object_unref() on a variable location when it goes out of
|
|
* scope. Note that unlike g_object_unref(), the variable may be
|
|
* %NULL.
|
|
*/
|
|
#define gs_unref_object __attribute__ ((cleanup(gs_local_obj_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION_VOID0 (GObject *, gs_local_obj_unref, g_object_unref)
|
|
|
|
/**
|
|
* gs_unref_variant:
|
|
*
|
|
* Call g_variant_unref() on a variable location when it goes out of
|
|
* scope. Note that unlike g_variant_unref(), the variable may be
|
|
* %NULL.
|
|
*/
|
|
#define gs_unref_variant __attribute__ ((cleanup(gs_local_variant_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GVariant *, gs_local_variant_unref, g_variant_unref)
|
|
|
|
/**
|
|
* gs_unref_array:
|
|
*
|
|
* Call g_array_unref() on a variable location when it goes out of
|
|
* scope. Note that unlike g_array_unref(), the variable may be
|
|
* %NULL.
|
|
|
|
*/
|
|
#define gs_unref_array __attribute__ ((cleanup(gs_local_array_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GArray *, gs_local_array_unref, g_array_unref)
|
|
|
|
/**
|
|
* gs_unref_ptrarray:
|
|
*
|
|
* Call g_ptr_array_unref() on a variable location when it goes out of
|
|
* scope. Note that unlike g_ptr_array_unref(), the variable may be
|
|
* %NULL.
|
|
|
|
*/
|
|
#define gs_unref_ptrarray __attribute__ ((cleanup(gs_local_ptrarray_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GPtrArray *, gs_local_ptrarray_unref, g_ptr_array_unref)
|
|
|
|
/**
|
|
* gs_unref_hashtable:
|
|
*
|
|
* Call g_hash_table_unref() on a variable location when it goes out
|
|
* of scope. Note that unlike g_hash_table_unref(), the variable may
|
|
* be %NULL.
|
|
*/
|
|
#define gs_unref_hashtable __attribute__ ((cleanup(gs_local_hashtable_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GHashTable *, gs_local_hashtable_unref, g_hash_table_unref)
|
|
|
|
/**
|
|
* gs_free_slist:
|
|
*
|
|
* Call g_slist_free() on a variable location when it goes out
|
|
* of scope.
|
|
*/
|
|
#define gs_free_slist __attribute__ ((cleanup(gs_local_free_slist)))
|
|
GS_DEFINE_CLEANUP_FUNCTION (GSList *, gs_local_free_slist, g_slist_free)
|
|
|
|
/**
|
|
* gs_unref_bytes:
|
|
*
|
|
* Call g_bytes_unref() on a variable location when it goes out
|
|
* of scope. Note that unlike g_bytes_unref(), the variable may
|
|
* be %NULL.
|
|
*/
|
|
#define gs_unref_bytes __attribute__ ((cleanup(gs_local_bytes_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GBytes *, gs_local_bytes_unref, g_bytes_unref)
|
|
|
|
/**
|
|
* gs_strfreev:
|
|
*
|
|
* Call g_strfreev() on a variable location when it goes out of scope.
|
|
*/
|
|
#define gs_strfreev __attribute__ ((cleanup(gs_local_strfreev)))
|
|
GS_DEFINE_CLEANUP_FUNCTION (char **, gs_local_strfreev, g_strfreev)
|
|
|
|
/**
|
|
* gs_free_error:
|
|
*
|
|
* Call g_error_free() on a variable location when it goes out of scope.
|
|
*/
|
|
#define gs_free_error __attribute__ ((cleanup(gs_local_free_error)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GError *, gs_local_free_error, g_error_free)
|
|
|
|
/**
|
|
* gs_unref_keyfile:
|
|
*
|
|
* Call g_key_file_unref() on a variable location when it goes out of scope.
|
|
*/
|
|
#define gs_unref_keyfile __attribute__ ((cleanup(gs_local_keyfile_unref)))
|
|
GS_DEFINE_CLEANUP_FUNCTION0 (GKeyFile *, gs_local_keyfile_unref, g_key_file_unref)
|
|
|
|
#endif
|