1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-types.h types such as dbus_bool_t
3 *
4 * Copyright (C) 2002 Red Hat Inc.
5 *
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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_TYPES_H
28#define DBUS_TYPES_H
29
30#include <stddef.h>
31#include <dbus/dbus-arch-deps.h>
32
33typedef dbus_uint32_t dbus_unichar_t;
34/* boolean size must be fixed at 4 bytes due to wire protocol! */
35typedef dbus_uint32_t dbus_bool_t;
36
37/* Normally docs are in .c files, but there isn't a .c file for this. */
38/**
39 * @defgroup DBusTypes Basic types
40 * @ingroup DBus
41 * @brief dbus_bool_t, dbus_int32_t, etc.
42 *
43 * Typedefs for common primitive types.
44 *
45 * @{
46 */
47
48/**
49 * @typedef dbus_bool_t
50 *
51 * A boolean, valid values are #TRUE and #FALSE.
52 */
53
54/**
55 * @typedef dbus_uint32_t
56 *
57 * A 32-bit unsigned integer on all platforms.
58 */
59
60/**
61 * @typedef dbus_int32_t
62 *
63 * A 32-bit signed integer on all platforms.
64 */
65
66/**
67 * @typedef dbus_uint16_t
68 *
69 * A 16-bit unsigned integer on all platforms.
70 */
71
72/**
73 * @typedef dbus_int16_t
74 *
75 * A 16-bit signed integer on all platforms.
76 */
77
78
79/**
80 * @typedef dbus_uint64_t
81 *
82 * A 64-bit unsigned integer.
83 */
84
85/**
86 * @typedef dbus_int64_t
87 *
88 * A 64-bit signed integer.
89 */
90
91/**
92 * @def DBUS_HAVE_INT64
93 *
94 * Always defined.
95 *
96 * In older libdbus versions, this would be undefined if there was no
97 * 64-bit integer type on that platform. libdbus no longer supports
98 * such platforms.
99 */
100
101/**
102 * @def DBUS_INT64_CONSTANT
103 *
104 * Declare a 64-bit signed integer constant. The macro
105 * adds the necessary "LL" or whatever after the integer,
106 * giving a literal such as "325145246765LL"
107 */
108
109/**
110 * @def DBUS_UINT64_CONSTANT
111 *
112 * Declare a 64-bit unsigned integer constant. The macro
113 * adds the necessary "ULL" or whatever after the integer,
114 * giving a literal such as "325145246765ULL"
115 */
116
117/**
118 * An 8-byte struct you could use to access int64 without having
119 * int64 support. Use #dbus_int64_t or #dbus_uint64_t instead.
120 */
121typedef struct
122{
123 dbus_uint32_t first32; /**< first 32 bits in the 8 bytes (beware endian issues) */
124 dbus_uint32_t second32; /**< second 32 bits in the 8 bytes (beware endian issues) */
125} DBus8ByteStruct;
126
127/**
128 * A simple value union that lets you access bytes as if they
129 * were various types; useful when dealing with basic types via
130 * void pointers and varargs.
131 *
132 * This union also contains a pointer member (which can be used
133 * to retrieve a string from dbus_message_iter_get_basic(), for
134 * instance), so on future platforms it could conceivably be larger
135 * than 8 bytes.
136 */
137typedef union
138{
139 unsigned char bytes[8]; /**< as 8 individual bytes */
140 dbus_int16_t i16; /**< as int16 */
141 dbus_uint16_t u16; /**< as int16 */
142 dbus_int32_t i32; /**< as int32 */
143 dbus_uint32_t u32; /**< as int32 */
144 dbus_bool_t bool_val; /**< as boolean */
145 dbus_int64_t i64; /**< as int64 */
146 dbus_uint64_t u64; /**< as int64 */
147 DBus8ByteStruct eight; /**< as 8-byte struct */
148 double dbl; /**< as double */
149 unsigned char byt; /**< as byte */
150 char *str; /**< as char* (string, object path or signature) */
151 int fd; /**< as Unix file descriptor */
152} DBusBasicValue;
153
154/** @} */
155
156#endif /* DBUS_TYPES_H */
157