1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message.c DBusMessage object
4 * Copyright (C) 2002, 2003 Red Hat Inc.
5 * Copyright (C) 2002, 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "dbus-internals.h"
26 #include "dbus-marshal.h"
27 #include "dbus-message.h"
28 #include "dbus-message-internal.h"
29 #include "dbus-memory.h"
30 #include "dbus-list.h"
31 #include "dbus-message-builder.h"
32 #include "dbus-dataslot.h"
36 * @defgroup DBusMessageInternals DBusMessage implementation details
37 * @ingroup DBusInternals
38 * @brief DBusMessage private implementation details.
40 * The guts of DBusMessage and its methods.
61 static dbus_bool_t field_is_named[FIELD_LAST] =
63 FALSE, /* FIELD_HEADER_LENGTH */
64 FALSE, /* FIELD_BODY_LENGTH */
65 FALSE, /* FIELD_CLIENT_SERIAL */
66 TRUE, /* FIELD_PATH */
67 TRUE, /* FIELD_INTERFACE */
68 TRUE, /* FIELD_MEMBER */
69 TRUE, /* FIELD_ERROR_NAME */
70 TRUE, /* FIELD_SERVICE */
71 TRUE, /* FIELD_SENDER_SERVICE */
72 TRUE /* FIELD_REPLY_SERIAL */
77 int offset; /**< Offset to start of field (location of name of field
82 #define BYTE_ORDER_OFFSET 0
84 #define FLAGS_OFFSET 2
85 #define VERSION_OFFSET 3
88 * @brief Internals of DBusMessage
90 * Object representing a message received from or to be sent to
91 * another application. This is an opaque object, all members
96 DBusAtomic refcount; /**< Reference count */
98 DBusString header; /**< Header network data, stored
99 * separately from body so we can
100 * independently realloc it.
103 HeaderField header_fields[FIELD_LAST]; /**< Track the location
104 * of each field in "header"
107 dbus_uint32_t client_serial; /**< Cached client serial value for speed */
108 dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
110 int header_padding; /**< bytes of alignment in header */
112 DBusString body; /**< Body network data. */
114 char byte_order; /**< Message byte order. */
116 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
117 long size_counter_delta; /**< Size we incremented the size counters by. */
119 dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
121 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
123 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
127 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
128 DBUS_MESSAGE_ITER_TYPE_ARRAY,
129 DBUS_MESSAGE_ITER_TYPE_DICT
132 /** typedef for internals of message iterator */
133 typedef struct DBusMessageRealIter DBusMessageRealIter;
136 * @brief Internals of DBusMessageIter
138 * Object representing a position in a message. All fields are internal.
140 struct DBusMessageRealIter
142 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
143 DBusMessage *message; /**< Message used */
144 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
146 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
147 int type; /**< type of iter */
149 int pos; /**< Current position in the string */
150 int end; /**< position right after the container */
151 int container_start; /**< offset of the start of the container */
152 int container_length_pos; /**< offset of the length of the container */
154 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
156 int array_type_pos; /**< pointer to the position of the array element type */
157 int array_type_done; /**< TRUE if the array type is fully finished */
161 * Gets the data to be sent over the network for this message.
162 * The header and then the body should be written out.
163 * This function is guaranteed to always return the same
164 * data once a message is locked (with _dbus_message_lock()).
166 * @param message the message.
167 * @param header return location for message header data.
168 * @param body return location for message body data.
171 _dbus_message_get_network_data (DBusMessage *message,
172 const DBusString **header,
173 const DBusString **body)
175 _dbus_assert (message->locked);
177 *header = &message->header;
178 *body = &message->body;
182 clear_header_padding (DBusMessage *message)
184 _dbus_string_shorten (&message->header,
185 message->header_padding);
186 message->header_padding = 0;
190 append_header_padding (DBusMessage *message)
193 old_len = _dbus_string_get_length (&message->header);
194 if (!_dbus_string_align_length (&message->header, 8))
197 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
203 adjust_field_offsets (DBusMessage *message,
213 while (i < FIELD_LAST)
215 if (message->header_fields[i].offset > offsets_after)
216 message->header_fields[i].offset += delta;
222 #ifdef DBUS_BUILD_TESTS
223 /* tests-only until it's actually used */
225 get_int_field (DBusMessage *message,
230 _dbus_assert (field < FIELD_LAST);
232 offset = message->header_fields[field].offset;
235 return -1; /* useless if -1 is a valid value of course */
237 return _dbus_demarshal_int32 (&message->header,
245 get_uint_field (DBusMessage *message,
250 _dbus_assert (field < FIELD_LAST);
252 offset = message->header_fields[field].offset;
255 return -1; /* useless if -1 is a valid value of course */
257 return _dbus_demarshal_uint32 (&message->header,
264 get_string_field (DBusMessage *message,
271 offset = message->header_fields[field].offset;
273 _dbus_assert (field < FIELD_LAST);
278 /* offset points to string length, string data follows it */
279 /* FIXME _dbus_demarshal_const_string() that returned
280 * a reference to the string plus its len might be nice.
284 *len = _dbus_demarshal_uint32 (&message->header,
289 data = _dbus_string_get_const_data (&message->header);
291 return data + (offset + 4);
294 /* returns FALSE if no memory, TRUE with NULL path if no field */
296 get_path_field_decomposed (DBusMessage *message,
302 offset = message->header_fields[field].offset;
304 _dbus_assert (field < FIELD_LAST);
312 return _dbus_demarshal_object_path (&message->header,
319 #ifdef DBUS_BUILD_TESTS
321 append_int_field (DBusMessage *message,
328 _dbus_assert (!message->locked);
330 clear_header_padding (message);
332 orig_len = _dbus_string_get_length (&message->header);
334 if (!_dbus_string_align_length (&message->header, 4))
337 if (!_dbus_string_append_len (&message->header, name, 4))
340 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
343 if (!_dbus_string_align_length (&message->header, 4))
346 message->header_fields[field].offset =
347 _dbus_string_get_length (&message->header);
349 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
353 if (!append_header_padding (message))
359 message->header_fields[field].offset = -1;
360 _dbus_string_set_length (&message->header, orig_len);
362 /* this must succeed because it was allocated on function entry and
363 * DBusString doesn't ever realloc smaller
365 if (!append_header_padding (message))
366 _dbus_assert_not_reached ("failed to reappend header padding");
372 append_uint_field (DBusMessage *message,
379 _dbus_assert (!message->locked);
381 clear_header_padding (message);
383 orig_len = _dbus_string_get_length (&message->header);
385 if (!_dbus_string_align_length (&message->header, 4))
388 if (!_dbus_string_append_len (&message->header, name, 4))
391 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
394 if (!_dbus_string_align_length (&message->header, 4))
397 message->header_fields[field].offset =
398 _dbus_string_get_length (&message->header);
400 if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
404 if (!append_header_padding (message))
410 message->header_fields[field].offset = -1;
411 _dbus_string_set_length (&message->header, orig_len);
413 /* this must succeed because it was allocated on function entry and
414 * DBusString doesn't ever realloc smaller
416 if (!append_header_padding (message))
417 _dbus_assert_not_reached ("failed to reappend header padding");
422 append_string_field (DBusMessage *message,
430 _dbus_assert (!message->locked);
432 clear_header_padding (message);
434 orig_len = _dbus_string_get_length (&message->header);
436 if (!_dbus_string_align_length (&message->header, 4))
439 if (!_dbus_string_append_len (&message->header, name, 4))
442 if (!_dbus_string_append_byte (&message->header, type))
445 if (!_dbus_string_align_length (&message->header, 4))
448 message->header_fields[field].offset =
449 _dbus_string_get_length (&message->header);
451 if (!_dbus_marshal_string (&message->header, message->byte_order,
455 if (!append_header_padding (message))
461 message->header_fields[field].offset = -1;
462 _dbus_string_set_length (&message->header, orig_len);
464 /* this must succeed because it was allocated on function entry and
465 * DBusString doesn't ever realloc smaller
467 if (!append_header_padding (message))
468 _dbus_assert_not_reached ("failed to reappend header padding");
473 #ifdef DBUS_BUILD_TESTS
474 /* This isn't used, but building it when tests are enabled just to
475 * keep it compiling if we need it in future
478 delete_int_or_uint_field (DBusMessage *message,
481 int offset = message->header_fields[field].offset;
483 _dbus_assert (!message->locked);
484 _dbus_assert (field_is_named[field]);
489 clear_header_padding (message);
491 /* The field typecode and name take up 8 bytes */
492 _dbus_string_delete (&message->header,
496 message->header_fields[field].offset = -1;
498 adjust_field_offsets (message,
502 append_header_padding (message);
507 delete_string_field (DBusMessage *message,
510 int offset = message->header_fields[field].offset;
514 _dbus_assert (!message->locked);
515 _dbus_assert (field_is_named[field]);
520 clear_header_padding (message);
522 get_string_field (message, field, &len);
524 /* The field typecode and name take up 8 bytes, and the nul
525 * termination is 1 bytes, string length integer is 4 bytes
527 delete_len = 8 + 4 + 1 + len;
529 _dbus_string_delete (&message->header,
533 message->header_fields[field].offset = -1;
535 adjust_field_offsets (message,
539 append_header_padding (message);
542 #ifdef DBUS_BUILD_TESTS
544 set_int_field (DBusMessage *message,
548 int offset = message->header_fields[field].offset;
550 _dbus_assert (!message->locked);
554 /* need to append the field */
559 _dbus_assert_not_reached ("appending an int field we don't support appending");
565 _dbus_marshal_set_int32 (&message->header,
575 set_uint_field (DBusMessage *message,
579 int offset = message->header_fields[field].offset;
581 _dbus_assert (!message->locked);
585 /* need to append the field */
589 case FIELD_REPLY_SERIAL:
590 return append_uint_field (message, field,
591 DBUS_HEADER_FIELD_REPLY,
594 _dbus_assert_not_reached ("appending a uint field we don't support appending");
600 _dbus_marshal_set_uint32 (&message->header,
609 set_string_field (DBusMessage *message,
614 int offset = message->header_fields[field].offset;
616 _dbus_assert (!message->locked);
617 _dbus_assert (value != NULL);
621 /* need to append the field */
626 return append_string_field (message, field, type,
627 DBUS_HEADER_FIELD_PATH,
629 case FIELD_SENDER_SERVICE:
630 return append_string_field (message, field, type,
631 DBUS_HEADER_FIELD_SENDER_SERVICE,
633 case FIELD_INTERFACE:
634 return append_string_field (message, field, type,
635 DBUS_HEADER_FIELD_INTERFACE,
638 return append_string_field (message, field, type,
639 DBUS_HEADER_FIELD_MEMBER,
641 case FIELD_ERROR_NAME:
642 return append_string_field (message, field, type,
643 DBUS_HEADER_FIELD_ERROR_NAME,
646 return append_string_field (message, field, type,
647 DBUS_HEADER_FIELD_SERVICE,
650 _dbus_assert_not_reached ("appending a string field we don't support appending");
661 clear_header_padding (message);
663 old_len = _dbus_string_get_length (&message->header);
665 len = strlen (value);
667 _dbus_string_init_const_len (&v, value,
668 len + 1); /* include nul */
669 if (!_dbus_marshal_set_string (&message->header,
675 new_len = _dbus_string_get_length (&message->header);
677 adjust_field_offsets (message,
681 if (!append_header_padding (message))
687 /* this must succeed because it was allocated on function entry and
688 * DBusString doesn't ever realloc smaller
690 if (!append_header_padding (message))
691 _dbus_assert_not_reached ("failed to reappend header padding");
698 * Sets the serial number of a message.
699 * This can only be done once on a message.
701 * @param message the message
702 * @param serial the serial
705 _dbus_message_set_serial (DBusMessage *message,
708 _dbus_assert (!message->locked);
709 _dbus_assert (dbus_message_get_serial (message) == 0);
711 set_uint_field (message, FIELD_CLIENT_SERIAL,
713 message->client_serial = serial;
717 * Sets the reply serial of a message (the client serial
718 * of the message this is a reply to).
720 * @param message the message
721 * @param reply_serial the client serial
722 * @returns #FALSE if not enough memory
725 dbus_message_set_reply_serial (DBusMessage *message,
726 dbus_uint32_t reply_serial)
728 _dbus_assert (!message->locked);
730 if (set_uint_field (message, FIELD_REPLY_SERIAL,
733 message->reply_serial = reply_serial;
741 * Returns the serial of a message or -1 if none has been specified.
742 * The message's serial number is provided by the application sending
743 * the message and is used to identify replies to this message.
745 * @param message the message
746 * @returns the client serial
749 dbus_message_get_serial (DBusMessage *message)
751 return message->client_serial;
755 * Returns the serial that the message is
756 * a reply to or 0 if none.
758 * @param message the message
759 * @returns the reply serial
762 dbus_message_get_reply_serial (DBusMessage *message)
764 return message->reply_serial;
768 * Adds a counter to be incremented immediately with the
769 * size of this message, and decremented by the size
770 * of this message when this message if finalized.
771 * The link contains a counter with its refcount already
772 * incremented, but the counter itself not incremented.
773 * Ownership of link and counter refcount is passed to
776 * @param message the message
777 * @param link link with counter as data
780 _dbus_message_add_size_counter_link (DBusMessage *message,
783 /* right now we don't recompute the delta when message
784 * size changes, and that's OK for current purposes
785 * I think, but could be important to change later.
786 * Do recompute it whenever there are no outstanding counters,
787 * since it's basically free.
789 if (message->size_counters == NULL)
791 message->size_counter_delta =
792 _dbus_string_get_length (&message->header) +
793 _dbus_string_get_length (&message->body);
796 _dbus_verbose ("message has size %ld\n",
797 message->size_counter_delta);
801 _dbus_list_append_link (&message->size_counters, link);
803 _dbus_counter_adjust (link->data, message->size_counter_delta);
807 * Adds a counter to be incremented immediately with the
808 * size of this message, and decremented by the size
809 * of this message when this message if finalized.
811 * @param message the message
812 * @param counter the counter
813 * @returns #FALSE if no memory
816 _dbus_message_add_size_counter (DBusMessage *message,
817 DBusCounter *counter)
821 link = _dbus_list_alloc_link (counter);
825 _dbus_counter_ref (counter);
826 _dbus_message_add_size_counter_link (message, link);
832 * Removes a counter tracking the size of this message, and decrements
833 * the counter by the size of this message.
835 * @param message the message
836 * @param link_return return the link used
837 * @param counter the counter
840 _dbus_message_remove_size_counter (DBusMessage *message,
841 DBusCounter *counter,
842 DBusList **link_return)
846 link = _dbus_list_find_last (&message->size_counters,
848 _dbus_assert (link != NULL);
850 _dbus_list_unlink (&message->size_counters,
855 _dbus_list_free_link (link);
857 _dbus_counter_adjust (counter, message->size_counter_delta);
859 _dbus_counter_unref (counter);
863 dbus_message_create_header (DBusMessage *message,
867 const char *interface,
869 const char *error_name)
873 _dbus_assert ((interface && member) ||
875 !(interface || member || error_name));
877 if (!_dbus_string_append_byte (&message->header, message->byte_order))
880 if (!_dbus_string_append_byte (&message->header, type))
884 if (!_dbus_string_append_byte (&message->header, flags))
887 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
890 message->header_fields[FIELD_HEADER_LENGTH].offset = 4;
891 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
894 message->header_fields[FIELD_BODY_LENGTH].offset = 8;
895 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
898 message->header_fields[FIELD_CLIENT_SERIAL].offset = 12;
899 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
902 /* Marshal all the fields (Marshall Fields?) */
906 if (!append_string_field (message,
907 FIELD_PATH, DBUS_TYPE_OBJECT_PATH,
908 DBUS_HEADER_FIELD_PATH,
915 if (!append_string_field (message,
916 FIELD_SERVICE, DBUS_TYPE_STRING,
917 DBUS_HEADER_FIELD_SERVICE,
922 if (interface != NULL)
924 if (!append_string_field (message,
925 FIELD_INTERFACE, DBUS_TYPE_STRING,
926 DBUS_HEADER_FIELD_INTERFACE,
933 if (!append_string_field (message,
934 FIELD_MEMBER, DBUS_TYPE_STRING,
935 DBUS_HEADER_FIELD_MEMBER,
940 if (error_name != NULL)
942 if (!append_string_field (message,
943 FIELD_ERROR_NAME, DBUS_TYPE_STRING,
944 DBUS_HEADER_FIELD_ERROR_NAME,
953 * Locks a message. Allows checking that applications don't keep a
954 * reference to a message in the outgoing queue and change it
955 * underneath us. Messages are locked when they enter the outgoing
956 * queue (dbus_connection_send_message()), and the library complains
957 * if the message is modified while locked.
959 * @param message the message to lock.
962 _dbus_message_lock (DBusMessage *message)
964 if (!message->locked)
966 /* Fill in our lengths */
967 set_uint_field (message,
969 _dbus_string_get_length (&message->header));
971 set_uint_field (message,
973 _dbus_string_get_length (&message->body));
975 message->locked = TRUE;
982 * @defgroup DBusMessage DBusMessage
984 * @brief Message to be sent or received over a DBusConnection.
986 * A DBusMessage is the most basic unit of communication over a
987 * DBusConnection. A DBusConnection represents a stream of messages
988 * received from a remote application, and a stream of messages
989 * sent to a remote application.
995 * @typedef DBusMessage
997 * Opaque data type representing a message received from or to be
998 * sent to another application.
1002 dbus_message_new_empty_header (void)
1004 DBusMessage *message;
1007 message = dbus_new0 (DBusMessage, 1);
1008 if (message == NULL)
1011 message->refcount.value = 1;
1012 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
1013 message->client_serial = 0;
1014 message->reply_serial = 0;
1016 _dbus_data_slot_list_init (&message->slot_list);
1019 while (i < FIELD_LAST)
1021 message->header_fields[i].offset = -1;
1025 if (!_dbus_string_init_preallocated (&message->header, 64))
1027 dbus_free (message);
1031 if (!_dbus_string_init_preallocated (&message->body, 64))
1033 _dbus_string_free (&message->header);
1034 dbus_free (message);
1042 * Constructs a new message of the given message type.
1043 * Types include #DBUS_MESSAGE_TYPE_METHOD_CALL,
1044 * #DBUS_MESSAGE_TYPE_SIGNAL, and so forth.
1046 * @param message_type type of message
1047 * @returns new message or #NULL If no memory
1050 dbus_message_new (int message_type)
1052 DBusMessage *message;
1054 _dbus_return_val_if_fail (message_type != DBUS_MESSAGE_TYPE_INVALID, NULL);
1056 message = dbus_message_new_empty_header ();
1057 if (message == NULL)
1060 if (!dbus_message_create_header (message,
1062 NULL, NULL, NULL, NULL, NULL))
1064 dbus_message_unref (message);
1072 * Constructs a new message to invoke a method on a remote
1073 * object. Returns #NULL if memory can't be allocated for the
1074 * message. The service may be #NULL in which case no service is set;
1075 * this is appropriate when using D-BUS in a peer-to-peer context (no
1076 * message bus). The interface may be #NULL, which means that
1077 * if multiple methods with the given name exist it is undefined
1078 * which one will be invoked.
1080 * @param service service that the message should be sent to or #NULL
1081 * @param path object path the message should be sent to
1082 * @param interface interface to invoke method on
1083 * @param method method to invoke
1085 * @returns a new DBusMessage, free with dbus_message_unref()
1086 * @see dbus_message_unref()
1089 dbus_message_new_method_call (const char *service,
1091 const char *interface,
1094 DBusMessage *message;
1096 _dbus_return_val_if_fail (path != NULL, NULL);
1097 _dbus_return_val_if_fail (method != NULL, NULL);
1099 message = dbus_message_new_empty_header ();
1100 if (message == NULL)
1103 if (!dbus_message_create_header (message,
1104 DBUS_MESSAGE_TYPE_METHOD_CALL,
1105 service, path, interface, method, NULL))
1107 dbus_message_unref (message);
1115 * Constructs a message that is a reply to a method call. Returns
1116 * #NULL if memory can't be allocated for the message.
1118 * @param method_call the message which the created
1119 * message is a reply to.
1120 * @returns a new DBusMessage, free with dbus_message_unref()
1121 * @see dbus_message_new_method_call(), dbus_message_unref()
1124 dbus_message_new_method_return (DBusMessage *method_call)
1126 DBusMessage *message;
1129 _dbus_return_val_if_fail (method_call != NULL, NULL);
1131 sender = get_string_field (method_call,
1132 FIELD_SENDER_SERVICE, NULL);
1134 /* sender is allowed to be null here in peer-to-peer case */
1136 message = dbus_message_new_empty_header ();
1137 if (message == NULL)
1140 if (!dbus_message_create_header (message,
1141 DBUS_MESSAGE_TYPE_METHOD_RETURN,
1142 sender, NULL, NULL, NULL, NULL))
1144 dbus_message_unref (message);
1148 if (!dbus_message_set_reply_serial (message,
1149 dbus_message_get_serial (method_call)))
1151 dbus_message_unref (message);
1159 * Constructs a new message representing a signal emission. Returns
1160 * #NULL if memory can't be allocated for the message.
1161 * A signal is identified by its originating interface, and
1162 * the name of the signal.
1164 * @param interface the interface the signal is emitted from
1165 * @param name name of the signal
1166 * @returns a new DBusMessage, free with dbus_message_unref()
1167 * @see dbus_message_unref()
1170 dbus_message_new_signal (const char *path,
1171 const char *interface,
1174 DBusMessage *message;
1176 _dbus_return_val_if_fail (path != NULL, NULL);
1177 _dbus_return_val_if_fail (interface != NULL, NULL);
1178 _dbus_return_val_if_fail (name != NULL, NULL);
1180 message = dbus_message_new_empty_header ();
1181 if (message == NULL)
1184 if (!dbus_message_create_header (message,
1185 DBUS_MESSAGE_TYPE_SIGNAL,
1186 NULL, path, interface, name, NULL))
1188 dbus_message_unref (message);
1196 * Creates a new message that is an error reply to a certain message.
1197 * Error replies are possible in response to method calls primarily.
1199 * @param reply_to the original message
1200 * @param error_name the error name
1201 * @param error_message the error message string or #NULL for none
1202 * @returns a new error message
1205 dbus_message_new_error (DBusMessage *reply_to,
1206 const char *error_name,
1207 const char *error_message)
1209 DBusMessage *message;
1211 DBusMessageIter iter;
1213 _dbus_return_val_if_fail (reply_to != NULL, NULL);
1214 _dbus_return_val_if_fail (error_name != NULL, NULL);
1216 sender = get_string_field (reply_to,
1217 FIELD_SENDER_SERVICE, NULL);
1219 /* sender may be NULL for non-message-bus case or
1220 * when the message bus is dealing with an unregistered
1223 message = dbus_message_new_empty_header ();
1224 if (message == NULL)
1227 if (!dbus_message_create_header (message,
1228 DBUS_MESSAGE_TYPE_ERROR,
1229 sender, NULL, NULL, NULL, error_name))
1231 dbus_message_unref (message);
1235 if (!dbus_message_set_reply_serial (message,
1236 dbus_message_get_serial (reply_to)))
1238 dbus_message_unref (message);
1242 if (error_message != NULL)
1244 dbus_message_append_iter_init (message, &iter);
1245 if (!dbus_message_iter_append_string (&iter, error_message))
1247 dbus_message_unref (message);
1256 * Creates a new message that is an exact replica of the message
1257 * specified, except that its refcount is set to 1.
1259 * @param message the message.
1260 * @returns the new message.
1263 dbus_message_copy (const DBusMessage *message)
1265 DBusMessage *retval;
1268 _dbus_return_val_if_fail (message != NULL, NULL);
1270 retval = dbus_new0 (DBusMessage, 1);
1274 retval->refcount.value = 1;
1275 retval->byte_order = message->byte_order;
1276 retval->client_serial = message->client_serial;
1277 retval->reply_serial = message->reply_serial;
1278 retval->header_padding = message->header_padding;
1279 retval->locked = FALSE;
1281 if (!_dbus_string_init (&retval->header))
1287 if (!_dbus_string_init (&retval->body))
1289 _dbus_string_free (&retval->header);
1294 if (!_dbus_string_copy (&message->header, 0,
1295 &retval->header, 0))
1297 _dbus_string_free (&retval->header);
1298 _dbus_string_free (&retval->body);
1304 if (!_dbus_string_copy (&message->body, 0,
1307 _dbus_string_free (&retval->header);
1308 _dbus_string_free (&retval->body);
1314 for (i = 0; i < FIELD_LAST; i++)
1316 retval->header_fields[i].offset = message->header_fields[i].offset;
1324 * Increments the reference count of a DBusMessage.
1326 * @param message The message
1327 * @see dbus_message_unref
1330 dbus_message_ref (DBusMessage *message)
1332 dbus_int32_t old_refcount;
1334 _dbus_return_if_fail (message != NULL);
1336 old_refcount = _dbus_atomic_inc (&message->refcount);
1337 _dbus_assert (old_refcount >= 1);
1341 free_size_counter (void *element,
1344 DBusCounter *counter = element;
1345 DBusMessage *message = data;
1347 _dbus_counter_adjust (counter, - message->size_counter_delta);
1349 _dbus_counter_unref (counter);
1353 * Decrements the reference count of a DBusMessage.
1355 * @param message The message
1356 * @see dbus_message_ref
1359 dbus_message_unref (DBusMessage *message)
1361 dbus_int32_t old_refcount;
1363 _dbus_return_if_fail (message != NULL);
1365 old_refcount = _dbus_atomic_dec (&message->refcount);
1367 _dbus_assert (old_refcount >= 0);
1369 if (old_refcount == 1)
1371 /* This calls application callbacks! */
1372 _dbus_data_slot_list_free (&message->slot_list);
1374 _dbus_list_foreach (&message->size_counters,
1375 free_size_counter, message);
1376 _dbus_list_clear (&message->size_counters);
1378 _dbus_string_free (&message->header);
1379 _dbus_string_free (&message->body);
1381 dbus_free (message);
1386 * Gets the type of a message. Types include
1387 * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN,
1388 * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types
1389 * are allowed and all code must silently ignore messages of unknown
1390 * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however.
1393 * @param message the message
1394 * @returns the type of the message
1397 dbus_message_get_type (DBusMessage *message)
1401 type = _dbus_string_get_byte (&message->header, 1);
1402 _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID);
1408 * Sets the object path this message is being sent to (for
1409 * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being
1410 * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL).
1412 * @param message the message
1413 * @param object_path the path
1414 * @returns #FALSE if not enough memory
1417 dbus_message_set_path (DBusMessage *message,
1418 const char *object_path)
1420 _dbus_return_val_if_fail (message != NULL, FALSE);
1421 _dbus_return_val_if_fail (!message->locked, FALSE);
1423 if (object_path == NULL)
1425 delete_string_field (message, FIELD_PATH);
1430 return set_string_field (message,
1432 DBUS_TYPE_OBJECT_PATH,
1438 * Gets the object path this message is being sent to
1439 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1440 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1442 * @param message the message
1443 * @returns the path (should not be freed)
1446 dbus_message_get_path (DBusMessage *message)
1448 _dbus_return_val_if_fail (message != NULL, NULL);
1450 return get_string_field (message, FIELD_PATH, NULL);
1454 * Gets the object path this message is being sent to
1455 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1456 * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed
1457 * format (one array element per path component).
1458 * Free the returned array with dbus_free_string_array().
1460 * An empty but non-NULL path array means the path "/".
1461 * So the path "/foo/bar" becomes { "foo", "bar", NULL }
1462 * and the path "/" becomes { NULL }.
1464 * @param message the message
1465 * @param path place to store allocated array of path components; #NULL set here if no path field exists
1466 * @returns #FALSE if no memory to allocate the array
1469 dbus_message_get_path_decomposed (DBusMessage *message,
1472 _dbus_return_val_if_fail (message != NULL, FALSE);
1473 _dbus_return_val_if_fail (path != NULL, FALSE);
1475 return get_path_field_decomposed (message, FIELD_PATH,
1480 * Sets the interface this message is being sent to
1481 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or
1482 * the interface a signal is being emitted from
1483 * (for DBUS_MESSAGE_TYPE_SIGNAL).
1485 * @param message the message
1486 * @param interface the interface
1487 * @returns #FALSE if not enough memory
1490 dbus_message_set_interface (DBusMessage *message,
1491 const char *interface)
1493 _dbus_return_val_if_fail (message != NULL, FALSE);
1494 _dbus_return_val_if_fail (!message->locked, FALSE);
1496 if (interface == NULL)
1498 delete_string_field (message, FIELD_INTERFACE);
1503 return set_string_field (message,
1511 * Gets the interface this message is being sent to
1512 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1513 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1514 * The interface name is fully-qualified (namespaced).
1516 * @param message the message
1517 * @returns the message interface (should not be freed)
1520 dbus_message_get_interface (DBusMessage *message)
1522 _dbus_return_val_if_fail (message != NULL, NULL);
1524 return get_string_field (message, FIELD_INTERFACE, NULL);
1528 * Sets the interface member being invoked
1529 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1530 * (DBUS_MESSAGE_TYPE_SIGNAL).
1531 * The interface name is fully-qualified (namespaced).
1533 * @param message the message
1534 * @param member the member
1535 * @returns #FALSE if not enough memory
1538 dbus_message_set_member (DBusMessage *message,
1541 _dbus_return_val_if_fail (message != NULL, FALSE);
1542 _dbus_return_val_if_fail (!message->locked, FALSE);
1546 delete_string_field (message, FIELD_MEMBER);
1551 return set_string_field (message,
1559 * Gets the interface member being invoked
1560 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1561 * (DBUS_MESSAGE_TYPE_SIGNAL).
1563 * @param message the message
1564 * @returns the member name (should not be freed)
1567 dbus_message_get_member (DBusMessage *message)
1569 _dbus_return_val_if_fail (message != NULL, NULL);
1571 return get_string_field (message, FIELD_MEMBER, NULL);
1575 * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
1576 * The name is fully-qualified (namespaced).
1578 * @param message the message
1579 * @param name the name
1580 * @returns #FALSE if not enough memory
1583 dbus_message_set_error_name (DBusMessage *message,
1584 const char *error_name)
1586 _dbus_return_val_if_fail (message != NULL, FALSE);
1587 _dbus_return_val_if_fail (!message->locked, FALSE);
1589 if (error_name == NULL)
1591 delete_string_field (message, FIELD_ERROR_NAME);
1596 return set_string_field (message,
1604 * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only).
1606 * @param message the message
1607 * @returns the error name (should not be freed)
1610 dbus_message_get_error_name (DBusMessage *message)
1612 _dbus_return_val_if_fail (message != NULL, NULL);
1614 return get_string_field (message, FIELD_ERROR_NAME, NULL);
1618 * Sets the message's destination service.
1620 * @param message the message
1621 * @param destination the destination service name
1622 * @returns #FALSE if not enough memory
1625 dbus_message_set_destination (DBusMessage *message,
1626 const char *destination)
1628 _dbus_return_val_if_fail (message != NULL, FALSE);
1629 _dbus_return_val_if_fail (!message->locked, FALSE);
1631 if (destination == NULL)
1633 delete_string_field (message, FIELD_SERVICE);
1638 return set_string_field (message,
1646 * Gets the destination service of a message.
1648 * @param message the message
1649 * @returns the message destination service (should not be freed)
1652 dbus_message_get_destination (DBusMessage *message)
1654 _dbus_return_val_if_fail (message != NULL, NULL);
1656 return get_string_field (message, FIELD_SERVICE, NULL);
1660 * Appends fields to a message given a variable argument list. The
1661 * variable argument list should contain the type of the argument
1662 * followed by the value to add. Array values are specified by an int
1663 * typecode followed by a pointer to the array followed by an int
1664 * giving the length of the array. The argument list must be
1665 * terminated with #DBUS_TYPE_INVALID.
1667 * This function doesn't support dicts or non-fundamental arrays.
1669 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1670 * only if #DBUS_HAVE_INT64 is defined.
1672 * @param message the message
1673 * @param first_arg_type type of the first argument
1674 * @param ... value of first argument, list of additional type-value pairs
1675 * @returns #TRUE on success
1678 dbus_message_append_args (DBusMessage *message,
1685 _dbus_return_val_if_fail (message != NULL, FALSE);
1687 va_start (var_args, first_arg_type);
1688 retval = dbus_message_append_args_valist (message,
1697 * This function takes a va_list for use by language bindings.
1698 * It's otherwise the same as dbus_message_append_args().
1700 * @todo: Shouldn't this function clean up the changes to the message
1701 * on failures? (Yes)
1703 * @see dbus_message_append_args.
1704 * @param message the message
1705 * @param first_arg_type type of first argument
1706 * @param var_args value of first argument, then list of type/value pairs
1707 * @returns #TRUE on success
1710 dbus_message_append_args_valist (DBusMessage *message,
1715 DBusMessageIter iter;
1717 _dbus_return_val_if_fail (message != NULL, FALSE);
1719 old_len = _dbus_string_get_length (&message->body);
1721 type = first_arg_type;
1723 dbus_message_append_iter_init (message, &iter);
1730 if (!dbus_message_iter_append_nil (&iter))
1733 case DBUS_TYPE_BOOLEAN:
1734 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1737 case DBUS_TYPE_INT32:
1738 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1741 case DBUS_TYPE_UINT32:
1742 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1745 #ifdef DBUS_HAVE_INT64
1746 case DBUS_TYPE_INT64:
1747 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1750 case DBUS_TYPE_UINT64:
1751 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1754 #endif /* DBUS_HAVE_INT64 */
1755 case DBUS_TYPE_DOUBLE:
1756 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1759 case DBUS_TYPE_STRING:
1760 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1763 case DBUS_TYPE_NAMED:
1766 unsigned char *data;
1769 name = va_arg (var_args, const char *);
1770 data = va_arg (var_args, unsigned char *);
1771 len = va_arg (var_args, int);
1773 if (!dbus_message_iter_append_named (&iter, name, data, len))
1777 case DBUS_TYPE_ARRAY:
1782 type = va_arg (var_args, int);
1783 data = va_arg (var_args, void *);
1784 len = va_arg (var_args, int);
1788 case DBUS_TYPE_BYTE:
1789 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1792 case DBUS_TYPE_BOOLEAN:
1793 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1796 case DBUS_TYPE_INT32:
1797 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1800 case DBUS_TYPE_UINT32:
1801 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1804 #ifdef DBUS_HAVE_INT64
1805 case DBUS_TYPE_INT64:
1806 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1809 case DBUS_TYPE_UINT64:
1810 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1813 #endif /* DBUS_HAVE_INT64 */
1814 case DBUS_TYPE_DOUBLE:
1815 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1818 case DBUS_TYPE_STRING:
1819 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1823 case DBUS_TYPE_ARRAY:
1824 case DBUS_TYPE_NAMED:
1825 case DBUS_TYPE_DICT:
1826 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1829 _dbus_warn ("Unknown field type %d\n", type);
1835 case DBUS_TYPE_DICT:
1836 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1839 _dbus_warn ("Unknown field type %d\n", type);
1843 type = va_arg (var_args, int);
1854 * Gets arguments from a message given a variable argument list.
1855 * The variable argument list should contain the type of the
1856 * argumen followed by a pointer to where the value should be
1857 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1859 * @param message the message
1860 * @param error error to be filled in on failure
1861 * @param first_arg_type the first argument type
1862 * @param ... location for first argument value, then list of type-location pairs
1863 * @returns #FALSE if the error was set
1866 dbus_message_get_args (DBusMessage *message,
1874 _dbus_return_val_if_fail (message != NULL, FALSE);
1875 _dbus_return_val_if_error_is_set (error, FALSE);
1877 va_start (var_args, first_arg_type);
1878 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1885 * This function takes a va_list for use by language bindings
1887 * @todo We need to free the argument data when an error occurs.
1889 * @see dbus_message_get_args
1890 * @param message the message
1891 * @param error error to be filled in
1892 * @param first_arg_type type of the first argument
1893 * @param var_args return location for first argument, followed by list of type/location pairs
1894 * @returns #FALSE if error was set
1897 dbus_message_get_args_valist (DBusMessage *message,
1902 DBusMessageIter iter;
1904 _dbus_return_val_if_fail (message != NULL, FALSE);
1905 _dbus_return_val_if_error_is_set (error, FALSE);
1907 dbus_message_iter_init (message, &iter);
1908 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1912 * Gets arguments from a message iterator given a variable argument list.
1913 * The variable argument list should contain the type of the
1914 * argumen followed by a pointer to where the value should be
1915 * stored. The list is terminated with 0.
1917 * @param iter the message iterator
1918 * @param error error to be filled in on failure
1919 * @param first_arg_type the first argument type
1920 * @param ... location for first argument value, then list of type-location pairs
1921 * @returns #FALSE if the error was set
1924 dbus_message_iter_get_args (DBusMessageIter *iter,
1932 _dbus_return_val_if_fail (iter != NULL, FALSE);
1933 _dbus_return_val_if_error_is_set (error, FALSE);
1935 va_start (var_args, first_arg_type);
1936 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1943 * This function takes a va_list for use by language bindings
1945 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1946 * only if #DBUS_HAVE_INT64 is defined.
1948 * @todo this function (or some lower-level non-convenience function)
1949 * needs better error handling; should allow the application to
1950 * distinguish between out of memory, and bad data from the remote
1951 * app. It also needs to not leak a bunch of args when it gets
1952 * to the arg that's bad, as that would be a security hole
1953 * (allow one app to force another to leak memory)
1955 * @todo We need to free the argument data when an error occurs.
1957 * @see dbus_message_get_args
1958 * @param iter the message iter
1959 * @param error error to be filled in
1960 * @param first_arg_type type of the first argument
1961 * @param var_args return location for first argument, followed by list of type/location pairs
1962 * @returns #FALSE if error was set
1965 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1970 int spec_type, msg_type, i;
1973 _dbus_return_val_if_fail (iter != NULL, FALSE);
1974 _dbus_return_val_if_error_is_set (error, FALSE);
1978 spec_type = first_arg_type;
1981 while (spec_type != 0)
1983 msg_type = dbus_message_iter_get_arg_type (iter);
1985 if (msg_type != spec_type)
1987 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1988 "Argument %d is specified to be of type \"%s\", but "
1989 "is actually of type \"%s\"\n", i,
1990 _dbus_type_to_string (spec_type),
1991 _dbus_type_to_string (msg_type));
2000 case DBUS_TYPE_BYTE:
2004 ptr = va_arg (var_args, unsigned char *);
2006 *ptr = dbus_message_iter_get_byte (iter);
2009 case DBUS_TYPE_BOOLEAN:
2013 ptr = va_arg (var_args, dbus_bool_t *);
2015 *ptr = dbus_message_iter_get_boolean (iter);
2018 case DBUS_TYPE_INT32:
2022 ptr = va_arg (var_args, dbus_int32_t *);
2024 *ptr = dbus_message_iter_get_int32 (iter);
2027 case DBUS_TYPE_UINT32:
2031 ptr = va_arg (var_args, dbus_uint32_t *);
2033 *ptr = dbus_message_iter_get_uint32 (iter);
2036 #ifdef DBUS_HAVE_INT64
2037 case DBUS_TYPE_INT64:
2041 ptr = va_arg (var_args, dbus_int64_t *);
2043 *ptr = dbus_message_iter_get_int64 (iter);
2046 case DBUS_TYPE_UINT64:
2050 ptr = va_arg (var_args, dbus_uint64_t *);
2052 *ptr = dbus_message_iter_get_uint64 (iter);
2055 #endif /* DBUS_HAVE_INT64 */
2057 case DBUS_TYPE_DOUBLE:
2061 ptr = va_arg (var_args, double *);
2063 *ptr = dbus_message_iter_get_double (iter);
2067 case DBUS_TYPE_STRING:
2071 ptr = va_arg (var_args, char **);
2073 *ptr = dbus_message_iter_get_string (iter);
2077 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2084 case DBUS_TYPE_NAMED:
2087 unsigned char **data;
2090 name = va_arg (var_args, char **);
2091 data = va_arg (var_args, unsigned char **);
2092 len = va_arg (var_args, int *);
2094 if (!dbus_message_iter_get_named (iter, name, data, len))
2096 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2101 case DBUS_TYPE_ARRAY:
2106 type = va_arg (var_args, int);
2107 data = va_arg (var_args, void *);
2108 len = va_arg (var_args, int *);
2110 if (dbus_message_iter_get_array_type (iter) != type)
2112 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2113 "Argument %d is specified to be of type \"array of %s\", but "
2114 "is actually of type \"array of %s\"\n", i,
2115 _dbus_type_to_string (type),
2116 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
2122 case DBUS_TYPE_BYTE:
2123 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
2125 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2129 case DBUS_TYPE_BOOLEAN:
2130 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
2132 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2136 case DBUS_TYPE_INT32:
2137 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
2139 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2143 case DBUS_TYPE_UINT32:
2144 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
2146 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2150 #ifdef DBUS_HAVE_INT64
2151 case DBUS_TYPE_INT64:
2152 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
2154 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2158 case DBUS_TYPE_UINT64:
2159 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
2161 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2165 #endif /* DBUS_HAVE_INT64 */
2166 case DBUS_TYPE_DOUBLE:
2167 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
2169 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2173 case DBUS_TYPE_STRING:
2174 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
2176 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2181 case DBUS_TYPE_ARRAY:
2182 case DBUS_TYPE_NAMED:
2183 case DBUS_TYPE_DICT:
2184 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
2185 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2188 _dbus_warn ("Unknown field type %d\n", type);
2189 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2194 case DBUS_TYPE_DICT:
2195 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
2196 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2199 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2200 _dbus_warn ("Unknown field type %d\n", spec_type);
2204 spec_type = va_arg (var_args, int);
2205 if (spec_type != 0 && !dbus_message_iter_next (iter))
2207 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2208 "Message has only %d arguments, but more were expected", i);
2224 * Initializes a DBusMessageIter representing the arguments of the
2225 * message passed in.
2227 * @param message the message
2228 * @param iter pointer to an iterator to initialize
2231 dbus_message_iter_init (DBusMessage *message,
2232 DBusMessageIter *iter)
2234 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2236 _dbus_return_if_fail (message != NULL);
2237 _dbus_return_if_fail (iter != NULL);
2239 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
2241 real->message = message;
2242 real->parent_iter = NULL;
2243 real->changed_stamp = message->changed_stamp;
2245 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2247 real->end = _dbus_string_get_length (&message->body);
2249 real->container_start = 0;
2250 real->container_length_pos = 0;
2251 real->wrote_dict_key = 0;
2252 real->array_type_pos = 0;
2255 #ifndef DBUS_DISABLE_CHECKS
2257 dbus_message_iter_check (DBusMessageRealIter *iter)
2261 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
2265 if (iter->changed_stamp != iter->message->changed_stamp)
2267 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
2271 if (iter->pos < 0 || iter->pos > iter->end)
2273 _dbus_warn ("dbus iterator check failed: invalid position\n");
2279 #endif /* DBUS_DISABLE_CHECKS */
2282 skip_array_type (DBusMessageRealIter *iter, int pos)
2288 data = _dbus_string_get_const_data_len (&iter->message->body,
2291 while (*data == DBUS_TYPE_ARRAY);
2297 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
2304 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2305 data = _dbus_string_get_const_data_len (&iter->message->body,
2307 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2310 *type = DBUS_TYPE_INVALID;
2312 return skip_array_type (iter, iter->pos);
2314 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2315 data = _dbus_string_get_const_data_len (&iter->message->body,
2316 iter->array_type_pos, 1);
2317 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2320 *type = DBUS_TYPE_INVALID;
2324 case DBUS_MESSAGE_ITER_TYPE_DICT:
2325 /* Get the length of the string */
2326 len = _dbus_demarshal_uint32 (&iter->message->body,
2327 iter->message->byte_order,
2329 pos = pos + len + 1;
2331 data = _dbus_string_get_const_data_len (&iter->message->body,
2333 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2336 *type = DBUS_TYPE_INVALID;
2338 return skip_array_type (iter, pos);
2341 _dbus_assert_not_reached ("Invalid iter type");
2344 *type = DBUS_TYPE_INVALID;
2350 * Checks if an iterator has any more fields.
2352 * @param iter the message iter
2353 * @returns #TRUE if there are more fields
2357 dbus_message_iter_has_next (DBusMessageIter *iter)
2359 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2363 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2365 if (real->pos >= real->end)
2368 pos = dbus_message_iter_get_data_start (real, &type);
2370 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2371 real->message->byte_order,
2372 type, pos, &end_pos))
2375 if (end_pos >= real->end)
2382 * Moves the iterator to the next field.
2384 * @param iter The message iter
2385 * @returns #TRUE if the iterator was moved to the next field
2388 dbus_message_iter_next (DBusMessageIter *iter)
2390 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2394 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2396 pos = dbus_message_iter_get_data_start (real, &type);
2398 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2399 real->message->byte_order,
2400 type, pos, &end_pos))
2403 if (end_pos >= real->end)
2406 real->pos = end_pos;
2412 * Returns the argument type of the argument that the
2413 * message iterator points at.
2415 * @param iter the message iter
2416 * @returns the field type
2419 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
2421 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2424 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2426 if (real->pos >= real->end)
2427 return DBUS_TYPE_INVALID;
2429 pos = dbus_message_iter_get_data_start (real, &type);
2435 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2438 int _array_type_pos;
2443 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2444 _array_type_pos = iter->pos + 1;
2446 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2447 _array_type_pos = iter->array_type_pos + 1;
2449 case DBUS_MESSAGE_ITER_TYPE_DICT:
2450 /* Get the length of the string */
2451 len = _dbus_demarshal_uint32 (&iter->message->body,
2452 iter->message->byte_order,
2454 pos = pos + len + 1;
2455 data = _dbus_string_get_const_data_len (&iter->message->body,
2457 _array_type_pos = pos + 1;
2460 _dbus_assert_not_reached ("wrong iter type");
2461 return DBUS_TYPE_INVALID;
2464 if (array_type_pos != NULL)
2465 *array_type_pos = _array_type_pos;
2467 data = _dbus_string_get_const_data_len (&iter->message->body,
2468 _array_type_pos, 1);
2469 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2472 return DBUS_TYPE_INVALID;
2477 * Returns the element type of the array that the
2478 * message iterator points at. Note that you need
2479 * to check that the iterator points to an array
2480 * prior to using this function.
2482 * @param iter the message iter
2483 * @returns the field type
2486 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2488 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2491 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2493 if (real->pos >= real->end)
2494 return DBUS_TYPE_INVALID;
2496 pos = dbus_message_iter_get_data_start (real, &type);
2498 _dbus_assert (type == DBUS_TYPE_ARRAY);
2500 return iter_get_array_type (real, NULL);
2505 * Returns the string value that an iterator may point to.
2506 * Note that you need to check that the iterator points to
2507 * a string value before using this function.
2509 * @see dbus_message_iter_get_arg_type
2510 * @param iter the message iter
2511 * @returns the string
2514 dbus_message_iter_get_string (DBusMessageIter *iter)
2516 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2519 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2521 pos = dbus_message_iter_get_data_start (real, &type);
2523 _dbus_assert (type == DBUS_TYPE_STRING);
2525 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2530 * Returns the name and data from a named type that an
2531 * iterator may point to. Note that you need to check that
2532 * the iterator points to a named type before using this
2535 * @see dbus_message_iter_get_arg_type
2536 * @param iter the message iter
2537 * @param name return location for the name
2538 * @param value return location for data
2539 * @param len return location for length of data
2540 * @returns TRUE if get succeed
2544 dbus_message_iter_get_named (DBusMessageIter *iter,
2546 unsigned char **value,
2549 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2553 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2555 pos = dbus_message_iter_get_data_start (real, &type);
2557 _dbus_assert (type == DBUS_TYPE_NAMED);
2559 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2565 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2566 pos + 1, NULL, value, len))
2578 * Returns the byte value that an iterator may point to.
2579 * Note that you need to check that the iterator points to
2580 * a byte value before using this function.
2582 * @see dbus_message_iter_get_arg_type
2583 * @param iter the message iter
2584 * @returns the byte value
2587 dbus_message_iter_get_byte (DBusMessageIter *iter)
2589 unsigned char value;
2590 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2593 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2595 pos = dbus_message_iter_get_data_start (real, &type);
2597 _dbus_assert (type == DBUS_TYPE_BYTE);
2599 value = _dbus_string_get_byte (&real->message->body, pos);
2606 * Returns the boolean value that an iterator may point to.
2607 * Note that you need to check that the iterator points to
2608 * a boolean value before using this function.
2610 * @see dbus_message_iter_get_arg_type
2611 * @param iter the message iter
2612 * @returns the boolean value
2615 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2617 unsigned char value;
2618 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2621 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2623 pos = dbus_message_iter_get_data_start (real, &type);
2625 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2627 value = _dbus_string_get_byte (&real->message->body, pos);
2633 * Returns the 32 bit signed integer value that an iterator may point to.
2634 * Note that you need to check that the iterator points to
2635 * a 32-bit integer value before using this function.
2637 * @see dbus_message_iter_get_arg_type
2638 * @param iter the message iter
2639 * @returns the integer
2642 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2644 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2647 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2649 pos = dbus_message_iter_get_data_start (real, &type);
2651 _dbus_assert (type == DBUS_TYPE_INT32);
2653 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2658 * Returns the 32 bit unsigned integer value that an iterator may point to.
2659 * Note that you need to check that the iterator points to
2660 * a 32-bit unsigned integer value before using this function.
2662 * @see dbus_message_iter_get_arg_type
2663 * @param iter the message iter
2664 * @returns the integer
2667 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2669 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2672 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2674 pos = dbus_message_iter_get_data_start (real, &type);
2676 _dbus_assert (type == DBUS_TYPE_UINT32);
2678 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2682 #ifdef DBUS_HAVE_INT64
2685 * Returns the 64 bit signed integer value that an iterator may point
2686 * to. Note that you need to check that the iterator points to a
2687 * 64-bit integer value before using this function.
2689 * This function only exists if #DBUS_HAVE_INT64 is defined.
2691 * @see dbus_message_iter_get_arg_type
2692 * @param iter the message iter
2693 * @returns the integer
2696 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2698 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2701 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2703 pos = dbus_message_iter_get_data_start (real, &type);
2705 _dbus_assert (type == DBUS_TYPE_INT64);
2707 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2712 * Returns the 64 bit unsigned integer value that an iterator may point to.
2713 * Note that you need to check that the iterator points to
2714 * a 64-bit unsigned integer value before using this function.
2716 * This function only exists if #DBUS_HAVE_INT64 is defined.
2718 * @see dbus_message_iter_get_arg_type
2719 * @param iter the message iter
2720 * @returns the integer
2723 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2725 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2728 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2730 pos = dbus_message_iter_get_data_start (real, &type);
2732 _dbus_assert (type == DBUS_TYPE_UINT64);
2734 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2738 #endif /* DBUS_HAVE_INT64 */
2741 * Returns the double value that an iterator may point to.
2742 * Note that you need to check that the iterator points to
2743 * a string value before using this function.
2745 * @see dbus_message_iter_get_arg_type
2746 * @param iter the message iter
2747 * @returns the double
2750 dbus_message_iter_get_double (DBusMessageIter *iter)
2752 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2755 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2757 pos = dbus_message_iter_get_data_start (real, &type);
2759 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2761 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2766 * Initializes an iterator for the array that the iterator
2767 * may point to. Note that you need to check that the iterator
2768 * points to an array prior to using this function.
2770 * The array element type is returned in array_type, and the array
2771 * iterator can only be used to get that type of data.
2773 * @param iter the iterator
2774 * @param array_iter pointer to an iterator to initialize
2775 * @param array_type gets set to the type of the array elements
2776 * @returns #TRUE on success
2779 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2780 DBusMessageIter *array_iter,
2783 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2784 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2785 int type, pos, len_pos, len, array_type_pos;
2788 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2790 pos = dbus_message_iter_get_data_start (real, &type);
2792 _dbus_assert (type == DBUS_TYPE_ARRAY);
2794 _array_type = iter_get_array_type (real, &array_type_pos);
2796 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2797 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2800 array_real->parent_iter = real;
2801 array_real->message = real->message;
2802 array_real->changed_stamp = real->message->changed_stamp;
2804 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2805 array_real->pos = pos;
2806 array_real->end = pos + len;
2808 array_real->container_start = pos;
2809 array_real->container_length_pos = len_pos;
2810 array_real->wrote_dict_key = 0;
2811 array_real->array_type_pos = array_type_pos;
2812 array_real->array_type_done = TRUE;
2814 if (array_type != NULL)
2815 *array_type = _array_type;
2822 * Initializes an iterator for the dict that the iterator
2823 * may point to. Note that you need to check that the iterator
2824 * points to a dict prior to using this function.
2826 * @param iter the iterator
2827 * @param dict_iter pointer to an iterator to initialize
2828 * @returns #TRUE on success
2831 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2832 DBusMessageIter *dict_iter)
2834 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2835 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2836 int type, pos, len_pos, len;
2838 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2840 pos = dbus_message_iter_get_data_start (real, &type);
2842 _dbus_assert (type == DBUS_TYPE_DICT);
2844 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2845 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2848 dict_real->parent_iter = real;
2849 dict_real->message = real->message;
2850 dict_real->changed_stamp = real->message->changed_stamp;
2852 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2853 dict_real->pos = pos;
2854 dict_real->end = pos + len;
2856 dict_real->container_start = pos;
2857 dict_real->container_length_pos = len_pos;
2858 dict_real->wrote_dict_key = 0;
2864 * Returns the byte array that the iterator may point to.
2865 * Note that you need to check that the iterator points
2866 * to a byte array prior to using this function.
2868 * @param iter the iterator
2869 * @param value return location for array values
2870 * @param len return location for length of byte array
2871 * @returns #TRUE on success
2874 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2875 unsigned char **value,
2878 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2881 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2883 pos = dbus_message_iter_get_data_start (real, &type);
2885 _dbus_assert (type == DBUS_TYPE_ARRAY);
2887 type = iter_get_array_type (real, NULL);
2889 _dbus_assert (type == DBUS_TYPE_BYTE);
2891 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2892 pos, NULL, value, len))
2899 * Returns the boolean array that the iterator may point to. Note that
2900 * you need to check that the iterator points to an array of the
2901 * correct type prior to using this function.
2903 * @param iter the iterator
2904 * @param value return location for the array
2905 * @param len return location for the array length
2906 * @returns #TRUE on success
2909 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2910 unsigned char **value,
2913 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2916 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2918 pos = dbus_message_iter_get_data_start (real, &type);
2920 _dbus_assert (type == DBUS_TYPE_ARRAY);
2922 type = iter_get_array_type (real, NULL);
2924 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2926 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2927 pos, NULL, value, len))
2934 * Returns the 32 bit signed integer array that the iterator may point
2935 * to. Note that you need to check that the iterator points to an
2936 * array of the correct type prior to using this function.
2938 * @param iter the iterator
2939 * @param value return location for the array
2940 * @param len return location for the array length
2941 * @returns #TRUE on success
2944 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2945 dbus_int32_t **value,
2948 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2951 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2953 pos = dbus_message_iter_get_data_start (real, &type);
2955 _dbus_assert (type == DBUS_TYPE_ARRAY);
2957 type = iter_get_array_type (real, NULL);
2959 _dbus_assert (type == DBUS_TYPE_INT32);
2961 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2962 pos, NULL, value, len))
2969 * Returns the 32 bit unsigned integer array that the iterator may point
2970 * to. Note that you need to check that the iterator points to an
2971 * array of the correct type prior to using this function.
2973 * @param iter the iterator
2974 * @param value return location for the array
2975 * @param len return location for the array length
2976 * @returns #TRUE on success
2979 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2980 dbus_uint32_t **value,
2983 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2986 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2988 pos = dbus_message_iter_get_data_start (real, &type);
2990 _dbus_assert (type == DBUS_TYPE_ARRAY);
2992 type = iter_get_array_type (real, NULL);
2993 _dbus_assert (type == DBUS_TYPE_UINT32);
2995 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2996 pos, NULL, value, len))
3002 #ifdef DBUS_HAVE_INT64
3005 * Returns the 64 bit signed integer array that the iterator may point
3006 * to. Note that you need to check that the iterator points to an
3007 * array of the correct type prior to using this function.
3009 * This function only exists if #DBUS_HAVE_INT64 is defined.
3011 * @param iter the iterator
3012 * @param value return location for the array
3013 * @param len return location for the array length
3014 * @returns #TRUE on success
3017 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
3018 dbus_int64_t **value,
3021 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3024 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3026 pos = dbus_message_iter_get_data_start (real, &type);
3028 _dbus_assert (type == DBUS_TYPE_ARRAY);
3030 type = iter_get_array_type (real, NULL);
3032 _dbus_assert (type == DBUS_TYPE_INT64);
3034 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
3035 pos, NULL, value, len))
3042 * Returns the 64 bit unsigned integer array that the iterator may point
3043 * to. Note that you need to check that the iterator points to an
3044 * array of the correct type prior to using this function.
3046 * This function only exists if #DBUS_HAVE_INT64 is defined.
3048 * @param iter the iterator
3049 * @param value return location for the array
3050 * @param len return location for the array length
3051 * @returns #TRUE on success
3054 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
3055 dbus_uint64_t **value,
3058 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3061 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3063 pos = dbus_message_iter_get_data_start (real, &type);
3065 _dbus_assert (type == DBUS_TYPE_ARRAY);
3067 type = iter_get_array_type (real, NULL);
3068 _dbus_assert (type == DBUS_TYPE_UINT64);
3070 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
3071 pos, NULL, value, len))
3077 #endif /* DBUS_HAVE_INT64 */
3080 * Returns the double array that the iterator may point to. Note that
3081 * you need to check that the iterator points to an array of the
3082 * correct type prior to using this function.
3084 * @param iter the iterator
3085 * @param value return location for the array
3086 * @param len return location for the array length
3087 * @returns #TRUE on success
3090 dbus_message_iter_get_double_array (DBusMessageIter *iter,
3094 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3097 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3099 pos = dbus_message_iter_get_data_start (real, &type);
3101 _dbus_assert (type == DBUS_TYPE_ARRAY);
3103 type = iter_get_array_type (real, NULL);
3104 _dbus_assert (type == DBUS_TYPE_DOUBLE);
3106 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
3107 pos, NULL, value, len))
3114 * Returns the string array that the iterator may point to.
3115 * Note that you need to check that the iterator points
3116 * to a byte array prior to using this function.
3118 * The returned value is a #NULL-terminated array of strings.
3119 * Each string is a separate malloc block, and the array
3120 * itself is a malloc block. You can free this type of
3121 * string array with dbus_free_string_array().
3123 * @param iter the iterator
3124 * @param value return location for string values
3125 * @param len return location for length of byte array
3126 * @returns #TRUE on success
3129 dbus_message_iter_get_string_array (DBusMessageIter *iter,
3133 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3136 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3138 pos = dbus_message_iter_get_data_start (real, &type);
3140 _dbus_assert (type == DBUS_TYPE_ARRAY);
3142 type = iter_get_array_type (real, NULL);
3143 _dbus_assert (type == DBUS_TYPE_STRING);
3145 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
3146 pos, NULL, value, len))
3153 * Returns the key name fot the dict entry that an iterator
3154 * may point to. Note that you need to check that the iterator
3155 * points to a dict entry before using this function.
3157 * @see dbus_message_iter_init_dict_iterator
3158 * @param iter the message iter
3159 * @returns the key name
3162 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
3164 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3166 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
3168 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3170 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
3175 * Initializes a DBusMessageIter pointing to the end of the
3176 * message. This iterator can be used to append data to the
3179 * @param message the message
3180 * @param iter pointer to an iterator to initialize
3183 dbus_message_append_iter_init (DBusMessage *message,
3184 DBusMessageIter *iter)
3186 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3188 _dbus_return_if_fail (message != NULL);
3189 _dbus_return_if_fail (iter != NULL);
3191 real->message = message;
3192 real->parent_iter = NULL;
3193 real->changed_stamp = message->changed_stamp;
3195 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
3196 real->end = _dbus_string_get_length (&real->message->body);
3197 real->pos = real->end;
3199 real->container_length_pos = 0;
3200 real->wrote_dict_key = 0;
3203 #ifndef DBUS_DISABLE_CHECKS
3205 dbus_message_iter_append_check (DBusMessageRealIter *iter)
3209 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
3213 if (iter->message->locked)
3215 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
3219 if (iter->changed_stamp != iter->message->changed_stamp)
3221 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
3225 if (iter->pos != iter->end)
3227 _dbus_warn ("dbus iterator check failed: can only append at end of message");
3231 if (iter->pos != _dbus_string_get_length (&iter->message->body))
3233 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
3239 #endif /* DBUS_DISABLE_CHECKS */
3242 dbus_message_iter_append_type (DBusMessageRealIter *iter,
3248 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
3249 if (!_dbus_string_append_byte (&iter->message->body, type))
3253 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
3254 data = _dbus_string_get_const_data_len (&iter->message->body,
3255 iter->array_type_pos, 1);
3258 _dbus_warn ("Appended element of wrong type for array\n");
3263 case DBUS_MESSAGE_ITER_TYPE_DICT:
3264 if (!iter->wrote_dict_key)
3266 _dbus_warn ("Appending dict data before key name\n");
3270 if (!_dbus_string_append_byte (&iter->message->body, type))
3276 _dbus_assert_not_reached ("Invalid iter type");
3284 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
3286 iter->changed_stamp = iter->message->changed_stamp;
3288 /* Set new end of iter */
3289 iter->end = _dbus_string_get_length (&iter->message->body);
3290 iter->pos = iter->end;
3292 /* Set container length */
3293 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
3294 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
3295 _dbus_marshal_set_uint32 (&iter->message->body,
3296 iter->message->byte_order,
3297 iter->container_length_pos,
3298 iter->end - iter->container_start);
3300 if (iter->parent_iter)
3301 dbus_message_iter_update_after_change (iter->parent_iter);
3305 dbus_message_iter_append_done (DBusMessageRealIter *iter)
3307 iter->message->changed_stamp++;
3308 dbus_message_iter_update_after_change (iter);
3309 iter->wrote_dict_key = FALSE;
3313 * Appends a nil value to the message
3315 * @param iter an iterator pointing to the end of the message
3316 * @returns #TRUE on success
3319 dbus_message_iter_append_nil (DBusMessageIter *iter)
3321 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3323 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3325 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
3328 dbus_message_iter_append_done (real);
3334 * Appends a boolean value to the message
3336 * @param iter an iterator pointing to the end of the message
3337 * @param value the boolean value
3338 * @returns #TRUE on success
3341 dbus_message_iter_append_boolean (DBusMessageIter *iter,
3344 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3346 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3348 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
3351 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
3353 _dbus_string_set_length (&real->message->body, real->pos);
3357 dbus_message_iter_append_done (real);
3363 * Appends a byte to the message
3365 * @param iter an iterator pointing to the end of the message
3366 * @param value the byte value
3367 * @returns #TRUE on success
3370 dbus_message_iter_append_byte (DBusMessageIter *iter,
3371 unsigned char value)
3373 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3375 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3377 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
3380 if (!_dbus_string_append_byte (&real->message->body, value))
3382 _dbus_string_set_length (&real->message->body, real->pos);
3386 dbus_message_iter_append_done (real);
3393 * Appends a 32 bit signed integer to the message.
3395 * @param iter an iterator pointing to the end of the message
3396 * @param value the integer value
3397 * @returns #TRUE on success
3400 dbus_message_iter_append_int32 (DBusMessageIter *iter,
3403 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3405 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3407 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
3410 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
3412 _dbus_string_set_length (&real->message->body, real->pos);
3416 dbus_message_iter_append_done (real);
3422 * Appends a 32 bit unsigned integer to the message.
3424 * @param iter an iterator pointing to the end of the message
3425 * @param value the integer value
3426 * @returns #TRUE on success
3429 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3430 dbus_uint32_t value)
3432 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3434 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3436 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3439 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3441 _dbus_string_set_length (&real->message->body, real->pos);
3445 dbus_message_iter_append_done (real);
3450 #ifdef DBUS_HAVE_INT64
3453 * Appends a 64 bit signed integer to the message.
3455 * This function only exists if #DBUS_HAVE_INT64 is defined.
3457 * @param iter an iterator pointing to the end of the message
3458 * @param value the integer value
3459 * @returns #TRUE on success
3462 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3465 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3467 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3469 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3472 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3474 _dbus_string_set_length (&real->message->body, real->pos);
3478 dbus_message_iter_append_done (real);
3484 * Appends a 64 bit unsigned integer to the message.
3486 * This function only exists if #DBUS_HAVE_INT64 is defined.
3488 * @param iter an iterator pointing to the end of the message
3489 * @param value the integer value
3490 * @returns #TRUE on success
3493 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3494 dbus_uint64_t value)
3496 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3498 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3500 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3503 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3505 _dbus_string_set_length (&real->message->body, real->pos);
3509 dbus_message_iter_append_done (real);
3514 #endif /* DBUS_HAVE_INT64 */
3517 * Appends a double value to the message.
3519 * @param iter an iterator pointing to the end of the message
3520 * @param value the double value
3521 * @returns #TRUE on success
3524 dbus_message_iter_append_double (DBusMessageIter *iter,
3527 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3529 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3531 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3534 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3536 _dbus_string_set_length (&real->message->body, real->pos);
3540 dbus_message_iter_append_done (real);
3546 * Appends a UTF-8 string to the message.
3548 * @param iter an iterator pointing to the end of the message
3549 * @param value the string
3550 * @returns #TRUE on success
3553 dbus_message_iter_append_string (DBusMessageIter *iter,
3556 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3558 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3560 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3563 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3565 _dbus_string_set_length (&real->message->body, real->pos);
3569 dbus_message_iter_append_done (real);
3575 * Appends a named type data chunk to the message. A named
3576 * type is simply an arbitrary UTF-8 string used as a type
3577 * tag, plus an array of arbitrary bytes to be interpreted
3578 * according to the type tag.
3580 * @param iter an iterator pointing to the end of the message
3581 * @param name the name of the type
3582 * @param data the binary data used to store the value
3583 * @param len the length of the binary data in bytes
3584 * @returns #TRUE on success
3587 dbus_message_iter_append_named (DBusMessageIter *iter,
3589 const unsigned char *data,
3592 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3594 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3596 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3599 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3601 _dbus_string_set_length (&real->message->body, real->pos);
3605 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3607 _dbus_string_set_length (&real->message->body, real->pos);
3611 dbus_message_iter_append_done (real);
3618 * Appends a dict key name to the message. The iterator used
3619 * must point to a dict.
3621 * @param iter an iterator pointing to the end of the message
3622 * @param value the string
3623 * @returns #TRUE on success
3626 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3629 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3631 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3632 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3634 if (real->wrote_dict_key)
3636 _dbus_warn ("Appendinging multiple dict key names\n");
3640 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3645 dbus_message_iter_append_done (real);
3646 real->wrote_dict_key = TRUE;
3652 array_iter_type_mark_done (DBusMessageRealIter *iter)
3656 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3657 array_iter_type_mark_done (iter->parent_iter);
3661 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3662 sizeof (dbus_uint32_t));
3664 /* Empty length for now, backfill later */
3665 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3667 _dbus_string_set_length (&iter->message->body, iter->pos);
3671 iter->container_start = _dbus_string_get_length (&iter->message->body);
3672 iter->container_length_pos = len_pos;
3673 iter->array_type_done = TRUE;
3679 append_array_type (DBusMessageRealIter *real,
3681 dbus_bool_t *array_type_done,
3682 int *array_type_pos)
3684 int existing_element_type;
3686 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3689 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3690 real->array_type_done)
3692 existing_element_type = iter_get_array_type (real, array_type_pos);
3693 if (existing_element_type != element_type)
3695 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3696 _dbus_type_to_string (element_type),
3697 _dbus_type_to_string (existing_element_type));
3698 _dbus_string_set_length (&real->message->body, real->pos);
3701 if (array_type_done != NULL)
3702 *array_type_done = TRUE;
3706 if (array_type_pos != NULL)
3707 *array_type_pos = _dbus_string_get_length (&real->message->body);
3709 /* Append element type */
3710 if (!_dbus_string_append_byte (&real->message->body, element_type))
3712 _dbus_string_set_length (&real->message->body, real->pos);
3716 if (array_type_done != NULL)
3717 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3719 if (element_type != DBUS_TYPE_ARRAY &&
3720 !array_iter_type_mark_done (real))
3728 * Appends an array to the message and initializes an iterator that
3729 * can be used to append to the array.
3731 * @param iter an iterator pointing to the end of the message
3732 * @param array_iter pointer to an iter that will be initialized
3733 * @param element_type the type of the array elements
3734 * @returns #TRUE on success
3737 dbus_message_iter_append_array (DBusMessageIter *iter,
3738 DBusMessageIter *array_iter,
3741 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3742 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3745 dbus_bool_t array_type_done;
3747 if (element_type == DBUS_TYPE_NIL)
3749 _dbus_warn ("Can't create NIL arrays\n");
3753 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3755 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3758 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3760 if (array_type_done)
3762 /* Empty length for now, backfill later */
3763 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3765 _dbus_string_set_length (&real->message->body, real->pos);
3770 array_real->parent_iter = real;
3771 array_real->message = real->message;
3772 array_real->changed_stamp = real->message->changed_stamp;
3774 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3775 array_real->pos = _dbus_string_get_length (&real->message->body);
3776 array_real->end = array_real->end;
3778 array_real->container_start = array_real->pos;
3779 array_real->container_length_pos = len_pos;
3780 array_real->wrote_dict_key = 0;
3781 array_real->array_type_done = array_type_done;
3782 array_real->array_type_pos = array_type_pos;
3784 dbus_message_iter_append_done (array_real);
3790 * Appends a dict to the message and initializes an iterator that
3791 * can be used to append to the dict.
3793 * @param iter an iterator pointing to the end of the message
3794 * @param dict_iter pointer to an iter that will be initialized
3795 * @returns #TRUE on success
3798 dbus_message_iter_append_dict (DBusMessageIter *iter,
3799 DBusMessageIter *dict_iter)
3801 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3802 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3805 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3807 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3810 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3812 /* Empty length for now, backfill later */
3813 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3815 _dbus_string_set_length (&real->message->body, real->pos);
3819 dict_real->parent_iter = real;
3820 dict_real->message = real->message;
3821 dict_real->changed_stamp = real->message->changed_stamp;
3823 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3824 dict_real->pos = _dbus_string_get_length (&real->message->body);
3825 dict_real->end = dict_real->end;
3827 dict_real->container_start = dict_real->pos;
3828 dict_real->container_length_pos = len_pos;
3829 dict_real->wrote_dict_key = 0;
3831 dbus_message_iter_append_done (dict_real);
3838 * Appends a boolean array to the message.
3840 * @param iter an iterator pointing to the end of the message
3841 * @param value the array
3842 * @param len the length of the array
3843 * @returns #TRUE on success
3846 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3847 unsigned const char *value,
3850 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3852 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3854 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3857 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3859 _dbus_string_set_length (&real->message->body, real->pos);
3863 dbus_message_iter_append_done (real);
3869 * Appends a 32 bit signed integer array to the message.
3871 * @param iter an iterator pointing to the end of the message
3872 * @param value the array
3873 * @param len the length of the array
3874 * @returns #TRUE on success
3877 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3878 const dbus_int32_t *value,
3881 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3883 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3885 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
3888 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
3890 _dbus_string_set_length (&real->message->body, real->pos);
3894 dbus_message_iter_append_done (real);
3900 * Appends a 32 bit unsigned integer array to the message.
3902 * @param iter an iterator pointing to the end of the message
3903 * @param value the array
3904 * @param len the length of the array
3905 * @returns #TRUE on success
3908 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
3909 const dbus_uint32_t *value,
3912 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3914 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3916 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
3919 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3921 _dbus_string_set_length (&real->message->body, real->pos);
3925 dbus_message_iter_append_done (real);
3930 #ifdef DBUS_HAVE_INT64
3933 * Appends a 64 bit signed integer array to the message.
3935 * This function only exists if #DBUS_HAVE_INT64 is defined.
3937 * @param iter an iterator pointing to the end of the message
3938 * @param value the array
3939 * @param len the length of the array
3940 * @returns #TRUE on success
3943 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
3944 const dbus_int64_t *value,
3947 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3949 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3951 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
3954 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
3956 _dbus_string_set_length (&real->message->body, real->pos);
3960 dbus_message_iter_append_done (real);
3966 * Appends a 64 bit unsigned integer array to the message.
3968 * This function only exists if #DBUS_HAVE_INT64 is defined.
3970 * @param iter an iterator pointing to the end of the message
3971 * @param value the array
3972 * @param len the length of the array
3973 * @returns #TRUE on success
3976 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
3977 const dbus_uint64_t *value,
3980 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3982 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3984 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
3987 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
3989 _dbus_string_set_length (&real->message->body, real->pos);
3993 dbus_message_iter_append_done (real);
3997 #endif /* DBUS_HAVE_INT64 */
4000 * Appends a double array to the message.
4002 * @param iter an iterator pointing to the end of the message
4003 * @param value the array
4004 * @param len the length of the array
4005 * @returns #TRUE on success
4008 dbus_message_iter_append_double_array (DBusMessageIter *iter,
4009 const double *value,
4012 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4014 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4016 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
4019 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
4021 _dbus_string_set_length (&real->message->body, real->pos);
4025 dbus_message_iter_append_done (real);
4031 * Appends a byte array to the message.
4033 * @param iter an iterator pointing to the end of the message
4034 * @param value the array
4035 * @param len the length of the array
4036 * @returns #TRUE on success
4039 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
4040 unsigned const char *value,
4043 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4045 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4047 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
4050 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
4052 _dbus_string_set_length (&real->message->body, real->pos);
4056 dbus_message_iter_append_done (real);
4062 * Appends a string array to the message.
4064 * @param iter an iterator pointing to the end of the message
4065 * @param value the array
4066 * @param len the length of the array
4067 * @returns #TRUE on success
4070 dbus_message_iter_append_string_array (DBusMessageIter *iter,
4074 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4076 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4078 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
4081 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
4083 _dbus_string_set_length (&real->message->body, real->pos);
4087 dbus_message_iter_append_done (real);
4093 * Sets the message sender.
4095 * @param message the message
4096 * @param sender the sender
4097 * @returns #FALSE if not enough memory
4100 dbus_message_set_sender (DBusMessage *message,
4103 _dbus_return_val_if_fail (message != NULL, FALSE);
4104 _dbus_return_val_if_fail (!message->locked, FALSE);
4108 delete_string_field (message, FIELD_SENDER_SERVICE);
4113 return set_string_field (message,
4114 FIELD_SENDER_SERVICE,
4121 * Sets a flag indicating that the message does not want a reply; if
4122 * this flag is set, the other end of the connection may (but is not
4123 * required to) optimize by not sending method return or error
4124 * replies. If this flag is set, there is no way to know whether the
4125 * message successfully arrived at the remote end.
4127 * @param message the message
4128 * @param no_reply #TRUE if no reply is desired
4131 dbus_message_set_no_reply (DBusMessage *message,
4132 dbus_bool_t no_reply)
4136 _dbus_return_if_fail (message != NULL);
4137 _dbus_return_if_fail (!message->locked);
4139 header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1);
4142 *header |= DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4144 *header &= ~DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4148 * Returns #TRUE if the message does not expect
4151 * @param message the message
4152 * @returns #TRUE if the message sender isn't waiting for a reply
4155 dbus_message_get_no_reply (DBusMessage *message)
4159 _dbus_return_val_if_fail (message != NULL, FALSE);
4161 header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1);
4163 return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0;
4167 * Gets the service which originated this message,
4168 * or #NULL if unknown or inapplicable.
4170 * @param message the message
4171 * @returns the service name or #NULL
4174 dbus_message_get_sender (DBusMessage *message)
4176 _dbus_return_val_if_fail (message != NULL, NULL);
4178 return get_string_field (message, FIELD_SENDER_SERVICE, NULL);
4182 _dbus_message_has_type_interface_member (DBusMessage *message,
4184 const char *interface,
4189 _dbus_assert (message != NULL);
4190 _dbus_assert (interface != NULL);
4191 _dbus_assert (method != NULL);
4193 if (dbus_message_get_type (message) != type)
4196 /* Optimize by checking the short method name first
4197 * instead of the longer interface name
4200 n = dbus_message_get_member (message);
4202 if (n && strcmp (n, method) == 0)
4204 n = dbus_message_get_interface (message);
4206 if (n && strcmp (n, interface) == 0)
4214 * Checks whether the message is a method call with the given
4215 * interface and member fields. If the message is not
4216 * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or member field,
4219 * @param message the message
4220 * @param interface the name to check (must not be #NULL)
4221 * @param method the name to check (must not be #NULL)
4223 * @returns #TRUE if the message is the specified method call
4226 dbus_message_is_method_call (DBusMessage *message,
4227 const char *interface,
4230 _dbus_return_val_if_fail (message != NULL, FALSE);
4231 _dbus_return_val_if_fail (interface != NULL, FALSE);
4232 _dbus_return_val_if_fail (method != NULL, FALSE);
4234 return _dbus_message_has_type_interface_member (message,
4235 DBUS_MESSAGE_TYPE_METHOD_CALL,
4240 * Checks whether the message is a signal with the given
4241 * interface and member fields. If the message is not
4242 * #DBUS_MESSAGE_TYPE_SIGNAL, or has a different interface or member field,
4245 * @param message the message
4246 * @param interface the name to check (must not be #NULL)
4247 * @param signal_name the name to check (must not be #NULL)
4249 * @returns #TRUE if the message is the specified signal
4252 dbus_message_is_signal (DBusMessage *message,
4253 const char *interface,
4254 const char *signal_name)
4256 _dbus_return_val_if_fail (message != NULL, FALSE);
4257 _dbus_return_val_if_fail (interface != NULL, FALSE);
4258 _dbus_return_val_if_fail (signal_name != NULL, FALSE);
4260 return _dbus_message_has_type_interface_member (message,
4261 DBUS_MESSAGE_TYPE_SIGNAL,
4262 interface, signal_name);
4266 * Checks whether the message is an error reply with the given error
4267 * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a
4268 * different name, returns #FALSE.
4270 * @param message the message
4271 * @param error_name the name to check (must not be #NULL)
4273 * @returns #TRUE if the message is the specified error
4276 dbus_message_is_error (DBusMessage *message,
4277 const char *error_name)
4281 _dbus_return_val_if_fail (message != NULL, FALSE);
4282 _dbus_return_val_if_fail (error_name != NULL, FALSE);
4284 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4287 n = dbus_message_get_error_name (message);
4289 if (n && strcmp (n, error_name) == 0)
4296 * Checks whether the message was sent to the given service. If the
4297 * message has no service specified or has a different name, returns
4300 * @param message the message
4301 * @param service the service to check (must not be #NULL)
4303 * @returns #TRUE if the message has the given destination service
4306 dbus_message_has_destination (DBusMessage *message,
4307 const char *service)
4311 _dbus_return_val_if_fail (message != NULL, FALSE);
4312 _dbus_return_val_if_fail (service != NULL, FALSE);
4314 s = dbus_message_get_destination (message);
4316 if (s && strcmp (s, service) == 0)
4323 * Checks whether the message has the given service as its sender. If
4324 * the message has no sender specified or has a different sender,
4325 * returns #FALSE. Note that if a peer application owns multiple
4326 * services, its messages will have only one of those services as the
4327 * sender (usually the base service). So you can't use this
4328 * function to prove the sender didn't own service Foo, you can
4329 * only use it to prove that it did.
4331 * @param message the message
4332 * @param service the service to check (must not be #NULL)
4334 * @returns #TRUE if the message has the given origin service
4337 dbus_message_has_sender (DBusMessage *message,
4338 const char *service)
4342 _dbus_assert (service != NULL);
4344 s = dbus_message_get_sender (message);
4346 if (s && strcmp (s, service) == 0)
4353 * Sets a #DBusError based on the contents of the given
4354 * message. The error is only set if the message
4355 * is an error message, as in DBUS_MESSAGE_TYPE_ERROR.
4356 * The name of the error is set to the name of the message,
4357 * and the error message is set to the first argument
4358 * if the argument exists and is a string.
4360 * The return value indicates whether the error was set (the error is
4361 * set if and only if the message is an error message).
4362 * So you can check for an error reply and convert it to DBusError
4365 * @param error the error to set
4366 * @param message the message to set it from
4367 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
4370 dbus_set_error_from_message (DBusError *error,
4371 DBusMessage *message)
4375 _dbus_return_val_if_fail (message != NULL, FALSE);
4376 _dbus_return_val_if_error_is_set (error, FALSE);
4378 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4382 dbus_message_get_args (message, NULL,
4383 DBUS_TYPE_STRING, &str,
4386 dbus_set_error (error, dbus_message_get_error_name (message),
4387 str ? "%s" : NULL, str);
4397 * @addtogroup DBusMessageInternals
4402 * @typedef DBusMessageLoader
4404 * The DBusMessageLoader object encapsulates the process of converting
4405 * a byte stream into a series of DBusMessage. It buffers the incoming
4406 * bytes as efficiently as possible, and generates a queue of
4407 * messages. DBusMessageLoader is typically used as part of a
4408 * DBusTransport implementation. The DBusTransport then hands off
4409 * the loaded messages to a DBusConnection, making the messages
4410 * visible to the application.
4412 * @todo write tests for break-loader that a) randomly delete header
4413 * fields and b) set string fields to zero-length and other funky
4418 /* we definitely use signed ints for sizes, so don't exceed
4419 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
4420 * over 128M is pretty nuts anyhow.
4424 * The maximum sane message size.
4426 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
4429 * Implementation details of DBusMessageLoader.
4430 * All members are private.
4432 struct DBusMessageLoader
4434 int refcount; /**< Reference count. */
4436 DBusString data; /**< Buffered data */
4438 DBusList *messages; /**< Complete messages. */
4440 long max_message_size; /**< Maximum size of a message */
4442 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
4444 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
4448 * The initial buffer size of the message loader.
4450 * @todo this should be based on min header size plus some average
4451 * body size, or something. Or rather, the min header size only, if we
4452 * want to try to read only the header, store that in a DBusMessage,
4453 * then read only the body and store that, etc., depends on
4454 * how we optimize _dbus_message_loader_get_buffer() and what
4455 * the exact message format is.
4457 #define INITIAL_LOADER_DATA_LEN 32
4460 * Creates a new message loader. Returns #NULL if memory can't
4463 * @returns new loader, or #NULL.
4466 _dbus_message_loader_new (void)
4468 DBusMessageLoader *loader;
4470 loader = dbus_new0 (DBusMessageLoader, 1);
4474 loader->refcount = 1;
4476 /* Try to cap message size at something that won't *totally* hose
4477 * the system if we have a couple of them.
4479 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
4481 if (!_dbus_string_init (&loader->data))
4487 /* preallocate the buffer for speed, ignore failure */
4488 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
4489 _dbus_string_set_length (&loader->data, 0);
4495 * Increments the reference count of the loader.
4497 * @param loader the loader.
4500 _dbus_message_loader_ref (DBusMessageLoader *loader)
4502 loader->refcount += 1;
4506 * Decrements the reference count of the loader and finalizes the
4507 * loader when the count reaches zero.
4509 * @param loader the loader.
4512 _dbus_message_loader_unref (DBusMessageLoader *loader)
4514 loader->refcount -= 1;
4515 if (loader->refcount == 0)
4517 _dbus_list_foreach (&loader->messages,
4518 (DBusForeachFunction) dbus_message_unref,
4520 _dbus_list_clear (&loader->messages);
4521 _dbus_string_free (&loader->data);
4527 * Gets the buffer to use for reading data from the network. Network
4528 * data is read directly into an allocated buffer, which is then used
4529 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4530 * The buffer must always be returned immediately using
4531 * _dbus_message_loader_return_buffer(), even if no bytes are
4532 * successfully read.
4534 * @todo this function can be a lot more clever. For example
4535 * it can probably always return a buffer size to read exactly
4536 * the body of the next message, thus avoiding any memory wastage
4539 * @todo we need to enforce a max length on strings in header fields.
4541 * @param loader the message loader.
4542 * @param buffer the buffer
4545 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4546 DBusString **buffer)
4548 _dbus_assert (!loader->buffer_outstanding);
4550 *buffer = &loader->data;
4552 loader->buffer_outstanding = TRUE;
4556 * The smallest header size that can occur.
4557 * (It won't be valid)
4559 #define DBUS_MINIMUM_HEADER_SIZE 16
4561 /** Pack four characters as in "abcd" into a uint32 */
4562 #define FOUR_CHARS_TO_UINT32(a, b, c, d) \
4563 ((((dbus_uint32_t)a) << 24) | \
4564 (((dbus_uint32_t)b) << 16) | \
4565 (((dbus_uint32_t)c) << 8) | \
4568 /** DBUS_HEADER_FIELD_PATH packed into a dbus_uint32_t */
4569 #define DBUS_HEADER_FIELD_PATH_AS_UINT32 \
4570 FOUR_CHARS_TO_UINT32 ('p', 'a', 't', 'h')
4572 /** DBUS_HEADER_FIELD_INTERFACE packed into a dbus_uint32_t */
4573 #define DBUS_HEADER_FIELD_INTERFACE_AS_UINT32 \
4574 FOUR_CHARS_TO_UINT32 ('i', 'f', 'c', 'e')
4576 /** DBUS_HEADER_FIELD_MEMBER packed into a dbus_uint32_t */
4577 #define DBUS_HEADER_FIELD_MEMBER_AS_UINT32 \
4578 FOUR_CHARS_TO_UINT32 ('m', 'e', 'b', 'r')
4580 /** DBUS_HEADER_FIELD_ERROR_NAME packed into a dbus_uint32_t */
4581 #define DBUS_HEADER_FIELD_ERROR_NAME_AS_UINT32 \
4582 FOUR_CHARS_TO_UINT32 ('e', 'r', 'n', 'm')
4584 /** DBUS_HEADER_FIELD_SERVICE packed into a dbus_uint32_t */
4585 #define DBUS_HEADER_FIELD_SERVICE_AS_UINT32 \
4586 FOUR_CHARS_TO_UINT32 ('s', 'r', 'v', 'c')
4588 /** DBUS_HEADER_FIELD_REPLY packed into a dbus_uint32_t */
4589 #define DBUS_HEADER_FIELD_REPLY_AS_UINT32 \
4590 FOUR_CHARS_TO_UINT32 ('r', 'p', 'l', 'y')
4592 /** DBUS_HEADER_FIELD_SENDER_SERVICE Packed into a dbus_uint32_t */
4593 #define DBUS_HEADER_FIELD_SENDER_SERVICE_AS_UINT32 \
4594 FOUR_CHARS_TO_UINT32 ('s', 'd', 'r', 's')
4597 decode_string_field (const DBusString *data,
4598 HeaderField fields[FIELD_LAST],
4602 const char *field_name)
4605 int string_data_pos;
4607 if (fields[field].offset >= 0)
4609 _dbus_verbose ("%s field provided twice\n",
4614 if (type != DBUS_TYPE_STRING)
4616 _dbus_verbose ("%s field has wrong type %s\n",
4617 field_name, _dbus_type_to_string (type));
4621 /* skip padding after typecode, skip string length;
4622 * we assume that the string arg has already been validated
4623 * for sanity and UTF-8
4625 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4626 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4628 _dbus_string_init_const (&tmp,
4629 _dbus_string_get_const_data (data) + string_data_pos);
4631 if (field == FIELD_INTERFACE)
4633 if (!_dbus_string_validate_interface (&tmp, 0, _dbus_string_get_length (&tmp)))
4635 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4636 field_name, _dbus_string_get_const_data (&tmp));
4640 if (_dbus_string_equal_c_str (&tmp,
4641 DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL))
4643 _dbus_verbose ("Message is on the local interface\n");
4647 else if (field == FIELD_MEMBER)
4649 if (!_dbus_string_validate_member (&tmp, 0, _dbus_string_get_length (&tmp)))
4651 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4652 field_name, _dbus_string_get_const_data (&tmp));
4656 else if (field == FIELD_ERROR_NAME)
4658 if (!_dbus_string_validate_error_name (&tmp, 0, _dbus_string_get_length (&tmp)))
4660 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4661 field_name, _dbus_string_get_const_data (&tmp));
4665 else if (field == FIELD_SERVICE ||
4666 field == FIELD_SENDER_SERVICE)
4668 if (!_dbus_string_validate_service (&tmp, 0, _dbus_string_get_length (&tmp)))
4670 _dbus_verbose ("%s field has invalid content \"%s\"\n",
4671 field_name, _dbus_string_get_const_data (&tmp));
4677 _dbus_assert_not_reached ("Unknown field\n");
4680 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4683 _dbus_verbose ("Found field %s name at offset %d\n",
4684 field_name, fields[field].offset);
4691 decode_header_data (const DBusString *data,
4695 HeaderField fields[FIELD_LAST],
4696 int *message_padding)
4703 if (header_len < 16)
4705 _dbus_verbose ("Header length %d is too short\n", header_len);
4710 while (i < FIELD_LAST)
4712 fields[i].offset = -1;
4716 fields[FIELD_HEADER_LENGTH].offset = 4;
4717 fields[FIELD_BODY_LENGTH].offset = 8;
4718 fields[FIELD_CLIENT_SERIAL].offset = 12;
4720 /* Now handle the named fields. A real named field is at least 4
4721 * bytes for the name, plus a type code (1 byte) plus padding. So
4722 * if we have less than 8 bytes left, it must be alignment padding,
4723 * not a field. While >= 8 bytes can't be entirely alignment
4727 while ((pos + 7) < header_len)
4729 pos = _DBUS_ALIGN_VALUE (pos, 4);
4731 if ((pos + 4) > header_len)
4733 _dbus_verbose ("not enough space remains in header for header field value\n");
4737 field = _dbus_string_get_const_data_len (data, pos, 4);
4740 _dbus_assert (_DBUS_ALIGN_ADDRESS (field, 4) == field);
4742 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4744 _dbus_verbose ("Failed to validate type of named header field\n");
4748 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4750 _dbus_verbose ("Failed to validate argument to named header field\n");
4754 if (new_pos > header_len)
4756 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4760 switch (DBUS_UINT32_FROM_BE (*(int*)field))
4762 case DBUS_HEADER_FIELD_SERVICE_AS_UINT32:
4763 if (!decode_string_field (data, fields, pos, type,
4765 DBUS_HEADER_FIELD_SERVICE))
4769 case DBUS_HEADER_FIELD_INTERFACE_AS_UINT32:
4770 if (!decode_string_field (data, fields, pos, type,
4772 DBUS_HEADER_FIELD_INTERFACE))
4776 case DBUS_HEADER_FIELD_MEMBER_AS_UINT32:
4777 if (!decode_string_field (data, fields, pos, type,
4779 DBUS_HEADER_FIELD_MEMBER))
4783 case DBUS_HEADER_FIELD_ERROR_NAME_AS_UINT32:
4784 if (!decode_string_field (data, fields, pos, type,
4786 DBUS_HEADER_FIELD_ERROR_NAME))
4790 case DBUS_HEADER_FIELD_SENDER_SERVICE_AS_UINT32:
4791 if (!decode_string_field (data, fields, pos, type,
4792 FIELD_SENDER_SERVICE,
4793 DBUS_HEADER_FIELD_SENDER_SERVICE))
4797 case DBUS_HEADER_FIELD_PATH_AS_UINT32:
4799 /* Path was already validated as part of standard
4800 * type validation, since there's an OBJECT_PATH
4804 if (fields[FIELD_PATH].offset >= 0)
4806 _dbus_verbose ("%s field provided twice\n",
4807 DBUS_HEADER_FIELD_PATH);
4810 if (type != DBUS_TYPE_OBJECT_PATH)
4812 _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_PATH);
4816 fields[FIELD_PATH].offset = _DBUS_ALIGN_VALUE (pos, 4);
4818 /* No forging signals from the local path */
4821 s = _dbus_string_get_const_data_len (data,
4822 fields[FIELD_PATH].offset,
4823 _dbus_string_get_length (data) -
4824 fields[FIELD_PATH].offset);
4825 if (strcmp (s, DBUS_PATH_ORG_FREEDESKTOP_LOCAL) == 0)
4827 _dbus_verbose ("Message is on the local path\n");
4832 _dbus_verbose ("Found path at offset %d\n",
4833 fields[FIELD_PATH].offset);
4836 case DBUS_HEADER_FIELD_REPLY_AS_UINT32:
4837 if (fields[FIELD_REPLY_SERIAL].offset >= 0)
4839 _dbus_verbose ("%s field provided twice\n",
4840 DBUS_HEADER_FIELD_REPLY);
4844 if (type != DBUS_TYPE_UINT32)
4846 _dbus_verbose ("%s field has wrong type\n", DBUS_HEADER_FIELD_REPLY);
4850 fields[FIELD_REPLY_SERIAL].offset = _DBUS_ALIGN_VALUE (pos, 4);
4852 _dbus_verbose ("Found reply serial at offset %d\n",
4853 fields[FIELD_REPLY_SERIAL].offset);
4857 _dbus_verbose ("Ignoring an unknown header field: %.4s at offset %d\n",
4864 if (pos < header_len)
4866 /* Alignment padding, verify that it's nul */
4867 _dbus_assert ((header_len - pos) < 8);
4869 if (!_dbus_string_validate_nul (data,
4870 pos, (header_len - pos)))
4872 _dbus_verbose ("header alignment padding is not nul\n");
4877 /* Depending on message type, enforce presence of certain fields. */
4878 switch (message_type)
4880 case DBUS_MESSAGE_TYPE_SIGNAL:
4881 case DBUS_MESSAGE_TYPE_METHOD_CALL:
4882 if (fields[FIELD_PATH].offset < 0)
4884 _dbus_verbose ("No %s field provided\n",
4885 DBUS_HEADER_FIELD_PATH);
4888 /* FIXME make this optional, at least for method calls */
4889 if (fields[FIELD_INTERFACE].offset < 0)
4891 _dbus_verbose ("No %s field provided\n",
4892 DBUS_HEADER_FIELD_INTERFACE);
4895 if (fields[FIELD_MEMBER].offset < 0)
4897 _dbus_verbose ("No %s field provided\n",
4898 DBUS_HEADER_FIELD_MEMBER);
4902 case DBUS_MESSAGE_TYPE_ERROR:
4903 if (fields[FIELD_ERROR_NAME].offset < 0)
4905 _dbus_verbose ("No %s field provided\n",
4906 DBUS_HEADER_FIELD_ERROR_NAME);
4910 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
4913 /* An unknown type, spec requires us to ignore it */
4917 if (message_padding)
4918 *message_padding = header_len - pos;
4924 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
4925 * indicating to the loader how many bytes of the buffer were filled
4926 * in. This function must always be called, even if no bytes were
4927 * successfully read.
4929 * @param loader the loader.
4930 * @param buffer the buffer.
4931 * @param bytes_read number of bytes that were read into the buffer.
4934 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
4938 _dbus_assert (loader->buffer_outstanding);
4939 _dbus_assert (buffer == &loader->data);
4941 loader->buffer_outstanding = FALSE;
4945 * Converts buffered data into messages.
4947 * @todo we need to check that the proper named header fields exist
4948 * for each message type.
4950 * @todo If a message has unknown type, we should probably eat it
4951 * right here rather than passing it out to applications. However
4952 * it's not an error to see messages of unknown type.
4954 * @param loader the loader.
4955 * @returns #TRUE if we had enough memory to finish.
4958 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
4960 if (loader->corrupted)
4963 while (_dbus_string_get_length (&loader->data) >= 16)
4965 DBusMessage *message;
4966 const char *header_data;
4967 int byte_order, message_type, header_len, body_len, header_padding;
4968 dbus_uint32_t header_len_unsigned, body_len_unsigned;
4970 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
4972 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
4974 if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION)
4976 _dbus_verbose ("Message has protocol version %d ours is %d\n",
4977 (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION);
4978 loader->corrupted = TRUE;
4982 byte_order = header_data[BYTE_ORDER_OFFSET];
4984 if (byte_order != DBUS_LITTLE_ENDIAN &&
4985 byte_order != DBUS_BIG_ENDIAN)
4987 _dbus_verbose ("Message with bad byte order '%c' received\n",
4989 loader->corrupted = TRUE;
4993 /* Unknown types are ignored, but INVALID is
4996 message_type = header_data[TYPE_OFFSET];
4997 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
4999 _dbus_verbose ("Message with bad type '%d' received\n",
5001 loader->corrupted = TRUE;
5005 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
5006 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
5008 if (header_len_unsigned < 16)
5010 _dbus_verbose ("Message had broken too-small header length %u\n",
5011 header_len_unsigned);
5012 loader->corrupted = TRUE;
5016 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
5017 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
5019 _dbus_verbose ("Header or body length too large (%u %u)\n",
5020 header_len_unsigned,
5022 loader->corrupted = TRUE;
5026 /* Now that we know the values are in signed range, get
5027 * rid of stupid unsigned, just causes bugs
5029 header_len = header_len_unsigned;
5030 body_len = body_len_unsigned;
5032 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
5035 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
5037 loader->corrupted = TRUE;
5041 if (header_len + body_len > loader->max_message_size)
5043 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
5044 header_len, body_len, loader->max_message_size);
5045 loader->corrupted = TRUE;
5049 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
5051 HeaderField fields[FIELD_LAST];
5056 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
5058 if (!decode_header_data (&loader->data,
5059 header_len, byte_order,
5061 fields, &header_padding))
5063 _dbus_verbose ("Header was invalid\n");
5064 loader->corrupted = TRUE;
5068 next_arg = header_len;
5069 while (next_arg < (header_len + body_len))
5072 int prev = next_arg;
5074 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
5077 _dbus_verbose ("invalid typecode at offset %d\n", prev);
5078 loader->corrupted = TRUE;
5082 if (!_dbus_marshal_validate_arg (&loader->data,
5089 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
5090 loader->corrupted = TRUE;
5094 _dbus_assert (next_arg > prev);
5097 if (next_arg > (header_len + body_len))
5099 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
5100 next_arg, header_len, body_len,
5101 header_len + body_len);
5102 loader->corrupted = TRUE;
5106 message = dbus_message_new_empty_header ();
5107 if (message == NULL)
5109 _dbus_verbose ("Failed to allocate empty message\n");
5113 message->byte_order = byte_order;
5114 message->header_padding = header_padding;
5116 /* Copy in the offsets we found */
5118 while (i < FIELD_LAST)
5120 message->header_fields[i] = fields[i];
5124 if (!_dbus_list_append (&loader->messages, message))
5126 _dbus_verbose ("Failed to append new message to loader queue\n");
5127 dbus_message_unref (message);
5131 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
5132 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
5134 _dbus_assert (_dbus_string_get_length (&loader->data) >=
5135 (header_len + body_len));
5137 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
5139 _dbus_verbose ("Failed to move header into new message\n");
5140 _dbus_list_remove_last (&loader->messages, message);
5141 dbus_message_unref (message);
5145 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
5149 _dbus_verbose ("Failed to move body into new message\n");
5151 /* put the header back, we'll try again later */
5152 result = _dbus_string_copy_len (&message->header, 0, header_len,
5154 _dbus_assert (result); /* because DBusString never reallocs smaller */
5156 _dbus_list_remove_last (&loader->messages, message);
5157 dbus_message_unref (message);
5161 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
5162 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
5164 /* Fill in caches (we checked the types of these fields
5167 message->reply_serial = get_uint_field (message,
5168 FIELD_REPLY_SERIAL);
5169 message->client_serial = get_uint_field (message,
5170 FIELD_CLIENT_SERIAL);
5172 _dbus_verbose ("Loaded message %p\n", message);
5182 * Peeks at first loaded message, returns #NULL if no messages have
5185 * @param loader the loader.
5186 * @returns the next message, or #NULL if none.
5189 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
5191 if (loader->messages)
5192 return loader->messages->data;
5198 * Pops a loaded message (passing ownership of the message
5199 * to the caller). Returns #NULL if no messages have been
5202 * @param loader the loader.
5203 * @returns the next message, or #NULL if none.
5206 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
5208 return _dbus_list_pop_first (&loader->messages);
5212 * Pops a loaded message inside a list link (passing ownership of the
5213 * message and link to the caller). Returns #NULL if no messages have
5216 * @param loader the loader.
5217 * @returns the next message link, or #NULL if none.
5220 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
5222 return _dbus_list_pop_first_link (&loader->messages);
5226 * Returns a popped message link, used to undo a pop.
5228 * @param loader the loader
5229 * @param link the link with a message in it
5232 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
5235 _dbus_list_prepend_link (&loader->messages, link);
5239 * Checks whether the loader is confused due to bad data.
5240 * If messages are received that are invalid, the
5241 * loader gets confused and gives up permanently.
5242 * This state is called "corrupted."
5244 * @param loader the loader
5245 * @returns #TRUE if the loader is hosed.
5248 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
5250 return loader->corrupted;
5254 * Sets the maximum size message we allow.
5256 * @param loader the loader
5257 * @param size the max message size in bytes
5260 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
5263 if (size > MAX_SANE_MESSAGE_SIZE)
5265 _dbus_verbose ("clamping requested max message size %ld to %d\n",
5266 size, MAX_SANE_MESSAGE_SIZE);
5267 size = MAX_SANE_MESSAGE_SIZE;
5269 loader->max_message_size = size;
5273 * Gets the maximum allowed message size in bytes.
5275 * @param loader the loader
5276 * @returns max size in bytes
5279 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
5281 return loader->max_message_size;
5284 static DBusDataSlotAllocator slot_allocator;
5285 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
5288 * Allocates an integer ID to be used for storing application-specific
5289 * data on any DBusMessage. The allocated ID may then be used
5290 * with dbus_message_set_data() and dbus_message_get_data().
5291 * The passed-in slot must be initialized to -1, and is filled in
5292 * with the slot ID. If the passed-in slot is not -1, it's assumed
5293 * to be already allocated, and its refcount is incremented.
5295 * The allocated slot is global, i.e. all DBusMessage objects will
5296 * have a slot with the given integer ID reserved.
5298 * @param slot_p address of a global variable storing the slot
5299 * @returns #FALSE on failure (no memory)
5302 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
5304 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5305 _DBUS_LOCK_NAME (message_slots),
5310 * Deallocates a global ID for message data slots.
5311 * dbus_message_get_data() and dbus_message_set_data() may no
5312 * longer be used with this slot. Existing data stored on existing
5313 * DBusMessage objects will be freed when the message is
5314 * finalized, but may not be retrieved (and may only be replaced if
5315 * someone else reallocates the slot). When the refcount on the
5316 * passed-in slot reaches 0, it is set to -1.
5318 * @param slot_p address storing the slot to deallocate
5321 dbus_message_free_data_slot (dbus_int32_t *slot_p)
5323 _dbus_return_if_fail (*slot_p >= 0);
5325 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5329 * Stores a pointer on a DBusMessage, along
5330 * with an optional function to be used for freeing
5331 * the data when the data is set again, or when
5332 * the message is finalized. The slot number
5333 * must have been allocated with dbus_message_allocate_data_slot().
5335 * @param message the message
5336 * @param slot the slot number
5337 * @param data the data to store
5338 * @param free_data_func finalizer function for the data
5339 * @returns #TRUE if there was enough memory to store the data
5342 dbus_message_set_data (DBusMessage *message,
5345 DBusFreeFunction free_data_func)
5347 DBusFreeFunction old_free_func;
5351 _dbus_return_val_if_fail (message != NULL, FALSE);
5352 _dbus_return_val_if_fail (slot >= 0, FALSE);
5354 retval = _dbus_data_slot_list_set (&slot_allocator,
5355 &message->slot_list,
5356 slot, data, free_data_func,
5357 &old_free_func, &old_data);
5361 /* Do the actual free outside the message lock */
5363 (* old_free_func) (old_data);
5370 * Retrieves data previously set with dbus_message_set_data().
5371 * The slot must still be allocated (must not have been freed).
5373 * @param message the message
5374 * @param slot the slot to get data from
5375 * @returns the data, or #NULL if not found
5378 dbus_message_get_data (DBusMessage *message,
5383 _dbus_return_val_if_fail (message != NULL, NULL);
5385 res = _dbus_data_slot_list_get (&slot_allocator,
5386 &message->slot_list,
5393 #ifdef DBUS_BUILD_TESTS
5394 #include "dbus-test.h"
5398 message_iter_test (DBusMessage *message)
5400 DBusMessageIter iter, dict, array, array2;
5402 unsigned char *data;
5403 dbus_int32_t *our_int_array;
5406 dbus_message_iter_init (message, &iter);
5409 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
5410 _dbus_assert_not_reached ("Argument type isn't string");
5412 str = dbus_message_iter_get_string (&iter);
5413 if (strcmp (str, "Test string") != 0)
5414 _dbus_assert_not_reached ("Strings differ");
5417 if (!dbus_message_iter_next (&iter))
5418 _dbus_assert_not_reached ("Reached end of arguments");
5420 /* Signed integer tests */
5421 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
5422 _dbus_assert_not_reached ("Argument type isn't int32");
5424 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
5425 _dbus_assert_not_reached ("Signed integers differ");
5427 if (!dbus_message_iter_next (&iter))
5428 _dbus_assert_not_reached ("Reached end of fields");
5430 /* Unsigned integer tests */
5431 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5432 _dbus_assert_not_reached ("Argument type isn't int32");
5434 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
5435 _dbus_assert_not_reached ("Unsigned integers differ");
5437 if (!dbus_message_iter_next (&iter))
5438 _dbus_assert_not_reached ("Reached end of arguments");
5441 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
5442 _dbus_assert_not_reached ("Argument type isn't double");
5444 if (dbus_message_iter_get_double (&iter) != 3.14159)
5445 _dbus_assert_not_reached ("Doubles differ");
5447 if (!dbus_message_iter_next (&iter))
5448 _dbus_assert_not_reached ("Reached end of arguments");
5450 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
5451 _dbus_assert_not_reached ("Argument type not an array");
5453 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
5454 _dbus_assert_not_reached ("Array type not double");
5457 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
5458 _dbus_assert_not_reached ("Array init failed");
5460 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5461 _dbus_assert_not_reached ("Argument type isn't double");
5463 if (dbus_message_iter_get_double (&array) != 1.5)
5464 _dbus_assert_not_reached ("Unsigned integers differ");
5466 if (!dbus_message_iter_next (&array))
5467 _dbus_assert_not_reached ("Reached end of arguments");
5469 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5470 _dbus_assert_not_reached ("Argument type isn't double");
5472 if (dbus_message_iter_get_double (&array) != 2.5)
5473 _dbus_assert_not_reached ("Unsigned integers differ");
5475 if (dbus_message_iter_next (&array))
5476 _dbus_assert_not_reached ("Didn't reach end of arguments");
5478 if (!dbus_message_iter_next (&iter))
5479 _dbus_assert_not_reached ("Reached end of arguments");
5484 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5485 _dbus_assert_not_reached ("not dict type");
5487 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
5488 _dbus_assert_not_reached ("dict iter failed");
5490 str = dbus_message_iter_get_dict_key (&dict);
5491 if (str == NULL || strcmp (str, "test") != 0)
5492 _dbus_assert_not_reached ("wrong dict key");
5495 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5496 _dbus_assert_not_reached ("wrong dict entry type");
5498 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
5499 _dbus_assert_not_reached ("wrong dict entry value");
5501 if (!dbus_message_iter_next (&dict))
5502 _dbus_assert_not_reached ("reached end of dict");
5504 /* array of array of int32 (in dict) */
5506 str = dbus_message_iter_get_dict_key (&dict);
5507 if (str == NULL || strcmp (str, "array") != 0)
5508 _dbus_assert_not_reached ("wrong dict key");
5511 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
5512 _dbus_assert_not_reached ("Argument type not an array");
5514 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
5515 _dbus_assert_not_reached ("Array type not array");
5517 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
5518 _dbus_assert_not_reached ("Array init failed");
5520 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
5521 _dbus_assert_not_reached ("Argument type isn't array");
5523 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5524 _dbus_assert_not_reached ("Array type not int32");
5526 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
5527 _dbus_assert_not_reached ("Array init failed");
5529 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
5530 _dbus_assert_not_reached ("Argument type isn't int32");
5532 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
5533 _dbus_assert_not_reached ("Signed integers differ");
5535 if (!dbus_message_iter_next (&array2))
5536 _dbus_assert_not_reached ("Reached end of arguments");
5538 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
5539 _dbus_assert_not_reached ("Signed integers differ");
5541 if (dbus_message_iter_next (&array2))
5542 _dbus_assert_not_reached ("Didn't reached end of arguments");
5544 if (!dbus_message_iter_next (&array))
5545 _dbus_assert_not_reached ("Reached end of arguments");
5547 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5548 _dbus_assert_not_reached ("Array type not int32");
5550 if (!dbus_message_iter_get_int32_array (&array,
5553 _dbus_assert_not_reached ("couldn't get int32 array");
5555 _dbus_assert (len == 3);
5556 _dbus_assert (our_int_array[0] == 0x34567812 &&
5557 our_int_array[1] == 0x45678123 &&
5558 our_int_array[2] == 0x56781234);
5559 dbus_free (our_int_array);
5561 if (dbus_message_iter_next (&array))
5562 _dbus_assert_not_reached ("Didn't reach end of array");
5564 if (dbus_message_iter_next (&dict))
5565 _dbus_assert_not_reached ("Didn't reach end of dict");
5567 if (!dbus_message_iter_next (&iter))
5568 _dbus_assert_not_reached ("Reached end of arguments");
5570 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
5572 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
5573 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
5576 if (dbus_message_iter_get_byte (&iter) != 0xF0)
5577 _dbus_assert_not_reached ("wrong value after dict");
5580 if (!dbus_message_iter_next (&iter))
5581 _dbus_assert_not_reached ("Reached end of arguments");
5583 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
5584 _dbus_assert_not_reached ("not a nil type");
5586 if (!dbus_message_iter_next (&iter))
5587 _dbus_assert_not_reached ("Reached end of arguments");
5589 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
5590 _dbus_assert_not_reached ("wrong type after dict");
5592 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
5593 _dbus_assert_not_reached ("failed to get named");
5595 _dbus_assert (strcmp (str, "named")==0);
5596 _dbus_assert (len == 5);
5597 _dbus_assert (strcmp (data, "data")==0);
5601 if (dbus_message_iter_next (&iter))
5602 _dbus_assert_not_reached ("Didn't reach end of arguments");
5607 check_message_handling_type (DBusMessageIter *iter,
5610 DBusMessageIter child_iter;
5616 case DBUS_TYPE_BYTE:
5617 dbus_message_iter_get_byte (iter);
5619 case DBUS_TYPE_BOOLEAN:
5620 dbus_message_iter_get_boolean (iter);
5622 case DBUS_TYPE_INT32:
5623 dbus_message_iter_get_int32 (iter);
5625 case DBUS_TYPE_UINT32:
5626 dbus_message_iter_get_uint32 (iter);
5628 case DBUS_TYPE_INT64:
5629 #ifdef DBUS_HAVE_INT64
5630 dbus_message_iter_get_int64 (iter);
5633 case DBUS_TYPE_UINT64:
5634 #ifdef DBUS_HAVE_INT64
5635 dbus_message_iter_get_uint64 (iter);
5638 case DBUS_TYPE_DOUBLE:
5639 dbus_message_iter_get_double (iter);
5641 case DBUS_TYPE_STRING:
5644 str = dbus_message_iter_get_string (iter);
5647 _dbus_warn ("NULL string in message\n");
5653 case DBUS_TYPE_NAMED:
5656 unsigned char *data;
5659 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
5661 _dbus_warn ("error reading name from named type\n");
5668 case DBUS_TYPE_ARRAY:
5672 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
5674 _dbus_warn ("Failed to init array iterator\n");
5678 while (dbus_message_iter_has_next (&child_iter))
5680 if (!check_message_handling_type (&child_iter, array_type))
5682 _dbus_warn ("error in array element\n");
5686 if (!dbus_message_iter_next (&child_iter))
5691 case DBUS_TYPE_DICT:
5696 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
5698 _dbus_warn ("Failed to init dict iterator\n");
5702 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5704 key = dbus_message_iter_get_dict_key (&child_iter);
5707 _dbus_warn ("error reading dict key\n");
5712 if (!check_message_handling_type (&child_iter, entry_type))
5714 _dbus_warn ("error in dict value\n");
5718 if (!dbus_message_iter_next (&child_iter))
5725 _dbus_warn ("unknown type %d\n", type);
5734 check_message_handling (DBusMessage *message)
5736 DBusMessageIter iter;
5739 dbus_uint32_t client_serial;
5743 client_serial = dbus_message_get_serial (message);
5745 /* can't use set_serial due to the assertions at the start of it */
5746 set_uint_field (message, FIELD_CLIENT_SERIAL,
5749 if (client_serial != dbus_message_get_serial (message))
5751 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5755 /* If we implement message_set_arg (message, n, value)
5756 * then we would want to test it here
5759 dbus_message_iter_init (message, &iter);
5760 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5762 if (!check_message_handling_type (&iter, type))
5765 if (!dbus_message_iter_next (&iter))
5776 check_have_valid_message (DBusMessageLoader *loader)
5778 DBusMessage *message;
5784 if (!_dbus_message_loader_queue_messages (loader))
5785 _dbus_assert_not_reached ("no memory to queue messages");
5787 if (_dbus_message_loader_get_is_corrupted (loader))
5789 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5793 message = _dbus_message_loader_pop_message (loader);
5794 if (message == NULL)
5796 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5800 if (_dbus_string_get_length (&loader->data) > 0)
5802 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5806 /* Verify that we're able to properly deal with the message.
5807 * For example, this would detect improper handling of messages
5808 * in nonstandard byte order.
5810 if (!check_message_handling (message))
5817 dbus_message_unref (message);
5823 check_invalid_message (DBusMessageLoader *loader)
5829 if (!_dbus_message_loader_queue_messages (loader))
5830 _dbus_assert_not_reached ("no memory to queue messages");
5832 if (!_dbus_message_loader_get_is_corrupted (loader))
5834 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
5845 check_incomplete_message (DBusMessageLoader *loader)
5847 DBusMessage *message;
5853 if (!_dbus_message_loader_queue_messages (loader))
5854 _dbus_assert_not_reached ("no memory to queue messages");
5856 if (_dbus_message_loader_get_is_corrupted (loader))
5858 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
5862 message = _dbus_message_loader_pop_message (loader);
5863 if (message != NULL)
5865 _dbus_warn ("loaded message that was expected to be incomplete\n");
5873 dbus_message_unref (message);
5878 check_loader_results (DBusMessageLoader *loader,
5879 DBusMessageValidity validity)
5881 if (!_dbus_message_loader_queue_messages (loader))
5882 _dbus_assert_not_reached ("no memory to queue messages");
5886 case _DBUS_MESSAGE_VALID:
5887 return check_have_valid_message (loader);
5888 case _DBUS_MESSAGE_INVALID:
5889 return check_invalid_message (loader);
5890 case _DBUS_MESSAGE_INCOMPLETE:
5891 return check_incomplete_message (loader);
5892 case _DBUS_MESSAGE_UNKNOWN:
5896 _dbus_assert_not_reached ("bad DBusMessageValidity");
5902 * Loads the message in the given message file.
5904 * @param filename filename to load
5905 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5906 * @param data string to load message into
5907 * @returns #TRUE if the message was loaded
5910 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
5922 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
5923 dbus_error_init (&error);
5924 if (!_dbus_file_get_contents (data, filename, &error))
5926 _dbus_warn ("Could not load message file %s: %s\n",
5927 _dbus_string_get_const_data (filename),
5929 dbus_error_free (&error);
5935 if (!_dbus_message_data_load (data, filename))
5937 _dbus_warn ("Could not load message file %s\n",
5938 _dbus_string_get_const_data (filename));
5951 * Tries loading the message in the given message file
5952 * and verifies that DBusMessageLoader can handle it.
5954 * @param filename filename to load
5955 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5956 * @param expected_validity what the message has to be like to return #TRUE
5957 * @returns #TRUE if the message has the expected validity
5960 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
5962 DBusMessageValidity expected_validity)
5969 if (!_dbus_string_init (&data))
5970 _dbus_assert_not_reached ("could not allocate string\n");
5972 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
5976 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
5982 if (_dbus_string_get_length (&data) > 0)
5983 _dbus_verbose_bytes_of_string (&data, 0,
5984 _dbus_string_get_length (&data));
5986 _dbus_warn ("Failed message loader test on %s\n",
5987 _dbus_string_get_const_data (filename));
5990 _dbus_string_free (&data);
5996 * Tries loading the given message data.
5999 * @param data the message data
6000 * @param expected_validity what the message has to be like to return #TRUE
6001 * @returns #TRUE if the message has the expected validity
6004 dbus_internal_do_not_use_try_message_data (const DBusString *data,
6005 DBusMessageValidity expected_validity)
6007 DBusMessageLoader *loader;
6015 /* Write the data one byte at a time */
6017 loader = _dbus_message_loader_new ();
6019 /* check some trivial loader functions */
6020 _dbus_message_loader_ref (loader);
6021 _dbus_message_loader_unref (loader);
6022 _dbus_message_loader_get_max_message_size (loader);
6024 len = _dbus_string_get_length (data);
6025 for (i = 0; i < len; i++)
6029 _dbus_message_loader_get_buffer (loader, &buffer);
6030 _dbus_string_append_byte (buffer,
6031 _dbus_string_get_byte (data, i));
6032 _dbus_message_loader_return_buffer (loader, buffer, 1);
6035 if (!check_loader_results (loader, expected_validity))
6038 _dbus_message_loader_unref (loader);
6041 /* Write the data all at once */
6043 loader = _dbus_message_loader_new ();
6048 _dbus_message_loader_get_buffer (loader, &buffer);
6049 _dbus_string_copy (data, 0, buffer,
6050 _dbus_string_get_length (buffer));
6051 _dbus_message_loader_return_buffer (loader, buffer, 1);
6054 if (!check_loader_results (loader, expected_validity))
6057 _dbus_message_loader_unref (loader);
6060 /* Write the data 2 bytes at a time */
6062 loader = _dbus_message_loader_new ();
6064 len = _dbus_string_get_length (data);
6065 for (i = 0; i < len; i += 2)
6069 _dbus_message_loader_get_buffer (loader, &buffer);
6070 _dbus_string_append_byte (buffer,
6071 _dbus_string_get_byte (data, i));
6073 _dbus_string_append_byte (buffer,
6074 _dbus_string_get_byte (data, i+1));
6075 _dbus_message_loader_return_buffer (loader, buffer, 1);
6078 if (!check_loader_results (loader, expected_validity))
6081 _dbus_message_loader_unref (loader);
6089 _dbus_message_loader_unref (loader);
6095 process_test_subdir (const DBusString *test_base_dir,
6097 DBusMessageValidity validity,
6098 DBusForeachMessageFileFunc function,
6101 DBusString test_directory;
6102 DBusString filename;
6110 if (!_dbus_string_init (&test_directory))
6111 _dbus_assert_not_reached ("didn't allocate test_directory\n");
6113 _dbus_string_init_const (&filename, subdir);
6115 if (!_dbus_string_copy (test_base_dir, 0,
6116 &test_directory, 0))
6117 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
6119 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
6120 _dbus_assert_not_reached ("couldn't allocate full path");
6122 _dbus_string_free (&filename);
6123 if (!_dbus_string_init (&filename))
6124 _dbus_assert_not_reached ("didn't allocate filename string\n");
6126 dbus_error_init (&error);
6127 dir = _dbus_directory_open (&test_directory, &error);
6130 _dbus_warn ("Could not open %s: %s\n",
6131 _dbus_string_get_const_data (&test_directory),
6133 dbus_error_free (&error);
6137 printf ("Testing:\n");
6140 while (_dbus_directory_get_next_file (dir, &filename, &error))
6142 DBusString full_path;
6145 if (!_dbus_string_init (&full_path))
6146 _dbus_assert_not_reached ("couldn't init string");
6148 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
6149 _dbus_assert_not_reached ("couldn't copy dir to full_path");
6151 if (!_dbus_concat_dir_and_file (&full_path, &filename))
6152 _dbus_assert_not_reached ("couldn't concat file to dir");
6154 if (_dbus_string_ends_with_c_str (&filename, ".message"))
6156 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
6160 _dbus_verbose ("Skipping non-.message file %s\n",
6161 _dbus_string_get_const_data (&filename));
6162 _dbus_string_free (&full_path);
6167 _dbus_string_get_const_data (&filename));
6169 _dbus_verbose (" expecting %s for %s\n",
6170 validity == _DBUS_MESSAGE_VALID ? "valid" :
6171 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
6172 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")),
6173 _dbus_string_get_const_data (&filename));
6175 if (! (*function) (&full_path, is_raw, validity, user_data))
6177 _dbus_string_free (&full_path);
6181 _dbus_string_free (&full_path);
6184 if (dbus_error_is_set (&error))
6186 _dbus_warn ("Could not get next file in %s: %s\n",
6187 _dbus_string_get_const_data (&test_directory),
6189 dbus_error_free (&error);
6198 _dbus_directory_close (dir);
6199 _dbus_string_free (&test_directory);
6200 _dbus_string_free (&filename);
6206 * Runs the given function on every message file in the test suite.
6207 * The function should return #FALSE on test failure or fatal error.
6209 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
6210 * @param func the function to run
6211 * @param user_data data for function
6212 * @returns #FALSE if there's a failure
6215 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
6216 DBusForeachMessageFileFunc func,
6219 DBusString test_directory;
6224 _dbus_string_init_const (&test_directory, test_data_dir);
6226 if (!process_test_subdir (&test_directory, "valid-messages",
6227 _DBUS_MESSAGE_VALID, func, user_data))
6230 if (!process_test_subdir (&test_directory, "invalid-messages",
6231 _DBUS_MESSAGE_INVALID, func, user_data))
6234 if (!process_test_subdir (&test_directory, "incomplete-messages",
6235 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
6242 _dbus_string_free (&test_directory);
6248 verify_test_message (DBusMessage *message)
6250 DBusMessageIter iter, dict;
6252 dbus_int32_t our_int;
6255 dbus_bool_t our_bool;
6256 dbus_uint32_t our_uint32;
6257 dbus_int32_t *our_uint32_array;
6258 int our_uint32_array_len;
6259 dbus_int32_t *our_int32_array;
6260 int our_int32_array_len;
6261 char **our_string_array;
6262 int our_string_array_len;
6263 #ifdef DBUS_HAVE_INT64
6264 dbus_int64_t our_int64;
6265 dbus_uint64_t our_uint64;
6266 dbus_int64_t *our_uint64_array;
6267 int our_uint64_array_len;
6268 dbus_int64_t *our_int64_array;
6269 int our_int64_array_len;
6271 double *our_double_array;
6272 int our_double_array_len;
6273 unsigned char *our_byte_array;
6274 int our_byte_array_len;
6275 unsigned char *our_boolean_array;
6276 int our_boolean_array_len;
6278 dbus_message_iter_init (message, &iter);
6280 dbus_error_init (&error);
6281 if (!dbus_message_iter_get_args (&iter, &error,
6282 DBUS_TYPE_INT32, &our_int,
6283 #ifdef DBUS_HAVE_INT64
6284 DBUS_TYPE_INT64, &our_int64,
6285 DBUS_TYPE_UINT64, &our_uint64,
6287 DBUS_TYPE_STRING, &our_str,
6288 DBUS_TYPE_DOUBLE, &our_double,
6289 DBUS_TYPE_BOOLEAN, &our_bool,
6290 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
6291 &our_uint32_array, &our_uint32_array_len,
6292 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
6293 &our_int32_array, &our_int32_array_len,
6294 #ifdef DBUS_HAVE_INT64
6295 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
6296 &our_uint64_array, &our_uint64_array_len,
6297 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
6298 &our_int64_array, &our_int64_array_len,
6300 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
6301 &our_string_array, &our_string_array_len,
6302 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
6303 &our_double_array, &our_double_array_len,
6304 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
6305 &our_byte_array, &our_byte_array_len,
6306 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
6307 &our_boolean_array, &our_boolean_array_len,
6310 _dbus_warn ("error: %s - %s\n", error.name,
6311 (error.message != NULL) ? error.message : "no message");
6312 _dbus_assert_not_reached ("Could not get arguments");
6315 if (our_int != -0x12345678)
6316 _dbus_assert_not_reached ("integers differ!");
6318 #ifdef DBUS_HAVE_INT64
6319 if (our_int64 != -0x123456789abcd)
6320 _dbus_assert_not_reached ("64-bit integers differ!");
6321 if (our_uint64 != 0x123456789abcd)
6322 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
6325 if (our_double != 3.14159)
6326 _dbus_assert_not_reached ("doubles differ!");
6328 if (strcmp (our_str, "Test string") != 0)
6329 _dbus_assert_not_reached ("strings differ!");
6330 dbus_free (our_str);
6333 _dbus_assert_not_reached ("booleans differ");
6335 if (our_uint32_array_len != 4 ||
6336 our_uint32_array[0] != 0x12345678 ||
6337 our_uint32_array[1] != 0x23456781 ||
6338 our_uint32_array[2] != 0x34567812 ||
6339 our_uint32_array[3] != 0x45678123)
6340 _dbus_assert_not_reached ("uint array differs");
6341 dbus_free (our_uint32_array);
6343 if (our_int32_array_len != 4 ||
6344 our_int32_array[0] != 0x12345678 ||
6345 our_int32_array[1] != -0x23456781 ||
6346 our_int32_array[2] != 0x34567812 ||
6347 our_int32_array[3] != -0x45678123)
6348 _dbus_assert_not_reached ("int array differs");
6349 dbus_free (our_int32_array);
6351 #ifdef DBUS_HAVE_INT64
6352 if (our_uint64_array_len != 4 ||
6353 our_uint64_array[0] != 0x12345678 ||
6354 our_uint64_array[1] != 0x23456781 ||
6355 our_uint64_array[2] != 0x34567812 ||
6356 our_uint64_array[3] != 0x45678123)
6357 _dbus_assert_not_reached ("uint64 array differs");
6358 dbus_free (our_uint64_array);
6360 if (our_int64_array_len != 4 ||
6361 our_int64_array[0] != 0x12345678 ||
6362 our_int64_array[1] != -0x23456781 ||
6363 our_int64_array[2] != 0x34567812 ||
6364 our_int64_array[3] != -0x45678123)
6365 _dbus_assert_not_reached ("int64 array differs");
6366 dbus_free (our_int64_array);
6367 #endif /* DBUS_HAVE_INT64 */
6369 if (our_string_array_len != 4)
6370 _dbus_assert_not_reached ("string array has wrong length");
6372 if (strcmp (our_string_array[0], "Foo") != 0 ||
6373 strcmp (our_string_array[1], "bar") != 0 ||
6374 strcmp (our_string_array[2], "") != 0 ||
6375 strcmp (our_string_array[3], "woo woo woo woo") != 0)
6376 _dbus_assert_not_reached ("string array differs");
6378 dbus_free_string_array (our_string_array);
6380 if (our_double_array_len != 3)
6381 _dbus_assert_not_reached ("double array had wrong length");
6383 /* On all IEEE machines (i.e. everything sane) exact equality
6384 * should be preserved over the wire
6386 if (our_double_array[0] != 0.1234 ||
6387 our_double_array[1] != 9876.54321 ||
6388 our_double_array[2] != -300.0)
6389 _dbus_assert_not_reached ("double array had wrong values");
6391 dbus_free (our_double_array);
6393 if (our_byte_array_len != 4)
6394 _dbus_assert_not_reached ("byte array had wrong length");
6396 if (our_byte_array[0] != 'a' ||
6397 our_byte_array[1] != 'b' ||
6398 our_byte_array[2] != 'c' ||
6399 our_byte_array[3] != 234)
6400 _dbus_assert_not_reached ("byte array had wrong values");
6402 dbus_free (our_byte_array);
6404 if (our_boolean_array_len != 5)
6405 _dbus_assert_not_reached ("bool array had wrong length");
6407 if (our_boolean_array[0] != TRUE ||
6408 our_boolean_array[1] != FALSE ||
6409 our_boolean_array[2] != TRUE ||
6410 our_boolean_array[3] != TRUE ||
6411 our_boolean_array[4] != FALSE)
6412 _dbus_assert_not_reached ("bool array had wrong values");
6414 dbus_free (our_boolean_array);
6416 if (!dbus_message_iter_next (&iter))
6417 _dbus_assert_not_reached ("Reached end of arguments");
6419 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
6420 _dbus_assert_not_reached ("not dict type");
6422 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
6423 _dbus_assert_not_reached ("dict iter failed");
6425 our_str = dbus_message_iter_get_dict_key (&dict);
6426 if (our_str == NULL || strcmp (our_str, "test") != 0)
6427 _dbus_assert_not_reached ("wrong dict key");
6428 dbus_free (our_str);
6430 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
6432 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
6433 _dbus_assert_not_reached ("wrong dict entry type");
6436 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
6438 _dbus_verbose ("dict entry val: %x\n", our_uint32);
6439 _dbus_assert_not_reached ("wrong dict entry value");
6442 if (dbus_message_iter_next (&dict))
6443 _dbus_assert_not_reached ("Didn't reach end of dict");
6445 if (!dbus_message_iter_next (&iter))
6446 _dbus_assert_not_reached ("Reached end of arguments");
6448 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
6449 _dbus_assert_not_reached ("wrong type after dict");
6451 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
6452 _dbus_assert_not_reached ("wrong value after dict");
6454 if (dbus_message_iter_next (&iter))
6455 _dbus_assert_not_reached ("Didn't reach end of arguments");
6459 * @ingroup DBusMessageInternals
6460 * Unit test for DBusMessage.
6462 * @returns #TRUE on success.
6465 _dbus_message_test (const char *test_data_dir)
6467 DBusMessage *message;
6468 DBusMessageLoader *loader;
6469 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
6475 const dbus_uint32_t our_uint32_array[] =
6476 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6477 const dbus_uint32_t our_int32_array[] =
6478 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6479 #ifdef DBUS_HAVE_INT64
6480 const dbus_uint64_t our_uint64_array[] =
6481 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6482 const dbus_uint64_t our_int64_array[] =
6483 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6485 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
6486 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
6487 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
6488 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
6490 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
6492 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6493 "/org/freedesktop/TestPath",
6494 "Foo.TestInterface",
6496 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6497 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
6499 _dbus_message_set_serial (message, 1234);
6500 dbus_message_set_sender (message, "org.foo.bar");
6501 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar"));
6502 dbus_message_set_sender (message, NULL);
6503 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar"));
6504 _dbus_assert (dbus_message_get_serial (message) == 1234);
6505 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6507 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6508 dbus_message_set_no_reply (message, TRUE);
6509 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
6510 dbus_message_set_no_reply (message, FALSE);
6511 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6513 dbus_message_unref (message);
6515 /* Test the vararg functions */
6516 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6517 "/org/freedesktop/TestPath",
6518 "Foo.TestInterface",
6520 _dbus_message_set_serial (message, 1);
6521 dbus_message_append_args (message,
6522 DBUS_TYPE_INT32, -0x12345678,
6523 #ifdef DBUS_HAVE_INT64
6524 DBUS_TYPE_INT64, -0x123456789abcd,
6525 DBUS_TYPE_UINT64, 0x123456789abcd,
6527 DBUS_TYPE_STRING, "Test string",
6528 DBUS_TYPE_DOUBLE, 3.14159,
6529 DBUS_TYPE_BOOLEAN, TRUE,
6530 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
6531 _DBUS_N_ELEMENTS (our_uint32_array),
6532 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
6533 _DBUS_N_ELEMENTS (our_int32_array),
6534 #ifdef DBUS_HAVE_INT64
6535 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
6536 _DBUS_N_ELEMENTS (our_uint64_array),
6537 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
6538 _DBUS_N_ELEMENTS (our_int64_array),
6540 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
6541 _DBUS_N_ELEMENTS (our_string_array),
6542 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
6543 _DBUS_N_ELEMENTS (our_double_array),
6544 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
6545 _DBUS_N_ELEMENTS (our_byte_array),
6546 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
6547 _DBUS_N_ELEMENTS (our_boolean_array),
6550 dbus_message_append_iter_init (message, &iter);
6551 dbus_message_iter_append_dict (&iter, &child_iter);
6552 dbus_message_iter_append_dict_key (&child_iter, "test");
6553 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6554 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
6556 _dbus_verbose_bytes_of_string (&message->header, 0,
6557 _dbus_string_get_length (&message->header));
6558 _dbus_verbose_bytes_of_string (&message->body, 0,
6559 _dbus_string_get_length (&message->body));
6561 verify_test_message (message);
6563 copy = dbus_message_copy (message);
6565 _dbus_assert (message->client_serial == copy->client_serial);
6566 _dbus_assert (message->reply_serial == copy->reply_serial);
6567 _dbus_assert (message->header_padding == copy->header_padding);
6569 _dbus_assert (_dbus_string_get_length (&message->header) ==
6570 _dbus_string_get_length (©->header));
6572 _dbus_assert (_dbus_string_get_length (&message->body) ==
6573 _dbus_string_get_length (©->body));
6575 verify_test_message (copy);
6577 name1 = dbus_message_get_interface (message);
6578 name2 = dbus_message_get_interface (copy);
6580 _dbus_assert (strcmp (name1, name2) == 0);
6582 name1 = dbus_message_get_member (message);
6583 name2 = dbus_message_get_member (copy);
6585 _dbus_assert (strcmp (name1, name2) == 0);
6587 dbus_message_unref (message);
6588 dbus_message_unref (copy);
6590 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6591 "/org/freedesktop/TestPath",
6592 "Foo.TestInterface",
6595 _dbus_message_set_serial (message, 1);
6596 dbus_message_set_reply_serial (message, 0x12345678);
6598 dbus_message_append_iter_init (message, &iter);
6599 dbus_message_iter_append_string (&iter, "Test string");
6600 dbus_message_iter_append_int32 (&iter, -0x12345678);
6601 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
6602 dbus_message_iter_append_double (&iter, 3.14159);
6604 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
6605 dbus_message_iter_append_double (&child_iter, 1.5);
6606 dbus_message_iter_append_double (&child_iter, 2.5);
6609 dbus_message_iter_append_dict (&iter, &child_iter);
6610 dbus_message_iter_append_dict_key (&child_iter, "test");
6611 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6613 /* array of array of int32 (in dict) */
6614 dbus_message_iter_append_dict_key (&child_iter, "array");
6615 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
6616 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6617 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
6618 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
6619 _dbus_warn ("next call expected to fail with wrong array type\n");
6620 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
6621 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6622 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
6623 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
6624 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
6626 dbus_message_iter_append_byte (&iter, 0xF0);
6628 dbus_message_iter_append_nil (&iter);
6630 dbus_message_iter_append_named (&iter, "named",
6633 message_iter_test (message);
6635 /* Message loader test */
6636 _dbus_message_lock (message);
6637 loader = _dbus_message_loader_new ();
6639 /* check ref/unref */
6640 _dbus_message_loader_ref (loader);
6641 _dbus_message_loader_unref (loader);
6643 /* Write the header data one byte at a time */
6644 data = _dbus_string_get_const_data (&message->header);
6645 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
6649 _dbus_message_loader_get_buffer (loader, &buffer);
6650 _dbus_string_append_byte (buffer, data[i]);
6651 _dbus_message_loader_return_buffer (loader, buffer, 1);
6654 /* Write the body data one byte at a time */
6655 data = _dbus_string_get_const_data (&message->body);
6656 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
6660 _dbus_message_loader_get_buffer (loader, &buffer);
6661 _dbus_string_append_byte (buffer, data[i]);
6662 _dbus_message_loader_return_buffer (loader, buffer, 1);
6665 dbus_message_unref (message);
6667 /* Now pop back the message */
6668 if (!_dbus_message_loader_queue_messages (loader))
6669 _dbus_assert_not_reached ("no memory to queue messages");
6671 if (_dbus_message_loader_get_is_corrupted (loader))
6672 _dbus_assert_not_reached ("message loader corrupted");
6674 message = _dbus_message_loader_pop_message (loader);
6676 _dbus_assert_not_reached ("received a NULL message");
6678 if (dbus_message_get_reply_serial (message) != 0x12345678)
6679 _dbus_assert_not_reached ("reply serial fields differ");
6681 message_iter_test (message);
6683 dbus_message_unref (message);
6684 _dbus_message_loader_unref (loader);
6686 /* Now load every message in test_data_dir if we have one */
6687 if (test_data_dir == NULL)
6690 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6691 (DBusForeachMessageFileFunc)
6692 dbus_internal_do_not_use_try_message_file,
6696 #endif /* DBUS_BUILD_TESTS */