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
|
/*
* tp-handle-repo.h - handle reference-counting for connection managers
*
* Copyright (C) 2005,2006,2007 Collabora Ltd.
* Copyright (C) 2005,2006,2007 Nokia Corporation
*
* 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.1 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 St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
#if !defined (_TP_GLIB_H_INSIDE) && !defined (_TP_COMPILATION)
#error "Only <telepathy-glib/telepathy-glib.h> can be included directly."
#endif
#ifndef __TP_HANDLE_REPO_H__
#define __TP_HANDLE_REPO_H__
#include <glib-object.h>
#include <gio/gio.h>
#include <telepathy-glib/intset.h>
#include <telepathy-glib/handle.h>
G_BEGIN_DECLS
/* Forward declaration to avoid circular includes */
typedef struct _TpBaseConnection TpBaseConnection;
/* Forward declaration because it's in the HandleRepo API */
#define TP_TYPE_HANDLE_SET (tp_handle_set_get_type ())
GType tp_handle_set_get_type (void);
typedef struct _TpHandleSet TpHandleSet;
/* Handle repository abstract interface */
#define TP_TYPE_HANDLE_REPO_IFACE (tp_handle_repo_iface_get_type ())
#define TP_HANDLE_REPO_IFACE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), \
TP_TYPE_HANDLE_REPO_IFACE, TpHandleRepoIface))
#define TP_IS_HANDLE_REPO_IFACE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
TP_TYPE_HANDLE_REPO_IFACE))
#define TP_HANDLE_REPO_IFACE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_INTERFACE ((obj), \
TP_TYPE_HANDLE_REPO_IFACE, TpHandleRepoIfaceClass))
/**
* TpHandleRepoIface:
*
* Dummy typedef representing any implementation of this interface.
*/
typedef struct _TpHandleRepoIface TpHandleRepoIface;
/**
* TpHandleRepoIfaceClass:
*
* The class of a handle repository interface. The structure layout is
* only available within telepathy-glib, for the handle repository
* implementations' benefit.
*/
typedef struct _TpHandleRepoIfaceClass TpHandleRepoIfaceClass;
GType tp_handle_repo_iface_get_type (void);
/* Public API for handle repositories */
gboolean tp_handle_is_valid (TpHandleRepoIface *self,
TpHandle handle, GError **error);
gboolean tp_handles_are_valid (TpHandleRepoIface *self,
const GArray *handles, gboolean allow_zero, GError **error);
const char *tp_handle_inspect (TpHandleRepoIface *self,
TpHandle handle) G_GNUC_WARN_UNUSED_RESULT;
TpHandle tp_handle_lookup (TpHandleRepoIface *self,
const gchar *id, gpointer context, GError **error);
TpHandle tp_handle_ensure (TpHandleRepoIface *self,
const gchar *id, gpointer context, GError **error)
G_GNUC_WARN_UNUSED_RESULT;
_TP_AVAILABLE_IN_0_20
void tp_handle_ensure_async (TpHandleRepoIface *self,
TpBaseConnection *connection,
const gchar *id,
gpointer context,
GAsyncReadyCallback callback,
gpointer user_data);
_TP_AVAILABLE_IN_0_20
TpHandle tp_handle_ensure_finish (TpHandleRepoIface *self,
GAsyncResult *result,
GError **error);
/* Handle set helper class */
typedef void (*TpHandleSetMemberFunc)(TpHandleSet *set, TpHandle handle,
gpointer userdata);
TpHandleSet * tp_handle_set_new (TpHandleRepoIface *repo)
G_GNUC_WARN_UNUSED_RESULT;
TpHandleSet *tp_handle_set_copy (const TpHandleSet *other)
G_GNUC_WARN_UNUSED_RESULT;
TpHandleSet *tp_handle_set_new_from_intset (TpHandleRepoIface *repo,
const TpIntset *intset);
TpHandleSet *tp_handle_set_new_containing (TpHandleRepoIface *repo,
TpHandle handle);
void tp_handle_set_clear (TpHandleSet *set);
void tp_handle_set_destroy (TpHandleSet *set);
TpIntset *tp_handle_set_peek (TpHandleSet *set) G_GNUC_WARN_UNUSED_RESULT;
void tp_handle_set_add (TpHandleSet *set, TpHandle handle);
gboolean tp_handle_set_remove (TpHandleSet *set, TpHandle handle);
gboolean tp_handle_set_is_member (const TpHandleSet *set, TpHandle handle);
void tp_handle_set_foreach (TpHandleSet *set, TpHandleSetMemberFunc func,
gpointer user_data);
gboolean tp_handle_set_is_empty (const TpHandleSet *set);
int tp_handle_set_size (const TpHandleSet *set);
GArray *tp_handle_set_to_array (const TpHandleSet *set)
G_GNUC_WARN_UNUSED_RESULT;
GVariant *tp_handle_set_to_identifier_map (TpHandleSet *self)
G_GNUC_WARN_UNUSED_RESULT;
TpHandleSet *tp_handle_set_new_from_array (TpHandleRepoIface *repo,
const GArray *array) G_GNUC_WARN_UNUSED_RESULT;
TpIntset *tp_handle_set_update (TpHandleSet *set, const TpIntset *add)
G_GNUC_WARN_UNUSED_RESULT;
TpIntset *tp_handle_set_difference_update (TpHandleSet *set,
const TpIntset *remove) G_GNUC_WARN_UNUSED_RESULT;
gchar *tp_handle_set_dump (const TpHandleSet *self) G_GNUC_WARN_UNUSED_RESULT;
/* static inline because it relies on TP_NUM_ENTITY_TYPES */
/**
* tp_handles_supported_and_valid: (skip)
* @repos: An array of possibly null pointers to handle repositories, indexed
* by entity type, where a null pointer means an unsupported handle
* type
* @entity_type: The entity type
* @handles: A GArray of guint representing handles of the given type
* @allow_zero: If %TRUE, zero is treated like a valid handle
* @error: Used to return an error if %FALSE is returned
*
* Return %TRUE if the given entity type is supported (i.e. repos[entity_type]
* is not %NULL) and the given handles are all valid in that repository.
* If not, set @error and return %FALSE.
*
* Returns: %TRUE if the entity type is supported and the handles are all
* valid.
*/
static inline
/* spacer so gtkdoc documents this function as though not static */
gboolean tp_handles_supported_and_valid (
TpHandleRepoIface *repos[TP_NUM_ENTITY_TYPES],
TpEntityType entity_type, const GArray *handles, gboolean allow_zero,
GError **error);
static inline gboolean
tp_handles_supported_and_valid (TpHandleRepoIface *repos[TP_NUM_ENTITY_TYPES],
TpEntityType entity_type,
const GArray *handles,
gboolean allow_zero,
GError **error)
{
if (!tp_entity_type_is_valid (entity_type, error))
return FALSE;
if (!repos[entity_type])
{
tp_g_set_error_unsupported_entity_type (entity_type, error);
return FALSE;
}
return tp_handles_are_valid (repos[entity_type], handles, allow_zero, error);
}
G_END_DECLS
#endif /*__HANDLE_SET_H__*/
|
