1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* libmm-glib -- Access modem status & information from glib applications
*
* 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., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright (C) 2011-2021 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef _MM_HELPERS_H_
#define _MM_HELPERS_H_
/******************************************************************************/
#define RETURN_NON_EMPTY_CONSTANT_STRING(input) do { \
const gchar *str; \
\
str = (input); \
if (str && str[0]) \
return str; \
} while (0); \
return NULL
#define RETURN_NON_EMPTY_STRING(input) do { \
gchar *str; \
\
str = (input); \
if (str && str[0]) \
return str; \
g_free (str); \
} while (0); \
return NULL
/******************************************************************************/
/* These are helper macros to work with properties that are being monitored
* internally by the proxy objects. This internal monitoring is used to allow
* maintaining 'custom' types associated to complex DBus properties like
* dictionaries.
*
* Basic ARRAY and OBJECT type support is given.
*/
#define PROPERTY_COMMON_DECLARE(property_name) \
guint property_name##_id; \
gboolean property_name##_refresh_required;
#define PROPERTY_DECLARE(property_name,PropertyType) \
PropertyType *property_name; \
PROPERTY_COMMON_DECLARE (property_name)
#define PROPERTY_ARRAY_DECLARE(property_name) PROPERTY_DECLARE (property_name, GArray)
#define PROPERTY_OBJECT_DECLARE(property_name,ObjectType) PROPERTY_DECLARE (property_name, ObjectType)
#define PROPERTY_ERROR_DECLARE(property_name) PROPERTY_DECLARE (property_name, GError)
#define PROPERTY_INITIALIZE(property_name,signal_name) \
self->priv->property_name##_refresh_required = TRUE; \
self->priv->property_name##_id = \
g_signal_connect (self, \
"notify::" signal_name, \
G_CALLBACK (property_name##_updated), \
NULL);
#define PROPERTY_ARRAY_FINALIZE(property_name) \
g_clear_pointer (&self->priv->property_name, g_array_unref);
#define PROPERTY_OBJECT_FINALIZE(property_name) \
g_clear_object (&self->priv->property_name);
#define PROPERTY_ERROR_FINALIZE(property_name) \
g_clear_error (&self->priv->property_name);
/* This helper macro uses a GMutexLocker to lock the context
* in which the macro is defined (so it must always be defined at the
* start of the context). It also will run a given refresh method if
* a specific input flag is set.
*/
#define PROPERTY_LOCK_AND_REFRESH(property_name) \
g_autoptr(GMutexLocker) locker = NULL; \
\
locker = g_mutex_locker_new (&self->priv->mutex); \
if (self->priv->property_name##_refresh_required) { \
property_name##_refresh (self); \
self->priv->property_name##_refresh_required = FALSE; \
}
/* This helper defines the property refresh method, and can be used for simple
* one-to-one property vs array transformations */
#define PROPERTY_ARRAY_DEFINE_REFRESH(property_name,Type,type,TYPE,variant_to_garray) \
static void \
property_name##_refresh (MM##Type *self) \
{ \
g_autoptr(GVariant) variant = NULL; \
\
g_clear_pointer (&self->priv->property_name, g_array_unref); \
\
variant = mm_gdbus_##type##_dup_##property_name (MM_GDBUS_##TYPE (self)); \
if (!variant) \
return; \
\
self->priv->property_name = variant_to_garray (variant); \
}
/* This helper defines the property refresh method, and can be used for simple
* one-to-one property vs object transformations */
#define PROPERTY_OBJECT_DEFINE_REFRESH(property_name,Type,type,TYPE,variant_to_object) \
static void \
property_name##_refresh (MM##Type *self) \
{ \
g_autoptr(GVariant) variant = NULL; \
\
g_clear_object (&self->priv->property_name); \
\
variant = mm_gdbus_##type##_dup_##property_name (MM_GDBUS_##TYPE (self)); \
if (!variant) \
return; \
\
self->priv->property_name = variant_to_object (variant); \
}
#define PROPERTY_OBJECT_DEFINE_REFRESH_FAILABLE(property_name,Type,type,TYPE,variant_to_object) \
static void \
property_name##_refresh (MM##Type *self) \
{ \
g_autoptr(GVariant) variant = NULL; \
g_autoptr(GError) inner_error = NULL; \
\
g_clear_object (&self->priv->property_name); \
\
variant = mm_gdbus_##type##_dup_##property_name (MM_GDBUS_##TYPE (self)); \
if (!variant) \
return; \
\
self->priv->property_name = variant_to_object (variant, &inner_error); \
if (inner_error) \
g_warning ("Invalid object variant reported: %s", inner_error->message); \
}
/* This helper defines the property refresh method, and can be used for simple
* one-to-one property vs GError transformations */
#define PROPERTY_ERROR_DEFINE_REFRESH_FAILABLE(property_name,Type,type,TYPE,variant_to_error) \
static void \
property_name##_refresh (MM##Type *self) \
{ \
g_autoptr(GVariant) variant = NULL; \
g_autoptr(GError) inner_error = NULL; \
\
g_clear_error (&self->priv->property_name); \
\
variant = mm_gdbus_##type##_dup_##property_name (MM_GDBUS_##TYPE (self)); \
if (!variant) \
return; \
\
self->priv->property_name = variant_to_error (variant, &inner_error); \
if (inner_error) \
g_warning ("Invalid error variant reported: %s", inner_error->message); \
}
/* This helper defines the common generic property updated callback */
#define PROPERTY_DEFINE_UPDATED(property_name,Type) \
static void \
property_name##_updated (MM##Type *self) \
{ \
g_autoptr(GMutexLocker) locker = NULL; \
\
locker = g_mutex_locker_new (&self->priv->mutex); \
self->priv->property_name##_refresh_required = TRUE; \
}
/* Getter implementation for arrays of complex types that need
* deep copy. */
#define PROPERTY_ARRAY_DEFINE_GET_DEEP(property_name,Type,type,TYPE,ArrayItemType,garray_to_array) \
gboolean \
mm_##type##_get_##property_name (MM##Type *self, \
ArrayItemType **out, \
guint *n_out) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), FALSE); \
g_return_val_if_fail (out != NULL, FALSE); \
g_return_val_if_fail (n_out != NULL, FALSE); \
\
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
return garray_to_array (self->priv->property_name, out, n_out); \
} \
}
/* Getter implementation for arrays of simple types */
#define PROPERTY_ARRAY_DEFINE_GET(property_name,Type,type,TYPE,ArrayItemType) \
gboolean \
mm_##type##_get_##property_name (MM##Type *self, \
ArrayItemType **out, \
guint *n_out) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), FALSE); \
g_return_val_if_fail (out != NULL, FALSE); \
g_return_val_if_fail (n_out != NULL, FALSE); \
\
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
if (!self->priv->property_name) \
return FALSE; \
\
*out = NULL; \
*n_out = self->priv->property_name->len; \
if (self->priv->property_name->len > 0) \
*out = g_memdup (self->priv->property_name->data, \
(guint)(sizeof (ArrayItemType) * self->priv->property_name->len)); \
return TRUE; \
} \
}
/* Peeker implementation for arrays of any type */
#define PROPERTY_ARRAY_DEFINE_PEEK(property_name,Type,type,TYPE,ArrayItemType) \
gboolean \
mm_##type##_peek_##property_name (MM##Type *self, \
const ArrayItemType **out, \
guint *n_out) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), FALSE); \
g_return_val_if_fail (out != NULL, FALSE); \
g_return_val_if_fail (n_out != NULL, FALSE); \
\
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
\
if (!self->priv->property_name) \
return FALSE; \
\
*n_out = self->priv->property_name->len; \
*out = (ArrayItemType *)self->priv->property_name->data; \
return TRUE; \
} \
}
/* Get implementations for object properties */
#define PROPERTY_OBJECT_DEFINE_GET(property_name,object_name,Type,type,TYPE,ObjectType) \
ObjectType * \
mm_##type##_get_##object_name (MM##Type *self) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), NULL); \
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
return (self->priv->object_name ? \
g_object_ref (self->priv->object_name) : \
NULL); \
} \
}
/* Peek implementations for object properties */
#define PROPERTY_OBJECT_DEFINE_PEEK(property_name,object_name,Type,type,TYPE,ObjectType) \
ObjectType * \
mm_##type##_peek_##object_name (MM##Type *self) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), NULL); \
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
return self->priv->object_name; \
} \
}
/* Get implementations for error properties */
#define PROPERTY_ERROR_DEFINE_GET(property_name,Type,type,TYPE) \
GError * \
mm_##type##_get_##property_name (MM##Type *self) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), NULL); \
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
return (self->priv->property_name ? \
g_error_copy (self->priv->property_name) : \
NULL); \
} \
}
/* Peek implementations for error properties */
#define PROPERTY_ERROR_DEFINE_PEEK(property_name,Type,type,TYPE) \
GError * \
mm_##type##_peek_##property_name (MM##Type *self) \
{ \
g_return_val_if_fail (MM_IS_##TYPE (self), NULL); \
{ \
PROPERTY_LOCK_AND_REFRESH (property_name) \
return self->priv->property_name; \
} \
}
#define PROPERTY_ARRAY_DEFINE(property_name,Type,type,TYPE,ArrayItemType,variant_to_garray) \
PROPERTY_ARRAY_DEFINE_REFRESH (property_name, Type, type, TYPE, variant_to_garray) \
PROPERTY_DEFINE_UPDATED (property_name, Type) \
PROPERTY_ARRAY_DEFINE_GET (property_name, Type, type, TYPE, ArrayItemType) \
PROPERTY_ARRAY_DEFINE_PEEK (property_name, Type, type, TYPE, ArrayItemType)
#define PROPERTY_ARRAY_DEFINE_DEEP(property_name,Type,type,TYPE,ArrayItemType,variant_to_garray,garray_to_array) \
PROPERTY_ARRAY_DEFINE_REFRESH (property_name, Type, type, TYPE, variant_to_garray) \
PROPERTY_DEFINE_UPDATED (property_name, Type) \
PROPERTY_ARRAY_DEFINE_GET_DEEP (property_name, Type, type, TYPE, ArrayItemType, garray_to_array) \
PROPERTY_ARRAY_DEFINE_PEEK (property_name, Type, type, TYPE, ArrayItemType)
#define PROPERTY_OBJECT_DEFINE(property_name,Type,type,TYPE,ObjectType,variant_to_object) \
PROPERTY_OBJECT_DEFINE_REFRESH (property_name, Type, type, TYPE, variant_to_object) \
PROPERTY_DEFINE_UPDATED (property_name, Type) \
PROPERTY_OBJECT_DEFINE_GET (property_name, property_name, Type, type, TYPE, ObjectType) \
PROPERTY_OBJECT_DEFINE_PEEK (property_name, property_name, Type, type, TYPE, ObjectType)
#define PROPERTY_OBJECT_DEFINE_FAILABLE(property_name,Type,type,TYPE,ObjectType,variant_to_object) \
PROPERTY_OBJECT_DEFINE_REFRESH_FAILABLE (property_name, Type, type, TYPE, variant_to_object) \
PROPERTY_DEFINE_UPDATED (property_name, Type) \
PROPERTY_OBJECT_DEFINE_GET (property_name, property_name, Type, type, TYPE, ObjectType) \
PROPERTY_OBJECT_DEFINE_PEEK (property_name, property_name, Type, type, TYPE, ObjectType)
#define PROPERTY_ERROR_DEFINE_FAILABLE(property_name,Type,type,TYPE,variant_to_error) \
PROPERTY_ERROR_DEFINE_REFRESH_FAILABLE (property_name, Type, type, TYPE, variant_to_error) \
PROPERTY_DEFINE_UPDATED (property_name, Type) \
PROPERTY_ERROR_DEFINE_GET (property_name, Type, type, TYPE) \
PROPERTY_ERROR_DEFINE_PEEK (property_name, Type, type, TYPE)
#endif /* _MM_HELPERS_H_ */
|
