1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.c DBusMessage object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
5 * Copyright (C) 2002, 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-internals.h"
26 #include "dbus-marshal.h"
27 #include "dbus-message.h"
28 #include "dbus-message-internal.h"
29 #include "dbus-memory.h"
30 #include "dbus-list.h"
31 #include "dbus-message-builder.h"
32 #include "dbus-dataslot.h"
36 * @defgroup DBusMessageInternals DBusMessage implementation details
37 * @ingroup DBusInternals
38 * @brief DBusMessage private implementation details.
40 * The guts of DBusMessage and its methods.
58 static dbus_bool_t field_is_named[FIELD_LAST] =
60 FALSE, /* FIELD_HEADER_LENGTH */
61 FALSE, /* FIELD_BODY_LENGTH */
62 FALSE, /* FIELD_CLIENT_SERIAL */
63 TRUE, /* FIELD_NAME */
64 TRUE, /* FIELD_SERVICE */
65 TRUE, /* FIELD_SENDER */
66 TRUE /* FIELD_REPLY_SERIAL */
71 int offset; /**< Offset to start of field (location of name of field
77 * @brief Internals of DBusMessage
79 * Object representing a message received from or to be sent to
80 * another application. This is an opaque object, all members
85 DBusAtomic refcount; /**< Reference count */
87 DBusString header; /**< Header network data, stored
88 * separately from body so we can
89 * independently realloc it.
92 HeaderField header_fields[FIELD_LAST]; /**< Track the location
93 * of each field in "header"
96 dbus_uint32_t client_serial; /**< Cached client serial value for speed */
97 dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
99 int header_padding; /**< bytes of alignment in header */
101 DBusString body; /**< Body network data. */
103 char byte_order; /**< Message byte order. */
105 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
106 long size_counter_delta; /**< Size we incremented the size counters by. */
108 dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
110 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
112 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
116 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
117 DBUS_MESSAGE_ITER_TYPE_ARRAY,
118 DBUS_MESSAGE_ITER_TYPE_DICT
121 /** typedef for internals of message iterator */
122 typedef struct DBusMessageRealIter DBusMessageRealIter;
125 * @brief Internals of DBusMessageIter
127 * Object representing a position in a message. All fields are internal.
129 struct DBusMessageRealIter
131 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
132 DBusMessage *message; /**< Message used */
133 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
135 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
136 int type; /**< type of iter */
138 int pos; /**< Current position in the string */
139 int end; /**< position right after the container */
140 int container_start; /**< offset of the start of the container */
141 int container_length_pos; /**< offset of the length of the container */
143 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
145 int array_type_pos; /**< pointer to the position of the array element type */
146 int array_type_done; /**< TRUE if the array type is fully finished */
150 * Gets the data to be sent over the network for this message.
151 * The header and then the body should be written out.
152 * This function is guaranteed to always return the same
153 * data once a message is locked (with _dbus_message_lock()).
155 * @param message the message.
156 * @param header return location for message header data.
157 * @param body return location for message body data.
160 _dbus_message_get_network_data (DBusMessage *message,
161 const DBusString **header,
162 const DBusString **body)
164 _dbus_assert (message->locked);
166 *header = &message->header;
167 *body = &message->body;
171 clear_header_padding (DBusMessage *message)
173 _dbus_string_shorten (&message->header,
174 message->header_padding);
175 message->header_padding = 0;
179 append_header_padding (DBusMessage *message)
182 old_len = _dbus_string_get_length (&message->header);
183 if (!_dbus_string_align_length (&message->header, 8))
186 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
192 adjust_field_offsets (DBusMessage *message,
202 while (i < FIELD_LAST)
204 if (message->header_fields[i].offset > offsets_after)
205 message->header_fields[i].offset += delta;
211 #ifdef DBUS_BUILD_TESTS
212 /* tests-only until it's actually used */
214 get_int_field (DBusMessage *message,
219 _dbus_assert (field < FIELD_LAST);
221 offset = message->header_fields[field].offset;
224 return -1; /* useless if -1 is a valid value of course */
226 return _dbus_demarshal_int32 (&message->header,
234 get_uint_field (DBusMessage *message,
239 _dbus_assert (field < FIELD_LAST);
241 offset = message->header_fields[field].offset;
244 return -1; /* useless if -1 is a valid value of course */
246 return _dbus_demarshal_uint32 (&message->header,
253 get_string_field (DBusMessage *message,
260 offset = message->header_fields[field].offset;
262 _dbus_assert (field < FIELD_LAST);
267 /* offset points to string length, string data follows it */
268 /* FIXME _dbus_demarshal_const_string() that returned
269 * a reference to the string plus its len might be nice.
273 *len = _dbus_demarshal_uint32 (&message->header,
278 data = _dbus_string_get_const_data (&message->header);
280 return data + (offset + 4);
283 #ifdef DBUS_BUILD_TESTS
285 append_int_field (DBusMessage *message,
292 _dbus_assert (!message->locked);
294 clear_header_padding (message);
296 orig_len = _dbus_string_get_length (&message->header);
298 if (!_dbus_string_align_length (&message->header, 4))
301 if (!_dbus_string_append_len (&message->header, name, 4))
304 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
307 if (!_dbus_string_align_length (&message->header, 4))
310 message->header_fields[FIELD_REPLY_SERIAL].offset =
311 _dbus_string_get_length (&message->header);
313 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
317 if (!append_header_padding (message))
323 message->header_fields[field].offset = -1;
324 _dbus_string_set_length (&message->header, orig_len);
326 /* this must succeed because it was allocated on function entry and
327 * DBusString doesn't ever realloc smaller
329 if (!append_header_padding (message))
330 _dbus_assert_not_reached ("failed to reappend header padding");
336 append_uint_field (DBusMessage *message,
343 _dbus_assert (!message->locked);
345 clear_header_padding (message);
347 orig_len = _dbus_string_get_length (&message->header);
349 if (!_dbus_string_align_length (&message->header, 4))
352 if (!_dbus_string_append_len (&message->header, name, 4))
355 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
358 if (!_dbus_string_align_length (&message->header, 4))
361 message->header_fields[FIELD_REPLY_SERIAL].offset =
362 _dbus_string_get_length (&message->header);
364 if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
368 if (!append_header_padding (message))
374 message->header_fields[field].offset = -1;
375 _dbus_string_set_length (&message->header, orig_len);
377 /* this must succeed because it was allocated on function entry and
378 * DBusString doesn't ever realloc smaller
380 if (!append_header_padding (message))
381 _dbus_assert_not_reached ("failed to reappend header padding");
386 append_string_field (DBusMessage *message,
393 _dbus_assert (!message->locked);
395 clear_header_padding (message);
397 orig_len = _dbus_string_get_length (&message->header);
399 if (!_dbus_string_align_length (&message->header, 4))
402 if (!_dbus_string_append_len (&message->header, name, 4))
405 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
408 if (!_dbus_string_align_length (&message->header, 4))
411 message->header_fields[field].offset =
412 _dbus_string_get_length (&message->header);
414 if (!_dbus_marshal_string (&message->header, message->byte_order,
418 if (!append_header_padding (message))
424 message->header_fields[field].offset = -1;
425 _dbus_string_set_length (&message->header, orig_len);
427 /* this must succeed because it was allocated on function entry and
428 * DBusString doesn't ever realloc smaller
430 if (!append_header_padding (message))
431 _dbus_assert_not_reached ("failed to reappend header padding");
436 #ifdef DBUS_BUILD_TESTS
437 /* This isn't used, but building it when tests are enabled just to
438 * keep it compiling if we need it in future
441 delete_int_or_uint_field (DBusMessage *message,
444 int offset = message->header_fields[field].offset;
446 _dbus_assert (!message->locked);
447 _dbus_assert (field_is_named[field]);
452 clear_header_padding (message);
454 /* The field typecode and name take up 8 bytes */
455 _dbus_string_delete (&message->header,
459 message->header_fields[field].offset = -1;
461 adjust_field_offsets (message,
465 append_header_padding (message);
470 delete_string_field (DBusMessage *message,
473 int offset = message->header_fields[field].offset;
477 _dbus_assert (!message->locked);
478 _dbus_assert (field_is_named[field]);
483 clear_header_padding (message);
485 get_string_field (message, field, &len);
487 /* The field typecode and name take up 8 bytes, and the nul
488 * termination is 1 bytes, string length integer is 4 bytes
490 delete_len = 8 + 4 + 1 + len;
492 _dbus_string_delete (&message->header,
496 message->header_fields[field].offset = -1;
498 adjust_field_offsets (message,
502 append_header_padding (message);
505 #ifdef DBUS_BUILD_TESTS
507 set_int_field (DBusMessage *message,
511 int offset = message->header_fields[field].offset;
513 _dbus_assert (!message->locked);
517 /* need to append the field */
522 _dbus_assert_not_reached ("appending an int field we don't support appending");
528 _dbus_marshal_set_int32 (&message->header,
538 set_uint_field (DBusMessage *message,
542 int offset = message->header_fields[field].offset;
544 _dbus_assert (!message->locked);
548 /* need to append the field */
552 case FIELD_REPLY_SERIAL:
553 return append_uint_field (message, field,
554 DBUS_HEADER_FIELD_REPLY,
557 _dbus_assert_not_reached ("appending a uint field we don't support appending");
563 _dbus_marshal_set_uint32 (&message->header,
572 set_string_field (DBusMessage *message,
576 int offset = message->header_fields[field].offset;
578 _dbus_assert (!message->locked);
579 _dbus_assert (value != NULL);
583 /* need to append the field */
588 return append_string_field (message, field,
589 DBUS_HEADER_FIELD_SENDER,
592 _dbus_assert_not_reached ("appending a string field we don't support appending");
603 clear_header_padding (message);
605 old_len = _dbus_string_get_length (&message->header);
607 len = strlen (value);
609 _dbus_string_init_const_len (&v, value,
610 len + 1); /* include nul */
611 if (!_dbus_marshal_set_string (&message->header,
617 new_len = _dbus_string_get_length (&message->header);
619 adjust_field_offsets (message,
623 if (!append_header_padding (message))
629 /* this must succeed because it was allocated on function entry and
630 * DBusString doesn't ever realloc smaller
632 if (!append_header_padding (message))
633 _dbus_assert_not_reached ("failed to reappend header padding");
640 * Sets the serial number of a message.
641 * This can only be done once on a message.
643 * @param message the message
644 * @param serial the serial
647 _dbus_message_set_serial (DBusMessage *message,
650 _dbus_assert (!message->locked);
651 _dbus_assert (dbus_message_get_serial (message) == 0);
653 set_uint_field (message, FIELD_CLIENT_SERIAL,
655 message->client_serial = serial;
659 * Sets the reply serial of a message (the client serial
660 * of the message this is a reply to).
662 * @param message the message
663 * @param reply_serial the client serial
664 * @returns #FALSE if not enough memory
667 dbus_message_set_reply_serial (DBusMessage *message,
668 dbus_uint32_t reply_serial)
670 _dbus_assert (!message->locked);
672 if (set_uint_field (message, FIELD_REPLY_SERIAL,
675 message->reply_serial = reply_serial;
683 * Returns the serial of a message or -1 if none has been specified.
684 * The message's serial number is provided by the application sending
685 * the message and is used to identify replies to this message.
687 * @param message the message
688 * @returns the client serial
691 dbus_message_get_serial (DBusMessage *message)
693 return message->client_serial;
697 * Returns the serial that the message is
698 * a reply to or 0 if none.
700 * @param message the message
701 * @returns the reply serial
704 dbus_message_get_reply_serial (DBusMessage *message)
706 return message->reply_serial;
710 * Adds a counter to be incremented immediately with the
711 * size of this message, and decremented by the size
712 * of this message when this message if finalized.
713 * The link contains a counter with its refcount already
714 * incremented, but the counter itself not incremented.
715 * Ownership of link and counter refcount is passed to
718 * @param message the message
719 * @param link link with counter as data
722 _dbus_message_add_size_counter_link (DBusMessage *message,
725 /* right now we don't recompute the delta when message
726 * size changes, and that's OK for current purposes
727 * I think, but could be important to change later.
728 * Do recompute it whenever there are no outstanding counters,
729 * since it's basically free.
731 if (message->size_counters == NULL)
733 message->size_counter_delta =
734 _dbus_string_get_length (&message->header) +
735 _dbus_string_get_length (&message->body);
738 _dbus_verbose ("message has size %ld\n",
739 message->size_counter_delta);
743 _dbus_list_append_link (&message->size_counters, link);
745 _dbus_counter_adjust (link->data, message->size_counter_delta);
749 * Adds a counter to be incremented immediately with the
750 * size of this message, and decremented by the size
751 * of this message when this message if finalized.
753 * @param message the message
754 * @param counter the counter
755 * @returns #FALSE if no memory
758 _dbus_message_add_size_counter (DBusMessage *message,
759 DBusCounter *counter)
763 link = _dbus_list_alloc_link (counter);
767 _dbus_counter_ref (counter);
768 _dbus_message_add_size_counter_link (message, link);
774 * Removes a counter tracking the size of this message, and decrements
775 * the counter by the size of this message.
777 * @param message the message
778 * @param link_return return the link used
779 * @param counter the counter
782 _dbus_message_remove_size_counter (DBusMessage *message,
783 DBusCounter *counter,
784 DBusList **link_return)
788 link = _dbus_list_find_last (&message->size_counters,
790 _dbus_assert (link != NULL);
792 _dbus_list_unlink (&message->size_counters,
797 _dbus_list_free_link (link);
799 _dbus_counter_adjust (counter, message->size_counter_delta);
801 _dbus_counter_unref (counter);
805 dbus_message_create_header (DBusMessage *message,
811 if (!_dbus_string_append_byte (&message->header, message->byte_order))
815 if (!_dbus_string_append_byte (&message->header, flags))
818 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
821 if (!_dbus_string_append_byte (&message->header, 0))
824 message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
825 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
828 message->header_fields[FIELD_BODY_LENGTH].offset = 8;
829 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
832 message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
833 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
836 /* Marshal message service */
839 if (!append_string_field (message,
841 DBUS_HEADER_FIELD_SERVICE,
846 _dbus_assert (name != NULL);
847 if (!append_string_field (message,
849 DBUS_HEADER_FIELD_NAME,
857 * Locks a message. Allows checking that applications don't keep a
858 * reference to a message in the outgoing queue and change it
859 * underneath us. Messages are locked when they enter the outgoing
860 * queue (dbus_connection_send_message()), and the library complains
861 * if the message is modified while locked.
863 * @param message the message to lock.
866 _dbus_message_lock (DBusMessage *message)
868 if (!message->locked)
870 /* Fill in our lengths */
871 set_uint_field (message,
873 _dbus_string_get_length (&message->header));
875 set_uint_field (message,
877 _dbus_string_get_length (&message->body));
879 message->locked = TRUE;
886 * @defgroup DBusMessage DBusMessage
888 * @brief Message to be sent or received over a DBusConnection.
890 * A DBusMessage is the most basic unit of communication over a
891 * DBusConnection. A DBusConnection represents a stream of messages
892 * received from a remote application, and a stream of messages
893 * sent to a remote application.
899 * @typedef DBusMessage
901 * Opaque data type representing a message received from or to be
902 * sent to another application.
906 dbus_message_new_empty_header (void)
908 DBusMessage *message;
911 message = dbus_new0 (DBusMessage, 1);
915 message->refcount.value = 1;
916 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
917 message->client_serial = 0;
918 message->reply_serial = 0;
920 _dbus_data_slot_list_init (&message->slot_list);
923 while (i < FIELD_LAST)
925 message->header_fields[i].offset = -1;
929 if (!_dbus_string_init_preallocated (&message->header, 64))
935 if (!_dbus_string_init_preallocated (&message->body, 64))
937 _dbus_string_free (&message->header);
947 * Constructs a new message. Returns #NULL if memory can't be
948 * allocated for the message. The service may be #NULL in which case
949 * no service is set; this is appropriate when using D-BUS in a
950 * peer-to-peer context (no message bus).
952 * @todo reverse the arguments, first 'name' then 'service'
953 * as 'name' is more fundamental
955 * @param name name of the message
956 * @param destination_service service that the message should be sent to or #NULL
957 * @returns a new DBusMessage, free with dbus_message_unref()
958 * @see dbus_message_unref()
961 dbus_message_new (const char *name,
962 const char *destination_service)
964 DBusMessage *message;
966 _dbus_return_val_if_fail (name != NULL, NULL);
968 message = dbus_message_new_empty_header ();
972 if (!dbus_message_create_header (message, name, destination_service))
974 dbus_message_unref (message);
982 * Constructs a message that is a reply to some other
983 * message. Returns #NULL if memory can't be allocated
986 * @param original_message the message which the created
987 * message is a reply to.
988 * @returns a new DBusMessage, free with dbus_message_unref()
989 * @see dbus_message_new(), dbus_message_unref()
992 dbus_message_new_reply (DBusMessage *original_message)
994 DBusMessage *message;
995 const char *sender, *name;
997 _dbus_return_val_if_fail (original_message != NULL, NULL);
999 sender = get_string_field (original_message,
1000 FIELD_SENDER, NULL);
1001 name = get_string_field (original_message,
1004 /* sender is allowed to be null here in peer-to-peer case */
1006 message = dbus_message_new (name, sender);
1008 if (message == NULL)
1011 if (!dbus_message_set_reply_serial (message,
1012 dbus_message_get_serial (original_message)))
1014 dbus_message_unref (message);
1022 * Creates a new message that is an error reply to a certain message.
1024 * @param original_message the original message
1025 * @param error_name the error name
1026 * @param error_message the error message string or #NULL for none
1027 * @returns a new error message
1030 dbus_message_new_error_reply (DBusMessage *original_message,
1031 const char *error_name,
1032 const char *error_message)
1034 DBusMessage *message;
1036 DBusMessageIter iter;
1038 _dbus_return_val_if_fail (original_message != NULL, NULL);
1039 _dbus_return_val_if_fail (error_name != NULL, NULL);
1041 sender = get_string_field (original_message,
1042 FIELD_SENDER, NULL);
1044 /* sender may be NULL for non-message-bus case or
1045 * when the message bus is dealing with an unregistered
1049 message = dbus_message_new (error_name, sender);
1051 if (message == NULL)
1054 if (!dbus_message_set_reply_serial (message,
1055 dbus_message_get_serial (original_message)))
1057 dbus_message_unref (message);
1061 if (error_message != NULL)
1063 dbus_message_append_iter_init (message, &iter);
1064 if (!dbus_message_iter_append_string (&iter, error_message))
1066 dbus_message_unref (message);
1071 dbus_message_set_is_error (message, TRUE);
1077 * Creates a new message that is an exact replica of the message
1078 * specified, except that its refcount is set to 1.
1080 * @param message the message.
1081 * @returns the new message.
1084 dbus_message_copy (const DBusMessage *message)
1086 DBusMessage *retval;
1089 _dbus_return_val_if_fail (message != NULL, NULL);
1091 retval = dbus_new0 (DBusMessage, 1);
1095 retval->refcount.value = 1;
1096 retval->byte_order = message->byte_order;
1097 retval->client_serial = message->client_serial;
1098 retval->reply_serial = message->reply_serial;
1099 retval->header_padding = message->header_padding;
1100 retval->locked = FALSE;
1102 if (!_dbus_string_init (&retval->header))
1108 if (!_dbus_string_init (&retval->body))
1110 _dbus_string_free (&retval->header);
1115 if (!_dbus_string_copy (&message->header, 0,
1116 &retval->header, 0))
1118 _dbus_string_free (&retval->header);
1119 _dbus_string_free (&retval->body);
1125 if (!_dbus_string_copy (&message->body, 0,
1128 _dbus_string_free (&retval->header);
1129 _dbus_string_free (&retval->body);
1135 for (i = 0; i < FIELD_LAST; i++)
1137 retval->header_fields[i].offset = message->header_fields[i].offset;
1145 * Increments the reference count of a DBusMessage.
1147 * @param message The message
1148 * @see dbus_message_unref
1151 dbus_message_ref (DBusMessage *message)
1153 dbus_int32_t old_refcount;
1155 _dbus_return_if_fail (message != NULL);
1157 old_refcount = _dbus_atomic_inc (&message->refcount);
1158 _dbus_assert (old_refcount >= 1);
1162 free_size_counter (void *element,
1165 DBusCounter *counter = element;
1166 DBusMessage *message = data;
1168 _dbus_counter_adjust (counter, - message->size_counter_delta);
1170 _dbus_counter_unref (counter);
1174 * Decrements the reference count of a DBusMessage.
1176 * @param message The message
1177 * @see dbus_message_ref
1180 dbus_message_unref (DBusMessage *message)
1182 dbus_int32_t old_refcount;
1184 _dbus_return_if_fail (message != NULL);
1186 old_refcount = _dbus_atomic_dec (&message->refcount);
1188 _dbus_assert (old_refcount >= 0);
1190 if (old_refcount == 1)
1192 /* This calls application callbacks! */
1193 _dbus_data_slot_list_free (&message->slot_list);
1195 _dbus_list_foreach (&message->size_counters,
1196 free_size_counter, message);
1197 _dbus_list_clear (&message->size_counters);
1199 _dbus_string_free (&message->header);
1200 _dbus_string_free (&message->body);
1202 dbus_free (message);
1207 * Gets the name of a message.
1209 * @param message the message
1210 * @returns the message name (should not be freed)
1213 dbus_message_get_name (DBusMessage *message)
1215 _dbus_return_val_if_fail (message != NULL, NULL);
1217 return get_string_field (message, FIELD_NAME, NULL);
1221 * Gets the destination service of a message.
1223 * @param message the message
1224 * @returns the message destination service (should not be freed)
1227 dbus_message_get_destination (DBusMessage *message)
1229 _dbus_return_val_if_fail (message != NULL, NULL);
1231 return get_string_field (message, FIELD_SERVICE, NULL);
1235 * Appends fields to a message given a variable argument list. The
1236 * variable argument list should contain the type of the argument
1237 * followed by the value to add. Array values are specified by an int
1238 * typecode followed by a pointer to the array followed by an int
1239 * giving the length of the array. The argument list must be
1240 * terminated with #DBUS_TYPE_INVALID.
1242 * This function doesn't support dicts or non-fundamental arrays.
1244 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1245 * only if #DBUS_HAVE_INT64 is defined.
1247 * @param message the message
1248 * @param first_arg_type type of the first argument
1249 * @param ... value of first argument, list of additional type-value pairs
1250 * @returns #TRUE on success
1253 dbus_message_append_args (DBusMessage *message,
1260 _dbus_return_val_if_fail (message != NULL, FALSE);
1262 va_start (var_args, first_arg_type);
1263 retval = dbus_message_append_args_valist (message,
1272 * This function takes a va_list for use by language bindings.
1273 * It's otherwise the same as dbus_message_append_args().
1275 * @todo: Shouldn't this function clean up the changes to the message
1276 * on failures? (Yes)
1278 * @see dbus_message_append_args.
1279 * @param message the message
1280 * @param first_arg_type type of first argument
1281 * @param var_args value of first argument, then list of type/value pairs
1282 * @returns #TRUE on success
1285 dbus_message_append_args_valist (DBusMessage *message,
1290 DBusMessageIter iter;
1292 _dbus_return_val_if_fail (message != NULL, FALSE);
1294 old_len = _dbus_string_get_length (&message->body);
1296 type = first_arg_type;
1298 dbus_message_append_iter_init (message, &iter);
1305 if (!dbus_message_iter_append_nil (&iter))
1308 case DBUS_TYPE_BOOLEAN:
1309 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1312 case DBUS_TYPE_INT32:
1313 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1316 case DBUS_TYPE_UINT32:
1317 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1320 #ifdef DBUS_HAVE_INT64
1321 case DBUS_TYPE_INT64:
1322 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1325 case DBUS_TYPE_UINT64:
1326 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1329 #endif /* DBUS_HAVE_INT64 */
1330 case DBUS_TYPE_DOUBLE:
1331 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1334 case DBUS_TYPE_STRING:
1335 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1338 case DBUS_TYPE_NAMED:
1341 unsigned char *data;
1344 name = va_arg (var_args, const char *);
1345 data = va_arg (var_args, unsigned char *);
1346 len = va_arg (var_args, int);
1348 if (!dbus_message_iter_append_named (&iter, name, data, len))
1352 case DBUS_TYPE_ARRAY:
1357 type = va_arg (var_args, int);
1358 data = va_arg (var_args, void *);
1359 len = va_arg (var_args, int);
1363 case DBUS_TYPE_BYTE:
1364 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1367 case DBUS_TYPE_BOOLEAN:
1368 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1371 case DBUS_TYPE_INT32:
1372 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1375 case DBUS_TYPE_UINT32:
1376 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1379 #ifdef DBUS_HAVE_INT64
1380 case DBUS_TYPE_INT64:
1381 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1384 case DBUS_TYPE_UINT64:
1385 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1388 #endif /* DBUS_HAVE_INT64 */
1389 case DBUS_TYPE_DOUBLE:
1390 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1393 case DBUS_TYPE_STRING:
1394 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1398 case DBUS_TYPE_ARRAY:
1399 case DBUS_TYPE_NAMED:
1400 case DBUS_TYPE_DICT:
1401 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1404 _dbus_warn ("Unknown field type %d\n", type);
1410 case DBUS_TYPE_DICT:
1411 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1414 _dbus_warn ("Unknown field type %d\n", type);
1418 type = va_arg (var_args, int);
1429 * Gets arguments from a message given a variable argument list.
1430 * The variable argument list should contain the type of the
1431 * argumen followed by a pointer to where the value should be
1432 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1434 * @param message the message
1435 * @param error error to be filled in on failure
1436 * @param first_arg_type the first argument type
1437 * @param ... location for first argument value, then list of type-location pairs
1438 * @returns #FALSE if the error was set
1441 dbus_message_get_args (DBusMessage *message,
1449 _dbus_return_val_if_fail (message != NULL, FALSE);
1450 _dbus_return_val_if_error_is_set (error, FALSE);
1452 va_start (var_args, first_arg_type);
1453 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1460 * This function takes a va_list for use by language bindings
1462 * @todo We need to free the argument data when an error occurs.
1464 * @see dbus_message_get_args
1465 * @param message the message
1466 * @param error error to be filled in
1467 * @param first_arg_type type of the first argument
1468 * @param var_args return location for first argument, followed by list of type/location pairs
1469 * @returns #FALSE if error was set
1472 dbus_message_get_args_valist (DBusMessage *message,
1477 DBusMessageIter iter;
1479 _dbus_return_val_if_fail (message != NULL, FALSE);
1480 _dbus_return_val_if_error_is_set (error, FALSE);
1482 dbus_message_iter_init (message, &iter);
1483 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1487 * Gets arguments from a message iterator given a variable argument list.
1488 * The variable argument list should contain the type of the
1489 * argumen followed by a pointer to where the value should be
1490 * stored. The list is terminated with 0.
1492 * @param iter the message iterator
1493 * @param error error to be filled in on failure
1494 * @param first_arg_type the first argument type
1495 * @param ... location for first argument value, then list of type-location pairs
1496 * @returns #FALSE if the error was set
1499 dbus_message_iter_get_args (DBusMessageIter *iter,
1507 _dbus_return_val_if_fail (iter != NULL, FALSE);
1508 _dbus_return_val_if_error_is_set (error, FALSE);
1510 va_start (var_args, first_arg_type);
1511 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1518 * This function takes a va_list for use by language bindings
1520 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1521 * only if #DBUS_HAVE_INT64 is defined.
1523 * @todo this function (or some lower-level non-convenience function)
1524 * needs better error handling; should allow the application to
1525 * distinguish between out of memory, and bad data from the remote
1526 * app. It also needs to not leak a bunch of args when it gets
1527 * to the arg that's bad, as that would be a security hole
1528 * (allow one app to force another to leak memory)
1530 * @todo We need to free the argument data when an error occurs.
1532 * @see dbus_message_get_args
1533 * @param iter the message iter
1534 * @param error error to be filled in
1535 * @param first_arg_type type of the first argument
1536 * @param var_args return location for first argument, followed by list of type/location pairs
1537 * @returns #FALSE if error was set
1540 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1545 int spec_type, msg_type, i;
1548 _dbus_return_val_if_fail (iter != NULL, FALSE);
1549 _dbus_return_val_if_error_is_set (error, FALSE);
1553 spec_type = first_arg_type;
1556 while (spec_type != 0)
1558 msg_type = dbus_message_iter_get_arg_type (iter);
1560 if (msg_type != spec_type)
1562 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1563 "Argument %d is specified to be of type \"%s\", but "
1564 "is actually of type \"%s\"\n", i,
1565 _dbus_type_to_string (spec_type),
1566 _dbus_type_to_string (msg_type));
1575 case DBUS_TYPE_BYTE:
1579 ptr = va_arg (var_args, unsigned char *);
1581 *ptr = dbus_message_iter_get_byte (iter);
1584 case DBUS_TYPE_BOOLEAN:
1588 ptr = va_arg (var_args, dbus_bool_t *);
1590 *ptr = dbus_message_iter_get_boolean (iter);
1593 case DBUS_TYPE_INT32:
1597 ptr = va_arg (var_args, dbus_int32_t *);
1599 *ptr = dbus_message_iter_get_int32 (iter);
1602 case DBUS_TYPE_UINT32:
1606 ptr = va_arg (var_args, dbus_uint32_t *);
1608 *ptr = dbus_message_iter_get_uint32 (iter);
1611 #ifdef DBUS_HAVE_INT64
1612 case DBUS_TYPE_INT64:
1616 ptr = va_arg (var_args, dbus_int64_t *);
1618 *ptr = dbus_message_iter_get_int64 (iter);
1621 case DBUS_TYPE_UINT64:
1625 ptr = va_arg (var_args, dbus_uint64_t *);
1627 *ptr = dbus_message_iter_get_uint64 (iter);
1630 #endif /* DBUS_HAVE_INT64 */
1632 case DBUS_TYPE_DOUBLE:
1636 ptr = va_arg (var_args, double *);
1638 *ptr = dbus_message_iter_get_double (iter);
1642 case DBUS_TYPE_STRING:
1646 ptr = va_arg (var_args, char **);
1648 *ptr = dbus_message_iter_get_string (iter);
1652 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1659 case DBUS_TYPE_NAMED:
1662 unsigned char **data;
1665 name = va_arg (var_args, char **);
1666 data = va_arg (var_args, unsigned char **);
1667 len = va_arg (var_args, int *);
1669 if (!dbus_message_iter_get_named (iter, name, data, len))
1671 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1676 case DBUS_TYPE_ARRAY:
1681 type = va_arg (var_args, int);
1682 data = va_arg (var_args, void *);
1683 len = va_arg (var_args, int *);
1685 if (dbus_message_iter_get_array_type (iter) != type)
1687 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1688 "Argument %d is specified to be of type \"array of %s\", but "
1689 "is actually of type \"array of %s\"\n", i,
1690 _dbus_type_to_string (type),
1691 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
1697 case DBUS_TYPE_BYTE:
1698 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
1700 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1704 case DBUS_TYPE_BOOLEAN:
1705 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
1707 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1711 case DBUS_TYPE_INT32:
1712 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
1714 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1718 case DBUS_TYPE_UINT32:
1719 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
1721 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1725 #ifdef DBUS_HAVE_INT64
1726 case DBUS_TYPE_INT64:
1727 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
1729 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1733 case DBUS_TYPE_UINT64:
1734 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
1736 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1740 #endif /* DBUS_HAVE_INT64 */
1741 case DBUS_TYPE_DOUBLE:
1742 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
1744 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1748 case DBUS_TYPE_STRING:
1749 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
1751 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1756 case DBUS_TYPE_ARRAY:
1757 case DBUS_TYPE_NAMED:
1758 case DBUS_TYPE_DICT:
1759 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
1760 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1763 _dbus_warn ("Unknown field type %d\n", type);
1764 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1769 case DBUS_TYPE_DICT:
1770 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
1771 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1774 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1775 _dbus_warn ("Unknown field type %d\n", spec_type);
1779 spec_type = va_arg (var_args, int);
1780 if (spec_type != 0 && !dbus_message_iter_next (iter))
1782 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1783 "Message has only %d arguments, but more were expected", i);
1799 * Initializes a DBusMessageIter representing the arguments of the
1800 * message passed in.
1802 * @param message the message
1803 * @param iter pointer to an iterator to initialize
1806 dbus_message_iter_init (DBusMessage *message,
1807 DBusMessageIter *iter)
1809 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1811 _dbus_return_if_fail (message != NULL);
1812 _dbus_return_if_fail (iter != NULL);
1814 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
1816 real->message = message;
1817 real->parent_iter = NULL;
1818 real->changed_stamp = message->changed_stamp;
1820 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
1822 real->end = _dbus_string_get_length (&message->body);
1824 real->container_start = 0;
1825 real->container_length_pos = 0;
1826 real->wrote_dict_key = 0;
1827 real->array_type_pos = 0;
1830 #ifndef DBUS_DISABLE_CHECKS
1832 dbus_message_iter_check (DBusMessageRealIter *iter)
1836 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
1840 if (iter->changed_stamp != iter->message->changed_stamp)
1842 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
1846 if (iter->pos < 0 || iter->pos > iter->end)
1848 _dbus_warn ("dbus iterator check failed: invalid position\n");
1854 #endif /* DBUS_DISABLE_CHECKS */
1857 skip_array_type (DBusMessageRealIter *iter, int pos)
1863 data = _dbus_string_get_const_data_len (&iter->message->body,
1866 while (*data == DBUS_TYPE_ARRAY);
1872 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
1879 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
1880 data = _dbus_string_get_const_data_len (&iter->message->body,
1882 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1885 *type = DBUS_TYPE_INVALID;
1887 return skip_array_type (iter, iter->pos);
1889 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
1890 data = _dbus_string_get_const_data_len (&iter->message->body,
1891 iter->array_type_pos, 1);
1892 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1895 *type = DBUS_TYPE_INVALID;
1899 case DBUS_MESSAGE_ITER_TYPE_DICT:
1900 /* Get the length of the string */
1901 len = _dbus_demarshal_uint32 (&iter->message->body,
1902 iter->message->byte_order,
1904 pos = pos + len + 1;
1906 data = _dbus_string_get_const_data_len (&iter->message->body,
1908 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1911 *type = DBUS_TYPE_INVALID;
1913 return skip_array_type (iter, pos);
1916 _dbus_assert_not_reached ("Invalid iter type");
1919 *type = DBUS_TYPE_INVALID;
1925 * Checks if an iterator has any more fields.
1927 * @param iter the message iter
1928 * @returns #TRUE if there are more fields
1932 dbus_message_iter_has_next (DBusMessageIter *iter)
1934 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1938 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
1940 if (real->pos >= real->end)
1943 pos = dbus_message_iter_get_data_start (real, &type);
1945 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1946 real->message->byte_order,
1947 type, pos, &end_pos))
1950 if (end_pos >= real->end)
1957 * Moves the iterator to the next field.
1959 * @param iter The message iter
1960 * @returns #TRUE if the iterator was moved to the next field
1963 dbus_message_iter_next (DBusMessageIter *iter)
1965 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1969 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
1971 pos = dbus_message_iter_get_data_start (real, &type);
1973 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1974 real->message->byte_order,
1975 type, pos, &end_pos))
1978 if (end_pos >= real->end)
1981 real->pos = end_pos;
1987 * Returns the argument type of the argument that the
1988 * message iterator points at.
1990 * @param iter the message iter
1991 * @returns the field type
1994 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
1996 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1999 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2001 if (real->pos >= real->end)
2002 return DBUS_TYPE_INVALID;
2004 pos = dbus_message_iter_get_data_start (real, &type);
2010 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2013 int _array_type_pos;
2018 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2019 _array_type_pos = iter->pos + 1;
2021 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2022 _array_type_pos = iter->array_type_pos + 1;
2024 case DBUS_MESSAGE_ITER_TYPE_DICT:
2025 /* Get the length of the string */
2026 len = _dbus_demarshal_uint32 (&iter->message->body,
2027 iter->message->byte_order,
2029 pos = pos + len + 1;
2030 data = _dbus_string_get_const_data_len (&iter->message->body,
2032 _array_type_pos = pos + 1;
2035 _dbus_assert_not_reached ("wrong iter type");
2036 return DBUS_TYPE_INVALID;
2039 if (array_type_pos != NULL)
2040 *array_type_pos = _array_type_pos;
2042 data = _dbus_string_get_const_data_len (&iter->message->body,
2043 _array_type_pos, 1);
2044 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2047 return DBUS_TYPE_INVALID;
2052 * Returns the element type of the array that the
2053 * message iterator points at. Note that you need
2054 * to check that the iterator points to an array
2055 * prior to using this function.
2057 * @param iter the message iter
2058 * @returns the field type
2061 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2063 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2066 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2068 if (real->pos >= real->end)
2069 return DBUS_TYPE_INVALID;
2071 pos = dbus_message_iter_get_data_start (real, &type);
2073 _dbus_assert (type == DBUS_TYPE_ARRAY);
2075 return iter_get_array_type (real, NULL);
2080 * Returns the string value that an iterator may point to.
2081 * Note that you need to check that the iterator points to
2082 * a string value before using this function.
2084 * @see dbus_message_iter_get_arg_type
2085 * @param iter the message iter
2086 * @returns the string
2089 dbus_message_iter_get_string (DBusMessageIter *iter)
2091 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2094 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2096 pos = dbus_message_iter_get_data_start (real, &type);
2098 _dbus_assert (type == DBUS_TYPE_STRING);
2100 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2105 * Returns the name and data from a named type that an
2106 * iterator may point to. Note that you need to check that
2107 * the iterator points to a named type before using this
2110 * @see dbus_message_iter_get_arg_type
2111 * @param iter the message iter
2112 * @param name return location for the name
2113 * @param value return location for data
2114 * @param len return location for length of data
2115 * @returns TRUE if get succeed
2119 dbus_message_iter_get_named (DBusMessageIter *iter,
2121 unsigned char **value,
2124 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2128 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2130 pos = dbus_message_iter_get_data_start (real, &type);
2132 _dbus_assert (type == DBUS_TYPE_NAMED);
2134 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2140 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2141 pos + 1, NULL, value, len))
2153 * Returns the byte value that an iterator may point to.
2154 * Note that you need to check that the iterator points to
2155 * a byte value before using this function.
2157 * @see dbus_message_iter_get_arg_type
2158 * @param iter the message iter
2159 * @returns the byte value
2162 dbus_message_iter_get_byte (DBusMessageIter *iter)
2164 unsigned char value;
2165 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2168 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2170 pos = dbus_message_iter_get_data_start (real, &type);
2172 _dbus_assert (type == DBUS_TYPE_BYTE);
2174 value = _dbus_string_get_byte (&real->message->body, pos);
2181 * Returns the boolean value that an iterator may point to.
2182 * Note that you need to check that the iterator points to
2183 * a boolean value before using this function.
2185 * @see dbus_message_iter_get_arg_type
2186 * @param iter the message iter
2187 * @returns the boolean value
2190 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2192 unsigned char value;
2193 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2196 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2198 pos = dbus_message_iter_get_data_start (real, &type);
2200 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2202 value = _dbus_string_get_byte (&real->message->body, pos);
2208 * Returns the 32 bit signed integer value that an iterator may point to.
2209 * Note that you need to check that the iterator points to
2210 * a 32-bit integer value before using this function.
2212 * @see dbus_message_iter_get_arg_type
2213 * @param iter the message iter
2214 * @returns the integer
2217 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2219 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2222 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2224 pos = dbus_message_iter_get_data_start (real, &type);
2226 _dbus_assert (type == DBUS_TYPE_INT32);
2228 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2233 * Returns the 32 bit unsigned integer value that an iterator may point to.
2234 * Note that you need to check that the iterator points to
2235 * a 32-bit unsigned integer value before using this function.
2237 * @see dbus_message_iter_get_arg_type
2238 * @param iter the message iter
2239 * @returns the integer
2242 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2244 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2247 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2249 pos = dbus_message_iter_get_data_start (real, &type);
2251 _dbus_assert (type == DBUS_TYPE_UINT32);
2253 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2257 #ifdef DBUS_HAVE_INT64
2260 * Returns the 64 bit signed integer value that an iterator may point
2261 * to. Note that you need to check that the iterator points to a
2262 * 64-bit integer value before using this function.
2264 * This function only exists if #DBUS_HAVE_INT64 is defined.
2266 * @see dbus_message_iter_get_arg_type
2267 * @param iter the message iter
2268 * @returns the integer
2271 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2273 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2276 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2278 pos = dbus_message_iter_get_data_start (real, &type);
2280 _dbus_assert (type == DBUS_TYPE_INT64);
2282 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2287 * Returns the 64 bit unsigned integer value that an iterator may point to.
2288 * Note that you need to check that the iterator points to
2289 * a 64-bit unsigned integer value before using this function.
2291 * This function only exists if #DBUS_HAVE_INT64 is defined.
2293 * @see dbus_message_iter_get_arg_type
2294 * @param iter the message iter
2295 * @returns the integer
2298 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2300 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2303 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2305 pos = dbus_message_iter_get_data_start (real, &type);
2307 _dbus_assert (type == DBUS_TYPE_UINT64);
2309 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2313 #endif /* DBUS_HAVE_INT64 */
2316 * Returns the double value that an iterator may point to.
2317 * Note that you need to check that the iterator points to
2318 * a string value before using this function.
2320 * @see dbus_message_iter_get_arg_type
2321 * @param iter the message iter
2322 * @returns the double
2325 dbus_message_iter_get_double (DBusMessageIter *iter)
2327 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2330 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2332 pos = dbus_message_iter_get_data_start (real, &type);
2334 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2336 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2341 * Initializes an iterator for the array that the iterator
2342 * may point to. Note that you need to check that the iterator
2343 * points to an array prior to using this function.
2345 * The array element type is returned in array_type, and the array
2346 * iterator can only be used to get that type of data.
2348 * @param iter the iterator
2349 * @param array_iter pointer to an iterator to initialize
2350 * @param array_type gets set to the type of the array elements
2351 * @returns #TRUE on success
2354 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2355 DBusMessageIter *array_iter,
2358 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2359 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2360 int type, pos, len_pos, len, array_type_pos;
2363 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2365 pos = dbus_message_iter_get_data_start (real, &type);
2367 _dbus_assert (type == DBUS_TYPE_ARRAY);
2369 _array_type = iter_get_array_type (real, &array_type_pos);
2371 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2372 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2375 array_real->parent_iter = real;
2376 array_real->message = real->message;
2377 array_real->changed_stamp = real->message->changed_stamp;
2379 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2380 array_real->pos = pos;
2381 array_real->end = pos + len;
2383 array_real->container_start = pos;
2384 array_real->container_length_pos = len_pos;
2385 array_real->wrote_dict_key = 0;
2386 array_real->array_type_pos = array_type_pos;
2387 array_real->array_type_done = TRUE;
2389 if (array_type != NULL)
2390 *array_type = _array_type;
2397 * Initializes an iterator for the dict that the iterator
2398 * may point to. Note that you need to check that the iterator
2399 * points to a dict prior to using this function.
2401 * @param iter the iterator
2402 * @param dict_iter pointer to an iterator to initialize
2403 * @returns #TRUE on success
2406 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2407 DBusMessageIter *dict_iter)
2409 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2410 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2411 int type, pos, len_pos, len;
2413 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2415 pos = dbus_message_iter_get_data_start (real, &type);
2417 _dbus_assert (type == DBUS_TYPE_DICT);
2419 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2420 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2423 dict_real->parent_iter = real;
2424 dict_real->message = real->message;
2425 dict_real->changed_stamp = real->message->changed_stamp;
2427 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2428 dict_real->pos = pos;
2429 dict_real->end = pos + len;
2431 dict_real->container_start = pos;
2432 dict_real->container_length_pos = len_pos;
2433 dict_real->wrote_dict_key = 0;
2439 * Returns the byte array that the iterator may point to.
2440 * Note that you need to check that the iterator points
2441 * to a byte array prior to using this function.
2443 * @param iter the iterator
2444 * @param value return location for array values
2445 * @param len return location for length of byte array
2446 * @returns #TRUE on success
2449 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2450 unsigned char **value,
2453 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2456 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2458 pos = dbus_message_iter_get_data_start (real, &type);
2460 _dbus_assert (type == DBUS_TYPE_ARRAY);
2462 type = iter_get_array_type (real, NULL);
2464 _dbus_assert (type == DBUS_TYPE_BYTE);
2466 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2467 pos, NULL, value, len))
2474 * Returns the boolean array that the iterator may point to. Note that
2475 * you need to check that the iterator points to an array of the
2476 * correct type prior to using this function.
2478 * @param iter the iterator
2479 * @param value return location for the array
2480 * @param len return location for the array length
2481 * @returns #TRUE on success
2484 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2485 unsigned char **value,
2488 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2491 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2493 pos = dbus_message_iter_get_data_start (real, &type);
2495 _dbus_assert (type == DBUS_TYPE_ARRAY);
2497 type = iter_get_array_type (real, NULL);
2499 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2501 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2502 pos, NULL, value, len))
2509 * Returns the 32 bit signed integer array that the iterator may point
2510 * to. Note that you need to check that the iterator points to an
2511 * array of the correct type prior to using this function.
2513 * @param iter the iterator
2514 * @param value return location for the array
2515 * @param len return location for the array length
2516 * @returns #TRUE on success
2519 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2520 dbus_int32_t **value,
2523 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2526 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2528 pos = dbus_message_iter_get_data_start (real, &type);
2530 _dbus_assert (type == DBUS_TYPE_ARRAY);
2532 type = iter_get_array_type (real, NULL);
2534 _dbus_assert (type == DBUS_TYPE_INT32);
2536 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2537 pos, NULL, value, len))
2544 * Returns the 32 bit unsigned integer array that the iterator may point
2545 * to. Note that you need to check that the iterator points to an
2546 * array of the correct type prior to using this function.
2548 * @param iter the iterator
2549 * @param value return location for the array
2550 * @param len return location for the array length
2551 * @returns #TRUE on success
2554 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2555 dbus_uint32_t **value,
2558 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2561 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2563 pos = dbus_message_iter_get_data_start (real, &type);
2565 _dbus_assert (type == DBUS_TYPE_ARRAY);
2567 type = iter_get_array_type (real, NULL);
2568 _dbus_assert (type == DBUS_TYPE_UINT32);
2570 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2571 pos, NULL, value, len))
2577 #ifdef DBUS_HAVE_INT64
2580 * Returns the 64 bit signed integer array that the iterator may point
2581 * to. Note that you need to check that the iterator points to an
2582 * array of the correct type prior to using this function.
2584 * This function only exists if #DBUS_HAVE_INT64 is defined.
2586 * @param iter the iterator
2587 * @param value return location for the array
2588 * @param len return location for the array length
2589 * @returns #TRUE on success
2592 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
2593 dbus_int64_t **value,
2596 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2599 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2601 pos = dbus_message_iter_get_data_start (real, &type);
2603 _dbus_assert (type == DBUS_TYPE_ARRAY);
2605 type = iter_get_array_type (real, NULL);
2607 _dbus_assert (type == DBUS_TYPE_INT64);
2609 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
2610 pos, NULL, value, len))
2617 * Returns the 64 bit unsigned integer array that the iterator may point
2618 * to. Note that you need to check that the iterator points to an
2619 * array of the correct type prior to using this function.
2621 * This function only exists if #DBUS_HAVE_INT64 is defined.
2623 * @param iter the iterator
2624 * @param value return location for the array
2625 * @param len return location for the array length
2626 * @returns #TRUE on success
2629 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
2630 dbus_uint64_t **value,
2633 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2636 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2638 pos = dbus_message_iter_get_data_start (real, &type);
2640 _dbus_assert (type == DBUS_TYPE_ARRAY);
2642 type = iter_get_array_type (real, NULL);
2643 _dbus_assert (type == DBUS_TYPE_UINT64);
2645 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
2646 pos, NULL, value, len))
2652 #endif /* DBUS_HAVE_INT64 */
2655 * Returns the double array that the iterator may point to. Note that
2656 * you need to check that the iterator points to an array of the
2657 * correct type prior to using this function.
2659 * @param iter the iterator
2660 * @param value return location for the array
2661 * @param len return location for the array length
2662 * @returns #TRUE on success
2665 dbus_message_iter_get_double_array (DBusMessageIter *iter,
2669 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2672 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2674 pos = dbus_message_iter_get_data_start (real, &type);
2676 _dbus_assert (type == DBUS_TYPE_ARRAY);
2678 type = iter_get_array_type (real, NULL);
2679 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2681 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
2682 pos, NULL, value, len))
2689 * Returns the string array that the iterator may point to.
2690 * Note that you need to check that the iterator points
2691 * to a byte array prior to using this function.
2693 * The returned value is a #NULL-terminated array of strings.
2694 * Each string is a separate malloc block, and the array
2695 * itself is a malloc block. You can free this type of
2696 * string array with dbus_free_string_array().
2698 * @param iter the iterator
2699 * @param value return location for string values
2700 * @param len return location for length of byte array
2701 * @returns #TRUE on success
2704 dbus_message_iter_get_string_array (DBusMessageIter *iter,
2708 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2711 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2713 pos = dbus_message_iter_get_data_start (real, &type);
2715 _dbus_assert (type == DBUS_TYPE_ARRAY);
2717 type = iter_get_array_type (real, NULL);
2718 _dbus_assert (type == DBUS_TYPE_STRING);
2720 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
2721 pos, NULL, value, len))
2728 * Returns the key name fot the dict entry that an iterator
2729 * may point to. Note that you need to check that the iterator
2730 * points to a dict entry before using this function.
2732 * @see dbus_message_iter_init_dict_iterator
2733 * @param iter the message iter
2734 * @returns the key name
2737 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
2739 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2741 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2743 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
2745 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2750 * Initializes a DBusMessageIter pointing to the end of the
2751 * message. This iterator can be used to append data to the
2754 * @param message the message
2755 * @param iter pointer to an iterator to initialize
2758 dbus_message_append_iter_init (DBusMessage *message,
2759 DBusMessageIter *iter)
2761 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2763 _dbus_return_if_fail (message != NULL);
2764 _dbus_return_if_fail (iter != NULL);
2766 real->message = message;
2767 real->parent_iter = NULL;
2768 real->changed_stamp = message->changed_stamp;
2770 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2771 real->end = _dbus_string_get_length (&real->message->body);
2772 real->pos = real->end;
2774 real->container_length_pos = 0;
2775 real->wrote_dict_key = 0;
2778 #ifndef DBUS_DISABLE_CHECKS
2780 dbus_message_iter_append_check (DBusMessageRealIter *iter)
2784 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
2788 if (iter->message->locked)
2790 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
2794 if (iter->changed_stamp != iter->message->changed_stamp)
2796 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
2800 if (iter->pos != iter->end)
2802 _dbus_warn ("dbus iterator check failed: can only append at end of message");
2806 if (iter->pos != _dbus_string_get_length (&iter->message->body))
2808 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
2814 #endif /* DBUS_DISABLE_CHECKS */
2817 dbus_message_iter_append_type (DBusMessageRealIter *iter,
2823 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2824 if (!_dbus_string_append_byte (&iter->message->body, type))
2828 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2829 data = _dbus_string_get_const_data_len (&iter->message->body,
2830 iter->array_type_pos, 1);
2833 _dbus_warn ("Appended element of wrong type for array\n");
2838 case DBUS_MESSAGE_ITER_TYPE_DICT:
2839 if (!iter->wrote_dict_key)
2841 _dbus_warn ("Appending dict data before key name\n");
2845 if (!_dbus_string_append_byte (&iter->message->body, type))
2851 _dbus_assert_not_reached ("Invalid iter type");
2859 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
2861 iter->changed_stamp = iter->message->changed_stamp;
2863 /* Set new end of iter */
2864 iter->end = _dbus_string_get_length (&iter->message->body);
2865 iter->pos = iter->end;
2867 /* Set container length */
2868 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
2869 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
2870 _dbus_marshal_set_uint32 (&iter->message->body,
2871 iter->message->byte_order,
2872 iter->container_length_pos,
2873 iter->end - iter->container_start);
2875 if (iter->parent_iter)
2876 dbus_message_iter_update_after_change (iter->parent_iter);
2880 dbus_message_iter_append_done (DBusMessageRealIter *iter)
2882 iter->message->changed_stamp++;
2883 dbus_message_iter_update_after_change (iter);
2884 iter->wrote_dict_key = FALSE;
2888 * Appends a nil value to the message
2890 * @param iter an iterator pointing to the end of the message
2891 * @returns #TRUE on success
2894 dbus_message_iter_append_nil (DBusMessageIter *iter)
2896 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2898 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2900 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
2903 dbus_message_iter_append_done (real);
2909 * Appends a boolean value to the message
2911 * @param iter an iterator pointing to the end of the message
2912 * @param value the boolean value
2913 * @returns #TRUE on success
2916 dbus_message_iter_append_boolean (DBusMessageIter *iter,
2919 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2921 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2923 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
2926 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
2928 _dbus_string_set_length (&real->message->body, real->pos);
2932 dbus_message_iter_append_done (real);
2938 * Appends a byte to the message
2940 * @param iter an iterator pointing to the end of the message
2941 * @param value the byte value
2942 * @returns #TRUE on success
2945 dbus_message_iter_append_byte (DBusMessageIter *iter,
2946 unsigned char value)
2948 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2950 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2952 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
2955 if (!_dbus_string_append_byte (&real->message->body, value))
2957 _dbus_string_set_length (&real->message->body, real->pos);
2961 dbus_message_iter_append_done (real);
2968 * Appends a 32 bit signed integer to the message.
2970 * @param iter an iterator pointing to the end of the message
2971 * @param value the integer value
2972 * @returns #TRUE on success
2975 dbus_message_iter_append_int32 (DBusMessageIter *iter,
2978 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2980 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2982 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
2985 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
2987 _dbus_string_set_length (&real->message->body, real->pos);
2991 dbus_message_iter_append_done (real);
2997 * Appends a 32 bit unsigned integer to the message.
2999 * @param iter an iterator pointing to the end of the message
3000 * @param value the integer value
3001 * @returns #TRUE on success
3004 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3005 dbus_uint32_t value)
3007 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3009 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3011 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3014 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3016 _dbus_string_set_length (&real->message->body, real->pos);
3020 dbus_message_iter_append_done (real);
3025 #ifdef DBUS_HAVE_INT64
3028 * Appends a 64 bit signed integer to the message.
3030 * This function only exists if #DBUS_HAVE_INT64 is defined.
3032 * @param iter an iterator pointing to the end of the message
3033 * @param value the integer value
3034 * @returns #TRUE on success
3037 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3040 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3042 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3044 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3047 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3049 _dbus_string_set_length (&real->message->body, real->pos);
3053 dbus_message_iter_append_done (real);
3059 * Appends a 64 bit unsigned integer to the message.
3061 * This function only exists if #DBUS_HAVE_INT64 is defined.
3063 * @param iter an iterator pointing to the end of the message
3064 * @param value the integer value
3065 * @returns #TRUE on success
3068 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3069 dbus_uint64_t value)
3071 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3073 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3075 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3078 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3080 _dbus_string_set_length (&real->message->body, real->pos);
3084 dbus_message_iter_append_done (real);
3089 #endif /* DBUS_HAVE_INT64 */
3092 * Appends a double value to the message.
3094 * @param iter an iterator pointing to the end of the message
3095 * @param value the double value
3096 * @returns #TRUE on success
3099 dbus_message_iter_append_double (DBusMessageIter *iter,
3102 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3104 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3106 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3109 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3111 _dbus_string_set_length (&real->message->body, real->pos);
3115 dbus_message_iter_append_done (real);
3121 * Appends a UTF-8 string to the message.
3123 * @param iter an iterator pointing to the end of the message
3124 * @param value the string
3125 * @returns #TRUE on success
3128 dbus_message_iter_append_string (DBusMessageIter *iter,
3131 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3133 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3135 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3138 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3140 _dbus_string_set_length (&real->message->body, real->pos);
3144 dbus_message_iter_append_done (real);
3150 * Appends a named type data chunk to the message. A named
3151 * type is simply an arbitrary UTF-8 string used as a type
3152 * tag, plus an array of arbitrary bytes to be interpreted
3153 * according to the type tag.
3155 * @param iter an iterator pointing to the end of the message
3156 * @param name the name of the type
3157 * @param data the binary data used to store the value
3158 * @param len the length of the binary data in bytes
3159 * @returns #TRUE on success
3162 dbus_message_iter_append_named (DBusMessageIter *iter,
3164 const unsigned char *data,
3167 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3169 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3171 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3174 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3176 _dbus_string_set_length (&real->message->body, real->pos);
3180 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3182 _dbus_string_set_length (&real->message->body, real->pos);
3186 dbus_message_iter_append_done (real);
3193 * Appends a dict key name to the message. The iterator used
3194 * must point to a dict.
3196 * @param iter an iterator pointing to the end of the message
3197 * @param value the string
3198 * @returns #TRUE on success
3201 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3204 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3206 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3207 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3209 if (real->wrote_dict_key)
3211 _dbus_warn ("Appendinging multiple dict key names\n");
3215 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3220 dbus_message_iter_append_done (real);
3221 real->wrote_dict_key = TRUE;
3227 array_iter_type_mark_done (DBusMessageRealIter *iter)
3231 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3232 array_iter_type_mark_done (iter->parent_iter);
3236 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3237 sizeof (dbus_uint32_t));
3239 /* Empty length for now, backfill later */
3240 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3242 _dbus_string_set_length (&iter->message->body, iter->pos);
3246 iter->container_start = _dbus_string_get_length (&iter->message->body);
3247 iter->container_length_pos = len_pos;
3248 iter->array_type_done = TRUE;
3254 append_array_type (DBusMessageRealIter *real,
3256 dbus_bool_t *array_type_done,
3257 int *array_type_pos)
3259 int existing_element_type;
3261 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3264 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3265 real->array_type_done)
3267 existing_element_type = iter_get_array_type (real, array_type_pos);
3268 if (existing_element_type != element_type)
3270 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3271 _dbus_type_to_string (element_type),
3272 _dbus_type_to_string (existing_element_type));
3273 _dbus_string_set_length (&real->message->body, real->pos);
3276 if (array_type_done != NULL)
3277 *array_type_done = TRUE;
3281 if (array_type_pos != NULL)
3282 *array_type_pos = _dbus_string_get_length (&real->message->body);
3284 /* Append element type */
3285 if (!_dbus_string_append_byte (&real->message->body, element_type))
3287 _dbus_string_set_length (&real->message->body, real->pos);
3291 if (array_type_done != NULL)
3292 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3294 if (element_type != DBUS_TYPE_ARRAY &&
3295 !array_iter_type_mark_done (real))
3303 * Appends an array to the message and initializes an iterator that
3304 * can be used to append to the array.
3306 * @param iter an iterator pointing to the end of the message
3307 * @param array_iter pointer to an iter that will be initialized
3308 * @param element_type the type of the array elements
3309 * @returns #TRUE on success
3312 dbus_message_iter_append_array (DBusMessageIter *iter,
3313 DBusMessageIter *array_iter,
3316 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3317 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3320 dbus_bool_t array_type_done;
3322 if (element_type == DBUS_TYPE_NIL)
3324 _dbus_warn ("Can't create NIL arrays\n");
3328 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3330 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3333 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3335 if (array_type_done)
3337 /* Empty length for now, backfill later */
3338 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3340 _dbus_string_set_length (&real->message->body, real->pos);
3345 array_real->parent_iter = real;
3346 array_real->message = real->message;
3347 array_real->changed_stamp = real->message->changed_stamp;
3349 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3350 array_real->pos = _dbus_string_get_length (&real->message->body);
3351 array_real->end = array_real->end;
3353 array_real->container_start = array_real->pos;
3354 array_real->container_length_pos = len_pos;
3355 array_real->wrote_dict_key = 0;
3356 array_real->array_type_done = array_type_done;
3357 array_real->array_type_pos = array_type_pos;
3359 dbus_message_iter_append_done (array_real);
3365 * Appends a dict to the message and initializes an iterator that
3366 * can be used to append to the dict.
3368 * @param iter an iterator pointing to the end of the message
3369 * @param dict_iter pointer to an iter that will be initialized
3370 * @returns #TRUE on success
3373 dbus_message_iter_append_dict (DBusMessageIter *iter,
3374 DBusMessageIter *dict_iter)
3376 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3377 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3380 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3382 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3385 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3387 /* Empty length for now, backfill later */
3388 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3390 _dbus_string_set_length (&real->message->body, real->pos);
3394 dict_real->parent_iter = real;
3395 dict_real->message = real->message;
3396 dict_real->changed_stamp = real->message->changed_stamp;
3398 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3399 dict_real->pos = _dbus_string_get_length (&real->message->body);
3400 dict_real->end = dict_real->end;
3402 dict_real->container_start = dict_real->pos;
3403 dict_real->container_length_pos = len_pos;
3404 dict_real->wrote_dict_key = 0;
3406 dbus_message_iter_append_done (dict_real);
3413 * Appends a boolean array to the message.
3415 * @param iter an iterator pointing to the end of the message
3416 * @param value the array
3417 * @param len the length of the array
3418 * @returns #TRUE on success
3421 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3422 unsigned const char *value,
3425 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3427 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3429 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3432 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3434 _dbus_string_set_length (&real->message->body, real->pos);
3438 dbus_message_iter_append_done (real);
3444 * Appends a 32 bit signed integer array to the message.
3446 * @param iter an iterator pointing to the end of the message
3447 * @param value the array
3448 * @param len the length of the array
3449 * @returns #TRUE on success
3452 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3453 const dbus_int32_t *value,
3456 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3458 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3460 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
3463 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
3465 _dbus_string_set_length (&real->message->body, real->pos);
3469 dbus_message_iter_append_done (real);
3475 * Appends a 32 bit unsigned integer array to the message.
3477 * @param iter an iterator pointing to the end of the message
3478 * @param value the array
3479 * @param len the length of the array
3480 * @returns #TRUE on success
3483 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
3484 const dbus_uint32_t *value,
3487 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3489 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3491 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
3494 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3496 _dbus_string_set_length (&real->message->body, real->pos);
3500 dbus_message_iter_append_done (real);
3505 #ifdef DBUS_HAVE_INT64
3508 * Appends a 64 bit signed integer array to the message.
3510 * This function only exists if #DBUS_HAVE_INT64 is defined.
3512 * @param iter an iterator pointing to the end of the message
3513 * @param value the array
3514 * @param len the length of the array
3515 * @returns #TRUE on success
3518 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
3519 const dbus_int64_t *value,
3522 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3524 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3526 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
3529 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
3531 _dbus_string_set_length (&real->message->body, real->pos);
3535 dbus_message_iter_append_done (real);
3541 * Appends a 64 bit unsigned integer array to the message.
3543 * This function only exists if #DBUS_HAVE_INT64 is defined.
3545 * @param iter an iterator pointing to the end of the message
3546 * @param value the array
3547 * @param len the length of the array
3548 * @returns #TRUE on success
3551 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
3552 const dbus_uint64_t *value,
3555 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3557 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3559 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
3562 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
3564 _dbus_string_set_length (&real->message->body, real->pos);
3568 dbus_message_iter_append_done (real);
3572 #endif /* DBUS_HAVE_INT64 */
3575 * Appends a double array to the message.
3577 * @param iter an iterator pointing to the end of the message
3578 * @param value the array
3579 * @param len the length of the array
3580 * @returns #TRUE on success
3583 dbus_message_iter_append_double_array (DBusMessageIter *iter,
3584 const double *value,
3587 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3589 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3591 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
3594 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
3596 _dbus_string_set_length (&real->message->body, real->pos);
3600 dbus_message_iter_append_done (real);
3606 * Appends a byte array to the message.
3608 * @param iter an iterator pointing to the end of the message
3609 * @param value the array
3610 * @param len the length of the array
3611 * @returns #TRUE on success
3614 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
3615 unsigned const char *value,
3618 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3620 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3622 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
3625 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3627 _dbus_string_set_length (&real->message->body, real->pos);
3631 dbus_message_iter_append_done (real);
3637 * Appends a string array to the message.
3639 * @param iter an iterator pointing to the end of the message
3640 * @param value the array
3641 * @param len the length of the array
3642 * @returns #TRUE on success
3645 dbus_message_iter_append_string_array (DBusMessageIter *iter,
3649 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3651 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3653 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
3656 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
3658 _dbus_string_set_length (&real->message->body, real->pos);
3662 dbus_message_iter_append_done (real);
3668 * Sets the message sender.
3670 * @param message the message
3671 * @param sender the sender
3672 * @returns #FALSE if not enough memory
3675 dbus_message_set_sender (DBusMessage *message,
3678 _dbus_return_val_if_fail (message != NULL, FALSE);
3679 _dbus_return_val_if_fail (!message->locked, FALSE);
3683 delete_string_field (message, FIELD_SENDER);
3688 return set_string_field (message,
3695 * Sets a flag indicating that the message is an error reply
3696 * message, i.e. an "exception" rather than a normal response.
3698 * @param message the message
3699 * @param is_error_reply #TRUE if this is an error message.
3702 dbus_message_set_is_error (DBusMessage *message,
3703 dbus_bool_t is_error_reply)
3707 _dbus_return_if_fail (message != NULL);
3708 _dbus_return_if_fail (!message->locked);
3710 header = _dbus_string_get_data_len (&message->header, 1, 1);
3713 *header |= DBUS_HEADER_FLAG_ERROR;
3715 *header &= ~DBUS_HEADER_FLAG_ERROR;
3719 * Returns #TRUE if the message is an error
3720 * reply to some previous message we sent.
3722 * @param message the message
3723 * @returns #TRUE if the message is an error
3726 dbus_message_get_is_error (DBusMessage *message)
3730 _dbus_return_val_if_fail (message != NULL, FALSE);
3732 header = _dbus_string_get_const_data_len (&message->header, 1, 1);
3734 return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
3738 * Gets the service which originated this message,
3739 * or #NULL if unknown or inapplicable.
3741 * @param message the message
3742 * @returns the service name or #NULL
3745 dbus_message_get_sender (DBusMessage *message)
3747 _dbus_return_val_if_fail (message != NULL, NULL);
3749 return get_string_field (message, FIELD_SENDER, NULL);
3753 * Checks whether the message has the given name.
3754 * If the message has no name or has a different
3755 * name, returns #FALSE.
3757 * @param message the message
3758 * @param name the name to check (must not be #NULL)
3760 * @returns #TRUE if the message has the given name
3763 dbus_message_has_name (DBusMessage *message,
3768 _dbus_return_val_if_fail (message != NULL, FALSE);
3769 _dbus_return_val_if_fail (name != NULL, FALSE);
3771 n = dbus_message_get_name (message);
3773 if (n && strcmp (n, name) == 0)
3780 * Checks whether the message was sent to the given service. If the
3781 * message has no service specified or has a different name, returns
3784 * @param message the message
3785 * @param service the service to check (must not be #NULL)
3787 * @returns #TRUE if the message has the given destination service
3790 dbus_message_has_destination (DBusMessage *message,
3791 const char *service)
3795 _dbus_return_val_if_fail (message != NULL, FALSE);
3796 _dbus_return_val_if_fail (service != NULL, FALSE);
3798 s = dbus_message_get_destination (message);
3800 if (s && strcmp (s, service) == 0)
3807 * Checks whether the message has the given service as its sender. If
3808 * the message has no sender specified or has a different sender,
3809 * returns #FALSE. Note that if a peer application owns multiple
3810 * services, its messages will have only one of those services as the
3811 * sender (usually the base service). So you can't use this
3812 * function to prove the sender didn't own service Foo, you can
3813 * only use it to prove that it did.
3815 * @param message the message
3816 * @param service the service to check (must not be #NULL)
3818 * @returns #TRUE if the message has the given origin service
3821 dbus_message_has_sender (DBusMessage *message,
3822 const char *service)
3826 _dbus_assert (service != NULL);
3828 s = dbus_message_get_sender (message);
3830 if (s && strcmp (s, service) == 0)
3837 * Sets a #DBusError based on the contents of the given
3838 * message. The error is only set if the message
3839 * is an error message, as in dbus_message_get_is_error().
3840 * The name of the error is set to the name of the message,
3841 * and the error message is set to the first argument
3842 * if the argument exists and is a string.
3844 * The return value indicates whether the error was set (the error is
3845 * set if and only if the message is an error message).
3846 * So you can check for an error reply and convert it to DBusError
3849 * @param error the error to set
3850 * @param message the message to set it from
3851 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
3854 dbus_set_error_from_message (DBusError *error,
3855 DBusMessage *message)
3859 _dbus_return_val_if_fail (message != NULL, FALSE);
3860 _dbus_return_val_if_error_is_set (error, FALSE);
3862 if (!dbus_message_get_is_error (message))
3866 dbus_message_get_args (message, NULL,
3867 DBUS_TYPE_STRING, &str,
3870 dbus_set_error (error, dbus_message_get_name (message),
3871 str ? "%s" : NULL, str);
3881 * @addtogroup DBusMessageInternals
3886 * @typedef DBusMessageLoader
3888 * The DBusMessageLoader object encapsulates the process of converting
3889 * a byte stream into a series of DBusMessage. It buffers the incoming
3890 * bytes as efficiently as possible, and generates a queue of
3891 * messages. DBusMessageLoader is typically used as part of a
3892 * DBusTransport implementation. The DBusTransport then hands off
3893 * the loaded messages to a DBusConnection, making the messages
3894 * visible to the application.
3896 * @todo write tests for break-loader that a) randomly delete header
3897 * fields and b) set string fields to zero-length and other funky
3902 /* we definitely use signed ints for sizes, so don't exceed
3903 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
3904 * over 128M is pretty nuts anyhow.
3908 * The maximum sane message size.
3910 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
3913 * Implementation details of DBusMessageLoader.
3914 * All members are private.
3916 struct DBusMessageLoader
3918 int refcount; /**< Reference count. */
3920 DBusString data; /**< Buffered data */
3922 DBusList *messages; /**< Complete messages. */
3924 long max_message_size; /**< Maximum size of a message */
3926 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
3928 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
3932 * The initial buffer size of the message loader.
3934 * @todo this should be based on min header size plus some average
3935 * body size, or something. Or rather, the min header size only, if we
3936 * want to try to read only the header, store that in a DBusMessage,
3937 * then read only the body and store that, etc., depends on
3938 * how we optimize _dbus_message_loader_get_buffer() and what
3939 * the exact message format is.
3941 #define INITIAL_LOADER_DATA_LEN 32
3944 * Creates a new message loader. Returns #NULL if memory can't
3947 * @returns new loader, or #NULL.
3950 _dbus_message_loader_new (void)
3952 DBusMessageLoader *loader;
3954 loader = dbus_new0 (DBusMessageLoader, 1);
3958 loader->refcount = 1;
3960 /* Try to cap message size at something that won't *totally* hose
3961 * the system if we have a couple of them.
3963 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
3965 if (!_dbus_string_init (&loader->data))
3971 /* preallocate the buffer for speed, ignore failure */
3972 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
3973 _dbus_string_set_length (&loader->data, 0);
3979 * Increments the reference count of the loader.
3981 * @param loader the loader.
3984 _dbus_message_loader_ref (DBusMessageLoader *loader)
3986 loader->refcount += 1;
3990 * Decrements the reference count of the loader and finalizes the
3991 * loader when the count reaches zero.
3993 * @param loader the loader.
3996 _dbus_message_loader_unref (DBusMessageLoader *loader)
3998 loader->refcount -= 1;
3999 if (loader->refcount == 0)
4001 _dbus_list_foreach (&loader->messages,
4002 (DBusForeachFunction) dbus_message_unref,
4004 _dbus_list_clear (&loader->messages);
4005 _dbus_string_free (&loader->data);
4011 * Gets the buffer to use for reading data from the network. Network
4012 * data is read directly into an allocated buffer, which is then used
4013 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4014 * The buffer must always be returned immediately using
4015 * _dbus_message_loader_return_buffer(), even if no bytes are
4016 * successfully read.
4018 * @todo this function can be a lot more clever. For example
4019 * it can probably always return a buffer size to read exactly
4020 * the body of the next message, thus avoiding any memory wastage
4023 * @todo we need to enforce a max length on strings in header fields.
4025 * @param loader the message loader.
4026 * @param buffer the buffer
4029 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4030 DBusString **buffer)
4032 _dbus_assert (!loader->buffer_outstanding);
4034 *buffer = &loader->data;
4036 loader->buffer_outstanding = TRUE;
4040 * The smallest header size that can occur.
4041 * (It won't be valid)
4043 #define DBUS_MINIMUM_HEADER_SIZE 16
4045 /** Pack four characters as in "abcd" into a uint32 */
4046 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
4047 ((((dbus_uint32_t)a) << 24) | \
4048 (((dbus_uint32_t)b) << 16) | \
4049 (((dbus_uint32_t)c) << 8) | \
4052 /** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
4053 #define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
4054 FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
4056 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
4057 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
4058 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
4060 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
4061 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
4062 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
4064 /** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
4065 #define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
4066 FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
4069 decode_string_field (const DBusString *data,
4070 HeaderField fields[FIELD_LAST],
4074 const char *field_name)
4077 int string_data_pos;
4079 if (fields[field].offset >= 0)
4081 _dbus_verbose ("%s field provided twice\n",
4086 if (type != DBUS_TYPE_STRING)
4088 _dbus_verbose ("%s field has wrong type %s\n",
4089 field_name, _dbus_type_to_string (type));
4093 /* skip padding after typecode, skip string length;
4094 * we assume that the string arg has already been validated
4095 * for sanity and UTF-8
4097 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4098 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4100 _dbus_string_init_const (&tmp,
4101 _dbus_string_get_const_data (data) + string_data_pos);
4103 if (field == FIELD_NAME)
4105 if (!_dbus_string_validate_name (&tmp, 0, _dbus_string_get_length (&tmp)))
4107 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4108 field_name, _dbus_string_get_const_data (&tmp));
4112 if (_dbus_string_starts_with_c_str (&tmp,
4113 DBUS_NAMESPACE_LOCAL_MESSAGE))
4115 _dbus_verbose ("Message is in the local namespace\n");
4121 if (!_dbus_string_validate_service (&tmp, 0, _dbus_string_get_length (&tmp)))
4123 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4124 field_name, _dbus_string_get_const_data (&tmp));
4129 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4132 _dbus_verbose ("Found field %s name at offset %d\n",
4133 field_name, fields[field].offset);
4140 decode_header_data (const DBusString *data,
4143 HeaderField fields[FIELD_LAST],
4144 int *message_padding)
4151 if (header_len < 16)
4155 while (i < FIELD_LAST)
4157 fields[i].offset = -1;
4161 fields[FIELD_HEADER_LENGTH].offset = 4;
4162 fields[FIELD_BODY_LENGTH].offset = 8;
4163 fields[FIELD_CLIENT_SERIAL].offset = 12;
4165 /* Now handle the named fields. A real named field is at least 4
4166 * bytes for the name, plus a type code (1 byte) plus padding. So
4167 * if we have less than 8 bytes left, it must be alignment padding,
4168 * not a field. While >= 8 bytes can't be entirely alignment
4172 while ((pos + 7) < header_len)
4174 pos = _DBUS_ALIGN_VALUE (pos, 4);
4176 if ((pos + 4) > header_len)
4179 field =_dbus_string_get_const_data_len (data, pos, 4);
4182 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
4184 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4186 _dbus_verbose ("Failed to validate type of named header field\n");
4190 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4192 _dbus_verbose ("Failed to validate argument to named header field\n");
4196 if (new_pos > header_len)
4198 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4202 switch (DBUS_UINT32_FROM_BE (*(int*)field))
4204 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
4205 if (!decode_string_field (data, fields, pos, type,
4207 DBUS_HEADER_FIELD_SERVICE))
4211 case DBUS_HEADER_FIELD_NAME_AS_UINT32:
4212 if (!decode_string_field (data, fields, pos, type,
4214 DBUS_HEADER_FIELD_NAME))
4218 case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
4219 if (!decode_string_field (data, fields, pos, type,
4221 DBUS_HEADER_FIELD_SENDER))
4225 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
4226 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
4228 _dbus_verbose ("%s field provided twice\n",
4229 DBUS_HEADER_FIELD_REPLY);
4233 if (type != DBUS_TYPE_UINT32)
4235 _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_REPLY);
4239 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos, 4);
4241 _dbus_verbose ("Found reply serial at offset %d\n",
4242 fields[FIELD_REPLY_SERIAL].offset);
4246 _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c at offset %d\n",
4247 field[0], field[1], field[2], field[3], pos);
4253 if (pos < header_len)
4255 /* Alignment padding, verify that it's nul */
4256 _dbus_assert ((header_len - pos) < 8);
4258 if (!_dbus_string_validate_nul (data,
4259 pos, (header_len - pos)))
4261 _dbus_verbose ("header alignment padding is not nul\n");
4266 /* Name field is mandatory */
4267 if (fields[FIELD_NAME].offset < 0)
4269 _dbus_verbose ("No %s field provided\n",
4270 DBUS_HEADER_FIELD_NAME);
4274 if (message_padding)
4275 *message_padding = header_len - pos;
4281 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
4282 * indicating to the loader how many bytes of the buffer were filled
4283 * in. This function must always be called, even if no bytes were
4284 * successfully read.
4286 * @param loader the loader.
4287 * @param buffer the buffer.
4288 * @param bytes_read number of bytes that were read into the buffer.
4291 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
4295 _dbus_assert (loader->buffer_outstanding);
4296 _dbus_assert (buffer == &loader->data);
4298 loader->buffer_outstanding = FALSE;
4302 * Converts buffered data into messages.
4304 * @param loader the loader.
4305 * @returns #TRUE if we had enough memory to finish.
4308 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
4310 if (loader->corrupted)
4313 while (_dbus_string_get_length (&loader->data) >= 16)
4315 DBusMessage *message;
4316 const char *header_data;
4317 int byte_order, header_len, body_len, header_padding;
4318 dbus_uint32_t header_len_unsigned, body_len_unsigned;
4320 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
4322 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
4324 if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
4326 _dbus_verbose ("Message has protocol version %d ours is %d\n",
4327 (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
4328 loader->corrupted = TRUE;
4332 byte_order = header_data[0];
4334 if (byte_order != DBUS_LITTLE_ENDIAN &&
4335 byte_order != DBUS_BIG_ENDIAN)
4337 _dbus_verbose ("Message with bad byte order '%c' received\n",
4339 loader->corrupted = TRUE;
4343 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
4344 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
4346 if (header_len_unsigned < 16)
4348 _dbus_verbose ("Message had broken too-small header length %u\n",
4349 header_len_unsigned);
4350 loader->corrupted = TRUE;
4354 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
4355 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
4357 _dbus_verbose ("Header or body length too large (%u %u)\n",
4358 header_len_unsigned,
4360 loader->corrupted = TRUE;
4364 /* Now that we know the values are in signed range, get
4365 * rid of stupid unsigned, just causes bugs
4367 header_len = header_len_unsigned;
4368 body_len = body_len_unsigned;
4370 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
4373 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
4375 loader->corrupted = TRUE;
4379 if (header_len + body_len > loader->max_message_size)
4381 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
4382 header_len, body_len, loader->max_message_size);
4383 loader->corrupted = TRUE;
4387 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
4389 HeaderField fields[FIELD_LAST];
4394 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
4396 if (!decode_header_data (&loader->data, header_len, byte_order,
4397 fields, &header_padding))
4399 _dbus_verbose ("Header was invalid\n");
4400 loader->corrupted = TRUE;
4404 next_arg = header_len;
4405 while (next_arg < (header_len + body_len))
4408 int prev = next_arg;
4410 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
4413 _dbus_verbose ("invalid typecode at offset %d\n", prev);
4414 loader->corrupted = TRUE;
4418 if (!_dbus_marshal_validate_arg (&loader->data,
4425 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
4426 loader->corrupted = TRUE;
4430 _dbus_assert (next_arg > prev);
4433 if (next_arg > (header_len + body_len))
4435 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
4436 next_arg, header_len, body_len,
4437 header_len + body_len);
4438 loader->corrupted = TRUE;
4442 message = dbus_message_new_empty_header ();
4443 if (message == NULL)
4445 _dbus_verbose ("Failed to allocate empty message\n");
4449 message->byte_order = byte_order;
4450 message->header_padding = header_padding;
4452 /* Copy in the offsets we found */
4454 while (i < FIELD_LAST)
4456 message->header_fields[i] = fields[i];
4460 if (!_dbus_list_append (&loader->messages, message))
4462 _dbus_verbose ("Failed to append new message to loader queue\n");
4463 dbus_message_unref (message);
4467 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
4468 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
4470 _dbus_assert (_dbus_string_get_length (&loader->data) >=
4471 (header_len + body_len));
4473 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
4475 _dbus_verbose ("Failed to move header into new message\n");
4476 _dbus_list_remove_last (&loader->messages, message);
4477 dbus_message_unref (message);
4481 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
4485 _dbus_verbose ("Failed to move body into new message\n");
4487 /* put the header back, we'll try again later */
4488 result = _dbus_string_copy_len (&message->header, 0, header_len,
4490 _dbus_assert (result); /* because DBusString never reallocs smaller */
4492 _dbus_list_remove_last (&loader->messages, message);
4493 dbus_message_unref (message);
4497 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
4498 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
4500 /* Fill in caches (we checked the types of these fields
4503 message->reply_serial = get_uint_field (message,
4504 FIELD_REPLY_SERIAL);
4505 message->client_serial = get_uint_field (message,
4506 FIELD_CLIENT_SERIAL);
4508 _dbus_verbose ("Loaded message %p\n", message);
4518 * Peeks at first loaded message, returns #NULL if no messages have
4521 * @param loader the loader.
4522 * @returns the next message, or #NULL if none.
4525 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
4527 if (loader->messages)
4528 return loader->messages->data;
4534 * Pops a loaded message (passing ownership of the message
4535 * to the caller). Returns #NULL if no messages have been
4538 * @param loader the loader.
4539 * @returns the next message, or #NULL if none.
4542 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
4544 return _dbus_list_pop_first (&loader->messages);
4548 * Pops a loaded message inside a list link (passing ownership of the
4549 * message and link to the caller). Returns #NULL if no messages have
4552 * @param loader the loader.
4553 * @returns the next message link, or #NULL if none.
4556 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
4558 return _dbus_list_pop_first_link (&loader->messages);
4562 * Returns a popped message link, used to undo a pop.
4564 * @param loader the loader
4565 * @param link the link with a message in it
4568 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
4571 _dbus_list_prepend_link (&loader->messages, link);
4575 * Checks whether the loader is confused due to bad data.
4576 * If messages are received that are invalid, the
4577 * loader gets confused and gives up permanently.
4578 * This state is called "corrupted."
4580 * @param loader the loader
4581 * @returns #TRUE if the loader is hosed.
4584 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
4586 return loader->corrupted;
4590 * Sets the maximum size message we allow.
4592 * @param loader the loader
4593 * @param size the max message size in bytes
4596 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
4599 if (size > MAX_SANE_MESSAGE_SIZE)
4601 _dbus_verbose ("clamping requested max message size %ld to %d\n",
4602 size, MAX_SANE_MESSAGE_SIZE);
4603 size = MAX_SANE_MESSAGE_SIZE;
4605 loader->max_message_size = size;
4609 * Gets the maximum allowed message size in bytes.
4611 * @param loader the loader
4612 * @returns max size in bytes
4615 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
4617 return loader->max_message_size;
4620 static DBusDataSlotAllocator slot_allocator;
4621 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
4624 * Allocates an integer ID to be used for storing application-specific
4625 * data on any DBusMessage. The allocated ID may then be used
4626 * with dbus_message_set_data() and dbus_message_get_data().
4627 * The passed-in slot must be initialized to -1, and is filled in
4628 * with the slot ID. If the passed-in slot is not -1, it's assumed
4629 * to be already allocated, and its refcount is incremented.
4631 * The allocated slot is global, i.e. all DBusMessage objects will
4632 * have a slot with the given integer ID reserved.
4634 * @param slot_p address of a global variable storing the slot
4635 * @returns #FALSE on failure (no memory)
4638 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
4640 return _dbus_data_slot_allocator_alloc (&slot_allocator,
4641 _DBUS_LOCK_NAME (message_slots),
4646 * Deallocates a global ID for message data slots.
4647 * dbus_message_get_data() and dbus_message_set_data() may no
4648 * longer be used with this slot. Existing data stored on existing
4649 * DBusMessage objects will be freed when the message is
4650 * finalized, but may not be retrieved (and may only be replaced if
4651 * someone else reallocates the slot). When the refcount on the
4652 * passed-in slot reaches 0, it is set to -1.
4654 * @param slot_p address storing the slot to deallocate
4657 dbus_message_free_data_slot (dbus_int32_t *slot_p)
4659 _dbus_return_if_fail (*slot_p >= 0);
4661 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
4665 * Stores a pointer on a DBusMessage, along
4666 * with an optional function to be used for freeing
4667 * the data when the data is set again, or when
4668 * the message is finalized. The slot number
4669 * must have been allocated with dbus_message_allocate_data_slot().
4671 * @param message the message
4672 * @param slot the slot number
4673 * @param data the data to store
4674 * @param free_data_func finalizer function for the data
4675 * @returns #TRUE if there was enough memory to store the data
4678 dbus_message_set_data (DBusMessage *message,
4681 DBusFreeFunction free_data_func)
4683 DBusFreeFunction old_free_func;
4687 _dbus_return_val_if_fail (message != NULL, FALSE);
4688 _dbus_return_val_if_fail (slot >= 0, FALSE);
4690 retval = _dbus_data_slot_list_set (&slot_allocator,
4691 &message->slot_list,
4692 slot, data, free_data_func,
4693 &old_free_func, &old_data);
4697 /* Do the actual free outside the message lock */
4699 (* old_free_func) (old_data);
4706 * Retrieves data previously set with dbus_message_set_data().
4707 * The slot must still be allocated (must not have been freed).
4709 * @param message the message
4710 * @param slot the slot to get data from
4711 * @returns the data, or #NULL if not found
4714 dbus_message_get_data (DBusMessage *message,
4719 _dbus_return_val_if_fail (message != NULL, NULL);
4721 res = _dbus_data_slot_list_get (&slot_allocator,
4722 &message->slot_list,
4729 #ifdef DBUS_BUILD_TESTS
4730 #include "dbus-test.h"
4734 message_iter_test (DBusMessage *message)
4736 DBusMessageIter iter, dict, array, array2;
4738 unsigned char *data;
4739 dbus_int32_t *our_int_array;
4742 dbus_message_iter_init (message, &iter);
4745 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
4746 _dbus_assert_not_reached ("Argument type isn't string");
4748 str = dbus_message_iter_get_string (&iter);
4749 if (strcmp (str, "Test string") != 0)
4750 _dbus_assert_not_reached ("Strings differ");
4753 if (!dbus_message_iter_next (&iter))
4754 _dbus_assert_not_reached ("Reached end of arguments");
4756 /* Signed integer tests */
4757 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
4758 _dbus_assert_not_reached ("Argument type isn't int32");
4760 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
4761 _dbus_assert_not_reached ("Signed integers differ");
4763 if (!dbus_message_iter_next (&iter))
4764 _dbus_assert_not_reached ("Reached end of fields");
4766 /* Unsigned integer tests */
4767 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
4768 _dbus_assert_not_reached ("Argument type isn't int32");
4770 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
4771 _dbus_assert_not_reached ("Unsigned integers differ");
4773 if (!dbus_message_iter_next (&iter))
4774 _dbus_assert_not_reached ("Reached end of arguments");
4777 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
4778 _dbus_assert_not_reached ("Argument type isn't double");
4780 if (dbus_message_iter_get_double (&iter) != 3.14159)
4781 _dbus_assert_not_reached ("Doubles differ");
4783 if (!dbus_message_iter_next (&iter))
4784 _dbus_assert_not_reached ("Reached end of arguments");
4786 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
4787 _dbus_assert_not_reached ("Argument type not an array");
4789 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
4790 _dbus_assert_not_reached ("Array type not double");
4793 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
4794 _dbus_assert_not_reached ("Array init failed");
4796 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4797 _dbus_assert_not_reached ("Argument type isn't double");
4799 if (dbus_message_iter_get_double (&array) != 1.5)
4800 _dbus_assert_not_reached ("Unsigned integers differ");
4802 if (!dbus_message_iter_next (&array))
4803 _dbus_assert_not_reached ("Reached end of arguments");
4805 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4806 _dbus_assert_not_reached ("Argument type isn't double");
4808 if (dbus_message_iter_get_double (&array) != 2.5)
4809 _dbus_assert_not_reached ("Unsigned integers differ");
4811 if (dbus_message_iter_next (&array))
4812 _dbus_assert_not_reached ("Didn't reach end of arguments");
4814 if (!dbus_message_iter_next (&iter))
4815 _dbus_assert_not_reached ("Reached end of arguments");
4820 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
4821 _dbus_assert_not_reached ("not dict type");
4823 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
4824 _dbus_assert_not_reached ("dict iter failed");
4826 str = dbus_message_iter_get_dict_key (&dict);
4827 if (str == NULL || strcmp (str, "test") != 0)
4828 _dbus_assert_not_reached ("wrong dict key");
4831 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
4832 _dbus_assert_not_reached ("wrong dict entry type");
4834 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
4835 _dbus_assert_not_reached ("wrong dict entry value");
4837 if (!dbus_message_iter_next (&dict))
4838 _dbus_assert_not_reached ("reached end of dict");
4840 /* array of array of int32 (in dict) */
4842 str = dbus_message_iter_get_dict_key (&dict);
4843 if (str == NULL || strcmp (str, "array") != 0)
4844 _dbus_assert_not_reached ("wrong dict key");
4847 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
4848 _dbus_assert_not_reached ("Argument type not an array");
4850 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
4851 _dbus_assert_not_reached ("Array type not array");
4853 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
4854 _dbus_assert_not_reached ("Array init failed");
4856 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
4857 _dbus_assert_not_reached ("Argument type isn't array");
4859 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4860 _dbus_assert_not_reached ("Array type not int32");
4862 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
4863 _dbus_assert_not_reached ("Array init failed");
4865 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
4866 _dbus_assert_not_reached ("Argument type isn't int32");
4868 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
4869 _dbus_assert_not_reached ("Signed integers differ");
4871 if (!dbus_message_iter_next (&array2))
4872 _dbus_assert_not_reached ("Reached end of arguments");
4874 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
4875 _dbus_assert_not_reached ("Signed integers differ");
4877 if (dbus_message_iter_next (&array2))
4878 _dbus_assert_not_reached ("Didn't reached end of arguments");
4880 if (!dbus_message_iter_next (&array))
4881 _dbus_assert_not_reached ("Reached end of arguments");
4883 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4884 _dbus_assert_not_reached ("Array type not int32");
4886 if (!dbus_message_iter_get_int32_array (&array,
4889 _dbus_assert_not_reached ("couldn't get int32 array");
4891 _dbus_assert (len == 3);
4892 _dbus_assert (our_int_array[0] == 0x34567812 &&
4893 our_int_array[1] == 0x45678123 &&
4894 our_int_array[2] == 0x56781234);
4895 dbus_free (our_int_array);
4897 if (dbus_message_iter_next (&array))
4898 _dbus_assert_not_reached ("Didn't reach end of array");
4900 if (dbus_message_iter_next (&dict))
4901 _dbus_assert_not_reached ("Didn't reach end of dict");
4903 if (!dbus_message_iter_next (&iter))
4904 _dbus_assert_not_reached ("Reached end of arguments");
4906 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
4908 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
4909 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
4912 if (dbus_message_iter_get_byte (&iter) != 0xF0)
4913 _dbus_assert_not_reached ("wrong value after dict");
4916 if (!dbus_message_iter_next (&iter))
4917 _dbus_assert_not_reached ("Reached end of arguments");
4919 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
4920 _dbus_assert_not_reached ("not a nil type");
4922 if (!dbus_message_iter_next (&iter))
4923 _dbus_assert_not_reached ("Reached end of arguments");
4925 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
4926 _dbus_assert_not_reached ("wrong type after dict");
4928 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
4929 _dbus_assert_not_reached ("failed to get named");
4931 _dbus_assert (strcmp (str, "named")==0);
4932 _dbus_assert (len == 5);
4933 _dbus_assert (strcmp (data, "data")==0);
4937 if (dbus_message_iter_next (&iter))
4938 _dbus_assert_not_reached ("Didn't reach end of arguments");
4943 check_message_handling_type (DBusMessageIter *iter,
4946 DBusMessageIter child_iter;
4952 case DBUS_TYPE_BYTE:
4953 dbus_message_iter_get_byte (iter);
4955 case DBUS_TYPE_BOOLEAN:
4956 dbus_message_iter_get_boolean (iter);
4958 case DBUS_TYPE_INT32:
4959 dbus_message_iter_get_int32 (iter);
4961 case DBUS_TYPE_UINT32:
4962 dbus_message_iter_get_uint32 (iter);
4964 case DBUS_TYPE_INT64:
4965 #ifdef DBUS_HAVE_INT64
4966 dbus_message_iter_get_int64 (iter);
4969 case DBUS_TYPE_UINT64:
4970 #ifdef DBUS_HAVE_INT64
4971 dbus_message_iter_get_uint64 (iter);
4974 case DBUS_TYPE_DOUBLE:
4975 dbus_message_iter_get_double (iter);
4977 case DBUS_TYPE_STRING:
4980 str = dbus_message_iter_get_string (iter);
4983 _dbus_warn ("NULL string in message\n");
4989 case DBUS_TYPE_NAMED:
4992 unsigned char *data;
4995 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
4997 _dbus_warn ("error reading name from named type\n");
5004 case DBUS_TYPE_ARRAY:
5008 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
5010 _dbus_warn ("Failed to init array iterator\n");
5014 while (dbus_message_iter_has_next (&child_iter))
5016 if (!check_message_handling_type (&child_iter, array_type))
5018 _dbus_warn ("error in array element\n");
5022 if (!dbus_message_iter_next (&child_iter))
5027 case DBUS_TYPE_DICT:
5032 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
5034 _dbus_warn ("Failed to init dict iterator\n");
5038 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5040 key = dbus_message_iter_get_dict_key (&child_iter);
5043 _dbus_warn ("error reading dict key\n");
5048 if (!check_message_handling_type (&child_iter, entry_type))
5050 _dbus_warn ("error in dict value\n");
5054 if (!dbus_message_iter_next (&child_iter))
5061 _dbus_warn ("unknown type %d\n", type);
5070 check_message_handling (DBusMessage *message)
5072 DBusMessageIter iter;
5075 dbus_uint32_t client_serial;
5079 client_serial = dbus_message_get_serial (message);
5081 /* can't use set_serial due to the assertions at the start of it */
5082 set_uint_field (message, FIELD_CLIENT_SERIAL,
5085 if (client_serial != dbus_message_get_serial (message))
5087 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5091 /* If we implement message_set_arg (message, n, value)
5092 * then we would want to test it here
5095 dbus_message_iter_init (message, &iter);
5096 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5098 if (!check_message_handling_type (&iter, type))
5101 if (!dbus_message_iter_next (&iter))
5112 check_have_valid_message (DBusMessageLoader *loader)
5114 DBusMessage *message;
5120 if (!_dbus_message_loader_queue_messages (loader))
5121 _dbus_assert_not_reached ("no memory to queue messages");
5123 if (_dbus_message_loader_get_is_corrupted (loader))
5125 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5129 message = _dbus_message_loader_pop_message (loader);
5130 if (message == NULL)
5132 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5136 if (_dbus_string_get_length (&loader->data) > 0)
5138 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5142 /* Verify that we're able to properly deal with the message.
5143 * For example, this would detect improper handling of messages
5144 * in nonstandard byte order.
5146 if (!check_message_handling (message))
5153 dbus_message_unref (message);
5159 check_invalid_message (DBusMessageLoader *loader)
5165 if (!_dbus_message_loader_queue_messages (loader))
5166 _dbus_assert_not_reached ("no memory to queue messages");
5168 if (!_dbus_message_loader_get_is_corrupted (loader))
5170 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
5181 check_incomplete_message (DBusMessageLoader *loader)
5183 DBusMessage *message;
5189 if (!_dbus_message_loader_queue_messages (loader))
5190 _dbus_assert_not_reached ("no memory to queue messages");
5192 if (_dbus_message_loader_get_is_corrupted (loader))
5194 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
5198 message = _dbus_message_loader_pop_message (loader);
5199 if (message != NULL)
5201 _dbus_warn ("loaded message that was expected to be incomplete\n");
5209 dbus_message_unref (message);
5214 check_loader_results (DBusMessageLoader *loader,
5215 DBusMessageValidity validity)
5217 if (!_dbus_message_loader_queue_messages (loader))
5218 _dbus_assert_not_reached ("no memory to queue messages");
5222 case _DBUS_MESSAGE_VALID:
5223 return check_have_valid_message (loader);
5224 case _DBUS_MESSAGE_INVALID:
5225 return check_invalid_message (loader);
5226 case _DBUS_MESSAGE_INCOMPLETE:
5227 return check_incomplete_message (loader);
5228 case _DBUS_MESSAGE_UNKNOWN:
5232 _dbus_assert_not_reached ("bad DBusMessageValidity");
5238 * Loads the message in the given message file.
5240 * @param filename filename to load
5241 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5242 * @param data string to load message into
5243 * @returns #TRUE if the message was loaded
5246 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
5258 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
5259 dbus_error_init (&error);
5260 if (!_dbus_file_get_contents (data, filename, &error))
5262 _dbus_warn ("Could not load message file %s: %s\n",
5263 _dbus_string_get_const_data (filename),
5265 dbus_error_free (&error);
5271 if (!_dbus_message_data_load (data, filename))
5273 _dbus_warn ("Could not load message file %s\n",
5274 _dbus_string_get_const_data (filename));
5287 * Tries loading the message in the given message file
5288 * and verifies that DBusMessageLoader can handle it.
5290 * @param filename filename to load
5291 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5292 * @param expected_validity what the message has to be like to return #TRUE
5293 * @returns #TRUE if the message has the expected validity
5296 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
5298 DBusMessageValidity expected_validity)
5305 if (!_dbus_string_init (&data))
5306 _dbus_assert_not_reached ("could not allocate string\n");
5308 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
5312 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
5318 if (_dbus_string_get_length (&data) > 0)
5319 _dbus_verbose_bytes_of_string (&data, 0,
5320 _dbus_string_get_length (&data));
5322 _dbus_warn ("Failed message loader test on %s\n",
5323 _dbus_string_get_const_data (filename));
5326 _dbus_string_free (&data);
5332 * Tries loading the given message data.
5335 * @param data the message data
5336 * @param expected_validity what the message has to be like to return #TRUE
5337 * @returns #TRUE if the message has the expected validity
5340 dbus_internal_do_not_use_try_message_data (const DBusString *data,
5341 DBusMessageValidity expected_validity)
5343 DBusMessageLoader *loader;
5351 /* Write the data one byte at a time */
5353 loader = _dbus_message_loader_new ();
5355 /* check some trivial loader functions */
5356 _dbus_message_loader_ref (loader);
5357 _dbus_message_loader_unref (loader);
5358 _dbus_message_loader_get_max_message_size (loader);
5360 len = _dbus_string_get_length (data);
5361 for (i = 0; i < len; i++)
5365 _dbus_message_loader_get_buffer (loader, &buffer);
5366 _dbus_string_append_byte (buffer,
5367 _dbus_string_get_byte (data, i));
5368 _dbus_message_loader_return_buffer (loader, buffer, 1);
5371 if (!check_loader_results (loader, expected_validity))
5374 _dbus_message_loader_unref (loader);
5377 /* Write the data all at once */
5379 loader = _dbus_message_loader_new ();
5384 _dbus_message_loader_get_buffer (loader, &buffer);
5385 _dbus_string_copy (data, 0, buffer,
5386 _dbus_string_get_length (buffer));
5387 _dbus_message_loader_return_buffer (loader, buffer, 1);
5390 if (!check_loader_results (loader, expected_validity))
5393 _dbus_message_loader_unref (loader);
5396 /* Write the data 2 bytes at a time */
5398 loader = _dbus_message_loader_new ();
5400 len = _dbus_string_get_length (data);
5401 for (i = 0; i < len; i += 2)
5405 _dbus_message_loader_get_buffer (loader, &buffer);
5406 _dbus_string_append_byte (buffer,
5407 _dbus_string_get_byte (data, i));
5409 _dbus_string_append_byte (buffer,
5410 _dbus_string_get_byte (data, i+1));
5411 _dbus_message_loader_return_buffer (loader, buffer, 1);
5414 if (!check_loader_results (loader, expected_validity))
5417 _dbus_message_loader_unref (loader);
5425 _dbus_message_loader_unref (loader);
5431 process_test_subdir (const DBusString *test_base_dir,
5433 DBusMessageValidity validity,
5434 DBusForeachMessageFileFunc function,
5437 DBusString test_directory;
5438 DBusString filename;
5446 if (!_dbus_string_init (&test_directory))
5447 _dbus_assert_not_reached ("didn't allocate test_directory\n");
5449 _dbus_string_init_const (&filename, subdir);
5451 if (!_dbus_string_copy (test_base_dir, 0,
5452 &test_directory, 0))
5453 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
5455 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
5456 _dbus_assert_not_reached ("couldn't allocate full path");
5458 _dbus_string_free (&filename);
5459 if (!_dbus_string_init (&filename))
5460 _dbus_assert_not_reached ("didn't allocate filename string\n");
5462 dbus_error_init (&error);
5463 dir = _dbus_directory_open (&test_directory, &error);
5466 _dbus_warn ("Could not open %s: %s\n",
5467 _dbus_string_get_const_data (&test_directory),
5469 dbus_error_free (&error);
5473 printf ("Testing:\n");
5476 while (_dbus_directory_get_next_file (dir, &filename, &error))
5478 DBusString full_path;
5481 if (!_dbus_string_init (&full_path))
5482 _dbus_assert_not_reached ("couldn't init string");
5484 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
5485 _dbus_assert_not_reached ("couldn't copy dir to full_path");
5487 if (!_dbus_concat_dir_and_file (&full_path, &filename))
5488 _dbus_assert_not_reached ("couldn't concat file to dir");
5490 if (_dbus_string_ends_with_c_str (&filename, ".message"))
5492 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
5496 _dbus_verbose ("Skipping non-.message file %s\n",
5497 _dbus_string_get_const_data (&filename));
5498 _dbus_string_free (&full_path);
5503 _dbus_string_get_const_data (&filename));
5505 _dbus_verbose (" expecting %s\n",
5506 validity == _DBUS_MESSAGE_VALID ? "valid" :
5507 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
5508 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
5510 if (! (*function) (&full_path, is_raw, validity, user_data))
5512 _dbus_string_free (&full_path);
5516 _dbus_string_free (&full_path);
5519 if (dbus_error_is_set (&error))
5521 _dbus_warn ("Could not get next file in %s: %s\n",
5522 _dbus_string_get_const_data (&test_directory),
5524 dbus_error_free (&error);
5533 _dbus_directory_close (dir);
5534 _dbus_string_free (&test_directory);
5535 _dbus_string_free (&filename);
5541 * Runs the given function on every message file in the test suite.
5542 * The function should return #FALSE on test failure or fatal error.
5544 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
5545 * @param func the function to run
5546 * @param user_data data for function
5547 * @returns #FALSE if there's a failure
5550 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
5551 DBusForeachMessageFileFunc func,
5554 DBusString test_directory;
5559 _dbus_string_init_const (&test_directory, test_data_dir);
5561 if (!process_test_subdir (&test_directory, "valid-messages",
5562 _DBUS_MESSAGE_VALID, func, user_data))
5565 if (!process_test_subdir (&test_directory, "invalid-messages",
5566 _DBUS_MESSAGE_INVALID, func, user_data))
5569 if (!process_test_subdir (&test_directory, "incomplete-messages",
5570 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
5577 _dbus_string_free (&test_directory);
5583 verify_test_message (DBusMessage *message)
5585 DBusMessageIter iter, dict;
5587 dbus_int32_t our_int;
5590 dbus_bool_t our_bool;
5591 dbus_uint32_t our_uint32;
5592 dbus_int32_t *our_uint32_array;
5593 int our_uint32_array_len;
5594 dbus_int32_t *our_int32_array;
5595 int our_int32_array_len;
5596 char **our_string_array;
5597 int our_string_array_len;
5598 #ifdef DBUS_HAVE_INT64
5599 dbus_int64_t our_int64;
5600 dbus_uint64_t our_uint64;
5601 dbus_int64_t *our_uint64_array;
5602 int our_uint64_array_len;
5603 dbus_int64_t *our_int64_array;
5604 int our_int64_array_len;
5606 double *our_double_array;
5607 int our_double_array_len;
5608 unsigned char *our_byte_array;
5609 int our_byte_array_len;
5610 unsigned char *our_boolean_array;
5611 int our_boolean_array_len;
5613 dbus_message_iter_init (message, &iter);
5615 dbus_error_init (&error);
5616 if (!dbus_message_iter_get_args (&iter, &error,
5617 DBUS_TYPE_INT32, &our_int,
5618 #ifdef DBUS_HAVE_INT64
5619 DBUS_TYPE_INT64, &our_int64,
5620 DBUS_TYPE_UINT64, &our_uint64,
5622 DBUS_TYPE_STRING, &our_str,
5623 DBUS_TYPE_DOUBLE, &our_double,
5624 DBUS_TYPE_BOOLEAN, &our_bool,
5625 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
5626 &our_uint32_array, &our_uint32_array_len,
5627 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
5628 &our_int32_array, &our_int32_array_len,
5629 #ifdef DBUS_HAVE_INT64
5630 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
5631 &our_uint64_array, &our_uint64_array_len,
5632 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
5633 &our_int64_array, &our_int64_array_len,
5635 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
5636 &our_string_array, &our_string_array_len,
5637 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
5638 &our_double_array, &our_double_array_len,
5639 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
5640 &our_byte_array, &our_byte_array_len,
5641 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
5642 &our_boolean_array, &our_boolean_array_len,
5645 _dbus_warn ("error: %s - %s\n", error.name,
5646 (error.message != NULL) ? error.message : "no message");
5647 _dbus_assert_not_reached ("Could not get arguments");
5650 if (our_int != -0x12345678)
5651 _dbus_assert_not_reached ("integers differ!");
5653 #ifdef DBUS_HAVE_INT64
5654 if (our_int64 != -0x123456789abcd)
5655 _dbus_assert_not_reached ("64-bit integers differ!");
5656 if (our_uint64 != 0x123456789abcd)
5657 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
5660 if (our_double != 3.14159)
5661 _dbus_assert_not_reached ("doubles differ!");
5663 if (strcmp (our_str, "Test string") != 0)
5664 _dbus_assert_not_reached ("strings differ!");
5665 dbus_free (our_str);
5668 _dbus_assert_not_reached ("booleans differ");
5670 if (our_uint32_array_len != 4 ||
5671 our_uint32_array[0] != 0x12345678 ||
5672 our_uint32_array[1] != 0x23456781 ||
5673 our_uint32_array[2] != 0x34567812 ||
5674 our_uint32_array[3] != 0x45678123)
5675 _dbus_assert_not_reached ("uint array differs");
5676 dbus_free (our_uint32_array);
5678 if (our_int32_array_len != 4 ||
5679 our_int32_array[0] != 0x12345678 ||
5680 our_int32_array[1] != -0x23456781 ||
5681 our_int32_array[2] != 0x34567812 ||
5682 our_int32_array[3] != -0x45678123)
5683 _dbus_assert_not_reached ("int array differs");
5684 dbus_free (our_int32_array);
5686 #ifdef DBUS_HAVE_INT64
5687 if (our_uint64_array_len != 4 ||
5688 our_uint64_array[0] != 0x12345678 ||
5689 our_uint64_array[1] != 0x23456781 ||
5690 our_uint64_array[2] != 0x34567812 ||
5691 our_uint64_array[3] != 0x45678123)
5692 _dbus_assert_not_reached ("uint64 array differs");
5693 dbus_free (our_uint64_array);
5695 if (our_int64_array_len != 4 ||
5696 our_int64_array[0] != 0x12345678 ||
5697 our_int64_array[1] != -0x23456781 ||
5698 our_int64_array[2] != 0x34567812 ||
5699 our_int64_array[3] != -0x45678123)
5700 _dbus_assert_not_reached ("int64 array differs");
5701 dbus_free (our_int64_array);
5702 #endif /* DBUS_HAVE_INT64 */
5704 if (our_string_array_len != 4)
5705 _dbus_assert_not_reached ("string array has wrong length");
5707 if (strcmp (our_string_array[0], "Foo") != 0 ||
5708 strcmp (our_string_array[1], "bar") != 0 ||
5709 strcmp (our_string_array[2], "") != 0 ||
5710 strcmp (our_string_array[3], "woo woo woo woo") != 0)
5711 _dbus_assert_not_reached ("string array differs");
5713 dbus_free_string_array (our_string_array);
5715 if (our_double_array_len != 3)
5716 _dbus_assert_not_reached ("double array had wrong length");
5718 /* On all IEEE machines (i.e. everything sane) exact equality
5719 * should be preserved over the wire
5721 if (our_double_array[0] != 0.1234 ||
5722 our_double_array[1] != 9876.54321 ||
5723 our_double_array[2] != -300.0)
5724 _dbus_assert_not_reached ("double array had wrong values");
5726 dbus_free (our_double_array);
5728 if (our_byte_array_len != 4)
5729 _dbus_assert_not_reached ("byte array had wrong length");
5731 if (our_byte_array[0] != 'a' ||
5732 our_byte_array[1] != 'b' ||
5733 our_byte_array[2] != 'c' ||
5734 our_byte_array[3] != 234)
5735 _dbus_assert_not_reached ("byte array had wrong values");
5737 dbus_free (our_byte_array);
5739 if (our_boolean_array_len != 5)
5740 _dbus_assert_not_reached ("bool array had wrong length");
5742 if (our_boolean_array[0] != TRUE ||
5743 our_boolean_array[1] != FALSE ||
5744 our_boolean_array[2] != TRUE ||
5745 our_boolean_array[3] != TRUE ||
5746 our_boolean_array[4] != FALSE)
5747 _dbus_assert_not_reached ("bool array had wrong values");
5749 dbus_free (our_boolean_array);
5751 if (!dbus_message_iter_next (&iter))
5752 _dbus_assert_not_reached ("Reached end of arguments");
5754 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5755 _dbus_assert_not_reached ("not dict type");
5757 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
5758 _dbus_assert_not_reached ("dict iter failed");
5760 our_str = dbus_message_iter_get_dict_key (&dict);
5761 if (our_str == NULL || strcmp (our_str, "test") != 0)
5762 _dbus_assert_not_reached ("wrong dict key");
5763 dbus_free (our_str);
5765 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5767 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
5768 _dbus_assert_not_reached ("wrong dict entry type");
5771 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
5773 _dbus_verbose ("dict entry val: %x\n", our_uint32);
5774 _dbus_assert_not_reached ("wrong dict entry value");
5777 if (dbus_message_iter_next (&dict))
5778 _dbus_assert_not_reached ("Didn't reach end of dict");
5780 if (!dbus_message_iter_next (&iter))
5781 _dbus_assert_not_reached ("Reached end of arguments");
5783 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5784 _dbus_assert_not_reached ("wrong type after dict");
5786 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
5787 _dbus_assert_not_reached ("wrong value after dict");
5789 if (dbus_message_iter_next (&iter))
5790 _dbus_assert_not_reached ("Didn't reach end of arguments");
5794 * @ingroup DBusMessageInternals
5795 * Unit test for DBusMessage.
5797 * @returns #TRUE on success.
5800 _dbus_message_test (const char *test_data_dir)
5802 DBusMessage *message;
5803 DBusMessageLoader *loader;
5804 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
5810 const dbus_uint32_t our_uint32_array[] =
5811 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5812 const dbus_uint32_t our_int32_array[] =
5813 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5814 #ifdef DBUS_HAVE_INT64
5815 const dbus_uint64_t our_uint64_array[] =
5816 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5817 const dbus_uint64_t our_int64_array[] =
5818 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5820 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
5821 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
5822 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
5823 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
5825 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
5827 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5828 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5829 _dbus_message_set_serial (message, 1234);
5830 dbus_message_set_sender (message, "org.foo.bar");
5831 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar"));
5832 dbus_message_set_sender (message, NULL);
5833 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar"));
5834 _dbus_assert (dbus_message_get_serial (message) == 1234);
5835 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5837 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5838 dbus_message_set_is_error (message, TRUE);
5839 _dbus_assert (dbus_message_get_is_error (message) == TRUE);
5840 dbus_message_set_is_error (message, FALSE);
5841 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5843 dbus_message_unref (message);
5845 /* Test the vararg functions */
5846 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5847 _dbus_message_set_serial (message, 1);
5848 dbus_message_append_args (message,
5849 DBUS_TYPE_INT32, -0x12345678,
5850 #ifdef DBUS_HAVE_INT64
5851 DBUS_TYPE_INT64, -0x123456789abcd,
5852 DBUS_TYPE_UINT64, 0x123456789abcd,
5854 DBUS_TYPE_STRING, "Test string",
5855 DBUS_TYPE_DOUBLE, 3.14159,
5856 DBUS_TYPE_BOOLEAN, TRUE,
5857 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
5858 _DBUS_N_ELEMENTS (our_uint32_array),
5859 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
5860 _DBUS_N_ELEMENTS (our_int32_array),
5861 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
5862 _DBUS_N_ELEMENTS (our_uint64_array),
5863 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
5864 _DBUS_N_ELEMENTS (our_int64_array),
5865 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
5866 _DBUS_N_ELEMENTS (our_string_array),
5867 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
5868 _DBUS_N_ELEMENTS (our_double_array),
5869 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
5870 _DBUS_N_ELEMENTS (our_byte_array),
5871 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
5872 _DBUS_N_ELEMENTS (our_boolean_array),
5875 dbus_message_append_iter_init (message, &iter);
5876 dbus_message_iter_append_dict (&iter, &child_iter);
5877 dbus_message_iter_append_dict_key (&child_iter, "test");
5878 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
5879 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
5881 _dbus_verbose_bytes_of_string (&message->header, 0,
5882 _dbus_string_get_length (&message->header));
5883 _dbus_verbose_bytes_of_string (&message->body, 0,
5884 _dbus_string_get_length (&message->body));
5886 verify_test_message (message);
5888 copy = dbus_message_copy (message);
5890 _dbus_assert (message->client_serial == copy->client_serial);
5891 _dbus_assert (message->reply_serial == copy->reply_serial);
5892 _dbus_assert (message->header_padding == copy->header_padding);
5894 _dbus_assert (_dbus_string_get_length (&message->header) ==
5895 _dbus_string_get_length (©->header));
5897 _dbus_assert (_dbus_string_get_length (&message->body) ==
5898 _dbus_string_get_length (©->body));
5900 verify_test_message (copy);
5902 name1 = dbus_message_get_name (message);
5903 name2 = dbus_message_get_name (copy);
5905 _dbus_assert (strcmp (name1, name2) == 0);
5907 dbus_message_unref (message);
5908 dbus_message_unref (copy);
5910 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5911 _dbus_message_set_serial (message, 1);
5912 dbus_message_set_reply_serial (message, 0x12345678);
5914 dbus_message_append_iter_init (message, &iter);
5915 dbus_message_iter_append_string (&iter, "Test string");
5916 dbus_message_iter_append_int32 (&iter, -0x12345678);
5917 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
5918 dbus_message_iter_append_double (&iter, 3.14159);
5920 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
5921 dbus_message_iter_append_double (&child_iter, 1.5);
5922 dbus_message_iter_append_double (&child_iter, 2.5);
5925 dbus_message_iter_append_dict (&iter, &child_iter);
5926 dbus_message_iter_append_dict_key (&child_iter, "test");
5927 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
5929 /* array of array of int32 (in dict) */
5930 dbus_message_iter_append_dict_key (&child_iter, "array");
5931 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
5932 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
5933 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
5934 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
5935 _dbus_warn ("next call expected to fail with wrong array type\n");
5936 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
5937 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
5938 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
5939 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
5940 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
5942 dbus_message_iter_append_byte (&iter, 0xF0);
5944 dbus_message_iter_append_nil (&iter);
5946 dbus_message_iter_append_named (&iter, "named",
5949 message_iter_test (message);
5951 /* Message loader test */
5952 _dbus_message_lock (message);
5953 loader = _dbus_message_loader_new ();
5955 /* check ref/unref */
5956 _dbus_message_loader_ref (loader);
5957 _dbus_message_loader_unref (loader);
5959 /* Write the header data one byte at a time */
5960 data = _dbus_string_get_const_data (&message->header);
5961 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
5965 _dbus_message_loader_get_buffer (loader, &buffer);
5966 _dbus_string_append_byte (buffer, data[i]);
5967 _dbus_message_loader_return_buffer (loader, buffer, 1);
5970 /* Write the body data one byte at a time */
5971 data = _dbus_string_get_const_data (&message->body);
5972 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
5976 _dbus_message_loader_get_buffer (loader, &buffer);
5977 _dbus_string_append_byte (buffer, data[i]);
5978 _dbus_message_loader_return_buffer (loader, buffer, 1);
5981 dbus_message_unref (message);
5983 /* Now pop back the message */
5984 if (!_dbus_message_loader_queue_messages (loader))
5985 _dbus_assert_not_reached ("no memory to queue messages");
5987 if (_dbus_message_loader_get_is_corrupted (loader))
5988 _dbus_assert_not_reached ("message loader corrupted");
5990 message = _dbus_message_loader_pop_message (loader);
5992 _dbus_assert_not_reached ("received a NULL message");
5994 if (dbus_message_get_reply_serial (message) != 0x12345678)
5995 _dbus_assert_not_reached ("reply serial fields differ");
5997 message_iter_test (message);
5999 dbus_message_unref (message);
6000 _dbus_message_loader_unref (loader);
6002 /* Now load every message in test_data_dir if we have one */
6003 if (test_data_dir == NULL)
6006 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6007 (DBusForeachMessageFileFunc)
6008 dbus_internal_do_not_use_try_message_file,
6012 #endif /* DBUS_BUILD_TESTS */