1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-signatures.h utility functions for D-Bus types
3 *
4 * Copyright (C) 2005 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21 *
22 */
23#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25#endif
26
27#ifndef DBUS_SIGNATURES_H
28#define DBUS_SIGNATURES_H
29
30#include <dbus/dbus-macros.h>
31#include <dbus/dbus-types.h>
32#include <dbus/dbus-errors.h>
33
34DBUS_BEGIN_DECLS
35
36/**
37 * @addtogroup DBusSignature
38 * @{
39 */
40
41/**
42 * DBusSignatureIter struct; contains no public fields
43 */
44typedef struct
45{
46  void *dummy1;         /**< Don't use this */
47  void *dummy2;         /**< Don't use this */
48  dbus_uint32_t dummy8; /**< Don't use this */
49  int dummy12;           /**< Don't use this */
50  int dummy17;           /**< Don't use this */
51} DBusSignatureIter;
52
53DBUS_EXPORT
54void            dbus_signature_iter_init             (DBusSignatureIter       *iter,
55						      const char              *signature);
56
57DBUS_EXPORT
58int             dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);
59
60DBUS_EXPORT
61char *          dbus_signature_iter_get_signature    (const DBusSignatureIter *iter);
62
63DBUS_EXPORT
64int             dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);
65
66DBUS_EXPORT
67dbus_bool_t     dbus_signature_iter_next             (DBusSignatureIter       *iter);
68
69DBUS_EXPORT
70void            dbus_signature_iter_recurse          (const DBusSignatureIter *iter,
71						      DBusSignatureIter       *subiter);
72
73DBUS_EXPORT
74dbus_bool_t     dbus_signature_validate              (const char       *signature,
75						      DBusError        *error);
76
77DBUS_EXPORT
78dbus_bool_t     dbus_signature_validate_single       (const char       *signature,
79						      DBusError        *error);
80
81DBUS_EXPORT
82dbus_bool_t     dbus_type_is_valid                   (int            typecode);
83
84DBUS_EXPORT
85dbus_bool_t     dbus_type_is_basic                   (int            typecode);
86DBUS_EXPORT
87dbus_bool_t     dbus_type_is_container               (int            typecode);
88DBUS_EXPORT
89dbus_bool_t     dbus_type_is_fixed                   (int            typecode);
90
91/** @} */
92
93DBUS_END_DECLS
94
95#endif /* DBUS_SIGNATURE_H */
96