dbus/dbus-marshal.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-marshal.h  Marshalling routines
   3  *
   4  * Copyright (C) 2002  CodeFactory AB
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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
  24 #ifndef DBUS_MARSHAL_H
  25 #define DBUS_MARSHAL_H
  26
  27 #include <config.h>
  28 #include <dbus/dbus-protocol.h>
  29 #include <dbus/dbus-types.h>
  30 #include <dbus/dbus-string.h>
  31
  32 #ifndef PACKAGE
  33 #error "config.h not included here"
  34 #endif
  35
  36 #ifdef WORDS_BIGENDIAN
  37 #define DBUS_COMPILER_BYTE_ORDER DBUS_BIG_ENDIAN
  38 #else
  39 #define DBUS_COMPILER_BYTE_ORDER DBUS_LITTLE_ENDIAN
  40 #endif
  41
  42 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val)    ((dbus_uint32_t) ( \
  43     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x000000ffU) << 24) |  \
  44     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x0000ff00U) <<  8) |  \
  45     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x00ff0000U) >>  8) |  \
  46     (((dbus_uint32_t) (val) & (dbus_uint32_t) 0xff000000U) >> 24)))
  47
  48 #define DBUS_UINT32_SWAP_LE_BE(val) (DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
  49
  50 #ifdef WORDS_BIGENDIAN
  51 #define DBUS_INT32_TO_BE(val)   ((dbus_int32_t) (val))
  52 #define DBUS_UINT32_TO_BE(val)  ((dbus_uint32_t) (val))
  53 #define DBUS_INT32_TO_LE(val)   ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
  54 #define DBUS_UINT32_TO_LE(val)  (DBUS_UINT32_SWAP_LE_BE (val))
  55 #else
  56 #define DBUS_INT32_TO_LE(val)   ((dbus_int32_t) (val))
  57 #define DBUS_UINT32_TO_LE(val)  ((dbus_uint32_t) (val))
  58 #define DBUS_INT32_TO_BE(val)   ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
  59 #define DBUS_UINT32_TO_BE(val)  (DBUS_UINT32_SWAP_LE_BE (val))
  60 #endif
  61
  62 /* The transformation is symmetric, so the FROM just maps to the TO. */
  63 #define DBUS_INT32_FROM_LE(val)  (DBUS_INT32_TO_LE (val))
  64 #define DBUS_UINT32_FROM_LE(val) (DBUS_UINT32_TO_LE (val))
  65 #define DBUS_INT32_FROM_BE(val)  (DBUS_INT32_TO_BE (val))
  66 #define DBUS_UINT32_FROM_BE(val) (DBUS_UINT32_TO_BE (val))
  67
  68 void          _dbus_pack_int32    (dbus_int32_t         value,
  69                                    int                  byte_order,
  70                                    unsigned char       *data);
  71 dbus_int32_t  _dbus_unpack_int32  (int                  byte_order,
  72                                    const unsigned char *data);
  73 void          _dbus_pack_uint32   (dbus_uint32_t        value,
  74                                    int                  byte_order,
  75                                    unsigned char       *data);
  76 dbus_uint32_t _dbus_unpack_uint32 (int                  byte_order,
  77                                    const unsigned char *data);
  78
  79
  80 dbus_bool_t _dbus_marshal_double     (DBusString          *str,
  81                                       int                  byte_order,
  82                                       double               value);
  83 dbus_bool_t _dbus_marshal_int32      (DBusString          *str,
  84                                       int                  byte_order,
  85                                       dbus_int32_t         value);
  86 dbus_bool_t _dbus_marshal_uint32     (DBusString          *str,
  87                                       int                  byte_order,
  88                                       dbus_uint32_t        value);
  89 dbus_bool_t _dbus_marshal_string     (DBusString          *str,
  90                                       int                  byte_order,
  91                                       const char          *value);
  92 dbus_bool_t _dbus_marshal_byte_array (DBusString          *str,
  93                                       int                  byte_order,
  94                                       const unsigned char *value,
  95                                       int                  len);
  96
  97 double         _dbus_demarshal_double     (DBusString *str,
  98                                            int         byte_order,
  99                                            int         pos,
 100                                            int        *new_pos);
 101 dbus_int32_t   _dbus_demarshal_int32      (DBusString *str,
 102                                            int         byte_order,
 103                                            int         pos,
 104                                            int        *new_pos);
 105 dbus_uint32_t  _dbus_demarshal_uint32     (DBusString *str,
 106                                            int         byte_order,
 107                                            int         pos,
 108                                            int        *new_pos);
 109 char *         _dbus_demarshal_string     (DBusString *str,
 110                                            int         byte_order,
 111                                            int         pos,
 112                                            int        *new_pos);
 113 unsigned char *_dbus_demarshal_byte_array (DBusString *str,
 114                                            int         byte_order,
 115                                            int         pos,
 116                                            int        *new_pos,
 117                                            int        *array_len);
 118
 119
 120 dbus_bool_t _dbus_marshal_get_field_end_pos (DBusString *str,
 121                                              int         byte_order,
 122                                              int         pos,
 123                                              int        *end_pos);
 124
 125
 126
 127
 128 #endif /* DBUS_PROTOCOL_H */