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
     1 /* -*- mode: C; c-file-style: "gnu" -*- */
     2 /* dbus-signatures.h utility functions for D-Bus types
     3  *
     4  * Copyright (C) 2005 Red Hat Inc.
     5  * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
     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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 
    34 DBUS_BEGIN_DECLS
    35 
    36 /**
    37  * @addtogroup DBusSignature
    38  * @{
    39  */
    40 
    41 /**
    42  * DBusSignatureIter struct; contains no public fields 
    43  */
    44 typedef 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 
    53 #ifdef __SYMBIAN32__
    54 IMPORT_C
    55 #endif
    56 void            dbus_signature_iter_init             (DBusSignatureIter       *iter,
    57 						      const char              *signature);
    58 
    59 #ifdef __SYMBIAN32__
    60 IMPORT_C
    61 #endif
    62 int             dbus_signature_iter_get_current_type (const DBusSignatureIter *iter);
    63 
    64 #ifdef __SYMBIAN32__
    65 IMPORT_C
    66 #endif
    67 char *          dbus_signature_iter_get_signature    (const DBusSignatureIter *iter);
    68 
    69 #ifdef __SYMBIAN32__
    70 IMPORT_C
    71 #endif
    72 int             dbus_signature_iter_get_element_type (const DBusSignatureIter *iter);
    73 
    74 #ifdef __SYMBIAN32__
    75 IMPORT_C
    76 #endif
    77 dbus_bool_t     dbus_signature_iter_next             (DBusSignatureIter       *iter);
    78 
    79 #ifdef __SYMBIAN32__
    80 IMPORT_C
    81 #endif
    82 void            dbus_signature_iter_recurse          (const DBusSignatureIter *iter,
    83 						      DBusSignatureIter       *subiter);
    84 
    85 #ifdef __SYMBIAN32__
    86 IMPORT_C
    87 #endif
    88 dbus_bool_t     dbus_signature_validate              (const char       *signature,
    89 						      DBusError        *error);
    90 
    91 #ifdef __SYMBIAN32__
    92 IMPORT_C
    93 #endif
    94 dbus_bool_t     dbus_signature_validate_single       (const char       *signature,
    95 						      DBusError        *error);
    96 
    97 #ifdef __SYMBIAN32__
    98 IMPORT_C
    99 #endif
   100 dbus_bool_t     dbus_type_is_basic                   (int            typecode);
   101 #ifdef __SYMBIAN32__
   102 IMPORT_C
   103 #endif
   104 dbus_bool_t     dbus_type_is_container               (int            typecode);
   105 #ifdef __SYMBIAN32__
   106 IMPORT_C
   107 #endif
   108 dbus_bool_t     dbus_type_is_fixed                   (int            typecode);
   109 
   110 /** @} */
   111 
   112 DBUS_END_DECLS
   113 
   114 #endif /* DBUS_SIGNATURE_H */