1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-marshal-basic.h Marshalling routines for basic (primitive) types
4 * Copyright (C) 2002 CodeFactory AB
5 * Copyright (C) 2004, 2005 Red Hat, Inc.
7 * Licensed under the Academic Free License version 2.1
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #ifndef DBUS_MARSHAL_BASIC_H
26 #define DBUS_MARSHAL_BASIC_H
30 #ifdef HAVE_BYTESWAP_H
34 #include <dbus/dbus-protocol.h>
35 #include <dbus/dbus-types.h>
36 #include <dbus/dbus-arch-deps.h>
37 #include <dbus/dbus-string.h>
39 #ifdef WORDS_BIGENDIAN
40 #define DBUS_COMPILER_BYTE_ORDER DBUS_BIG_ENDIAN
42 #define DBUS_COMPILER_BYTE_ORDER DBUS_LITTLE_ENDIAN
45 #ifdef HAVE_BYTESWAP_H
46 #define DBUS_UINT16_SWAP_LE_BE_CONSTANT(val) bswap_16(val)
47 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val) bswap_32(val)
48 #else /* HAVE_BYTESWAP_H */
50 #define DBUS_UINT16_SWAP_LE_BE_CONSTANT(val) ((dbus_uint16_t) ( \
51 (dbus_uint16_t) ((dbus_uint16_t) (val) >> 8) | \
52 (dbus_uint16_t) ((dbus_uint16_t) (val) << 8)))
54 #define DBUS_UINT32_SWAP_LE_BE_CONSTANT(val) ((dbus_uint32_t) ( \
55 (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x000000ffU) << 24) | \
56 (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x0000ff00U) << 8) | \
57 (((dbus_uint32_t) (val) & (dbus_uint32_t) 0x00ff0000U) >> 8) | \
58 (((dbus_uint32_t) (val) & (dbus_uint32_t) 0xff000000U) >> 24)))
60 #endif /* HAVE_BYTESWAP_H */
62 #ifdef DBUS_HAVE_INT64
64 #ifdef HAVE_BYTESWAP_H
65 #define DBUS_UINT64_SWAP_LE_BE_CONSTANT(val) bswap_64(val)
66 #else /* HAVE_BYTESWAP_H */
68 #define DBUS_UINT64_SWAP_LE_BE_CONSTANT(val) ((dbus_uint64_t) ( \
69 (((dbus_uint64_t) (val) & \
70 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00000000000000ff)) << 56) | \
71 (((dbus_uint64_t) (val) & \
72 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x000000000000ff00)) << 40) | \
73 (((dbus_uint64_t) (val) & \
74 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x0000000000ff0000)) << 24) | \
75 (((dbus_uint64_t) (val) & \
76 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00000000ff000000)) << 8) | \
77 (((dbus_uint64_t) (val) & \
78 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x000000ff00000000)) >> 8) | \
79 (((dbus_uint64_t) (val) & \
80 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x0000ff0000000000)) >> 24) | \
81 (((dbus_uint64_t) (val) & \
82 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0x00ff000000000000)) >> 40) | \
83 (((dbus_uint64_t) (val) & \
84 (dbus_uint64_t) DBUS_UINT64_CONSTANT (0xff00000000000000)) >> 56)))
85 #endif /* DBUS_HAVE_INT64 */
87 #endif /* HAVE_BYTESWAP_H */
89 #define DBUS_UINT16_SWAP_LE_BE(val) (DBUS_UINT16_SWAP_LE_BE_CONSTANT (val))
90 #define DBUS_INT16_SWAP_LE_BE(val) ((dbus_int16_t)DBUS_UINT16_SWAP_LE_BE_CONSTANT (val))
92 #define DBUS_UINT32_SWAP_LE_BE(val) (DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
93 #define DBUS_INT32_SWAP_LE_BE(val) ((dbus_int32_t)DBUS_UINT32_SWAP_LE_BE_CONSTANT (val))
95 #ifdef DBUS_HAVE_INT64
96 # define DBUS_UINT64_SWAP_LE_BE(val) (DBUS_UINT64_SWAP_LE_BE_CONSTANT (val))
97 # define DBUS_INT64_SWAP_LE_BE(val) ((dbus_int64_t)DBUS_UINT64_SWAP_LE_BE_CONSTANT (val))
98 #endif /* DBUS_HAVE_INT64 */
100 #ifdef WORDS_BIGENDIAN
102 # define DBUS_INT16_TO_BE(val) ((dbus_int16_t) (val))
103 # define DBUS_UINT16_TO_BE(val) ((dbus_uint16_t) (val))
104 # define DBUS_INT16_TO_LE(val) (DBUS_INT16_SWAP_LE_BE (val))
105 # define DBUS_UINT16_TO_LE(val) (DBUS_UINT16_SWAP_LE_BE (val))
106 # define DBUS_INT32_TO_BE(val) ((dbus_int32_t) (val))
107 # define DBUS_UINT32_TO_BE(val) ((dbus_uint32_t) (val))
108 # define DBUS_INT32_TO_LE(val) (DBUS_INT32_SWAP_LE_BE (val))
109 # define DBUS_UINT32_TO_LE(val) (DBUS_UINT32_SWAP_LE_BE (val))
110 # ifdef DBUS_HAVE_INT64
111 # define DBUS_INT64_TO_BE(val) ((dbus_int64_t) (val))
112 # define DBUS_UINT64_TO_BE(val) ((dbus_uint64_t) (val))
113 # define DBUS_INT64_TO_LE(val) (DBUS_INT64_SWAP_LE_BE (val))
114 # define DBUS_UINT64_TO_LE(val) (DBUS_UINT64_SWAP_LE_BE (val))
115 # endif /* DBUS_HAVE_INT64 */
117 #else /* WORDS_BIGENDIAN */
119 # define DBUS_INT16_TO_LE(val) ((dbus_int16_t) (val))
120 # define DBUS_UINT16_TO_LE(val) ((dbus_uint16_t) (val))
121 # define DBUS_INT16_TO_BE(val) ((dbus_int16_t) DBUS_UINT16_SWAP_LE_BE (val))
122 # define DBUS_UINT16_TO_BE(val) (DBUS_UINT16_SWAP_LE_BE (val))
123 # define DBUS_INT32_TO_LE(val) ((dbus_int32_t) (val))
124 # define DBUS_UINT32_TO_LE(val) ((dbus_uint32_t) (val))
125 # define DBUS_INT32_TO_BE(val) ((dbus_int32_t) DBUS_UINT32_SWAP_LE_BE (val))
126 # define DBUS_UINT32_TO_BE(val) (DBUS_UINT32_SWAP_LE_BE (val))
127 # ifdef DBUS_HAVE_INT64
128 # define DBUS_INT64_TO_LE(val) ((dbus_int64_t) (val))
129 # define DBUS_UINT64_TO_LE(val) ((dbus_uint64_t) (val))
130 # define DBUS_INT64_TO_BE(val) ((dbus_int64_t) DBUS_UINT64_SWAP_LE_BE (val))
131 # define DBUS_UINT64_TO_BE(val) (DBUS_UINT64_SWAP_LE_BE (val))
132 # endif /* DBUS_HAVE_INT64 */
135 /* The transformation is symmetric, so the FROM just maps to the TO. */
136 #define DBUS_INT16_FROM_LE(val) (DBUS_INT16_TO_LE (val))
137 #define DBUS_UINT16_FROM_LE(val) (DBUS_UINT16_TO_LE (val))
138 #define DBUS_INT16_FROM_BE(val) (DBUS_INT16_TO_BE (val))
139 #define DBUS_UINT16_FROM_BE(val) (DBUS_UINT16_TO_BE (val))
140 #define DBUS_INT32_FROM_LE(val) (DBUS_INT32_TO_LE (val))
141 #define DBUS_UINT32_FROM_LE(val) (DBUS_UINT32_TO_LE (val))
142 #define DBUS_INT32_FROM_BE(val) (DBUS_INT32_TO_BE (val))
143 #define DBUS_UINT32_FROM_BE(val) (DBUS_UINT32_TO_BE (val))
144 #ifdef DBUS_HAVE_INT64
145 # define DBUS_INT64_FROM_LE(val) (DBUS_INT64_TO_LE (val))
146 # define DBUS_UINT64_FROM_LE(val) (DBUS_UINT64_TO_LE (val))
147 # define DBUS_INT64_FROM_BE(val) (DBUS_INT64_TO_BE (val))
148 # define DBUS_UINT64_FROM_BE(val) (DBUS_UINT64_TO_BE (val))
149 #endif /* DBUS_HAVE_INT64 */
151 #ifndef DBUS_HAVE_INT64
153 * An 8-byte struct you could use to access int64 without having
158 dbus_uint32_t first32; /**< first 32 bits in the 8 bytes (beware endian issues) */
159 dbus_uint32_t second32; /**< second 32 bits in the 8 bytes (beware endian issues) */
161 #endif /* DBUS_HAVE_INT64 */
164 * A simple 8-byte value union that lets you access 8 bytes as if they
165 * were various types; useful when dealing with basic types via
166 * void pointers and varargs.
170 dbus_int16_t i16; /**< as int16 */
171 dbus_uint16_t u16; /**< as int16 */
172 dbus_int32_t i32; /**< as int32 */
173 dbus_uint32_t u32; /**< as int32 */
174 #ifdef DBUS_HAVE_INT64
175 dbus_int64_t i64; /**< as int64 */
176 dbus_uint64_t u64; /**< as int64 */
178 DBus8ByteStruct u64; /**< as 8-byte-struct */
180 double dbl; /**< as double */
181 unsigned char byt; /**< as byte */
182 char *str; /**< as char* */
185 #ifdef DBUS_DISABLE_ASSERT
186 #define _dbus_unpack_uint16(byte_order, data) \
187 (((byte_order) == DBUS_LITTLE_ENDIAN) ? \
188 DBUS_UINT16_FROM_LE (*(dbus_uint16_t*)(data)) : \
189 DBUS_UINT16_FROM_BE (*(dbus_uint16_t*)(data)))
191 #define _dbus_unpack_uint32(byte_order, data) \
192 (((byte_order) == DBUS_LITTLE_ENDIAN) ? \
193 DBUS_UINT32_FROM_LE (*(dbus_uint32_t*)(data)) : \
194 DBUS_UINT32_FROM_BE (*(dbus_uint32_t*)(data)))
197 #ifndef _dbus_unpack_uint16
198 dbus_uint16_t _dbus_unpack_uint16 (int byte_order,
199 const unsigned char *data);
202 void _dbus_pack_uint32 (dbus_uint32_t value,
204 unsigned char *data);
205 #ifndef _dbus_unpack_uint32
206 dbus_uint32_t _dbus_unpack_uint32 (int byte_order,
207 const unsigned char *data);
210 dbus_bool_t _dbus_marshal_set_basic (DBusString *str,
217 dbus_bool_t _dbus_marshal_write_basic (DBusString *str,
223 dbus_bool_t _dbus_marshal_write_fixed_multi (DBusString *str,
230 void _dbus_marshal_read_basic (const DBusString *str,
236 void _dbus_marshal_read_fixed_multi (const DBusString *str,
243 void _dbus_marshal_skip_basic (const DBusString *str,
247 void _dbus_marshal_skip_array (const DBusString *str,
251 void _dbus_marshal_set_uint32 (DBusString *str,
255 dbus_uint32_t _dbus_marshal_read_uint32 (const DBusString *str,
259 dbus_bool_t _dbus_type_is_valid (int typecode);
260 int _dbus_type_get_alignment (int typecode);
261 dbus_bool_t _dbus_type_is_fixed (int typecode);
262 int _dbus_type_get_alignment (int typecode);
263 const char* _dbus_type_to_string (int typecode);
265 int _dbus_first_type_in_signature (const DBusString *str,
268 int _dbus_first_type_in_signature_c_str (const char *str,
271 void _dbus_swap_array (unsigned char *data,
275 #endif /* DBUS_MARSHAL_BASIC_H */