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
|
/*
* handle.h - Header for basic Telepathy-GLib handle functionality
*
* Copyright (C) 2005, 2007 Collabora Ltd.
* Copyright (C) 2005, 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_DISABLE_SINGLE_INCLUDE) && !defined (_TP_IN_META_HEADER) && !defined (_TP_COMPILATION)
#error "Only <telepathy-glib/telepathy-glib.h> and <telepathy-glib/telepathy-glib-dbus.h> can be included directly."
#endif
#ifndef __TP_HANDLE_H__
#define __TP_HANDLE_H__
#include <glib.h>
#include <telepathy-glib/enums.h>
#include <telepathy-glib/errors.h>
G_BEGIN_DECLS
/**
* TpHandle:
*
* Type representing Telepathy handles within telepathy-glib.
*
* This is guint despite the wire protocol having 32-bit integers, because
* dbus-glib expects GArrays of guint and so on. If the dbus-glib ABI changes
* in future, telepathy-glib is likely to have a matching ABI change.
*/
typedef guint TpHandle;
/**
* TP_TYPE_HANDLE:
*
* The GType of a TpHandle, currently G_TYPE_UINT.
*
* This won't change unless in an ABI-incompatible version of telepathy-glib.
*/
#define TP_TYPE_HANDLE G_TYPE_UINT
/**
* TP_UNKNOWN_HANDLE_TYPE:
*
* An invalid handle type (-1 cast to TpHandleType) used to represent an
* unknown handle type.
*
* Since: 0.7.0
*/
#define TP_UNKNOWN_HANDLE_TYPE ((TpHandleType) -1)
/**
* tp_handle_type_is_valid:
* @type: A handle type, valid or not, to be checked
* @error: Set if the handle type is invalid
*
* If the given handle type is valid, return %TRUE. If not, set @error
* and return %FALSE.
*
* Returns: %TRUE if the handle type is valid.
*/
static inline
/* spacer so gtkdoc documents this function as though not static */
gboolean tp_handle_type_is_valid (TpHandleType type, GError **error);
/* Must be static inline because it references TP_NUM_HANDLE_TYPES -
* if it wasn't inlined, a newer libtelepathy-glib with a larger number
* of handle types might accept handle types that won't fit in the
* connection manager's array of length TP_NUM_HANDLE_TYPES
*/
static inline gboolean
tp_handle_type_is_valid (TpHandleType type, GError **error)
{
if (type > TP_HANDLE_TYPE_NONE && type < TP_NUM_HANDLE_TYPES)
return TRUE;
tp_g_set_error_invalid_handle_type (type, error);
return FALSE;
}
const gchar *tp_handle_type_to_string (TpHandleType type);
G_END_DECLS
#endif
|
