dbus-1.0/dbus/dbus-signature.h

0001 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
0002 /* dbus-signatures.h utility functions for D-Bus types
0003  *
0004  * Copyright (C) 2005 Red Hat Inc.
0005  *
0006  * Licensed under the Academic Free License version 2.1
0007  *
0008  * This program is free software; you can redistribute it and/or modify
0009  * it under the terms of the GNU General Public License as published by
0010  * the Free Software Foundation; either version 2 of the License, or
0011  * (at your option) any later version.
0012  *
0013  * This program is distributed in the hope that it will be useful,
0014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0016  * GNU General Public License for more details.
0017  *
0018  * You should have received a copy of the GNU General Public License
0019  * along with this program; if not, write to the Free Software
0020  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0021  *
0022  */
0023 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
0024 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
0025 #endif
0026
0027 #ifndef DBUS_SIGNATURES_H
0028 #define DBUS_SIGNATURES_H
0029
0030 #include <dbus/dbus-macros.h>
0031 #include <dbus/dbus-types.h>
0032 #include <dbus/dbus-errors.h>
0033
0034 DBUS_BEGIN_DECLS
0035
0036 /**
0037  * @addtogroup DBusSignature
0038  * @{
0039  */
0040
0041 /**
0042  * DBusSignatureIter struct; contains no public fields
0043  */
0044 typedef struct
0045 {
0046   void *dummy1;         /**< Don't use this */
0047   void *dummy2;         /**< Don't use this */
0048   dbus_uint32_t dummy8; /**< Don't use this */
0049   int dummy12;           /**< Don't use this */
0050   int dummy17;           /**< Don't use this */
0051 } DBusSignatureIter;
0052
0053 DBUS_EXPORT
0054 void            dbus_signature_iter_init             (DBusSignatureIter       *iter,
0055                               const char              *signature);
0056
0057 DBUS_EXPORT
0058 int             dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);
0059
0060 DBUS_EXPORT
0061 char *          dbus_signature_iter_get_signature    (const DBusSignatureIter *iter);
0062
0063 DBUS_EXPORT
0064 int             dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);
0065
0066 DBUS_EXPORT
0067 dbus_bool_t     dbus_signature_iter_next             (DBusSignatureIter       *iter);
0068
0069 DBUS_EXPORT
0070 void            dbus_signature_iter_recurse          (const DBusSignatureIter *iter,
0071                               DBusSignatureIter       *subiter);
0072
0073 DBUS_EXPORT
0074 dbus_bool_t     dbus_signature_validate              (const char       *signature,
0075                               DBusError        *error);
0076
0077 DBUS_EXPORT
0078 dbus_bool_t     dbus_signature_validate_single       (const char       *signature,
0079                               DBusError        *error);
0080
0081 DBUS_EXPORT
0082 dbus_bool_t     dbus_type_is_valid                   (int            typecode);
0083
0084 DBUS_EXPORT
0085 dbus_bool_t     dbus_type_is_basic                   (int            typecode);
0086 DBUS_EXPORT
0087 dbus_bool_t     dbus_type_is_container               (int            typecode);
0088 DBUS_EXPORT
0089 dbus_bool_t     dbus_type_is_fixed                   (int            typecode);
0090
0091 /** @} */
0092
0093 DBUS_END_DECLS
0094
0095 #endif /* DBUS_SIGNATURE_H */