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