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"
35 * @defgroup DBusMessageInternals DBusMessage implementation details
36 * @ingroup DBusInternals
37 * @brief DBusMessage private implementation details.
39 * The guts of DBusMessage and its methods.
57 static dbus_bool_t field_is_named[FIELD_LAST] =
59 FALSE, /* FIELD_HEADER_LENGTH */
60 FALSE, /* FIELD_BODY_LENGTH */
61 FALSE, /* FIELD_CLIENT_SERIAL */
62 TRUE, /* FIELD_NAME */
63 TRUE, /* FIELD_SERVICE */
64 TRUE, /* FIELD_SENDER */
65 TRUE /* FIELD_REPLY_SERIAL */
70 int offset; /**< Offset to start of field (location of name of field
76 * @brief Internals of DBusMessage
78 * Object representing a message received from or to be sent to
79 * another application. This is an opaque object, all members
84 dbus_atomic_t refcount; /**< Reference count */
86 DBusString header; /**< Header network data, stored
87 * separately from body so we can
88 * independently realloc it.
91 HeaderField header_fields[FIELD_LAST]; /**< Track the location
92 * of each field in "header"
95 dbus_int32_t client_serial; /**< Cached client serial value for speed */
96 dbus_int32_t reply_serial; /**< Cached reply serial value for speed */
98 int header_padding; /**< bytes of alignment in header */
100 DBusString body; /**< Body network data. */
102 char byte_order; /**< Message byte order. */
104 DBusCounter *size_counter; /**< Counter for the size of the message, or #NULL */
105 long size_counter_delta; /**< Size we incremented the size counter by. */
107 dbus_uint32_t changed_stamp;
109 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
113 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
114 DBUS_MESSAGE_ITER_TYPE_ARRAY,
115 DBUS_MESSAGE_ITER_TYPE_DICT
118 typedef struct DBusMessageRealIter DBusMessageRealIter;
121 * @brief Internals of DBusMessageIter
123 * Object representing a position in a message. All fields are internal.
125 struct DBusMessageRealIter
127 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
128 DBusMessage *message; /**< Message used */
129 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
131 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
132 int type; /**< type of iter */
134 int pos; /**< Current position in the string */
135 int end; /**< position right after the container */
136 int container_start; /**< offset of the start of the container */
137 int container_length_pos; /**< offset of the length of the container */
139 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
141 int array_type_pos; /**< pointer to the position of the array element type */
142 int array_type_done; /**< TRUE if the array type is fully finished */
146 * Gets the data to be sent over the network for this message.
147 * The header and then the body should be written out.
148 * This function is guaranteed to always return the same
149 * data once a message is locked (with _dbus_message_lock()).
151 * @param message the message.
152 * @param header return location for message header data.
153 * @param body return location for message body data.
156 _dbus_message_get_network_data (DBusMessage *message,
157 const DBusString **header,
158 const DBusString **body)
160 _dbus_assert (message->locked);
162 *header = &message->header;
163 *body = &message->body;
167 clear_header_padding (DBusMessage *message)
169 _dbus_string_shorten (&message->header,
170 message->header_padding);
171 message->header_padding = 0;
175 append_header_padding (DBusMessage *message)
178 old_len = _dbus_string_get_length (&message->header);
179 if (!_dbus_string_align_length (&message->header, 8))
182 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
188 adjust_field_offsets (DBusMessage *message,
198 while (i < FIELD_LAST)
200 if (message->header_fields[i].offset > offsets_after)
201 message->header_fields[i].offset += delta;
208 get_string_field (DBusMessage *message,
215 offset = message->header_fields[field].offset;
217 _dbus_assert (field < FIELD_LAST);
222 /* offset points to string length, string data follows it */
223 /* FIXME _dbus_demarshal_const_string() that returned
224 * a reference to the string plus its len might be nice.
228 *len = _dbus_demarshal_uint32 (&message->header,
233 data = _dbus_string_get_const_data (&message->header);
235 return data + (offset + 4);
239 get_int_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_int32 (&message->header,
258 append_int_field (DBusMessage *message,
265 _dbus_assert (!message->locked);
267 clear_header_padding (message);
269 orig_len = _dbus_string_get_length (&message->header);
271 if (!_dbus_string_align_length (&message->header, 4))
274 if (!_dbus_string_append_len (&message->header, name, 4))
277 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
280 if (!_dbus_string_align_length (&message->header, 4))
283 message->header_fields[FIELD_REPLY_SERIAL].offset =
284 _dbus_string_get_length (&message->header);
286 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
290 if (!append_header_padding (message))
296 message->header_fields[field].offset = -1;
297 _dbus_string_set_length (&message->header, orig_len);
299 /* this must succeed because it was allocated on function entry and
300 * DBusString doesn't ever realloc smaller
302 if (!append_header_padding (message))
303 _dbus_assert_not_reached ("failed to reappend header padding");
308 append_string_field (DBusMessage *message,
315 _dbus_assert (!message->locked);
317 clear_header_padding (message);
319 orig_len = _dbus_string_get_length (&message->header);
321 if (!_dbus_string_align_length (&message->header, 4))
324 if (!_dbus_string_append_len (&message->header, name, 4))
327 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_STRING))
330 if (!_dbus_string_align_length (&message->header, 4))
333 message->header_fields[field].offset =
334 _dbus_string_get_length (&message->header);
336 if (!_dbus_marshal_string (&message->header, message->byte_order,
340 if (!append_header_padding (message))
346 message->header_fields[field].offset = -1;
347 _dbus_string_set_length (&message->header, orig_len);
349 /* this must succeed because it was allocated on function entry and
350 * DBusString doesn't ever realloc smaller
352 if (!append_header_padding (message))
353 _dbus_assert_not_reached ("failed to reappend header padding");
358 #ifdef DBUS_BUILD_TESTS
359 /* This isn't used, but building it when tests are enabled just to
360 * keep it compiling if we need it in future
363 delete_int_field (DBusMessage *message,
366 int offset = message->header_fields[field].offset;
368 _dbus_assert (!message->locked);
369 _dbus_assert (field_is_named[field]);
374 clear_header_padding (message);
376 /* The field typecode and name take up 8 bytes */
377 _dbus_string_delete (&message->header,
381 message->header_fields[field].offset = -1;
383 adjust_field_offsets (message,
387 append_header_padding (message);
392 delete_string_field (DBusMessage *message,
395 int offset = message->header_fields[field].offset;
399 _dbus_assert (!message->locked);
400 _dbus_assert (field_is_named[field]);
405 clear_header_padding (message);
407 get_string_field (message, field, &len);
409 /* The field typecode and name take up 8 bytes, and the nul
410 * termination is 1 bytes, string length integer is 4 bytes
412 delete_len = 8 + 4 + 1 + len;
414 _dbus_string_delete (&message->header,
418 message->header_fields[field].offset = -1;
420 adjust_field_offsets (message,
424 append_header_padding (message);
428 set_int_field (DBusMessage *message,
432 int offset = message->header_fields[field].offset;
434 _dbus_assert (!message->locked);
438 /* need to append the field */
442 case FIELD_REPLY_SERIAL:
443 return append_int_field (message, field,
444 DBUS_HEADER_FIELD_REPLY,
447 _dbus_assert_not_reached ("appending an int field we don't support appending");
453 _dbus_marshal_set_int32 (&message->header,
462 set_uint_field (DBusMessage *message,
466 int offset = message->header_fields[field].offset;
468 _dbus_assert (!message->locked);
472 /* need to append the field */
477 _dbus_assert_not_reached ("appending a uint field we don't support appending");
483 _dbus_marshal_set_uint32 (&message->header,
492 set_string_field (DBusMessage *message,
496 int offset = message->header_fields[field].offset;
498 _dbus_assert (!message->locked);
499 _dbus_assert (value != NULL);
503 /* need to append the field */
508 return append_string_field (message, field,
509 DBUS_HEADER_FIELD_SENDER,
512 _dbus_assert_not_reached ("appending a string field we don't support appending");
523 clear_header_padding (message);
525 old_len = _dbus_string_get_length (&message->header);
527 len = strlen (value);
529 _dbus_string_init_const_len (&v, value,
530 len + 1); /* include nul */
531 if (!_dbus_marshal_set_string (&message->header,
537 new_len = _dbus_string_get_length (&message->header);
539 adjust_field_offsets (message,
543 if (!append_header_padding (message))
549 /* this must succeed because it was allocated on function entry and
550 * DBusString doesn't ever realloc smaller
552 if (!append_header_padding (message))
553 _dbus_assert_not_reached ("failed to reappend header padding");
560 * Sets the serial number of a message.
561 * This can only be done once on a message.
563 * @param message the message
564 * @param serial the serial
567 _dbus_message_set_serial (DBusMessage *message,
570 _dbus_assert (!message->locked);
571 _dbus_assert (dbus_message_get_serial (message) < 0);
573 set_int_field (message, FIELD_CLIENT_SERIAL,
575 message->client_serial = serial;
579 * Sets the reply serial of a message (the client serial
580 * of the message this is a reply to).
582 * @param message the message
583 * @param reply_serial the client serial
584 * @returns #FALSE if not enough memory
587 dbus_message_set_reply_serial (DBusMessage *message,
588 dbus_int32_t reply_serial)
590 _dbus_assert (!message->locked);
592 if (set_int_field (message, FIELD_REPLY_SERIAL,
595 message->reply_serial = reply_serial;
603 * Returns the serial of a message or -1 if none has been specified.
604 * The message's serial number is provided by the application sending
605 * the message and is used to identify replies to this message.
607 * @param message the message
608 * @returns the client serial
611 dbus_message_get_serial (DBusMessage *message)
613 return message->client_serial;
617 * Returns the serial that the message is
618 * a reply to or -1 if none.
620 * @param message the message
621 * @returns the reply serial
624 dbus_message_get_reply_serial (DBusMessage *message)
626 return message->reply_serial;
630 * Adds a counter to be incremented immediately with the
631 * size of this message, and decremented by the size
632 * of this message when this message if finalized.
634 * @param message the message
635 * @param counter the counter
638 _dbus_message_add_size_counter (DBusMessage *message,
639 DBusCounter *counter)
641 _dbus_assert (message->size_counter == NULL); /* If this fails we may need to keep a list of
642 * counters instead of just one
645 message->size_counter = counter;
646 _dbus_counter_ref (message->size_counter);
648 /* When we can change message size, we may want to
649 * update this each time we do so, or we may want to
650 * just KISS like this.
652 message->size_counter_delta =
653 _dbus_string_get_length (&message->header) +
654 _dbus_string_get_length (&message->body);
657 _dbus_verbose ("message has size %ld\n",
658 message->size_counter_delta);
661 _dbus_counter_adjust (message->size_counter, message->size_counter_delta);
665 dbus_message_create_header (DBusMessage *message,
671 if (!_dbus_string_append_byte (&message->header, message->byte_order))
675 if (!_dbus_string_append_byte (&message->header, flags))
678 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
681 if (!_dbus_string_append_byte (&message->header, 0))
684 message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
685 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
688 message->header_fields[FIELD_BODY_LENGTH].offset = 8;
689 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
692 message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
693 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
696 /* Marshal message service */
699 if (!append_string_field (message,
701 DBUS_HEADER_FIELD_SERVICE,
706 _dbus_assert (name != NULL);
707 if (!append_string_field (message,
709 DBUS_HEADER_FIELD_NAME,
717 * Locks a message. Allows checking that applications don't keep a
718 * reference to a message in the outgoing queue and change it
719 * underneath us. Messages are locked when they enter the outgoing
720 * queue (dbus_connection_send_message()), and the library complains
721 * if the message is modified while locked.
723 * @param message the message to lock.
726 _dbus_message_lock (DBusMessage *message)
728 if (!message->locked)
730 /* Fill in our lengths */
731 set_uint_field (message,
733 _dbus_string_get_length (&message->header));
735 set_uint_field (message,
737 _dbus_string_get_length (&message->body));
739 message->locked = TRUE;
746 * @defgroup DBusMessage DBusMessage
748 * @brief Message to be sent or received over a DBusConnection.
750 * A DBusMessage is the most basic unit of communication over a
751 * DBusConnection. A DBusConnection represents a stream of messages
752 * received from a remote application, and a stream of messages
753 * sent to a remote application.
759 * @typedef DBusMessage
761 * Opaque data type representing a message received from or to be
762 * sent to another application.
766 dbus_message_new_empty_header (void)
768 DBusMessage *message;
771 message = dbus_new0 (DBusMessage, 1);
775 message->refcount = 1;
776 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
777 message->client_serial = -1;
778 message->reply_serial = -1;
781 while (i < FIELD_LAST)
783 message->header_fields[i].offset = -1;
787 if (!_dbus_string_init (&message->header))
793 if (!_dbus_string_init (&message->body))
795 _dbus_string_free (&message->header);
805 * Constructs a new message. Returns #NULL if memory can't be
806 * allocated for the message. The service may be #NULL in which case
807 * no service is set; this is appropriate when using D-BUS in a
808 * peer-to-peer context (no message bus).
810 * @todo reverse the arguments, first 'name' then 'service'
811 * as 'name' is more fundamental
813 * @param service service that the message should be sent to or #NULL
814 * @param name name of the message
815 * @returns a new DBusMessage, free with dbus_message_unref()
816 * @see dbus_message_unref()
819 dbus_message_new (const char *service,
822 DBusMessage *message;
824 message = dbus_message_new_empty_header ();
828 if (!dbus_message_create_header (message, service, name))
830 dbus_message_unref (message);
838 * Constructs a message that is a reply to some other
839 * message. Returns #NULL if memory can't be allocated
842 * @param original_message the message which the created
843 * message is a reply to.
844 * @returns a new DBusMessage, free with dbus_message_unref()
845 * @see dbus_message_new(), dbus_message_unref()
848 dbus_message_new_reply (DBusMessage *original_message)
850 DBusMessage *message;
851 const char *sender, *name;
853 sender = get_string_field (original_message,
855 name = get_string_field (original_message,
858 /* sender is allowed to be null here in peer-to-peer case */
860 message = dbus_message_new (sender, name);
865 if (!dbus_message_set_reply_serial (message,
866 dbus_message_get_serial (original_message)))
868 dbus_message_unref (message);
876 * Creates a new message that is an error reply to a certain message.
878 * @param original_message the original message
879 * @param error_name the error name
880 * @param error_message the error message string
881 * @returns a new error message
884 dbus_message_new_error_reply (DBusMessage *original_message,
885 const char *error_name,
886 const char *error_message)
888 DBusMessage *message;
890 DBusMessageIter iter;
892 sender = get_string_field (original_message,
895 _dbus_assert (sender != NULL);
897 message = dbus_message_new (sender, error_name);
902 if (!dbus_message_set_reply_serial (message,
903 dbus_message_get_serial (original_message)))
905 dbus_message_unref (message);
909 dbus_message_append_iter_init (message, &iter);
910 if (!dbus_message_iter_append_string (&iter, error_message))
912 dbus_message_unref (message);
916 dbus_message_set_is_error (message, TRUE);
922 * Creates a new message that is an exact replica of the message
923 * specified, except that its refcount is set to 1.
925 * @param message the message.
926 * @returns the new message.
929 dbus_message_copy (const DBusMessage *message)
934 retval = dbus_new0 (DBusMessage, 1);
938 retval->refcount = 1;
939 retval->byte_order = message->byte_order;
940 retval->client_serial = message->client_serial;
941 retval->reply_serial = message->reply_serial;
942 retval->header_padding = message->header_padding;
943 retval->locked = FALSE;
945 if (!_dbus_string_init (&retval->header))
951 if (!_dbus_string_init (&retval->body))
953 _dbus_string_free (&retval->header);
958 if (!_dbus_string_copy (&message->header, 0,
961 _dbus_string_free (&retval->header);
962 _dbus_string_free (&retval->body);
968 if (!_dbus_string_copy (&message->body, 0,
971 _dbus_string_free (&retval->header);
972 _dbus_string_free (&retval->body);
978 for (i = 0; i < FIELD_LAST; i++)
980 retval->header_fields[i].offset = message->header_fields[i].offset;
988 * Increments the reference count of a DBusMessage.
990 * @param message The message
991 * @see dbus_message_unref
994 dbus_message_ref (DBusMessage *message)
996 dbus_atomic_t refcount;
998 refcount = _dbus_atomic_inc (&message->refcount);
999 _dbus_assert (refcount > 1);
1003 * Decrements the reference count of a DBusMessage.
1005 * @param message The message
1006 * @see dbus_message_ref
1009 dbus_message_unref (DBusMessage *message)
1011 dbus_atomic_t refcount;
1013 refcount = _dbus_atomic_dec (&message->refcount);
1015 _dbus_assert (refcount >= 0);
1019 if (message->size_counter != NULL)
1021 _dbus_counter_adjust (message->size_counter,
1022 - message->size_counter_delta);
1023 _dbus_counter_unref (message->size_counter);
1026 _dbus_string_free (&message->header);
1027 _dbus_string_free (&message->body);
1029 dbus_free (message);
1034 * Gets the name of a message.
1036 * @param message the message
1037 * @returns the message name (should not be freed)
1040 dbus_message_get_name (DBusMessage *message)
1042 return get_string_field (message, FIELD_NAME, NULL);
1046 * Gets the destination service of a message.
1048 * @todo I think if we have set_sender/get_sender,
1049 * this function might be better named set_destination/
1050 * get_destination for clarity, as the sender
1051 * is also a service name.
1053 * @param message the message
1054 * @returns the message destination service (should not be freed)
1057 dbus_message_get_service (DBusMessage *message)
1059 return get_string_field (message, FIELD_SERVICE, NULL);
1063 * Appends fields to a message given a variable argument
1064 * list. The variable argument list should contain the type
1065 * of the argument followed by the value to add.
1066 * Array values are specified by a int typecode followed by a pointer
1067 * to the array followed by an int giving the length of the array.
1068 * The argument list must be terminated with 0.
1070 * This function doesn't support dicts or non-fundamental arrays.
1072 * @param message the message
1073 * @param first_arg_type type of the first argument
1074 * @param ... value of first argument, list of additional type-value pairs
1075 * @returns #TRUE on success
1078 dbus_message_append_args (DBusMessage *message,
1085 va_start (var_args, first_arg_type);
1086 retval = dbus_message_append_args_valist (message,
1095 * This function takes a va_list for use by language bindings
1097 * @todo: Shouldn't this function clean up the changes to the message
1100 * @see dbus_message_append_args.
1101 * @param message the message
1102 * @param first_arg_type type of first argument
1103 * @param var_args value of first argument, then list of type/value pairs
1104 * @returns #TRUE on success
1107 dbus_message_append_args_valist (DBusMessage *message,
1112 DBusMessageIter iter;
1114 old_len = _dbus_string_get_length (&message->body);
1116 type = first_arg_type;
1118 dbus_message_append_iter_init (message, &iter);
1125 if (!dbus_message_iter_append_nil (&iter))
1128 case DBUS_TYPE_BOOLEAN:
1129 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1132 case DBUS_TYPE_INT32:
1133 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1136 case DBUS_TYPE_UINT32:
1137 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1140 case DBUS_TYPE_DOUBLE:
1141 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1144 case DBUS_TYPE_STRING:
1145 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1148 case DBUS_TYPE_NAMED:
1151 unsigned char *data;
1154 name = va_arg (var_args, const char *);
1155 data = va_arg (var_args, unsigned char *);
1156 len = va_arg (var_args, int);
1158 if (!dbus_message_iter_append_named (&iter, name, data, len))
1162 case DBUS_TYPE_ARRAY:
1167 type = va_arg (var_args, int);
1168 data = va_arg (var_args, void *);
1169 len = va_arg (var_args, int);
1173 case DBUS_TYPE_BYTE:
1174 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1177 case DBUS_TYPE_BOOLEAN:
1178 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1181 case DBUS_TYPE_INT32:
1182 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1185 case DBUS_TYPE_UINT32:
1186 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1189 case DBUS_TYPE_DOUBLE:
1190 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1193 case DBUS_TYPE_STRING:
1194 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1198 case DBUS_TYPE_ARRAY:
1199 case DBUS_TYPE_NAMED:
1200 case DBUS_TYPE_DICT:
1201 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1204 _dbus_warn ("Unknown field type %d\n", type);
1210 case DBUS_TYPE_DICT:
1211 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1214 _dbus_warn ("Unknown field type %d\n", type);
1218 type = va_arg (var_args, int);
1229 * Gets arguments from a message given a variable argument list.
1230 * The variable argument list should contain the type of the
1231 * argumen followed by a pointer to where the value should be
1232 * stored. The list is terminated with 0.
1234 * @param message the message
1235 * @param error error to be filled in on failure
1236 * @param first_arg_type the first argument type
1237 * @param ... location for first argument value, then list of type-location pairs
1238 * @returns #FALSE if the error was set
1241 dbus_message_get_args (DBusMessage *message,
1249 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1251 va_start (var_args, first_arg_type);
1252 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1259 * This function takes a va_list for use by language bindings
1261 * @todo We need to free the argument data when an error occurs.
1263 * @see dbus_message_get_args
1264 * @param message the message
1265 * @param error error to be filled in
1266 * @param first_arg_type type of the first argument
1267 * @param var_args return location for first argument, followed by list of type/location pairs
1268 * @returns #FALSE if error was set
1271 dbus_message_get_args_valist (DBusMessage *message,
1276 DBusMessageIter iter;
1278 dbus_message_iter_init (message, &iter);
1279 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1283 * Gets arguments from a message iterator given a variable argument list.
1284 * The variable argument list should contain the type of the
1285 * argumen followed by a pointer to where the value should be
1286 * stored. The list is terminated with 0.
1288 * @param iter the message iterator
1289 * @param error error to be filled in on failure
1290 * @param first_arg_type the first argument type
1291 * @param ... location for first argument value, then list of type-location pairs
1292 * @returns #FALSE if the error was set
1295 dbus_message_iter_get_args (DBusMessageIter *iter,
1303 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1305 va_start (var_args, first_arg_type);
1306 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1313 * This function takes a va_list for use by language bindings
1315 * @todo this function (or some lower-level non-convenience function)
1316 * needs better error handling; should allow the application to
1317 * distinguish between out of memory, and bad data from the remote
1318 * app. It also needs to not leak a bunch of args when it gets
1319 * to the arg that's bad, as that would be a security hole
1320 * (allow one app to force another to leak memory)
1322 * @todo We need to free the argument data when an error occurs.
1324 * @see dbus_message_get_args
1325 * @param iter the message iter
1326 * @param error error to be filled in
1327 * @param first_arg_type type of the first argument
1328 * @param var_args return location for first argument, followed by list of type/location pairs
1329 * @returns #FALSE if error was set
1332 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1337 int spec_type, msg_type, i;
1340 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
1344 spec_type = first_arg_type;
1347 while (spec_type != 0)
1349 msg_type = dbus_message_iter_get_arg_type (iter);
1351 if (msg_type != spec_type)
1353 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1354 "Argument %d is specified to be of type \"%s\", but "
1355 "is actually of type \"%s\"\n", i,
1356 _dbus_type_to_string (spec_type),
1357 _dbus_type_to_string (msg_type));
1366 case DBUS_TYPE_BYTE:
1370 ptr = va_arg (var_args, unsigned char *);
1372 *ptr = dbus_message_iter_get_byte (iter);
1375 case DBUS_TYPE_BOOLEAN:
1379 ptr = va_arg (var_args, dbus_bool_t *);
1381 *ptr = dbus_message_iter_get_boolean (iter);
1384 case DBUS_TYPE_INT32:
1388 ptr = va_arg (var_args, dbus_int32_t *);
1390 *ptr = dbus_message_iter_get_int32 (iter);
1393 case DBUS_TYPE_UINT32:
1397 ptr = va_arg (var_args, dbus_uint32_t *);
1399 *ptr = dbus_message_iter_get_uint32 (iter);
1403 case DBUS_TYPE_DOUBLE:
1407 ptr = va_arg (var_args, double *);
1409 *ptr = dbus_message_iter_get_double (iter);
1413 case DBUS_TYPE_STRING:
1417 ptr = va_arg (var_args, char **);
1419 *ptr = dbus_message_iter_get_string (iter);
1423 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1430 case DBUS_TYPE_NAMED:
1433 unsigned char **data;
1436 name = va_arg (var_args, char **);
1437 data = va_arg (var_args, unsigned char **);
1438 len = va_arg (var_args, int *);
1440 if (!dbus_message_iter_get_named (iter, name, data, len))
1442 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1447 case DBUS_TYPE_ARRAY:
1452 type = va_arg (var_args, int);
1453 data = va_arg (var_args, void *);
1454 len = va_arg (var_args, int *);
1456 if (dbus_message_iter_get_array_type (iter) != type)
1458 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1459 "Argument %d is specified to be of type \"array of %s\", but "
1460 "is actually of type \"array of %s\"\n", i,
1461 _dbus_type_to_string (type),
1462 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
1468 case DBUS_TYPE_BYTE:
1469 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
1471 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1475 case DBUS_TYPE_BOOLEAN:
1476 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
1478 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1482 case DBUS_TYPE_INT32:
1483 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
1485 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1489 case DBUS_TYPE_UINT32:
1490 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
1492 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1496 case DBUS_TYPE_DOUBLE:
1497 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
1499 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1503 case DBUS_TYPE_STRING:
1504 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
1506 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
1511 case DBUS_TYPE_ARRAY:
1512 case DBUS_TYPE_NAMED:
1513 case DBUS_TYPE_DICT:
1514 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
1515 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1518 _dbus_warn ("Unknown field type %d\n", type);
1519 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1524 case DBUS_TYPE_DICT:
1525 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
1526 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1529 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
1530 _dbus_warn ("Unknown field type %d\n", spec_type);
1534 spec_type = va_arg (var_args, int);
1535 if (spec_type != 0 && !dbus_message_iter_next (iter))
1537 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1538 "Message has only %d arguments, but more were expected", i);
1554 * Initializes a DBusMessageIter representing the arguments of the
1555 * message passed in.
1557 * @param message the message
1558 * @param _iter pointer to an iterator to initialize
1561 dbus_message_iter_init (DBusMessage *message,
1562 DBusMessageIter *iter)
1564 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1566 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
1568 real->message = message;
1569 real->parent_iter = NULL;
1570 real->changed_stamp = message->changed_stamp;
1572 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
1574 real->end = _dbus_string_get_length (&message->body);
1576 real->container_start = 0;
1577 real->container_length_pos = 0;
1578 real->wrote_dict_key = 0;
1579 real->array_type_pos = 0;
1583 dbus_message_iter_check (DBusMessageRealIter *iter)
1585 if (iter->changed_stamp != iter->message->changed_stamp)
1586 _dbus_warn ("dbus iterator check failed: invalid iterator\n");
1587 if (iter->pos < 0 || iter->pos > iter->end)
1588 _dbus_warn ("dbus iterator check failed: invalid position\n");
1592 skip_array_type (DBusMessageRealIter *iter, int pos)
1598 data = _dbus_string_get_const_data_len (&iter->message->body,
1601 while (*data == DBUS_TYPE_ARRAY);
1607 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
1614 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
1615 data = _dbus_string_get_const_data_len (&iter->message->body,
1617 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1620 *type = DBUS_TYPE_INVALID;
1622 return skip_array_type (iter, iter->pos);
1624 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
1625 data = _dbus_string_get_const_data_len (&iter->message->body,
1626 iter->array_type_pos, 1);
1627 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1630 *type = DBUS_TYPE_INVALID;
1634 case DBUS_MESSAGE_ITER_TYPE_DICT:
1635 /* Get the length of the string */
1636 len = _dbus_demarshal_uint32 (&iter->message->body,
1637 iter->message->byte_order,
1639 pos = pos + len + 1;
1641 data = _dbus_string_get_const_data_len (&iter->message->body,
1643 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1646 *type = DBUS_TYPE_INVALID;
1648 return skip_array_type (iter, pos);
1651 _dbus_assert_not_reached ("Invalid iter type");
1654 *type = DBUS_TYPE_INVALID;
1660 * Checks if an iterator has any more fields.
1662 * @param iter the message iter
1663 * @returns #TRUE if there are more fields
1667 dbus_message_iter_has_next (DBusMessageIter *iter)
1669 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1673 dbus_message_iter_check (real);
1675 if (real->pos >= real->end)
1678 pos = dbus_message_iter_get_data_start (real, &type);
1680 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1681 real->message->byte_order,
1682 type, pos, &end_pos))
1685 if (end_pos >= real->end)
1692 * Moves the iterator to the next field.
1694 * @param _iter The message iter
1695 * @returns #TRUE if the iterator was moved to the next field
1698 dbus_message_iter_next (DBusMessageIter *iter)
1700 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1704 dbus_message_iter_check (real);
1706 pos = dbus_message_iter_get_data_start (real, &type);
1708 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
1709 real->message->byte_order,
1710 type, pos, &end_pos))
1713 if (end_pos >= real->end)
1716 real->pos = end_pos;
1722 * Returns the argument type of the argument that the
1723 * message iterator points at.
1725 * @param iter the message iter
1726 * @returns the field type
1729 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
1731 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1734 dbus_message_iter_check (real);
1736 if (real->pos >= real->end)
1737 return DBUS_TYPE_INVALID;
1739 pos = dbus_message_iter_get_data_start (real, &type);
1745 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
1748 int _array_type_pos;
1753 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
1754 _array_type_pos = iter->pos + 1;
1756 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
1757 _array_type_pos = iter->array_type_pos + 1;
1759 case DBUS_MESSAGE_ITER_TYPE_DICT:
1760 /* Get the length of the string */
1761 len = _dbus_demarshal_uint32 (&iter->message->body,
1762 iter->message->byte_order,
1764 pos = pos + len + 1;
1765 data = _dbus_string_get_const_data_len (&iter->message->body,
1767 _array_type_pos = pos + 1;
1770 _dbus_assert_not_reached ("wrong iter type");
1771 return DBUS_TYPE_INVALID;
1774 if (array_type_pos != NULL)
1775 *array_type_pos = _array_type_pos;
1777 data = _dbus_string_get_const_data_len (&iter->message->body,
1778 _array_type_pos, 1);
1779 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
1782 return DBUS_TYPE_INVALID;
1787 * Returns the element type of the array that the
1788 * message iterator points at. Note that you need
1789 * to check that the iterator points to an array
1790 * prior to using this function.
1792 * @param iter the message iter
1793 * @returns the field type
1796 dbus_message_iter_get_array_type (DBusMessageIter *iter)
1798 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1801 dbus_message_iter_check (real);
1803 if (real->pos >= real->end)
1804 return DBUS_TYPE_INVALID;
1806 pos = dbus_message_iter_get_data_start (real, &type);
1808 _dbus_assert (type == DBUS_TYPE_ARRAY);
1810 return iter_get_array_type (real, NULL);
1815 * Returns the string value that an iterator may point to.
1816 * Note that you need to check that the iterator points to
1817 * a string value before using this function.
1819 * @see dbus_message_iter_get_arg_type
1820 * @param iter the message iter
1821 * @returns the string
1824 dbus_message_iter_get_string (DBusMessageIter *iter)
1826 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1829 dbus_message_iter_check (real);
1831 pos = dbus_message_iter_get_data_start (real, &type);
1833 _dbus_assert (type == DBUS_TYPE_STRING);
1835 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
1840 * Returns the name and data from a named type that an
1841 * iterator may point to. Note that you need to check that
1842 * the iterator points to a named type before using this
1845 * @see dbus_message_iter_get_arg_type
1846 * @param iter the message iter
1847 * @param name return location for the name
1848 * @param value return location for data
1849 * @param len return location for length of data
1850 * @returns TRUE if get succeed
1854 dbus_message_iter_get_named (DBusMessageIter *iter,
1856 unsigned char **value,
1859 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1863 dbus_message_iter_check (real);
1865 pos = dbus_message_iter_get_data_start (real, &type);
1867 _dbus_assert (type == DBUS_TYPE_NAMED);
1869 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
1875 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
1876 pos + 1, NULL, value, len))
1888 * Returns the byte value that an iterator may point to.
1889 * Note that you need to check that the iterator points to
1890 * a byte value before using this function.
1892 * @see dbus_message_iter_get_arg_type
1893 * @param iter the message iter
1894 * @returns the byte value
1897 dbus_message_iter_get_byte (DBusMessageIter *iter)
1899 unsigned char value;
1900 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1903 dbus_message_iter_check (real);
1905 pos = dbus_message_iter_get_data_start (real, &type);
1907 _dbus_assert (type == DBUS_TYPE_BYTE);
1909 value = _dbus_string_get_byte (&real->message->body, pos);
1916 * Returns the boolean value that an iterator may point to.
1917 * Note that you need to check that the iterator points to
1918 * a boolean value before using this function.
1920 * @see dbus_message_iter_get_arg_type
1921 * @param iter the message iter
1922 * @returns the boolean value
1925 dbus_message_iter_get_boolean (DBusMessageIter *iter)
1927 unsigned char value;
1928 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1931 dbus_message_iter_check (real);
1933 pos = dbus_message_iter_get_data_start (real, &type);
1935 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
1937 value = _dbus_string_get_byte (&real->message->body, pos);
1943 * Returns the 32 bit signed integer value that an iterator may point to.
1944 * Note that you need to check that the iterator points to
1945 * an integer value before using this function.
1947 * @see dbus_message_iter_get_arg_type
1948 * @param iter the message iter
1949 * @returns the integer
1952 dbus_message_iter_get_int32 (DBusMessageIter *iter)
1954 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1957 dbus_message_iter_check (real);
1959 pos = dbus_message_iter_get_data_start (real, &type);
1961 _dbus_assert (type == DBUS_TYPE_INT32);
1963 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
1968 * Returns the 32 bit unsigned integer value that an iterator may point to.
1969 * Note that you need to check that the iterator points to
1970 * an unsigned integer value before using this function.
1972 * @see dbus_message_iter_get_arg_type
1973 * @param iter the message iter
1974 * @returns the integer
1977 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
1979 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
1982 dbus_message_iter_check (real);
1984 pos = dbus_message_iter_get_data_start (real, &type);
1986 _dbus_assert (type == DBUS_TYPE_UINT32);
1988 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
1993 * Returns the double value that an iterator may point to.
1994 * Note that you need to check that the iterator points to
1995 * a string value before using this function.
1997 * @see dbus_message_iter_get_arg_type
1998 * @param iter the message iter
1999 * @returns the double
2002 dbus_message_iter_get_double (DBusMessageIter *iter)
2004 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2007 dbus_message_iter_check (real);
2009 pos = dbus_message_iter_get_data_start (real, &type);
2011 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2013 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2018 * Initializes an iterator for the array that the iterator
2019 * may point to. Note that you need to check that the iterator
2020 * points to an array prior to using this function.
2022 * The array element type is returned in array_type, and the array
2023 * iterator can only be used to get that type of data.
2025 * @param iter the iterator
2026 * @param array_iter pointer to an iterator to initialize
2027 * @param array_type gets set to the type of the array elements
2028 * @returns #TRUE on success
2031 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2032 DBusMessageIter *array_iter,
2035 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2036 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2037 int type, pos, len_pos, len, array_type_pos;
2040 dbus_message_iter_check (real);
2042 pos = dbus_message_iter_get_data_start (real, &type);
2044 _dbus_assert (type == DBUS_TYPE_ARRAY);
2046 _array_type = iter_get_array_type (real, &array_type_pos);
2048 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2049 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2052 array_real->parent_iter = real;
2053 array_real->message = real->message;
2054 array_real->changed_stamp = real->message->changed_stamp;
2056 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2057 array_real->pos = pos;
2058 array_real->end = pos + len;
2060 array_real->container_start = pos;
2061 array_real->container_length_pos = len_pos;
2062 array_real->wrote_dict_key = 0;
2063 array_real->array_type_pos = array_type_pos;
2064 array_real->array_type_done = TRUE;
2066 if (array_type != NULL)
2067 *array_type = _array_type;
2074 * Initializes an iterator for the dict that the iterator
2075 * may point to. Note that you need to check that the iterator
2076 * points to a dict prior to using this function.
2078 * @param iter the iterator
2079 * @param dict_iter pointer to an iterator to initialize
2080 * @returns #TRUE on success
2083 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2084 DBusMessageIter *dict_iter)
2086 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2087 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2088 int type, pos, len_pos, len;
2090 dbus_message_iter_check (real);
2092 pos = dbus_message_iter_get_data_start (real, &type);
2094 _dbus_assert (type == DBUS_TYPE_DICT);
2096 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2097 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2100 dict_real->parent_iter = real;
2101 dict_real->message = real->message;
2102 dict_real->changed_stamp = real->message->changed_stamp;
2104 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2105 dict_real->pos = pos;
2106 dict_real->end = pos + len;
2108 dict_real->container_start = pos;
2109 dict_real->container_length_pos = len_pos;
2110 dict_real->wrote_dict_key = 0;
2116 * Returns the byte array that the iterator may point to.
2117 * Note that you need to check that the iterator points
2118 * to a byte array prior to using this function.
2120 * @param iter the iterator
2121 * @param value return location for array values
2122 * @param len return location for length of byte array
2123 * @returns #TRUE on success
2126 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2127 unsigned char **value,
2130 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2133 dbus_message_iter_check (real);
2135 pos = dbus_message_iter_get_data_start (real, &type);
2137 _dbus_assert (type == DBUS_TYPE_ARRAY);
2139 type = iter_get_array_type (real, NULL);
2141 _dbus_assert (type == DBUS_TYPE_BYTE);
2143 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2144 pos, NULL, value, len))
2151 * Returns the boolean array that the iterator may point to. Note that
2152 * you need to check that the iterator points to an array of the
2153 * correct type prior to using this function.
2155 * @param iter the iterator
2156 * @param value return location for the array
2157 * @param len return location for the array length
2158 * @returns #TRUE on success
2161 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2162 unsigned char **value,
2165 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2168 dbus_message_iter_check (real);
2170 pos = dbus_message_iter_get_data_start (real, &type);
2172 _dbus_assert (type == DBUS_TYPE_ARRAY);
2174 type = iter_get_array_type (real, NULL);
2176 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2178 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2179 pos, NULL, value, len))
2186 * Returns the 32 bit signed integer array that the iterator may point
2187 * to. Note that you need to check that the iterator points to an
2188 * array of the correct type prior to using this function.
2190 * @param iter the iterator
2191 * @param value return location for the array
2192 * @param len return location for the array length
2193 * @returns #TRUE on success
2196 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2197 dbus_int32_t **value,
2200 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2203 dbus_message_iter_check (real);
2205 pos = dbus_message_iter_get_data_start (real, &type);
2207 _dbus_assert (type == DBUS_TYPE_ARRAY);
2209 type = iter_get_array_type (real, NULL);
2211 _dbus_assert (type == DBUS_TYPE_INT32);
2213 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2214 pos, NULL, value, len))
2221 * Returns the 32 bit unsigned integer array that the iterator may point
2222 * to. Note that you need to check that the iterator points to an
2223 * array of the correct type prior to using this function.
2225 * @param iter the iterator
2226 * @param value return location for the array
2227 * @param len return location for the array length
2228 * @returns #TRUE on success
2231 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2232 dbus_uint32_t **value,
2235 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2238 dbus_message_iter_check (real);
2240 pos = dbus_message_iter_get_data_start (real, &type);
2242 _dbus_assert (type == DBUS_TYPE_ARRAY);
2244 type = iter_get_array_type (real, NULL);
2245 _dbus_assert (type == DBUS_TYPE_UINT32);
2247 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2248 pos, NULL, value, len))
2255 * Returns the double array that the iterator may point to. Note that
2256 * you need to check that the iterator points to an array of the
2257 * correct type prior to using this function.
2259 * @param iter the iterator
2260 * @param value return location for the array
2261 * @param len return location for the array length
2262 * @returns #TRUE on success
2265 dbus_message_iter_get_double_array (DBusMessageIter *iter,
2269 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2272 dbus_message_iter_check (real);
2274 pos = dbus_message_iter_get_data_start (real, &type);
2276 _dbus_assert (type == DBUS_TYPE_ARRAY);
2278 type = iter_get_array_type (real, NULL);
2279 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2281 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
2282 pos, NULL, value, len))
2289 * Returns the string array that the iterator may point to.
2290 * Note that you need to check that the iterator points
2291 * to a byte array prior to using this function.
2293 * The returned value is a #NULL-terminated array of strings.
2294 * Each string is a separate malloc block, and the array
2295 * itself is a malloc block. You can free this type of
2296 * string array with dbus_free_string_array().
2298 * @param iter the iterator
2299 * @param value return location for string values
2300 * @param len return location for length of byte array
2301 * @returns #TRUE on success
2304 dbus_message_iter_get_string_array (DBusMessageIter *iter,
2308 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2311 dbus_message_iter_check (real);
2313 pos = dbus_message_iter_get_data_start (real, &type);
2315 _dbus_assert (type == DBUS_TYPE_ARRAY);
2317 type = iter_get_array_type (real, NULL);
2318 _dbus_assert (type == DBUS_TYPE_STRING);
2320 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
2321 pos, NULL, value, len))
2328 * Returns the key name fot the dict entry that an iterator
2329 * may point to. Note that you need to check that the iterator
2330 * points to a dict entry before using this function.
2332 * @see dbus_message_iter_init_dict_iterator
2333 * @param iter the message iter
2334 * @returns the key name
2337 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
2339 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2341 dbus_message_iter_check (real);
2343 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
2345 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2350 * Initializes a DBusMessageIter pointing to the end of the
2351 * message. This iterator can be used to append data to the
2354 * @param message the message
2355 * @param _iter pointer to an iterator to initialize
2358 dbus_message_append_iter_init (DBusMessage *message,
2359 DBusMessageIter *iter)
2361 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2363 real->message = message;
2364 real->parent_iter = NULL;
2365 real->changed_stamp = message->changed_stamp;
2367 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2368 real->end = _dbus_string_get_length (&real->message->body);
2369 real->pos = real->end;
2371 real->container_length_pos = 0;
2372 real->wrote_dict_key = 0;
2376 dbus_message_iter_append_check (DBusMessageRealIter *iter)
2378 _dbus_assert (!iter->message->locked);
2380 if (iter->changed_stamp != iter->message->changed_stamp)
2381 _dbus_warn ("dbus iterator check failed: invalid iterator");
2383 if (iter->pos != iter->end)
2384 _dbus_warn ("dbus iterator check failed: can only append at end of message");
2386 if (iter->pos != _dbus_string_get_length (&iter->message->body))
2387 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
2391 dbus_message_iter_append_type (DBusMessageRealIter *iter,
2397 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2398 if (!_dbus_string_append_byte (&iter->message->body, type))
2402 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2403 data = _dbus_string_get_const_data_len (&iter->message->body,
2404 iter->array_type_pos, 1);
2407 _dbus_warn ("Appended element of wrong type for array\n");
2412 case DBUS_MESSAGE_ITER_TYPE_DICT:
2413 if (!iter->wrote_dict_key)
2415 _dbus_warn ("Appending dict data before key name\n");
2419 if (!_dbus_string_append_byte (&iter->message->body, type))
2425 _dbus_assert_not_reached ("Invalid iter type");
2433 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
2435 iter->changed_stamp = iter->message->changed_stamp;
2437 /* Set new end of iter */
2438 iter->end = _dbus_string_get_length (&iter->message->body);
2439 iter->pos = iter->end;
2441 /* Set container length */
2442 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
2443 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
2444 _dbus_marshal_set_uint32 (&iter->message->body,
2445 iter->message->byte_order,
2446 iter->container_length_pos,
2447 iter->end - iter->container_start);
2449 if (iter->parent_iter)
2450 dbus_message_iter_update_after_change (iter->parent_iter);
2454 dbus_message_iter_append_done (DBusMessageRealIter *iter)
2456 iter->message->changed_stamp++;
2457 dbus_message_iter_update_after_change (iter);
2458 iter->wrote_dict_key = FALSE;
2462 * Appends a nil value to the message
2464 * @param iter an iterator pointing to the end of the message
2465 * @returns #TRUE on success
2468 dbus_message_iter_append_nil (DBusMessageIter *iter)
2470 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2472 dbus_message_iter_append_check (real);
2474 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
2477 dbus_message_iter_append_done (real);
2483 * Appends a boolean value to the message
2485 * @param iter an iterator pointing to the end of the message
2486 * @param value the boolean value
2487 * @returns #TRUE on success
2490 dbus_message_iter_append_boolean (DBusMessageIter *iter,
2493 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2495 dbus_message_iter_append_check (real);
2497 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
2500 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
2502 _dbus_string_set_length (&real->message->body, real->pos);
2506 dbus_message_iter_append_done (real);
2512 * Appends a byte to the message
2514 * @param iter an iterator pointing to the end of the message
2515 * @param value the byte value
2516 * @returns #TRUE on success
2519 dbus_message_iter_append_byte (DBusMessageIter *iter,
2520 unsigned char value)
2522 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2524 dbus_message_iter_append_check (real);
2526 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
2529 if (!_dbus_string_append_byte (&real->message->body, value))
2531 _dbus_string_set_length (&real->message->body, real->pos);
2535 dbus_message_iter_append_done (real);
2542 * Appends a 32 bit signed integer to the message.
2544 * @param iter an iterator pointing to the end of the message
2545 * @param value the integer value
2546 * @returns #TRUE on success
2549 dbus_message_iter_append_int32 (DBusMessageIter *iter,
2552 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2554 dbus_message_iter_append_check (real);
2556 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
2559 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
2561 _dbus_string_set_length (&real->message->body, real->pos);
2565 dbus_message_iter_append_done (real);
2571 * Appends a 32 bit unsigned integer to the message.
2573 * @param iter an iterator pointing to the end of the message
2574 * @param value the integer value
2575 * @returns #TRUE on success
2578 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
2579 dbus_uint32_t value)
2581 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2583 dbus_message_iter_append_check (real);
2585 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
2588 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
2590 _dbus_string_set_length (&real->message->body, real->pos);
2594 dbus_message_iter_append_done (real);
2600 * Appends a double value to the message.
2602 * @param iter an iterator pointing to the end of the message
2603 * @param value the double value
2604 * @returns #TRUE on success
2607 dbus_message_iter_append_double (DBusMessageIter *iter,
2610 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2612 dbus_message_iter_append_check (real);
2614 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
2617 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
2619 _dbus_string_set_length (&real->message->body, real->pos);
2623 dbus_message_iter_append_done (real);
2629 * Appends a UTF-8 string to the message.
2631 * @param iter an iterator pointing to the end of the message
2632 * @param value the string
2633 * @returns #TRUE on success
2636 dbus_message_iter_append_string (DBusMessageIter *iter,
2639 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2641 dbus_message_iter_append_check (real);
2643 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
2646 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
2648 _dbus_string_set_length (&real->message->body, real->pos);
2652 dbus_message_iter_append_done (real);
2658 * Appends a named type data chunk to the message.
2660 * @param iter an iterator pointing to the end of the message
2661 * @param name the name of the type
2663 * @returns #TRUE on success
2666 dbus_message_iter_append_named (DBusMessageIter *iter,
2668 const unsigned char *data,
2671 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2673 dbus_message_iter_append_check (real);
2675 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
2678 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
2680 _dbus_string_set_length (&real->message->body, real->pos);
2684 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
2686 _dbus_string_set_length (&real->message->body, real->pos);
2690 dbus_message_iter_append_done (real);
2697 * Appends a dict key name to the message. The iterator used
2698 * must point to a dict.
2700 * @param iter an iterator pointing to the end of the message
2701 * @param value the string
2702 * @returns #TRUE on success
2705 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
2708 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2710 dbus_message_iter_append_check (real);
2711 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
2713 if (real->wrote_dict_key)
2715 _dbus_warn ("Appendinging multiple dict key names\n");
2719 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
2724 dbus_message_iter_append_done (real);
2725 real->wrote_dict_key = TRUE;
2731 array_iter_type_mark_done (DBusMessageRealIter *iter)
2735 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
2736 array_iter_type_mark_done (iter->parent_iter);
2740 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
2741 sizeof (dbus_uint32_t));
2743 /* Empty length for now, backfill later */
2744 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
2746 _dbus_string_set_length (&iter->message->body, iter->pos);
2750 iter->container_start = _dbus_string_get_length (&iter->message->body);
2751 iter->container_length_pos = len_pos;
2752 iter->array_type_done = TRUE;
2758 append_array_type (DBusMessageRealIter *real,
2760 dbus_bool_t *array_type_done,
2761 int *array_type_pos)
2763 int existing_element_type;
2765 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
2768 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
2769 real->array_type_done)
2771 existing_element_type = iter_get_array_type (real, array_type_pos);
2772 if (existing_element_type != element_type)
2774 _dbus_warn ("Appending array of %d, when expecting array of %d\n",
2775 element_type, existing_element_type);
2776 _dbus_string_set_length (&real->message->body, real->pos);
2779 if (array_type_done != NULL)
2780 *array_type_done = TRUE;
2784 if (array_type_pos != NULL)
2785 *array_type_pos = _dbus_string_get_length (&real->message->body);
2787 /* Append element type */
2788 if (!_dbus_string_append_byte (&real->message->body, element_type))
2790 _dbus_string_set_length (&real->message->body, real->pos);
2794 if (array_type_done != NULL)
2795 *array_type_done = element_type != DBUS_TYPE_ARRAY;
2797 if (element_type != DBUS_TYPE_ARRAY &&
2798 !array_iter_type_mark_done (real))
2806 * Appends an array to the message and initializes an iterator that
2807 * can be used to append to the array.
2809 * @param iter an iterator pointing to the end of the message
2810 * @param array_iter pointer to an iter that will be initialized
2811 * @param element_type the type of the array elements
2812 * @returns #TRUE on success
2815 dbus_message_iter_append_array (DBusMessageIter *iter,
2816 DBusMessageIter *array_iter,
2819 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2820 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2823 dbus_bool_t array_type_done;
2825 if (element_type == DBUS_TYPE_NIL)
2827 _dbus_warn ("Can't create NIL arrays\n");
2831 dbus_message_iter_append_check (real);
2833 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
2836 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
2838 if (array_type_done)
2840 /* Empty length for now, backfill later */
2841 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
2843 _dbus_string_set_length (&real->message->body, real->pos);
2848 array_real->parent_iter = real;
2849 array_real->message = real->message;
2850 array_real->changed_stamp = real->message->changed_stamp;
2852 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2853 array_real->pos = _dbus_string_get_length (&real->message->body);
2854 array_real->end = array_real->end;
2856 array_real->container_start = array_real->pos;
2857 array_real->container_length_pos = len_pos;
2858 array_real->wrote_dict_key = 0;
2859 array_real->array_type_done = array_type_done;
2860 array_real->array_type_pos = array_type_pos;
2862 dbus_message_iter_append_done (array_real);
2868 * Appends a dict to the message and initializes an iterator that
2869 * can be used to append to the dict.
2871 * @param iter an iterator pointing to the end of the message
2872 * @param array_iter pointer to an iter that will be initialized
2873 * @param element_type the type of the array elements
2874 * @returns #TRUE on success
2877 dbus_message_iter_append_dict (DBusMessageIter *iter,
2878 DBusMessageIter *dict_iter)
2880 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2881 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2884 dbus_message_iter_append_check (real);
2886 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
2889 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
2891 /* Empty length for now, backfill later */
2892 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
2894 _dbus_string_set_length (&real->message->body, real->pos);
2898 dict_real->parent_iter = real;
2899 dict_real->message = real->message;
2900 dict_real->changed_stamp = real->message->changed_stamp;
2902 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2903 dict_real->pos = _dbus_string_get_length (&real->message->body);
2904 dict_real->end = dict_real->end;
2906 dict_real->container_start = dict_real->pos;
2907 dict_real->container_length_pos = len_pos;
2908 dict_real->wrote_dict_key = 0;
2910 dbus_message_iter_append_done (dict_real);
2917 * Appends a boolean array to the message.
2919 * @param iter an iterator pointing to the end of the message
2920 * @param value the array
2921 * @param len the length of the array
2922 * @returns #TRUE on success
2925 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
2926 unsigned const char *value,
2929 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2931 dbus_message_iter_append_check (real);
2933 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
2936 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
2938 _dbus_string_set_length (&real->message->body, real->pos);
2942 dbus_message_iter_append_done (real);
2948 * Appends a 32 bit signed integer array to the message.
2950 * @param iter an iterator pointing to the end of the message
2951 * @param value the array
2952 * @param len the length of the array
2953 * @returns #TRUE on success
2956 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
2957 const dbus_int32_t *value,
2960 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2962 dbus_message_iter_append_check (real);
2964 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
2967 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
2969 _dbus_string_set_length (&real->message->body, real->pos);
2973 dbus_message_iter_append_done (real);
2979 * Appends a 32 bit unsigned integer array to the message.
2981 * @param iter an iterator pointing to the end of the message
2982 * @param value the array
2983 * @param len the length of the array
2984 * @returns #TRUE on success
2987 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
2988 const dbus_uint32_t *value,
2991 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2993 dbus_message_iter_append_check (real);
2995 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
2998 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3000 _dbus_string_set_length (&real->message->body, real->pos);
3004 dbus_message_iter_append_done (real);
3010 * Appends a double array to the message.
3012 * @param iter an iterator pointing to the end of the message
3013 * @param value the array
3014 * @param len the length of the array
3015 * @returns #TRUE on success
3018 dbus_message_iter_append_double_array (DBusMessageIter *iter,
3019 const double *value,
3022 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3024 dbus_message_iter_append_check (real);
3026 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
3029 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
3031 _dbus_string_set_length (&real->message->body, real->pos);
3035 dbus_message_iter_append_done (real);
3041 * Appends a byte array to the message.
3043 * @param iter an iterator pointing to the end of the message
3044 * @param value the array
3045 * @param len the length of the array
3046 * @returns #TRUE on success
3049 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
3050 unsigned const char *value,
3053 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3055 dbus_message_iter_append_check (real);
3057 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
3060 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3062 _dbus_string_set_length (&real->message->body, real->pos);
3066 dbus_message_iter_append_done (real);
3072 * Appends a string array to the message.
3074 * @param iter an iterator pointing to the end of the message
3075 * @param value the array
3076 * @param len the length of the array
3077 * @returns #TRUE on success
3080 dbus_message_iter_append_string_array (DBusMessageIter *iter,
3084 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3086 dbus_message_iter_append_check (real);
3088 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
3091 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
3093 _dbus_string_set_length (&real->message->body, real->pos);
3097 dbus_message_iter_append_done (real);
3103 * Sets the message sender.
3105 * @param message the message
3106 * @param sender the sender
3107 * @returns #FALSE if not enough memory
3110 dbus_message_set_sender (DBusMessage *message,
3113 _dbus_assert (!message->locked);
3117 delete_string_field (message, FIELD_SENDER);
3122 return set_string_field (message,
3129 * Sets a flag indicating that the message is an error reply
3130 * message, i.e. an "exception" rather than a normal response.
3132 * @param message the message
3133 * @param is_error_reply #TRUE if this is an error message.
3136 dbus_message_set_is_error (DBusMessage *message,
3137 dbus_bool_t is_error_reply)
3141 _dbus_assert (!message->locked);
3143 header = _dbus_string_get_data_len (&message->header, 1, 1);
3146 *header |= DBUS_HEADER_FLAG_ERROR;
3148 *header &= ~DBUS_HEADER_FLAG_ERROR;
3152 * Returns #TRUE if the message is an error
3153 * reply to some previous message we sent.
3155 * @param message the message
3156 * @returns #TRUE if the message is an error
3159 dbus_message_get_is_error (DBusMessage *message)
3163 header = _dbus_string_get_const_data_len (&message->header, 1, 1);
3165 return (*header & DBUS_HEADER_FLAG_ERROR) != 0;
3169 * Gets the service which originated this message,
3170 * or #NULL if unknown or inapplicable.
3172 * @param message the message
3173 * @returns the service name or #NULL
3176 dbus_message_get_sender (DBusMessage *message)
3178 return get_string_field (message, FIELD_SENDER, NULL);
3182 * Checks whether the message has the given name.
3183 * If the message has no name or has a different
3184 * name, returns #FALSE.
3186 * @param message the message
3187 * @param name the name to check (must not be #NULL)
3189 * @returns #TRUE if the message has the given name
3192 dbus_message_name_is (DBusMessage *message,
3197 _dbus_assert (name != NULL);
3199 n = dbus_message_get_name (message);
3201 if (n && strcmp (n, name) == 0)
3208 * Checks whether the message was sent to the given service. If the
3209 * message has no service specified or has a different name, returns
3212 * @param message the message
3213 * @param service the service to check (must not be #NULL)
3215 * @returns #TRUE if the message has the given destination service
3218 dbus_message_service_is (DBusMessage *message,
3219 const char *service)
3223 _dbus_assert (service != NULL);
3225 s = dbus_message_get_service (message);
3227 if (s && strcmp (s, service) == 0)
3234 * Checks whether the message has the given service as its sender. If
3235 * the message has no sender specified or has a different sender,
3236 * returns #FALSE. Note that if a peer application owns multiple
3237 * services, its messages will have only one of those services as the
3238 * sender (usually the base service). So you can't use this
3239 * function to prove the sender didn't own service Foo, you can
3240 * only use it to prove that it did.
3242 * @param message the message
3243 * @param service the service to check (must not be #NULL)
3245 * @returns #TRUE if the message has the given origin service
3248 dbus_message_sender_is (DBusMessage *message,
3249 const char *service)
3253 _dbus_assert (service != NULL);
3255 s = dbus_message_get_sender (message);
3257 if (s && strcmp (s, service) == 0)
3264 * Sets a #DBusError based on the contents of the given
3265 * message. The error is only set if the message
3266 * is an error message, as in dbus_message_get_is_error().
3267 * The name of the error is set to the name of the message,
3268 * and the error message is set to the first argument
3269 * if the argument exists and is a string.
3271 * The return value indicates whether the error was set (the error is
3272 * set if and only if the message is an error message).
3273 * So you can check for an error reply and convert it to DBusError
3276 * @param error the error to set
3277 * @param message the message to set it from
3278 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
3281 dbus_set_error_from_message (DBusError *error,
3282 DBusMessage *message)
3286 if (!dbus_message_get_is_error (message))
3290 dbus_message_get_args (message, NULL,
3291 DBUS_TYPE_STRING, &str,
3294 dbus_set_error (error, dbus_message_get_name (message),
3295 str ? "%s" : NULL, str);
3305 * @addtogroup DBusMessageInternals
3310 * @typedef DBusMessageLoader
3312 * The DBusMessageLoader object encapsulates the process of converting
3313 * a byte stream into a series of DBusMessage. It buffers the incoming
3314 * bytes as efficiently as possible, and generates a queue of
3315 * messages. DBusMessageLoader is typically used as part of a
3316 * DBusTransport implementation. The DBusTransport then hands off
3317 * the loaded messages to a DBusConnection, making the messages
3318 * visible to the application.
3320 * @todo write tests for break-loader that a) randomly delete header
3321 * fields and b) set string fields to zero-length and other funky
3326 /* we definitely use signed ints for sizes, so don't exceed
3327 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
3328 * over 128M is pretty nuts anyhow.
3332 * The maximum sane message size.
3334 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
3337 * Implementation details of DBusMessageLoader.
3338 * All members are private.
3340 struct DBusMessageLoader
3342 int refcount; /**< Reference count. */
3344 DBusString data; /**< Buffered data */
3346 DBusList *messages; /**< Complete messages. */
3348 long max_message_size; /**< Maximum size of a message */
3350 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
3352 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
3356 * The initial buffer size of the message loader.
3358 * @todo this should be based on min header size plus some average
3359 * body size, or something. Or rather, the min header size only, if we
3360 * want to try to read only the header, store that in a DBusMessage,
3361 * then read only the body and store that, etc., depends on
3362 * how we optimize _dbus_message_loader_get_buffer() and what
3363 * the exact message format is.
3365 #define INITIAL_LOADER_DATA_LEN 32
3368 * Creates a new message loader. Returns #NULL if memory can't
3371 * @returns new loader, or #NULL.
3374 _dbus_message_loader_new (void)
3376 DBusMessageLoader *loader;
3378 loader = dbus_new0 (DBusMessageLoader, 1);
3382 loader->refcount = 1;
3384 /* Try to cap message size at something that won't *totally* hose
3385 * the system if we have a couple of them.
3387 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
3389 if (!_dbus_string_init (&loader->data))
3395 /* preallocate the buffer for speed, ignore failure */
3396 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
3397 _dbus_string_set_length (&loader->data, 0);
3403 * Increments the reference count of the loader.
3405 * @param loader the loader.
3408 _dbus_message_loader_ref (DBusMessageLoader *loader)
3410 loader->refcount += 1;
3414 * Decrements the reference count of the loader and finalizes the
3415 * loader when the count reaches zero.
3417 * @param loader the loader.
3420 _dbus_message_loader_unref (DBusMessageLoader *loader)
3422 loader->refcount -= 1;
3423 if (loader->refcount == 0)
3425 _dbus_list_foreach (&loader->messages,
3426 (DBusForeachFunction) dbus_message_unref,
3428 _dbus_list_clear (&loader->messages);
3429 _dbus_string_free (&loader->data);
3435 * Gets the buffer to use for reading data from the network. Network
3436 * data is read directly into an allocated buffer, which is then used
3437 * in the DBusMessage, to avoid as many extra memcpy's as possible.
3438 * The buffer must always be returned immediately using
3439 * _dbus_message_loader_return_buffer(), even if no bytes are
3440 * successfully read.
3442 * @todo this function can be a lot more clever. For example
3443 * it can probably always return a buffer size to read exactly
3444 * the body of the next message, thus avoiding any memory wastage
3447 * @todo we need to enforce a max length on strings in header fields.
3449 * @param loader the message loader.
3450 * @param buffer the buffer
3453 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
3454 DBusString **buffer)
3456 _dbus_assert (!loader->buffer_outstanding);
3458 *buffer = &loader->data;
3460 loader->buffer_outstanding = TRUE;
3464 * The smallest header size that can occur.
3465 * (It won't be valid)
3467 #define DBUS_MINIMUM_HEADER_SIZE 16
3469 /** Pack four characters as in "abcd" into a uint32 */
3470 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
3471 ((((dbus_uint32_t)a) << 24) | \
3472 (((dbus_uint32_t)b) << 16) | \
3473 (((dbus_uint32_t)c) << 8) | \
3476 /** DBUS_HEADER_FIELD_NAME packed into a dbus_uint32_t */
3477 #define DBUS_HEADER_FIELD_NAME_AS_UINT32 \
3478 FOUR_CHARS_TO_UINT32 ('n', 'a', 'm', 'e')
3480 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
3481 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
3482 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
3484 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
3485 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
3486 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
3488 /** DBUS_HEADER_FIELD_SENDER Packed into a dbus_uint32_t */
3489 #define DBUS_HEADER_FIELD_SENDER_AS_UINT32 \
3490 FOUR_CHARS_TO_UINT32 ('s', 'n', 'd', 'r')
3492 /* FIXME impose max length on name, srvc, sndr */
3494 decode_header_data (const DBusString *data,
3497 HeaderField fields[FIELD_LAST],
3498 int *message_padding)
3505 if (header_len < 16)
3509 while (i < FIELD_LAST)
3511 fields[i].offset = -1;
3515 fields[FIELD_HEADER_LENGTH].offset = 4;
3516 fields[FIELD_BODY_LENGTH].offset = 8;
3517 fields[FIELD_CLIENT_SERIAL].offset = 12;
3519 /* Now handle the named fields. A real named field is at least 4
3520 * bytes for the name, plus a type code (1 byte) plus padding. So
3521 * if we have less than 8 bytes left, it must be alignment padding,
3522 * not a field. While >= 8 bytes can't be entirely alignment
3526 while ((pos + 7) < header_len)
3528 pos = _DBUS_ALIGN_VALUE (pos, 4);
3530 if ((pos + 4) > header_len)
3533 field =_dbus_string_get_const_data_len (data, pos, 4);
3536 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
3538 switch (DBUS_UINT32_FROM_BE (*(int*)field))
3540 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
3541 if (fields[FIELD_SERVICE].offset >= 0)
3543 _dbus_verbose ("%s field provided twice\n",
3544 DBUS_HEADER_FIELD_SERVICE);
3548 fields[FIELD_SERVICE].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
3550 _dbus_verbose ("Found service name at offset %d\n",
3551 fields[FIELD_SERVICE].offset);
3555 case DBUS_HEADER_FIELD_NAME_AS_UINT32:
3556 if (fields[FIELD_NAME].offset >= 0)
3558 _dbus_verbose ("%s field provided twice\n",
3559 DBUS_HEADER_FIELD_NAME);
3563 fields[FIELD_NAME].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
3566 _dbus_verbose ("Found message name at offset %d\n",
3567 fields[FIELD_NAME].offset);
3570 case DBUS_HEADER_FIELD_SENDER_AS_UINT32:
3571 if (fields[FIELD_SENDER].offset >= 0)
3573 _dbus_verbose ("%s field provided twice\n",
3574 DBUS_HEADER_FIELD_SENDER);
3578 fields[FIELD_SENDER].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
3580 _dbus_verbose ("Found sender name at offset %d\n",
3581 fields[FIELD_NAME].offset);
3584 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
3585 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
3587 _dbus_verbose ("%s field provided twice\n",
3588 DBUS_HEADER_FIELD_REPLY);
3592 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos + 1, 4);
3594 _dbus_verbose ("Found reply serial at offset %d\n",
3595 fields[FIELD_REPLY_SERIAL].offset);
3599 _dbus_verbose ("Ignoring an unknown header field: %c%c%c%c at offset %d\n",
3600 field[0], field[1], field[2], field[3], pos);
3603 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
3605 _dbus_verbose ("Failed to validate type of named header field\n");
3609 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
3611 _dbus_verbose ("Failed to validate argument to named header field\n");
3615 if (new_pos > header_len)
3617 _dbus_verbose ("Named header field tries to extend beyond header length\n");
3624 if (pos < header_len)
3626 /* Alignment padding, verify that it's nul */
3627 _dbus_assert ((header_len - pos) < 8);
3629 if (!_dbus_string_validate_nul (data,
3630 pos, (header_len - pos)))
3632 _dbus_verbose ("header alignment padding is not nul\n");
3637 if (fields[FIELD_NAME].offset < 0)
3639 _dbus_verbose ("No %s field provided\n",
3640 DBUS_HEADER_FIELD_NAME);
3644 if (message_padding)
3645 *message_padding = header_len - pos;
3651 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
3652 * indicating to the loader how many bytes of the buffer were filled
3653 * in. This function must always be called, even if no bytes were
3654 * successfully read.
3656 * @param loader the loader.
3657 * @param buffer the buffer.
3658 * @param bytes_read number of bytes that were read into the buffer.
3661 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
3665 _dbus_assert (loader->buffer_outstanding);
3666 _dbus_assert (buffer == &loader->data);
3668 loader->buffer_outstanding = FALSE;
3672 * Converts buffered data into messages.
3674 * @param loader the loader.
3675 * @returns #TRUE if we had enough memory to finish.
3678 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
3680 if (loader->corrupted)
3683 while (_dbus_string_get_length (&loader->data) >= 16)
3685 DBusMessage *message;
3686 const char *header_data;
3687 int byte_order, header_len, body_len, header_padding;
3688 dbus_uint32_t header_len_unsigned, body_len_unsigned;
3690 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
3692 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
3694 if (header_data[2] != DBUS_MAJOR_PROTOCOL_VERSION)
3696 _dbus_verbose ("Message has protocol version %d ours is %d\n",
3697 (int) header_data[2], DBUS_MAJOR_PROTOCOL_VERSION);
3698 loader->corrupted = TRUE;
3702 byte_order = header_data[0];
3704 if (byte_order != DBUS_LITTLE_ENDIAN &&
3705 byte_order != DBUS_BIG_ENDIAN)
3707 _dbus_verbose ("Message with bad byte order '%c' received\n",
3709 loader->corrupted = TRUE;
3713 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
3714 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
3716 if (header_len_unsigned < 16)
3718 _dbus_verbose ("Message had broken too-small header length %u\n",
3719 header_len_unsigned);
3720 loader->corrupted = TRUE;
3724 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
3725 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
3727 _dbus_verbose ("Header or body length too large (%u %u)\n",
3728 header_len_unsigned,
3730 loader->corrupted = TRUE;
3734 /* Now that we know the values are in signed range, get
3735 * rid of stupid unsigned, just causes bugs
3737 header_len = header_len_unsigned;
3738 body_len = body_len_unsigned;
3740 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
3743 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
3745 loader->corrupted = TRUE;
3749 if (header_len + body_len > loader->max_message_size)
3751 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
3752 header_len, body_len, loader->max_message_size);
3753 loader->corrupted = TRUE;
3757 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
3759 HeaderField fields[FIELD_LAST];
3764 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
3766 if (!decode_header_data (&loader->data, header_len, byte_order,
3767 fields, &header_padding))
3769 _dbus_verbose ("Header was invalid\n");
3770 loader->corrupted = TRUE;
3774 next_arg = header_len;
3775 while (next_arg < (header_len + body_len))
3778 int prev = next_arg;
3780 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
3783 _dbus_verbose ("invalid typecode at offset %d\n", prev);
3784 loader->corrupted = TRUE;
3788 if (!_dbus_marshal_validate_arg (&loader->data,
3795 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
3796 loader->corrupted = TRUE;
3800 _dbus_assert (next_arg > prev);
3803 if (next_arg > (header_len + body_len))
3805 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
3806 next_arg, header_len, body_len,
3807 header_len + body_len);
3808 loader->corrupted = TRUE;
3812 message = dbus_message_new_empty_header ();
3813 if (message == NULL)
3815 _dbus_verbose ("Failed to allocate empty message\n");
3819 message->byte_order = byte_order;
3820 message->header_padding = header_padding;
3822 /* Copy in the offsets we found */
3824 while (i < FIELD_LAST)
3826 message->header_fields[i] = fields[i];
3830 if (!_dbus_list_append (&loader->messages, message))
3832 _dbus_verbose ("Failed to append new message to loader queue\n");
3833 dbus_message_unref (message);
3837 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
3838 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
3840 _dbus_assert (_dbus_string_get_length (&loader->data) >=
3841 (header_len + body_len));
3843 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
3845 _dbus_verbose ("Failed to move header into new message\n");
3846 _dbus_list_remove_last (&loader->messages, message);
3847 dbus_message_unref (message);
3851 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
3855 _dbus_verbose ("Failed to move body into new message\n");
3857 /* put the header back, we'll try again later */
3858 result = _dbus_string_copy_len (&message->header, 0, header_len,
3860 _dbus_assert (result); /* because DBusString never reallocs smaller */
3862 _dbus_list_remove_last (&loader->messages, message);
3863 dbus_message_unref (message);
3867 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
3868 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
3870 /* Fill in caches */
3871 message->reply_serial = get_int_field (message,
3872 FIELD_REPLY_SERIAL);
3873 message->client_serial = get_int_field (message,
3874 FIELD_CLIENT_SERIAL);
3876 _dbus_verbose ("Loaded message %p\n", message);
3886 * Peeks at first loaded message, returns #NULL if no messages have
3889 * @param loader the loader.
3890 * @returns the next message, or #NULL if none.
3893 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
3895 if (loader->messages)
3896 return loader->messages->data;
3902 * Pops a loaded message (passing ownership of the message
3903 * to the caller). Returns #NULL if no messages have been
3906 * @param loader the loader.
3907 * @returns the next message, or #NULL if none.
3910 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
3912 return _dbus_list_pop_first (&loader->messages);
3916 * Pops a loaded message inside a list link (passing ownership of the
3917 * message and link to the caller). Returns #NULL if no messages have
3920 * @param loader the loader.
3921 * @returns the next message link, or #NULL if none.
3924 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
3926 return _dbus_list_pop_first_link (&loader->messages);
3930 * Checks whether the loader is confused due to bad data.
3931 * If messages are received that are invalid, the
3932 * loader gets confused and gives up permanently.
3933 * This state is called "corrupted."
3935 * @param loader the loader
3936 * @returns #TRUE if the loader is hosed.
3939 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
3941 return loader->corrupted;
3945 * Sets the maximum size message we allow.
3947 * @param loader the loader
3948 * @param size the max message size in bytes
3951 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
3954 if (size > MAX_SANE_MESSAGE_SIZE)
3956 _dbus_verbose ("clamping requested max message size %ld to %d\n",
3957 size, MAX_SANE_MESSAGE_SIZE);
3958 size = MAX_SANE_MESSAGE_SIZE;
3960 loader->max_message_size = size;
3964 * Gets the maximum allowed message size in bytes.
3966 * @param loader the loader
3967 * @returns max size in bytes
3970 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
3972 return loader->max_message_size;
3976 #ifdef DBUS_BUILD_TESTS
3977 #include "dbus-test.h"
3981 message_iter_test (DBusMessage *message)
3983 DBusMessageIter iter, dict, array, array2;
3985 unsigned char *data;
3986 dbus_int32_t *our_int_array;
3989 dbus_message_iter_init (message, &iter);
3992 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
3993 _dbus_assert_not_reached ("Argument type isn't string");
3995 str = dbus_message_iter_get_string (&iter);
3996 if (strcmp (str, "Test string") != 0)
3997 _dbus_assert_not_reached ("Strings differ");
4000 if (!dbus_message_iter_next (&iter))
4001 _dbus_assert_not_reached ("Reached end of arguments");
4003 /* Signed integer tests */
4004 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
4005 _dbus_assert_not_reached ("Argument type isn't int32");
4007 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
4008 _dbus_assert_not_reached ("Signed integers differ");
4010 if (!dbus_message_iter_next (&iter))
4011 _dbus_assert_not_reached ("Reached end of fields");
4013 /* Unsigned integer tests */
4014 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
4015 _dbus_assert_not_reached ("Argument type isn't int32");
4017 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
4018 _dbus_assert_not_reached ("Unsigned integers differ");
4020 if (!dbus_message_iter_next (&iter))
4021 _dbus_assert_not_reached ("Reached end of arguments");
4024 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
4025 _dbus_assert_not_reached ("Argument type isn't double");
4027 if (dbus_message_iter_get_double (&iter) != 3.14159)
4028 _dbus_assert_not_reached ("Doubles differ");
4030 if (!dbus_message_iter_next (&iter))
4031 _dbus_assert_not_reached ("Reached end of arguments");
4033 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
4034 _dbus_assert_not_reached ("Argument type not an array");
4036 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
4037 _dbus_assert_not_reached ("Array type not double");
4040 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
4041 _dbus_assert_not_reached ("Array init failed");
4043 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4044 _dbus_assert_not_reached ("Argument type isn't double");
4046 if (dbus_message_iter_get_double (&array) != 1.5)
4047 _dbus_assert_not_reached ("Unsigned integers differ");
4049 if (!dbus_message_iter_next (&array))
4050 _dbus_assert_not_reached ("Reached end of arguments");
4052 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
4053 _dbus_assert_not_reached ("Argument type isn't double");
4055 if (dbus_message_iter_get_double (&array) != 2.5)
4056 _dbus_assert_not_reached ("Unsigned integers differ");
4058 if (dbus_message_iter_next (&array))
4059 _dbus_assert_not_reached ("Didn't reach end of arguments");
4061 if (!dbus_message_iter_next (&iter))
4062 _dbus_assert_not_reached ("Reached end of arguments");
4067 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
4068 _dbus_assert_not_reached ("not dict type");
4070 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
4071 _dbus_assert_not_reached ("dict iter failed");
4073 str = dbus_message_iter_get_dict_key (&dict);
4074 if (str == NULL || strcmp (str, "test") != 0)
4075 _dbus_assert_not_reached ("wrong dict key");
4078 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
4079 _dbus_assert_not_reached ("wrong dict entry type");
4081 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
4082 _dbus_assert_not_reached ("wrong dict entry value");
4084 if (!dbus_message_iter_next (&dict))
4085 _dbus_assert_not_reached ("reached end of dict");
4087 /* array of array of int32 (in dict) */
4089 str = dbus_message_iter_get_dict_key (&dict);
4090 if (str == NULL || strcmp (str, "array") != 0)
4091 _dbus_assert_not_reached ("wrong dict key");
4094 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
4095 _dbus_assert_not_reached ("Argument type not an array");
4097 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
4098 _dbus_assert_not_reached ("Array type not array");
4100 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
4101 _dbus_assert_not_reached ("Array init failed");
4103 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
4104 _dbus_assert_not_reached ("Argument type isn't array");
4106 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4107 _dbus_assert_not_reached ("Array type not int32");
4109 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
4110 _dbus_assert_not_reached ("Array init failed");
4112 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
4113 _dbus_assert_not_reached ("Argument type isn't int32");
4115 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
4116 _dbus_assert_not_reached ("Signed integers differ");
4118 if (!dbus_message_iter_next (&array2))
4119 _dbus_assert_not_reached ("Reached end of arguments");
4121 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
4122 _dbus_assert_not_reached ("Signed integers differ");
4124 if (dbus_message_iter_next (&array2))
4125 _dbus_assert_not_reached ("Didn't reached end of arguments");
4127 if (!dbus_message_iter_next (&array))
4128 _dbus_assert_not_reached ("Reached end of arguments");
4130 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
4131 _dbus_assert_not_reached ("Array type not int32");
4133 if (!dbus_message_iter_get_int32_array (&array,
4136 _dbus_assert_not_reached ("couldn't get int32 array");
4138 _dbus_assert (len == 3);
4139 _dbus_assert (our_int_array[0] == 0x34567812 &&
4140 our_int_array[1] == 0x45678123 &&
4141 our_int_array[2] == 0x56781234);
4142 dbus_free (our_int_array);
4144 if (dbus_message_iter_next (&array))
4145 _dbus_assert_not_reached ("Didn't reach end of array");
4147 if (dbus_message_iter_next (&dict))
4148 _dbus_assert_not_reached ("Didn't reach end of dict");
4150 if (!dbus_message_iter_next (&iter))
4151 _dbus_assert_not_reached ("Reached end of arguments");
4153 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
4155 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
4156 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
4159 if (dbus_message_iter_get_byte (&iter) != 0xF0)
4160 _dbus_assert_not_reached ("wrong value after dict");
4163 if (!dbus_message_iter_next (&iter))
4164 _dbus_assert_not_reached ("Reached end of arguments");
4166 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
4167 _dbus_assert_not_reached ("not a nil type");
4169 if (!dbus_message_iter_next (&iter))
4170 _dbus_assert_not_reached ("Reached end of arguments");
4172 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
4173 _dbus_assert_not_reached ("wrong type after dict");
4175 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
4176 _dbus_assert_not_reached ("failed to get named");
4178 _dbus_assert (strcmp (str, "named")==0);
4179 _dbus_assert (len == 5);
4180 _dbus_assert (strcmp (data, "data")==0);
4184 if (dbus_message_iter_next (&iter))
4185 _dbus_assert_not_reached ("Didn't reach end of arguments");
4190 check_message_handling_type (DBusMessageIter *iter,
4193 DBusMessageIter child_iter;
4199 case DBUS_TYPE_BYTE:
4200 dbus_message_iter_get_byte (iter);
4202 case DBUS_TYPE_BOOLEAN:
4203 dbus_message_iter_get_boolean (iter);
4205 case DBUS_TYPE_INT32:
4206 dbus_message_iter_get_int32 (iter);
4208 case DBUS_TYPE_UINT32:
4209 dbus_message_iter_get_uint32 (iter);
4211 case DBUS_TYPE_DOUBLE:
4212 dbus_message_iter_get_double (iter);
4214 case DBUS_TYPE_STRING:
4217 str = dbus_message_iter_get_string (iter);
4220 _dbus_warn ("NULL string in message\n");
4226 case DBUS_TYPE_NAMED:
4229 unsigned char *data;
4232 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
4234 _dbus_warn ("error reading name from named type\n");
4241 case DBUS_TYPE_ARRAY:
4245 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
4247 _dbus_warn ("Failed to init array iterator\n");
4251 while (dbus_message_iter_has_next (&child_iter))
4253 if (!check_message_handling_type (&child_iter, array_type))
4255 _dbus_warn ("error in array element\n");
4259 if (!dbus_message_iter_next (&child_iter))
4264 case DBUS_TYPE_DICT:
4269 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
4271 _dbus_warn ("Failed to init dict iterator\n");
4275 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
4277 key = dbus_message_iter_get_dict_key (&child_iter);
4280 _dbus_warn ("error reading dict key\n");
4285 if (!check_message_handling_type (&child_iter, entry_type))
4287 _dbus_warn ("error in dict value\n");
4291 if (!dbus_message_iter_next (&child_iter))
4298 _dbus_warn ("unknown type %d\n", type);
4307 check_message_handling (DBusMessage *message)
4309 DBusMessageIter iter;
4312 dbus_int32_t client_serial;
4316 client_serial = dbus_message_get_serial (message);
4318 /* can't use set_serial due to the assertions at the start of it */
4319 set_int_field (message, FIELD_CLIENT_SERIAL,
4322 if (client_serial != dbus_message_get_serial (message))
4324 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
4328 /* If we implement message_set_arg (message, n, value)
4329 * then we would want to test it here
4332 dbus_message_iter_init (message, &iter);
4333 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
4335 if (!check_message_handling_type (&iter, type))
4338 if (!dbus_message_iter_next (&iter))
4349 check_have_valid_message (DBusMessageLoader *loader)
4351 DBusMessage *message;
4357 if (!_dbus_message_loader_queue_messages (loader))
4358 _dbus_assert_not_reached ("no memory to queue messages");
4360 if (_dbus_message_loader_get_is_corrupted (loader))
4362 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
4366 message = _dbus_message_loader_pop_message (loader);
4367 if (message == NULL)
4369 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
4373 if (_dbus_string_get_length (&loader->data) > 0)
4375 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
4379 /* Verify that we're able to properly deal with the message.
4380 * For example, this would detect improper handling of messages
4381 * in nonstandard byte order.
4383 if (!check_message_handling (message))
4390 dbus_message_unref (message);
4396 check_invalid_message (DBusMessageLoader *loader)
4402 if (!_dbus_message_loader_queue_messages (loader))
4403 _dbus_assert_not_reached ("no memory to queue messages");
4405 if (!_dbus_message_loader_get_is_corrupted (loader))
4407 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
4418 check_incomplete_message (DBusMessageLoader *loader)
4420 DBusMessage *message;
4426 if (!_dbus_message_loader_queue_messages (loader))
4427 _dbus_assert_not_reached ("no memory to queue messages");
4429 if (_dbus_message_loader_get_is_corrupted (loader))
4431 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
4435 message = _dbus_message_loader_pop_message (loader);
4436 if (message != NULL)
4438 _dbus_warn ("loaded message that was expected to be incomplete\n");
4446 dbus_message_unref (message);
4451 check_loader_results (DBusMessageLoader *loader,
4452 DBusMessageValidity validity)
4454 if (!_dbus_message_loader_queue_messages (loader))
4455 _dbus_assert_not_reached ("no memory to queue messages");
4459 case _DBUS_MESSAGE_VALID:
4460 return check_have_valid_message (loader);
4461 case _DBUS_MESSAGE_INVALID:
4462 return check_invalid_message (loader);
4463 case _DBUS_MESSAGE_INCOMPLETE:
4464 return check_incomplete_message (loader);
4465 case _DBUS_MESSAGE_UNKNOWN:
4469 _dbus_assert_not_reached ("bad DBusMessageValidity");
4475 * Loads the message in the given message file.
4477 * @param filename filename to load
4478 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
4479 * @param data string to load message into
4480 * @returns #TRUE if the message was loaded
4483 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
4495 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
4496 dbus_error_init (&error);
4497 if (!_dbus_file_get_contents (data, filename, &error))
4499 _dbus_warn ("Could not load message file %s: %s\n",
4500 _dbus_string_get_const_data (filename),
4502 dbus_error_free (&error);
4508 if (!_dbus_message_data_load (data, filename))
4510 _dbus_warn ("Could not load message file %s\n",
4511 _dbus_string_get_const_data (filename));
4524 * Tries loading the message in the given message file
4525 * and verifies that DBusMessageLoader can handle it.
4527 * @param filename filename to load
4528 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
4529 * @param expected_validity what the message has to be like to return #TRUE
4530 * @returns #TRUE if the message has the expected validity
4533 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
4535 DBusMessageValidity expected_validity)
4542 if (!_dbus_string_init (&data))
4543 _dbus_assert_not_reached ("could not allocate string\n");
4545 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
4549 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
4555 if (_dbus_string_get_length (&data) > 0)
4556 _dbus_verbose_bytes_of_string (&data, 0,
4557 _dbus_string_get_length (&data));
4559 _dbus_warn ("Failed message loader test on %s\n",
4560 _dbus_string_get_const_data (filename));
4563 _dbus_string_free (&data);
4569 * Tries loading the given message data.
4572 * @param data the message data
4573 * @param expected_validity what the message has to be like to return #TRUE
4574 * @returns #TRUE if the message has the expected validity
4577 dbus_internal_do_not_use_try_message_data (const DBusString *data,
4578 DBusMessageValidity expected_validity)
4580 DBusMessageLoader *loader;
4588 /* Write the data one byte at a time */
4590 loader = _dbus_message_loader_new ();
4592 len = _dbus_string_get_length (data);
4593 for (i = 0; i < len; i++)
4597 _dbus_message_loader_get_buffer (loader, &buffer);
4598 _dbus_string_append_byte (buffer,
4599 _dbus_string_get_byte (data, i));
4600 _dbus_message_loader_return_buffer (loader, buffer, 1);
4603 if (!check_loader_results (loader, expected_validity))
4606 _dbus_message_loader_unref (loader);
4609 /* Write the data all at once */
4611 loader = _dbus_message_loader_new ();
4616 _dbus_message_loader_get_buffer (loader, &buffer);
4617 _dbus_string_copy (data, 0, buffer,
4618 _dbus_string_get_length (buffer));
4619 _dbus_message_loader_return_buffer (loader, buffer, 1);
4622 if (!check_loader_results (loader, expected_validity))
4625 _dbus_message_loader_unref (loader);
4628 /* Write the data 2 bytes at a time */
4630 loader = _dbus_message_loader_new ();
4632 len = _dbus_string_get_length (data);
4633 for (i = 0; i < len; i += 2)
4637 _dbus_message_loader_get_buffer (loader, &buffer);
4638 _dbus_string_append_byte (buffer,
4639 _dbus_string_get_byte (data, i));
4641 _dbus_string_append_byte (buffer,
4642 _dbus_string_get_byte (data, i+1));
4643 _dbus_message_loader_return_buffer (loader, buffer, 1);
4646 if (!check_loader_results (loader, expected_validity))
4649 _dbus_message_loader_unref (loader);
4657 _dbus_message_loader_unref (loader);
4663 process_test_subdir (const DBusString *test_base_dir,
4665 DBusMessageValidity validity,
4666 DBusForeachMessageFileFunc function,
4669 DBusString test_directory;
4670 DBusString filename;
4678 if (!_dbus_string_init (&test_directory))
4679 _dbus_assert_not_reached ("didn't allocate test_directory\n");
4681 _dbus_string_init_const (&filename, subdir);
4683 if (!_dbus_string_copy (test_base_dir, 0,
4684 &test_directory, 0))
4685 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
4687 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
4688 _dbus_assert_not_reached ("couldn't allocate full path");
4690 _dbus_string_free (&filename);
4691 if (!_dbus_string_init (&filename))
4692 _dbus_assert_not_reached ("didn't allocate filename string\n");
4694 dbus_error_init (&error);
4695 dir = _dbus_directory_open (&test_directory, &error);
4698 _dbus_warn ("Could not open %s: %s\n",
4699 _dbus_string_get_const_data (&test_directory),
4701 dbus_error_free (&error);
4705 printf ("Testing:\n");
4708 while (_dbus_directory_get_next_file (dir, &filename, &error))
4710 DBusString full_path;
4713 if (!_dbus_string_init (&full_path))
4714 _dbus_assert_not_reached ("couldn't init string");
4716 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
4717 _dbus_assert_not_reached ("couldn't copy dir to full_path");
4719 if (!_dbus_concat_dir_and_file (&full_path, &filename))
4720 _dbus_assert_not_reached ("couldn't concat file to dir");
4722 if (_dbus_string_ends_with_c_str (&filename, ".message"))
4724 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
4728 _dbus_verbose ("Skipping non-.message file %s\n",
4729 _dbus_string_get_const_data (&filename));
4730 _dbus_string_free (&full_path);
4735 _dbus_string_get_const_data (&filename));
4737 _dbus_verbose (" expecting %s\n",
4738 validity == _DBUS_MESSAGE_VALID ? "valid" :
4739 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
4740 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")));
4742 if (! (*function) (&full_path, is_raw, validity, user_data))
4744 _dbus_string_free (&full_path);
4748 _dbus_string_free (&full_path);
4751 if (dbus_error_is_set (&error))
4753 _dbus_warn ("Could not get next file in %s: %s\n",
4754 _dbus_string_get_const_data (&test_directory),
4756 dbus_error_free (&error);
4765 _dbus_directory_close (dir);
4766 _dbus_string_free (&test_directory);
4767 _dbus_string_free (&filename);
4773 * Runs the given function on every message file in the test suite.
4774 * The function should return #FALSE on test failure or fatal error.
4776 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
4777 * @param func the function to run
4778 * @param user_data data for function
4779 * @returns #FALSE if there's a failure
4782 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
4783 DBusForeachMessageFileFunc func,
4786 DBusString test_directory;
4791 _dbus_string_init_const (&test_directory, test_data_dir);
4793 if (!process_test_subdir (&test_directory, "valid-messages",
4794 _DBUS_MESSAGE_VALID, func, user_data))
4797 if (!process_test_subdir (&test_directory, "invalid-messages",
4798 _DBUS_MESSAGE_INVALID, func, user_data))
4801 if (!process_test_subdir (&test_directory, "incomplete-messages",
4802 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
4809 _dbus_string_free (&test_directory);
4815 verify_test_message (DBusMessage *message)
4817 dbus_int32_t our_int;
4820 dbus_bool_t our_bool;
4821 dbus_int32_t *our_int_array;
4822 dbus_uint32_t our_uint32;
4823 int our_int_array_len;
4824 DBusMessageIter iter, dict;
4827 dbus_message_iter_init (message, &iter);
4829 dbus_error_init (&error);
4830 if (!dbus_message_iter_get_args (&iter, &error,
4831 DBUS_TYPE_INT32, &our_int,
4832 DBUS_TYPE_STRING, &our_str,
4833 DBUS_TYPE_DOUBLE, &our_double,
4834 DBUS_TYPE_BOOLEAN, &our_bool,
4835 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, &our_int_array, &our_int_array_len,
4838 _dbus_verbose ("error: %s - %s\n", error.name, (error.message != NULL)?error.message: "no message");
4839 _dbus_assert_not_reached ("Could not get arguments");
4842 if (our_int != -0x12345678)
4843 _dbus_assert_not_reached ("integers differ!");
4845 if (our_double != 3.14159)
4846 _dbus_assert_not_reached ("doubles differ!");
4848 if (strcmp (our_str, "Test string") != 0)
4849 _dbus_assert_not_reached ("strings differ!");
4850 dbus_free (our_str);
4853 _dbus_assert_not_reached ("booleans differ");
4855 if (our_int_array_len != 4 ||
4856 our_int_array[0] != 0x12345678 ||
4857 our_int_array[1] != 0x23456781 ||
4858 our_int_array[2] != 0x34567812 ||
4859 our_int_array[3] != 0x45678123)
4860 _dbus_assert_not_reached ("array differ");
4861 dbus_free (our_int_array);
4863 if (!dbus_message_iter_next (&iter))
4864 _dbus_assert_not_reached ("Reached end of arguments");
4866 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
4867 _dbus_assert_not_reached ("not dict type");
4869 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
4870 _dbus_assert_not_reached ("dict iter failed");
4872 our_str = dbus_message_iter_get_dict_key (&dict);
4873 if (our_str == NULL || strcmp (our_str, "test") != 0)
4874 _dbus_assert_not_reached ("wrong dict key");
4875 dbus_free (our_str);
4877 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
4879 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
4880 _dbus_assert_not_reached ("wrong dict entry type");
4883 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
4885 _dbus_verbose ("dict entry val: %x\n", our_uint32);
4886 _dbus_assert_not_reached ("wrong dict entry value");
4889 if (dbus_message_iter_next (&dict))
4890 _dbus_assert_not_reached ("Didn't reach end of dict");
4892 if (!dbus_message_iter_next (&iter))
4893 _dbus_assert_not_reached ("Reached end of arguments");
4895 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
4896 _dbus_assert_not_reached ("wrong type after dict");
4898 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
4899 _dbus_assert_not_reached ("wrong value after dict");
4901 if (dbus_message_iter_next (&iter))
4902 _dbus_assert_not_reached ("Didn't reach end of arguments");
4906 * @ingroup DBusMessageInternals
4907 * Unit test for DBusMessage.
4909 * @returns #TRUE on success.
4912 _dbus_message_test (const char *test_data_dir)
4914 DBusMessage *message;
4915 DBusMessageLoader *loader;
4916 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
4922 const dbus_uint32_t our_int32_array[] = { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
4924 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
4926 /* Test the vararg functions */
4927 message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
4928 _dbus_message_set_serial (message, 1);
4929 dbus_message_append_args (message,
4930 DBUS_TYPE_INT32, -0x12345678,
4931 DBUS_TYPE_STRING, "Test string",
4932 DBUS_TYPE_DOUBLE, 3.14159,
4933 DBUS_TYPE_BOOLEAN, TRUE,
4934 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_int32_array, 4,
4937 dbus_message_append_iter_init (message, &iter);
4938 dbus_message_iter_append_dict (&iter, &child_iter);
4939 dbus_message_iter_append_dict_key (&child_iter, "test");
4940 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
4941 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
4943 _dbus_verbose_bytes_of_string (&message->header, 0,
4944 _dbus_string_get_length (&message->header));
4945 _dbus_verbose_bytes_of_string (&message->body, 0,
4946 _dbus_string_get_length (&message->body));
4948 verify_test_message (message);
4950 copy = dbus_message_copy (message);
4952 _dbus_assert (message->client_serial == copy->client_serial);
4953 _dbus_assert (message->reply_serial == copy->reply_serial);
4954 _dbus_assert (message->header_padding == copy->header_padding);
4956 _dbus_assert (_dbus_string_get_length (&message->header) ==
4957 _dbus_string_get_length (©->header));
4959 _dbus_assert (_dbus_string_get_length (&message->body) ==
4960 _dbus_string_get_length (©->body));
4962 verify_test_message (copy);
4964 name1 = dbus_message_get_name (message);
4965 name2 = dbus_message_get_name (copy);
4967 _dbus_assert (strcmp (name1, name2) == 0);
4969 dbus_message_unref (message);
4970 dbus_message_unref (copy);
4972 message = dbus_message_new ("org.freedesktop.DBus.Test", "testMessage");
4973 _dbus_message_set_serial (message, 1);
4974 dbus_message_set_reply_serial (message, 0x12345678);
4976 dbus_message_append_iter_init (message, &iter);
4977 dbus_message_iter_append_string (&iter, "Test string");
4978 dbus_message_iter_append_int32 (&iter, -0x12345678);
4979 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
4980 dbus_message_iter_append_double (&iter, 3.14159);
4982 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
4983 dbus_message_iter_append_double (&child_iter, 1.5);
4984 dbus_message_iter_append_double (&child_iter, 2.5);
4987 dbus_message_iter_append_dict (&iter, &child_iter);
4988 dbus_message_iter_append_dict_key (&child_iter, "test");
4989 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
4991 /* array of array of int32 (in dict) */
4992 dbus_message_iter_append_dict_key (&child_iter, "array");
4993 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
4994 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
4995 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
4996 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
4997 _dbus_warn ("next call expected to fail with wrong array type\n");
4998 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
4999 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
5000 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
5001 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
5002 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
5004 dbus_message_iter_append_byte (&iter, 0xF0);
5006 dbus_message_iter_append_nil (&iter);
5008 dbus_message_iter_append_named (&iter, "named",
5011 message_iter_test (message);
5013 /* Message loader test */
5014 _dbus_message_lock (message);
5015 loader = _dbus_message_loader_new ();
5017 /* Write the header data one byte at a time */
5018 data = _dbus_string_get_const_data (&message->header);
5019 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
5023 _dbus_message_loader_get_buffer (loader, &buffer);
5024 _dbus_string_append_byte (buffer, data[i]);
5025 _dbus_message_loader_return_buffer (loader, buffer, 1);
5028 /* Write the body data one byte at a time */
5029 data = _dbus_string_get_const_data (&message->body);
5030 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
5034 _dbus_message_loader_get_buffer (loader, &buffer);
5035 _dbus_string_append_byte (buffer, data[i]);
5036 _dbus_message_loader_return_buffer (loader, buffer, 1);
5039 dbus_message_unref (message);
5041 /* Now pop back the message */
5042 if (!_dbus_message_loader_queue_messages (loader))
5043 _dbus_assert_not_reached ("no memory to queue messages");
5045 if (_dbus_message_loader_get_is_corrupted (loader))
5046 _dbus_assert_not_reached ("message loader corrupted");
5048 message = _dbus_message_loader_pop_message (loader);
5050 _dbus_assert_not_reached ("received a NULL message");
5052 if (dbus_message_get_reply_serial (message) != 0x12345678)
5053 _dbus_assert_not_reached ("reply serial fields differ");
5055 message_iter_test (message);
5057 dbus_message_unref (message);
5058 _dbus_message_loader_unref (loader);
5060 /* Now load every message in test_data_dir if we have one */
5061 if (test_data_dir == NULL)
5064 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
5065 (DBusForeachMessageFileFunc)
5066 dbus_internal_do_not_use_try_message_file,
5070 #endif /* DBUS_BUILD_TESTS */