NetworkManager/src/libnm-glib-aux/nm-dbus-aux.h
Thomas Haller 615221a99c format: reformat source tree with clang-format 13.0
We use clang-format for automatic formatting of our source files.
Since clang-format is actively maintained software, the actual
formatting depends on the used version of clang-format. That is
unfortunate and painful, but really unavoidable unless clang-format
would be strictly bug-compatible.

So the version that we must use is from the current Fedora release, which
is also tested by our gitlab-ci. Previously, we were using Fedora 34 with
clang-tools-extra-12.0.1-1.fc34.x86_64.

As Fedora 35 comes along, we need to update our formatting as Fedora 35
comes with version "13.0.0~rc1-1.fc35".
An alternative would be to freeze on version 12, but that has different
problems (like, it's cumbersome to rebuild clang 12 on Fedora 35 and it
would be cumbersome for our developers which are on Fedora 35 to use a
clang that they cannot easily install).

The (differently painful) solution is to reformat from time to time, as we
switch to a new Fedora (and thus clang) version.
Usually we would expect that such a reformatting brings minor changes.
But this time, the changes are huge. That is mentioned in the release
notes [1] as

  Makes PointerAligment: Right working with AlignConsecutiveDeclarations. (Fixes https://llvm.org/PR27353)

[1] https://releases.llvm.org/13.0.0/tools/clang/docs/ReleaseNotes.html#clang-format
2021-11-29 09:31:09 +00:00

267 lines
13 KiB
C

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2019 Red Hat, Inc.
*/
#ifndef __NM_DBUS_AUX_H__
#define __NM_DBUS_AUX_H__
#include "libnm-std-aux/nm-dbus-compat.h"
/*****************************************************************************/
static inline gboolean
nm_clear_g_dbus_connection_signal(GDBusConnection *dbus_connection, guint *id)
{
guint v;
if (id && (v = *id)) {
*id = 0;
g_dbus_connection_signal_unsubscribe(dbus_connection, v);
return TRUE;
}
return FALSE;
}
/*****************************************************************************/
typedef void (*NMDBusConnectionCallDefaultCb)(GVariant *result, GError *error, gpointer user_data);
/*****************************************************************************/
static inline void
nm_dbus_connection_call_start_service_by_name(GDBusConnection *dbus_connection,
const char *name,
int timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
g_dbus_connection_call(dbus_connection,
DBUS_SERVICE_DBUS,
DBUS_PATH_DBUS,
DBUS_INTERFACE_DBUS,
"StartServiceByName",
g_variant_new("(su)", name, 0u),
G_VARIANT_TYPE("(u)"),
G_DBUS_CALL_FLAGS_NONE,
timeout_msec,
cancellable,
callback,
user_data);
}
/*****************************************************************************/
static inline guint
nm_dbus_connection_signal_subscribe_name_owner_changed(GDBusConnection *dbus_connection,
const char *service_name,
GDBusSignalCallback callback,
gpointer user_data,
GDestroyNotify user_data_free_func)
{
return g_dbus_connection_signal_subscribe(dbus_connection,
DBUS_SERVICE_DBUS,
DBUS_INTERFACE_DBUS,
"NameOwnerChanged",
DBUS_PATH_DBUS,
service_name,
G_DBUS_SIGNAL_FLAGS_NONE,
callback,
user_data,
user_data_free_func);
}
typedef void (*NMDBusConnectionCallGetNameOwnerCb)(const char *name_owner,
GError *error,
gpointer user_data);
void nm_dbus_connection_call_get_name_owner(GDBusConnection *dbus_connection,
const char *service_name,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallGetNameOwnerCb callback,
gpointer user_data);
static inline void
nm_dbus_connection_call_request_name(GDBusConnection *dbus_connection,
const char *name,
guint32 flags,
int timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
g_dbus_connection_call(dbus_connection,
DBUS_SERVICE_DBUS,
DBUS_PATH_DBUS,
DBUS_INTERFACE_DBUS,
"RequestName",
g_variant_new("(su)", name, flags),
G_VARIANT_TYPE("(u)"),
G_DBUS_CALL_FLAGS_NONE,
timeout_msec,
cancellable,
callback,
user_data);
}
static inline guint
nm_dbus_connection_signal_subscribe_properties_changed(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
const char *interface_name,
GDBusSignalCallback callback,
gpointer user_data,
GDestroyNotify user_data_free_func)
{
nm_assert(bus_name);
/* it seems that using a non-unique name causes problems that we get signals
* also from unrelated senders. Usually, you are anyway monitoring the name-owner,
* so you should have the unique name at hand.
*
* If not, investigate this, ensure that it works, and lift this restriction. */
nm_assert(g_dbus_is_unique_name(bus_name));
return g_dbus_connection_signal_subscribe(dbus_connection,
bus_name,
DBUS_INTERFACE_PROPERTIES,
"PropertiesChanged",
object_path,
interface_name,
G_DBUS_SIGNAL_FLAGS_NONE,
callback,
user_data,
user_data_free_func);
}
void nm_dbus_connection_call_get_all(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
const char *interface_name,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data);
void nm_dbus_connection_call_set(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
const char *interface_name,
const char *property_name,
GVariant *value,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data);
/*****************************************************************************/
static inline guint
nm_dbus_connection_signal_subscribe_object_manager(GDBusConnection *dbus_connection,
const char *service_name,
const char *object_path,
const char *signal_name,
GDBusSignalCallback callback,
gpointer user_data,
GDestroyNotify user_data_free_func)
{
return g_dbus_connection_signal_subscribe(dbus_connection,
service_name,
DBUS_INTERFACE_OBJECT_MANAGER,
signal_name,
object_path,
NULL,
G_DBUS_SIGNAL_FLAGS_NONE,
callback,
user_data,
user_data_free_func);
}
void nm_dbus_connection_call_get_managed_objects(GDBusConnection *dbus_connection,
const char *bus_name,
const char *object_path,
GDBusCallFlags flags,
int timeout_msec,
GCancellable *cancellable,
NMDBusConnectionCallDefaultCb callback,
gpointer user_data);
/*****************************************************************************/
void
nm_dbus_connection_call_finish_void_cb(GObject *source, GAsyncResult *result, gpointer user_data);
void nm_dbus_connection_call_finish_void_strip_dbus_error_cb(GObject *source,
GAsyncResult *result,
gpointer user_data);
void nm_dbus_connection_call_finish_variant_cb(GObject *source,
GAsyncResult *result,
gpointer user_data);
void nm_dbus_connection_call_finish_variant_strip_dbus_error_cb(GObject *source,
GAsyncResult *result,
gpointer user_data);
/*****************************************************************************/
void nm_dbus_call(GBusType bus_type,
const char *bus_name,
const char *object_path,
const char *interface_name,
const char *method_name,
GVariant *parameters,
const GVariantType *reply_type,
GCancellable *cancellable,
int timeout_msec,
GAsyncReadyCallback callback,
gpointer user_data);
GVariant *nm_dbus_call_finish(GAsyncResult *result, GError **error);
/*****************************************************************************/
gboolean _nm_dbus_error_is(GError *error, ...) G_GNUC_NULL_TERMINATED;
#define nm_dbus_error_is(error, ...) \
({ \
GError *const _error = (error); \
\
_error &&_nm_dbus_error_is(_error, __VA_ARGS__, NULL); \
})
#define NM_DBUS_ERROR_NAME_UNKNOWN_METHOD "org.freedesktop.DBus.Error.UnknownMethod"
/*****************************************************************************/
GDBusConnection *nm_g_bus_get_blocking(GCancellable *cancellable, GError **error);
/*****************************************************************************/
typedef struct {
GVariant *result;
GError *error;
} NMDBusConnectionCallBlockingData;
void
nm_dbus_connection_call_blocking_callback(GObject *source, GAsyncResult *res, gpointer user_data);
GVariant *nm_dbus_connection_call_blocking(NMDBusConnectionCallBlockingData *data, GError **error);
/*****************************************************************************/
static inline gboolean
nm_g_variant_tuple_get_u(GVariant *v, guint32 *out_u)
{
if (g_variant_is_of_type(v, G_VARIANT_TYPE("(u)"))) {
g_variant_get(v, "(u)", out_u);
return TRUE;
}
return FALSE;
}
#endif /* __NM_DBUS_AUX_H__ */