summaryrefslogtreecommitdiff
path: root/telepathy-glib/gtypes.c
blob: 7c26a4dd9334544eebebaa24ba86ca9d2b4d4b67 (plain)
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
/*
 * gtypes.c - Specialized GTypes representing D-Bus structs etc.
 * Copyright (C) 2007 Collabora Ltd. <http://www.collabora.co.uk/>
 * Copyright (C) 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
 */

#include "config.h"

#include <telepathy-glib/gtypes.h>

#include <telepathy-glib/util.h>

/**
 * SECTION:gtypes
 * @title: GType factory functions
 * @short_description: Macros using caching factory functions to get
 *    dbus-glib specialized GTypes
 *
 * dbus-glib's built-in factory functions for specialized GTypes need to do
 * a fair amount of parsing on their arguments, so these macros are provided
 * to avoid that. Each macro expands to a call to a function which caches
 * the GType, so it only ever has to call into dbus-glib once.
 *
 * tp_dbus_specialized_value_slice_new() is also provided.
 *
 * Since: 0.7.0
 */

/**
 * TP_ARRAY_TYPE_OBJECT_PATH_LIST:
 *
 * Expands to a call to a function
 * that returns the #GType of a #GPtrArray
 * of DBUS_TYPE_G_OBJECT_PATH.
 *
 * Since: 0.7.34
 */

GType
tp_type_dbus_array_of_o (void)
{
  static GType t = 0;

  if (G_UNLIKELY (t == 0))
    t = dbus_g_type_get_collection ("GPtrArray", DBUS_TYPE_G_OBJECT_PATH);

  return t;
}

/**
 * tp_dbus_specialized_value_slice_new:
 * @type: A D-Bus specialized type (i.e. probably a specialized GValueArray
 * representing a D-Bus struct)
 *
 * <!-- -->
 *
 * Returns: a slice-allocated GValue containing an empty value of the
 * given type.
 */
GValue *
tp_dbus_specialized_value_slice_new (GType type)
{
  GValue *value = tp_g_value_slice_new (type);

  g_value_take_boxed (value, dbus_g_type_specialized_construct (type));
  return value;
}

/**
 * TP_TYPE_UCHAR_ARRAY:
 *
 * Expands to a call to a function
 * that returns the #GType of a #GArray
 * of %G_TYPE_UCHAR, i.e. the same thing as %DBUS_TYPE_G_UCHAR_ARRAY
 *
 * This is the type used in dbus-glib to represent a byte array, signature
 * 'ay'. (Note that the #GByteArray type is not used with dbus-glib.)
 *
 * Since: 0.11.1
 */

GType
tp_type_dbus_array_of_y (void)
{
  static GType t = 0;

  if (G_UNLIKELY (t == 0))
    t = DBUS_TYPE_G_UCHAR_ARRAY;

  return t;
}

/**
 * TP_ARRAY_TYPE_UCHAR_ARRAY_LIST:
 *
 * Expands to a call to a function
 * that returns the #GType of a #GPtrArray of %TP_TYPE_UCHAR_ARRAY, i.e.
 * a #GPtrArray of #GArray of #guchar.
 *
 * This is the type used in dbus-glib to represent an array of byte arrays,
 * signature 'aay'. (Note that the #GByteArray type is not used with
 * dbus-glib.)
 *
 * Since: 0.11.14
 */

GType
tp_type_dbus_array_of_ay (void)
{
  static GType t = 0;

  if (G_UNLIKELY (t == 0))
    t = dbus_g_type_get_collection ("GPtrArray", TP_TYPE_UCHAR_ARRAY);

  return t;
}

/* auto-generated implementation stubs */
#include "_gen/gtypes-body.h"