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].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].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 * @param name name of the message
953 * @param destination_service service that the message should be sent to or #NULL
954 * @returns a new DBusMessage, free with dbus_message_unref()
955 * @see dbus_message_unref()
958 dbus_message_new (const char *name,
959 const char *destination_service)
961 DBusMessage *message;
963 _dbus_return_val_if_fail (name != NULL, NULL);
965 message = dbus_message_new_empty_header ();
969 if (!dbus_message_create_header (message, name, destination_service))
971 dbus_message_unref (message);
979 * Constructs a message that is a reply to some other
980 * message. Returns #NULL if memory can't be allocated
983 * @param original_message the message which the created
984 * message is a reply to.
985 * @returns a new DBusMessage, free with dbus_message_unref()
986 * @see dbus_message_new(), dbus_message_unref()
989 dbus_message_new_reply (DBusMessage *original_message)
991 DBusMessage *message;
992 const char *sender, *name;
994 _dbus_return_val_if_fail (original_message != NULL, NULL);
996 sender = get_string_field (original_message,
998 name = get_string_field (original_message,
1001 /* sender is allowed to be null here in peer-to-peer case */
1003 message = dbus_message_new (name, sender);
1005 if (message == NULL)
1008 if (!dbus_message_set_reply_serial (message,
1009 dbus_message_get_serial (original_message)))
1011 dbus_message_unref (message);
1019 * Creates a new message that is an error reply to a certain message.
1021 * @param original_message the original message
1022 * @param error_name the error name
1023 * @param error_message the error message string or #NULL for none
1024 * @returns a new error message
1027 dbus_message_new_error_reply (DBusMessage *original_message,
1028 const char *error_name,
1029 const char *error_message)
1031 DBusMessage *message;
1033 DBusMessageIter iter;
1035 _dbus_return_val_if_fail (original_message != NULL, NULL);
1036 _dbus_return_val_if_fail (error_name != NULL, NULL);
1038 sender = get_string_field (original_message,
1039 FIELD_SENDER, NULL);
1041 /* sender may be NULL for non-message-bus case or
1042 * when the message bus is dealing with an unregistered
1046 message = dbus_message_new (error_name, sender);
1048 if (message == NULL)
1051 if (!dbus_message_set_reply_serial (message,
1052 dbus_message_get_serial (original_message)))
1054 dbus_message_unref (message);
1058 if (error_message != NULL)
1060 dbus_message_append_iter_init (message, &iter);
1061 if (!dbus_message_iter_append_string (&iter, error_message))
1063 dbus_message_unref (message);
1068 dbus_message_set_is_error (message, TRUE);
1074 * Creates a new message that is an exact replica of the message
1075 * specified, except that its refcount is set to 1.
1077 * @param message the message.
1078 * @returns the new message.
1081 dbus_message_copy (const DBusMessage *message)
1083 DBusMessage *retval;
1086 _dbus_return_val_if_fail (message != NULL, NULL);
1088 retval = dbus_new0 (DBusMessage, 1);
1092 retval->refcount.value = 1;
1093 retval->byte_order = message->byte_order;
1094 retval->client_serial = message->client_serial;
1095 retval->reply_serial = message->reply_serial;
1096 retval->header_padding = message->header_padding;
1097 retval->locked = FALSE;
1099 if (!_dbus_string_init (&retval->header))
1105 if (!_dbus_string_init (&retval->body))
1107 _dbus_string_free (&retval->header);
1112 if (!_dbus_string_copy (&message->header, 0,
1113 &retval->header, 0))
1115 _dbus_string_free (&retval->header);
1116 _dbus_string_free (&retval->body);
1122 if (!_dbus_string_copy (&message->body, 0,
1125 _dbus_string_free (&retval->header);
1126 _dbus_string_free (&retval->body);
1132 for (i = 0; i < FIELD_LAST; i++)
1134 retval->header_fields[i].offset = message->header_fields[i].offset;
1142 * Increments the reference count of a DBusMessage.
1144 * @param message The message
1145 * @see dbus_message_unref
1148 dbus_message_ref (DBusMessage *message)
1150 dbus_int32_t old_refcount;
1152 _dbus_return_if_fail (message != NULL);
1154 old_refcount = _dbus_atomic_inc (&message->refcount);
1155 _dbus_assert (old_refcount >= 1);
1159 free_size_counter (void *element,
1162 DBusCounter *counter = element;
1163 DBusMessage *message = data;
1165 _dbus_counter_adjust (counter, - message->size_counter_delta);
1167 _dbus_counter_unref (counter);
1171 * Decrements the reference count of a DBusMessage.
1173 * @param message The message
1174 * @see dbus_message_ref
1177 dbus_message_unref (DBusMessage *message)
1179 dbus_int32_t old_refcount;
1181 _dbus_return_if_fail (message != NULL);
1183 old_refcount = _dbus_atomic_dec (&message->refcount);
1185 _dbus_assert (old_refcount >= 0);
1187 if (old_refcount == 1)
1189 /* This calls application callbacks! */
1190 _dbus_data_slot_list_free (&message->slot_list);
1192 _dbus_list_foreach (&message->size_counters,
1193 free_size_counter, message);
1194 _dbus_list_clear (&message->size_counters);
1196 _dbus_string_free (&message->header);
1197 _dbus_string_free (&message->body);
1199 dbus_free (message);
1204 * Gets the name of a message.
1206 * @param message the message
1207 * @returns the message name (should not be freed)
1210 dbus_message_get_name (DBusMessage *message)
1212 _dbus_return_val_if_fail (message != NULL, NULL);
1214 return get_string_field (message, FIELD_NAME, NULL);
1218 * Gets the destination service of a message.
1220 * @param message the message
1221 * @returns the message destination service (should not be freed)
1224 dbus_message_get_destination (DBusMessage *message)
1226 _dbus_return_val_if_fail (message != NULL, NULL);
1228 return get_string_field (message, FIELD_SERVICE, NULL);
1232 * Appends fields to a message given a variable argument list. The
1233 * variable argument list should contain the type of the argument
1234 * followed by the value to add. Array values are specified by an int
1235 * typecode followed by a pointer to the array followed by an int
1236 * giving the length of the array. The argument list must be
1237 * terminated with #DBUS_TYPE_INVALID.
1239 * This function doesn't support dicts or non-fundamental arrays.
1241 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1242 * only if #DBUS_HAVE_INT64 is defined.
1244 * @param message the message
1245 * @param first_arg_type type of the first argument
1246 * @param ... value of first argument, list of additional type-value pairs
1247 * @returns #TRUE on success
1250 dbus_message_append_args (DBusMessage *message,
1257 _dbus_return_val_if_fail (message != NULL, FALSE);
1259 va_start (var_args, first_arg_type);
1260 retval = dbus_message_append_args_valist (message,
1269 * This function takes a va_list for use by language bindings.
1270 * It's otherwise the same as dbus_message_append_args().
1272 * @todo: Shouldn't this function clean up the changes to the message
1273 * on failures? (Yes)
1275 * @see dbus_message_append_args.
1276 * @param message the message
1277 * @param first_arg_type type of first argument
1278 * @param var_args value of first argument, then list of type/value pairs
1279 * @returns #TRUE on success
1282 dbus_message_append_args_valist (DBusMessage *message,
1287 DBusMessageIter iter;
1289 _dbus_return_val_if_fail (message != NULL, FALSE);
1291 old_len = _dbus_string_get_length (&message->body);
1293 type = first_arg_type;
1295 dbus_message_append_iter_init (message, &iter);
1302 if (!dbus_message_iter_append_nil (&iter))
1305 case DBUS_TYPE_BOOLEAN:
1306 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1309 case DBUS_TYPE_INT32:
1310 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1313 case DBUS_TYPE_UINT32:
1314 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1317 #ifdef DBUS_HAVE_INT64
1318 case DBUS_TYPE_INT64:
1319 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1322 case DBUS_TYPE_UINT64:
1323 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1326 #endif /* DBUS_HAVE_INT64 */
1327 case DBUS_TYPE_DOUBLE:
1328 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1331 case DBUS_TYPE_STRING:
1332 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1335 case DBUS_TYPE_NAMED:
1338 unsigned char *data;
1341 name = va_arg (var_args, const char *);
1342 data = va_arg (var_args, unsigned char *);
1343 len = va_arg (var_args, int);
1345 if (!dbus_message_iter_append_named (&iter, name, data, len))
1349 case DBUS_TYPE_ARRAY:
1354 type = va_arg (var_args, int);
1355 data = va_arg (var_args, void *);
1356 len = va_arg (var_args, int);
1360 case DBUS_TYPE_BYTE:
1361 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1364 case DBUS_TYPE_BOOLEAN:
1365 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1368 case DBUS_TYPE_INT32:
1369 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1372 case DBUS_TYPE_UINT32:
1373 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1376 #ifdef DBUS_HAVE_INT64
1377 case DBUS_TYPE_INT64:
1378 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1381 case DBUS_TYPE_UINT64:
1382 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1385 #endif /* DBUS_HAVE_INT64 */
1386 case DBUS_TYPE_DOUBLE:
1387 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1390 case DBUS_TYPE_STRING:
1391 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1395 case DBUS_TYPE_ARRAY:
1396 case DBUS_TYPE_NAMED:
1397 case DBUS_TYPE_DICT:
1398 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1401 _dbus_warn ("Unknown field type %d\n", type);
1407 case DBUS_TYPE_DICT:
1408 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1411 _dbus_warn ("Unknown field type %d\n", type);
1415 type = va_arg (var_args, int);
1426 * Gets arguments from a message given a variable argument list.
1427 * The variable argument list should contain the type of the
1428 * argumen followed by a pointer to where the value should be
1429 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1431 * @param message the message
1432 * @param error error to be filled in on failure
1433 * @param first_arg_type the first argument type
1434 * @param ... location for first argument value, then list of type-location pairs
1435 * @returns #FALSE if the error was set
1438 dbus_message_get_args (DBusMessage *message,
1446 _dbus_return_val_if_fail (message != NULL, FALSE);
1447 _dbus_return_val_if_error_is_set (error, FALSE);
1449 va_start (var_args, first_arg_type);
1450 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1457 * This function takes a va_list for use by language bindings
1459 * @todo We need to free the argument data when an error occurs.
1461 * @see dbus_message_get_args
1462 * @param message the message
1463 * @param error error to be filled in
1464 * @param first_arg_type type of the first argument
1465 * @param var_args return location for first argument, followed by list of type/location pairs
1466 * @returns #FALSE if error was set
1469 dbus_message_get_args_valist (DBusMessage *message,
1474 DBusMessageIter iter;
1476 _dbus_return_val_if_fail (message != NULL, FALSE);
1477 _dbus_return_val_if_error_is_set (error, FALSE);
1479 dbus_message_iter_init (message, &iter);
1480 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1484 * Gets arguments from a message iterator given a variable argument list.
1485 * The variable argument list should contain the type of the
1486 * argumen followed by a pointer to where the value should be
1487 * stored. The list is terminated with 0.
1489 * @param iter the message iterator
1490 * @param error error to be filled in on failure
1491 * @param first_arg_type the first argument type
1492 * @param ... location for first argument value, then list of type-location pairs
1493 * @returns #FALSE if the error was set
1496 dbus_message_iter_get_args (DBusMessageIter *iter,
1504 _dbus_return_val_if_fail (iter != NULL, FALSE);
1505 _dbus_return_val_if_error_is_set (error, FALSE);
1507 va_start (var_args, first_arg_type);
1508 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1515 * This function takes a va_list for use by language bindings
1517 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1518 * only if #DBUS_HAVE_INT64 is defined.
1520 * @todo this function (or some lower-level non-convenience function)
1521 * needs better error handling; should allow the application to
1522 * distinguish between out of memory, and bad data from the remote
1523 * app. It also needs to not leak a bunch of args when it gets
1524 * to the arg that's bad, as that would be a security hole
1525 * (allow one app to force another to leak memory)
1527 * @todo We need to free the argument data when an error occurs.
1529 * @see dbus_message_get_args
1530 * @param iter the message iter
1531 * @param error error to be filled in
1532 * @param first_arg_type type of the first argument
1533 * @param var_args return location for first argument, followed by list of type/location pairs
1534 * @returns #FALSE if error was set
1537 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1542 int spec_type, msg_type, i;
1545 _dbus_return_val_if_fail (iter != NULL, FALSE);
1546 _dbus_return_val_if_error_is_set (error, FALSE);
1550 spec_type = first_arg_type;
1553 while (spec_type != 0)
1555 msg_type = dbus_message_iter_get_arg_type (iter);
1557 if (msg_type != spec_type)
1559 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1560 "Argument %d is specified to be of type \"%s\", but "
1561 "is actually of type \"%s\"\n", i,
1562 _dbus_type_to_string (spec_type),
1563 _dbus_type_to_string (msg_type));
1572 case DBUS_TYPE_BYTE:
1576 ptr = va_arg (var_args, unsigned char *);
1578 *ptr = dbus_message_iter_get_byte (iter);
1581 case DBUS_TYPE_BOOLEAN:
1585 ptr = va_arg (var_args, dbus_bool_t *);
1587 *ptr = dbus_message_iter_get_boolean (iter);
1590 case DBUS_TYPE_INT32:
1594 ptr = va_arg (var_args, dbus_int32_t *);
1596 *ptr = dbus_message_iter_get_int32 (iter);
1599 case DBUS_TYPE_UINT32:
1603 ptr = va_arg (var_args, dbus_uint32_t *);
1605 *ptr = dbus_message_iter_get_uint32 (iter);
1608 #ifdef DBUS_HAVE_INT64
1609 case DBUS_TYPE_INT64:
1613 ptr = va_arg (var_args, dbus_int64_t *);
1615 *ptr = dbus_message_iter_get_int64 (iter);
1618 case DBUS_TYPE_UINT64:
1622 ptr = va_arg (var_args, dbus_uint64_t *);
1624 *ptr = dbus_message_iter_get_uint64 (iter);
1627 #endif /* DBUS_HAVE_INT64 */
1629 case DBUS_TYPE_DOUBLE:
1633 ptr = va_arg (var_args, double *);
1635 *ptr = dbus_message_iter_get_double (iter);
1639 case DBUS_TYPE_STRING:
1643 ptr = va_arg (var_args, char **);
1645 *ptr = dbus_message_iter_get_string (iter);
1649 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1656 case DBUS_TYPE_NAMED:
1659 unsigned char **data;
1662 name = va_arg (var_args, char **);
1663 data = va_arg (var_args, unsigned char **);
1664 len = va_arg (var_args, int *);
1666 if (!dbus_message_iter_get_named (iter, name, data, len))
1668 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1673 case DBUS_TYPE_ARRAY:
1678 type = va_arg (var_args, int);
1679 data = va_arg (var_args, void *);
1680 len = va_arg (var_args, int *);
1682 if (dbus_message_iter_get_array_type (iter) != type)
1684 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1685 "Argument %d is specified to be of type \"array of %s\", but "
1686 "is actually of type \"array of %s\"\n", i,
1687 _dbus_type_to_string (type),
1688 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
1694 case DBUS_TYPE_BYTE:
1695 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
1697 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1701 case DBUS_TYPE_BOOLEAN:
1702 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
1704 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1708 case DBUS_TYPE_INT32:
1709 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
1711 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1715 case DBUS_TYPE_UINT32:
1716 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
1718 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1722 #ifdef DBUS_HAVE_INT64
1723 case DBUS_TYPE_INT64:
1724 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
1726 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1730 case DBUS_TYPE_UINT64:
1731 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
1733 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1737 #endif /* DBUS_HAVE_INT64 */
1738 case DBUS_TYPE_DOUBLE:
1739 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
1741 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1745 case DBUS_TYPE_STRING:
1746 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
1748 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1753 case DBUS_TYPE_ARRAY:
1754 case DBUS_TYPE_NAMED:
1755 case DBUS_TYPE_DICT:
1756 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
1757 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1760 _dbus_warn ("Unknown field type %d\n", type);
1761 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1766 case DBUS_TYPE_DICT:
1767 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
1768 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1771 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1772 _dbus_warn ("Unknown field type %d\n", spec_type);
1776 spec_type = va_arg (var_args, int);
1777 if (spec_type != 0 && !dbus_message_iter_next (iter))
1779 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1780 "Message has only %d arguments, but more were expected", i);
1796 * Initializes a DBusMessageIter representing the arguments of the
1797 * message passed in.
1799 * @param message the message
1800 * @param iter pointer to an iterator to initialize
1803 dbus_message_iter_init (DBusMessage *message,
1804 DBusMessageIter *iter)
1806 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1808 _dbus_return_if_fail (message != NULL);
1809 _dbus_return_if_fail (iter != NULL);
1811 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
1813 real->message = message;
1814 real->parent_iter = NULL;
1815 real->changed_stamp = message->changed_stamp;
1817 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
1819 real->end = _dbus_string_get_length (&message->body);
1821 real->container_start = 0;
1822 real->container_length_pos = 0;
1823 real->wrote_dict_key = 0;
1824 real->array_type_pos = 0;
1827 #ifndef DBUS_DISABLE_CHECKS
1829 dbus_message_iter_check (DBusMessageRealIter *iter)
1833 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
1837 if (iter->changed_stamp != iter->message->changed_stamp)
1839 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
1843 if (iter->pos < 0 || iter->pos > iter->end)
1845 _dbus_warn ("dbus iterator check failed: invalid position\n");
1851 #endif /* DBUS_DISABLE_CHECKS */
1854 skip_array_type (DBusMessageRealIter *iter, int pos)
1860 data = _dbus_string_get_const_data_len (&iter->message->body,
1863 while (*data == DBUS_TYPE_ARRAY);
1869 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
1876 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
1877 data = _dbus_string_get_const_data_len (&iter->message->body,
1879 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1882 *type = DBUS_TYPE_INVALID;
1884 return skip_array_type (iter, iter->pos);
1886 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
1887 data = _dbus_string_get_const_data_len (&iter->message->body,
1888 iter->array_type_pos, 1);
1889 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1892 *type = DBUS_TYPE_INVALID;
1896 case DBUS_MESSAGE_ITER_TYPE_DICT:
1897 /* Get the length of the string */
1898 len = _dbus_demarshal_uint32 (&iter->message->body,
1899 iter->message->byte_order,
1901 pos = pos + len + 1;
1903 data = _dbus_string_get_const_data_len (&iter->message->body,
1905 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1908 *type = DBUS_TYPE_INVALID;
1910 return skip_array_type (iter, pos);
1913 _dbus_assert_not_reached ("Invalid iter type");
1916 *type = DBUS_TYPE_INVALID;
1922 * Checks if an iterator has any more fields.
1924 * @param iter the message iter
1925 * @returns #TRUE if there are more fields
1929 dbus_message_iter_has_next (DBusMessageIter *iter)
1931 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1935 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
1937 if (real->pos >= real->end)
1940 pos = dbus_message_iter_get_data_start (real, &type);
1942 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1943 real->message->byte_order,
1944 type, pos, &end_pos))
1947 if (end_pos >= real->end)
1954 * Moves the iterator to the next field.
1956 * @param iter The message iter
1957 * @returns #TRUE if the iterator was moved to the next field
1960 dbus_message_iter_next (DBusMessageIter *iter)
1962 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1966 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
1968 pos = dbus_message_iter_get_data_start (real, &type);
1970 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1971 real->message->byte_order,
1972 type, pos, &end_pos))
1975 if (end_pos >= real->end)
1978 real->pos = end_pos;
1984 * Returns the argument type of the argument that the
1985 * message iterator points at.
1987 * @param iter the message iter
1988 * @returns the field type
1991 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
1993 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1996 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
1998 if (real->pos >= real->end)
1999 return DBUS_TYPE_INVALID;
2001 pos = dbus_message_iter_get_data_start (real, &type);
2007 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2010 int _array_type_pos;
2015 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2016 _array_type_pos = iter->pos + 1;
2018 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2019 _array_type_pos = iter->array_type_pos + 1;
2021 case DBUS_MESSAGE_ITER_TYPE_DICT:
2022 /* Get the length of the string */
2023 len = _dbus_demarshal_uint32 (&iter->message->body,
2024 iter->message->byte_order,
2026 pos = pos + len + 1;
2027 data = _dbus_string_get_const_data_len (&iter->message->body,
2029 _array_type_pos = pos + 1;
2032 _dbus_assert_not_reached ("wrong iter type");
2033 return DBUS_TYPE_INVALID;
2036 if (array_type_pos != NULL)
2037 *array_type_pos = _array_type_pos;
2039 data = _dbus_string_get_const_data_len (&iter->message->body,
2040 _array_type_pos, 1);
2041 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2044 return DBUS_TYPE_INVALID;
2049 * Returns the element type of the array that the
2050 * message iterator points at. Note that you need
2051 * to check that the iterator points to an array
2052 * prior to using this function.
2054 * @param iter the message iter
2055 * @returns the field type
2058 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2060 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2063 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2065 if (real->pos >= real->end)
2066 return DBUS_TYPE_INVALID;
2068 pos = dbus_message_iter_get_data_start (real, &type);
2070 _dbus_assert (type == DBUS_TYPE_ARRAY);
2072 return iter_get_array_type (real, NULL);
2077 * Returns the string value that an iterator may point to.
2078 * Note that you need to check that the iterator points to
2079 * a string value before using this function.
2081 * @see dbus_message_iter_get_arg_type
2082 * @param iter the message iter
2083 * @returns the string
2086 dbus_message_iter_get_string (DBusMessageIter *iter)
2088 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2091 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2093 pos = dbus_message_iter_get_data_start (real, &type);
2095 _dbus_assert (type == DBUS_TYPE_STRING);
2097 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2102 * Returns the name and data from a named type that an
2103 * iterator may point to. Note that you need to check that
2104 * the iterator points to a named type before using this
2107 * @see dbus_message_iter_get_arg_type
2108 * @param iter the message iter
2109 * @param name return location for the name
2110 * @param value return location for data
2111 * @param len return location for length of data
2112 * @returns TRUE if get succeed
2116 dbus_message_iter_get_named (DBusMessageIter *iter,
2118 unsigned char **value,
2121 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2125 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2127 pos = dbus_message_iter_get_data_start (real, &type);
2129 _dbus_assert (type == DBUS_TYPE_NAMED);
2131 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2137 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2138 pos + 1, NULL, value, len))
2150 * Returns the byte value that an iterator may point to.
2151 * Note that you need to check that the iterator points to
2152 * a byte value before using this function.
2154 * @see dbus_message_iter_get_arg_type
2155 * @param iter the message iter
2156 * @returns the byte value
2159 dbus_message_iter_get_byte (DBusMessageIter *iter)
2161 unsigned char value;
2162 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2165 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2167 pos = dbus_message_iter_get_data_start (real, &type);
2169 _dbus_assert (type == DBUS_TYPE_BYTE);
2171 value = _dbus_string_get_byte (&real->message->body, pos);
2178 * Returns the boolean value that an iterator may point to.
2179 * Note that you need to check that the iterator points to
2180 * a boolean value before using this function.
2182 * @see dbus_message_iter_get_arg_type
2183 * @param iter the message iter
2184 * @returns the boolean value
2187 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2189 unsigned char value;
2190 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2193 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2195 pos = dbus_message_iter_get_data_start (real, &type);
2197 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2199 value = _dbus_string_get_byte (&real->message->body, pos);
2205 * Returns the 32 bit signed integer value that an iterator may point to.
2206 * Note that you need to check that the iterator points to
2207 * a 32-bit integer value before using this function.
2209 * @see dbus_message_iter_get_arg_type
2210 * @param iter the message iter
2211 * @returns the integer
2214 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2216 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2219 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2221 pos = dbus_message_iter_get_data_start (real, &type);
2223 _dbus_assert (type == DBUS_TYPE_INT32);
2225 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2230 * Returns the 32 bit unsigned integer value that an iterator may point to.
2231 * Note that you need to check that the iterator points to
2232 * a 32-bit unsigned integer value before using this function.
2234 * @see dbus_message_iter_get_arg_type
2235 * @param iter the message iter
2236 * @returns the integer
2239 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2241 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2244 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2246 pos = dbus_message_iter_get_data_start (real, &type);
2248 _dbus_assert (type == DBUS_TYPE_UINT32);
2250 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2254 #ifdef DBUS_HAVE_INT64
2257 * Returns the 64 bit signed integer value that an iterator may point
2258 * to. Note that you need to check that the iterator points to a
2259 * 64-bit integer value before using this function.
2261 * This function only exists if #DBUS_HAVE_INT64 is defined.
2263 * @see dbus_message_iter_get_arg_type
2264 * @param iter the message iter
2265 * @returns the integer
2268 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2270 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2273 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2275 pos = dbus_message_iter_get_data_start (real, &type);
2277 _dbus_assert (type == DBUS_TYPE_INT64);
2279 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2284 * Returns the 64 bit unsigned integer value that an iterator may point to.
2285 * Note that you need to check that the iterator points to
2286 * a 64-bit unsigned integer value before using this function.
2288 * This function only exists if #DBUS_HAVE_INT64 is defined.
2290 * @see dbus_message_iter_get_arg_type
2291 * @param iter the message iter
2292 * @returns the integer
2295 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2297 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2300 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2302 pos = dbus_message_iter_get_data_start (real, &type);
2304 _dbus_assert (type == DBUS_TYPE_UINT64);
2306 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2310 #endif /* DBUS_HAVE_INT64 */
2313 * Returns the double value that an iterator may point to.
2314 * Note that you need to check that the iterator points to
2315 * a string value before using this function.
2317 * @see dbus_message_iter_get_arg_type
2318 * @param iter the message iter
2319 * @returns the double
2322 dbus_message_iter_get_double (DBusMessageIter *iter)
2324 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2327 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2329 pos = dbus_message_iter_get_data_start (real, &type);
2331 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2333 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2338 * Initializes an iterator for the array that the iterator
2339 * may point to. Note that you need to check that the iterator
2340 * points to an array prior to using this function.
2342 * The array element type is returned in array_type, and the array
2343 * iterator can only be used to get that type of data.
2345 * @param iter the iterator
2346 * @param array_iter pointer to an iterator to initialize
2347 * @param array_type gets set to the type of the array elements
2348 * @returns #TRUE on success
2351 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2352 DBusMessageIter *array_iter,
2355 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2356 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2357 int type, pos, len_pos, len, array_type_pos;
2360 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2362 pos = dbus_message_iter_get_data_start (real, &type);
2364 _dbus_assert (type == DBUS_TYPE_ARRAY);
2366 _array_type = iter_get_array_type (real, &array_type_pos);
2368 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2369 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2372 array_real->parent_iter = real;
2373 array_real->message = real->message;
2374 array_real->changed_stamp = real->message->changed_stamp;
2376 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2377 array_real->pos = pos;
2378 array_real->end = pos + len;
2380 array_real->container_start = pos;
2381 array_real->container_length_pos = len_pos;
2382 array_real->wrote_dict_key = 0;
2383 array_real->array_type_pos = array_type_pos;
2384 array_real->array_type_done = TRUE;
2386 if (array_type != NULL)
2387 *array_type = _array_type;
2394 * Initializes an iterator for the dict that the iterator
2395 * may point to. Note that you need to check that the iterator
2396 * points to a dict prior to using this function.
2398 * @param iter the iterator
2399 * @param dict_iter pointer to an iterator to initialize
2400 * @returns #TRUE on success
2403 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2404 DBusMessageIter *dict_iter)
2406 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2407 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2408 int type, pos, len_pos, len;
2410 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2412 pos = dbus_message_iter_get_data_start (real, &type);
2414 _dbus_assert (type == DBUS_TYPE_DICT);
2416 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2417 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2420 dict_real->parent_iter = real;
2421 dict_real->message = real->message;
2422 dict_real->changed_stamp = real->message->changed_stamp;
2424 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2425 dict_real->pos = pos;
2426 dict_real->end = pos + len;
2428 dict_real->container_start = pos;
2429 dict_real->container_length_pos = len_pos;
2430 dict_real->wrote_dict_key = 0;
2436 * Returns the byte array that the iterator may point to.
2437 * Note that you need to check that the iterator points
2438 * to a byte array prior to using this function.
2440 * @param iter the iterator
2441 * @param value return location for array values
2442 * @param len return location for length of byte array
2443 * @returns #TRUE on success
2446 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2447 unsigned char **value,
2450 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2453 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2455 pos = dbus_message_iter_get_data_start (real, &type);
2457 _dbus_assert (type == DBUS_TYPE_ARRAY);
2459 type = iter_get_array_type (real, NULL);
2461 _dbus_assert (type == DBUS_TYPE_BYTE);
2463 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2464 pos, NULL, value, len))
2471 * Returns the boolean array that the iterator may point to. Note that
2472 * you need to check that the iterator points to an array of the
2473 * correct type prior to using this function.
2475 * @param iter the iterator
2476 * @param value return location for the array
2477 * @param len return location for the array length
2478 * @returns #TRUE on success
2481 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2482 unsigned char **value,
2485 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2488 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2490 pos = dbus_message_iter_get_data_start (real, &type);
2492 _dbus_assert (type == DBUS_TYPE_ARRAY);
2494 type = iter_get_array_type (real, NULL);
2496 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2498 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2499 pos, NULL, value, len))
2506 * Returns the 32 bit signed integer array that the iterator may point
2507 * to. Note that you need to check that the iterator points to an
2508 * array of the correct type prior to using this function.
2510 * @param iter the iterator
2511 * @param value return location for the array
2512 * @param len return location for the array length
2513 * @returns #TRUE on success
2516 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2517 dbus_int32_t **value,
2520 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2523 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2525 pos = dbus_message_iter_get_data_start (real, &type);
2527 _dbus_assert (type == DBUS_TYPE_ARRAY);
2529 type = iter_get_array_type (real, NULL);
2531 _dbus_assert (type == DBUS_TYPE_INT32);
2533 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2534 pos, NULL, value, len))
2541 * Returns the 32 bit unsigned integer array that the iterator may point
2542 * to. Note that you need to check that the iterator points to an
2543 * array of the correct type prior to using this function.
2545 * @param iter the iterator
2546 * @param value return location for the array
2547 * @param len return location for the array length
2548 * @returns #TRUE on success
2551 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2552 dbus_uint32_t **value,
2555 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2558 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2560 pos = dbus_message_iter_get_data_start (real, &type);
2562 _dbus_assert (type == DBUS_TYPE_ARRAY);
2564 type = iter_get_array_type (real, NULL);
2565 _dbus_assert (type == DBUS_TYPE_UINT32);
2567 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2568 pos, NULL, value, len))
2574 #ifdef DBUS_HAVE_INT64
2577 * Returns the 64 bit signed integer array that the iterator may point
2578 * to. Note that you need to check that the iterator points to an
2579 * array of the correct type prior to using this function.
2581 * This function only exists if #DBUS_HAVE_INT64 is defined.
2583 * @param iter the iterator
2584 * @param value return location for the array
2585 * @param len return location for the array length
2586 * @returns #TRUE on success
2589 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
2590 dbus_int64_t **value,
2593 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2596 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2598 pos = dbus_message_iter_get_data_start (real, &type);
2600 _dbus_assert (type == DBUS_TYPE_ARRAY);
2602 type = iter_get_array_type (real, NULL);
2604 _dbus_assert (type == DBUS_TYPE_INT64);
2606 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
2607 pos, NULL, value, len))
2614 * Returns the 64 bit unsigned integer array that the iterator may point
2615 * to. Note that you need to check that the iterator points to an
2616 * array of the correct type prior to using this function.
2618 * This function only exists if #DBUS_HAVE_INT64 is defined.
2620 * @param iter the iterator
2621 * @param value return location for the array
2622 * @param len return location for the array length
2623 * @returns #TRUE on success
2626 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
2627 dbus_uint64_t **value,
2630 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2633 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2635 pos = dbus_message_iter_get_data_start (real, &type);
2637 _dbus_assert (type == DBUS_TYPE_ARRAY);
2639 type = iter_get_array_type (real, NULL);
2640 _dbus_assert (type == DBUS_TYPE_UINT64);
2642 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
2643 pos, NULL, value, len))
2649 #endif /* DBUS_HAVE_INT64 */
2652 * Returns the double array that the iterator may point to. Note that
2653 * you need to check that the iterator points to an array of the
2654 * correct type prior to using this function.
2656 * @param iter the iterator
2657 * @param value return location for the array
2658 * @param len return location for the array length
2659 * @returns #TRUE on success
2662 dbus_message_iter_get_double_array (DBusMessageIter *iter,
2666 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2669 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2671 pos = dbus_message_iter_get_data_start (real, &type);
2673 _dbus_assert (type == DBUS_TYPE_ARRAY);
2675 type = iter_get_array_type (real, NULL);
2676 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2678 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
2679 pos, NULL, value, len))
2686 * Returns the string array that the iterator may point to.
2687 * Note that you need to check that the iterator points
2688 * to a byte array prior to using this function.
2690 * The returned value is a #NULL-terminated array of strings.
2691 * Each string is a separate malloc block, and the array
2692 * itself is a malloc block. You can free this type of
2693 * string array with dbus_free_string_array().
2695 * @param iter the iterator
2696 * @param value return location for string values
2697 * @param len return location for length of byte array
2698 * @returns #TRUE on success
2701 dbus_message_iter_get_string_array (DBusMessageIter *iter,
2705 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2708 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2710 pos = dbus_message_iter_get_data_start (real, &type);
2712 _dbus_assert (type == DBUS_TYPE_ARRAY);
2714 type = iter_get_array_type (real, NULL);
2715 _dbus_assert (type == DBUS_TYPE_STRING);
2717 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
2718 pos, NULL, value, len))
2725 * Returns the key name fot the dict entry that an iterator
2726 * may point to. Note that you need to check that the iterator
2727 * points to a dict entry before using this function.
2729 * @see dbus_message_iter_init_dict_iterator
2730 * @param iter the message iter
2731 * @returns the key name
2734 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
2736 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2738 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2740 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
2742 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2747 * Initializes a DBusMessageIter pointing to the end of the
2748 * message. This iterator can be used to append data to the
2751 * @param message the message
2752 * @param iter pointer to an iterator to initialize
2755 dbus_message_append_iter_init (DBusMessage *message,
2756 DBusMessageIter *iter)
2758 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2760 _dbus_return_if_fail (message != NULL);
2761 _dbus_return_if_fail (iter != NULL);
2763 real->message = message;
2764 real->parent_iter = NULL;
2765 real->changed_stamp = message->changed_stamp;
2767 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2768 real->end = _dbus_string_get_length (&real->message->body);
2769 real->pos = real->end;
2771 real->container_length_pos = 0;
2772 real->wrote_dict_key = 0;
2775 #ifndef DBUS_DISABLE_CHECKS
2777 dbus_message_iter_append_check (DBusMessageRealIter *iter)
2781 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
2785 if (iter->message->locked)
2787 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
2791 if (iter->changed_stamp != iter->message->changed_stamp)
2793 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
2797 if (iter->pos != iter->end)
2799 _dbus_warn ("dbus iterator check failed: can only append at end of message");
2803 if (iter->pos != _dbus_string_get_length (&iter->message->body))
2805 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
2811 #endif /* DBUS_DISABLE_CHECKS */
2814 dbus_message_iter_append_type (DBusMessageRealIter *iter,
2820 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2821 if (!_dbus_string_append_byte (&iter->message->body, type))
2825 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2826 data = _dbus_string_get_const_data_len (&iter->message->body,
2827 iter->array_type_pos, 1);
2830 _dbus_warn ("Appended element of wrong type for array\n");
2835 case DBUS_MESSAGE_ITER_TYPE_DICT:
2836 if (!iter->wrote_dict_key)
2838 _dbus_warn ("Appending dict data before key name\n");
2842 if (!_dbus_string_append_byte (&iter->message->body, type))
2848 _dbus_assert_not_reached ("Invalid iter type");
2856 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
2858 iter->changed_stamp = iter->message->changed_stamp;
2860 /* Set new end of iter */
2861 iter->end = _dbus_string_get_length (&iter->message->body);
2862 iter->pos = iter->end;
2864 /* Set container length */
2865 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
2866 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
2867 _dbus_marshal_set_uint32 (&iter->message->body,
2868 iter->message->byte_order,
2869 iter->container_length_pos,
2870 iter->end - iter->container_start);
2872 if (iter->parent_iter)
2873 dbus_message_iter_update_after_change (iter->parent_iter);
2877 dbus_message_iter_append_done (DBusMessageRealIter *iter)
2879 iter->message->changed_stamp++;
2880 dbus_message_iter_update_after_change (iter);
2881 iter->wrote_dict_key = FALSE;
2885 * Appends a nil value to the message
2887 * @param iter an iterator pointing to the end of the message
2888 * @returns #TRUE on success
2891 dbus_message_iter_append_nil (DBusMessageIter *iter)
2893 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2895 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2897 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
2900 dbus_message_iter_append_done (real);
2906 * Appends a boolean value to the message
2908 * @param iter an iterator pointing to the end of the message
2909 * @param value the boolean value
2910 * @returns #TRUE on success
2913 dbus_message_iter_append_boolean (DBusMessageIter *iter,
2916 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2918 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2920 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
2923 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
2925 _dbus_string_set_length (&real->message->body, real->pos);
2929 dbus_message_iter_append_done (real);
2935 * Appends a byte to the message
2937 * @param iter an iterator pointing to the end of the message
2938 * @param value the byte value
2939 * @returns #TRUE on success
2942 dbus_message_iter_append_byte (DBusMessageIter *iter,
2943 unsigned char value)
2945 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2947 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2949 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
2952 if (!_dbus_string_append_byte (&real->message->body, value))
2954 _dbus_string_set_length (&real->message->body, real->pos);
2958 dbus_message_iter_append_done (real);
2965 * Appends a 32 bit signed integer to the message.
2967 * @param iter an iterator pointing to the end of the message
2968 * @param value the integer value
2969 * @returns #TRUE on success
2972 dbus_message_iter_append_int32 (DBusMessageIter *iter,
2975 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2977 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2979 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
2982 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
2984 _dbus_string_set_length (&real->message->body, real->pos);
2988 dbus_message_iter_append_done (real);
2994 * Appends a 32 bit unsigned integer to the message.
2996 * @param iter an iterator pointing to the end of the message
2997 * @param value the integer value
2998 * @returns #TRUE on success
3001 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3002 dbus_uint32_t value)
3004 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3006 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3008 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3011 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3013 _dbus_string_set_length (&real->message->body, real->pos);
3017 dbus_message_iter_append_done (real);
3022 #ifdef DBUS_HAVE_INT64
3025 * Appends a 64 bit signed integer to the message.
3027 * This function only exists if #DBUS_HAVE_INT64 is defined.
3029 * @param iter an iterator pointing to the end of the message
3030 * @param value the integer value
3031 * @returns #TRUE on success
3034 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3037 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3039 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3041 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3044 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3046 _dbus_string_set_length (&real->message->body, real->pos);
3050 dbus_message_iter_append_done (real);
3056 * Appends a 64 bit unsigned integer to the message.
3058 * This function only exists if #DBUS_HAVE_INT64 is defined.
3060 * @param iter an iterator pointing to the end of the message
3061 * @param value the integer value
3062 * @returns #TRUE on success
3065 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3066 dbus_uint64_t value)
3068 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3070 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3072 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3075 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3077 _dbus_string_set_length (&real->message->body, real->pos);
3081 dbus_message_iter_append_done (real);
3086 #endif /* DBUS_HAVE_INT64 */
3089 * Appends a double value to the message.
3091 * @param iter an iterator pointing to the end of the message
3092 * @param value the double value
3093 * @returns #TRUE on success
3096 dbus_message_iter_append_double (DBusMessageIter *iter,
3099 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3101 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3103 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3106 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3108 _dbus_string_set_length (&real->message->body, real->pos);
3112 dbus_message_iter_append_done (real);
3118 * Appends a UTF-8 string to the message.
3120 * @param iter an iterator pointing to the end of the message
3121 * @param value the string
3122 * @returns #TRUE on success
3125 dbus_message_iter_append_string (DBusMessageIter *iter,
3128 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3130 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3132 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3135 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3137 _dbus_string_set_length (&real->message->body, real->pos);
3141 dbus_message_iter_append_done (real);
3147 * Appends a named type data chunk to the message. A named
3148 * type is simply an arbitrary UTF-8 string used as a type
3149 * tag, plus an array of arbitrary bytes to be interpreted
3150 * according to the type tag.
3152 * @param iter an iterator pointing to the end of the message
3153 * @param name the name of the type
3154 * @param data the binary data used to store the value
3155 * @param len the length of the binary data in bytes
3156 * @returns #TRUE on success
3159 dbus_message_iter_append_named (DBusMessageIter *iter,
3161 const unsigned char *data,
3164 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3166 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3168 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3171 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3173 _dbus_string_set_length (&real->message->body, real->pos);
3177 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3179 _dbus_string_set_length (&real->message->body, real->pos);
3183 dbus_message_iter_append_done (real);
3190 * Appends a dict key name to the message. The iterator used
3191 * must point to a dict.
3193 * @param iter an iterator pointing to the end of the message
3194 * @param value the string
3195 * @returns #TRUE on success
3198 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3201 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3203 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3204 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3206 if (real->wrote_dict_key)
3208 _dbus_warn ("Appendinging multiple dict key names\n");
3212 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3217 dbus_message_iter_append_done (real);
3218 real->wrote_dict_key = TRUE;
3224 array_iter_type_mark_done (DBusMessageRealIter *iter)
3228 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3229 array_iter_type_mark_done (iter->parent_iter);
3233 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3234 sizeof (dbus_uint32_t));
3236 /* Empty length for now, backfill later */
3237 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3239 _dbus_string_set_length (&iter->message->body, iter->pos);
3243 iter->container_start = _dbus_string_get_length (&iter->message->body);
3244 iter->container_length_pos = len_pos;
3245 iter->array_type_done = TRUE;
3251 append_array_type (DBusMessageRealIter *real,
3253 dbus_bool_t *array_type_done,
3254 int *array_type_pos)
3256 int existing_element_type;
3258 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3261 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3262 real->array_type_done)
3264 existing_element_type = iter_get_array_type (real, array_type_pos);
3265 if (existing_element_type != element_type)
3267 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3268 _dbus_type_to_string (element_type),
3269 _dbus_type_to_string (existing_element_type));
3270 _dbus_string_set_length (&real->message->body, real->pos);
3273 if (array_type_done != NULL)
3274 *array_type_done = TRUE;
3278 if (array_type_pos != NULL)
3279 *array_type_pos = _dbus_string_get_length (&real->message->body);
3281 /* Append element type */
3282 if (!_dbus_string_append_byte (&real->message->body, element_type))
3284 _dbus_string_set_length (&real->message->body, real->pos);
3288 if (array_type_done != NULL)
3289 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3291 if (element_type != DBUS_TYPE_ARRAY &&
3292 !array_iter_type_mark_done (real))
3300 * Appends an array to the message and initializes an iterator that
3301 * can be used to append to the array.
3303 * @param iter an iterator pointing to the end of the message
3304 * @param array_iter pointer to an iter that will be initialized
3305 * @param element_type the type of the array elements
3306 * @returns #TRUE on success
3309 dbus_message_iter_append_array (DBusMessageIter *iter,
3310 DBusMessageIter *array_iter,
3313 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3314 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3317 dbus_bool_t array_type_done;
3319 if (element_type == DBUS_TYPE_NIL)
3321 _dbus_warn ("Can't create NIL arrays\n");
3325 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3327 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3330 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3332 if (array_type_done)
3334 /* Empty length for now, backfill later */
3335 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3337 _dbus_string_set_length (&real->message->body, real->pos);
3342 array_real->parent_iter = real;
3343 array_real->message = real->message;
3344 array_real->changed_stamp = real->message->changed_stamp;
3346 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3347 array_real->pos = _dbus_string_get_length (&real->message->body);
3348 array_real->end = array_real->end;
3350 array_real->container_start = array_real->pos;
3351 array_real->container_length_pos = len_pos;
3352 array_real->wrote_dict_key = 0;
3353 array_real->array_type_done = array_type_done;
3354 array_real->array_type_pos = array_type_pos;
3356 dbus_message_iter_append_done (array_real);
3362 * Appends a dict to the message and initializes an iterator that
3363 * can be used to append to the dict.
3365 * @param iter an iterator pointing to the end of the message
3366 * @param dict_iter pointer to an iter that will be initialized
3367 * @returns #TRUE on success
3370 dbus_message_iter_append_dict (DBusMessageIter *iter,
3371 DBusMessageIter *dict_iter)
3373 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3374 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3377 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3379 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3382 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3384 /* Empty length for now, backfill later */
3385 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3387 _dbus_string_set_length (&real->message->body, real->pos);
3391 dict_real->parent_iter = real;
3392 dict_real->message = real->message;
3393 dict_real->changed_stamp = real->message->changed_stamp;
3395 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3396 dict_real->pos = _dbus_string_get_length (&real->message->body);
3397 dict_real->end = dict_real->end;
3399 dict_real->container_start = dict_real->pos;
3400 dict_real->container_length_pos = len_pos;
3401 dict_real->wrote_dict_key = 0;
3403 dbus_message_iter_append_done (dict_real);
3410 * Appends a boolean array to the message.
3412 * @param iter an iterator pointing to the end of the message
3413 * @param value the array
3414 * @param len the length of the array
3415 * @returns #TRUE on success
3418 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3419 unsigned const char *value,
3422 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3424 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3426 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3429 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3431 _dbus_string_set_length (&real->message->body, real->pos);
3435 dbus_message_iter_append_done (real);
3441 * Appends a 32 bit signed integer array to the message.
3443 * @param iter an iterator pointing to the end of the message
3444 * @param value the array
3445 * @param len the length of the array
3446 * @returns #TRUE on success
3449 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3450 const dbus_int32_t *value,
3453 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3455 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3457 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
3460 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
3462 _dbus_string_set_length (&real->message->body, real->pos);
3466 dbus_message_iter_append_done (real);
3472 * Appends a 32 bit unsigned integer array to the message.
3474 * @param iter an iterator pointing to the end of the message
3475 * @param value the array
3476 * @param len the length of the array
3477 * @returns #TRUE on success
3480 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
3481 const dbus_uint32_t *value,
3484 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3486 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3488 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
3491 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3493 _dbus_string_set_length (&real->message->body, real->pos);
3497 dbus_message_iter_append_done (real);
3502 #ifdef DBUS_HAVE_INT64
3505 * Appends a 64 bit signed integer array to the message.
3507 * This function only exists if #DBUS_HAVE_INT64 is defined.
3509 * @param iter an iterator pointing to the end of the message
3510 * @param value the array
3511 * @param len the length of the array
3512 * @returns #TRUE on success
3515 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
3516 const dbus_int64_t *value,
3519 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3521 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3523 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
3526 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
3528 _dbus_string_set_length (&real->message->body, real->pos);
3532 dbus_message_iter_append_done (real);
3538 * Appends a 64 bit unsigned integer array to the message.
3540 * This function only exists if #DBUS_HAVE_INT64 is defined.
3542 * @param iter an iterator pointing to the end of the message
3543 * @param value the array
3544 * @param len the length of the array
3545 * @returns #TRUE on success
3548 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
3549 const dbus_uint64_t *value,
3552 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3554 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3556 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
3559 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
3561 _dbus_string_set_length (&real->message->body, real->pos);
3565 dbus_message_iter_append_done (real);
3569 #endif /* DBUS_HAVE_INT64 */
3572 * Appends a double array to the message.
3574 * @param iter an iterator pointing to the end of the message
3575 * @param value the array
3576 * @param len the length of the array
3577 * @returns #TRUE on success
3580 dbus_message_iter_append_double_array (DBusMessageIter *iter,
3581 const double *value,
3584 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3586 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3588 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
3591 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
3593 _dbus_string_set_length (&real->message->body, real->pos);
3597 dbus_message_iter_append_done (real);
3603 * Appends a byte array to the message.
3605 * @param iter an iterator pointing to the end of the message
3606 * @param value the array
3607 * @param len the length of the array
3608 * @returns #TRUE on success
3611 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
3612 unsigned const char *value,
3615 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3617 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3619 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
3622 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3624 _dbus_string_set_length (&real->message->body, real->pos);
3628 dbus_message_iter_append_done (real);
3634 * Appends a string array to the message.
3636 * @param iter an iterator pointing to the end of the message
3637 * @param value the array
3638 * @param len the length of the array
3639 * @returns #TRUE on success
3642 dbus_message_iter_append_string_array (DBusMessageIter *iter,
3646 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3648 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3650 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
3653 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
3655 _dbus_string_set_length (&real->message->body, real->pos);
3659 dbus_message_iter_append_done (real);
3665 * Sets the message sender.
3667 * @param message the message
3668 * @param sender the sender
3669 * @returns #FALSE if not enough memory
3672 dbus_message_set_sender (DBusMessage *message,
3675 _dbus_return_val_if_fail (message != NULL, FALSE);
3676 _dbus_return_val_if_fail (!message->locked, FALSE);
3680 delete_string_field (message, FIELD_SENDER);
3685 return set_string_field (message,
3692 * Sets a flag indicating that the message is an error reply
3693 * message, i.e. an "exception" rather than a normal response.
3695 * @param message the message
3696 * @param is_error_reply #TRUE if this is an error message.
3699 dbus_message_set_is_error (DBusMessage *message,
3700 dbus_bool_t is_error_reply)
3704 _dbus_return_if_fail (message != NULL);
3705 _dbus_return_if_fail (!message->locked);
3707 header = _dbus_string_get_data_len (&message->header, 1, 1);
3710 *header |= DBUS_HEADER_FLAG_ERROR;
3712 *header &= ~DBUS_HEADER_FLAG_ERROR;
3716 * Returns #TRUE if the message is an error
3717 * reply to some previous message we sent.
3719 * @param message the message
3720 * @returns #TRUE if the message is an error
3723 dbus_message_get_is_error (DBusMessage *message)
3727 _dbus_return_val_if_fail (message != NULL, FALSE);
3729 header = _dbus_string_get_const_data_len (&message->header, 1, 1);
3731 return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
3735 * Gets the service which originated this message,
3736 * or #NULL if unknown or inapplicable.
3738 * @param message the message
3739 * @returns the service name or #NULL
3742 dbus_message_get_sender (DBusMessage *message)
3744 _dbus_return_val_if_fail (message != NULL, NULL);
3746 return get_string_field (message, FIELD_SENDER, NULL);
3750 * Checks whether the message has the given name.
3751 * If the message has no name or has a different
3752 * name, returns #FALSE.
3754 * @param message the message
3755 * @param name the name to check (must not be #NULL)
3757 * @returns #TRUE if the message has the given name
3760 dbus_message_has_name (DBusMessage *message,
3765 _dbus_return_val_if_fail (message != NULL, FALSE);
3766 _dbus_return_val_if_fail (name != NULL, FALSE);
3768 n = dbus_message_get_name (message);
3770 if (n && strcmp (n, name) == 0)
3777 * Checks whether the message was sent to the given service. If the
3778 * message has no service specified or has a different name, returns
3781 * @param message the message
3782 * @param service the service to check (must not be #NULL)
3784 * @returns #TRUE if the message has the given destination service
3787 dbus_message_has_destination (DBusMessage *message,
3788 const char *service)
3792 _dbus_return_val_if_fail (message != NULL, FALSE);
3793 _dbus_return_val_if_fail (service != NULL, FALSE);
3795 s = dbus_message_get_destination (message);
3797 if (s && strcmp (s, service) == 0)
3804 * Checks whether the message has the given service as its sender. If
3805 * the message has no sender specified or has a different sender,
3806 * returns #FALSE. Note that if a peer application owns multiple
3807 * services, its messages will have only one of those services as the
3808 * sender (usually the base service). So you can't use this
3809 * function to prove the sender didn't own service Foo, you can
3810 * only use it to prove that it did.
3812 * @param message the message
3813 * @param service the service to check (must not be #NULL)
3815 * @returns #TRUE if the message has the given origin service
3818 dbus_message_has_sender (DBusMessage *message,
3819 const char *service)
3823 _dbus_assert (service != NULL);
3825 s = dbus_message_get_sender (message);
3827 if (s && strcmp (s, service) == 0)
3834 * Sets a #DBusError based on the contents of the given
3835 * message. The error is only set if the message
3836 * is an error message, as in dbus_message_get_is_error().
3837 * The name of the error is set to the name of the message,
3838 * and the error message is set to the first argument
3839 * if the argument exists and is a string.
3841 * The return value indicates whether the error was set (the error is
3842 * set if and only if the message is an error message).
3843 * So you can check for an error reply and convert it to DBusError
3846 * @param error the error to set
3847 * @param message the message to set it from
3848 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
3851 dbus_set_error_from_message (DBusError *error,
3852 DBusMessage *message)
3856 _dbus_return_val_if_fail (message != NULL, FALSE);
3857 _dbus_return_val_if_error_is_set (error, FALSE);
3859 if (!dbus_message_get_is_error (message))
3863 dbus_message_get_args (message, NULL,
3864 DBUS_TYPE_STRING, &str,
3867 dbus_set_error (error, dbus_message_get_name (message),
3868 str ? "%s" : NULL, str);
3878 * @addtogroup DBusMessageInternals
3883 * @typedef DBusMessageLoader
3885 * The DBusMessageLoader object encapsulates the process of converting
3886 * a byte stream into a series of DBusMessage. It buffers the incoming
3887 * bytes as efficiently as possible, and generates a queue of
3888 * messages. DBusMessageLoader is typically used as part of a
3889 * DBusTransport implementation. The DBusTransport then hands off
3890 * the loaded messages to a DBusConnection, making the messages
3891 * visible to the application.
3893 * @todo write tests for break-loader that a) randomly delete header
3894 * fields and b) set string fields to zero-length and other funky
3899 /* we definitely use signed ints for sizes, so don't exceed
3900 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
3901 * over 128M is pretty nuts anyhow.
3905 * The maximum sane message size.
3907 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
3910 * Implementation details of DBusMessageLoader.
3911 * All members are private.
3913 struct DBusMessageLoader
3915 int refcount; /**< Reference count. */
3917 DBusString data; /**< Buffered data */
3919 DBusList *messages; /**< Complete messages. */
3921 long max_message_size; /**< Maximum size of a message */
3923 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
3925 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
3929 * The initial buffer size of the message loader.
3931 * @todo this should be based on min header size plus some average
3932 * body size, or something. Or rather, the min header size only, if we
3933 * want to try to read only the header, store that in a DBusMessage,
3934 * then read only the body and store that, etc., depends on
3935 * how we optimize _dbus_message_loader_get_buffer() and what
3936 * the exact message format is.
3938 #define INITIAL_LOADER_DATA_LEN 32
3941 * Creates a new message loader. Returns #NULL if memory can't
3944 * @returns new loader, or #NULL.
3947 _dbus_message_loader_new (void)
3949 DBusMessageLoader *loader;
3951 loader = dbus_new0 (DBusMessageLoader, 1);
3955 loader->refcount = 1;
3957 /* Try to cap message size at something that won't *totally* hose
3958 * the system if we have a couple of them.
3960 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
3962 if (!_dbus_string_init (&loader->data))
3968 /* preallocate the buffer for speed, ignore failure */
3969 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
3970 _dbus_string_set_length (&loader->data, 0);
3976 * Increments the reference count of the loader.
3978 * @param loader the loader.
3981 _dbus_message_loader_ref (DBusMessageLoader *loader)
3983 loader->refcount += 1;
3987 * Decrements the reference count of the loader and finalizes the
3988 * loader when the count reaches zero.
3990 * @param loader the loader.
3993 _dbus_message_loader_unref (DBusMessageLoader *loader)
3995 loader->refcount -= 1;
3996 if (loader->refcount == 0)
3998 _dbus_list_foreach (&loader->messages,
3999 (DBusForeachFunction) dbus_message_unref,
4001 _dbus_list_clear (&loader->messages);
4002 _dbus_string_free (&loader->data);
4008 * Gets the buffer to use for reading data from the network. Network
4009 * data is read directly into an allocated buffer, which is then used
4010 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4011 * The buffer must always be returned immediately using
4012 * _dbus_message_loader_return_buffer(), even if no bytes are
4013 * successfully read.
4015 * @todo this function can be a lot more clever. For example
4016 * it can probably always return a buffer size to read exactly
4017 * the body of the next message, thus avoiding any memory wastage
4020 * @todo we need to enforce a max length on strings in header fields.
4022 * @param loader the message loader.
4023 * @param buffer the buffer
4026 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4027 DBusString **buffer)
4029 _dbus_assert (!loader->buffer_outstanding);
4031 *buffer = &loader->data;
4033 loader->buffer_outstanding = TRUE;
4037 * The smallest header size that can occur.
4038 * (It won't be valid)
4040 #define DBUS_MINIMUM_HEADER_SIZE 16
4042 /** Pack four characters as in "abcd" into a uint32 */
4043 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
4044 ((((dbus_uint32_t)a) << 24) | \
4045 (((dbus_uint32_t)b) << 16) | \
4046 (((dbus_uint32_t)c) << 8) | \
4049 /** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
4050 #define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
4051 FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
4053 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
4054 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
4055 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
4057 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
4058 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
4059 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
4061 /** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
4062 #define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
4063 FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
4066 decode_string_field (const DBusString *data,
4067 HeaderField fields[FIELD_LAST],
4071 const char *field_name)
4074 int string_data_pos;
4076 if (fields[field].offset >= 0)
4078 _dbus_verbose ("%s field provided twice\n",
4083 if (type != DBUS_TYPE_STRING)
4085 _dbus_verbose ("%s field has wrong type %s\n",
4086 field_name, _dbus_type_to_string (type));
4090 /* skip padding after typecode, skip string length;
4091 * we assume that the string arg has already been validated
4092 * for sanity and UTF-8
4094 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4095 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4097 _dbus_string_init_const (&tmp,
4098 _dbus_string_get_const_data (data) + string_data_pos);
4100 if (field == FIELD_NAME)
4102 if (!_dbus_string_validate_name (&tmp, 0, _dbus_string_get_length (&tmp)))
4104 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4105 field_name, _dbus_string_get_const_data (&tmp));
4109 if (_dbus_string_starts_with_c_str (&tmp,
4110 DBUS_NAMESPACE_LOCAL_MESSAGE))
4112 _dbus_verbose ("Message is in the local namespace\n");
4118 if (!_dbus_string_validate_service (&tmp, 0, _dbus_string_get_length (&tmp)))
4120 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4121 field_name, _dbus_string_get_const_data (&tmp));
4126 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4129 _dbus_verbose ("Found field %s name at offset %d\n",
4130 field_name, fields[field].offset);
4137 decode_header_data (const DBusString *data,
4140 HeaderField fields[FIELD_LAST],
4141 int *message_padding)
4148 if (header_len < 16)
4152 while (i < FIELD_LAST)
4154 fields[i].offset = -1;
4158 fields[FIELD_HEADER_LENGTH].offset = 4;
4159 fields[FIELD_BODY_LENGTH].offset = 8;
4160 fields[FIELD_CLIENT_SERIAL].offset = 12;
4162 /* Now handle the named fields. A real named field is at least 4
4163 * bytes for the name, plus a type code (1 byte) plus padding. So
4164 * if we have less than 8 bytes left, it must be alignment padding,
4165 * not a field. While >= 8 bytes can't be entirely alignment
4169 while ((pos + 7) < header_len)
4171 pos = _DBUS_ALIGN_VALUE (pos, 4);
4173 if ((pos + 4) > header_len)
4176 field =_dbus_string_get_const_data_len (data, pos, 4);
4179 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
4181 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4183 _dbus_verbose ("Failed to validate type of named header field\n");
4187 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4189 _dbus_verbose ("Failed to validate argument to named header field\n");
4193 if (new_pos > header_len)
4195 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4199 switch (DBUS_UINT32_FROM_BE (*(int*)field))
4201 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
4202 if (!decode_string_field (data, fields, pos, type,
4204 DBUS_HEADER_FIELD_SERVICE))
4208 case DBUS_HEADER_FIELD_NAME_AS_UINT32:
4209 if (!decode_string_field (data, fields, pos, type,
4211 DBUS_HEADER_FIELD_NAME))
4215 case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
4216 if (!decode_string_field (data, fields, pos, type,
4218 DBUS_HEADER_FIELD_SENDER))
4222 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
4223 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
4225 _dbus_verbose ("%s field provided twice\n",
4226 DBUS_HEADER_FIELD_REPLY);
4230 if (type != DBUS_TYPE_UINT32)
4232 _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_REPLY);
4236 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos, 4);
4238 _dbus_verbose ("Found reply serial at offset %d\n",
4239 fields[FIELD_REPLY_SERIAL].offset);
4243 _dbus_verbose ("Ignoring an unknown header field: %.4s at offset %d\n",
4250 if (pos < header_len)
4252 /* Alignment padding, verify that it's nul */
4253 _dbus_assert ((header_len - pos) < 8);
4255 if (!_dbus_string_validate_nul (data,
4256 pos, (header_len - pos)))
4258 _dbus_verbose ("header alignment padding is not nul\n");
4263 /* Name field is mandatory */
4264 if (fields[FIELD_NAME].offset < 0)
4266 _dbus_verbose ("No %s field provided\n",
4267 DBUS_HEADER_FIELD_NAME);
4271 if (message_padding)
4272 *message_padding = header_len - pos;
4278 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
4279 * indicating to the loader how many bytes of the buffer were filled
4280 * in. This function must always be called, even if no bytes were
4281 * successfully read.
4283 * @param loader the loader.
4284 * @param buffer the buffer.
4285 * @param bytes_read number of bytes that were read into the buffer.
4288 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
4292 _dbus_assert (loader->buffer_outstanding);
4293 _dbus_assert (buffer == &loader->data);
4295 loader->buffer_outstanding = FALSE;
4299 * Converts buffered data into messages.
4301 * @param loader the loader.
4302 * @returns #TRUE if we had enough memory to finish.
4305 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
4307 if (loader->corrupted)
4310 while (_dbus_string_get_length (&loader->data) >= 16)
4312 DBusMessage *message;
4313 const char *header_data;
4314 int byte_order, header_len, body_len, header_padding;
4315 dbus_uint32_t header_len_unsigned, body_len_unsigned;
4317 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
4319 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
4321 if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
4323 _dbus_verbose ("Message has protocol version %d ours is %d\n",
4324 (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
4325 loader->corrupted = TRUE;
4329 byte_order = header_data[0];
4331 if (byte_order != DBUS_LITTLE_ENDIAN &&
4332 byte_order != DBUS_BIG_ENDIAN)
4334 _dbus_verbose ("Message with bad byte order '%c' received\n",
4336 loader->corrupted = TRUE;
4340 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
4341 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
4343 if (header_len_unsigned < 16)
4345 _dbus_verbose ("Message had broken too-small header length %u\n",
4346 header_len_unsigned);
4347 loader->corrupted = TRUE;
4351 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
4352 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
4354 _dbus_verbose ("Header or body length too large (%u %u)\n",
4355 header_len_unsigned,
4357 loader->corrupted = TRUE;
4361 /* Now that we know the values are in signed range, get
4362 * rid of stupid unsigned, just causes bugs
4364 header_len = header_len_unsigned;
4365 body_len = body_len_unsigned;
4367 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
4370 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
4372 loader->corrupted = TRUE;
4376 if (header_len + body_len > loader->max_message_size)
4378 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
4379 header_len, body_len, loader->max_message_size);
4380 loader->corrupted = TRUE;
4384 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
4386 HeaderField fields[FIELD_LAST];
4391 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
4393 if (!decode_header_data (&loader->data, header_len, byte_order,
4394 fields, &header_padding))
4396 _dbus_verbose ("Header was invalid\n");
4397 loader->corrupted = TRUE;
4401 next_arg = header_len;
4402 while (next_arg < (header_len + body_len))
4405 int prev = next_arg;
4407 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
4410 _dbus_verbose ("invalid typecode at offset %d\n", prev);
4411 loader->corrupted = TRUE;
4415 if (!_dbus_marshal_validate_arg (&loader->data,
4422 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
4423 loader->corrupted = TRUE;
4427 _dbus_assert (next_arg > prev);
4430 if (next_arg > (header_len + body_len))
4432 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
4433 next_arg, header_len, body_len,
4434 header_len + body_len);
4435 loader->corrupted = TRUE;
4439 message = dbus_message_new_empty_header ();
4440 if (message == NULL)
4442 _dbus_verbose ("Failed to allocate empty message\n");
4446 message->byte_order = byte_order;
4447 message->header_padding = header_padding;
4449 /* Copy in the offsets we found */
4451 while (i < FIELD_LAST)
4453 message->header_fields[i] = fields[i];
4457 if (!_dbus_list_append (&loader->messages, message))
4459 _dbus_verbose ("Failed to append new message to loader queue\n");
4460 dbus_message_unref (message);
4464 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
4465 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
4467 _dbus_assert (_dbus_string_get_length (&loader->data) >=
4468 (header_len + body_len));
4470 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
4472 _dbus_verbose ("Failed to move header into new message\n");
4473 _dbus_list_remove_last (&loader->messages, message);
4474 dbus_message_unref (message);
4478 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
4482 _dbus_verbose ("Failed to move body into new message\n");
4484 /* put the header back, we'll try again later */
4485 result = _dbus_string_copy_len (&message->header, 0, header_len,
4487 _dbus_assert (result); /* because DBusString never reallocs smaller */
4489 _dbus_list_remove_last (&loader->messages, message);
4490 dbus_message_unref (message);
4494 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
4495 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
4497 /* Fill in caches (we checked the types of these fields
4500 message->reply_serial = get_uint_field (message,
4501 FIELD_REPLY_SERIAL);
4502 message->client_serial = get_uint_field (message,
4503 FIELD_CLIENT_SERIAL);
4505 _dbus_verbose ("Loaded message %p\n", message);
4515 * Peeks at first loaded message, returns #NULL if no messages have
4518 * @param loader the loader.
4519 * @returns the next message, or #NULL if none.
4522 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
4524 if (loader->messages)
4525 return loader->messages->data;
4531 * Pops a loaded message (passing ownership of the message
4532 * to the caller). Returns #NULL if no messages have been
4535 * @param loader the loader.
4536 * @returns the next message, or #NULL if none.
4539 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
4541 return _dbus_list_pop_first (&loader->messages);
4545 * Pops a loaded message inside a list link (passing ownership of the
4546 * message and link to the caller). Returns #NULL if no messages have
4549 * @param loader the loader.
4550 * @returns the next message link, or #NULL if none.
4553 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
4555 return _dbus_list_pop_first_link (&loader->messages);
4559 * Returns a popped message link, used to undo a pop.
4561 * @param loader the loader
4562 * @param link the link with a message in it
4565 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
4568 _dbus_list_prepend_link (&loader->messages, link);
4572 * Checks whether the loader is confused due to bad data.
4573 * If messages are received that are invalid, the
4574 * loader gets confused and gives up permanently.
4575 * This state is called "corrupted."
4577 * @param loader the loader
4578 * @returns #TRUE if the loader is hosed.
4581 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
4583 return loader->corrupted;
4587 * Sets the maximum size message we allow.
4589 * @param loader the loader
4590 * @param size the max message size in bytes
4593 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
4596 if (size > MAX_SANE_MESSAGE_SIZE)
4598 _dbus_verbose ("clamping requested max message size %ld to %d\n",
4599 size, MAX_SANE_MESSAGE_SIZE);
4600 size = MAX_SANE_MESSAGE_SIZE;
4602 loader->max_message_size = size;
4606 * Gets the maximum allowed message size in bytes.
4608 * @param loader the loader
4609 * @returns max size in bytes
4612 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
4614 return loader->max_message_size;
4617 static DBusDataSlotAllocator slot_allocator;
4618 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
4621 * Allocates an integer ID to be used for storing application-specific
4622 * data on any DBusMessage. The allocated ID may then be used
4623 * with dbus_message_set_data() and dbus_message_get_data().
4624 * The passed-in slot must be initialized to -1, and is filled in
4625 * with the slot ID. If the passed-in slot is not -1, it's assumed
4626 * to be already allocated, and its refcount is incremented.
4628 * The allocated slot is global, i.e. all DBusMessage objects will
4629 * have a slot with the given integer ID reserved.
4631 * @param slot_p address of a global variable storing the slot
4632 * @returns #FALSE on failure (no memory)
4635 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
4637 return _dbus_data_slot_allocator_alloc (&slot_allocator,
4638 _DBUS_LOCK_NAME (message_slots),
4643 * Deallocates a global ID for message data slots.
4644 * dbus_message_get_data() and dbus_message_set_data() may no
4645 * longer be used with this slot. Existing data stored on existing
4646 * DBusMessage objects will be freed when the message is
4647 * finalized, but may not be retrieved (and may only be replaced if
4648 * someone else reallocates the slot). When the refcount on the
4649 * passed-in slot reaches 0, it is set to -1.
4651 * @param slot_p address storing the slot to deallocate
4654 dbus_message_free_data_slot (dbus_int32_t *slot_p)
4656 _dbus_return_if_fail (*slot_p >= 0);
4658 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
4662 * Stores a pointer on a DBusMessage, along
4663 * with an optional function to be used for freeing
4664 * the data when the data is set again, or when
4665 * the message is finalized. The slot number
4666 * must have been allocated with dbus_message_allocate_data_slot().
4668 * @param message the message
4669 * @param slot the slot number
4670 * @param data the data to store
4671 * @param free_data_func finalizer function for the data
4672 * @returns #TRUE if there was enough memory to store the data
4675 dbus_message_set_data (DBusMessage *message,
4678 DBusFreeFunction free_data_func)
4680 DBusFreeFunction old_free_func;
4684 _dbus_return_val_if_fail (message != NULL, FALSE);
4685 _dbus_return_val_if_fail (slot >= 0, FALSE);
4687 retval = _dbus_data_slot_list_set (&slot_allocator,
4688 &message->slot_list,
4689 slot, data, free_data_func,
4690 &old_free_func, &old_data);
4694 /* Do the actual free outside the message lock */
4696 (* old_free_func) (old_data);
4703 * Retrieves data previously set with dbus_message_set_data().
4704 * The slot must still be allocated (must not have been freed).
4706 * @param message the message
4707 * @param slot the slot to get data from
4708 * @returns the data, or #NULL if not found
4711 dbus_message_get_data (DBusMessage *message,
4716 _dbus_return_val_if_fail (message != NULL, NULL);
4718 res = _dbus_data_slot_list_get (&slot_allocator,
4719 &message->slot_list,
4726 #ifdef DBUS_BUILD_TESTS
4727 #include "dbus-test.h"
4731 message_iter_test (DBusMessage *message)
4733 DBusMessageIter iter, dict, array, array2;
4735 unsigned char *data;
4736 dbus_int32_t *our_int_array;
4739 dbus_message_iter_init (message, &iter);
4742 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
4743 _dbus_assert_not_reached ("Argument type isn't string");
4745 str = dbus_message_iter_get_string (&iter);
4746 if (strcmp (str, "Test string") != 0)
4747 _dbus_assert_not_reached ("Strings differ");
4750 if (!dbus_message_iter_next (&iter))
4751 _dbus_assert_not_reached ("Reached end of arguments");
4753 /* Signed integer tests */
4754 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
4755 _dbus_assert_not_reached ("Argument type isn't int32");
4757 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
4758 _dbus_assert_not_reached ("Signed integers differ");
4760 if (!dbus_message_iter_next (&iter))
4761 _dbus_assert_not_reached ("Reached end of fields");
4763 /* Unsigned integer tests */
4764 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
4765 _dbus_assert_not_reached ("Argument type isn't int32");
4767 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
4768 _dbus_assert_not_reached ("Unsigned integers differ");
4770 if (!dbus_message_iter_next (&iter))
4771 _dbus_assert_not_reached ("Reached end of arguments");
4774 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
4775 _dbus_assert_not_reached ("Argument type isn't double");
4777 if (dbus_message_iter_get_double (&iter) != 3.14159)
4778 _dbus_assert_not_reached ("Doubles differ");
4780 if (!dbus_message_iter_next (&iter))
4781 _dbus_assert_not_reached ("Reached end of arguments");
4783 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
4784 _dbus_assert_not_reached ("Argument type not an array");
4786 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
4787 _dbus_assert_not_reached ("Array type not double");
4790 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
4791 _dbus_assert_not_reached ("Array init failed");
4793 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4794 _dbus_assert_not_reached ("Argument type isn't double");
4796 if (dbus_message_iter_get_double (&array) != 1.5)
4797 _dbus_assert_not_reached ("Unsigned integers differ");
4799 if (!dbus_message_iter_next (&array))
4800 _dbus_assert_not_reached ("Reached end of arguments");
4802 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4803 _dbus_assert_not_reached ("Argument type isn't double");
4805 if (dbus_message_iter_get_double (&array) != 2.5)
4806 _dbus_assert_not_reached ("Unsigned integers differ");
4808 if (dbus_message_iter_next (&array))
4809 _dbus_assert_not_reached ("Didn't reach end of arguments");
4811 if (!dbus_message_iter_next (&iter))
4812 _dbus_assert_not_reached ("Reached end of arguments");
4817 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
4818 _dbus_assert_not_reached ("not dict type");
4820 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
4821 _dbus_assert_not_reached ("dict iter failed");
4823 str = dbus_message_iter_get_dict_key (&dict);
4824 if (str == NULL || strcmp (str, "test") != 0)
4825 _dbus_assert_not_reached ("wrong dict key");
4828 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
4829 _dbus_assert_not_reached ("wrong dict entry type");
4831 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
4832 _dbus_assert_not_reached ("wrong dict entry value");
4834 if (!dbus_message_iter_next (&dict))
4835 _dbus_assert_not_reached ("reached end of dict");
4837 /* array of array of int32 (in dict) */
4839 str = dbus_message_iter_get_dict_key (&dict);
4840 if (str == NULL || strcmp (str, "array") != 0)
4841 _dbus_assert_not_reached ("wrong dict key");
4844 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
4845 _dbus_assert_not_reached ("Argument type not an array");
4847 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
4848 _dbus_assert_not_reached ("Array type not array");
4850 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
4851 _dbus_assert_not_reached ("Array init failed");
4853 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
4854 _dbus_assert_not_reached ("Argument type isn't array");
4856 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4857 _dbus_assert_not_reached ("Array type not int32");
4859 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
4860 _dbus_assert_not_reached ("Array init failed");
4862 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
4863 _dbus_assert_not_reached ("Argument type isn't int32");
4865 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
4866 _dbus_assert_not_reached ("Signed integers differ");
4868 if (!dbus_message_iter_next (&array2))
4869 _dbus_assert_not_reached ("Reached end of arguments");
4871 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
4872 _dbus_assert_not_reached ("Signed integers differ");
4874 if (dbus_message_iter_next (&array2))
4875 _dbus_assert_not_reached ("Didn't reached end of arguments");
4877 if (!dbus_message_iter_next (&array))
4878 _dbus_assert_not_reached ("Reached end of arguments");
4880 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4881 _dbus_assert_not_reached ("Array type not int32");
4883 if (!dbus_message_iter_get_int32_array (&array,
4886 _dbus_assert_not_reached ("couldn't get int32 array");
4888 _dbus_assert (len == 3);
4889 _dbus_assert (our_int_array[0] == 0x34567812 &&
4890 our_int_array[1] == 0x45678123 &&
4891 our_int_array[2] == 0x56781234);
4892 dbus_free (our_int_array);
4894 if (dbus_message_iter_next (&array))
4895 _dbus_assert_not_reached ("Didn't reach end of array");
4897 if (dbus_message_iter_next (&dict))
4898 _dbus_assert_not_reached ("Didn't reach end of dict");
4900 if (!dbus_message_iter_next (&iter))
4901 _dbus_assert_not_reached ("Reached end of arguments");
4903 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
4905 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
4906 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
4909 if (dbus_message_iter_get_byte (&iter) != 0xF0)
4910 _dbus_assert_not_reached ("wrong value after dict");
4913 if (!dbus_message_iter_next (&iter))
4914 _dbus_assert_not_reached ("Reached end of arguments");
4916 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
4917 _dbus_assert_not_reached ("not a nil type");
4919 if (!dbus_message_iter_next (&iter))
4920 _dbus_assert_not_reached ("Reached end of arguments");
4922 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
4923 _dbus_assert_not_reached ("wrong type after dict");
4925 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
4926 _dbus_assert_not_reached ("failed to get named");
4928 _dbus_assert (strcmp (str, "named")==0);
4929 _dbus_assert (len == 5);
4930 _dbus_assert (strcmp (data, "data")==0);
4934 if (dbus_message_iter_next (&iter))
4935 _dbus_assert_not_reached ("Didn't reach end of arguments");
4940 check_message_handling_type (DBusMessageIter *iter,
4943 DBusMessageIter child_iter;
4949 case DBUS_TYPE_BYTE:
4950 dbus_message_iter_get_byte (iter);
4952 case DBUS_TYPE_BOOLEAN:
4953 dbus_message_iter_get_boolean (iter);
4955 case DBUS_TYPE_INT32:
4956 dbus_message_iter_get_int32 (iter);
4958 case DBUS_TYPE_UINT32:
4959 dbus_message_iter_get_uint32 (iter);
4961 case DBUS_TYPE_INT64:
4962 #ifdef DBUS_HAVE_INT64
4963 dbus_message_iter_get_int64 (iter);
4966 case DBUS_TYPE_UINT64:
4967 #ifdef DBUS_HAVE_INT64
4968 dbus_message_iter_get_uint64 (iter);
4971 case DBUS_TYPE_DOUBLE:
4972 dbus_message_iter_get_double (iter);
4974 case DBUS_TYPE_STRING:
4977 str = dbus_message_iter_get_string (iter);
4980 _dbus_warn ("NULL string in message\n");
4986 case DBUS_TYPE_NAMED:
4989 unsigned char *data;
4992 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
4994 _dbus_warn ("error reading name from named type\n");
5001 case DBUS_TYPE_ARRAY:
5005 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
5007 _dbus_warn ("Failed to init array iterator\n");
5011 while (dbus_message_iter_has_next (&child_iter))
5013 if (!check_message_handling_type (&child_iter, array_type))
5015 _dbus_warn ("error in array element\n");
5019 if (!dbus_message_iter_next (&child_iter))
5024 case DBUS_TYPE_DICT:
5029 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
5031 _dbus_warn ("Failed to init dict iterator\n");
5035 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5037 key = dbus_message_iter_get_dict_key (&child_iter);
5040 _dbus_warn ("error reading dict key\n");
5045 if (!check_message_handling_type (&child_iter, entry_type))
5047 _dbus_warn ("error in dict value\n");
5051 if (!dbus_message_iter_next (&child_iter))
5058 _dbus_warn ("unknown type %d\n", type);
5067 check_message_handling (DBusMessage *message)
5069 DBusMessageIter iter;
5072 dbus_uint32_t client_serial;
5076 client_serial = dbus_message_get_serial (message);
5078 /* can't use set_serial due to the assertions at the start of it */
5079 set_uint_field (message, FIELD_CLIENT_SERIAL,
5082 if (client_serial != dbus_message_get_serial (message))
5084 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5088 /* If we implement message_set_arg (message, n, value)
5089 * then we would want to test it here
5092 dbus_message_iter_init (message, &iter);
5093 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5095 if (!check_message_handling_type (&iter, type))
5098 if (!dbus_message_iter_next (&iter))
5109 check_have_valid_message (DBusMessageLoader *loader)
5111 DBusMessage *message;
5117 if (!_dbus_message_loader_queue_messages (loader))
5118 _dbus_assert_not_reached ("no memory to queue messages");
5120 if (_dbus_message_loader_get_is_corrupted (loader))
5122 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5126 message = _dbus_message_loader_pop_message (loader);
5127 if (message == NULL)
5129 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5133 if (_dbus_string_get_length (&loader->data) > 0)
5135 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5139 /* Verify that we're able to properly deal with the message.
5140 * For example, this would detect improper handling of messages
5141 * in nonstandard byte order.
5143 if (!check_message_handling (message))
5150 dbus_message_unref (message);
5156 check_invalid_message (DBusMessageLoader *loader)
5162 if (!_dbus_message_loader_queue_messages (loader))
5163 _dbus_assert_not_reached ("no memory to queue messages");
5165 if (!_dbus_message_loader_get_is_corrupted (loader))
5167 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
5178 check_incomplete_message (DBusMessageLoader *loader)
5180 DBusMessage *message;
5186 if (!_dbus_message_loader_queue_messages (loader))
5187 _dbus_assert_not_reached ("no memory to queue messages");
5189 if (_dbus_message_loader_get_is_corrupted (loader))
5191 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
5195 message = _dbus_message_loader_pop_message (loader);
5196 if (message != NULL)
5198 _dbus_warn ("loaded message that was expected to be incomplete\n");
5206 dbus_message_unref (message);
5211 check_loader_results (DBusMessageLoader *loader,
5212 DBusMessageValidity validity)
5214 if (!_dbus_message_loader_queue_messages (loader))
5215 _dbus_assert_not_reached ("no memory to queue messages");
5219 case _DBUS_MESSAGE_VALID:
5220 return check_have_valid_message (loader);
5221 case _DBUS_MESSAGE_INVALID:
5222 return check_invalid_message (loader);
5223 case _DBUS_MESSAGE_INCOMPLETE:
5224 return check_incomplete_message (loader);
5225 case _DBUS_MESSAGE_UNKNOWN:
5229 _dbus_assert_not_reached ("bad DBusMessageValidity");
5235 * Loads the message in the given message file.
5237 * @param filename filename to load
5238 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5239 * @param data string to load message into
5240 * @returns #TRUE if the message was loaded
5243 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
5255 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
5256 dbus_error_init (&error);
5257 if (!_dbus_file_get_contents (data, filename, &error))
5259 _dbus_warn ("Could not load message file %s: %s\n",
5260 _dbus_string_get_const_data (filename),
5262 dbus_error_free (&error);
5268 if (!_dbus_message_data_load (data, filename))
5270 _dbus_warn ("Could not load message file %s\n",
5271 _dbus_string_get_const_data (filename));
5284 * Tries loading the message in the given message file
5285 * and verifies that DBusMessageLoader can handle it.
5287 * @param filename filename to load
5288 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5289 * @param expected_validity what the message has to be like to return #TRUE
5290 * @returns #TRUE if the message has the expected validity
5293 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
5295 DBusMessageValidity expected_validity)
5302 if (!_dbus_string_init (&data))
5303 _dbus_assert_not_reached ("could not allocate string\n");
5305 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
5309 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
5315 if (_dbus_string_get_length (&data) > 0)
5316 _dbus_verbose_bytes_of_string (&data, 0,
5317 _dbus_string_get_length (&data));
5319 _dbus_warn ("Failed message loader test on %s\n",
5320 _dbus_string_get_const_data (filename));
5323 _dbus_string_free (&data);
5329 * Tries loading the given message data.
5332 * @param data the message data
5333 * @param expected_validity what the message has to be like to return #TRUE
5334 * @returns #TRUE if the message has the expected validity
5337 dbus_internal_do_not_use_try_message_data (const DBusString *data,
5338 DBusMessageValidity expected_validity)
5340 DBusMessageLoader *loader;
5348 /* Write the data one byte at a time */
5350 loader = _dbus_message_loader_new ();
5352 /* check some trivial loader functions */
5353 _dbus_message_loader_ref (loader);
5354 _dbus_message_loader_unref (loader);
5355 _dbus_message_loader_get_max_message_size (loader);
5357 len = _dbus_string_get_length (data);
5358 for (i = 0; i < len; i++)
5362 _dbus_message_loader_get_buffer (loader, &buffer);
5363 _dbus_string_append_byte (buffer,
5364 _dbus_string_get_byte (data, i));
5365 _dbus_message_loader_return_buffer (loader, buffer, 1);
5368 if (!check_loader_results (loader, expected_validity))
5371 _dbus_message_loader_unref (loader);
5374 /* Write the data all at once */
5376 loader = _dbus_message_loader_new ();
5381 _dbus_message_loader_get_buffer (loader, &buffer);
5382 _dbus_string_copy (data, 0, buffer,
5383 _dbus_string_get_length (buffer));
5384 _dbus_message_loader_return_buffer (loader, buffer, 1);
5387 if (!check_loader_results (loader, expected_validity))
5390 _dbus_message_loader_unref (loader);
5393 /* Write the data 2 bytes at a time */
5395 loader = _dbus_message_loader_new ();
5397 len = _dbus_string_get_length (data);
5398 for (i = 0; i < len; i += 2)
5402 _dbus_message_loader_get_buffer (loader, &buffer);
5403 _dbus_string_append_byte (buffer,
5404 _dbus_string_get_byte (data, i));
5406 _dbus_string_append_byte (buffer,
5407 _dbus_string_get_byte (data, i+1));
5408 _dbus_message_loader_return_buffer (loader, buffer, 1);
5411 if (!check_loader_results (loader, expected_validity))
5414 _dbus_message_loader_unref (loader);
5422 _dbus_message_loader_unref (loader);
5428 process_test_subdir (const DBusString *test_base_dir,
5430 DBusMessageValidity validity,
5431 DBusForeachMessageFileFunc function,
5434 DBusString test_directory;
5435 DBusString filename;
5443 if (!_dbus_string_init (&test_directory))
5444 _dbus_assert_not_reached ("didn't allocate test_directory\n");
5446 _dbus_string_init_const (&filename, subdir);
5448 if (!_dbus_string_copy (test_base_dir, 0,
5449 &test_directory, 0))
5450 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
5452 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
5453 _dbus_assert_not_reached ("couldn't allocate full path");
5455 _dbus_string_free (&filename);
5456 if (!_dbus_string_init (&filename))
5457 _dbus_assert_not_reached ("didn't allocate filename string\n");
5459 dbus_error_init (&error);
5460 dir = _dbus_directory_open (&test_directory, &error);
5463 _dbus_warn ("Could not open %s: %s\n",
5464 _dbus_string_get_const_data (&test_directory),
5466 dbus_error_free (&error);
5470 printf ("Testing:\n");
5473 while (_dbus_directory_get_next_file (dir, &filename, &error))
5475 DBusString full_path;
5478 if (!_dbus_string_init (&full_path))
5479 _dbus_assert_not_reached ("couldn't init string");
5481 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
5482 _dbus_assert_not_reached ("couldn't copy dir to full_path");
5484 if (!_dbus_concat_dir_and_file (&full_path, &filename))
5485 _dbus_assert_not_reached ("couldn't concat file to dir");
5487 if (_dbus_string_ends_with_c_str (&filename, ".message"))
5489 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
5493 _dbus_verbose ("Skipping non-.message file %s\n",
5494 _dbus_string_get_const_data (&filename));
5495 _dbus_string_free (&full_path);
5500 _dbus_string_get_const_data (&filename));
5502 _dbus_verbose (" expecting %s\n",
5503 validity == _DBUS_MESSAGE_VALID ? "valid" :
5504 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
5505 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
5507 if (! (*function) (&full_path, is_raw, validity, user_data))
5509 _dbus_string_free (&full_path);
5513 _dbus_string_free (&full_path);
5516 if (dbus_error_is_set (&error))
5518 _dbus_warn ("Could not get next file in %s: %s\n",
5519 _dbus_string_get_const_data (&test_directory),
5521 dbus_error_free (&error);
5530 _dbus_directory_close (dir);
5531 _dbus_string_free (&test_directory);
5532 _dbus_string_free (&filename);
5538 * Runs the given function on every message file in the test suite.
5539 * The function should return #FALSE on test failure or fatal error.
5541 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
5542 * @param func the function to run
5543 * @param user_data data for function
5544 * @returns #FALSE if there's a failure
5547 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
5548 DBusForeachMessageFileFunc func,
5551 DBusString test_directory;
5556 _dbus_string_init_const (&test_directory, test_data_dir);
5558 if (!process_test_subdir (&test_directory, "valid-messages",
5559 _DBUS_MESSAGE_VALID, func, user_data))
5562 if (!process_test_subdir (&test_directory, "invalid-messages",
5563 _DBUS_MESSAGE_INVALID, func, user_data))
5566 if (!process_test_subdir (&test_directory, "incomplete-messages",
5567 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
5574 _dbus_string_free (&test_directory);
5580 verify_test_message (DBusMessage *message)
5582 DBusMessageIter iter, dict;
5584 dbus_int32_t our_int;
5587 dbus_bool_t our_bool;
5588 dbus_uint32_t our_uint32;
5589 dbus_int32_t *our_uint32_array;
5590 int our_uint32_array_len;
5591 dbus_int32_t *our_int32_array;
5592 int our_int32_array_len;
5593 char **our_string_array;
5594 int our_string_array_len;
5595 #ifdef DBUS_HAVE_INT64
5596 dbus_int64_t our_int64;
5597 dbus_uint64_t our_uint64;
5598 dbus_int64_t *our_uint64_array;
5599 int our_uint64_array_len;
5600 dbus_int64_t *our_int64_array;
5601 int our_int64_array_len;
5603 double *our_double_array;
5604 int our_double_array_len;
5605 unsigned char *our_byte_array;
5606 int our_byte_array_len;
5607 unsigned char *our_boolean_array;
5608 int our_boolean_array_len;
5610 dbus_message_iter_init (message, &iter);
5612 dbus_error_init (&error);
5613 if (!dbus_message_iter_get_args (&iter, &error,
5614 DBUS_TYPE_INT32, &our_int,
5615 #ifdef DBUS_HAVE_INT64
5616 DBUS_TYPE_INT64, &our_int64,
5617 DBUS_TYPE_UINT64, &our_uint64,
5619 DBUS_TYPE_STRING, &our_str,
5620 DBUS_TYPE_DOUBLE, &our_double,
5621 DBUS_TYPE_BOOLEAN, &our_bool,
5622 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
5623 &our_uint32_array, &our_uint32_array_len,
5624 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
5625 &our_int32_array, &our_int32_array_len,
5626 #ifdef DBUS_HAVE_INT64
5627 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
5628 &our_uint64_array, &our_uint64_array_len,
5629 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
5630 &our_int64_array, &our_int64_array_len,
5632 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
5633 &our_string_array, &our_string_array_len,
5634 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
5635 &our_double_array, &our_double_array_len,
5636 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
5637 &our_byte_array, &our_byte_array_len,
5638 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
5639 &our_boolean_array, &our_boolean_array_len,
5642 _dbus_warn ("error: %s - %s\n", error.name,
5643 (error.message != NULL) ? error.message : "no message");
5644 _dbus_assert_not_reached ("Could not get arguments");
5647 if (our_int != -0x12345678)
5648 _dbus_assert_not_reached ("integers differ!");
5650 #ifdef DBUS_HAVE_INT64
5651 if (our_int64 != -0x123456789abcd)
5652 _dbus_assert_not_reached ("64-bit integers differ!");
5653 if (our_uint64 != 0x123456789abcd)
5654 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
5657 if (our_double != 3.14159)
5658 _dbus_assert_not_reached ("doubles differ!");
5660 if (strcmp (our_str, "Test string") != 0)
5661 _dbus_assert_not_reached ("strings differ!");
5662 dbus_free (our_str);
5665 _dbus_assert_not_reached ("booleans differ");
5667 if (our_uint32_array_len != 4 ||
5668 our_uint32_array[0] != 0x12345678 ||
5669 our_uint32_array[1] != 0x23456781 ||
5670 our_uint32_array[2] != 0x34567812 ||
5671 our_uint32_array[3] != 0x45678123)
5672 _dbus_assert_not_reached ("uint array differs");
5673 dbus_free (our_uint32_array);
5675 if (our_int32_array_len != 4 ||
5676 our_int32_array[0] != 0x12345678 ||
5677 our_int32_array[1] != -0x23456781 ||
5678 our_int32_array[2] != 0x34567812 ||
5679 our_int32_array[3] != -0x45678123)
5680 _dbus_assert_not_reached ("int array differs");
5681 dbus_free (our_int32_array);
5683 #ifdef DBUS_HAVE_INT64
5684 if (our_uint64_array_len != 4 ||
5685 our_uint64_array[0] != 0x12345678 ||
5686 our_uint64_array[1] != 0x23456781 ||
5687 our_uint64_array[2] != 0x34567812 ||
5688 our_uint64_array[3] != 0x45678123)
5689 _dbus_assert_not_reached ("uint64 array differs");
5690 dbus_free (our_uint64_array);
5692 if (our_int64_array_len != 4 ||
5693 our_int64_array[0] != 0x12345678 ||
5694 our_int64_array[1] != -0x23456781 ||
5695 our_int64_array[2] != 0x34567812 ||
5696 our_int64_array[3] != -0x45678123)
5697 _dbus_assert_not_reached ("int64 array differs");
5698 dbus_free (our_int64_array);
5699 #endif /* DBUS_HAVE_INT64 */
5701 if (our_string_array_len != 4)
5702 _dbus_assert_not_reached ("string array has wrong length");
5704 if (strcmp (our_string_array[0], "Foo") != 0 ||
5705 strcmp (our_string_array[1], "bar") != 0 ||
5706 strcmp (our_string_array[2], "") != 0 ||
5707 strcmp (our_string_array[3], "woo woo woo woo") != 0)
5708 _dbus_assert_not_reached ("string array differs");
5710 dbus_free_string_array (our_string_array);
5712 if (our_double_array_len != 3)
5713 _dbus_assert_not_reached ("double array had wrong length");
5715 /* On all IEEE machines (i.e. everything sane) exact equality
5716 * should be preserved over the wire
5718 if (our_double_array[0] != 0.1234 ||
5719 our_double_array[1] != 9876.54321 ||
5720 our_double_array[2] != -300.0)
5721 _dbus_assert_not_reached ("double array had wrong values");
5723 dbus_free (our_double_array);
5725 if (our_byte_array_len != 4)
5726 _dbus_assert_not_reached ("byte array had wrong length");
5728 if (our_byte_array[0] != 'a' ||
5729 our_byte_array[1] != 'b' ||
5730 our_byte_array[2] != 'c' ||
5731 our_byte_array[3] != 234)
5732 _dbus_assert_not_reached ("byte array had wrong values");
5734 dbus_free (our_byte_array);
5736 if (our_boolean_array_len != 5)
5737 _dbus_assert_not_reached ("bool array had wrong length");
5739 if (our_boolean_array[0] != TRUE ||
5740 our_boolean_array[1] != FALSE ||
5741 our_boolean_array[2] != TRUE ||
5742 our_boolean_array[3] != TRUE ||
5743 our_boolean_array[4] != FALSE)
5744 _dbus_assert_not_reached ("bool array had wrong values");
5746 dbus_free (our_boolean_array);
5748 if (!dbus_message_iter_next (&iter))
5749 _dbus_assert_not_reached ("Reached end of arguments");
5751 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5752 _dbus_assert_not_reached ("not dict type");
5754 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
5755 _dbus_assert_not_reached ("dict iter failed");
5757 our_str = dbus_message_iter_get_dict_key (&dict);
5758 if (our_str == NULL || strcmp (our_str, "test") != 0)
5759 _dbus_assert_not_reached ("wrong dict key");
5760 dbus_free (our_str);
5762 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5764 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
5765 _dbus_assert_not_reached ("wrong dict entry type");
5768 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
5770 _dbus_verbose ("dict entry val: %x\n", our_uint32);
5771 _dbus_assert_not_reached ("wrong dict entry value");
5774 if (dbus_message_iter_next (&dict))
5775 _dbus_assert_not_reached ("Didn't reach end of dict");
5777 if (!dbus_message_iter_next (&iter))
5778 _dbus_assert_not_reached ("Reached end of arguments");
5780 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5781 _dbus_assert_not_reached ("wrong type after dict");
5783 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
5784 _dbus_assert_not_reached ("wrong value after dict");
5786 if (dbus_message_iter_next (&iter))
5787 _dbus_assert_not_reached ("Didn't reach end of arguments");
5791 * @ingroup DBusMessageInternals
5792 * Unit test for DBusMessage.
5794 * @returns #TRUE on success.
5797 _dbus_message_test (const char *test_data_dir)
5799 DBusMessage *message;
5800 DBusMessageLoader *loader;
5801 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
5807 const dbus_uint32_t our_uint32_array[] =
5808 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5809 const dbus_uint32_t our_int32_array[] =
5810 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5811 #ifdef DBUS_HAVE_INT64
5812 const dbus_uint64_t our_uint64_array[] =
5813 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5814 const dbus_uint64_t our_int64_array[] =
5815 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5817 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
5818 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
5819 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
5820 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
5822 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
5824 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5825 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5826 _dbus_message_set_serial (message, 1234);
5827 dbus_message_set_sender (message, "org.foo.bar");
5828 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar"));
5829 dbus_message_set_sender (message, NULL);
5830 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar"));
5831 _dbus_assert (dbus_message_get_serial (message) == 1234);
5832 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5834 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5835 dbus_message_set_is_error (message, TRUE);
5836 _dbus_assert (dbus_message_get_is_error (message) == TRUE);
5837 dbus_message_set_is_error (message, FALSE);
5838 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5840 dbus_message_unref (message);
5842 /* Test the vararg functions */
5843 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5844 _dbus_message_set_serial (message, 1);
5845 dbus_message_append_args (message,
5846 DBUS_TYPE_INT32, -0x12345678,
5847 #ifdef DBUS_HAVE_INT64
5848 DBUS_TYPE_INT64, -0x123456789abcd,
5849 DBUS_TYPE_UINT64, 0x123456789abcd,
5851 DBUS_TYPE_STRING, "Test string",
5852 DBUS_TYPE_DOUBLE, 3.14159,
5853 DBUS_TYPE_BOOLEAN, TRUE,
5854 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
5855 _DBUS_N_ELEMENTS (our_uint32_array),
5856 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
5857 _DBUS_N_ELEMENTS (our_int32_array),
5858 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
5859 _DBUS_N_ELEMENTS (our_uint64_array),
5860 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
5861 _DBUS_N_ELEMENTS (our_int64_array),
5862 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
5863 _DBUS_N_ELEMENTS (our_string_array),
5864 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
5865 _DBUS_N_ELEMENTS (our_double_array),
5866 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
5867 _DBUS_N_ELEMENTS (our_byte_array),
5868 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
5869 _DBUS_N_ELEMENTS (our_boolean_array),
5872 dbus_message_append_iter_init (message, &iter);
5873 dbus_message_iter_append_dict (&iter, &child_iter);
5874 dbus_message_iter_append_dict_key (&child_iter, "test");
5875 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
5876 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
5878 _dbus_verbose_bytes_of_string (&message->header, 0,
5879 _dbus_string_get_length (&message->header));
5880 _dbus_verbose_bytes_of_string (&message->body, 0,
5881 _dbus_string_get_length (&message->body));
5883 verify_test_message (message);
5885 copy = dbus_message_copy (message);
5887 _dbus_assert (message->client_serial == copy->client_serial);
5888 _dbus_assert (message->reply_serial == copy->reply_serial);
5889 _dbus_assert (message->header_padding == copy->header_padding);
5891 _dbus_assert (_dbus_string_get_length (&message->header) ==
5892 _dbus_string_get_length (©->header));
5894 _dbus_assert (_dbus_string_get_length (&message->body) ==
5895 _dbus_string_get_length (©->body));
5897 verify_test_message (copy);
5899 name1 = dbus_message_get_name (message);
5900 name2 = dbus_message_get_name (copy);
5902 _dbus_assert (strcmp (name1, name2) == 0);
5904 dbus_message_unref (message);
5905 dbus_message_unref (copy);
5907 message = dbus_message_new ("test.Message", "org.freedesktop.DBus.Test");
5908 _dbus_message_set_serial (message, 1);
5909 dbus_message_set_reply_serial (message, 0x12345678);
5911 dbus_message_append_iter_init (message, &iter);
5912 dbus_message_iter_append_string (&iter, "Test string");
5913 dbus_message_iter_append_int32 (&iter, -0x12345678);
5914 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
5915 dbus_message_iter_append_double (&iter, 3.14159);
5917 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
5918 dbus_message_iter_append_double (&child_iter, 1.5);
5919 dbus_message_iter_append_double (&child_iter, 2.5);
5922 dbus_message_iter_append_dict (&iter, &child_iter);
5923 dbus_message_iter_append_dict_key (&child_iter, "test");
5924 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
5926 /* array of array of int32 (in dict) */
5927 dbus_message_iter_append_dict_key (&child_iter, "array");
5928 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
5929 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
5930 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
5931 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
5932 _dbus_warn ("next call expected to fail with wrong array type\n");
5933 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
5934 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
5935 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
5936 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
5937 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
5939 dbus_message_iter_append_byte (&iter, 0xF0);
5941 dbus_message_iter_append_nil (&iter);
5943 dbus_message_iter_append_named (&iter, "named",
5946 message_iter_test (message);
5948 /* Message loader test */
5949 _dbus_message_lock (message);
5950 loader = _dbus_message_loader_new ();
5952 /* check ref/unref */
5953 _dbus_message_loader_ref (loader);
5954 _dbus_message_loader_unref (loader);
5956 /* Write the header data one byte at a time */
5957 data = _dbus_string_get_const_data (&message->header);
5958 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
5962 _dbus_message_loader_get_buffer (loader, &buffer);
5963 _dbus_string_append_byte (buffer, data[i]);
5964 _dbus_message_loader_return_buffer (loader, buffer, 1);
5967 /* Write the body data one byte at a time */
5968 data = _dbus_string_get_const_data (&message->body);
5969 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
5973 _dbus_message_loader_get_buffer (loader, &buffer);
5974 _dbus_string_append_byte (buffer, data[i]);
5975 _dbus_message_loader_return_buffer (loader, buffer, 1);
5978 dbus_message_unref (message);
5980 /* Now pop back the message */
5981 if (!_dbus_message_loader_queue_messages (loader))
5982 _dbus_assert_not_reached ("no memory to queue messages");
5984 if (_dbus_message_loader_get_is_corrupted (loader))
5985 _dbus_assert_not_reached ("message loader corrupted");
5987 message = _dbus_message_loader_pop_message (loader);
5989 _dbus_assert_not_reached ("received a NULL message");
5991 if (dbus_message_get_reply_serial (message) != 0x12345678)
5992 _dbus_assert_not_reached ("reply serial fields differ");
5994 message_iter_test (message);
5996 dbus_message_unref (message);
5997 _dbus_message_loader_unref (loader);
5999 /* Now load every message in test_data_dir if we have one */
6000 if (test_data_dir == NULL)
6003 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6004 (DBusForeachMessageFileFunc)
6005 dbus_internal_do_not_use_try_message_file,
6009 #endif /* DBUS_BUILD_TESTS */