dbus-signature.h 2.98 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
John Palmieri's avatar
John Palmieri committed
2
/* dbus-signatures.h utility functions for D-Bus types
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * Copyright (C) 2005 Red Hat Inc.
 *
 * Licensed under the Academic Free License version 2.1
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * 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 24 25 26 27 28 29 30 31 32 33 34 35
 *
 */
#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef DBUS_SIGNATURES_H
#define DBUS_SIGNATURES_H

#include <dbus/dbus-macros.h>
#include <dbus/dbus-types.h>
#include <dbus/dbus-errors.h>

DBUS_BEGIN_DECLS

36 37 38 39 40
/**
 * @addtogroup DBusSignature
 * @{
 */

41 42 43 44 45 46 47 48 49 50 51 52
/**
 * DBusSignatureIter struct; contains no public fields 
 */
typedef struct
{ 
  void *dummy1;         /**< Don't use this */
  void *dummy2;         /**< Don't use this */
  dbus_uint32_t dummy8; /**< Don't use this */
  int dummy12;           /**< Don't use this */
  int dummy17;           /**< Don't use this */
} DBusSignatureIter;

53
DBUS_EXPORT
54 55 56
void            dbus_signature_iter_init             (DBusSignatureIter       *iter,
						      const char              *signature);

57
DBUS_EXPORT
58 59
int             dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);

60
DBUS_EXPORT
61 62
char *          dbus_signature_iter_get_signature    (const DBusSignatureIter *iter);

63
DBUS_EXPORT
64 65
int             dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);

66
DBUS_EXPORT
67 68
dbus_bool_t     dbus_signature_iter_next             (DBusSignatureIter       *iter);

69
DBUS_EXPORT
70 71 72
void            dbus_signature_iter_recurse          (const DBusSignatureIter *iter,
						      DBusSignatureIter       *subiter);

73
DBUS_EXPORT
74 75 76
dbus_bool_t     dbus_signature_validate              (const char       *signature,
						      DBusError        *error);

77
DBUS_EXPORT
78 79 80
dbus_bool_t     dbus_signature_validate_single       (const char       *signature,
						      DBusError        *error);

81 82 83
DBUS_EXPORT
dbus_bool_t     dbus_type_is_valid                   (int            typecode);

84
DBUS_EXPORT
85
dbus_bool_t     dbus_type_is_basic                   (int            typecode);
86
DBUS_EXPORT
87
dbus_bool_t     dbus_type_is_container               (int            typecode);
88
DBUS_EXPORT
89
dbus_bool_t     dbus_type_is_fixed                   (int            typecode);
90

91 92
/** @} */

93 94
DBUS_END_DECLS

95
#endif /* DBUS_SIGNATURE_H */