epoc32/include/stdapis/dbus-1.0/dbus/dbus-signature.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
/* -*- mode: C; c-file-style: "gnu" -*- */
williamr@2
     2
/* dbus-signatures.h utility functions for D-Bus types
williamr@2
     3
 *
williamr@2
     4
 * Copyright (C) 2005 Red Hat Inc.
williamr@2
     5
 * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
williamr@2
     6
 * Licensed under the Academic Free License version 2.1
williamr@2
     7
 * 
williamr@2
     8
 * This program is free software; you can redistribute it and/or modify
williamr@2
     9
 * it under the terms of the GNU General Public License as published by
williamr@2
    10
 * the Free Software Foundation; either version 2 of the License, or
williamr@2
    11
 * (at your option) any later version.
williamr@2
    12
 *
williamr@2
    13
 * This program is distributed in the hope that it will be useful,
williamr@2
    14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2
    15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
williamr@2
    16
 * GNU General Public License for more details.
williamr@2
    17
 * 
williamr@2
    18
 * You should have received a copy of the GNU General Public License
williamr@2
    19
 * along with this program; if not, write to the Free Software
williamr@2
    20
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
williamr@2
    21
 *
williamr@2
    22
 */
williamr@2
    23
#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
williamr@2
    24
#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
williamr@2
    25
#endif
williamr@2
    26
williamr@2
    27
#ifndef DBUS_SIGNATURES_H
williamr@2
    28
#define DBUS_SIGNATURES_H
williamr@2
    29
williamr@2
    30
#include <dbus/dbus-macros.h>
williamr@2
    31
#include <dbus/dbus-types.h>
williamr@2
    32
#include <dbus/dbus-errors.h>
williamr@2
    33
williamr@2
    34
DBUS_BEGIN_DECLS
williamr@2
    35
williamr@2
    36
/**
williamr@2
    37
 * @addtogroup DBusSignature
williamr@2
    38
 * @{
williamr@2
    39
 */
williamr@2
    40
williamr@2
    41
/**
williamr@2
    42
 * DBusSignatureIter struct; contains no public fields 
williamr@2
    43
 */
williamr@2
    44
typedef struct
williamr@2
    45
{ 
williamr@2
    46
  void *dummy1;         /**< Don't use this */
williamr@2
    47
  void *dummy2;         /**< Don't use this */
williamr@2
    48
  dbus_uint32_t dummy8; /**< Don't use this */
williamr@2
    49
  int dummy12;           /**< Don't use this */
williamr@2
    50
  int dummy17;           /**< Don't use this */
williamr@2
    51
} DBusSignatureIter;
williamr@2
    52
williamr@2
    53
#ifdef __SYMBIAN32__
williamr@2
    54
IMPORT_C
williamr@2
    55
#endif
williamr@2
    56
void            dbus_signature_iter_init             (DBusSignatureIter       *iter,
williamr@2
    57
						      const char              *signature);
williamr@2
    58
williamr@2
    59
#ifdef __SYMBIAN32__
williamr@2
    60
IMPORT_C
williamr@2
    61
#endif
williamr@2
    62
int             dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);
williamr@2
    63
williamr@2
    64
#ifdef __SYMBIAN32__
williamr@2
    65
IMPORT_C
williamr@2
    66
#endif
williamr@2
    67
char *          dbus_signature_iter_get_signature    (const DBusSignatureIter *iter);
williamr@2
    68
williamr@2
    69
#ifdef __SYMBIAN32__
williamr@2
    70
IMPORT_C
williamr@2
    71
#endif
williamr@2
    72
int             dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);
williamr@2
    73
williamr@2
    74
#ifdef __SYMBIAN32__
williamr@2
    75
IMPORT_C
williamr@2
    76
#endif
williamr@2
    77
dbus_bool_t     dbus_signature_iter_next             (DBusSignatureIter       *iter);
williamr@2
    78
williamr@2
    79
#ifdef __SYMBIAN32__
williamr@2
    80
IMPORT_C
williamr@2
    81
#endif
williamr@2
    82
void            dbus_signature_iter_recurse          (const DBusSignatureIter *iter,
williamr@2
    83
						      DBusSignatureIter       *subiter);
williamr@2
    84
williamr@2
    85
#ifdef __SYMBIAN32__
williamr@2
    86
IMPORT_C
williamr@2
    87
#endif
williamr@2
    88
dbus_bool_t     dbus_signature_validate              (const char       *signature,
williamr@2
    89
						      DBusError        *error);
williamr@2
    90
williamr@2
    91
#ifdef __SYMBIAN32__
williamr@2
    92
IMPORT_C
williamr@2
    93
#endif
williamr@2
    94
dbus_bool_t     dbus_signature_validate_single       (const char       *signature,
williamr@2
    95
						      DBusError        *error);
williamr@2
    96
williamr@2
    97
#ifdef __SYMBIAN32__
williamr@2
    98
IMPORT_C
williamr@2
    99
#endif
williamr@2
   100
dbus_bool_t     dbus_type_is_basic                   (int            typecode);
williamr@2
   101
#ifdef __SYMBIAN32__
williamr@2
   102
IMPORT_C
williamr@2
   103
#endif
williamr@2
   104
dbus_bool_t     dbus_type_is_container               (int            typecode);
williamr@2
   105
#ifdef __SYMBIAN32__
williamr@2
   106
IMPORT_C
williamr@2
   107
#endif
williamr@2
   108
dbus_bool_t     dbus_type_is_fixed                   (int            typecode);
williamr@2
   109
williamr@2
   110
/** @} */
williamr@2
   111
williamr@2
   112
DBUS_END_DECLS
williamr@2
   113
williamr@2
   114
#endif /* DBUS_SIGNATURE_H */