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
76 #define BYTE_ORDER_OFFSET 0
78 #define FLAGS_OFFSET 2
79 #define VERSION_OFFSET 3
82 * @brief Internals of DBusMessage
84 * Object representing a message received from or to be sent to
85 * another application. This is an opaque object, all members
90 DBusAtomic refcount; /**< Reference count */
92 DBusString header; /**< Header network data, stored
93 * separately from body so we can
94 * independently realloc it.
97 HeaderField header_fields[FIELD_LAST]; /**< Track the location
98 * of each field in "header"
101 dbus_uint32_t client_serial; /**< Cached client serial value for speed */
102 dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
104 int header_padding; /**< bytes of alignment in header */
106 DBusString body; /**< Body network data. */
108 char byte_order; /**< Message byte order. */
110 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
111 long size_counter_delta; /**< Size we incremented the size counters by. */
113 dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
115 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
117 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
121 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
122 DBUS_MESSAGE_ITER_TYPE_ARRAY,
123 DBUS_MESSAGE_ITER_TYPE_DICT
126 /** typedef for internals of message iterator */
127 typedef struct DBusMessageRealIter DBusMessageRealIter;
130 * @brief Internals of DBusMessageIter
132 * Object representing a position in a message. All fields are internal.
134 struct DBusMessageRealIter
136 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
137 DBusMessage *message; /**< Message used */
138 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
140 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
141 int type; /**< type of iter */
143 int pos; /**< Current position in the string */
144 int end; /**< position right after the container */
145 int container_start; /**< offset of the start of the container */
146 int container_length_pos; /**< offset of the length of the container */
148 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
150 int array_type_pos; /**< pointer to the position of the array element type */
151 int array_type_done; /**< TRUE if the array type is fully finished */
155 * Gets the data to be sent over the network for this message.
156 * The header and then the body should be written out.
157 * This function is guaranteed to always return the same
158 * data once a message is locked (with _dbus_message_lock()).
160 * @param message the message.
161 * @param header return location for message header data.
162 * @param body return location for message body data.
165 _dbus_message_get_network_data (DBusMessage *message,
166 const DBusString **header,
167 const DBusString **body)
169 _dbus_assert (message->locked);
171 *header = &message->header;
172 *body = &message->body;
176 clear_header_padding (DBusMessage *message)
178 _dbus_string_shorten (&message->header,
179 message->header_padding);
180 message->header_padding = 0;
184 append_header_padding (DBusMessage *message)
187 old_len = _dbus_string_get_length (&message->header);
188 if (!_dbus_string_align_length (&message->header, 8))
191 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
197 adjust_field_offsets (DBusMessage *message,
207 while (i < FIELD_LAST)
209 if (message->header_fields[i].offset > offsets_after)
210 message->header_fields[i].offset += delta;
216 #ifdef DBUS_BUILD_TESTS
217 /* tests-only until it's actually used */
219 get_int_field (DBusMessage *message,
224 _dbus_assert (field < FIELD_LAST);
226 offset = message->header_fields[field].offset;
229 return -1; /* useless if -1 is a valid value of course */
231 return _dbus_demarshal_int32 (&message->header,
239 get_uint_field (DBusMessage *message,
244 _dbus_assert (field < FIELD_LAST);
246 offset = message->header_fields[field].offset;
249 return -1; /* useless if -1 is a valid value of course */
251 return _dbus_demarshal_uint32 (&message->header,
258 get_string_field (DBusMessage *message,
265 offset = message->header_fields[field].offset;
267 _dbus_assert (field < FIELD_LAST);
272 /* offset points to string length, string data follows it */
273 /* FIXME _dbus_demarshal_const_string() that returned
274 * a reference to the string plus its len might be nice.
278 *len = _dbus_demarshal_uint32 (&message->header,
283 data = _dbus_string_get_const_data (&message->header);
285 return data + (offset + 4);
288 #ifdef DBUS_BUILD_TESTS
290 append_int_field (DBusMessage *message,
297 _dbus_assert (!message->locked);
299 clear_header_padding (message);
301 orig_len = _dbus_string_get_length (&message->header);
303 if (!_dbus_string_align_length (&message->header, 4))
306 if (!_dbus_string_append_len (&message->header, name, 4))
309 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
312 if (!_dbus_string_align_length (&message->header, 4))
315 message->header_fields[field].offset =
316 _dbus_string_get_length (&message->header);
318 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
322 if (!append_header_padding (message))
328 message->header_fields[field].offset = -1;
329 _dbus_string_set_length (&message->header, orig_len);
331 /* this must succeed because it was allocated on function entry and
332 * DBusString doesn't ever realloc smaller
334 if (!append_header_padding (message))
335 _dbus_assert_not_reached ("failed to reappend header padding");
341 append_uint_field (DBusMessage *message,
348 _dbus_assert (!message->locked);
350 clear_header_padding (message);
352 orig_len = _dbus_string_get_length (&message->header);
354 if (!_dbus_string_align_length (&message->header, 4))
357 if (!_dbus_string_append_len (&message->header, name, 4))
360 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
363 if (!_dbus_string_align_length (&message->header, 4))
366 message->header_fields[field].offset =
367 _dbus_string_get_length (&message->header);
369 if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
373 if (!append_header_padding (message))
379 message->header_fields[field].offset = -1;
380 _dbus_string_set_length (&message->header, orig_len);
382 /* this must succeed because it was allocated on function entry and
383 * DBusString doesn't ever realloc smaller
385 if (!append_header_padding (message))
386 _dbus_assert_not_reached ("failed to reappend header padding");
391 append_string_field (DBusMessage *message,
398 _dbus_assert (!message->locked);
400 clear_header_padding (message);
402 orig_len = _dbus_string_get_length (&message->header);
404 if (!_dbus_string_align_length (&message->header, 4))
407 if (!_dbus_string_append_len (&message->header, name, 4))
410 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
413 if (!_dbus_string_align_length (&message->header, 4))
416 message->header_fields[field].offset =
417 _dbus_string_get_length (&message->header);
419 if (!_dbus_marshal_string (&message->header, message->byte_order,
423 if (!append_header_padding (message))
429 message->header_fields[field].offset = -1;
430 _dbus_string_set_length (&message->header, orig_len);
432 /* this must succeed because it was allocated on function entry and
433 * DBusString doesn't ever realloc smaller
435 if (!append_header_padding (message))
436 _dbus_assert_not_reached ("failed to reappend header padding");
441 #ifdef DBUS_BUILD_TESTS
442 /* This isn't used, but building it when tests are enabled just to
443 * keep it compiling if we need it in future
446 delete_int_or_uint_field (DBusMessage *message,
449 int offset = message->header_fields[field].offset;
451 _dbus_assert (!message->locked);
452 _dbus_assert (field_is_named[field]);
457 clear_header_padding (message);
459 /* The field typecode and name take up 8 bytes */
460 _dbus_string_delete (&message->header,
464 message->header_fields[field].offset = -1;
466 adjust_field_offsets (message,
470 append_header_padding (message);
475 delete_string_field (DBusMessage *message,
478 int offset = message->header_fields[field].offset;
482 _dbus_assert (!message->locked);
483 _dbus_assert (field_is_named[field]);
488 clear_header_padding (message);
490 get_string_field (message, field, &len);
492 /* The field typecode and name take up 8 bytes, and the nul
493 * termination is 1 bytes, string length integer is 4 bytes
495 delete_len = 8 + 4 + 1 + len;
497 _dbus_string_delete (&message->header,
501 message->header_fields[field].offset = -1;
503 adjust_field_offsets (message,
507 append_header_padding (message);
510 #ifdef DBUS_BUILD_TESTS
512 set_int_field (DBusMessage *message,
516 int offset = message->header_fields[field].offset;
518 _dbus_assert (!message->locked);
522 /* need to append the field */
527 _dbus_assert_not_reached ("appending an int field we don't support appending");
533 _dbus_marshal_set_int32 (&message->header,
543 set_uint_field (DBusMessage *message,
547 int offset = message->header_fields[field].offset;
549 _dbus_assert (!message->locked);
553 /* need to append the field */
557 case FIELD_REPLY_SERIAL:
558 return append_uint_field (message, field,
559 DBUS_HEADER_FIELD_REPLY,
562 _dbus_assert_not_reached ("appending a uint field we don't support appending");
568 _dbus_marshal_set_uint32 (&message->header,
577 set_string_field (DBusMessage *message,
581 int offset = message->header_fields[field].offset;
583 _dbus_assert (!message->locked);
584 _dbus_assert (value != NULL);
588 /* need to append the field */
593 return append_string_field (message, field,
594 DBUS_HEADER_FIELD_SENDER,
597 _dbus_assert_not_reached ("appending a string field we don't support appending");
608 clear_header_padding (message);
610 old_len = _dbus_string_get_length (&message->header);
612 len = strlen (value);
614 _dbus_string_init_const_len (&v, value,
615 len + 1); /* include nul */
616 if (!_dbus_marshal_set_string (&message->header,
622 new_len = _dbus_string_get_length (&message->header);
624 adjust_field_offsets (message,
628 if (!append_header_padding (message))
634 /* this must succeed because it was allocated on function entry and
635 * DBusString doesn't ever realloc smaller
637 if (!append_header_padding (message))
638 _dbus_assert_not_reached ("failed to reappend header padding");
645 * Sets the serial number of a message.
646 * This can only be done once on a message.
648 * @param message the message
649 * @param serial the serial
652 _dbus_message_set_serial (DBusMessage *message,
655 _dbus_assert (!message->locked);
656 _dbus_assert (dbus_message_get_serial (message) == 0);
658 set_uint_field (message, FIELD_CLIENT_SERIAL,
660 message->client_serial = serial;
664 * Sets the reply serial of a message (the client serial
665 * of the message this is a reply to).
667 * @param message the message
668 * @param reply_serial the client serial
669 * @returns #FALSE if not enough memory
672 dbus_message_set_reply_serial (DBusMessage *message,
673 dbus_uint32_t reply_serial)
675 _dbus_assert (!message->locked);
677 if (set_uint_field (message, FIELD_REPLY_SERIAL,
680 message->reply_serial = reply_serial;
688 * Returns the serial of a message or -1 if none has been specified.
689 * The message's serial number is provided by the application sending
690 * the message and is used to identify replies to this message.
692 * @param message the message
693 * @returns the client serial
696 dbus_message_get_serial (DBusMessage *message)
698 return message->client_serial;
702 * Returns the serial that the message is
703 * a reply to or 0 if none.
705 * @param message the message
706 * @returns the reply serial
709 dbus_message_get_reply_serial (DBusMessage *message)
711 return message->reply_serial;
715 * Adds a counter to be incremented immediately with the
716 * size of this message, and decremented by the size
717 * of this message when this message if finalized.
718 * The link contains a counter with its refcount already
719 * incremented, but the counter itself not incremented.
720 * Ownership of link and counter refcount is passed to
723 * @param message the message
724 * @param link link with counter as data
727 _dbus_message_add_size_counter_link (DBusMessage *message,
730 /* right now we don't recompute the delta when message
731 * size changes, and that's OK for current purposes
732 * I think, but could be important to change later.
733 * Do recompute it whenever there are no outstanding counters,
734 * since it's basically free.
736 if (message->size_counters == NULL)
738 message->size_counter_delta =
739 _dbus_string_get_length (&message->header) +
740 _dbus_string_get_length (&message->body);
743 _dbus_verbose ("message has size %ld\n",
744 message->size_counter_delta);
748 _dbus_list_append_link (&message->size_counters, link);
750 _dbus_counter_adjust (link->data, message->size_counter_delta);
754 * Adds a counter to be incremented immediately with the
755 * size of this message, and decremented by the size
756 * of this message when this message if finalized.
758 * @param message the message
759 * @param counter the counter
760 * @returns #FALSE if no memory
763 _dbus_message_add_size_counter (DBusMessage *message,
764 DBusCounter *counter)
768 link = _dbus_list_alloc_link (counter);
772 _dbus_counter_ref (counter);
773 _dbus_message_add_size_counter_link (message, link);
779 * Removes a counter tracking the size of this message, and decrements
780 * the counter by the size of this message.
782 * @param message the message
783 * @param link_return return the link used
784 * @param counter the counter
787 _dbus_message_remove_size_counter (DBusMessage *message,
788 DBusCounter *counter,
789 DBusList **link_return)
793 link = _dbus_list_find_last (&message->size_counters,
795 _dbus_assert (link != NULL);
797 _dbus_list_unlink (&message->size_counters,
802 _dbus_list_free_link (link);
804 _dbus_counter_adjust (counter, message->size_counter_delta);
806 _dbus_counter_unref (counter);
810 dbus_message_create_header (DBusMessage *message,
817 if (!_dbus_string_append_byte (&message->header, message->byte_order))
820 if (!_dbus_string_append_byte (&message->header, type))
824 if (!_dbus_string_append_byte (&message->header, flags))
827 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
830 message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
831 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
834 message->header_fields[FIELD_BODY_LENGTH].offset = 8;
835 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
838 message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
839 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
842 /* Marshal message service */
845 if (!append_string_field (message,
847 DBUS_HEADER_FIELD_SERVICE,
852 _dbus_assert (name != NULL);
853 if (!append_string_field (message,
855 DBUS_HEADER_FIELD_NAME,
863 * Locks a message. Allows checking that applications don't keep a
864 * reference to a message in the outgoing queue and change it
865 * underneath us. Messages are locked when they enter the outgoing
866 * queue (dbus_connection_send_message()), and the library complains
867 * if the message is modified while locked.
869 * @param message the message to lock.
872 _dbus_message_lock (DBusMessage *message)
874 if (!message->locked)
876 /* Fill in our lengths */
877 set_uint_field (message,
879 _dbus_string_get_length (&message->header));
881 set_uint_field (message,
883 _dbus_string_get_length (&message->body));
885 message->locked = TRUE;
892 * @defgroup DBusMessage DBusMessage
894 * @brief Message to be sent or received over a DBusConnection.
896 * A DBusMessage is the most basic unit of communication over a
897 * DBusConnection. A DBusConnection represents a stream of messages
898 * received from a remote application, and a stream of messages
899 * sent to a remote application.
905 * @typedef DBusMessage
907 * Opaque data type representing a message received from or to be
908 * sent to another application.
912 dbus_message_new_empty_header (void)
914 DBusMessage *message;
917 message = dbus_new0 (DBusMessage, 1);
921 message->refcount.value = 1;
922 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
923 message->client_serial = 0;
924 message->reply_serial = 0;
926 _dbus_data_slot_list_init (&message->slot_list);
929 while (i < FIELD_LAST)
931 message->header_fields[i].offset = -1;
935 if (!_dbus_string_init_preallocated (&message->header, 64))
941 if (!_dbus_string_init_preallocated (&message->body, 64))
943 _dbus_string_free (&message->header);
953 * Constructs a new message to invoke a method on a remote
954 * object. Returns #NULL if memory can't be allocated for the
955 * message. The service may be #NULL in which case no service is set;
956 * this is appropriate when using D-BUS in a peer-to-peer context (no
959 * @param name name of the message
960 * @param destination_service service that the message should be sent to or #NULL
961 * @returns a new DBusMessage, free with dbus_message_unref()
962 * @see dbus_message_unref()
965 dbus_message_new_method_call (const char *name,
966 const char *destination_service)
968 DBusMessage *message;
970 _dbus_return_val_if_fail (name != NULL, NULL);
972 message = dbus_message_new_empty_header ();
976 if (!dbus_message_create_header (message,
977 DBUS_MESSAGE_TYPE_METHOD_CALL,
978 name, destination_service))
980 dbus_message_unref (message);
988 * Constructs a message that is a reply to a method call. Returns
989 * #NULL if memory can't be allocated for the message.
991 * @param method_call the message which the created
992 * message is a reply to.
993 * @returns a new DBusMessage, free with dbus_message_unref()
994 * @see dbus_message_new_method_call(), dbus_message_unref()
997 dbus_message_new_method_return (DBusMessage *method_call)
999 DBusMessage *message;
1000 const char *sender, *name;
1002 _dbus_return_val_if_fail (method_call != NULL, NULL);
1004 sender = get_string_field (method_call,
1005 FIELD_SENDER, NULL);
1006 name = get_string_field (method_call,
1009 /* sender is allowed to be null here in peer-to-peer case */
1011 message = dbus_message_new_empty_header ();
1012 if (message == NULL)
1015 if (!dbus_message_create_header (message,
1016 DBUS_MESSAGE_TYPE_METHOD_RETURN,
1019 dbus_message_unref (message);
1023 if (!dbus_message_set_reply_serial (message,
1024 dbus_message_get_serial (method_call)))
1026 dbus_message_unref (message);
1034 * Constructs a new message representing a signal emission. Returns
1035 * #NULL if memory can't be allocated for the message. The name
1036 * passed in is the name of the signal.
1038 * @param name name of the signal
1039 * @returns a new DBusMessage, free with dbus_message_unref()
1040 * @see dbus_message_unref()
1043 dbus_message_new_signal (const char *name)
1045 DBusMessage *message;
1047 _dbus_return_val_if_fail (name != NULL, NULL);
1049 message = dbus_message_new_empty_header ();
1050 if (message == NULL)
1053 if (!dbus_message_create_header (message,
1054 DBUS_MESSAGE_TYPE_SIGNAL,
1057 dbus_message_unref (message);
1065 * Creates a new message that is an error reply to a certain message.
1066 * Error replies are possible in response to method calls primarily.
1068 * @param reply_to the original message
1069 * @param error_name the error name
1070 * @param error_message the error message string or #NULL for none
1071 * @returns a new error message
1074 dbus_message_new_error (DBusMessage *reply_to,
1075 const char *error_name,
1076 const char *error_message)
1078 DBusMessage *message;
1080 DBusMessageIter iter;
1082 _dbus_return_val_if_fail (reply_to != NULL, NULL);
1083 _dbus_return_val_if_fail (error_name != NULL, NULL);
1085 sender = get_string_field (reply_to,
1086 FIELD_SENDER, NULL);
1088 /* sender may be NULL for non-message-bus case or
1089 * when the message bus is dealing with an unregistered
1092 message = dbus_message_new_empty_header ();
1093 if (message == NULL)
1096 if (!dbus_message_create_header (message,
1097 DBUS_MESSAGE_TYPE_ERROR,
1098 error_name, sender))
1100 dbus_message_unref (message);
1104 if (!dbus_message_set_reply_serial (message,
1105 dbus_message_get_serial (reply_to)))
1107 dbus_message_unref (message);
1111 if (error_message != NULL)
1113 dbus_message_append_iter_init (message, &iter);
1114 if (!dbus_message_iter_append_string (&iter, error_message))
1116 dbus_message_unref (message);
1121 dbus_message_set_is_error (message, TRUE);
1127 * Creates a new message that is an exact replica of the message
1128 * specified, except that its refcount is set to 1.
1130 * @param message the message.
1131 * @returns the new message.
1134 dbus_message_copy (const DBusMessage *message)
1136 DBusMessage *retval;
1139 _dbus_return_val_if_fail (message != NULL, NULL);
1141 retval = dbus_new0 (DBusMessage, 1);
1145 retval->refcount.value = 1;
1146 retval->byte_order = message->byte_order;
1147 retval->client_serial = message->client_serial;
1148 retval->reply_serial = message->reply_serial;
1149 retval->header_padding = message->header_padding;
1150 retval->locked = FALSE;
1152 if (!_dbus_string_init (&retval->header))
1158 if (!_dbus_string_init (&retval->body))
1160 _dbus_string_free (&retval->header);
1165 if (!_dbus_string_copy (&message->header, 0,
1166 &retval->header, 0))
1168 _dbus_string_free (&retval->header);
1169 _dbus_string_free (&retval->body);
1175 if (!_dbus_string_copy (&message->body, 0,
1178 _dbus_string_free (&retval->header);
1179 _dbus_string_free (&retval->body);
1185 for (i = 0; i < FIELD_LAST; i++)
1187 retval->header_fields[i].offset = message->header_fields[i].offset;
1195 * Increments the reference count of a DBusMessage.
1197 * @param message The message
1198 * @see dbus_message_unref
1201 dbus_message_ref (DBusMessage *message)
1203 dbus_int32_t old_refcount;
1205 _dbus_return_if_fail (message != NULL);
1207 old_refcount = _dbus_atomic_inc (&message->refcount);
1208 _dbus_assert (old_refcount >= 1);
1212 free_size_counter (void *element,
1215 DBusCounter *counter = element;
1216 DBusMessage *message = data;
1218 _dbus_counter_adjust (counter, - message->size_counter_delta);
1220 _dbus_counter_unref (counter);
1224 * Decrements the reference count of a DBusMessage.
1226 * @param message The message
1227 * @see dbus_message_ref
1230 dbus_message_unref (DBusMessage *message)
1232 dbus_int32_t old_refcount;
1234 _dbus_return_if_fail (message != NULL);
1236 old_refcount = _dbus_atomic_dec (&message->refcount);
1238 _dbus_assert (old_refcount >= 0);
1240 if (old_refcount == 1)
1242 /* This calls application callbacks! */
1243 _dbus_data_slot_list_free (&message->slot_list);
1245 _dbus_list_foreach (&message->size_counters,
1246 free_size_counter, message);
1247 _dbus_list_clear (&message->size_counters);
1249 _dbus_string_free (&message->header);
1250 _dbus_string_free (&message->body);
1252 dbus_free (message);
1257 * Gets the type of a message. Types include
1258 * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN,
1259 * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types
1260 * are allowed and all code must silently ignore messages of unknown
1261 * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however.
1264 * @param message the message
1265 * @returns the type of the message
1268 dbus_message_get_type (DBusMessage *message)
1272 type = _dbus_string_get_byte (&message->header, 1);
1273 _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID);
1279 * Gets the name of a message.
1281 * @param message the message
1282 * @returns the message name (should not be freed)
1285 dbus_message_get_name (DBusMessage *message)
1287 _dbus_return_val_if_fail (message != NULL, NULL);
1289 return get_string_field (message, FIELD_NAME, NULL);
1293 * Gets the destination service of a message.
1295 * @param message the message
1296 * @returns the message destination service (should not be freed)
1299 dbus_message_get_destination (DBusMessage *message)
1301 _dbus_return_val_if_fail (message != NULL, NULL);
1303 return get_string_field (message, FIELD_SERVICE, NULL);
1307 * Appends fields to a message given a variable argument list. The
1308 * variable argument list should contain the type of the argument
1309 * followed by the value to add. Array values are specified by an int
1310 * typecode followed by a pointer to the array followed by an int
1311 * giving the length of the array. The argument list must be
1312 * terminated with #DBUS_TYPE_INVALID.
1314 * This function doesn't support dicts or non-fundamental arrays.
1316 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1317 * only if #DBUS_HAVE_INT64 is defined.
1319 * @param message the message
1320 * @param first_arg_type type of the first argument
1321 * @param ... value of first argument, list of additional type-value pairs
1322 * @returns #TRUE on success
1325 dbus_message_append_args (DBusMessage *message,
1332 _dbus_return_val_if_fail (message != NULL, FALSE);
1334 va_start (var_args, first_arg_type);
1335 retval = dbus_message_append_args_valist (message,
1344 * This function takes a va_list for use by language bindings.
1345 * It's otherwise the same as dbus_message_append_args().
1347 * @todo: Shouldn't this function clean up the changes to the message
1348 * on failures? (Yes)
1350 * @see dbus_message_append_args.
1351 * @param message the message
1352 * @param first_arg_type type of first argument
1353 * @param var_args value of first argument, then list of type/value pairs
1354 * @returns #TRUE on success
1357 dbus_message_append_args_valist (DBusMessage *message,
1362 DBusMessageIter iter;
1364 _dbus_return_val_if_fail (message != NULL, FALSE);
1366 old_len = _dbus_string_get_length (&message->body);
1368 type = first_arg_type;
1370 dbus_message_append_iter_init (message, &iter);
1377 if (!dbus_message_iter_append_nil (&iter))
1380 case DBUS_TYPE_BOOLEAN:
1381 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1384 case DBUS_TYPE_INT32:
1385 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1388 case DBUS_TYPE_UINT32:
1389 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1392 #ifdef DBUS_HAVE_INT64
1393 case DBUS_TYPE_INT64:
1394 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1397 case DBUS_TYPE_UINT64:
1398 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1401 #endif /* DBUS_HAVE_INT64 */
1402 case DBUS_TYPE_DOUBLE:
1403 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1406 case DBUS_TYPE_STRING:
1407 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1410 case DBUS_TYPE_NAMED:
1413 unsigned char *data;
1416 name = va_arg (var_args, const char *);
1417 data = va_arg (var_args, unsigned char *);
1418 len = va_arg (var_args, int);
1420 if (!dbus_message_iter_append_named (&iter, name, data, len))
1424 case DBUS_TYPE_ARRAY:
1429 type = va_arg (var_args, int);
1430 data = va_arg (var_args, void *);
1431 len = va_arg (var_args, int);
1435 case DBUS_TYPE_BYTE:
1436 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1439 case DBUS_TYPE_BOOLEAN:
1440 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1443 case DBUS_TYPE_INT32:
1444 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1447 case DBUS_TYPE_UINT32:
1448 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1451 #ifdef DBUS_HAVE_INT64
1452 case DBUS_TYPE_INT64:
1453 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1456 case DBUS_TYPE_UINT64:
1457 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1460 #endif /* DBUS_HAVE_INT64 */
1461 case DBUS_TYPE_DOUBLE:
1462 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1465 case DBUS_TYPE_STRING:
1466 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1470 case DBUS_TYPE_ARRAY:
1471 case DBUS_TYPE_NAMED:
1472 case DBUS_TYPE_DICT:
1473 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1476 _dbus_warn ("Unknown field type %d\n", type);
1482 case DBUS_TYPE_DICT:
1483 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1486 _dbus_warn ("Unknown field type %d\n", type);
1490 type = va_arg (var_args, int);
1501 * Gets arguments from a message given a variable argument list.
1502 * The variable argument list should contain the type of the
1503 * argumen followed by a pointer to where the value should be
1504 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1506 * @param message the message
1507 * @param error error to be filled in on failure
1508 * @param first_arg_type the first argument type
1509 * @param ... location for first argument value, then list of type-location pairs
1510 * @returns #FALSE if the error was set
1513 dbus_message_get_args (DBusMessage *message,
1521 _dbus_return_val_if_fail (message != NULL, FALSE);
1522 _dbus_return_val_if_error_is_set (error, FALSE);
1524 va_start (var_args, first_arg_type);
1525 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1532 * This function takes a va_list for use by language bindings
1534 * @todo We need to free the argument data when an error occurs.
1536 * @see dbus_message_get_args
1537 * @param message the message
1538 * @param error error to be filled in
1539 * @param first_arg_type type of the first argument
1540 * @param var_args return location for first argument, followed by list of type/location pairs
1541 * @returns #FALSE if error was set
1544 dbus_message_get_args_valist (DBusMessage *message,
1549 DBusMessageIter iter;
1551 _dbus_return_val_if_fail (message != NULL, FALSE);
1552 _dbus_return_val_if_error_is_set (error, FALSE);
1554 dbus_message_iter_init (message, &iter);
1555 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1559 * Gets arguments from a message iterator given a variable argument list.
1560 * The variable argument list should contain the type of the
1561 * argumen followed by a pointer to where the value should be
1562 * stored. The list is terminated with 0.
1564 * @param iter the message iterator
1565 * @param error error to be filled in on failure
1566 * @param first_arg_type the first argument type
1567 * @param ... location for first argument value, then list of type-location pairs
1568 * @returns #FALSE if the error was set
1571 dbus_message_iter_get_args (DBusMessageIter *iter,
1579 _dbus_return_val_if_fail (iter != NULL, FALSE);
1580 _dbus_return_val_if_error_is_set (error, FALSE);
1582 va_start (var_args, first_arg_type);
1583 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1590 * This function takes a va_list for use by language bindings
1592 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1593 * only if #DBUS_HAVE_INT64 is defined.
1595 * @todo this function (or some lower-level non-convenience function)
1596 * needs better error handling; should allow the application to
1597 * distinguish between out of memory, and bad data from the remote
1598 * app. It also needs to not leak a bunch of args when it gets
1599 * to the arg that's bad, as that would be a security hole
1600 * (allow one app to force another to leak memory)
1602 * @todo We need to free the argument data when an error occurs.
1604 * @see dbus_message_get_args
1605 * @param iter the message iter
1606 * @param error error to be filled in
1607 * @param first_arg_type type of the first argument
1608 * @param var_args return location for first argument, followed by list of type/location pairs
1609 * @returns #FALSE if error was set
1612 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1617 int spec_type, msg_type, i;
1620 _dbus_return_val_if_fail (iter != NULL, FALSE);
1621 _dbus_return_val_if_error_is_set (error, FALSE);
1625 spec_type = first_arg_type;
1628 while (spec_type != 0)
1630 msg_type = dbus_message_iter_get_arg_type (iter);
1632 if (msg_type != spec_type)
1634 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1635 "Argument %d is specified to be of type \"%s\", but "
1636 "is actually of type \"%s\"\n", i,
1637 _dbus_type_to_string (spec_type),
1638 _dbus_type_to_string (msg_type));
1647 case DBUS_TYPE_BYTE:
1651 ptr = va_arg (var_args, unsigned char *);
1653 *ptr = dbus_message_iter_get_byte (iter);
1656 case DBUS_TYPE_BOOLEAN:
1660 ptr = va_arg (var_args, dbus_bool_t *);
1662 *ptr = dbus_message_iter_get_boolean (iter);
1665 case DBUS_TYPE_INT32:
1669 ptr = va_arg (var_args, dbus_int32_t *);
1671 *ptr = dbus_message_iter_get_int32 (iter);
1674 case DBUS_TYPE_UINT32:
1678 ptr = va_arg (var_args, dbus_uint32_t *);
1680 *ptr = dbus_message_iter_get_uint32 (iter);
1683 #ifdef DBUS_HAVE_INT64
1684 case DBUS_TYPE_INT64:
1688 ptr = va_arg (var_args, dbus_int64_t *);
1690 *ptr = dbus_message_iter_get_int64 (iter);
1693 case DBUS_TYPE_UINT64:
1697 ptr = va_arg (var_args, dbus_uint64_t *);
1699 *ptr = dbus_message_iter_get_uint64 (iter);
1702 #endif /* DBUS_HAVE_INT64 */
1704 case DBUS_TYPE_DOUBLE:
1708 ptr = va_arg (var_args, double *);
1710 *ptr = dbus_message_iter_get_double (iter);
1714 case DBUS_TYPE_STRING:
1718 ptr = va_arg (var_args, char **);
1720 *ptr = dbus_message_iter_get_string (iter);
1724 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1731 case DBUS_TYPE_NAMED:
1734 unsigned char **data;
1737 name = va_arg (var_args, char **);
1738 data = va_arg (var_args, unsigned char **);
1739 len = va_arg (var_args, int *);
1741 if (!dbus_message_iter_get_named (iter, name, data, len))
1743 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1748 case DBUS_TYPE_ARRAY:
1753 type = va_arg (var_args, int);
1754 data = va_arg (var_args, void *);
1755 len = va_arg (var_args, int *);
1757 if (dbus_message_iter_get_array_type (iter) != type)
1759 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1760 "Argument %d is specified to be of type \"array of %s\", but "
1761 "is actually of type \"array of %s\"\n", i,
1762 _dbus_type_to_string (type),
1763 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
1769 case DBUS_TYPE_BYTE:
1770 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
1772 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1776 case DBUS_TYPE_BOOLEAN:
1777 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
1779 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1783 case DBUS_TYPE_INT32:
1784 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
1786 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1790 case DBUS_TYPE_UINT32:
1791 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
1793 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1797 #ifdef DBUS_HAVE_INT64
1798 case DBUS_TYPE_INT64:
1799 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
1801 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1805 case DBUS_TYPE_UINT64:
1806 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
1808 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1812 #endif /* DBUS_HAVE_INT64 */
1813 case DBUS_TYPE_DOUBLE:
1814 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
1816 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1820 case DBUS_TYPE_STRING:
1821 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
1823 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1828 case DBUS_TYPE_ARRAY:
1829 case DBUS_TYPE_NAMED:
1830 case DBUS_TYPE_DICT:
1831 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
1832 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1835 _dbus_warn ("Unknown field type %d\n", type);
1836 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1841 case DBUS_TYPE_DICT:
1842 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
1843 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1846 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1847 _dbus_warn ("Unknown field type %d\n", spec_type);
1851 spec_type = va_arg (var_args, int);
1852 if (spec_type != 0 && !dbus_message_iter_next (iter))
1854 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1855 "Message has only %d arguments, but more were expected", i);
1871 * Initializes a DBusMessageIter representing the arguments of the
1872 * message passed in.
1874 * @param message the message
1875 * @param iter pointer to an iterator to initialize
1878 dbus_message_iter_init (DBusMessage *message,
1879 DBusMessageIter *iter)
1881 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1883 _dbus_return_if_fail (message != NULL);
1884 _dbus_return_if_fail (iter != NULL);
1886 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
1888 real->message = message;
1889 real->parent_iter = NULL;
1890 real->changed_stamp = message->changed_stamp;
1892 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
1894 real->end = _dbus_string_get_length (&message->body);
1896 real->container_start = 0;
1897 real->container_length_pos = 0;
1898 real->wrote_dict_key = 0;
1899 real->array_type_pos = 0;
1902 #ifndef DBUS_DISABLE_CHECKS
1904 dbus_message_iter_check (DBusMessageRealIter *iter)
1908 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
1912 if (iter->changed_stamp != iter->message->changed_stamp)
1914 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
1918 if (iter->pos < 0 || iter->pos > iter->end)
1920 _dbus_warn ("dbus iterator check failed: invalid position\n");
1926 #endif /* DBUS_DISABLE_CHECKS */
1929 skip_array_type (DBusMessageRealIter *iter, int pos)
1935 data = _dbus_string_get_const_data_len (&iter->message->body,
1938 while (*data == DBUS_TYPE_ARRAY);
1944 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
1951 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
1952 data = _dbus_string_get_const_data_len (&iter->message->body,
1954 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1957 *type = DBUS_TYPE_INVALID;
1959 return skip_array_type (iter, iter->pos);
1961 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
1962 data = _dbus_string_get_const_data_len (&iter->message->body,
1963 iter->array_type_pos, 1);
1964 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1967 *type = DBUS_TYPE_INVALID;
1971 case DBUS_MESSAGE_ITER_TYPE_DICT:
1972 /* Get the length of the string */
1973 len = _dbus_demarshal_uint32 (&iter->message->body,
1974 iter->message->byte_order,
1976 pos = pos + len + 1;
1978 data = _dbus_string_get_const_data_len (&iter->message->body,
1980 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1983 *type = DBUS_TYPE_INVALID;
1985 return skip_array_type (iter, pos);
1988 _dbus_assert_not_reached ("Invalid iter type");
1991 *type = DBUS_TYPE_INVALID;
1997 * Checks if an iterator has any more fields.
1999 * @param iter the message iter
2000 * @returns #TRUE if there are more fields
2004 dbus_message_iter_has_next (DBusMessageIter *iter)
2006 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2010 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2012 if (real->pos >= real->end)
2015 pos = dbus_message_iter_get_data_start (real, &type);
2017 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2018 real->message->byte_order,
2019 type, pos, &end_pos))
2022 if (end_pos >= real->end)
2029 * Moves the iterator to the next field.
2031 * @param iter The message iter
2032 * @returns #TRUE if the iterator was moved to the next field
2035 dbus_message_iter_next (DBusMessageIter *iter)
2037 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2041 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2043 pos = dbus_message_iter_get_data_start (real, &type);
2045 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2046 real->message->byte_order,
2047 type, pos, &end_pos))
2050 if (end_pos >= real->end)
2053 real->pos = end_pos;
2059 * Returns the argument type of the argument that the
2060 * message iterator points at.
2062 * @param iter the message iter
2063 * @returns the field type
2066 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
2068 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2071 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2073 if (real->pos >= real->end)
2074 return DBUS_TYPE_INVALID;
2076 pos = dbus_message_iter_get_data_start (real, &type);
2082 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2085 int _array_type_pos;
2090 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2091 _array_type_pos = iter->pos + 1;
2093 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2094 _array_type_pos = iter->array_type_pos + 1;
2096 case DBUS_MESSAGE_ITER_TYPE_DICT:
2097 /* Get the length of the string */
2098 len = _dbus_demarshal_uint32 (&iter->message->body,
2099 iter->message->byte_order,
2101 pos = pos + len + 1;
2102 data = _dbus_string_get_const_data_len (&iter->message->body,
2104 _array_type_pos = pos + 1;
2107 _dbus_assert_not_reached ("wrong iter type");
2108 return DBUS_TYPE_INVALID;
2111 if (array_type_pos != NULL)
2112 *array_type_pos = _array_type_pos;
2114 data = _dbus_string_get_const_data_len (&iter->message->body,
2115 _array_type_pos, 1);
2116 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2119 return DBUS_TYPE_INVALID;
2124 * Returns the element type of the array that the
2125 * message iterator points at. Note that you need
2126 * to check that the iterator points to an array
2127 * prior to using this function.
2129 * @param iter the message iter
2130 * @returns the field type
2133 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2135 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2138 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2140 if (real->pos >= real->end)
2141 return DBUS_TYPE_INVALID;
2143 pos = dbus_message_iter_get_data_start (real, &type);
2145 _dbus_assert (type == DBUS_TYPE_ARRAY);
2147 return iter_get_array_type (real, NULL);
2152 * Returns the string value that an iterator may point to.
2153 * Note that you need to check that the iterator points to
2154 * a string value before using this function.
2156 * @see dbus_message_iter_get_arg_type
2157 * @param iter the message iter
2158 * @returns the string
2161 dbus_message_iter_get_string (DBusMessageIter *iter)
2163 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2166 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2168 pos = dbus_message_iter_get_data_start (real, &type);
2170 _dbus_assert (type == DBUS_TYPE_STRING);
2172 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2177 * Returns the name and data from a named type that an
2178 * iterator may point to. Note that you need to check that
2179 * the iterator points to a named type before using this
2182 * @see dbus_message_iter_get_arg_type
2183 * @param iter the message iter
2184 * @param name return location for the name
2185 * @param value return location for data
2186 * @param len return location for length of data
2187 * @returns TRUE if get succeed
2191 dbus_message_iter_get_named (DBusMessageIter *iter,
2193 unsigned char **value,
2196 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2200 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2202 pos = dbus_message_iter_get_data_start (real, &type);
2204 _dbus_assert (type == DBUS_TYPE_NAMED);
2206 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2212 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2213 pos + 1, NULL, value, len))
2225 * Returns the byte value that an iterator may point to.
2226 * Note that you need to check that the iterator points to
2227 * a byte value before using this function.
2229 * @see dbus_message_iter_get_arg_type
2230 * @param iter the message iter
2231 * @returns the byte value
2234 dbus_message_iter_get_byte (DBusMessageIter *iter)
2236 unsigned char value;
2237 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2240 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2242 pos = dbus_message_iter_get_data_start (real, &type);
2244 _dbus_assert (type == DBUS_TYPE_BYTE);
2246 value = _dbus_string_get_byte (&real->message->body, pos);
2253 * Returns the boolean value that an iterator may point to.
2254 * Note that you need to check that the iterator points to
2255 * a boolean value before using this function.
2257 * @see dbus_message_iter_get_arg_type
2258 * @param iter the message iter
2259 * @returns the boolean value
2262 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2264 unsigned char value;
2265 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2268 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2270 pos = dbus_message_iter_get_data_start (real, &type);
2272 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2274 value = _dbus_string_get_byte (&real->message->body, pos);
2280 * Returns the 32 bit signed integer value that an iterator may point to.
2281 * Note that you need to check that the iterator points to
2282 * a 32-bit integer value before using this function.
2284 * @see dbus_message_iter_get_arg_type
2285 * @param iter the message iter
2286 * @returns the integer
2289 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2291 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2294 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2296 pos = dbus_message_iter_get_data_start (real, &type);
2298 _dbus_assert (type == DBUS_TYPE_INT32);
2300 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2305 * Returns the 32 bit unsigned integer value that an iterator may point to.
2306 * Note that you need to check that the iterator points to
2307 * a 32-bit unsigned integer value before using this function.
2309 * @see dbus_message_iter_get_arg_type
2310 * @param iter the message iter
2311 * @returns the integer
2314 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2316 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2319 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2321 pos = dbus_message_iter_get_data_start (real, &type);
2323 _dbus_assert (type == DBUS_TYPE_UINT32);
2325 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2329 #ifdef DBUS_HAVE_INT64
2332 * Returns the 64 bit signed integer value that an iterator may point
2333 * to. Note that you need to check that the iterator points to a
2334 * 64-bit integer value before using this function.
2336 * This function only exists if #DBUS_HAVE_INT64 is defined.
2338 * @see dbus_message_iter_get_arg_type
2339 * @param iter the message iter
2340 * @returns the integer
2343 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2345 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2348 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2350 pos = dbus_message_iter_get_data_start (real, &type);
2352 _dbus_assert (type == DBUS_TYPE_INT64);
2354 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2359 * Returns the 64 bit unsigned integer value that an iterator may point to.
2360 * Note that you need to check that the iterator points to
2361 * a 64-bit unsigned integer value before using this function.
2363 * This function only exists if #DBUS_HAVE_INT64 is defined.
2365 * @see dbus_message_iter_get_arg_type
2366 * @param iter the message iter
2367 * @returns the integer
2370 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2372 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2375 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2377 pos = dbus_message_iter_get_data_start (real, &type);
2379 _dbus_assert (type == DBUS_TYPE_UINT64);
2381 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2385 #endif /* DBUS_HAVE_INT64 */
2388 * Returns the double value that an iterator may point to.
2389 * Note that you need to check that the iterator points to
2390 * a string value before using this function.
2392 * @see dbus_message_iter_get_arg_type
2393 * @param iter the message iter
2394 * @returns the double
2397 dbus_message_iter_get_double (DBusMessageIter *iter)
2399 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2402 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2404 pos = dbus_message_iter_get_data_start (real, &type);
2406 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2408 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2413 * Initializes an iterator for the array that the iterator
2414 * may point to. Note that you need to check that the iterator
2415 * points to an array prior to using this function.
2417 * The array element type is returned in array_type, and the array
2418 * iterator can only be used to get that type of data.
2420 * @param iter the iterator
2421 * @param array_iter pointer to an iterator to initialize
2422 * @param array_type gets set to the type of the array elements
2423 * @returns #TRUE on success
2426 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2427 DBusMessageIter *array_iter,
2430 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2431 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2432 int type, pos, len_pos, len, array_type_pos;
2435 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2437 pos = dbus_message_iter_get_data_start (real, &type);
2439 _dbus_assert (type == DBUS_TYPE_ARRAY);
2441 _array_type = iter_get_array_type (real, &array_type_pos);
2443 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2444 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2447 array_real->parent_iter = real;
2448 array_real->message = real->message;
2449 array_real->changed_stamp = real->message->changed_stamp;
2451 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2452 array_real->pos = pos;
2453 array_real->end = pos + len;
2455 array_real->container_start = pos;
2456 array_real->container_length_pos = len_pos;
2457 array_real->wrote_dict_key = 0;
2458 array_real->array_type_pos = array_type_pos;
2459 array_real->array_type_done = TRUE;
2461 if (array_type != NULL)
2462 *array_type = _array_type;
2469 * Initializes an iterator for the dict that the iterator
2470 * may point to. Note that you need to check that the iterator
2471 * points to a dict prior to using this function.
2473 * @param iter the iterator
2474 * @param dict_iter pointer to an iterator to initialize
2475 * @returns #TRUE on success
2478 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2479 DBusMessageIter *dict_iter)
2481 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2482 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2483 int type, pos, len_pos, len;
2485 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2487 pos = dbus_message_iter_get_data_start (real, &type);
2489 _dbus_assert (type == DBUS_TYPE_DICT);
2491 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2492 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2495 dict_real->parent_iter = real;
2496 dict_real->message = real->message;
2497 dict_real->changed_stamp = real->message->changed_stamp;
2499 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2500 dict_real->pos = pos;
2501 dict_real->end = pos + len;
2503 dict_real->container_start = pos;
2504 dict_real->container_length_pos = len_pos;
2505 dict_real->wrote_dict_key = 0;
2511 * Returns the byte array that the iterator may point to.
2512 * Note that you need to check that the iterator points
2513 * to a byte array prior to using this function.
2515 * @param iter the iterator
2516 * @param value return location for array values
2517 * @param len return location for length of byte array
2518 * @returns #TRUE on success
2521 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2522 unsigned char **value,
2525 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2528 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2530 pos = dbus_message_iter_get_data_start (real, &type);
2532 _dbus_assert (type == DBUS_TYPE_ARRAY);
2534 type = iter_get_array_type (real, NULL);
2536 _dbus_assert (type == DBUS_TYPE_BYTE);
2538 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2539 pos, NULL, value, len))
2546 * Returns the boolean array that the iterator may point to. Note that
2547 * you need to check that the iterator points to an array of the
2548 * correct type prior to using this function.
2550 * @param iter the iterator
2551 * @param value return location for the array
2552 * @param len return location for the array length
2553 * @returns #TRUE on success
2556 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2557 unsigned char **value,
2560 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2563 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2565 pos = dbus_message_iter_get_data_start (real, &type);
2567 _dbus_assert (type == DBUS_TYPE_ARRAY);
2569 type = iter_get_array_type (real, NULL);
2571 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2573 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2574 pos, NULL, value, len))
2581 * Returns the 32 bit signed integer array that the iterator may point
2582 * to. Note that you need to check that the iterator points to an
2583 * array of the correct type prior to using this function.
2585 * @param iter the iterator
2586 * @param value return location for the array
2587 * @param len return location for the array length
2588 * @returns #TRUE on success
2591 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2592 dbus_int32_t **value,
2595 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2598 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2600 pos = dbus_message_iter_get_data_start (real, &type);
2602 _dbus_assert (type == DBUS_TYPE_ARRAY);
2604 type = iter_get_array_type (real, NULL);
2606 _dbus_assert (type == DBUS_TYPE_INT32);
2608 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2609 pos, NULL, value, len))
2616 * Returns the 32 bit unsigned integer array that the iterator may point
2617 * to. Note that you need to check that the iterator points to an
2618 * array of the correct type prior to using this function.
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_uint32_array (DBusMessageIter *iter,
2627 dbus_uint32_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_UINT32);
2642 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2643 pos, NULL, value, len))
2649 #ifdef DBUS_HAVE_INT64
2652 * Returns the 64 bit signed integer array that the iterator may point
2653 * to. Note that you need to check that the iterator points to an
2654 * array of the correct type prior to using this function.
2656 * This function only exists if #DBUS_HAVE_INT64 is defined.
2658 * @param iter the iterator
2659 * @param value return location for the array
2660 * @param len return location for the array length
2661 * @returns #TRUE on success
2664 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
2665 dbus_int64_t **value,
2668 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2671 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2673 pos = dbus_message_iter_get_data_start (real, &type);
2675 _dbus_assert (type == DBUS_TYPE_ARRAY);
2677 type = iter_get_array_type (real, NULL);
2679 _dbus_assert (type == DBUS_TYPE_INT64);
2681 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
2682 pos, NULL, value, len))
2689 * Returns the 64 bit unsigned integer array that the iterator may point
2690 * to. Note that you need to check that the iterator points to an
2691 * array of the correct type prior to using this function.
2693 * This function only exists if #DBUS_HAVE_INT64 is defined.
2695 * @param iter the iterator
2696 * @param value return location for the array
2697 * @param len return location for the array length
2698 * @returns #TRUE on success
2701 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
2702 dbus_uint64_t **value,
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_UINT64);
2717 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
2718 pos, NULL, value, len))
2724 #endif /* DBUS_HAVE_INT64 */
2727 * Returns the double array that the iterator may point to. Note that
2728 * you need to check that the iterator points to an array of the
2729 * correct type prior to using this function.
2731 * @param iter the iterator
2732 * @param value return location for the array
2733 * @param len return location for the array length
2734 * @returns #TRUE on success
2737 dbus_message_iter_get_double_array (DBusMessageIter *iter,
2741 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2744 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2746 pos = dbus_message_iter_get_data_start (real, &type);
2748 _dbus_assert (type == DBUS_TYPE_ARRAY);
2750 type = iter_get_array_type (real, NULL);
2751 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2753 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
2754 pos, NULL, value, len))
2761 * Returns the string array that the iterator may point to.
2762 * Note that you need to check that the iterator points
2763 * to a byte array prior to using this function.
2765 * The returned value is a #NULL-terminated array of strings.
2766 * Each string is a separate malloc block, and the array
2767 * itself is a malloc block. You can free this type of
2768 * string array with dbus_free_string_array().
2770 * @param iter the iterator
2771 * @param value return location for string values
2772 * @param len return location for length of byte array
2773 * @returns #TRUE on success
2776 dbus_message_iter_get_string_array (DBusMessageIter *iter,
2780 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2783 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2785 pos = dbus_message_iter_get_data_start (real, &type);
2787 _dbus_assert (type == DBUS_TYPE_ARRAY);
2789 type = iter_get_array_type (real, NULL);
2790 _dbus_assert (type == DBUS_TYPE_STRING);
2792 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
2793 pos, NULL, value, len))
2800 * Returns the key name fot the dict entry that an iterator
2801 * may point to. Note that you need to check that the iterator
2802 * points to a dict entry before using this function.
2804 * @see dbus_message_iter_init_dict_iterator
2805 * @param iter the message iter
2806 * @returns the key name
2809 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
2811 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2813 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2815 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
2817 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2822 * Initializes a DBusMessageIter pointing to the end of the
2823 * message. This iterator can be used to append data to the
2826 * @param message the message
2827 * @param iter pointer to an iterator to initialize
2830 dbus_message_append_iter_init (DBusMessage *message,
2831 DBusMessageIter *iter)
2833 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2835 _dbus_return_if_fail (message != NULL);
2836 _dbus_return_if_fail (iter != NULL);
2838 real->message = message;
2839 real->parent_iter = NULL;
2840 real->changed_stamp = message->changed_stamp;
2842 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2843 real->end = _dbus_string_get_length (&real->message->body);
2844 real->pos = real->end;
2846 real->container_length_pos = 0;
2847 real->wrote_dict_key = 0;
2850 #ifndef DBUS_DISABLE_CHECKS
2852 dbus_message_iter_append_check (DBusMessageRealIter *iter)
2856 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
2860 if (iter->message->locked)
2862 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
2866 if (iter->changed_stamp != iter->message->changed_stamp)
2868 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
2872 if (iter->pos != iter->end)
2874 _dbus_warn ("dbus iterator check failed: can only append at end of message");
2878 if (iter->pos != _dbus_string_get_length (&iter->message->body))
2880 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
2886 #endif /* DBUS_DISABLE_CHECKS */
2889 dbus_message_iter_append_type (DBusMessageRealIter *iter,
2895 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2896 if (!_dbus_string_append_byte (&iter->message->body, type))
2900 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2901 data = _dbus_string_get_const_data_len (&iter->message->body,
2902 iter->array_type_pos, 1);
2905 _dbus_warn ("Appended element of wrong type for array\n");
2910 case DBUS_MESSAGE_ITER_TYPE_DICT:
2911 if (!iter->wrote_dict_key)
2913 _dbus_warn ("Appending dict data before key name\n");
2917 if (!_dbus_string_append_byte (&iter->message->body, type))
2923 _dbus_assert_not_reached ("Invalid iter type");
2931 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
2933 iter->changed_stamp = iter->message->changed_stamp;
2935 /* Set new end of iter */
2936 iter->end = _dbus_string_get_length (&iter->message->body);
2937 iter->pos = iter->end;
2939 /* Set container length */
2940 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
2941 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
2942 _dbus_marshal_set_uint32 (&iter->message->body,
2943 iter->message->byte_order,
2944 iter->container_length_pos,
2945 iter->end - iter->container_start);
2947 if (iter->parent_iter)
2948 dbus_message_iter_update_after_change (iter->parent_iter);
2952 dbus_message_iter_append_done (DBusMessageRealIter *iter)
2954 iter->message->changed_stamp++;
2955 dbus_message_iter_update_after_change (iter);
2956 iter->wrote_dict_key = FALSE;
2960 * Appends a nil value to the message
2962 * @param iter an iterator pointing to the end of the message
2963 * @returns #TRUE on success
2966 dbus_message_iter_append_nil (DBusMessageIter *iter)
2968 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2970 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2972 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
2975 dbus_message_iter_append_done (real);
2981 * Appends a boolean value to the message
2983 * @param iter an iterator pointing to the end of the message
2984 * @param value the boolean value
2985 * @returns #TRUE on success
2988 dbus_message_iter_append_boolean (DBusMessageIter *iter,
2991 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2993 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
2995 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
2998 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
3000 _dbus_string_set_length (&real->message->body, real->pos);
3004 dbus_message_iter_append_done (real);
3010 * Appends a byte to the message
3012 * @param iter an iterator pointing to the end of the message
3013 * @param value the byte value
3014 * @returns #TRUE on success
3017 dbus_message_iter_append_byte (DBusMessageIter *iter,
3018 unsigned char value)
3020 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3022 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3024 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
3027 if (!_dbus_string_append_byte (&real->message->body, value))
3029 _dbus_string_set_length (&real->message->body, real->pos);
3033 dbus_message_iter_append_done (real);
3040 * Appends a 32 bit signed integer to the message.
3042 * @param iter an iterator pointing to the end of the message
3043 * @param value the integer value
3044 * @returns #TRUE on success
3047 dbus_message_iter_append_int32 (DBusMessageIter *iter,
3050 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3052 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3054 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
3057 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
3059 _dbus_string_set_length (&real->message->body, real->pos);
3063 dbus_message_iter_append_done (real);
3069 * Appends a 32 bit unsigned integer to the message.
3071 * @param iter an iterator pointing to the end of the message
3072 * @param value the integer value
3073 * @returns #TRUE on success
3076 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3077 dbus_uint32_t value)
3079 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3081 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3083 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3086 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3088 _dbus_string_set_length (&real->message->body, real->pos);
3092 dbus_message_iter_append_done (real);
3097 #ifdef DBUS_HAVE_INT64
3100 * Appends a 64 bit signed integer to the message.
3102 * This function only exists if #DBUS_HAVE_INT64 is defined.
3104 * @param iter an iterator pointing to the end of the message
3105 * @param value the integer value
3106 * @returns #TRUE on success
3109 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3112 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3114 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3116 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3119 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3121 _dbus_string_set_length (&real->message->body, real->pos);
3125 dbus_message_iter_append_done (real);
3131 * Appends a 64 bit unsigned integer to the message.
3133 * This function only exists if #DBUS_HAVE_INT64 is defined.
3135 * @param iter an iterator pointing to the end of the message
3136 * @param value the integer value
3137 * @returns #TRUE on success
3140 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3141 dbus_uint64_t value)
3143 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3145 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3147 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3150 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3152 _dbus_string_set_length (&real->message->body, real->pos);
3156 dbus_message_iter_append_done (real);
3161 #endif /* DBUS_HAVE_INT64 */
3164 * Appends a double value to the message.
3166 * @param iter an iterator pointing to the end of the message
3167 * @param value the double value
3168 * @returns #TRUE on success
3171 dbus_message_iter_append_double (DBusMessageIter *iter,
3174 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3176 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3178 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3181 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3183 _dbus_string_set_length (&real->message->body, real->pos);
3187 dbus_message_iter_append_done (real);
3193 * Appends a UTF-8 string to the message.
3195 * @param iter an iterator pointing to the end of the message
3196 * @param value the string
3197 * @returns #TRUE on success
3200 dbus_message_iter_append_string (DBusMessageIter *iter,
3203 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3205 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3207 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3210 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3212 _dbus_string_set_length (&real->message->body, real->pos);
3216 dbus_message_iter_append_done (real);
3222 * Appends a named type data chunk to the message. A named
3223 * type is simply an arbitrary UTF-8 string used as a type
3224 * tag, plus an array of arbitrary bytes to be interpreted
3225 * according to the type tag.
3227 * @param iter an iterator pointing to the end of the message
3228 * @param name the name of the type
3229 * @param data the binary data used to store the value
3230 * @param len the length of the binary data in bytes
3231 * @returns #TRUE on success
3234 dbus_message_iter_append_named (DBusMessageIter *iter,
3236 const unsigned char *data,
3239 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3241 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3243 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3246 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3248 _dbus_string_set_length (&real->message->body, real->pos);
3252 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3254 _dbus_string_set_length (&real->message->body, real->pos);
3258 dbus_message_iter_append_done (real);
3265 * Appends a dict key name to the message. The iterator used
3266 * must point to a dict.
3268 * @param iter an iterator pointing to the end of the message
3269 * @param value the string
3270 * @returns #TRUE on success
3273 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3276 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3278 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3279 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3281 if (real->wrote_dict_key)
3283 _dbus_warn ("Appendinging multiple dict key names\n");
3287 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3292 dbus_message_iter_append_done (real);
3293 real->wrote_dict_key = TRUE;
3299 array_iter_type_mark_done (DBusMessageRealIter *iter)
3303 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3304 array_iter_type_mark_done (iter->parent_iter);
3308 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3309 sizeof (dbus_uint32_t));
3311 /* Empty length for now, backfill later */
3312 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3314 _dbus_string_set_length (&iter->message->body, iter->pos);
3318 iter->container_start = _dbus_string_get_length (&iter->message->body);
3319 iter->container_length_pos = len_pos;
3320 iter->array_type_done = TRUE;
3326 append_array_type (DBusMessageRealIter *real,
3328 dbus_bool_t *array_type_done,
3329 int *array_type_pos)
3331 int existing_element_type;
3333 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3336 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3337 real->array_type_done)
3339 existing_element_type = iter_get_array_type (real, array_type_pos);
3340 if (existing_element_type != element_type)
3342 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3343 _dbus_type_to_string (element_type),
3344 _dbus_type_to_string (existing_element_type));
3345 _dbus_string_set_length (&real->message->body, real->pos);
3348 if (array_type_done != NULL)
3349 *array_type_done = TRUE;
3353 if (array_type_pos != NULL)
3354 *array_type_pos = _dbus_string_get_length (&real->message->body);
3356 /* Append element type */
3357 if (!_dbus_string_append_byte (&real->message->body, element_type))
3359 _dbus_string_set_length (&real->message->body, real->pos);
3363 if (array_type_done != NULL)
3364 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3366 if (element_type != DBUS_TYPE_ARRAY &&
3367 !array_iter_type_mark_done (real))
3375 * Appends an array to the message and initializes an iterator that
3376 * can be used to append to the array.
3378 * @param iter an iterator pointing to the end of the message
3379 * @param array_iter pointer to an iter that will be initialized
3380 * @param element_type the type of the array elements
3381 * @returns #TRUE on success
3384 dbus_message_iter_append_array (DBusMessageIter *iter,
3385 DBusMessageIter *array_iter,
3388 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3389 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3392 dbus_bool_t array_type_done;
3394 if (element_type == DBUS_TYPE_NIL)
3396 _dbus_warn ("Can't create NIL arrays\n");
3400 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3402 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3405 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3407 if (array_type_done)
3409 /* Empty length for now, backfill later */
3410 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3412 _dbus_string_set_length (&real->message->body, real->pos);
3417 array_real->parent_iter = real;
3418 array_real->message = real->message;
3419 array_real->changed_stamp = real->message->changed_stamp;
3421 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3422 array_real->pos = _dbus_string_get_length (&real->message->body);
3423 array_real->end = array_real->end;
3425 array_real->container_start = array_real->pos;
3426 array_real->container_length_pos = len_pos;
3427 array_real->wrote_dict_key = 0;
3428 array_real->array_type_done = array_type_done;
3429 array_real->array_type_pos = array_type_pos;
3431 dbus_message_iter_append_done (array_real);
3437 * Appends a dict to the message and initializes an iterator that
3438 * can be used to append to the dict.
3440 * @param iter an iterator pointing to the end of the message
3441 * @param dict_iter pointer to an iter that will be initialized
3442 * @returns #TRUE on success
3445 dbus_message_iter_append_dict (DBusMessageIter *iter,
3446 DBusMessageIter *dict_iter)
3448 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3449 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3452 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3454 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3457 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3459 /* Empty length for now, backfill later */
3460 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3462 _dbus_string_set_length (&real->message->body, real->pos);
3466 dict_real->parent_iter = real;
3467 dict_real->message = real->message;
3468 dict_real->changed_stamp = real->message->changed_stamp;
3470 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3471 dict_real->pos = _dbus_string_get_length (&real->message->body);
3472 dict_real->end = dict_real->end;
3474 dict_real->container_start = dict_real->pos;
3475 dict_real->container_length_pos = len_pos;
3476 dict_real->wrote_dict_key = 0;
3478 dbus_message_iter_append_done (dict_real);
3485 * Appends a boolean array to the message.
3487 * @param iter an iterator pointing to the end of the message
3488 * @param value the array
3489 * @param len the length of the array
3490 * @returns #TRUE on success
3493 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3494 unsigned const char *value,
3497 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3499 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3501 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3504 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3506 _dbus_string_set_length (&real->message->body, real->pos);
3510 dbus_message_iter_append_done (real);
3516 * Appends a 32 bit signed integer array to the message.
3518 * @param iter an iterator pointing to the end of the message
3519 * @param value the array
3520 * @param len the length of the array
3521 * @returns #TRUE on success
3524 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3525 const dbus_int32_t *value,
3528 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3530 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3532 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
3535 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
3537 _dbus_string_set_length (&real->message->body, real->pos);
3541 dbus_message_iter_append_done (real);
3547 * Appends a 32 bit unsigned integer array to the message.
3549 * @param iter an iterator pointing to the end of the message
3550 * @param value the array
3551 * @param len the length of the array
3552 * @returns #TRUE on success
3555 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
3556 const dbus_uint32_t *value,
3559 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3561 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3563 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
3566 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3568 _dbus_string_set_length (&real->message->body, real->pos);
3572 dbus_message_iter_append_done (real);
3577 #ifdef DBUS_HAVE_INT64
3580 * Appends a 64 bit signed integer array to the message.
3582 * This function only exists if #DBUS_HAVE_INT64 is defined.
3584 * @param iter an iterator pointing to the end of the message
3585 * @param value the array
3586 * @param len the length of the array
3587 * @returns #TRUE on success
3590 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
3591 const dbus_int64_t *value,
3594 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3596 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3598 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
3601 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
3603 _dbus_string_set_length (&real->message->body, real->pos);
3607 dbus_message_iter_append_done (real);
3613 * Appends a 64 bit unsigned integer array to the message.
3615 * This function only exists if #DBUS_HAVE_INT64 is defined.
3617 * @param iter an iterator pointing to the end of the message
3618 * @param value the array
3619 * @param len the length of the array
3620 * @returns #TRUE on success
3623 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
3624 const dbus_uint64_t *value,
3627 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3629 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3631 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
3634 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
3636 _dbus_string_set_length (&real->message->body, real->pos);
3640 dbus_message_iter_append_done (real);
3644 #endif /* DBUS_HAVE_INT64 */
3647 * Appends a double array to the message.
3649 * @param iter an iterator pointing to the end of the message
3650 * @param value the array
3651 * @param len the length of the array
3652 * @returns #TRUE on success
3655 dbus_message_iter_append_double_array (DBusMessageIter *iter,
3656 const double *value,
3659 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3661 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3663 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
3666 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
3668 _dbus_string_set_length (&real->message->body, real->pos);
3672 dbus_message_iter_append_done (real);
3678 * Appends a byte array to the message.
3680 * @param iter an iterator pointing to the end of the message
3681 * @param value the array
3682 * @param len the length of the array
3683 * @returns #TRUE on success
3686 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
3687 unsigned const char *value,
3690 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3692 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3694 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
3697 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3699 _dbus_string_set_length (&real->message->body, real->pos);
3703 dbus_message_iter_append_done (real);
3709 * Appends a string array to the message.
3711 * @param iter an iterator pointing to the end of the message
3712 * @param value the array
3713 * @param len the length of the array
3714 * @returns #TRUE on success
3717 dbus_message_iter_append_string_array (DBusMessageIter *iter,
3721 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3723 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3725 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
3728 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
3730 _dbus_string_set_length (&real->message->body, real->pos);
3734 dbus_message_iter_append_done (real);
3740 * Sets the message sender.
3742 * @param message the message
3743 * @param sender the sender
3744 * @returns #FALSE if not enough memory
3747 dbus_message_set_sender (DBusMessage *message,
3750 _dbus_return_val_if_fail (message != NULL, FALSE);
3751 _dbus_return_val_if_fail (!message->locked, FALSE);
3755 delete_string_field (message, FIELD_SENDER);
3760 return set_string_field (message,
3767 * Sets a flag indicating that the message is an error reply
3768 * message, i.e. an "exception" rather than a normal response.
3770 * @param message the message
3771 * @param is_error_reply #TRUE if this is an error message.
3774 dbus_message_set_is_error (DBusMessage *message,
3775 dbus_bool_t is_error_reply)
3779 _dbus_return_if_fail (message != NULL);
3780 _dbus_return_if_fail (!message->locked);
3782 header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1);
3785 *header |= DBUS_HEADER_FLAG_ERROR;
3787 *header &= ~DBUS_HEADER_FLAG_ERROR;
3791 * Returns #TRUE if the message is an error
3792 * reply to some previous message we sent.
3794 * @param message the message
3795 * @returns #TRUE if the message is an error
3798 dbus_message_get_is_error (DBusMessage *message)
3802 _dbus_return_val_if_fail (message != NULL, FALSE);
3804 header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1);
3806 return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
3810 * Gets the service which originated this message,
3811 * or #NULL if unknown or inapplicable.
3813 * @param message the message
3814 * @returns the service name or #NULL
3817 dbus_message_get_sender (DBusMessage *message)
3819 _dbus_return_val_if_fail (message != NULL, NULL);
3821 return get_string_field (message, FIELD_SENDER, NULL);
3825 * Checks whether the message has the given name.
3826 * If the message has no name or has a different
3827 * name, returns #FALSE.
3829 * @param message the message
3830 * @param name the name to check (must not be #NULL)
3832 * @returns #TRUE if the message has the given name
3835 dbus_message_has_name (DBusMessage *message,
3840 _dbus_return_val_if_fail (message != NULL, FALSE);
3841 _dbus_return_val_if_fail (name != NULL, FALSE);
3843 n = dbus_message_get_name (message);
3845 if (n && strcmp (n, name) == 0)
3852 * Checks whether the message was sent to the given service. If the
3853 * message has no service specified or has a different name, returns
3856 * @param message the message
3857 * @param service the service to check (must not be #NULL)
3859 * @returns #TRUE if the message has the given destination service
3862 dbus_message_has_destination (DBusMessage *message,
3863 const char *service)
3867 _dbus_return_val_if_fail (message != NULL, FALSE);
3868 _dbus_return_val_if_fail (service != NULL, FALSE);
3870 s = dbus_message_get_destination (message);
3872 if (s && strcmp (s, service) == 0)
3879 * Checks whether the message has the given service as its sender. If
3880 * the message has no sender specified or has a different sender,
3881 * returns #FALSE. Note that if a peer application owns multiple
3882 * services, its messages will have only one of those services as the
3883 * sender (usually the base service). So you can't use this
3884 * function to prove the sender didn't own service Foo, you can
3885 * only use it to prove that it did.
3887 * @param message the message
3888 * @param service the service to check (must not be #NULL)
3890 * @returns #TRUE if the message has the given origin service
3893 dbus_message_has_sender (DBusMessage *message,
3894 const char *service)
3898 _dbus_assert (service != NULL);
3900 s = dbus_message_get_sender (message);
3902 if (s && strcmp (s, service) == 0)
3909 * Sets a #DBusError based on the contents of the given
3910 * message. The error is only set if the message
3911 * is an error message, as in dbus_message_get_is_error().
3912 * The name of the error is set to the name of the message,
3913 * and the error message is set to the first argument
3914 * if the argument exists and is a string.
3916 * The return value indicates whether the error was set (the error is
3917 * set if and only if the message is an error message).
3918 * So you can check for an error reply and convert it to DBusError
3921 * @param error the error to set
3922 * @param message the message to set it from
3923 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
3926 dbus_set_error_from_message (DBusError *error,
3927 DBusMessage *message)
3931 _dbus_return_val_if_fail (message != NULL, FALSE);
3932 _dbus_return_val_if_error_is_set (error, FALSE);
3934 if (!dbus_message_get_is_error (message))
3938 dbus_message_get_args (message, NULL,
3939 DBUS_TYPE_STRING, &str,
3942 dbus_set_error (error, dbus_message_get_name (message),
3943 str ? "%s" : NULL, str);
3953 * @addtogroup DBusMessageInternals
3958 * @typedef DBusMessageLoader
3960 * The DBusMessageLoader object encapsulates the process of converting
3961 * a byte stream into a series of DBusMessage. It buffers the incoming
3962 * bytes as efficiently as possible, and generates a queue of
3963 * messages. DBusMessageLoader is typically used as part of a
3964 * DBusTransport implementation. The DBusTransport then hands off
3965 * the loaded messages to a DBusConnection, making the messages
3966 * visible to the application.
3968 * @todo write tests for break-loader that a) randomly delete header
3969 * fields and b) set string fields to zero-length and other funky
3974 /* we definitely use signed ints for sizes, so don't exceed
3975 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
3976 * over 128M is pretty nuts anyhow.
3980 * The maximum sane message size.
3982 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
3985 * Implementation details of DBusMessageLoader.
3986 * All members are private.
3988 struct DBusMessageLoader
3990 int refcount; /**< Reference count. */
3992 DBusString data; /**< Buffered data */
3994 DBusList *messages; /**< Complete messages. */
3996 long max_message_size; /**< Maximum size of a message */
3998 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
4000 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
4004 * The initial buffer size of the message loader.
4006 * @todo this should be based on min header size plus some average
4007 * body size, or something. Or rather, the min header size only, if we
4008 * want to try to read only the header, store that in a DBusMessage,
4009 * then read only the body and store that, etc., depends on
4010 * how we optimize _dbus_message_loader_get_buffer() and what
4011 * the exact message format is.
4013 #define INITIAL_LOADER_DATA_LEN 32
4016 * Creates a new message loader. Returns #NULL if memory can't
4019 * @returns new loader, or #NULL.
4022 _dbus_message_loader_new (void)
4024 DBusMessageLoader *loader;
4026 loader = dbus_new0 (DBusMessageLoader, 1);
4030 loader->refcount = 1;
4032 /* Try to cap message size at something that won't *totally* hose
4033 * the system if we have a couple of them.
4035 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
4037 if (!_dbus_string_init (&loader->data))
4043 /* preallocate the buffer for speed, ignore failure */
4044 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
4045 _dbus_string_set_length (&loader->data, 0);
4051 * Increments the reference count of the loader.
4053 * @param loader the loader.
4056 _dbus_message_loader_ref (DBusMessageLoader *loader)
4058 loader->refcount += 1;
4062 * Decrements the reference count of the loader and finalizes the
4063 * loader when the count reaches zero.
4065 * @param loader the loader.
4068 _dbus_message_loader_unref (DBusMessageLoader *loader)
4070 loader->refcount -= 1;
4071 if (loader->refcount == 0)
4073 _dbus_list_foreach (&loader->messages,
4074 (DBusForeachFunction) dbus_message_unref,
4076 _dbus_list_clear (&loader->messages);
4077 _dbus_string_free (&loader->data);
4083 * Gets the buffer to use for reading data from the network. Network
4084 * data is read directly into an allocated buffer, which is then used
4085 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4086 * The buffer must always be returned immediately using
4087 * _dbus_message_loader_return_buffer(), even if no bytes are
4088 * successfully read.
4090 * @todo this function can be a lot more clever. For example
4091 * it can probably always return a buffer size to read exactly
4092 * the body of the next message, thus avoiding any memory wastage
4095 * @todo we need to enforce a max length on strings in header fields.
4097 * @param loader the message loader.
4098 * @param buffer the buffer
4101 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4102 DBusString **buffer)
4104 _dbus_assert (!loader->buffer_outstanding);
4106 *buffer = &loader->data;
4108 loader->buffer_outstanding = TRUE;
4112 * The smallest header size that can occur.
4113 * (It won't be valid)
4115 #define DBUS_MINIMUM_HEADER_SIZE 16
4117 /** Pack four characters as in "abcd" into a uint32 */
4118 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
4119 ((((dbus_uint32_t)a) << 24) | \
4120 (((dbus_uint32_t)b) << 16) | \
4121 (((dbus_uint32_t)c) << 8) | \
4124 /** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
4125 #define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
4126 FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
4128 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
4129 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
4130 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
4132 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
4133 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
4134 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
4136 /** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
4137 #define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
4138 FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
4141 decode_string_field (const DBusString *data,
4142 HeaderField fields[FIELD_LAST],
4146 const char *field_name)
4149 int string_data_pos;
4151 if (fields[field].offset >= 0)
4153 _dbus_verbose ("%s field provided twice\n",
4158 if (type != DBUS_TYPE_STRING)
4160 _dbus_verbose ("%s field has wrong type %s\n",
4161 field_name, _dbus_type_to_string (type));
4165 /* skip padding after typecode, skip string length;
4166 * we assume that the string arg has already been validated
4167 * for sanity and UTF-8
4169 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4170 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4172 _dbus_string_init_const (&tmp,
4173 _dbus_string_get_const_data (data) + string_data_pos);
4175 if (field == FIELD_NAME)
4177 if (!_dbus_string_validate_name (&tmp, 0, _dbus_string_get_length (&tmp)))
4179 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4180 field_name, _dbus_string_get_const_data (&tmp));
4184 if (_dbus_string_starts_with_c_str (&tmp,
4185 DBUS_NAMESPACE_LOCAL_MESSAGE))
4187 _dbus_verbose ("Message is in the local namespace\n");
4193 if (!_dbus_string_validate_service (&tmp, 0, _dbus_string_get_length (&tmp)))
4195 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4196 field_name, _dbus_string_get_const_data (&tmp));
4201 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4204 _dbus_verbose ("Found field %s name at offset %d\n",
4205 field_name, fields[field].offset);
4212 decode_header_data (const DBusString *data,
4215 HeaderField fields[FIELD_LAST],
4216 int *message_padding)
4223 if (header_len < 16)
4227 while (i < FIELD_LAST)
4229 fields[i].offset = -1;
4233 fields[FIELD_HEADER_LENGTH].offset = 4;
4234 fields[FIELD_BODY_LENGTH].offset = 8;
4235 fields[FIELD_CLIENT_SERIAL].offset = 12;
4237 /* Now handle the named fields. A real named field is at least 4
4238 * bytes for the name, plus a type code (1 byte) plus padding. So
4239 * if we have less than 8 bytes left, it must be alignment padding,
4240 * not a field. While >= 8 bytes can't be entirely alignment
4244 while ((pos + 7) < header_len)
4246 pos = _DBUS_ALIGN_VALUE (pos, 4);
4248 if ((pos + 4) > header_len)
4251 field =_dbus_string_get_const_data_len (data, pos, 4);
4254 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
4256 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4258 _dbus_verbose ("Failed to validate type of named header field\n");
4262 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4264 _dbus_verbose ("Failed to validate argument to named header field\n");
4268 if (new_pos > header_len)
4270 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4274 switch (DBUS_UINT32_FROM_BE (*(int*)field))
4276 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
4277 if (!decode_string_field (data, fields, pos, type,
4279 DBUS_HEADER_FIELD_SERVICE))
4283 case DBUS_HEADER_FIELD_NAME_AS_UINT32:
4284 if (!decode_string_field (data, fields, pos, type,
4286 DBUS_HEADER_FIELD_NAME))
4290 case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
4291 if (!decode_string_field (data, fields, pos, type,
4293 DBUS_HEADER_FIELD_SENDER))
4297 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
4298 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
4300 _dbus_verbose ("%s field provided twice\n",
4301 DBUS_HEADER_FIELD_REPLY);
4305 if (type != DBUS_TYPE_UINT32)
4307 _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_REPLY);
4311 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos, 4);
4313 _dbus_verbose ("Found reply serial at offset %d\n",
4314 fields[FIELD_REPLY_SERIAL].offset);
4318 _dbus_verbose ("Ignoring an unknown header field: %.4s at offset %d\n",
4325 if (pos < header_len)
4327 /* Alignment padding, verify that it's nul */
4328 _dbus_assert ((header_len - pos) < 8);
4330 if (!_dbus_string_validate_nul (data,
4331 pos, (header_len - pos)))
4333 _dbus_verbose ("header alignment padding is not nul\n");
4338 /* Name field is mandatory */
4339 if (fields[FIELD_NAME].offset < 0)
4341 _dbus_verbose ("No %s field provided\n",
4342 DBUS_HEADER_FIELD_NAME);
4346 if (message_padding)
4347 *message_padding = header_len - pos;
4353 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
4354 * indicating to the loader how many bytes of the buffer were filled
4355 * in. This function must always be called, even if no bytes were
4356 * successfully read.
4358 * @param loader the loader.
4359 * @param buffer the buffer.
4360 * @param bytes_read number of bytes that were read into the buffer.
4363 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
4367 _dbus_assert (loader->buffer_outstanding);
4368 _dbus_assert (buffer == &loader->data);
4370 loader->buffer_outstanding = FALSE;
4374 * Converts buffered data into messages.
4376 * @todo we need to check that the proper named header fields exist
4377 * for each message type.
4379 * @param loader the loader.
4380 * @returns #TRUE if we had enough memory to finish.
4383 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
4385 if (loader->corrupted)
4388 while (_dbus_string_get_length (&loader->data) >= 16)
4390 DBusMessage *message;
4391 const char *header_data;
4392 int byte_order, message_type, header_len, body_len, header_padding;
4393 dbus_uint32_t header_len_unsigned, body_len_unsigned;
4395 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
4397 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
4399 if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION)
4401 _dbus_verbose ("Message has protocol version %d ours is %d\n",
4402 (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION);
4403 loader->corrupted = TRUE;
4407 byte_order = header_data[BYTE_ORDER_OFFSET];
4409 if (byte_order != DBUS_LITTLE_ENDIAN &&
4410 byte_order != DBUS_BIG_ENDIAN)
4412 _dbus_verbose ("Message with bad byte order '%c' received\n",
4414 loader->corrupted = TRUE;
4418 /* Unknown types are ignored, but INVALID is
4421 message_type = header_data[TYPE_OFFSET];
4422 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
4424 _dbus_verbose ("Message with bad type '%d' received\n",
4426 loader->corrupted = TRUE;
4430 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
4431 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
4433 if (header_len_unsigned < 16)
4435 _dbus_verbose ("Message had broken too-small header length %u\n",
4436 header_len_unsigned);
4437 loader->corrupted = TRUE;
4441 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
4442 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
4444 _dbus_verbose ("Header or body length too large (%u %u)\n",
4445 header_len_unsigned,
4447 loader->corrupted = TRUE;
4451 /* Now that we know the values are in signed range, get
4452 * rid of stupid unsigned, just causes bugs
4454 header_len = header_len_unsigned;
4455 body_len = body_len_unsigned;
4457 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
4460 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
4462 loader->corrupted = TRUE;
4466 if (header_len + body_len > loader->max_message_size)
4468 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
4469 header_len, body_len, loader->max_message_size);
4470 loader->corrupted = TRUE;
4474 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
4476 HeaderField fields[FIELD_LAST];
4481 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
4483 if (!decode_header_data (&loader->data, header_len, byte_order,
4484 fields, &header_padding))
4486 _dbus_verbose ("Header was invalid\n");
4487 loader->corrupted = TRUE;
4491 next_arg = header_len;
4492 while (next_arg < (header_len + body_len))
4495 int prev = next_arg;
4497 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
4500 _dbus_verbose ("invalid typecode at offset %d\n", prev);
4501 loader->corrupted = TRUE;
4505 if (!_dbus_marshal_validate_arg (&loader->data,
4512 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
4513 loader->corrupted = TRUE;
4517 _dbus_assert (next_arg > prev);
4520 if (next_arg > (header_len + body_len))
4522 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
4523 next_arg, header_len, body_len,
4524 header_len + body_len);
4525 loader->corrupted = TRUE;
4529 message = dbus_message_new_empty_header ();
4530 if (message == NULL)
4532 _dbus_verbose ("Failed to allocate empty message\n");
4536 message->byte_order = byte_order;
4537 message->header_padding = header_padding;
4539 /* Copy in the offsets we found */
4541 while (i < FIELD_LAST)
4543 message->header_fields[i] = fields[i];
4547 if (!_dbus_list_append (&loader->messages, message))
4549 _dbus_verbose ("Failed to append new message to loader queue\n");
4550 dbus_message_unref (message);
4554 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
4555 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
4557 _dbus_assert (_dbus_string_get_length (&loader->data) >=
4558 (header_len + body_len));
4560 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
4562 _dbus_verbose ("Failed to move header into new message\n");
4563 _dbus_list_remove_last (&loader->messages, message);
4564 dbus_message_unref (message);
4568 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
4572 _dbus_verbose ("Failed to move body into new message\n");
4574 /* put the header back, we'll try again later */
4575 result = _dbus_string_copy_len (&message->header, 0, header_len,
4577 _dbus_assert (result); /* because DBusString never reallocs smaller */
4579 _dbus_list_remove_last (&loader->messages, message);
4580 dbus_message_unref (message);
4584 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
4585 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
4587 /* Fill in caches (we checked the types of these fields
4590 message->reply_serial = get_uint_field (message,
4591 FIELD_REPLY_SERIAL);
4592 message->client_serial = get_uint_field (message,
4593 FIELD_CLIENT_SERIAL);
4595 _dbus_verbose ("Loaded message %p\n", message);
4605 * Peeks at first loaded message, returns #NULL if no messages have
4608 * @param loader the loader.
4609 * @returns the next message, or #NULL if none.
4612 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
4614 if (loader->messages)
4615 return loader->messages->data;
4621 * Pops a loaded message (passing ownership of the message
4622 * to the caller). Returns #NULL if no messages have been
4625 * @param loader the loader.
4626 * @returns the next message, or #NULL if none.
4629 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
4631 return _dbus_list_pop_first (&loader->messages);
4635 * Pops a loaded message inside a list link (passing ownership of the
4636 * message and link to the caller). Returns #NULL if no messages have
4639 * @param loader the loader.
4640 * @returns the next message link, or #NULL if none.
4643 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
4645 return _dbus_list_pop_first_link (&loader->messages);
4649 * Returns a popped message link, used to undo a pop.
4651 * @param loader the loader
4652 * @param link the link with a message in it
4655 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
4658 _dbus_list_prepend_link (&loader->messages, link);
4662 * Checks whether the loader is confused due to bad data.
4663 * If messages are received that are invalid, the
4664 * loader gets confused and gives up permanently.
4665 * This state is called "corrupted."
4667 * @param loader the loader
4668 * @returns #TRUE if the loader is hosed.
4671 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
4673 return loader->corrupted;
4677 * Sets the maximum size message we allow.
4679 * @param loader the loader
4680 * @param size the max message size in bytes
4683 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
4686 if (size > MAX_SANE_MESSAGE_SIZE)
4688 _dbus_verbose ("clamping requested max message size %ld to %d\n",
4689 size, MAX_SANE_MESSAGE_SIZE);
4690 size = MAX_SANE_MESSAGE_SIZE;
4692 loader->max_message_size = size;
4696 * Gets the maximum allowed message size in bytes.
4698 * @param loader the loader
4699 * @returns max size in bytes
4702 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
4704 return loader->max_message_size;
4707 static DBusDataSlotAllocator slot_allocator;
4708 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
4711 * Allocates an integer ID to be used for storing application-specific
4712 * data on any DBusMessage. The allocated ID may then be used
4713 * with dbus_message_set_data() and dbus_message_get_data().
4714 * The passed-in slot must be initialized to -1, and is filled in
4715 * with the slot ID. If the passed-in slot is not -1, it's assumed
4716 * to be already allocated, and its refcount is incremented.
4718 * The allocated slot is global, i.e. all DBusMessage objects will
4719 * have a slot with the given integer ID reserved.
4721 * @param slot_p address of a global variable storing the slot
4722 * @returns #FALSE on failure (no memory)
4725 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
4727 return _dbus_data_slot_allocator_alloc (&slot_allocator,
4728 _DBUS_LOCK_NAME (message_slots),
4733 * Deallocates a global ID for message data slots.
4734 * dbus_message_get_data() and dbus_message_set_data() may no
4735 * longer be used with this slot. Existing data stored on existing
4736 * DBusMessage objects will be freed when the message is
4737 * finalized, but may not be retrieved (and may only be replaced if
4738 * someone else reallocates the slot). When the refcount on the
4739 * passed-in slot reaches 0, it is set to -1.
4741 * @param slot_p address storing the slot to deallocate
4744 dbus_message_free_data_slot (dbus_int32_t *slot_p)
4746 _dbus_return_if_fail (*slot_p >= 0);
4748 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
4752 * Stores a pointer on a DBusMessage, along
4753 * with an optional function to be used for freeing
4754 * the data when the data is set again, or when
4755 * the message is finalized. The slot number
4756 * must have been allocated with dbus_message_allocate_data_slot().
4758 * @param message the message
4759 * @param slot the slot number
4760 * @param data the data to store
4761 * @param free_data_func finalizer function for the data
4762 * @returns #TRUE if there was enough memory to store the data
4765 dbus_message_set_data (DBusMessage *message,
4768 DBusFreeFunction free_data_func)
4770 DBusFreeFunction old_free_func;
4774 _dbus_return_val_if_fail (message != NULL, FALSE);
4775 _dbus_return_val_if_fail (slot >= 0, FALSE);
4777 retval = _dbus_data_slot_list_set (&slot_allocator,
4778 &message->slot_list,
4779 slot, data, free_data_func,
4780 &old_free_func, &old_data);
4784 /* Do the actual free outside the message lock */
4786 (* old_free_func) (old_data);
4793 * Retrieves data previously set with dbus_message_set_data().
4794 * The slot must still be allocated (must not have been freed).
4796 * @param message the message
4797 * @param slot the slot to get data from
4798 * @returns the data, or #NULL if not found
4801 dbus_message_get_data (DBusMessage *message,
4806 _dbus_return_val_if_fail (message != NULL, NULL);
4808 res = _dbus_data_slot_list_get (&slot_allocator,
4809 &message->slot_list,
4816 #ifdef DBUS_BUILD_TESTS
4817 #include "dbus-test.h"
4821 message_iter_test (DBusMessage *message)
4823 DBusMessageIter iter, dict, array, array2;
4825 unsigned char *data;
4826 dbus_int32_t *our_int_array;
4829 dbus_message_iter_init (message, &iter);
4832 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
4833 _dbus_assert_not_reached ("Argument type isn't string");
4835 str = dbus_message_iter_get_string (&iter);
4836 if (strcmp (str, "Test string") != 0)
4837 _dbus_assert_not_reached ("Strings differ");
4840 if (!dbus_message_iter_next (&iter))
4841 _dbus_assert_not_reached ("Reached end of arguments");
4843 /* Signed integer tests */
4844 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
4845 _dbus_assert_not_reached ("Argument type isn't int32");
4847 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
4848 _dbus_assert_not_reached ("Signed integers differ");
4850 if (!dbus_message_iter_next (&iter))
4851 _dbus_assert_not_reached ("Reached end of fields");
4853 /* Unsigned integer tests */
4854 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
4855 _dbus_assert_not_reached ("Argument type isn't int32");
4857 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
4858 _dbus_assert_not_reached ("Unsigned integers differ");
4860 if (!dbus_message_iter_next (&iter))
4861 _dbus_assert_not_reached ("Reached end of arguments");
4864 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
4865 _dbus_assert_not_reached ("Argument type isn't double");
4867 if (dbus_message_iter_get_double (&iter) != 3.14159)
4868 _dbus_assert_not_reached ("Doubles differ");
4870 if (!dbus_message_iter_next (&iter))
4871 _dbus_assert_not_reached ("Reached end of arguments");
4873 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
4874 _dbus_assert_not_reached ("Argument type not an array");
4876 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
4877 _dbus_assert_not_reached ("Array type not double");
4880 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
4881 _dbus_assert_not_reached ("Array init failed");
4883 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4884 _dbus_assert_not_reached ("Argument type isn't double");
4886 if (dbus_message_iter_get_double (&array) != 1.5)
4887 _dbus_assert_not_reached ("Unsigned integers differ");
4889 if (!dbus_message_iter_next (&array))
4890 _dbus_assert_not_reached ("Reached end of arguments");
4892 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4893 _dbus_assert_not_reached ("Argument type isn't double");
4895 if (dbus_message_iter_get_double (&array) != 2.5)
4896 _dbus_assert_not_reached ("Unsigned integers differ");
4898 if (dbus_message_iter_next (&array))
4899 _dbus_assert_not_reached ("Didn't reach end of arguments");
4901 if (!dbus_message_iter_next (&iter))
4902 _dbus_assert_not_reached ("Reached end of arguments");
4907 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
4908 _dbus_assert_not_reached ("not dict type");
4910 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
4911 _dbus_assert_not_reached ("dict iter failed");
4913 str = dbus_message_iter_get_dict_key (&dict);
4914 if (str == NULL || strcmp (str, "test") != 0)
4915 _dbus_assert_not_reached ("wrong dict key");
4918 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
4919 _dbus_assert_not_reached ("wrong dict entry type");
4921 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
4922 _dbus_assert_not_reached ("wrong dict entry value");
4924 if (!dbus_message_iter_next (&dict))
4925 _dbus_assert_not_reached ("reached end of dict");
4927 /* array of array of int32 (in dict) */
4929 str = dbus_message_iter_get_dict_key (&dict);
4930 if (str == NULL || strcmp (str, "array") != 0)
4931 _dbus_assert_not_reached ("wrong dict key");
4934 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
4935 _dbus_assert_not_reached ("Argument type not an array");
4937 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
4938 _dbus_assert_not_reached ("Array type not array");
4940 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
4941 _dbus_assert_not_reached ("Array init failed");
4943 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
4944 _dbus_assert_not_reached ("Argument type isn't array");
4946 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4947 _dbus_assert_not_reached ("Array type not int32");
4949 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
4950 _dbus_assert_not_reached ("Array init failed");
4952 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
4953 _dbus_assert_not_reached ("Argument type isn't int32");
4955 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
4956 _dbus_assert_not_reached ("Signed integers differ");
4958 if (!dbus_message_iter_next (&array2))
4959 _dbus_assert_not_reached ("Reached end of arguments");
4961 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
4962 _dbus_assert_not_reached ("Signed integers differ");
4964 if (dbus_message_iter_next (&array2))
4965 _dbus_assert_not_reached ("Didn't reached end of arguments");
4967 if (!dbus_message_iter_next (&array))
4968 _dbus_assert_not_reached ("Reached end of arguments");
4970 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4971 _dbus_assert_not_reached ("Array type not int32");
4973 if (!dbus_message_iter_get_int32_array (&array,
4976 _dbus_assert_not_reached ("couldn't get int32 array");
4978 _dbus_assert (len == 3);
4979 _dbus_assert (our_int_array[0] == 0x34567812 &&
4980 our_int_array[1] == 0x45678123 &&
4981 our_int_array[2] == 0x56781234);
4982 dbus_free (our_int_array);
4984 if (dbus_message_iter_next (&array))
4985 _dbus_assert_not_reached ("Didn't reach end of array");
4987 if (dbus_message_iter_next (&dict))
4988 _dbus_assert_not_reached ("Didn't reach end of dict");
4990 if (!dbus_message_iter_next (&iter))
4991 _dbus_assert_not_reached ("Reached end of arguments");
4993 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
4995 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
4996 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
4999 if (dbus_message_iter_get_byte (&iter) != 0xF0)
5000 _dbus_assert_not_reached ("wrong value after dict");
5003 if (!dbus_message_iter_next (&iter))
5004 _dbus_assert_not_reached ("Reached end of arguments");
5006 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
5007 _dbus_assert_not_reached ("not a nil type");
5009 if (!dbus_message_iter_next (&iter))
5010 _dbus_assert_not_reached ("Reached end of arguments");
5012 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
5013 _dbus_assert_not_reached ("wrong type after dict");
5015 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
5016 _dbus_assert_not_reached ("failed to get named");
5018 _dbus_assert (strcmp (str, "named")==0);
5019 _dbus_assert (len == 5);
5020 _dbus_assert (strcmp (data, "data")==0);
5024 if (dbus_message_iter_next (&iter))
5025 _dbus_assert_not_reached ("Didn't reach end of arguments");
5030 check_message_handling_type (DBusMessageIter *iter,
5033 DBusMessageIter child_iter;
5039 case DBUS_TYPE_BYTE:
5040 dbus_message_iter_get_byte (iter);
5042 case DBUS_TYPE_BOOLEAN:
5043 dbus_message_iter_get_boolean (iter);
5045 case DBUS_TYPE_INT32:
5046 dbus_message_iter_get_int32 (iter);
5048 case DBUS_TYPE_UINT32:
5049 dbus_message_iter_get_uint32 (iter);
5051 case DBUS_TYPE_INT64:
5052 #ifdef DBUS_HAVE_INT64
5053 dbus_message_iter_get_int64 (iter);
5056 case DBUS_TYPE_UINT64:
5057 #ifdef DBUS_HAVE_INT64
5058 dbus_message_iter_get_uint64 (iter);
5061 case DBUS_TYPE_DOUBLE:
5062 dbus_message_iter_get_double (iter);
5064 case DBUS_TYPE_STRING:
5067 str = dbus_message_iter_get_string (iter);
5070 _dbus_warn ("NULL string in message\n");
5076 case DBUS_TYPE_NAMED:
5079 unsigned char *data;
5082 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
5084 _dbus_warn ("error reading name from named type\n");
5091 case DBUS_TYPE_ARRAY:
5095 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
5097 _dbus_warn ("Failed to init array iterator\n");
5101 while (dbus_message_iter_has_next (&child_iter))
5103 if (!check_message_handling_type (&child_iter, array_type))
5105 _dbus_warn ("error in array element\n");
5109 if (!dbus_message_iter_next (&child_iter))
5114 case DBUS_TYPE_DICT:
5119 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
5121 _dbus_warn ("Failed to init dict iterator\n");
5125 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5127 key = dbus_message_iter_get_dict_key (&child_iter);
5130 _dbus_warn ("error reading dict key\n");
5135 if (!check_message_handling_type (&child_iter, entry_type))
5137 _dbus_warn ("error in dict value\n");
5141 if (!dbus_message_iter_next (&child_iter))
5148 _dbus_warn ("unknown type %d\n", type);
5157 check_message_handling (DBusMessage *message)
5159 DBusMessageIter iter;
5162 dbus_uint32_t client_serial;
5166 client_serial = dbus_message_get_serial (message);
5168 /* can't use set_serial due to the assertions at the start of it */
5169 set_uint_field (message, FIELD_CLIENT_SERIAL,
5172 if (client_serial != dbus_message_get_serial (message))
5174 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5178 /* If we implement message_set_arg (message, n, value)
5179 * then we would want to test it here
5182 dbus_message_iter_init (message, &iter);
5183 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5185 if (!check_message_handling_type (&iter, type))
5188 if (!dbus_message_iter_next (&iter))
5199 check_have_valid_message (DBusMessageLoader *loader)
5201 DBusMessage *message;
5207 if (!_dbus_message_loader_queue_messages (loader))
5208 _dbus_assert_not_reached ("no memory to queue messages");
5210 if (_dbus_message_loader_get_is_corrupted (loader))
5212 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5216 message = _dbus_message_loader_pop_message (loader);
5217 if (message == NULL)
5219 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5223 if (_dbus_string_get_length (&loader->data) > 0)
5225 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5229 /* Verify that we're able to properly deal with the message.
5230 * For example, this would detect improper handling of messages
5231 * in nonstandard byte order.
5233 if (!check_message_handling (message))
5240 dbus_message_unref (message);
5246 check_invalid_message (DBusMessageLoader *loader)
5252 if (!_dbus_message_loader_queue_messages (loader))
5253 _dbus_assert_not_reached ("no memory to queue messages");
5255 if (!_dbus_message_loader_get_is_corrupted (loader))
5257 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
5268 check_incomplete_message (DBusMessageLoader *loader)
5270 DBusMessage *message;
5276 if (!_dbus_message_loader_queue_messages (loader))
5277 _dbus_assert_not_reached ("no memory to queue messages");
5279 if (_dbus_message_loader_get_is_corrupted (loader))
5281 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
5285 message = _dbus_message_loader_pop_message (loader);
5286 if (message != NULL)
5288 _dbus_warn ("loaded message that was expected to be incomplete\n");
5296 dbus_message_unref (message);
5301 check_loader_results (DBusMessageLoader *loader,
5302 DBusMessageValidity validity)
5304 if (!_dbus_message_loader_queue_messages (loader))
5305 _dbus_assert_not_reached ("no memory to queue messages");
5309 case _DBUS_MESSAGE_VALID:
5310 return check_have_valid_message (loader);
5311 case _DBUS_MESSAGE_INVALID:
5312 return check_invalid_message (loader);
5313 case _DBUS_MESSAGE_INCOMPLETE:
5314 return check_incomplete_message (loader);
5315 case _DBUS_MESSAGE_UNKNOWN:
5319 _dbus_assert_not_reached ("bad DBusMessageValidity");
5325 * Loads the message in the given message file.
5327 * @param filename filename to load
5328 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5329 * @param data string to load message into
5330 * @returns #TRUE if the message was loaded
5333 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
5345 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
5346 dbus_error_init (&error);
5347 if (!_dbus_file_get_contents (data, filename, &error))
5349 _dbus_warn ("Could not load message file %s: %s\n",
5350 _dbus_string_get_const_data (filename),
5352 dbus_error_free (&error);
5358 if (!_dbus_message_data_load (data, filename))
5360 _dbus_warn ("Could not load message file %s\n",
5361 _dbus_string_get_const_data (filename));
5374 * Tries loading the message in the given message file
5375 * and verifies that DBusMessageLoader can handle it.
5377 * @param filename filename to load
5378 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5379 * @param expected_validity what the message has to be like to return #TRUE
5380 * @returns #TRUE if the message has the expected validity
5383 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
5385 DBusMessageValidity expected_validity)
5392 if (!_dbus_string_init (&data))
5393 _dbus_assert_not_reached ("could not allocate string\n");
5395 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
5399 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
5405 if (_dbus_string_get_length (&data) > 0)
5406 _dbus_verbose_bytes_of_string (&data, 0,
5407 _dbus_string_get_length (&data));
5409 _dbus_warn ("Failed message loader test on %s\n",
5410 _dbus_string_get_const_data (filename));
5413 _dbus_string_free (&data);
5419 * Tries loading the given message data.
5422 * @param data the message data
5423 * @param expected_validity what the message has to be like to return #TRUE
5424 * @returns #TRUE if the message has the expected validity
5427 dbus_internal_do_not_use_try_message_data (const DBusString *data,
5428 DBusMessageValidity expected_validity)
5430 DBusMessageLoader *loader;
5438 /* Write the data one byte at a time */
5440 loader = _dbus_message_loader_new ();
5442 /* check some trivial loader functions */
5443 _dbus_message_loader_ref (loader);
5444 _dbus_message_loader_unref (loader);
5445 _dbus_message_loader_get_max_message_size (loader);
5447 len = _dbus_string_get_length (data);
5448 for (i = 0; i < len; i++)
5452 _dbus_message_loader_get_buffer (loader, &buffer);
5453 _dbus_string_append_byte (buffer,
5454 _dbus_string_get_byte (data, i));
5455 _dbus_message_loader_return_buffer (loader, buffer, 1);
5458 if (!check_loader_results (loader, expected_validity))
5461 _dbus_message_loader_unref (loader);
5464 /* Write the data all at once */
5466 loader = _dbus_message_loader_new ();
5471 _dbus_message_loader_get_buffer (loader, &buffer);
5472 _dbus_string_copy (data, 0, buffer,
5473 _dbus_string_get_length (buffer));
5474 _dbus_message_loader_return_buffer (loader, buffer, 1);
5477 if (!check_loader_results (loader, expected_validity))
5480 _dbus_message_loader_unref (loader);
5483 /* Write the data 2 bytes at a time */
5485 loader = _dbus_message_loader_new ();
5487 len = _dbus_string_get_length (data);
5488 for (i = 0; i < len; i += 2)
5492 _dbus_message_loader_get_buffer (loader, &buffer);
5493 _dbus_string_append_byte (buffer,
5494 _dbus_string_get_byte (data, i));
5496 _dbus_string_append_byte (buffer,
5497 _dbus_string_get_byte (data, i+1));
5498 _dbus_message_loader_return_buffer (loader, buffer, 1);
5501 if (!check_loader_results (loader, expected_validity))
5504 _dbus_message_loader_unref (loader);
5512 _dbus_message_loader_unref (loader);
5518 process_test_subdir (const DBusString *test_base_dir,
5520 DBusMessageValidity validity,
5521 DBusForeachMessageFileFunc function,
5524 DBusString test_directory;
5525 DBusString filename;
5533 if (!_dbus_string_init (&test_directory))
5534 _dbus_assert_not_reached ("didn't allocate test_directory\n");
5536 _dbus_string_init_const (&filename, subdir);
5538 if (!_dbus_string_copy (test_base_dir, 0,
5539 &test_directory, 0))
5540 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
5542 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
5543 _dbus_assert_not_reached ("couldn't allocate full path");
5545 _dbus_string_free (&filename);
5546 if (!_dbus_string_init (&filename))
5547 _dbus_assert_not_reached ("didn't allocate filename string\n");
5549 dbus_error_init (&error);
5550 dir = _dbus_directory_open (&test_directory, &error);
5553 _dbus_warn ("Could not open %s: %s\n",
5554 _dbus_string_get_const_data (&test_directory),
5556 dbus_error_free (&error);
5560 printf ("Testing:\n");
5563 while (_dbus_directory_get_next_file (dir, &filename, &error))
5565 DBusString full_path;
5568 if (!_dbus_string_init (&full_path))
5569 _dbus_assert_not_reached ("couldn't init string");
5571 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
5572 _dbus_assert_not_reached ("couldn't copy dir to full_path");
5574 if (!_dbus_concat_dir_and_file (&full_path, &filename))
5575 _dbus_assert_not_reached ("couldn't concat file to dir");
5577 if (_dbus_string_ends_with_c_str (&filename, ".message"))
5579 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
5583 _dbus_verbose ("Skipping non-.message file %s\n",
5584 _dbus_string_get_const_data (&filename));
5585 _dbus_string_free (&full_path);
5590 _dbus_string_get_const_data (&filename));
5592 _dbus_verbose (" expecting %s\n",
5593 validity == _DBUS_MESSAGE_VALID ? "valid" :
5594 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
5595 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
5597 if (! (*function) (&full_path, is_raw, validity, user_data))
5599 _dbus_string_free (&full_path);
5603 _dbus_string_free (&full_path);
5606 if (dbus_error_is_set (&error))
5608 _dbus_warn ("Could not get next file in %s: %s\n",
5609 _dbus_string_get_const_data (&test_directory),
5611 dbus_error_free (&error);
5620 _dbus_directory_close (dir);
5621 _dbus_string_free (&test_directory);
5622 _dbus_string_free (&filename);
5628 * Runs the given function on every message file in the test suite.
5629 * The function should return #FALSE on test failure or fatal error.
5631 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
5632 * @param func the function to run
5633 * @param user_data data for function
5634 * @returns #FALSE if there's a failure
5637 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
5638 DBusForeachMessageFileFunc func,
5641 DBusString test_directory;
5646 _dbus_string_init_const (&test_directory, test_data_dir);
5648 if (!process_test_subdir (&test_directory, "valid-messages",
5649 _DBUS_MESSAGE_VALID, func, user_data))
5652 if (!process_test_subdir (&test_directory, "invalid-messages",
5653 _DBUS_MESSAGE_INVALID, func, user_data))
5656 if (!process_test_subdir (&test_directory, "incomplete-messages",
5657 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
5664 _dbus_string_free (&test_directory);
5670 verify_test_message (DBusMessage *message)
5672 DBusMessageIter iter, dict;
5674 dbus_int32_t our_int;
5677 dbus_bool_t our_bool;
5678 dbus_uint32_t our_uint32;
5679 dbus_int32_t *our_uint32_array;
5680 int our_uint32_array_len;
5681 dbus_int32_t *our_int32_array;
5682 int our_int32_array_len;
5683 char **our_string_array;
5684 int our_string_array_len;
5685 #ifdef DBUS_HAVE_INT64
5686 dbus_int64_t our_int64;
5687 dbus_uint64_t our_uint64;
5688 dbus_int64_t *our_uint64_array;
5689 int our_uint64_array_len;
5690 dbus_int64_t *our_int64_array;
5691 int our_int64_array_len;
5693 double *our_double_array;
5694 int our_double_array_len;
5695 unsigned char *our_byte_array;
5696 int our_byte_array_len;
5697 unsigned char *our_boolean_array;
5698 int our_boolean_array_len;
5700 dbus_message_iter_init (message, &iter);
5702 dbus_error_init (&error);
5703 if (!dbus_message_iter_get_args (&iter, &error,
5704 DBUS_TYPE_INT32, &our_int,
5705 #ifdef DBUS_HAVE_INT64
5706 DBUS_TYPE_INT64, &our_int64,
5707 DBUS_TYPE_UINT64, &our_uint64,
5709 DBUS_TYPE_STRING, &our_str,
5710 DBUS_TYPE_DOUBLE, &our_double,
5711 DBUS_TYPE_BOOLEAN, &our_bool,
5712 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
5713 &our_uint32_array, &our_uint32_array_len,
5714 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
5715 &our_int32_array, &our_int32_array_len,
5716 #ifdef DBUS_HAVE_INT64
5717 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
5718 &our_uint64_array, &our_uint64_array_len,
5719 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
5720 &our_int64_array, &our_int64_array_len,
5722 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
5723 &our_string_array, &our_string_array_len,
5724 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
5725 &our_double_array, &our_double_array_len,
5726 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
5727 &our_byte_array, &our_byte_array_len,
5728 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
5729 &our_boolean_array, &our_boolean_array_len,
5732 _dbus_warn ("error: %s - %s\n", error.name,
5733 (error.message != NULL) ? error.message : "no message");
5734 _dbus_assert_not_reached ("Could not get arguments");
5737 if (our_int != -0x12345678)
5738 _dbus_assert_not_reached ("integers differ!");
5740 #ifdef DBUS_HAVE_INT64
5741 if (our_int64 != -0x123456789abcd)
5742 _dbus_assert_not_reached ("64-bit integers differ!");
5743 if (our_uint64 != 0x123456789abcd)
5744 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
5747 if (our_double != 3.14159)
5748 _dbus_assert_not_reached ("doubles differ!");
5750 if (strcmp (our_str, "Test string") != 0)
5751 _dbus_assert_not_reached ("strings differ!");
5752 dbus_free (our_str);
5755 _dbus_assert_not_reached ("booleans differ");
5757 if (our_uint32_array_len != 4 ||
5758 our_uint32_array[0] != 0x12345678 ||
5759 our_uint32_array[1] != 0x23456781 ||
5760 our_uint32_array[2] != 0x34567812 ||
5761 our_uint32_array[3] != 0x45678123)
5762 _dbus_assert_not_reached ("uint array differs");
5763 dbus_free (our_uint32_array);
5765 if (our_int32_array_len != 4 ||
5766 our_int32_array[0] != 0x12345678 ||
5767 our_int32_array[1] != -0x23456781 ||
5768 our_int32_array[2] != 0x34567812 ||
5769 our_int32_array[3] != -0x45678123)
5770 _dbus_assert_not_reached ("int array differs");
5771 dbus_free (our_int32_array);
5773 #ifdef DBUS_HAVE_INT64
5774 if (our_uint64_array_len != 4 ||
5775 our_uint64_array[0] != 0x12345678 ||
5776 our_uint64_array[1] != 0x23456781 ||
5777 our_uint64_array[2] != 0x34567812 ||
5778 our_uint64_array[3] != 0x45678123)
5779 _dbus_assert_not_reached ("uint64 array differs");
5780 dbus_free (our_uint64_array);
5782 if (our_int64_array_len != 4 ||
5783 our_int64_array[0] != 0x12345678 ||
5784 our_int64_array[1] != -0x23456781 ||
5785 our_int64_array[2] != 0x34567812 ||
5786 our_int64_array[3] != -0x45678123)
5787 _dbus_assert_not_reached ("int64 array differs");
5788 dbus_free (our_int64_array);
5789 #endif /* DBUS_HAVE_INT64 */
5791 if (our_string_array_len != 4)
5792 _dbus_assert_not_reached ("string array has wrong length");
5794 if (strcmp (our_string_array[0], "Foo") != 0 ||
5795 strcmp (our_string_array[1], "bar") != 0 ||
5796 strcmp (our_string_array[2], "") != 0 ||
5797 strcmp (our_string_array[3], "woo woo woo woo") != 0)
5798 _dbus_assert_not_reached ("string array differs");
5800 dbus_free_string_array (our_string_array);
5802 if (our_double_array_len != 3)
5803 _dbus_assert_not_reached ("double array had wrong length");
5805 /* On all IEEE machines (i.e. everything sane) exact equality
5806 * should be preserved over the wire
5808 if (our_double_array[0] != 0.1234 ||
5809 our_double_array[1] != 9876.54321 ||
5810 our_double_array[2] != -300.0)
5811 _dbus_assert_not_reached ("double array had wrong values");
5813 dbus_free (our_double_array);
5815 if (our_byte_array_len != 4)
5816 _dbus_assert_not_reached ("byte array had wrong length");
5818 if (our_byte_array[0] != 'a' ||
5819 our_byte_array[1] != 'b' ||
5820 our_byte_array[2] != 'c' ||
5821 our_byte_array[3] != 234)
5822 _dbus_assert_not_reached ("byte array had wrong values");
5824 dbus_free (our_byte_array);
5826 if (our_boolean_array_len != 5)
5827 _dbus_assert_not_reached ("bool array had wrong length");
5829 if (our_boolean_array[0] != TRUE ||
5830 our_boolean_array[1] != FALSE ||
5831 our_boolean_array[2] != TRUE ||
5832 our_boolean_array[3] != TRUE ||
5833 our_boolean_array[4] != FALSE)
5834 _dbus_assert_not_reached ("bool array had wrong values");
5836 dbus_free (our_boolean_array);
5838 if (!dbus_message_iter_next (&iter))
5839 _dbus_assert_not_reached ("Reached end of arguments");
5841 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5842 _dbus_assert_not_reached ("not dict type");
5844 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
5845 _dbus_assert_not_reached ("dict iter failed");
5847 our_str = dbus_message_iter_get_dict_key (&dict);
5848 if (our_str == NULL || strcmp (our_str, "test") != 0)
5849 _dbus_assert_not_reached ("wrong dict key");
5850 dbus_free (our_str);
5852 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5854 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
5855 _dbus_assert_not_reached ("wrong dict entry type");
5858 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
5860 _dbus_verbose ("dict entry val: %x\n", our_uint32);
5861 _dbus_assert_not_reached ("wrong dict entry value");
5864 if (dbus_message_iter_next (&dict))
5865 _dbus_assert_not_reached ("Didn't reach end of dict");
5867 if (!dbus_message_iter_next (&iter))
5868 _dbus_assert_not_reached ("Reached end of arguments");
5870 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5871 _dbus_assert_not_reached ("wrong type after dict");
5873 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
5874 _dbus_assert_not_reached ("wrong value after dict");
5876 if (dbus_message_iter_next (&iter))
5877 _dbus_assert_not_reached ("Didn't reach end of arguments");
5881 * @ingroup DBusMessageInternals
5882 * Unit test for DBusMessage.
5884 * @returns #TRUE on success.
5887 _dbus_message_test (const char *test_data_dir)
5889 DBusMessage *message;
5890 DBusMessageLoader *loader;
5891 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
5897 const dbus_uint32_t our_uint32_array[] =
5898 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5899 const dbus_uint32_t our_int32_array[] =
5900 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5901 #ifdef DBUS_HAVE_INT64
5902 const dbus_uint64_t our_uint64_array[] =
5903 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
5904 const dbus_uint64_t our_int64_array[] =
5905 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
5907 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
5908 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
5909 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
5910 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
5912 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
5914 message = dbus_message_new_method_call ("test.Message", "org.freedesktop.DBus.Test");
5915 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5916 _dbus_message_set_serial (message, 1234);
5917 dbus_message_set_sender (message, "org.foo.bar");
5918 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar"));
5919 dbus_message_set_sender (message, NULL);
5920 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar"));
5921 _dbus_assert (dbus_message_get_serial (message) == 1234);
5922 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.Test"));
5924 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5925 dbus_message_set_is_error (message, TRUE);
5926 _dbus_assert (dbus_message_get_is_error (message) == TRUE);
5927 dbus_message_set_is_error (message, FALSE);
5928 _dbus_assert (dbus_message_get_is_error (message) == FALSE);
5930 dbus_message_unref (message);
5932 /* Test the vararg functions */
5933 message = dbus_message_new_method_call ("test.Message", "org.freedesktop.DBus.Test");
5934 _dbus_message_set_serial (message, 1);
5935 dbus_message_append_args (message,
5936 DBUS_TYPE_INT32, -0x12345678,
5937 #ifdef DBUS_HAVE_INT64
5938 DBUS_TYPE_INT64, -0x123456789abcd,
5939 DBUS_TYPE_UINT64, 0x123456789abcd,
5941 DBUS_TYPE_STRING, "Test string",
5942 DBUS_TYPE_DOUBLE, 3.14159,
5943 DBUS_TYPE_BOOLEAN, TRUE,
5944 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
5945 _DBUS_N_ELEMENTS (our_uint32_array),
5946 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
5947 _DBUS_N_ELEMENTS (our_int32_array),
5948 #ifdef DBUS_HAVE_INT64
5949 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
5950 _DBUS_N_ELEMENTS (our_uint64_array),
5951 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
5952 _DBUS_N_ELEMENTS (our_int64_array),
5954 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
5955 _DBUS_N_ELEMENTS (our_string_array),
5956 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
5957 _DBUS_N_ELEMENTS (our_double_array),
5958 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
5959 _DBUS_N_ELEMENTS (our_byte_array),
5960 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
5961 _DBUS_N_ELEMENTS (our_boolean_array),
5964 dbus_message_append_iter_init (message, &iter);
5965 dbus_message_iter_append_dict (&iter, &child_iter);
5966 dbus_message_iter_append_dict_key (&child_iter, "test");
5967 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
5968 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
5970 _dbus_verbose_bytes_of_string (&message->header, 0,
5971 _dbus_string_get_length (&message->header));
5972 _dbus_verbose_bytes_of_string (&message->body, 0,
5973 _dbus_string_get_length (&message->body));
5975 verify_test_message (message);
5977 copy = dbus_message_copy (message);
5979 _dbus_assert (message->client_serial == copy->client_serial);
5980 _dbus_assert (message->reply_serial == copy->reply_serial);
5981 _dbus_assert (message->header_padding == copy->header_padding);
5983 _dbus_assert (_dbus_string_get_length (&message->header) ==
5984 _dbus_string_get_length (©->header));
5986 _dbus_assert (_dbus_string_get_length (&message->body) ==
5987 _dbus_string_get_length (©->body));
5989 verify_test_message (copy);
5991 name1 = dbus_message_get_name (message);
5992 name2 = dbus_message_get_name (copy);
5994 _dbus_assert (strcmp (name1, name2) == 0);
5996 dbus_message_unref (message);
5997 dbus_message_unref (copy);
5999 message = dbus_message_new_method_call ("test.Message", "org.freedesktop.DBus.Test");
6000 _dbus_message_set_serial (message, 1);
6001 dbus_message_set_reply_serial (message, 0x12345678);
6003 dbus_message_append_iter_init (message, &iter);
6004 dbus_message_iter_append_string (&iter, "Test string");
6005 dbus_message_iter_append_int32 (&iter, -0x12345678);
6006 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
6007 dbus_message_iter_append_double (&iter, 3.14159);
6009 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
6010 dbus_message_iter_append_double (&child_iter, 1.5);
6011 dbus_message_iter_append_double (&child_iter, 2.5);
6014 dbus_message_iter_append_dict (&iter, &child_iter);
6015 dbus_message_iter_append_dict_key (&child_iter, "test");
6016 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6018 /* array of array of int32 (in dict) */
6019 dbus_message_iter_append_dict_key (&child_iter, "array");
6020 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
6021 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6022 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
6023 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
6024 _dbus_warn ("next call expected to fail with wrong array type\n");
6025 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
6026 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6027 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
6028 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
6029 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
6031 dbus_message_iter_append_byte (&iter, 0xF0);
6033 dbus_message_iter_append_nil (&iter);
6035 dbus_message_iter_append_named (&iter, "named",
6038 message_iter_test (message);
6040 /* Message loader test */
6041 _dbus_message_lock (message);
6042 loader = _dbus_message_loader_new ();
6044 /* check ref/unref */
6045 _dbus_message_loader_ref (loader);
6046 _dbus_message_loader_unref (loader);
6048 /* Write the header data one byte at a time */
6049 data = _dbus_string_get_const_data (&message->header);
6050 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
6054 _dbus_message_loader_get_buffer (loader, &buffer);
6055 _dbus_string_append_byte (buffer, data[i]);
6056 _dbus_message_loader_return_buffer (loader, buffer, 1);
6059 /* Write the body data one byte at a time */
6060 data = _dbus_string_get_const_data (&message->body);
6061 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
6065 _dbus_message_loader_get_buffer (loader, &buffer);
6066 _dbus_string_append_byte (buffer, data[i]);
6067 _dbus_message_loader_return_buffer (loader, buffer, 1);
6070 dbus_message_unref (message);
6072 /* Now pop back the message */
6073 if (!_dbus_message_loader_queue_messages (loader))
6074 _dbus_assert_not_reached ("no memory to queue messages");
6076 if (_dbus_message_loader_get_is_corrupted (loader))
6077 _dbus_assert_not_reached ("message loader corrupted");
6079 message = _dbus_message_loader_pop_message (loader);
6081 _dbus_assert_not_reached ("received a NULL message");
6083 if (dbus_message_get_reply_serial (message) != 0x12345678)
6084 _dbus_assert_not_reached ("reply serial fields differ");
6086 message_iter_test (message);
6088 dbus_message_unref (message);
6089 _dbus_message_loader_unref (loader);
6091 /* Now load every message in test_data_dir if we have one */
6092 if (test_data_dir == NULL)
6095 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6096 (DBusForeachMessageFileFunc)
6097 dbus_internal_do_not_use_try_message_file,
6101 #endif /* DBUS_BUILD_TESTS */