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.
46 * Cached information about a header field in the message
50 int offset; /**< Offset to start of field (location of name of field
55 /** Offset to byte order from start of header */
56 #define BYTE_ORDER_OFFSET 0
57 /** Offset to type from start of header */
59 /** Offset to flags from start of header */
60 #define FLAGS_OFFSET 2
61 /** Offset to version from start of header */
62 #define VERSION_OFFSET 3
63 /** Offset to header length from start of header */
64 #define HEADER_LENGTH_OFFSET 4
65 /** Offset to body length from start of header */
66 #define BODY_LENGTH_OFFSET 8
67 /** Offset to client serial from start of header */
68 #define CLIENT_SERIAL_OFFSET 12
72 * @brief Internals of DBusMessage
74 * Object representing a message received from or to be sent to
75 * another application. This is an opaque object, all members
80 DBusAtomic refcount; /**< Reference count */
82 DBusString header; /**< Header network data, stored
83 * separately from body so we can
84 * independently realloc it.
87 HeaderField header_fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location
88 * of each field in "header"
91 dbus_uint32_t client_serial; /**< Cached client serial value for speed */
92 dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
94 int header_padding; /**< bytes of alignment in header */
96 DBusString body; /**< Body network data. */
98 char byte_order; /**< Message byte order. */
100 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
101 long size_counter_delta; /**< Size we incremented the size counters by. */
103 dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
105 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
107 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
111 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
112 DBUS_MESSAGE_ITER_TYPE_ARRAY,
113 DBUS_MESSAGE_ITER_TYPE_DICT
116 /** typedef for internals of message iterator */
117 typedef struct DBusMessageRealIter DBusMessageRealIter;
120 * @brief Internals of DBusMessageIter
122 * Object representing a position in a message. All fields are internal.
124 struct DBusMessageRealIter
126 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
127 DBusMessage *message; /**< Message used */
128 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
130 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
131 int type; /**< type of iter */
133 int pos; /**< Current position in the string */
134 int end; /**< position right after the container */
135 int container_start; /**< offset of the start of the container */
136 int container_length_pos; /**< offset of the length of the container */
138 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
140 int array_type_pos; /**< pointer to the position of the array element type */
141 int array_type_done; /**< TRUE if the array type is fully finished */
145 * Gets the data to be sent over the network for this message.
146 * The header and then the body should be written out.
147 * This function is guaranteed to always return the same
148 * data once a message is locked (with _dbus_message_lock()).
150 * @param message the message.
151 * @param header return location for message header data.
152 * @param body return location for message body data.
155 _dbus_message_get_network_data (DBusMessage *message,
156 const DBusString **header,
157 const DBusString **body)
159 _dbus_assert (message->locked);
161 *header = &message->header;
162 *body = &message->body;
166 clear_header_padding (DBusMessage *message)
168 _dbus_string_shorten (&message->header,
169 message->header_padding);
170 message->header_padding = 0;
174 append_header_padding (DBusMessage *message)
177 old_len = _dbus_string_get_length (&message->header);
178 if (!_dbus_string_align_length (&message->header, 8))
181 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
187 adjust_field_offsets (DBusMessage *message,
197 while (i <= DBUS_HEADER_FIELD_LAST)
199 if (message->header_fields[i].offset > offsets_after)
200 message->header_fields[i].offset += delta;
206 #ifdef DBUS_BUILD_TESTS
207 /* tests-only until it's actually used */
209 get_int_field (DBusMessage *message,
214 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
216 offset = message->header_fields[field].offset;
219 return -1; /* useless if -1 is a valid value of course */
221 return _dbus_demarshal_int32 (&message->header,
229 get_uint_field (DBusMessage *message,
234 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
236 offset = message->header_fields[field].offset;
239 return -1; /* useless if -1 is a valid value of course */
241 return _dbus_demarshal_uint32 (&message->header,
248 get_string_field (DBusMessage *message,
255 offset = message->header_fields[field].offset;
257 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
262 /* offset points to string length, string data follows it */
263 /* FIXME _dbus_demarshal_const_string() that returned
264 * a reference to the string plus its len might be nice.
268 *len = _dbus_demarshal_uint32 (&message->header,
273 data = _dbus_string_get_const_data (&message->header);
275 return data + (offset + 4);
278 /* returns FALSE if no memory, TRUE with NULL path if no field */
280 get_path_field_decomposed (DBusMessage *message,
286 offset = message->header_fields[field].offset;
288 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
296 return _dbus_demarshal_object_path (&message->header,
303 #ifdef DBUS_BUILD_TESTS
305 append_int_field (DBusMessage *message,
311 _dbus_assert (!message->locked);
313 clear_header_padding (message);
315 orig_len = _dbus_string_get_length (&message->header);
317 if (!_dbus_string_align_length (&message->header, 4))
320 if (!_dbus_string_append_byte (&message->header, field))
323 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
326 if (!_dbus_string_align_length (&message->header, 4))
329 message->header_fields[field].offset =
330 _dbus_string_get_length (&message->header);
332 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
336 if (!append_header_padding (message))
342 message->header_fields[field].offset = -1;
343 _dbus_string_set_length (&message->header, orig_len);
345 /* this must succeed because it was allocated on function entry and
346 * DBusString doesn't ever realloc smaller
348 if (!append_header_padding (message))
349 _dbus_assert_not_reached ("failed to reappend header padding");
355 append_uint_field (DBusMessage *message,
361 _dbus_assert (!message->locked);
363 clear_header_padding (message);
365 orig_len = _dbus_string_get_length (&message->header);
367 if (!_dbus_string_align_length (&message->header, 4))
370 if (!_dbus_string_append_byte (&message->header, field))
373 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
376 if (!_dbus_string_align_length (&message->header, 4))
379 message->header_fields[field].offset =
380 _dbus_string_get_length (&message->header);
382 if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
386 if (!append_header_padding (message))
392 message->header_fields[field].offset = -1;
393 _dbus_string_set_length (&message->header, orig_len);
395 /* this must succeed because it was allocated on function entry and
396 * DBusString doesn't ever realloc smaller
398 if (!append_header_padding (message))
399 _dbus_assert_not_reached ("failed to reappend header padding");
404 append_string_field (DBusMessage *message,
411 _dbus_assert (!message->locked);
413 clear_header_padding (message);
415 orig_len = _dbus_string_get_length (&message->header);
417 if (!_dbus_string_align_length (&message->header, 4))
420 if (!_dbus_string_append_byte (&message->header, field))
423 if (!_dbus_string_append_byte (&message->header, type))
426 if (!_dbus_string_align_length (&message->header, 4))
429 message->header_fields[field].offset =
430 _dbus_string_get_length (&message->header);
432 if (!_dbus_marshal_string (&message->header, message->byte_order,
436 if (!append_header_padding (message))
442 message->header_fields[field].offset = -1;
443 _dbus_string_set_length (&message->header, orig_len);
445 /* this must succeed because it was allocated on function entry and
446 * DBusString doesn't ever realloc smaller
448 if (!append_header_padding (message))
449 _dbus_assert_not_reached ("failed to reappend header padding");
454 #ifdef DBUS_BUILD_TESTS
455 /* This isn't used, but building it when tests are enabled just to
456 * keep it compiling if we need it in future
459 delete_int_or_uint_field (DBusMessage *message,
462 int offset = message->header_fields[field].offset;
464 _dbus_assert (!message->locked);
469 clear_header_padding (message);
471 /* The field typecode and name take up 4 bytes */
472 _dbus_string_delete (&message->header,
476 message->header_fields[field].offset = -1;
478 adjust_field_offsets (message,
482 append_header_padding (message);
487 delete_string_field (DBusMessage *message,
490 int offset = message->header_fields[field].offset;
494 _dbus_assert (!message->locked);
499 clear_header_padding (message);
501 get_string_field (message, field, &len);
503 /* The field typecode and name take up 4 bytes, and the nul
504 * termination is 1 bytes, string length integer is 4 bytes
506 delete_len = 4 + 4 + 1 + len;
508 _dbus_string_delete (&message->header,
512 message->header_fields[field].offset = -1;
514 adjust_field_offsets (message,
518 append_header_padding (message);
521 #ifdef DBUS_BUILD_TESTS
523 set_int_field (DBusMessage *message,
527 int offset = message->header_fields[field].offset;
529 _dbus_assert (!message->locked);
533 /* need to append the field */
538 _dbus_assert_not_reached ("appending an int field we don't support appending");
544 _dbus_marshal_set_int32 (&message->header,
554 set_uint_field (DBusMessage *message,
558 int offset = message->header_fields[field].offset;
560 _dbus_assert (!message->locked);
564 /* need to append the field */
568 case DBUS_HEADER_FIELD_REPLY_SERIAL:
569 return append_uint_field (message, field, value);
572 _dbus_assert_not_reached ("appending a uint field we don't support appending");
578 _dbus_marshal_set_uint32 (&message->header,
587 set_string_field (DBusMessage *message,
592 int offset = message->header_fields[field].offset;
594 _dbus_assert (!message->locked);
595 _dbus_assert (value != NULL);
599 /* need to append the field */
603 case DBUS_HEADER_FIELD_PATH:
604 case DBUS_HEADER_FIELD_SENDER_SERVICE:
605 case DBUS_HEADER_FIELD_INTERFACE:
606 case DBUS_HEADER_FIELD_MEMBER:
607 case DBUS_HEADER_FIELD_ERROR_NAME:
608 case DBUS_HEADER_FIELD_SERVICE:
609 return append_string_field (message, field, type, value);
612 _dbus_assert_not_reached ("appending a string field we don't support appending");
623 clear_header_padding (message);
625 old_len = _dbus_string_get_length (&message->header);
627 len = strlen (value);
629 _dbus_string_init_const_len (&v, value,
630 len + 1); /* include nul */
631 if (!_dbus_marshal_set_string (&message->header,
637 new_len = _dbus_string_get_length (&message->header);
639 adjust_field_offsets (message,
643 if (!append_header_padding (message))
649 /* this must succeed because it was allocated on function entry and
650 * DBusString doesn't ever realloc smaller
652 if (!append_header_padding (message))
653 _dbus_assert_not_reached ("failed to reappend header padding");
660 * Sets the serial number of a message.
661 * This can only be done once on a message.
663 * @param message the message
664 * @param serial the serial
667 _dbus_message_set_serial (DBusMessage *message,
670 _dbus_assert (!message->locked);
671 _dbus_assert (dbus_message_get_serial (message) == 0);
673 _dbus_marshal_set_uint32 (&message->header,
675 CLIENT_SERIAL_OFFSET,
678 message->client_serial = serial;
682 * Sets the reply serial of a message (the client serial
683 * of the message this is a reply to).
685 * @param message the message
686 * @param reply_serial the client serial
687 * @returns #FALSE if not enough memory
690 dbus_message_set_reply_serial (DBusMessage *message,
691 dbus_uint32_t reply_serial)
693 _dbus_assert (!message->locked);
695 if (set_uint_field (message,
696 DBUS_HEADER_FIELD_REPLY_SERIAL,
699 message->reply_serial = reply_serial;
707 * Returns the serial of a message or -1 if none has been specified.
708 * The message's serial number is provided by the application sending
709 * the message and is used to identify replies to this message.
711 * @param message the message
712 * @returns the client serial
715 dbus_message_get_serial (DBusMessage *message)
717 return message->client_serial;
721 * Returns the serial that the message is
722 * a reply to or 0 if none.
724 * @param message the message
725 * @returns the reply serial
728 dbus_message_get_reply_serial (DBusMessage *message)
730 return message->reply_serial;
734 * Adds a counter to be incremented immediately with the
735 * size of this message, and decremented by the size
736 * of this message when this message if finalized.
737 * The link contains a counter with its refcount already
738 * incremented, but the counter itself not incremented.
739 * Ownership of link and counter refcount is passed to
742 * @param message the message
743 * @param link link with counter as data
746 _dbus_message_add_size_counter_link (DBusMessage *message,
749 /* right now we don't recompute the delta when message
750 * size changes, and that's OK for current purposes
751 * I think, but could be important to change later.
752 * Do recompute it whenever there are no outstanding counters,
753 * since it's basically free.
755 if (message->size_counters == NULL)
757 message->size_counter_delta =
758 _dbus_string_get_length (&message->header) +
759 _dbus_string_get_length (&message->body);
762 _dbus_verbose ("message has size %ld\n",
763 message->size_counter_delta);
767 _dbus_list_append_link (&message->size_counters, link);
769 _dbus_counter_adjust (link->data, message->size_counter_delta);
773 * Adds a counter to be incremented immediately with the
774 * size of this message, and decremented by the size
775 * of this message when this message if finalized.
777 * @param message the message
778 * @param counter the counter
779 * @returns #FALSE if no memory
782 _dbus_message_add_size_counter (DBusMessage *message,
783 DBusCounter *counter)
787 link = _dbus_list_alloc_link (counter);
791 _dbus_counter_ref (counter);
792 _dbus_message_add_size_counter_link (message, link);
798 * Removes a counter tracking the size of this message, and decrements
799 * the counter by the size of this message.
801 * @param message the message
802 * @param link_return return the link used
803 * @param counter the counter
806 _dbus_message_remove_size_counter (DBusMessage *message,
807 DBusCounter *counter,
808 DBusList **link_return)
812 link = _dbus_list_find_last (&message->size_counters,
814 _dbus_assert (link != NULL);
816 _dbus_list_unlink (&message->size_counters,
821 _dbus_list_free_link (link);
823 _dbus_counter_adjust (counter, message->size_counter_delta);
825 _dbus_counter_unref (counter);
829 dbus_message_create_header (DBusMessage *message,
833 const char *interface,
835 const char *error_name)
839 _dbus_assert ((interface && member) ||
841 !(interface || member || error_name));
843 if (!_dbus_string_append_byte (&message->header, message->byte_order))
846 if (!_dbus_string_append_byte (&message->header, type))
850 if (!_dbus_string_append_byte (&message->header, flags))
853 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
856 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
859 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
862 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
865 /* Marshal all the fields (Marshall Fields?) */
869 if (!append_string_field (message,
870 DBUS_HEADER_FIELD_PATH,
871 DBUS_TYPE_OBJECT_PATH,
878 if (!append_string_field (message,
879 DBUS_HEADER_FIELD_SERVICE,
885 if (interface != NULL)
887 if (!append_string_field (message,
888 DBUS_HEADER_FIELD_INTERFACE,
896 if (!append_string_field (message,
897 DBUS_HEADER_FIELD_MEMBER,
903 if (error_name != NULL)
905 if (!append_string_field (message,
906 DBUS_HEADER_FIELD_ERROR_NAME,
916 * Locks a message. Allows checking that applications don't keep a
917 * reference to a message in the outgoing queue and change it
918 * underneath us. Messages are locked when they enter the outgoing
919 * queue (dbus_connection_send_message()), and the library complains
920 * if the message is modified while locked.
922 * @param message the message to lock.
925 _dbus_message_lock (DBusMessage *message)
927 if (!message->locked)
929 /* Fill in our lengths */
930 _dbus_marshal_set_uint32 (&message->header,
932 HEADER_LENGTH_OFFSET,
933 _dbus_string_get_length (&message->header));
935 _dbus_marshal_set_uint32 (&message->header,
938 _dbus_string_get_length (&message->body));
940 message->locked = TRUE;
947 * @defgroup DBusMessage DBusMessage
949 * @brief Message to be sent or received over a DBusConnection.
951 * A DBusMessage is the most basic unit of communication over a
952 * DBusConnection. A DBusConnection represents a stream of messages
953 * received from a remote application, and a stream of messages
954 * sent to a remote application.
960 * @typedef DBusMessage
962 * Opaque data type representing a message received from or to be
963 * sent to another application.
967 dbus_message_new_empty_header (void)
969 DBusMessage *message;
972 message = dbus_new0 (DBusMessage, 1);
976 message->refcount.value = 1;
977 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
978 message->client_serial = 0;
979 message->reply_serial = 0;
981 _dbus_data_slot_list_init (&message->slot_list);
984 while (i <= DBUS_HEADER_FIELD_LAST)
986 message->header_fields[i].offset = -1;
990 if (!_dbus_string_init_preallocated (&message->header, 64))
996 if (!_dbus_string_init_preallocated (&message->body, 64))
998 _dbus_string_free (&message->header);
1007 * Constructs a new message of the given message type.
1008 * Types include #DBUS_MESSAGE_TYPE_METHOD_CALL,
1009 * #DBUS_MESSAGE_TYPE_SIGNAL, and so forth.
1011 * @param message_type type of message
1012 * @returns new message or #NULL If no memory
1015 dbus_message_new (int message_type)
1017 DBusMessage *message;
1019 _dbus_return_val_if_fail (message_type != DBUS_MESSAGE_TYPE_INVALID, NULL);
1021 message = dbus_message_new_empty_header ();
1022 if (message == NULL)
1025 if (!dbus_message_create_header (message,
1027 NULL, NULL, NULL, NULL, NULL))
1029 dbus_message_unref (message);
1037 * Constructs a new message to invoke a method on a remote
1038 * object. Returns #NULL if memory can't be allocated for the
1039 * message. The service may be #NULL in which case no service is set;
1040 * this is appropriate when using D-BUS in a peer-to-peer context (no
1041 * message bus). The interface may be #NULL, which means that
1042 * if multiple methods with the given name exist it is undefined
1043 * which one will be invoked.
1045 * @param service service that the message should be sent to or #NULL
1046 * @param path object path the message should be sent to
1047 * @param interface interface to invoke method on
1048 * @param method method to invoke
1050 * @returns a new DBusMessage, free with dbus_message_unref()
1051 * @see dbus_message_unref()
1054 dbus_message_new_method_call (const char *service,
1056 const char *interface,
1059 DBusMessage *message;
1061 _dbus_return_val_if_fail (path != NULL, NULL);
1062 _dbus_return_val_if_fail (method != NULL, NULL);
1064 message = dbus_message_new_empty_header ();
1065 if (message == NULL)
1068 if (!dbus_message_create_header (message,
1069 DBUS_MESSAGE_TYPE_METHOD_CALL,
1070 service, path, interface, method, NULL))
1072 dbus_message_unref (message);
1080 * Constructs a message that is a reply to a method call. Returns
1081 * #NULL if memory can't be allocated for the message.
1083 * @param method_call the message which the created
1084 * message is a reply to.
1085 * @returns a new DBusMessage, free with dbus_message_unref()
1086 * @see dbus_message_new_method_call(), dbus_message_unref()
1089 dbus_message_new_method_return (DBusMessage *method_call)
1091 DBusMessage *message;
1094 _dbus_return_val_if_fail (method_call != NULL, NULL);
1096 sender = get_string_field (method_call,
1097 DBUS_HEADER_FIELD_SENDER_SERVICE,
1100 /* sender is allowed to be null here in peer-to-peer case */
1102 message = dbus_message_new_empty_header ();
1103 if (message == NULL)
1106 if (!dbus_message_create_header (message,
1107 DBUS_MESSAGE_TYPE_METHOD_RETURN,
1108 sender, NULL, NULL, NULL, NULL))
1110 dbus_message_unref (message);
1114 if (!dbus_message_set_reply_serial (message,
1115 dbus_message_get_serial (method_call)))
1117 dbus_message_unref (message);
1125 * Constructs a new message representing a signal emission. Returns
1126 * #NULL if memory can't be allocated for the message.
1127 * A signal is identified by its originating interface, and
1128 * the name of the signal.
1130 * @param path the path to the object emitting the signal
1131 * @param interface the interface the signal is emitted from
1132 * @param name name of the signal
1133 * @returns a new DBusMessage, free with dbus_message_unref()
1134 * @see dbus_message_unref()
1137 dbus_message_new_signal (const char *path,
1138 const char *interface,
1141 DBusMessage *message;
1143 _dbus_return_val_if_fail (path != NULL, NULL);
1144 _dbus_return_val_if_fail (interface != NULL, NULL);
1145 _dbus_return_val_if_fail (name != NULL, NULL);
1147 message = dbus_message_new_empty_header ();
1148 if (message == NULL)
1151 if (!dbus_message_create_header (message,
1152 DBUS_MESSAGE_TYPE_SIGNAL,
1153 NULL, path, interface, name, NULL))
1155 dbus_message_unref (message);
1163 * Creates a new message that is an error reply to a certain message.
1164 * Error replies are possible in response to method calls primarily.
1166 * @param reply_to the original message
1167 * @param error_name the error name
1168 * @param error_message the error message string or #NULL for none
1169 * @returns a new error message
1172 dbus_message_new_error (DBusMessage *reply_to,
1173 const char *error_name,
1174 const char *error_message)
1176 DBusMessage *message;
1178 DBusMessageIter iter;
1180 _dbus_return_val_if_fail (reply_to != NULL, NULL);
1181 _dbus_return_val_if_fail (error_name != NULL, NULL);
1183 sender = get_string_field (reply_to,
1184 DBUS_HEADER_FIELD_SENDER_SERVICE,
1187 /* sender may be NULL for non-message-bus case or
1188 * when the message bus is dealing with an unregistered
1191 message = dbus_message_new_empty_header ();
1192 if (message == NULL)
1195 if (!dbus_message_create_header (message,
1196 DBUS_MESSAGE_TYPE_ERROR,
1197 sender, NULL, NULL, NULL, error_name))
1199 dbus_message_unref (message);
1203 if (!dbus_message_set_reply_serial (message,
1204 dbus_message_get_serial (reply_to)))
1206 dbus_message_unref (message);
1210 if (error_message != NULL)
1212 dbus_message_append_iter_init (message, &iter);
1213 if (!dbus_message_iter_append_string (&iter, error_message))
1215 dbus_message_unref (message);
1224 * Creates a new message that is an exact replica of the message
1225 * specified, except that its refcount is set to 1.
1227 * @param message the message.
1228 * @returns the new message.
1231 dbus_message_copy (const DBusMessage *message)
1233 DBusMessage *retval;
1236 _dbus_return_val_if_fail (message != NULL, NULL);
1238 retval = dbus_new0 (DBusMessage, 1);
1242 retval->refcount.value = 1;
1243 retval->byte_order = message->byte_order;
1244 retval->client_serial = message->client_serial;
1245 retval->reply_serial = message->reply_serial;
1246 retval->header_padding = message->header_padding;
1247 retval->locked = FALSE;
1249 if (!_dbus_string_init (&retval->header))
1255 if (!_dbus_string_init (&retval->body))
1257 _dbus_string_free (&retval->header);
1262 if (!_dbus_string_copy (&message->header, 0,
1263 &retval->header, 0))
1265 _dbus_string_free (&retval->header);
1266 _dbus_string_free (&retval->body);
1272 if (!_dbus_string_copy (&message->body, 0,
1275 _dbus_string_free (&retval->header);
1276 _dbus_string_free (&retval->body);
1282 for (i = 0; i <= DBUS_HEADER_FIELD_LAST; i++)
1284 retval->header_fields[i].offset = message->header_fields[i].offset;
1292 * Increments the reference count of a DBusMessage.
1294 * @param message The message
1295 * @see dbus_message_unref
1298 dbus_message_ref (DBusMessage *message)
1300 dbus_int32_t old_refcount;
1302 _dbus_return_if_fail (message != NULL);
1304 old_refcount = _dbus_atomic_inc (&message->refcount);
1305 _dbus_assert (old_refcount >= 1);
1309 free_size_counter (void *element,
1312 DBusCounter *counter = element;
1313 DBusMessage *message = data;
1315 _dbus_counter_adjust (counter, - message->size_counter_delta);
1317 _dbus_counter_unref (counter);
1321 * Decrements the reference count of a DBusMessage.
1323 * @param message The message
1324 * @see dbus_message_ref
1327 dbus_message_unref (DBusMessage *message)
1329 dbus_int32_t old_refcount;
1331 _dbus_return_if_fail (message != NULL);
1333 old_refcount = _dbus_atomic_dec (&message->refcount);
1335 _dbus_assert (old_refcount >= 0);
1337 if (old_refcount == 1)
1339 /* This calls application callbacks! */
1340 _dbus_data_slot_list_free (&message->slot_list);
1342 _dbus_list_foreach (&message->size_counters,
1343 free_size_counter, message);
1344 _dbus_list_clear (&message->size_counters);
1346 _dbus_string_free (&message->header);
1347 _dbus_string_free (&message->body);
1349 dbus_free (message);
1354 * Gets the type of a message. Types include
1355 * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN,
1356 * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types
1357 * are allowed and all code must silently ignore messages of unknown
1358 * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however.
1361 * @param message the message
1362 * @returns the type of the message
1365 dbus_message_get_type (DBusMessage *message)
1369 type = _dbus_string_get_byte (&message->header, 1);
1370 _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID);
1376 * Sets the object path this message is being sent to (for
1377 * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being
1378 * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL).
1380 * @param message the message
1381 * @param object_path the path
1382 * @returns #FALSE if not enough memory
1385 dbus_message_set_path (DBusMessage *message,
1386 const char *object_path)
1388 _dbus_return_val_if_fail (message != NULL, FALSE);
1389 _dbus_return_val_if_fail (!message->locked, FALSE);
1391 if (object_path == NULL)
1393 delete_string_field (message, DBUS_HEADER_FIELD_PATH);
1398 return set_string_field (message,
1399 DBUS_HEADER_FIELD_PATH,
1400 DBUS_TYPE_OBJECT_PATH,
1406 * Gets the object path this message is being sent to
1407 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1408 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1410 * @param message the message
1411 * @returns the path (should not be freed)
1414 dbus_message_get_path (DBusMessage *message)
1416 _dbus_return_val_if_fail (message != NULL, NULL);
1418 return get_string_field (message, DBUS_HEADER_FIELD_PATH, NULL);
1422 * Gets the object path this message is being sent to
1423 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1424 * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed
1425 * format (one array element per path component).
1426 * Free the returned array with dbus_free_string_array().
1428 * An empty but non-NULL path array means the path "/".
1429 * So the path "/foo/bar" becomes { "foo", "bar", NULL }
1430 * and the path "/" becomes { NULL }.
1432 * @param message the message
1433 * @param path place to store allocated array of path components; #NULL set here if no path field exists
1434 * @returns #FALSE if no memory to allocate the array
1437 dbus_message_get_path_decomposed (DBusMessage *message,
1440 _dbus_return_val_if_fail (message != NULL, FALSE);
1441 _dbus_return_val_if_fail (path != NULL, FALSE);
1443 return get_path_field_decomposed (message,
1444 DBUS_HEADER_FIELD_PATH,
1449 * Sets the interface this message is being sent to
1450 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or
1451 * the interface a signal is being emitted from
1452 * (for DBUS_MESSAGE_TYPE_SIGNAL).
1454 * @param message the message
1455 * @param interface the interface
1456 * @returns #FALSE if not enough memory
1459 dbus_message_set_interface (DBusMessage *message,
1460 const char *interface)
1462 _dbus_return_val_if_fail (message != NULL, FALSE);
1463 _dbus_return_val_if_fail (!message->locked, FALSE);
1465 if (interface == NULL)
1467 delete_string_field (message, DBUS_HEADER_FIELD_INTERFACE);
1472 return set_string_field (message,
1473 DBUS_HEADER_FIELD_INTERFACE,
1480 * Gets the interface this message is being sent to
1481 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1482 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1483 * The interface name is fully-qualified (namespaced).
1485 * @param message the message
1486 * @returns the message interface (should not be freed)
1489 dbus_message_get_interface (DBusMessage *message)
1491 _dbus_return_val_if_fail (message != NULL, NULL);
1493 return get_string_field (message, DBUS_HEADER_FIELD_INTERFACE, NULL);
1497 * Sets the interface member being invoked
1498 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1499 * (DBUS_MESSAGE_TYPE_SIGNAL).
1500 * The interface name is fully-qualified (namespaced).
1502 * @param message the message
1503 * @param member the member
1504 * @returns #FALSE if not enough memory
1507 dbus_message_set_member (DBusMessage *message,
1510 _dbus_return_val_if_fail (message != NULL, FALSE);
1511 _dbus_return_val_if_fail (!message->locked, FALSE);
1515 delete_string_field (message, DBUS_HEADER_FIELD_MEMBER);
1520 return set_string_field (message,
1521 DBUS_HEADER_FIELD_MEMBER,
1528 * Gets the interface member being invoked
1529 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1530 * (DBUS_MESSAGE_TYPE_SIGNAL).
1532 * @param message the message
1533 * @returns the member name (should not be freed)
1536 dbus_message_get_member (DBusMessage *message)
1538 _dbus_return_val_if_fail (message != NULL, NULL);
1540 return get_string_field (message,
1541 DBUS_HEADER_FIELD_MEMBER,
1546 * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
1547 * The name is fully-qualified (namespaced).
1549 * @param message the message
1550 * @param error_name the name
1551 * @returns #FALSE if not enough memory
1554 dbus_message_set_error_name (DBusMessage *message,
1555 const char *error_name)
1557 _dbus_return_val_if_fail (message != NULL, FALSE);
1558 _dbus_return_val_if_fail (!message->locked, FALSE);
1560 if (error_name == NULL)
1562 delete_string_field (message,
1563 DBUS_HEADER_FIELD_ERROR_NAME);
1568 return set_string_field (message,
1569 DBUS_HEADER_FIELD_ERROR_NAME,
1576 * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only).
1578 * @param message the message
1579 * @returns the error name (should not be freed)
1582 dbus_message_get_error_name (DBusMessage *message)
1584 _dbus_return_val_if_fail (message != NULL, NULL);
1586 return get_string_field (message,
1587 DBUS_HEADER_FIELD_ERROR_NAME,
1592 * Sets the message's destination service.
1594 * @param message the message
1595 * @param destination the destination service name
1596 * @returns #FALSE if not enough memory
1599 dbus_message_set_destination (DBusMessage *message,
1600 const char *destination)
1602 _dbus_return_val_if_fail (message != NULL, FALSE);
1603 _dbus_return_val_if_fail (!message->locked, FALSE);
1605 if (destination == NULL)
1607 delete_string_field (message, DBUS_HEADER_FIELD_SERVICE);
1612 return set_string_field (message,
1613 DBUS_HEADER_FIELD_SERVICE,
1620 * Gets the destination service of a message.
1622 * @param message the message
1623 * @returns the message destination service (should not be freed)
1626 dbus_message_get_destination (DBusMessage *message)
1628 _dbus_return_val_if_fail (message != NULL, NULL);
1630 return get_string_field (message,
1631 DBUS_HEADER_FIELD_SERVICE,
1636 * Appends fields to a message given a variable argument list. The
1637 * variable argument list should contain the type of the argument
1638 * followed by the value to add. Array values are specified by an int
1639 * typecode followed by a pointer to the array followed by an int
1640 * giving the length of the array. The argument list must be
1641 * terminated with #DBUS_TYPE_INVALID.
1643 * This function doesn't support dicts or non-fundamental arrays.
1645 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1646 * only if #DBUS_HAVE_INT64 is defined.
1648 * @param message the message
1649 * @param first_arg_type type of the first argument
1650 * @param ... value of first argument, list of additional type-value pairs
1651 * @returns #TRUE on success
1654 dbus_message_append_args (DBusMessage *message,
1661 _dbus_return_val_if_fail (message != NULL, FALSE);
1663 va_start (var_args, first_arg_type);
1664 retval = dbus_message_append_args_valist (message,
1673 * This function takes a va_list for use by language bindings.
1674 * It's otherwise the same as dbus_message_append_args().
1676 * @todo: Shouldn't this function clean up the changes to the message
1677 * on failures? (Yes)
1679 * @see dbus_message_append_args.
1680 * @param message the message
1681 * @param first_arg_type type of first argument
1682 * @param var_args value of first argument, then list of type/value pairs
1683 * @returns #TRUE on success
1686 dbus_message_append_args_valist (DBusMessage *message,
1691 DBusMessageIter iter;
1693 _dbus_return_val_if_fail (message != NULL, FALSE);
1695 old_len = _dbus_string_get_length (&message->body);
1697 type = first_arg_type;
1699 dbus_message_append_iter_init (message, &iter);
1706 if (!dbus_message_iter_append_nil (&iter))
1709 case DBUS_TYPE_BOOLEAN:
1710 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1713 case DBUS_TYPE_INT32:
1714 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1717 case DBUS_TYPE_UINT32:
1718 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1721 #ifdef DBUS_HAVE_INT64
1722 case DBUS_TYPE_INT64:
1723 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1726 case DBUS_TYPE_UINT64:
1727 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1730 #endif /* DBUS_HAVE_INT64 */
1731 case DBUS_TYPE_DOUBLE:
1732 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1735 case DBUS_TYPE_STRING:
1736 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1739 case DBUS_TYPE_NAMED:
1742 unsigned char *data;
1745 name = va_arg (var_args, const char *);
1746 data = va_arg (var_args, unsigned char *);
1747 len = va_arg (var_args, int);
1749 if (!dbus_message_iter_append_named (&iter, name, data, len))
1753 case DBUS_TYPE_ARRAY:
1758 type = va_arg (var_args, int);
1759 data = va_arg (var_args, void *);
1760 len = va_arg (var_args, int);
1764 case DBUS_TYPE_BYTE:
1765 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1768 case DBUS_TYPE_BOOLEAN:
1769 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1772 case DBUS_TYPE_INT32:
1773 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1776 case DBUS_TYPE_UINT32:
1777 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1780 #ifdef DBUS_HAVE_INT64
1781 case DBUS_TYPE_INT64:
1782 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1785 case DBUS_TYPE_UINT64:
1786 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1789 #endif /* DBUS_HAVE_INT64 */
1790 case DBUS_TYPE_DOUBLE:
1791 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1794 case DBUS_TYPE_STRING:
1795 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1799 case DBUS_TYPE_ARRAY:
1800 case DBUS_TYPE_NAMED:
1801 case DBUS_TYPE_DICT:
1802 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1805 _dbus_warn ("Unknown field type %d\n", type);
1811 case DBUS_TYPE_DICT:
1812 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1815 _dbus_warn ("Unknown field type %d\n", type);
1819 type = va_arg (var_args, int);
1830 * Gets arguments from a message given a variable argument list.
1831 * The variable argument list should contain the type of the
1832 * argumen followed by a pointer to where the value should be
1833 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1835 * @param message the message
1836 * @param error error to be filled in on failure
1837 * @param first_arg_type the first argument type
1838 * @param ... location for first argument value, then list of type-location pairs
1839 * @returns #FALSE if the error was set
1842 dbus_message_get_args (DBusMessage *message,
1850 _dbus_return_val_if_fail (message != NULL, FALSE);
1851 _dbus_return_val_if_error_is_set (error, FALSE);
1853 va_start (var_args, first_arg_type);
1854 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1861 * This function takes a va_list for use by language bindings
1863 * @todo We need to free the argument data when an error occurs.
1865 * @see dbus_message_get_args
1866 * @param message the message
1867 * @param error error to be filled in
1868 * @param first_arg_type type of the first argument
1869 * @param var_args return location for first argument, followed by list of type/location pairs
1870 * @returns #FALSE if error was set
1873 dbus_message_get_args_valist (DBusMessage *message,
1878 DBusMessageIter iter;
1880 _dbus_return_val_if_fail (message != NULL, FALSE);
1881 _dbus_return_val_if_error_is_set (error, FALSE);
1883 dbus_message_iter_init (message, &iter);
1884 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
1888 * Gets arguments from a message iterator given a variable argument list.
1889 * The variable argument list should contain the type of the
1890 * argumen followed by a pointer to where the value should be
1891 * stored. The list is terminated with 0.
1893 * @param iter the message iterator
1894 * @param error error to be filled in on failure
1895 * @param first_arg_type the first argument type
1896 * @param ... location for first argument value, then list of type-location pairs
1897 * @returns #FALSE if the error was set
1900 dbus_message_iter_get_args (DBusMessageIter *iter,
1908 _dbus_return_val_if_fail (iter != NULL, FALSE);
1909 _dbus_return_val_if_error_is_set (error, FALSE);
1911 va_start (var_args, first_arg_type);
1912 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
1919 * This function takes a va_list for use by language bindings
1921 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1922 * only if #DBUS_HAVE_INT64 is defined.
1924 * @todo this function (or some lower-level non-convenience function)
1925 * needs better error handling; should allow the application to
1926 * distinguish between out of memory, and bad data from the remote
1927 * app. It also needs to not leak a bunch of args when it gets
1928 * to the arg that's bad, as that would be a security hole
1929 * (allow one app to force another to leak memory)
1931 * @todo We need to free the argument data when an error occurs.
1933 * @see dbus_message_get_args
1934 * @param iter the message iter
1935 * @param error error to be filled in
1936 * @param first_arg_type type of the first argument
1937 * @param var_args return location for first argument, followed by list of type/location pairs
1938 * @returns #FALSE if error was set
1941 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
1946 int spec_type, msg_type, i;
1949 _dbus_return_val_if_fail (iter != NULL, FALSE);
1950 _dbus_return_val_if_error_is_set (error, FALSE);
1954 spec_type = first_arg_type;
1957 while (spec_type != 0)
1959 msg_type = dbus_message_iter_get_arg_type (iter);
1961 if (msg_type != spec_type)
1963 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
1964 "Argument %d is specified to be of type \"%s\", but "
1965 "is actually of type \"%s\"\n", i,
1966 _dbus_type_to_string (spec_type),
1967 _dbus_type_to_string (msg_type));
1976 case DBUS_TYPE_BYTE:
1980 ptr = va_arg (var_args, unsigned char *);
1982 *ptr = dbus_message_iter_get_byte (iter);
1985 case DBUS_TYPE_BOOLEAN:
1989 ptr = va_arg (var_args, dbus_bool_t *);
1991 *ptr = dbus_message_iter_get_boolean (iter);
1994 case DBUS_TYPE_INT32:
1998 ptr = va_arg (var_args, dbus_int32_t *);
2000 *ptr = dbus_message_iter_get_int32 (iter);
2003 case DBUS_TYPE_UINT32:
2007 ptr = va_arg (var_args, dbus_uint32_t *);
2009 *ptr = dbus_message_iter_get_uint32 (iter);
2012 #ifdef DBUS_HAVE_INT64
2013 case DBUS_TYPE_INT64:
2017 ptr = va_arg (var_args, dbus_int64_t *);
2019 *ptr = dbus_message_iter_get_int64 (iter);
2022 case DBUS_TYPE_UINT64:
2026 ptr = va_arg (var_args, dbus_uint64_t *);
2028 *ptr = dbus_message_iter_get_uint64 (iter);
2031 #endif /* DBUS_HAVE_INT64 */
2033 case DBUS_TYPE_DOUBLE:
2037 ptr = va_arg (var_args, double *);
2039 *ptr = dbus_message_iter_get_double (iter);
2043 case DBUS_TYPE_STRING:
2047 ptr = va_arg (var_args, char **);
2049 *ptr = dbus_message_iter_get_string (iter);
2053 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2060 case DBUS_TYPE_NAMED:
2063 unsigned char **data;
2066 name = va_arg (var_args, char **);
2067 data = va_arg (var_args, unsigned char **);
2068 len = va_arg (var_args, int *);
2070 if (!dbus_message_iter_get_named (iter, name, data, len))
2072 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2077 case DBUS_TYPE_ARRAY:
2082 type = va_arg (var_args, int);
2083 data = va_arg (var_args, void *);
2084 len = va_arg (var_args, int *);
2086 if (dbus_message_iter_get_array_type (iter) != type)
2088 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2089 "Argument %d is specified to be of type \"array of %s\", but "
2090 "is actually of type \"array of %s\"\n", i,
2091 _dbus_type_to_string (type),
2092 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
2098 case DBUS_TYPE_BYTE:
2099 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
2101 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2105 case DBUS_TYPE_BOOLEAN:
2106 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
2108 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2112 case DBUS_TYPE_INT32:
2113 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
2115 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2119 case DBUS_TYPE_UINT32:
2120 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
2122 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2126 #ifdef DBUS_HAVE_INT64
2127 case DBUS_TYPE_INT64:
2128 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
2130 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2134 case DBUS_TYPE_UINT64:
2135 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
2137 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2141 #endif /* DBUS_HAVE_INT64 */
2142 case DBUS_TYPE_DOUBLE:
2143 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
2145 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2149 case DBUS_TYPE_STRING:
2150 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
2152 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2157 case DBUS_TYPE_ARRAY:
2158 case DBUS_TYPE_NAMED:
2159 case DBUS_TYPE_DICT:
2160 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
2161 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2164 _dbus_warn ("Unknown field type %d\n", type);
2165 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2170 case DBUS_TYPE_DICT:
2171 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
2172 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2175 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2176 _dbus_warn ("Unknown field type %d\n", spec_type);
2180 spec_type = va_arg (var_args, int);
2181 if (spec_type != 0 && !dbus_message_iter_next (iter))
2183 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2184 "Message has only %d arguments, but more were expected", i);
2200 * Initializes a DBusMessageIter representing the arguments of the
2201 * message passed in.
2203 * @param message the message
2204 * @param iter pointer to an iterator to initialize
2207 dbus_message_iter_init (DBusMessage *message,
2208 DBusMessageIter *iter)
2210 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2212 _dbus_return_if_fail (message != NULL);
2213 _dbus_return_if_fail (iter != NULL);
2215 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
2217 real->message = message;
2218 real->parent_iter = NULL;
2219 real->changed_stamp = message->changed_stamp;
2221 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2223 real->end = _dbus_string_get_length (&message->body);
2225 real->container_start = 0;
2226 real->container_length_pos = 0;
2227 real->wrote_dict_key = 0;
2228 real->array_type_pos = 0;
2231 #ifndef DBUS_DISABLE_CHECKS
2233 dbus_message_iter_check (DBusMessageRealIter *iter)
2237 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
2241 if (iter->changed_stamp != iter->message->changed_stamp)
2243 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
2247 if (iter->pos < 0 || iter->pos > iter->end)
2249 _dbus_warn ("dbus iterator check failed: invalid position\n");
2255 #endif /* DBUS_DISABLE_CHECKS */
2258 skip_array_type (DBusMessageRealIter *iter, int pos)
2264 data = _dbus_string_get_const_data_len (&iter->message->body,
2267 while (*data == DBUS_TYPE_ARRAY);
2273 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
2280 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2281 data = _dbus_string_get_const_data_len (&iter->message->body,
2283 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2286 *type = DBUS_TYPE_INVALID;
2288 return skip_array_type (iter, iter->pos);
2290 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2291 data = _dbus_string_get_const_data_len (&iter->message->body,
2292 iter->array_type_pos, 1);
2293 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2296 *type = DBUS_TYPE_INVALID;
2300 case DBUS_MESSAGE_ITER_TYPE_DICT:
2301 /* Get the length of the string */
2302 len = _dbus_demarshal_uint32 (&iter->message->body,
2303 iter->message->byte_order,
2305 pos = pos + len + 1;
2307 data = _dbus_string_get_const_data_len (&iter->message->body,
2309 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2312 *type = DBUS_TYPE_INVALID;
2314 return skip_array_type (iter, pos);
2317 _dbus_assert_not_reached ("Invalid iter type");
2320 *type = DBUS_TYPE_INVALID;
2326 * Checks if an iterator has any more fields.
2328 * @param iter the message iter
2329 * @returns #TRUE if there are more fields
2333 dbus_message_iter_has_next (DBusMessageIter *iter)
2335 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2339 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2341 if (real->pos >= real->end)
2344 pos = dbus_message_iter_get_data_start (real, &type);
2346 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2347 real->message->byte_order,
2348 type, pos, &end_pos))
2351 if (end_pos >= real->end)
2358 * Moves the iterator to the next field.
2360 * @param iter The message iter
2361 * @returns #TRUE if the iterator was moved to the next field
2364 dbus_message_iter_next (DBusMessageIter *iter)
2366 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2370 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2372 pos = dbus_message_iter_get_data_start (real, &type);
2374 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2375 real->message->byte_order,
2376 type, pos, &end_pos))
2379 if (end_pos >= real->end)
2382 real->pos = end_pos;
2388 * Returns the argument type of the argument that the
2389 * message iterator points at.
2391 * @param iter the message iter
2392 * @returns the field type
2395 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
2397 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2400 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2402 if (real->pos >= real->end)
2403 return DBUS_TYPE_INVALID;
2405 pos = dbus_message_iter_get_data_start (real, &type);
2411 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2414 int _array_type_pos;
2419 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2420 _array_type_pos = iter->pos + 1;
2422 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2423 _array_type_pos = iter->array_type_pos + 1;
2425 case DBUS_MESSAGE_ITER_TYPE_DICT:
2426 /* Get the length of the string */
2427 len = _dbus_demarshal_uint32 (&iter->message->body,
2428 iter->message->byte_order,
2430 pos = pos + len + 1;
2431 data = _dbus_string_get_const_data_len (&iter->message->body,
2433 _array_type_pos = pos + 1;
2436 _dbus_assert_not_reached ("wrong iter type");
2437 return DBUS_TYPE_INVALID;
2440 if (array_type_pos != NULL)
2441 *array_type_pos = _array_type_pos;
2443 data = _dbus_string_get_const_data_len (&iter->message->body,
2444 _array_type_pos, 1);
2445 if (*data > DBUS_TYPE_INVALID && *data <= DBUS_TYPE_LAST)
2448 return DBUS_TYPE_INVALID;
2453 * Returns the element type of the array that the
2454 * message iterator points at. Note that you need
2455 * to check that the iterator points to an array
2456 * prior to using this function.
2458 * @param iter the message iter
2459 * @returns the field type
2462 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2464 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2467 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2469 if (real->pos >= real->end)
2470 return DBUS_TYPE_INVALID;
2472 pos = dbus_message_iter_get_data_start (real, &type);
2474 _dbus_assert (type == DBUS_TYPE_ARRAY);
2476 return iter_get_array_type (real, NULL);
2481 * Returns the string value that an iterator may point to.
2482 * Note that you need to check that the iterator points to
2483 * a string value before using this function.
2485 * @see dbus_message_iter_get_arg_type
2486 * @param iter the message iter
2487 * @returns the string
2490 dbus_message_iter_get_string (DBusMessageIter *iter)
2492 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2495 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2497 pos = dbus_message_iter_get_data_start (real, &type);
2499 _dbus_assert (type == DBUS_TYPE_STRING);
2501 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2506 * Returns the name and data from a named type that an
2507 * iterator may point to. Note that you need to check that
2508 * the iterator points to a named type before using this
2511 * @see dbus_message_iter_get_arg_type
2512 * @param iter the message iter
2513 * @param name return location for the name
2514 * @param value return location for data
2515 * @param len return location for length of data
2516 * @returns TRUE if get succeed
2520 dbus_message_iter_get_named (DBusMessageIter *iter,
2522 unsigned char **value,
2525 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2529 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2531 pos = dbus_message_iter_get_data_start (real, &type);
2533 _dbus_assert (type == DBUS_TYPE_NAMED);
2535 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2541 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2542 pos + 1, NULL, value, len))
2554 * Returns the byte value that an iterator may point to.
2555 * Note that you need to check that the iterator points to
2556 * a byte value before using this function.
2558 * @see dbus_message_iter_get_arg_type
2559 * @param iter the message iter
2560 * @returns the byte value
2563 dbus_message_iter_get_byte (DBusMessageIter *iter)
2565 unsigned char value;
2566 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2569 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2571 pos = dbus_message_iter_get_data_start (real, &type);
2573 _dbus_assert (type == DBUS_TYPE_BYTE);
2575 value = _dbus_string_get_byte (&real->message->body, pos);
2582 * Returns the boolean value that an iterator may point to.
2583 * Note that you need to check that the iterator points to
2584 * a boolean value before using this function.
2586 * @see dbus_message_iter_get_arg_type
2587 * @param iter the message iter
2588 * @returns the boolean value
2591 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2593 unsigned char value;
2594 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2597 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2599 pos = dbus_message_iter_get_data_start (real, &type);
2601 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2603 value = _dbus_string_get_byte (&real->message->body, pos);
2609 * Returns the 32 bit signed integer value that an iterator may point to.
2610 * Note that you need to check that the iterator points to
2611 * a 32-bit integer value before using this function.
2613 * @see dbus_message_iter_get_arg_type
2614 * @param iter the message iter
2615 * @returns the integer
2618 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2620 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2623 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2625 pos = dbus_message_iter_get_data_start (real, &type);
2627 _dbus_assert (type == DBUS_TYPE_INT32);
2629 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2634 * Returns the 32 bit unsigned integer value that an iterator may point to.
2635 * Note that you need to check that the iterator points to
2636 * a 32-bit unsigned integer value before using this function.
2638 * @see dbus_message_iter_get_arg_type
2639 * @param iter the message iter
2640 * @returns the integer
2643 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2645 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2648 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2650 pos = dbus_message_iter_get_data_start (real, &type);
2652 _dbus_assert (type == DBUS_TYPE_UINT32);
2654 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2658 #ifdef DBUS_HAVE_INT64
2661 * Returns the 64 bit signed integer value that an iterator may point
2662 * to. Note that you need to check that the iterator points to a
2663 * 64-bit integer value before using this function.
2665 * This function only exists if #DBUS_HAVE_INT64 is defined.
2667 * @see dbus_message_iter_get_arg_type
2668 * @param iter the message iter
2669 * @returns the integer
2672 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2674 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2677 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2679 pos = dbus_message_iter_get_data_start (real, &type);
2681 _dbus_assert (type == DBUS_TYPE_INT64);
2683 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2688 * Returns the 64 bit unsigned integer value that an iterator may point to.
2689 * Note that you need to check that the iterator points to
2690 * a 64-bit unsigned integer value before using this function.
2692 * This function only exists if #DBUS_HAVE_INT64 is defined.
2694 * @see dbus_message_iter_get_arg_type
2695 * @param iter the message iter
2696 * @returns the integer
2699 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2701 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2704 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2706 pos = dbus_message_iter_get_data_start (real, &type);
2708 _dbus_assert (type == DBUS_TYPE_UINT64);
2710 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2714 #endif /* DBUS_HAVE_INT64 */
2717 * Returns the double value that an iterator may point to.
2718 * Note that you need to check that the iterator points to
2719 * a string value before using this function.
2721 * @see dbus_message_iter_get_arg_type
2722 * @param iter the message iter
2723 * @returns the double
2726 dbus_message_iter_get_double (DBusMessageIter *iter)
2728 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2731 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2733 pos = dbus_message_iter_get_data_start (real, &type);
2735 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2737 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2742 * Initializes an iterator for the array that the iterator
2743 * may point to. Note that you need to check that the iterator
2744 * points to an array prior to using this function.
2746 * The array element type is returned in array_type, and the array
2747 * iterator can only be used to get that type of data.
2749 * @param iter the iterator
2750 * @param array_iter pointer to an iterator to initialize
2751 * @param array_type gets set to the type of the array elements
2752 * @returns #TRUE on success
2755 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2756 DBusMessageIter *array_iter,
2759 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2760 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2761 int type, pos, len_pos, len, array_type_pos;
2764 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2766 pos = dbus_message_iter_get_data_start (real, &type);
2768 _dbus_assert (type == DBUS_TYPE_ARRAY);
2770 _array_type = iter_get_array_type (real, &array_type_pos);
2772 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2773 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2776 array_real->parent_iter = real;
2777 array_real->message = real->message;
2778 array_real->changed_stamp = real->message->changed_stamp;
2780 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2781 array_real->pos = pos;
2782 array_real->end = pos + len;
2784 array_real->container_start = pos;
2785 array_real->container_length_pos = len_pos;
2786 array_real->wrote_dict_key = 0;
2787 array_real->array_type_pos = array_type_pos;
2788 array_real->array_type_done = TRUE;
2790 if (array_type != NULL)
2791 *array_type = _array_type;
2798 * Initializes an iterator for the dict that the iterator
2799 * may point to. Note that you need to check that the iterator
2800 * points to a dict prior to using this function.
2802 * @param iter the iterator
2803 * @param dict_iter pointer to an iterator to initialize
2804 * @returns #TRUE on success
2807 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2808 DBusMessageIter *dict_iter)
2810 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2811 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2812 int type, pos, len_pos, len;
2814 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2816 pos = dbus_message_iter_get_data_start (real, &type);
2818 _dbus_assert (type == DBUS_TYPE_DICT);
2820 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2821 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2824 dict_real->parent_iter = real;
2825 dict_real->message = real->message;
2826 dict_real->changed_stamp = real->message->changed_stamp;
2828 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2829 dict_real->pos = pos;
2830 dict_real->end = pos + len;
2832 dict_real->container_start = pos;
2833 dict_real->container_length_pos = len_pos;
2834 dict_real->wrote_dict_key = 0;
2840 * Returns the byte array that the iterator may point to.
2841 * Note that you need to check that the iterator points
2842 * to a byte array prior to using this function.
2844 * @param iter the iterator
2845 * @param value return location for array values
2846 * @param len return location for length of byte array
2847 * @returns #TRUE on success
2850 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2851 unsigned char **value,
2854 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2857 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2859 pos = dbus_message_iter_get_data_start (real, &type);
2861 _dbus_assert (type == DBUS_TYPE_ARRAY);
2863 type = iter_get_array_type (real, NULL);
2865 _dbus_assert (type == DBUS_TYPE_BYTE);
2867 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2868 pos, NULL, value, len))
2875 * Returns the boolean array that the iterator may point to. Note that
2876 * you need to check that the iterator points to an array of the
2877 * correct type prior to using this function.
2879 * @param iter the iterator
2880 * @param value return location for the array
2881 * @param len return location for the array length
2882 * @returns #TRUE on success
2885 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
2886 unsigned char **value,
2889 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2892 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2894 pos = dbus_message_iter_get_data_start (real, &type);
2896 _dbus_assert (type == DBUS_TYPE_ARRAY);
2898 type = iter_get_array_type (real, NULL);
2900 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2902 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2903 pos, NULL, value, len))
2910 * Returns the 32 bit signed integer array that the iterator may point
2911 * to. Note that you need to check that the iterator points to an
2912 * array of the correct type prior to using this function.
2914 * @param iter the iterator
2915 * @param value return location for the array
2916 * @param len return location for the array length
2917 * @returns #TRUE on success
2920 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
2921 dbus_int32_t **value,
2924 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2927 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2929 pos = dbus_message_iter_get_data_start (real, &type);
2931 _dbus_assert (type == DBUS_TYPE_ARRAY);
2933 type = iter_get_array_type (real, NULL);
2935 _dbus_assert (type == DBUS_TYPE_INT32);
2937 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
2938 pos, NULL, value, len))
2945 * Returns the 32 bit unsigned integer array that the iterator may point
2946 * to. Note that you need to check that the iterator points to an
2947 * array of the correct type prior to using this function.
2949 * @param iter the iterator
2950 * @param value return location for the array
2951 * @param len return location for the array length
2952 * @returns #TRUE on success
2955 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
2956 dbus_uint32_t **value,
2959 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2962 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2964 pos = dbus_message_iter_get_data_start (real, &type);
2966 _dbus_assert (type == DBUS_TYPE_ARRAY);
2968 type = iter_get_array_type (real, NULL);
2969 _dbus_assert (type == DBUS_TYPE_UINT32);
2971 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
2972 pos, NULL, value, len))
2978 #ifdef DBUS_HAVE_INT64
2981 * Returns the 64 bit signed integer array that the iterator may point
2982 * to. Note that you need to check that the iterator points to an
2983 * array of the correct type prior to using this function.
2985 * This function only exists if #DBUS_HAVE_INT64 is defined.
2987 * @param iter the iterator
2988 * @param value return location for the array
2989 * @param len return location for the array length
2990 * @returns #TRUE on success
2993 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
2994 dbus_int64_t **value,
2997 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3000 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3002 pos = dbus_message_iter_get_data_start (real, &type);
3004 _dbus_assert (type == DBUS_TYPE_ARRAY);
3006 type = iter_get_array_type (real, NULL);
3008 _dbus_assert (type == DBUS_TYPE_INT64);
3010 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
3011 pos, NULL, value, len))
3018 * Returns the 64 bit unsigned integer array that the iterator may point
3019 * to. Note that you need to check that the iterator points to an
3020 * array of the correct type prior to using this function.
3022 * This function only exists if #DBUS_HAVE_INT64 is defined.
3024 * @param iter the iterator
3025 * @param value return location for the array
3026 * @param len return location for the array length
3027 * @returns #TRUE on success
3030 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
3031 dbus_uint64_t **value,
3034 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3037 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3039 pos = dbus_message_iter_get_data_start (real, &type);
3041 _dbus_assert (type == DBUS_TYPE_ARRAY);
3043 type = iter_get_array_type (real, NULL);
3044 _dbus_assert (type == DBUS_TYPE_UINT64);
3046 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
3047 pos, NULL, value, len))
3053 #endif /* DBUS_HAVE_INT64 */
3056 * Returns the double array that the iterator may point to. Note that
3057 * you need to check that the iterator points to an array of the
3058 * correct type prior to using this function.
3060 * @param iter the iterator
3061 * @param value return location for the array
3062 * @param len return location for the array length
3063 * @returns #TRUE on success
3066 dbus_message_iter_get_double_array (DBusMessageIter *iter,
3070 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3073 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3075 pos = dbus_message_iter_get_data_start (real, &type);
3077 _dbus_assert (type == DBUS_TYPE_ARRAY);
3079 type = iter_get_array_type (real, NULL);
3080 _dbus_assert (type == DBUS_TYPE_DOUBLE);
3082 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
3083 pos, NULL, value, len))
3090 * Returns the string array that the iterator may point to.
3091 * Note that you need to check that the iterator points
3092 * to a byte array prior to using this function.
3094 * The returned value is a #NULL-terminated array of strings.
3095 * Each string is a separate malloc block, and the array
3096 * itself is a malloc block. You can free this type of
3097 * string array with dbus_free_string_array().
3099 * @param iter the iterator
3100 * @param value return location for string values
3101 * @param len return location for length of byte array
3102 * @returns #TRUE on success
3105 dbus_message_iter_get_string_array (DBusMessageIter *iter,
3109 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3112 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3114 pos = dbus_message_iter_get_data_start (real, &type);
3116 _dbus_assert (type == DBUS_TYPE_ARRAY);
3118 type = iter_get_array_type (real, NULL);
3119 _dbus_assert (type == DBUS_TYPE_STRING);
3121 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
3122 pos, NULL, value, len))
3129 * Returns the key name fot the dict entry that an iterator
3130 * may point to. Note that you need to check that the iterator
3131 * points to a dict entry before using this function.
3133 * @see dbus_message_iter_init_dict_iterator
3134 * @param iter the message iter
3135 * @returns the key name
3138 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
3140 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3142 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
3144 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3146 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
3151 * Initializes a DBusMessageIter pointing to the end of the
3152 * message. This iterator can be used to append data to the
3155 * @param message the message
3156 * @param iter pointer to an iterator to initialize
3159 dbus_message_append_iter_init (DBusMessage *message,
3160 DBusMessageIter *iter)
3162 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3164 _dbus_return_if_fail (message != NULL);
3165 _dbus_return_if_fail (iter != NULL);
3167 real->message = message;
3168 real->parent_iter = NULL;
3169 real->changed_stamp = message->changed_stamp;
3171 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
3172 real->end = _dbus_string_get_length (&real->message->body);
3173 real->pos = real->end;
3175 real->container_length_pos = 0;
3176 real->wrote_dict_key = 0;
3179 #ifndef DBUS_DISABLE_CHECKS
3181 dbus_message_iter_append_check (DBusMessageRealIter *iter)
3185 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
3189 if (iter->message->locked)
3191 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
3195 if (iter->changed_stamp != iter->message->changed_stamp)
3197 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
3201 if (iter->pos != iter->end)
3203 _dbus_warn ("dbus iterator check failed: can only append at end of message");
3207 if (iter->pos != _dbus_string_get_length (&iter->message->body))
3209 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
3215 #endif /* DBUS_DISABLE_CHECKS */
3218 dbus_message_iter_append_type (DBusMessageRealIter *iter,
3224 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
3225 if (!_dbus_string_append_byte (&iter->message->body, type))
3229 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
3230 data = _dbus_string_get_const_data_len (&iter->message->body,
3231 iter->array_type_pos, 1);
3234 _dbus_warn ("Appended element of wrong type for array\n");
3239 case DBUS_MESSAGE_ITER_TYPE_DICT:
3240 if (!iter->wrote_dict_key)
3242 _dbus_warn ("Appending dict data before key name\n");
3246 if (!_dbus_string_append_byte (&iter->message->body, type))
3252 _dbus_assert_not_reached ("Invalid iter type");
3260 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
3262 iter->changed_stamp = iter->message->changed_stamp;
3264 /* Set new end of iter */
3265 iter->end = _dbus_string_get_length (&iter->message->body);
3266 iter->pos = iter->end;
3268 /* Set container length */
3269 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
3270 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
3271 _dbus_marshal_set_uint32 (&iter->message->body,
3272 iter->message->byte_order,
3273 iter->container_length_pos,
3274 iter->end - iter->container_start);
3276 if (iter->parent_iter)
3277 dbus_message_iter_update_after_change (iter->parent_iter);
3281 dbus_message_iter_append_done (DBusMessageRealIter *iter)
3283 iter->message->changed_stamp++;
3284 dbus_message_iter_update_after_change (iter);
3285 iter->wrote_dict_key = FALSE;
3289 * Appends a nil value to the message
3291 * @param iter an iterator pointing to the end of the message
3292 * @returns #TRUE on success
3295 dbus_message_iter_append_nil (DBusMessageIter *iter)
3297 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3299 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3301 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
3304 dbus_message_iter_append_done (real);
3310 * Appends a boolean value to the message
3312 * @param iter an iterator pointing to the end of the message
3313 * @param value the boolean value
3314 * @returns #TRUE on success
3317 dbus_message_iter_append_boolean (DBusMessageIter *iter,
3320 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3322 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3324 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
3327 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
3329 _dbus_string_set_length (&real->message->body, real->pos);
3333 dbus_message_iter_append_done (real);
3339 * Appends a byte to the message
3341 * @param iter an iterator pointing to the end of the message
3342 * @param value the byte value
3343 * @returns #TRUE on success
3346 dbus_message_iter_append_byte (DBusMessageIter *iter,
3347 unsigned char value)
3349 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3351 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3353 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
3356 if (!_dbus_string_append_byte (&real->message->body, value))
3358 _dbus_string_set_length (&real->message->body, real->pos);
3362 dbus_message_iter_append_done (real);
3369 * Appends a 32 bit signed integer to the message.
3371 * @param iter an iterator pointing to the end of the message
3372 * @param value the integer value
3373 * @returns #TRUE on success
3376 dbus_message_iter_append_int32 (DBusMessageIter *iter,
3379 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3381 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3383 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
3386 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
3388 _dbus_string_set_length (&real->message->body, real->pos);
3392 dbus_message_iter_append_done (real);
3398 * Appends a 32 bit unsigned integer to the message.
3400 * @param iter an iterator pointing to the end of the message
3401 * @param value the integer value
3402 * @returns #TRUE on success
3405 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3406 dbus_uint32_t value)
3408 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3410 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3412 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3415 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3417 _dbus_string_set_length (&real->message->body, real->pos);
3421 dbus_message_iter_append_done (real);
3426 #ifdef DBUS_HAVE_INT64
3429 * Appends a 64 bit signed integer to the message.
3431 * This function only exists if #DBUS_HAVE_INT64 is defined.
3433 * @param iter an iterator pointing to the end of the message
3434 * @param value the integer value
3435 * @returns #TRUE on success
3438 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3441 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3443 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3445 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3448 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3450 _dbus_string_set_length (&real->message->body, real->pos);
3454 dbus_message_iter_append_done (real);
3460 * Appends a 64 bit unsigned integer to the message.
3462 * This function only exists if #DBUS_HAVE_INT64 is defined.
3464 * @param iter an iterator pointing to the end of the message
3465 * @param value the integer value
3466 * @returns #TRUE on success
3469 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3470 dbus_uint64_t value)
3472 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3474 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3476 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3479 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3481 _dbus_string_set_length (&real->message->body, real->pos);
3485 dbus_message_iter_append_done (real);
3490 #endif /* DBUS_HAVE_INT64 */
3493 * Appends a double value to the message.
3495 * @param iter an iterator pointing to the end of the message
3496 * @param value the double value
3497 * @returns #TRUE on success
3500 dbus_message_iter_append_double (DBusMessageIter *iter,
3503 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3505 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3507 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3510 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3512 _dbus_string_set_length (&real->message->body, real->pos);
3516 dbus_message_iter_append_done (real);
3522 * Appends a UTF-8 string to the message.
3524 * @param iter an iterator pointing to the end of the message
3525 * @param value the string
3526 * @returns #TRUE on success
3529 dbus_message_iter_append_string (DBusMessageIter *iter,
3532 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3534 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3536 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3539 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3541 _dbus_string_set_length (&real->message->body, real->pos);
3545 dbus_message_iter_append_done (real);
3551 * Appends a named type data chunk to the message. A named
3552 * type is simply an arbitrary UTF-8 string used as a type
3553 * tag, plus an array of arbitrary bytes to be interpreted
3554 * according to the type tag.
3556 * @param iter an iterator pointing to the end of the message
3557 * @param name the name of the type
3558 * @param data the binary data used to store the value
3559 * @param len the length of the binary data in bytes
3560 * @returns #TRUE on success
3563 dbus_message_iter_append_named (DBusMessageIter *iter,
3565 const unsigned char *data,
3568 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3570 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3572 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3575 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3577 _dbus_string_set_length (&real->message->body, real->pos);
3581 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3583 _dbus_string_set_length (&real->message->body, real->pos);
3587 dbus_message_iter_append_done (real);
3594 * Appends a dict key name to the message. The iterator used
3595 * must point to a dict.
3597 * @param iter an iterator pointing to the end of the message
3598 * @param value the string
3599 * @returns #TRUE on success
3602 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3605 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3607 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3608 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3610 if (real->wrote_dict_key)
3612 _dbus_warn ("Appendinging multiple dict key names\n");
3616 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3621 dbus_message_iter_append_done (real);
3622 real->wrote_dict_key = TRUE;
3628 array_iter_type_mark_done (DBusMessageRealIter *iter)
3632 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3633 array_iter_type_mark_done (iter->parent_iter);
3637 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3638 sizeof (dbus_uint32_t));
3640 /* Empty length for now, backfill later */
3641 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3643 _dbus_string_set_length (&iter->message->body, iter->pos);
3647 iter->container_start = _dbus_string_get_length (&iter->message->body);
3648 iter->container_length_pos = len_pos;
3649 iter->array_type_done = TRUE;
3655 append_array_type (DBusMessageRealIter *real,
3657 dbus_bool_t *array_type_done,
3658 int *array_type_pos)
3660 int existing_element_type;
3662 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3665 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3666 real->array_type_done)
3668 existing_element_type = iter_get_array_type (real, array_type_pos);
3669 if (existing_element_type != element_type)
3671 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3672 _dbus_type_to_string (element_type),
3673 _dbus_type_to_string (existing_element_type));
3674 _dbus_string_set_length (&real->message->body, real->pos);
3677 if (array_type_done != NULL)
3678 *array_type_done = TRUE;
3682 if (array_type_pos != NULL)
3683 *array_type_pos = _dbus_string_get_length (&real->message->body);
3685 /* Append element type */
3686 if (!_dbus_string_append_byte (&real->message->body, element_type))
3688 _dbus_string_set_length (&real->message->body, real->pos);
3692 if (array_type_done != NULL)
3693 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3695 if (element_type != DBUS_TYPE_ARRAY &&
3696 !array_iter_type_mark_done (real))
3704 * Appends an array to the message and initializes an iterator that
3705 * can be used to append to the array.
3707 * @param iter an iterator pointing to the end of the message
3708 * @param array_iter pointer to an iter that will be initialized
3709 * @param element_type the type of the array elements
3710 * @returns #TRUE on success
3713 dbus_message_iter_append_array (DBusMessageIter *iter,
3714 DBusMessageIter *array_iter,
3717 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3718 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3721 dbus_bool_t array_type_done;
3723 if (element_type == DBUS_TYPE_NIL)
3725 _dbus_warn ("Can't create NIL arrays\n");
3729 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3731 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3734 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3736 if (array_type_done)
3738 /* Empty length for now, backfill later */
3739 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3741 _dbus_string_set_length (&real->message->body, real->pos);
3746 array_real->parent_iter = real;
3747 array_real->message = real->message;
3748 array_real->changed_stamp = real->message->changed_stamp;
3750 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3751 array_real->pos = _dbus_string_get_length (&real->message->body);
3752 array_real->end = array_real->end;
3754 array_real->container_start = array_real->pos;
3755 array_real->container_length_pos = len_pos;
3756 array_real->wrote_dict_key = 0;
3757 array_real->array_type_done = array_type_done;
3758 array_real->array_type_pos = array_type_pos;
3760 dbus_message_iter_append_done (array_real);
3766 * Appends a dict to the message and initializes an iterator that
3767 * can be used to append to the dict.
3769 * @param iter an iterator pointing to the end of the message
3770 * @param dict_iter pointer to an iter that will be initialized
3771 * @returns #TRUE on success
3774 dbus_message_iter_append_dict (DBusMessageIter *iter,
3775 DBusMessageIter *dict_iter)
3777 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3778 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3781 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3783 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3786 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3788 /* Empty length for now, backfill later */
3789 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3791 _dbus_string_set_length (&real->message->body, real->pos);
3795 dict_real->parent_iter = real;
3796 dict_real->message = real->message;
3797 dict_real->changed_stamp = real->message->changed_stamp;
3799 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3800 dict_real->pos = _dbus_string_get_length (&real->message->body);
3801 dict_real->end = dict_real->end;
3803 dict_real->container_start = dict_real->pos;
3804 dict_real->container_length_pos = len_pos;
3805 dict_real->wrote_dict_key = 0;
3807 dbus_message_iter_append_done (dict_real);
3814 * Appends a boolean array to the message.
3816 * @param iter an iterator pointing to the end of the message
3817 * @param value the array
3818 * @param len the length of the array
3819 * @returns #TRUE on success
3822 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3823 unsigned const char *value,
3826 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3828 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3830 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3833 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3835 _dbus_string_set_length (&real->message->body, real->pos);
3839 dbus_message_iter_append_done (real);
3845 * Appends a 32 bit signed integer array to the message.
3847 * @param iter an iterator pointing to the end of the message
3848 * @param value the array
3849 * @param len the length of the array
3850 * @returns #TRUE on success
3853 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3854 const dbus_int32_t *value,
3857 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3859 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3861 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
3864 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
3866 _dbus_string_set_length (&real->message->body, real->pos);
3870 dbus_message_iter_append_done (real);
3876 * Appends a 32 bit unsigned integer array to the message.
3878 * @param iter an iterator pointing to the end of the message
3879 * @param value the array
3880 * @param len the length of the array
3881 * @returns #TRUE on success
3884 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
3885 const dbus_uint32_t *value,
3888 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3890 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3892 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
3895 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
3897 _dbus_string_set_length (&real->message->body, real->pos);
3901 dbus_message_iter_append_done (real);
3906 #ifdef DBUS_HAVE_INT64
3909 * Appends a 64 bit signed integer array to the message.
3911 * This function only exists if #DBUS_HAVE_INT64 is defined.
3913 * @param iter an iterator pointing to the end of the message
3914 * @param value the array
3915 * @param len the length of the array
3916 * @returns #TRUE on success
3919 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
3920 const dbus_int64_t *value,
3923 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3925 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3927 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
3930 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
3932 _dbus_string_set_length (&real->message->body, real->pos);
3936 dbus_message_iter_append_done (real);
3942 * Appends a 64 bit unsigned integer array to the message.
3944 * This function only exists if #DBUS_HAVE_INT64 is defined.
3946 * @param iter an iterator pointing to the end of the message
3947 * @param value the array
3948 * @param len the length of the array
3949 * @returns #TRUE on success
3952 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
3953 const dbus_uint64_t *value,
3956 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3958 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3960 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
3963 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
3965 _dbus_string_set_length (&real->message->body, real->pos);
3969 dbus_message_iter_append_done (real);
3973 #endif /* DBUS_HAVE_INT64 */
3976 * Appends a double array to the message.
3978 * @param iter an iterator pointing to the end of the message
3979 * @param value the array
3980 * @param len the length of the array
3981 * @returns #TRUE on success
3984 dbus_message_iter_append_double_array (DBusMessageIter *iter,
3985 const double *value,
3988 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3990 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3992 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
3995 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
3997 _dbus_string_set_length (&real->message->body, real->pos);
4001 dbus_message_iter_append_done (real);
4007 * Appends a byte array to the message.
4009 * @param iter an iterator pointing to the end of the message
4010 * @param value the array
4011 * @param len the length of the array
4012 * @returns #TRUE on success
4015 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
4016 unsigned const char *value,
4019 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4021 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4023 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
4026 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
4028 _dbus_string_set_length (&real->message->body, real->pos);
4032 dbus_message_iter_append_done (real);
4038 * Appends a string array to the message.
4040 * @param iter an iterator pointing to the end of the message
4041 * @param value the array
4042 * @param len the length of the array
4043 * @returns #TRUE on success
4046 dbus_message_iter_append_string_array (DBusMessageIter *iter,
4050 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4052 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4054 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
4057 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
4059 _dbus_string_set_length (&real->message->body, real->pos);
4063 dbus_message_iter_append_done (real);
4069 * Sets the message sender.
4071 * @param message the message
4072 * @param sender the sender
4073 * @returns #FALSE if not enough memory
4076 dbus_message_set_sender (DBusMessage *message,
4079 _dbus_return_val_if_fail (message != NULL, FALSE);
4080 _dbus_return_val_if_fail (!message->locked, FALSE);
4084 delete_string_field (message,
4085 DBUS_HEADER_FIELD_SENDER_SERVICE);
4090 return set_string_field (message,
4091 DBUS_HEADER_FIELD_SENDER_SERVICE,
4098 * Sets a flag indicating that the message does not want a reply; if
4099 * this flag is set, the other end of the connection may (but is not
4100 * required to) optimize by not sending method return or error
4101 * replies. If this flag is set, there is no way to know whether the
4102 * message successfully arrived at the remote end.
4104 * @param message the message
4105 * @param no_reply #TRUE if no reply is desired
4108 dbus_message_set_no_reply (DBusMessage *message,
4109 dbus_bool_t no_reply)
4113 _dbus_return_if_fail (message != NULL);
4114 _dbus_return_if_fail (!message->locked);
4116 header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1);
4119 *header |= DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4121 *header &= ~DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4125 * Returns #TRUE if the message does not expect
4128 * @param message the message
4129 * @returns #TRUE if the message sender isn't waiting for a reply
4132 dbus_message_get_no_reply (DBusMessage *message)
4136 _dbus_return_val_if_fail (message != NULL, FALSE);
4138 header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1);
4140 return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0;
4144 * Gets the service which originated this message,
4145 * or #NULL if unknown or inapplicable.
4147 * @param message the message
4148 * @returns the service name or #NULL
4151 dbus_message_get_sender (DBusMessage *message)
4153 _dbus_return_val_if_fail (message != NULL, NULL);
4155 return get_string_field (message,
4156 DBUS_HEADER_FIELD_SENDER_SERVICE,
4161 _dbus_message_has_type_interface_member (DBusMessage *message,
4163 const char *interface,
4168 _dbus_assert (message != NULL);
4169 _dbus_assert (interface != NULL);
4170 _dbus_assert (method != NULL);
4172 if (dbus_message_get_type (message) != type)
4175 /* Optimize by checking the short method name first
4176 * instead of the longer interface name
4179 n = dbus_message_get_member (message);
4181 if (n && strcmp (n, method) == 0)
4183 n = dbus_message_get_interface (message);
4185 if (n && strcmp (n, interface) == 0)
4193 * Checks whether the message is a method call with the given
4194 * interface and member fields. If the message is not
4195 * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or member field,
4198 * @param message the message
4199 * @param interface the name to check (must not be #NULL)
4200 * @param method the name to check (must not be #NULL)
4202 * @returns #TRUE if the message is the specified method call
4205 dbus_message_is_method_call (DBusMessage *message,
4206 const char *interface,
4209 _dbus_return_val_if_fail (message != NULL, FALSE);
4210 _dbus_return_val_if_fail (interface != NULL, FALSE);
4211 _dbus_return_val_if_fail (method != NULL, FALSE);
4213 return _dbus_message_has_type_interface_member (message,
4214 DBUS_MESSAGE_TYPE_METHOD_CALL,
4219 * Checks whether the message is a signal with the given
4220 * interface and member fields. If the message is not
4221 * #DBUS_MESSAGE_TYPE_SIGNAL, or has a different interface or member field,
4224 * @param message the message
4225 * @param interface the name to check (must not be #NULL)
4226 * @param signal_name the name to check (must not be #NULL)
4228 * @returns #TRUE if the message is the specified signal
4231 dbus_message_is_signal (DBusMessage *message,
4232 const char *interface,
4233 const char *signal_name)
4235 _dbus_return_val_if_fail (message != NULL, FALSE);
4236 _dbus_return_val_if_fail (interface != NULL, FALSE);
4237 _dbus_return_val_if_fail (signal_name != NULL, FALSE);
4239 return _dbus_message_has_type_interface_member (message,
4240 DBUS_MESSAGE_TYPE_SIGNAL,
4241 interface, signal_name);
4245 * Checks whether the message is an error reply with the given error
4246 * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a
4247 * different name, returns #FALSE.
4249 * @param message the message
4250 * @param error_name the name to check (must not be #NULL)
4252 * @returns #TRUE if the message is the specified error
4255 dbus_message_is_error (DBusMessage *message,
4256 const char *error_name)
4260 _dbus_return_val_if_fail (message != NULL, FALSE);
4261 _dbus_return_val_if_fail (error_name != NULL, FALSE);
4263 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4266 n = dbus_message_get_error_name (message);
4268 if (n && strcmp (n, error_name) == 0)
4275 * Checks whether the message was sent to the given service. If the
4276 * message has no service specified or has a different name, returns
4279 * @param message the message
4280 * @param service the service to check (must not be #NULL)
4282 * @returns #TRUE if the message has the given destination service
4285 dbus_message_has_destination (DBusMessage *message,
4286 const char *service)
4290 _dbus_return_val_if_fail (message != NULL, FALSE);
4291 _dbus_return_val_if_fail (service != NULL, FALSE);
4293 s = dbus_message_get_destination (message);
4295 if (s && strcmp (s, service) == 0)
4302 * Checks whether the message has the given service as its sender. If
4303 * the message has no sender specified or has a different sender,
4304 * returns #FALSE. Note that if a peer application owns multiple
4305 * services, its messages will have only one of those services as the
4306 * sender (usually the base service). So you can't use this
4307 * function to prove the sender didn't own service Foo, you can
4308 * only use it to prove that it did.
4310 * @param message the message
4311 * @param service the service to check (must not be #NULL)
4313 * @returns #TRUE if the message has the given origin service
4316 dbus_message_has_sender (DBusMessage *message,
4317 const char *service)
4321 _dbus_assert (service != NULL);
4323 s = dbus_message_get_sender (message);
4325 if (s && strcmp (s, service) == 0)
4332 * Sets a #DBusError based on the contents of the given
4333 * message. The error is only set if the message
4334 * is an error message, as in DBUS_MESSAGE_TYPE_ERROR.
4335 * The name of the error is set to the name of the message,
4336 * and the error message is set to the first argument
4337 * if the argument exists and is a string.
4339 * The return value indicates whether the error was set (the error is
4340 * set if and only if the message is an error message).
4341 * So you can check for an error reply and convert it to DBusError
4344 * @param error the error to set
4345 * @param message the message to set it from
4346 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
4349 dbus_set_error_from_message (DBusError *error,
4350 DBusMessage *message)
4354 _dbus_return_val_if_fail (message != NULL, FALSE);
4355 _dbus_return_val_if_error_is_set (error, FALSE);
4357 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4361 dbus_message_get_args (message, NULL,
4362 DBUS_TYPE_STRING, &str,
4365 dbus_set_error (error, dbus_message_get_error_name (message),
4366 str ? "%s" : NULL, str);
4376 * @addtogroup DBusMessageInternals
4381 * @typedef DBusMessageLoader
4383 * The DBusMessageLoader object encapsulates the process of converting
4384 * a byte stream into a series of DBusMessage. It buffers the incoming
4385 * bytes as efficiently as possible, and generates a queue of
4386 * messages. DBusMessageLoader is typically used as part of a
4387 * DBusTransport implementation. The DBusTransport then hands off
4388 * the loaded messages to a DBusConnection, making the messages
4389 * visible to the application.
4391 * @todo write tests for break-loader that a) randomly delete header
4392 * fields and b) set string fields to zero-length and other funky
4397 /* we definitely use signed ints for sizes, so don't exceed
4398 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
4399 * over 128M is pretty nuts anyhow.
4403 * The maximum sane message size.
4405 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
4408 * Implementation details of DBusMessageLoader.
4409 * All members are private.
4411 struct DBusMessageLoader
4413 int refcount; /**< Reference count. */
4415 DBusString data; /**< Buffered data */
4417 DBusList *messages; /**< Complete messages. */
4419 long max_message_size; /**< Maximum size of a message */
4421 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
4423 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
4427 * The initial buffer size of the message loader.
4429 * @todo this should be based on min header size plus some average
4430 * body size, or something. Or rather, the min header size only, if we
4431 * want to try to read only the header, store that in a DBusMessage,
4432 * then read only the body and store that, etc., depends on
4433 * how we optimize _dbus_message_loader_get_buffer() and what
4434 * the exact message format is.
4436 #define INITIAL_LOADER_DATA_LEN 32
4439 * Creates a new message loader. Returns #NULL if memory can't
4442 * @returns new loader, or #NULL.
4445 _dbus_message_loader_new (void)
4447 DBusMessageLoader *loader;
4449 loader = dbus_new0 (DBusMessageLoader, 1);
4453 loader->refcount = 1;
4455 /* Try to cap message size at something that won't *totally* hose
4456 * the system if we have a couple of them.
4458 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
4460 if (!_dbus_string_init (&loader->data))
4466 /* preallocate the buffer for speed, ignore failure */
4467 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
4468 _dbus_string_set_length (&loader->data, 0);
4474 * Increments the reference count of the loader.
4476 * @param loader the loader.
4479 _dbus_message_loader_ref (DBusMessageLoader *loader)
4481 loader->refcount += 1;
4485 * Decrements the reference count of the loader and finalizes the
4486 * loader when the count reaches zero.
4488 * @param loader the loader.
4491 _dbus_message_loader_unref (DBusMessageLoader *loader)
4493 loader->refcount -= 1;
4494 if (loader->refcount == 0)
4496 _dbus_list_foreach (&loader->messages,
4497 (DBusForeachFunction) dbus_message_unref,
4499 _dbus_list_clear (&loader->messages);
4500 _dbus_string_free (&loader->data);
4506 * Gets the buffer to use for reading data from the network. Network
4507 * data is read directly into an allocated buffer, which is then used
4508 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4509 * The buffer must always be returned immediately using
4510 * _dbus_message_loader_return_buffer(), even if no bytes are
4511 * successfully read.
4513 * @todo this function can be a lot more clever. For example
4514 * it can probably always return a buffer size to read exactly
4515 * the body of the next message, thus avoiding any memory wastage
4518 * @todo we need to enforce a max length on strings in header fields.
4520 * @param loader the message loader.
4521 * @param buffer the buffer
4524 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4525 DBusString **buffer)
4527 _dbus_assert (!loader->buffer_outstanding);
4529 *buffer = &loader->data;
4531 loader->buffer_outstanding = TRUE;
4535 * The smallest header size that can occur.
4536 * (It won't be valid)
4538 #define DBUS_MINIMUM_HEADER_SIZE 16
4541 decode_string_field (const DBusString *data,
4543 HeaderField *header_field,
4544 DBusString *field_data,
4548 int string_data_pos;
4550 _dbus_assert (header_field != NULL);
4551 _dbus_assert (field_data != NULL);
4553 if (header_field->offset >= 0)
4555 _dbus_verbose ("%s field provided twice\n",
4556 _dbus_header_field_to_string (field));
4560 if (type != DBUS_TYPE_STRING)
4562 _dbus_verbose ("%s field has wrong type %s\n",
4563 _dbus_header_field_to_string (field),
4564 _dbus_type_to_string (type));
4568 /* skip padding after typecode, skip string length;
4569 * we assume that the string arg has already been validated
4570 * for sanity and UTF-8
4572 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4573 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4575 _dbus_string_init_const (field_data,
4576 _dbus_string_get_const_data (data) + string_data_pos);
4578 header_field->offset = _DBUS_ALIGN_VALUE (pos, 4);
4581 _dbus_verbose ("Found field %s at offset %d\n",
4582 _dbus_header_field_to_string (field),
4583 header_field->offset);
4590 decode_header_data (const DBusString *data,
4594 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1],
4595 int *message_padding)
4597 DBusString field_data;
4603 if (header_len < 16)
4605 _dbus_verbose ("Header length %d is too short\n", header_len);
4610 while (i <= DBUS_HEADER_FIELD_LAST)
4612 fields[i].offset = -1;
4616 /* Now handle the named fields. A real named field is at least 1
4617 * byte for the name, plus a type code (1 byte) plus padding, plus
4618 * the field value. So if we have less than 8 bytes left, it must
4619 * be alignment padding, not a field. While >= 8 bytes can't be
4620 * entirely alignment padding.
4623 while ((pos + 7) < header_len)
4625 pos = _DBUS_ALIGN_VALUE (pos, 4);
4627 if ((pos + 1) > header_len)
4629 _dbus_verbose ("not enough space remains in header for header field value\n");
4633 field = _dbus_string_get_byte (data, pos);
4636 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4638 _dbus_verbose ("Failed to validate type of named header field\n");
4642 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4644 _dbus_verbose ("Failed to validate argument to named header field\n");
4648 if (new_pos > header_len)
4650 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4656 case DBUS_HEADER_FIELD_SERVICE:
4657 if (!decode_string_field (data, field, &fields[field],
4658 &field_data, pos, type))
4661 if (!_dbus_string_validate_service (&field_data, 0,
4662 _dbus_string_get_length (&field_data)))
4664 _dbus_verbose ("service field has invalid content \"%s\"\n",
4665 _dbus_string_get_const_data (&field_data));
4670 case DBUS_HEADER_FIELD_INTERFACE:
4671 if (!decode_string_field (data, field, &fields[field],
4672 &field_data, pos, type))
4675 if (!_dbus_string_validate_interface (&field_data, 0,
4676 _dbus_string_get_length (&field_data)))
4678 _dbus_verbose ("interface field has invalid content \"%s\"\n",
4679 _dbus_string_get_const_data (&field_data));
4683 if (_dbus_string_equal_c_str (&field_data,
4684 DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL))
4686 _dbus_verbose ("Message is on the local interface\n");
4691 case DBUS_HEADER_FIELD_MEMBER:
4692 if (!decode_string_field (data, field, &fields[field],
4693 &field_data, pos, type))
4696 if (!_dbus_string_validate_member (&field_data, 0,
4697 _dbus_string_get_length (&field_data)))
4699 _dbus_verbose ("member field has invalid content \"%s\"\n",
4700 _dbus_string_get_const_data (&field_data));
4705 case DBUS_HEADER_FIELD_ERROR_NAME:
4706 if (!decode_string_field (data, field, &fields[field],
4707 &field_data, pos, type))
4710 if (!_dbus_string_validate_error_name (&field_data, 0,
4711 _dbus_string_get_length (&field_data)))
4713 _dbus_verbose ("error-name field has invalid content \"%s\"\n",
4714 _dbus_string_get_const_data (&field_data));
4719 case DBUS_HEADER_FIELD_SENDER_SERVICE:
4720 if (!decode_string_field (data, field, &fields[field],
4721 &field_data, pos, type))
4724 if (!_dbus_string_validate_service (&field_data, 0,
4725 _dbus_string_get_length (&field_data)))
4727 _dbus_verbose ("sender-service field has invalid content \"%s\"\n",
4728 _dbus_string_get_const_data (&field_data));
4733 case DBUS_HEADER_FIELD_PATH:
4735 /* Path was already validated as part of standard
4736 * type validation, since there's an OBJECT_PATH
4740 if (fields[field].offset >= 0)
4742 _dbus_verbose ("path field provided twice\n");
4745 if (type != DBUS_TYPE_OBJECT_PATH)
4747 _dbus_verbose ("path field has wrong type\n");
4751 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4753 /* No forging signals from the local path */
4756 s = _dbus_string_get_const_data_len (data,
4757 fields[field].offset,
4758 _dbus_string_get_length (data) -
4759 fields[field].offset);
4760 if (strcmp (s, DBUS_PATH_ORG_FREEDESKTOP_LOCAL) == 0)
4762 _dbus_verbose ("Message is on the local path\n");
4767 _dbus_verbose ("Found path at offset %d\n",
4768 fields[field].offset);
4771 case DBUS_HEADER_FIELD_REPLY_SERIAL:
4772 if (fields[field].offset >= 0)
4774 _dbus_verbose ("reply field provided twice\n");
4778 if (type != DBUS_TYPE_UINT32)
4780 _dbus_verbose ("reply field has wrong type\n");
4784 fields[field].offset = _DBUS_ALIGN_VALUE (pos, 4);
4786 _dbus_verbose ("Found reply serial at offset %d\n",
4787 fields[field].offset);
4791 _dbus_verbose ("Ignoring an unknown header field: %d at offset %d\n",
4798 if (pos < header_len)
4800 /* Alignment padding, verify that it's nul */
4801 _dbus_assert ((header_len - pos) < 8);
4803 if (!_dbus_string_validate_nul (data,
4804 pos, (header_len - pos)))
4806 _dbus_verbose ("header alignment padding is not nul\n");
4811 /* Depending on message type, enforce presence of certain fields. */
4812 switch (message_type)
4814 case DBUS_MESSAGE_TYPE_SIGNAL:
4815 case DBUS_MESSAGE_TYPE_METHOD_CALL:
4816 if (fields[DBUS_HEADER_FIELD_PATH].offset < 0)
4818 _dbus_verbose ("No path field provided\n");
4821 /* FIXME make this optional, at least for method calls */
4822 if (fields[DBUS_HEADER_FIELD_INTERFACE].offset < 0)
4824 _dbus_verbose ("No interface field provided\n");
4827 if (fields[DBUS_HEADER_FIELD_MEMBER].offset < 0)
4829 _dbus_verbose ("No member field provided\n");
4833 case DBUS_MESSAGE_TYPE_ERROR:
4834 if (fields[DBUS_HEADER_FIELD_ERROR_NAME].offset < 0)
4836 _dbus_verbose ("No error-name field provided\n");
4840 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
4843 /* An unknown type, spec requires us to ignore it */
4847 if (message_padding)
4848 *message_padding = header_len - pos;
4854 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
4855 * indicating to the loader how many bytes of the buffer were filled
4856 * in. This function must always be called, even if no bytes were
4857 * successfully read.
4859 * @param loader the loader.
4860 * @param buffer the buffer.
4861 * @param bytes_read number of bytes that were read into the buffer.
4864 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
4868 _dbus_assert (loader->buffer_outstanding);
4869 _dbus_assert (buffer == &loader->data);
4871 loader->buffer_outstanding = FALSE;
4875 * Converts buffered data into messages.
4877 * @todo we need to check that the proper named header fields exist
4878 * for each message type.
4880 * @todo If a message has unknown type, we should probably eat it
4881 * right here rather than passing it out to applications. However
4882 * it's not an error to see messages of unknown type.
4884 * @param loader the loader.
4885 * @returns #TRUE if we had enough memory to finish.
4888 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
4890 if (loader->corrupted)
4893 while (_dbus_string_get_length (&loader->data) >= 16)
4895 DBusMessage *message;
4896 const char *header_data;
4897 int byte_order, message_type, header_len, body_len, header_padding;
4898 dbus_uint32_t header_len_unsigned, body_len_unsigned;
4900 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
4902 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
4904 if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION)
4906 _dbus_verbose ("Message has protocol version %d ours is %d\n",
4907 (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION);
4908 loader->corrupted = TRUE;
4912 byte_order = header_data[BYTE_ORDER_OFFSET];
4914 if (byte_order != DBUS_LITTLE_ENDIAN &&
4915 byte_order != DBUS_BIG_ENDIAN)
4917 _dbus_verbose ("Message with bad byte order '%c' received\n",
4919 loader->corrupted = TRUE;
4923 /* Unknown types are ignored, but INVALID is
4926 message_type = header_data[TYPE_OFFSET];
4927 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
4929 _dbus_verbose ("Message with bad type '%d' received\n",
4931 loader->corrupted = TRUE;
4935 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
4936 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
4938 if (header_len_unsigned < 16)
4940 _dbus_verbose ("Message had broken too-small header length %u\n",
4941 header_len_unsigned);
4942 loader->corrupted = TRUE;
4946 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
4947 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
4949 _dbus_verbose ("Header or body length too large (%u %u)\n",
4950 header_len_unsigned,
4952 loader->corrupted = TRUE;
4956 /* Now that we know the values are in signed range, get
4957 * rid of stupid unsigned, just causes bugs
4959 header_len = header_len_unsigned;
4960 body_len = body_len_unsigned;
4962 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
4965 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
4967 loader->corrupted = TRUE;
4971 if (header_len + body_len > loader->max_message_size)
4973 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
4974 header_len, body_len, loader->max_message_size);
4975 loader->corrupted = TRUE;
4979 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
4981 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1];
4986 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
4988 if (!decode_header_data (&loader->data,
4989 header_len, byte_order,
4991 fields, &header_padding))
4993 _dbus_verbose ("Header was invalid\n");
4994 loader->corrupted = TRUE;
4998 next_arg = header_len;
4999 while (next_arg < (header_len + body_len))
5002 int prev = next_arg;
5004 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
5007 _dbus_verbose ("invalid typecode at offset %d\n", prev);
5008 loader->corrupted = TRUE;
5012 if (!_dbus_marshal_validate_arg (&loader->data,
5019 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
5020 loader->corrupted = TRUE;
5024 _dbus_assert (next_arg > prev);
5027 if (next_arg > (header_len + body_len))
5029 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
5030 next_arg, header_len, body_len,
5031 header_len + body_len);
5032 loader->corrupted = TRUE;
5036 message = dbus_message_new_empty_header ();
5037 if (message == NULL)
5039 _dbus_verbose ("Failed to allocate empty message\n");
5043 message->byte_order = byte_order;
5044 message->header_padding = header_padding;
5046 /* Copy in the offsets we found */
5048 while (i <= DBUS_HEADER_FIELD_LAST)
5050 message->header_fields[i] = fields[i];
5054 if (!_dbus_list_append (&loader->messages, message))
5056 _dbus_verbose ("Failed to append new message to loader queue\n");
5057 dbus_message_unref (message);
5061 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
5062 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
5064 _dbus_assert (_dbus_string_get_length (&loader->data) >=
5065 (header_len + body_len));
5067 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
5069 _dbus_verbose ("Failed to move header into new message\n");
5070 _dbus_list_remove_last (&loader->messages, message);
5071 dbus_message_unref (message);
5075 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
5079 _dbus_verbose ("Failed to move body into new message\n");
5081 /* put the header back, we'll try again later */
5082 result = _dbus_string_copy_len (&message->header, 0, header_len,
5084 _dbus_assert (result); /* because DBusString never reallocs smaller */
5086 _dbus_list_remove_last (&loader->messages, message);
5087 dbus_message_unref (message);
5091 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
5092 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
5094 /* Fill in caches (we checked the types of these fields
5097 message->reply_serial = get_uint_field (message,
5098 DBUS_HEADER_FIELD_REPLY_SERIAL);
5100 message->client_serial = _dbus_demarshal_uint32 (&message->header,
5101 message->byte_order,
5102 CLIENT_SERIAL_OFFSET,
5105 _dbus_verbose ("Loaded message %p\n", message);
5115 * Peeks at first loaded message, returns #NULL if no messages have
5118 * @param loader the loader.
5119 * @returns the next message, or #NULL if none.
5122 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
5124 if (loader->messages)
5125 return loader->messages->data;
5131 * Pops a loaded message (passing ownership of the message
5132 * to the caller). Returns #NULL if no messages have been
5135 * @param loader the loader.
5136 * @returns the next message, or #NULL if none.
5139 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
5141 return _dbus_list_pop_first (&loader->messages);
5145 * Pops a loaded message inside a list link (passing ownership of the
5146 * message and link to the caller). Returns #NULL if no messages have
5149 * @param loader the loader.
5150 * @returns the next message link, or #NULL if none.
5153 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
5155 return _dbus_list_pop_first_link (&loader->messages);
5159 * Returns a popped message link, used to undo a pop.
5161 * @param loader the loader
5162 * @param link the link with a message in it
5165 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
5168 _dbus_list_prepend_link (&loader->messages, link);
5172 * Checks whether the loader is confused due to bad data.
5173 * If messages are received that are invalid, the
5174 * loader gets confused and gives up permanently.
5175 * This state is called "corrupted."
5177 * @param loader the loader
5178 * @returns #TRUE if the loader is hosed.
5181 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
5183 return loader->corrupted;
5187 * Sets the maximum size message we allow.
5189 * @param loader the loader
5190 * @param size the max message size in bytes
5193 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
5196 if (size > MAX_SANE_MESSAGE_SIZE)
5198 _dbus_verbose ("clamping requested max message size %ld to %d\n",
5199 size, MAX_SANE_MESSAGE_SIZE);
5200 size = MAX_SANE_MESSAGE_SIZE;
5202 loader->max_message_size = size;
5206 * Gets the maximum allowed message size in bytes.
5208 * @param loader the loader
5209 * @returns max size in bytes
5212 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
5214 return loader->max_message_size;
5217 static DBusDataSlotAllocator slot_allocator;
5218 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
5221 * Allocates an integer ID to be used for storing application-specific
5222 * data on any DBusMessage. The allocated ID may then be used
5223 * with dbus_message_set_data() and dbus_message_get_data().
5224 * The passed-in slot must be initialized to -1, and is filled in
5225 * with the slot ID. If the passed-in slot is not -1, it's assumed
5226 * to be already allocated, and its refcount is incremented.
5228 * The allocated slot is global, i.e. all DBusMessage objects will
5229 * have a slot with the given integer ID reserved.
5231 * @param slot_p address of a global variable storing the slot
5232 * @returns #FALSE on failure (no memory)
5235 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
5237 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5238 _DBUS_LOCK_NAME (message_slots),
5243 * Deallocates a global ID for message data slots.
5244 * dbus_message_get_data() and dbus_message_set_data() may no
5245 * longer be used with this slot. Existing data stored on existing
5246 * DBusMessage objects will be freed when the message is
5247 * finalized, but may not be retrieved (and may only be replaced if
5248 * someone else reallocates the slot). When the refcount on the
5249 * passed-in slot reaches 0, it is set to -1.
5251 * @param slot_p address storing the slot to deallocate
5254 dbus_message_free_data_slot (dbus_int32_t *slot_p)
5256 _dbus_return_if_fail (*slot_p >= 0);
5258 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5262 * Stores a pointer on a DBusMessage, along
5263 * with an optional function to be used for freeing
5264 * the data when the data is set again, or when
5265 * the message is finalized. The slot number
5266 * must have been allocated with dbus_message_allocate_data_slot().
5268 * @param message the message
5269 * @param slot the slot number
5270 * @param data the data to store
5271 * @param free_data_func finalizer function for the data
5272 * @returns #TRUE if there was enough memory to store the data
5275 dbus_message_set_data (DBusMessage *message,
5278 DBusFreeFunction free_data_func)
5280 DBusFreeFunction old_free_func;
5284 _dbus_return_val_if_fail (message != NULL, FALSE);
5285 _dbus_return_val_if_fail (slot >= 0, FALSE);
5287 retval = _dbus_data_slot_list_set (&slot_allocator,
5288 &message->slot_list,
5289 slot, data, free_data_func,
5290 &old_free_func, &old_data);
5294 /* Do the actual free outside the message lock */
5296 (* old_free_func) (old_data);
5303 * Retrieves data previously set with dbus_message_set_data().
5304 * The slot must still be allocated (must not have been freed).
5306 * @param message the message
5307 * @param slot the slot to get data from
5308 * @returns the data, or #NULL if not found
5311 dbus_message_get_data (DBusMessage *message,
5316 _dbus_return_val_if_fail (message != NULL, NULL);
5318 res = _dbus_data_slot_list_get (&slot_allocator,
5319 &message->slot_list,
5326 #ifdef DBUS_BUILD_TESTS
5327 #include "dbus-test.h"
5331 message_iter_test (DBusMessage *message)
5333 DBusMessageIter iter, dict, array, array2;
5335 unsigned char *data;
5336 dbus_int32_t *our_int_array;
5339 dbus_message_iter_init (message, &iter);
5342 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
5343 _dbus_assert_not_reached ("Argument type isn't string");
5345 str = dbus_message_iter_get_string (&iter);
5346 if (strcmp (str, "Test string") != 0)
5347 _dbus_assert_not_reached ("Strings differ");
5350 if (!dbus_message_iter_next (&iter))
5351 _dbus_assert_not_reached ("Reached end of arguments");
5353 /* Signed integer tests */
5354 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
5355 _dbus_assert_not_reached ("Argument type isn't int32");
5357 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
5358 _dbus_assert_not_reached ("Signed integers differ");
5360 if (!dbus_message_iter_next (&iter))
5361 _dbus_assert_not_reached ("Reached end of fields");
5363 /* Unsigned integer tests */
5364 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5365 _dbus_assert_not_reached ("Argument type isn't int32");
5367 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
5368 _dbus_assert_not_reached ("Unsigned integers differ");
5370 if (!dbus_message_iter_next (&iter))
5371 _dbus_assert_not_reached ("Reached end of arguments");
5374 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
5375 _dbus_assert_not_reached ("Argument type isn't double");
5377 if (dbus_message_iter_get_double (&iter) != 3.14159)
5378 _dbus_assert_not_reached ("Doubles differ");
5380 if (!dbus_message_iter_next (&iter))
5381 _dbus_assert_not_reached ("Reached end of arguments");
5383 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
5384 _dbus_assert_not_reached ("Argument type not an array");
5386 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
5387 _dbus_assert_not_reached ("Array type not double");
5390 if (!dbus_message_iter_init_array_iterator (&iter, &array, NULL))
5391 _dbus_assert_not_reached ("Array init failed");
5393 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5394 _dbus_assert_not_reached ("Argument type isn't double");
5396 if (dbus_message_iter_get_double (&array) != 1.5)
5397 _dbus_assert_not_reached ("Unsigned integers differ");
5399 if (!dbus_message_iter_next (&array))
5400 _dbus_assert_not_reached ("Reached end of arguments");
5402 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5403 _dbus_assert_not_reached ("Argument type isn't double");
5405 if (dbus_message_iter_get_double (&array) != 2.5)
5406 _dbus_assert_not_reached ("Unsigned integers differ");
5408 if (dbus_message_iter_next (&array))
5409 _dbus_assert_not_reached ("Didn't reach end of arguments");
5411 if (!dbus_message_iter_next (&iter))
5412 _dbus_assert_not_reached ("Reached end of arguments");
5417 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5418 _dbus_assert_not_reached ("not dict type");
5420 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
5421 _dbus_assert_not_reached ("dict iter failed");
5423 str = dbus_message_iter_get_dict_key (&dict);
5424 if (str == NULL || strcmp (str, "test") != 0)
5425 _dbus_assert_not_reached ("wrong dict key");
5428 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5429 _dbus_assert_not_reached ("wrong dict entry type");
5431 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
5432 _dbus_assert_not_reached ("wrong dict entry value");
5434 if (!dbus_message_iter_next (&dict))
5435 _dbus_assert_not_reached ("reached end of dict");
5437 /* array of array of int32 (in dict) */
5439 str = dbus_message_iter_get_dict_key (&dict);
5440 if (str == NULL || strcmp (str, "array") != 0)
5441 _dbus_assert_not_reached ("wrong dict key");
5444 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
5445 _dbus_assert_not_reached ("Argument type not an array");
5447 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
5448 _dbus_assert_not_reached ("Array type not array");
5450 if (!dbus_message_iter_init_array_iterator (&dict, &array, NULL))
5451 _dbus_assert_not_reached ("Array init failed");
5453 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
5454 _dbus_assert_not_reached ("Argument type isn't array");
5456 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5457 _dbus_assert_not_reached ("Array type not int32");
5459 if (!dbus_message_iter_init_array_iterator (&array, &array2, NULL))
5460 _dbus_assert_not_reached ("Array init failed");
5462 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
5463 _dbus_assert_not_reached ("Argument type isn't int32");
5465 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
5466 _dbus_assert_not_reached ("Signed integers differ");
5468 if (!dbus_message_iter_next (&array2))
5469 _dbus_assert_not_reached ("Reached end of arguments");
5471 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
5472 _dbus_assert_not_reached ("Signed integers differ");
5474 if (dbus_message_iter_next (&array2))
5475 _dbus_assert_not_reached ("Didn't reached end of arguments");
5477 if (!dbus_message_iter_next (&array))
5478 _dbus_assert_not_reached ("Reached end of arguments");
5480 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5481 _dbus_assert_not_reached ("Array type not int32");
5483 if (!dbus_message_iter_get_int32_array (&array,
5486 _dbus_assert_not_reached ("couldn't get int32 array");
5488 _dbus_assert (len == 3);
5489 _dbus_assert (our_int_array[0] == 0x34567812 &&
5490 our_int_array[1] == 0x45678123 &&
5491 our_int_array[2] == 0x56781234);
5492 dbus_free (our_int_array);
5494 if (dbus_message_iter_next (&array))
5495 _dbus_assert_not_reached ("Didn't reach end of array");
5497 if (dbus_message_iter_next (&dict))
5498 _dbus_assert_not_reached ("Didn't reach end of dict");
5500 if (!dbus_message_iter_next (&iter))
5501 _dbus_assert_not_reached ("Reached end of arguments");
5503 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
5505 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
5506 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
5509 if (dbus_message_iter_get_byte (&iter) != 0xF0)
5510 _dbus_assert_not_reached ("wrong value after dict");
5513 if (!dbus_message_iter_next (&iter))
5514 _dbus_assert_not_reached ("Reached end of arguments");
5516 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
5517 _dbus_assert_not_reached ("not a nil type");
5519 if (!dbus_message_iter_next (&iter))
5520 _dbus_assert_not_reached ("Reached end of arguments");
5522 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
5523 _dbus_assert_not_reached ("wrong type after dict");
5525 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
5526 _dbus_assert_not_reached ("failed to get named");
5528 _dbus_assert (strcmp (str, "named")==0);
5529 _dbus_assert (len == 5);
5530 _dbus_assert (strcmp (data, "data")==0);
5534 if (dbus_message_iter_next (&iter))
5535 _dbus_assert_not_reached ("Didn't reach end of arguments");
5540 check_message_handling_type (DBusMessageIter *iter,
5543 DBusMessageIter child_iter;
5549 case DBUS_TYPE_BYTE:
5550 dbus_message_iter_get_byte (iter);
5552 case DBUS_TYPE_BOOLEAN:
5553 dbus_message_iter_get_boolean (iter);
5555 case DBUS_TYPE_INT32:
5556 dbus_message_iter_get_int32 (iter);
5558 case DBUS_TYPE_UINT32:
5559 dbus_message_iter_get_uint32 (iter);
5561 case DBUS_TYPE_INT64:
5562 #ifdef DBUS_HAVE_INT64
5563 dbus_message_iter_get_int64 (iter);
5566 case DBUS_TYPE_UINT64:
5567 #ifdef DBUS_HAVE_INT64
5568 dbus_message_iter_get_uint64 (iter);
5571 case DBUS_TYPE_DOUBLE:
5572 dbus_message_iter_get_double (iter);
5574 case DBUS_TYPE_STRING:
5577 str = dbus_message_iter_get_string (iter);
5580 _dbus_warn ("NULL string in message\n");
5586 case DBUS_TYPE_NAMED:
5589 unsigned char *data;
5592 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
5594 _dbus_warn ("error reading name from named type\n");
5601 case DBUS_TYPE_ARRAY:
5605 if (!dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type))
5607 _dbus_warn ("Failed to init array iterator\n");
5611 while (dbus_message_iter_has_next (&child_iter))
5613 if (!check_message_handling_type (&child_iter, array_type))
5615 _dbus_warn ("error in array element\n");
5619 if (!dbus_message_iter_next (&child_iter))
5624 case DBUS_TYPE_DICT:
5629 if (!dbus_message_iter_init_dict_iterator (iter, &child_iter))
5631 _dbus_warn ("Failed to init dict iterator\n");
5635 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5637 key = dbus_message_iter_get_dict_key (&child_iter);
5640 _dbus_warn ("error reading dict key\n");
5645 if (!check_message_handling_type (&child_iter, entry_type))
5647 _dbus_warn ("error in dict value\n");
5651 if (!dbus_message_iter_next (&child_iter))
5658 _dbus_warn ("unknown type %d\n", type);
5667 check_message_handling (DBusMessage *message)
5669 DBusMessageIter iter;
5672 dbus_uint32_t client_serial;
5676 client_serial = dbus_message_get_serial (message);
5678 /* can't use set_serial due to the assertions at the start of it */
5679 _dbus_marshal_set_uint32 (&message->header,
5680 message->byte_order,
5681 CLIENT_SERIAL_OFFSET,
5684 if (client_serial != dbus_message_get_serial (message))
5686 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5690 /* If we implement message_set_arg (message, n, value)
5691 * then we would want to test it here
5694 dbus_message_iter_init (message, &iter);
5695 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5697 if (!check_message_handling_type (&iter, type))
5700 if (!dbus_message_iter_next (&iter))
5711 check_have_valid_message (DBusMessageLoader *loader)
5713 DBusMessage *message;
5719 if (!_dbus_message_loader_queue_messages (loader))
5720 _dbus_assert_not_reached ("no memory to queue messages");
5722 if (_dbus_message_loader_get_is_corrupted (loader))
5724 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5728 message = _dbus_message_loader_pop_message (loader);
5729 if (message == NULL)
5731 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5735 if (_dbus_string_get_length (&loader->data) > 0)
5737 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5741 /* Verify that we're able to properly deal with the message.
5742 * For example, this would detect improper handling of messages
5743 * in nonstandard byte order.
5745 if (!check_message_handling (message))
5752 dbus_message_unref (message);
5758 check_invalid_message (DBusMessageLoader *loader)
5764 if (!_dbus_message_loader_queue_messages (loader))
5765 _dbus_assert_not_reached ("no memory to queue messages");
5767 if (!_dbus_message_loader_get_is_corrupted (loader))
5769 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
5780 check_incomplete_message (DBusMessageLoader *loader)
5782 DBusMessage *message;
5788 if (!_dbus_message_loader_queue_messages (loader))
5789 _dbus_assert_not_reached ("no memory to queue messages");
5791 if (_dbus_message_loader_get_is_corrupted (loader))
5793 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
5797 message = _dbus_message_loader_pop_message (loader);
5798 if (message != NULL)
5800 _dbus_warn ("loaded message that was expected to be incomplete\n");
5808 dbus_message_unref (message);
5813 check_loader_results (DBusMessageLoader *loader,
5814 DBusMessageValidity validity)
5816 if (!_dbus_message_loader_queue_messages (loader))
5817 _dbus_assert_not_reached ("no memory to queue messages");
5821 case _DBUS_MESSAGE_VALID:
5822 return check_have_valid_message (loader);
5823 case _DBUS_MESSAGE_INVALID:
5824 return check_invalid_message (loader);
5825 case _DBUS_MESSAGE_INCOMPLETE:
5826 return check_incomplete_message (loader);
5827 case _DBUS_MESSAGE_UNKNOWN:
5831 _dbus_assert_not_reached ("bad DBusMessageValidity");
5837 * Loads the message in the given message file.
5839 * @param filename filename to load
5840 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5841 * @param data string to load message into
5842 * @returns #TRUE if the message was loaded
5845 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
5857 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
5858 dbus_error_init (&error);
5859 if (!_dbus_file_get_contents (data, filename, &error))
5861 _dbus_warn ("Could not load message file %s: %s\n",
5862 _dbus_string_get_const_data (filename),
5864 dbus_error_free (&error);
5870 if (!_dbus_message_data_load (data, filename))
5872 _dbus_warn ("Could not load message file %s\n",
5873 _dbus_string_get_const_data (filename));
5886 * Tries loading the message in the given message file
5887 * and verifies that DBusMessageLoader can handle it.
5889 * @param filename filename to load
5890 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
5891 * @param expected_validity what the message has to be like to return #TRUE
5892 * @returns #TRUE if the message has the expected validity
5895 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
5897 DBusMessageValidity expected_validity)
5904 if (!_dbus_string_init (&data))
5905 _dbus_assert_not_reached ("could not allocate string\n");
5907 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
5911 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
5917 if (_dbus_string_get_length (&data) > 0)
5918 _dbus_verbose_bytes_of_string (&data, 0,
5919 _dbus_string_get_length (&data));
5921 _dbus_warn ("Failed message loader test on %s\n",
5922 _dbus_string_get_const_data (filename));
5925 _dbus_string_free (&data);
5931 * Tries loading the given message data.
5934 * @param data the message data
5935 * @param expected_validity what the message has to be like to return #TRUE
5936 * @returns #TRUE if the message has the expected validity
5939 dbus_internal_do_not_use_try_message_data (const DBusString *data,
5940 DBusMessageValidity expected_validity)
5942 DBusMessageLoader *loader;
5950 /* Write the data one byte at a time */
5952 loader = _dbus_message_loader_new ();
5954 /* check some trivial loader functions */
5955 _dbus_message_loader_ref (loader);
5956 _dbus_message_loader_unref (loader);
5957 _dbus_message_loader_get_max_message_size (loader);
5959 len = _dbus_string_get_length (data);
5960 for (i = 0; i < len; i++)
5964 _dbus_message_loader_get_buffer (loader, &buffer);
5965 _dbus_string_append_byte (buffer,
5966 _dbus_string_get_byte (data, i));
5967 _dbus_message_loader_return_buffer (loader, buffer, 1);
5970 if (!check_loader_results (loader, expected_validity))
5973 _dbus_message_loader_unref (loader);
5976 /* Write the data all at once */
5978 loader = _dbus_message_loader_new ();
5983 _dbus_message_loader_get_buffer (loader, &buffer);
5984 _dbus_string_copy (data, 0, buffer,
5985 _dbus_string_get_length (buffer));
5986 _dbus_message_loader_return_buffer (loader, buffer, 1);
5989 if (!check_loader_results (loader, expected_validity))
5992 _dbus_message_loader_unref (loader);
5995 /* Write the data 2 bytes at a time */
5997 loader = _dbus_message_loader_new ();
5999 len = _dbus_string_get_length (data);
6000 for (i = 0; i < len; i += 2)
6004 _dbus_message_loader_get_buffer (loader, &buffer);
6005 _dbus_string_append_byte (buffer,
6006 _dbus_string_get_byte (data, i));
6008 _dbus_string_append_byte (buffer,
6009 _dbus_string_get_byte (data, i+1));
6010 _dbus_message_loader_return_buffer (loader, buffer, 1);
6013 if (!check_loader_results (loader, expected_validity))
6016 _dbus_message_loader_unref (loader);
6024 _dbus_message_loader_unref (loader);
6030 process_test_subdir (const DBusString *test_base_dir,
6032 DBusMessageValidity validity,
6033 DBusForeachMessageFileFunc function,
6036 DBusString test_directory;
6037 DBusString filename;
6045 if (!_dbus_string_init (&test_directory))
6046 _dbus_assert_not_reached ("didn't allocate test_directory\n");
6048 _dbus_string_init_const (&filename, subdir);
6050 if (!_dbus_string_copy (test_base_dir, 0,
6051 &test_directory, 0))
6052 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
6054 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
6055 _dbus_assert_not_reached ("couldn't allocate full path");
6057 _dbus_string_free (&filename);
6058 if (!_dbus_string_init (&filename))
6059 _dbus_assert_not_reached ("didn't allocate filename string\n");
6061 dbus_error_init (&error);
6062 dir = _dbus_directory_open (&test_directory, &error);
6065 _dbus_warn ("Could not open %s: %s\n",
6066 _dbus_string_get_const_data (&test_directory),
6068 dbus_error_free (&error);
6072 printf ("Testing:\n");
6075 while (_dbus_directory_get_next_file (dir, &filename, &error))
6077 DBusString full_path;
6080 if (!_dbus_string_init (&full_path))
6081 _dbus_assert_not_reached ("couldn't init string");
6083 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
6084 _dbus_assert_not_reached ("couldn't copy dir to full_path");
6086 if (!_dbus_concat_dir_and_file (&full_path, &filename))
6087 _dbus_assert_not_reached ("couldn't concat file to dir");
6089 if (_dbus_string_ends_with_c_str (&filename, ".message"))
6091 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
6095 _dbus_verbose ("Skipping non-.message file %s\n",
6096 _dbus_string_get_const_data (&filename));
6097 _dbus_string_free (&full_path);
6102 _dbus_string_get_const_data (&filename));
6104 _dbus_verbose (" expecting %s for %s\n",
6105 validity == _DBUS_MESSAGE_VALID ? "valid" :
6106 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
6107 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")),
6108 _dbus_string_get_const_data (&filename));
6110 if (! (*function) (&full_path, is_raw, validity, user_data))
6112 _dbus_string_free (&full_path);
6116 _dbus_string_free (&full_path);
6119 if (dbus_error_is_set (&error))
6121 _dbus_warn ("Could not get next file in %s: %s\n",
6122 _dbus_string_get_const_data (&test_directory),
6124 dbus_error_free (&error);
6133 _dbus_directory_close (dir);
6134 _dbus_string_free (&test_directory);
6135 _dbus_string_free (&filename);
6141 * Runs the given function on every message file in the test suite.
6142 * The function should return #FALSE on test failure or fatal error.
6144 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
6145 * @param func the function to run
6146 * @param user_data data for function
6147 * @returns #FALSE if there's a failure
6150 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
6151 DBusForeachMessageFileFunc func,
6154 DBusString test_directory;
6159 _dbus_string_init_const (&test_directory, test_data_dir);
6161 if (!process_test_subdir (&test_directory, "valid-messages",
6162 _DBUS_MESSAGE_VALID, func, user_data))
6165 if (!process_test_subdir (&test_directory, "invalid-messages",
6166 _DBUS_MESSAGE_INVALID, func, user_data))
6169 if (!process_test_subdir (&test_directory, "incomplete-messages",
6170 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
6177 _dbus_string_free (&test_directory);
6183 verify_test_message (DBusMessage *message)
6185 DBusMessageIter iter, dict;
6187 dbus_int32_t our_int;
6190 dbus_bool_t our_bool;
6191 dbus_uint32_t our_uint32;
6192 dbus_int32_t *our_uint32_array;
6193 int our_uint32_array_len;
6194 dbus_int32_t *our_int32_array;
6195 int our_int32_array_len;
6196 char **our_string_array;
6197 int our_string_array_len;
6198 #ifdef DBUS_HAVE_INT64
6199 dbus_int64_t our_int64;
6200 dbus_uint64_t our_uint64;
6201 dbus_int64_t *our_uint64_array;
6202 int our_uint64_array_len;
6203 dbus_int64_t *our_int64_array;
6204 int our_int64_array_len;
6206 double *our_double_array;
6207 int our_double_array_len;
6208 unsigned char *our_byte_array;
6209 int our_byte_array_len;
6210 unsigned char *our_boolean_array;
6211 int our_boolean_array_len;
6213 dbus_message_iter_init (message, &iter);
6215 dbus_error_init (&error);
6216 if (!dbus_message_iter_get_args (&iter, &error,
6217 DBUS_TYPE_INT32, &our_int,
6218 #ifdef DBUS_HAVE_INT64
6219 DBUS_TYPE_INT64, &our_int64,
6220 DBUS_TYPE_UINT64, &our_uint64,
6222 DBUS_TYPE_STRING, &our_str,
6223 DBUS_TYPE_DOUBLE, &our_double,
6224 DBUS_TYPE_BOOLEAN, &our_bool,
6225 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
6226 &our_uint32_array, &our_uint32_array_len,
6227 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
6228 &our_int32_array, &our_int32_array_len,
6229 #ifdef DBUS_HAVE_INT64
6230 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
6231 &our_uint64_array, &our_uint64_array_len,
6232 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
6233 &our_int64_array, &our_int64_array_len,
6235 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
6236 &our_string_array, &our_string_array_len,
6237 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
6238 &our_double_array, &our_double_array_len,
6239 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
6240 &our_byte_array, &our_byte_array_len,
6241 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
6242 &our_boolean_array, &our_boolean_array_len,
6245 _dbus_warn ("error: %s - %s\n", error.name,
6246 (error.message != NULL) ? error.message : "no message");
6247 _dbus_assert_not_reached ("Could not get arguments");
6250 if (our_int != -0x12345678)
6251 _dbus_assert_not_reached ("integers differ!");
6253 #ifdef DBUS_HAVE_INT64
6254 if (our_int64 != -0x123456789abcd)
6255 _dbus_assert_not_reached ("64-bit integers differ!");
6256 if (our_uint64 != 0x123456789abcd)
6257 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
6260 if (our_double != 3.14159)
6261 _dbus_assert_not_reached ("doubles differ!");
6263 if (strcmp (our_str, "Test string") != 0)
6264 _dbus_assert_not_reached ("strings differ!");
6265 dbus_free (our_str);
6268 _dbus_assert_not_reached ("booleans differ");
6270 if (our_uint32_array_len != 4 ||
6271 our_uint32_array[0] != 0x12345678 ||
6272 our_uint32_array[1] != 0x23456781 ||
6273 our_uint32_array[2] != 0x34567812 ||
6274 our_uint32_array[3] != 0x45678123)
6275 _dbus_assert_not_reached ("uint array differs");
6276 dbus_free (our_uint32_array);
6278 if (our_int32_array_len != 4 ||
6279 our_int32_array[0] != 0x12345678 ||
6280 our_int32_array[1] != -0x23456781 ||
6281 our_int32_array[2] != 0x34567812 ||
6282 our_int32_array[3] != -0x45678123)
6283 _dbus_assert_not_reached ("int array differs");
6284 dbus_free (our_int32_array);
6286 #ifdef DBUS_HAVE_INT64
6287 if (our_uint64_array_len != 4 ||
6288 our_uint64_array[0] != 0x12345678 ||
6289 our_uint64_array[1] != 0x23456781 ||
6290 our_uint64_array[2] != 0x34567812 ||
6291 our_uint64_array[3] != 0x45678123)
6292 _dbus_assert_not_reached ("uint64 array differs");
6293 dbus_free (our_uint64_array);
6295 if (our_int64_array_len != 4 ||
6296 our_int64_array[0] != 0x12345678 ||
6297 our_int64_array[1] != -0x23456781 ||
6298 our_int64_array[2] != 0x34567812 ||
6299 our_int64_array[3] != -0x45678123)
6300 _dbus_assert_not_reached ("int64 array differs");
6301 dbus_free (our_int64_array);
6302 #endif /* DBUS_HAVE_INT64 */
6304 if (our_string_array_len != 4)
6305 _dbus_assert_not_reached ("string array has wrong length");
6307 if (strcmp (our_string_array[0], "Foo") != 0 ||
6308 strcmp (our_string_array[1], "bar") != 0 ||
6309 strcmp (our_string_array[2], "") != 0 ||
6310 strcmp (our_string_array[3], "woo woo woo woo") != 0)
6311 _dbus_assert_not_reached ("string array differs");
6313 dbus_free_string_array (our_string_array);
6315 if (our_double_array_len != 3)
6316 _dbus_assert_not_reached ("double array had wrong length");
6318 /* On all IEEE machines (i.e. everything sane) exact equality
6319 * should be preserved over the wire
6321 if (our_double_array[0] != 0.1234 ||
6322 our_double_array[1] != 9876.54321 ||
6323 our_double_array[2] != -300.0)
6324 _dbus_assert_not_reached ("double array had wrong values");
6326 dbus_free (our_double_array);
6328 if (our_byte_array_len != 4)
6329 _dbus_assert_not_reached ("byte array had wrong length");
6331 if (our_byte_array[0] != 'a' ||
6332 our_byte_array[1] != 'b' ||
6333 our_byte_array[2] != 'c' ||
6334 our_byte_array[3] != 234)
6335 _dbus_assert_not_reached ("byte array had wrong values");
6337 dbus_free (our_byte_array);
6339 if (our_boolean_array_len != 5)
6340 _dbus_assert_not_reached ("bool array had wrong length");
6342 if (our_boolean_array[0] != TRUE ||
6343 our_boolean_array[1] != FALSE ||
6344 our_boolean_array[2] != TRUE ||
6345 our_boolean_array[3] != TRUE ||
6346 our_boolean_array[4] != FALSE)
6347 _dbus_assert_not_reached ("bool array had wrong values");
6349 dbus_free (our_boolean_array);
6351 if (!dbus_message_iter_next (&iter))
6352 _dbus_assert_not_reached ("Reached end of arguments");
6354 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
6355 _dbus_assert_not_reached ("not dict type");
6357 if (!dbus_message_iter_init_dict_iterator (&iter, &dict))
6358 _dbus_assert_not_reached ("dict iter failed");
6360 our_str = dbus_message_iter_get_dict_key (&dict);
6361 if (our_str == NULL || strcmp (our_str, "test") != 0)
6362 _dbus_assert_not_reached ("wrong dict key");
6363 dbus_free (our_str);
6365 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
6367 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
6368 _dbus_assert_not_reached ("wrong dict entry type");
6371 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
6373 _dbus_verbose ("dict entry val: %x\n", our_uint32);
6374 _dbus_assert_not_reached ("wrong dict entry value");
6377 if (dbus_message_iter_next (&dict))
6378 _dbus_assert_not_reached ("Didn't reach end of dict");
6380 if (!dbus_message_iter_next (&iter))
6381 _dbus_assert_not_reached ("Reached end of arguments");
6383 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
6384 _dbus_assert_not_reached ("wrong type after dict");
6386 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
6387 _dbus_assert_not_reached ("wrong value after dict");
6389 if (dbus_message_iter_next (&iter))
6390 _dbus_assert_not_reached ("Didn't reach end of arguments");
6394 * @ingroup DBusMessageInternals
6395 * Unit test for DBusMessage.
6397 * @returns #TRUE on success.
6400 _dbus_message_test (const char *test_data_dir)
6402 DBusMessage *message;
6403 DBusMessageLoader *loader;
6404 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
6410 const dbus_uint32_t our_uint32_array[] =
6411 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6412 const dbus_uint32_t our_int32_array[] =
6413 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6414 #ifdef DBUS_HAVE_INT64
6415 const dbus_uint64_t our_uint64_array[] =
6416 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6417 const dbus_uint64_t our_int64_array[] =
6418 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6420 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
6421 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
6422 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
6423 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
6425 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
6427 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6428 "/org/freedesktop/TestPath",
6429 "Foo.TestInterface",
6431 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6432 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
6434 _dbus_message_set_serial (message, 1234);
6435 dbus_message_set_sender (message, "org.foo.bar");
6436 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar"));
6437 dbus_message_set_sender (message, NULL);
6438 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar"));
6439 _dbus_assert (dbus_message_get_serial (message) == 1234);
6440 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6442 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6443 dbus_message_set_no_reply (message, TRUE);
6444 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
6445 dbus_message_set_no_reply (message, FALSE);
6446 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6448 dbus_message_unref (message);
6450 /* Test the vararg functions */
6451 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6452 "/org/freedesktop/TestPath",
6453 "Foo.TestInterface",
6455 _dbus_message_set_serial (message, 1);
6456 dbus_message_append_args (message,
6457 DBUS_TYPE_INT32, -0x12345678,
6458 #ifdef DBUS_HAVE_INT64
6459 DBUS_TYPE_INT64, -0x123456789abcd,
6460 DBUS_TYPE_UINT64, 0x123456789abcd,
6462 DBUS_TYPE_STRING, "Test string",
6463 DBUS_TYPE_DOUBLE, 3.14159,
6464 DBUS_TYPE_BOOLEAN, TRUE,
6465 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
6466 _DBUS_N_ELEMENTS (our_uint32_array),
6467 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
6468 _DBUS_N_ELEMENTS (our_int32_array),
6469 #ifdef DBUS_HAVE_INT64
6470 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
6471 _DBUS_N_ELEMENTS (our_uint64_array),
6472 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
6473 _DBUS_N_ELEMENTS (our_int64_array),
6475 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
6476 _DBUS_N_ELEMENTS (our_string_array),
6477 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
6478 _DBUS_N_ELEMENTS (our_double_array),
6479 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
6480 _DBUS_N_ELEMENTS (our_byte_array),
6481 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
6482 _DBUS_N_ELEMENTS (our_boolean_array),
6485 dbus_message_append_iter_init (message, &iter);
6486 dbus_message_iter_append_dict (&iter, &child_iter);
6487 dbus_message_iter_append_dict_key (&child_iter, "test");
6488 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6489 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
6491 _dbus_verbose_bytes_of_string (&message->header, 0,
6492 _dbus_string_get_length (&message->header));
6493 _dbus_verbose_bytes_of_string (&message->body, 0,
6494 _dbus_string_get_length (&message->body));
6496 verify_test_message (message);
6498 copy = dbus_message_copy (message);
6500 _dbus_assert (message->client_serial == copy->client_serial);
6501 _dbus_assert (message->reply_serial == copy->reply_serial);
6502 _dbus_assert (message->header_padding == copy->header_padding);
6504 _dbus_assert (_dbus_string_get_length (&message->header) ==
6505 _dbus_string_get_length (©->header));
6507 _dbus_assert (_dbus_string_get_length (&message->body) ==
6508 _dbus_string_get_length (©->body));
6510 verify_test_message (copy);
6512 name1 = dbus_message_get_interface (message);
6513 name2 = dbus_message_get_interface (copy);
6515 _dbus_assert (strcmp (name1, name2) == 0);
6517 name1 = dbus_message_get_member (message);
6518 name2 = dbus_message_get_member (copy);
6520 _dbus_assert (strcmp (name1, name2) == 0);
6522 dbus_message_unref (message);
6523 dbus_message_unref (copy);
6525 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6526 "/org/freedesktop/TestPath",
6527 "Foo.TestInterface",
6530 _dbus_message_set_serial (message, 1);
6531 dbus_message_set_reply_serial (message, 0x12345678);
6533 dbus_message_append_iter_init (message, &iter);
6534 dbus_message_iter_append_string (&iter, "Test string");
6535 dbus_message_iter_append_int32 (&iter, -0x12345678);
6536 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
6537 dbus_message_iter_append_double (&iter, 3.14159);
6539 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
6540 dbus_message_iter_append_double (&child_iter, 1.5);
6541 dbus_message_iter_append_double (&child_iter, 2.5);
6544 dbus_message_iter_append_dict (&iter, &child_iter);
6545 dbus_message_iter_append_dict_key (&child_iter, "test");
6546 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6548 /* array of array of int32 (in dict) */
6549 dbus_message_iter_append_dict_key (&child_iter, "array");
6550 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
6551 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6552 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
6553 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
6554 _dbus_warn ("next call expected to fail with wrong array type\n");
6555 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
6556 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6557 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
6558 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
6559 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
6561 dbus_message_iter_append_byte (&iter, 0xF0);
6563 dbus_message_iter_append_nil (&iter);
6565 dbus_message_iter_append_named (&iter, "named",
6568 message_iter_test (message);
6570 /* Message loader test */
6571 _dbus_message_lock (message);
6572 loader = _dbus_message_loader_new ();
6574 /* check ref/unref */
6575 _dbus_message_loader_ref (loader);
6576 _dbus_message_loader_unref (loader);
6578 /* Write the header data one byte at a time */
6579 data = _dbus_string_get_const_data (&message->header);
6580 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
6584 _dbus_message_loader_get_buffer (loader, &buffer);
6585 _dbus_string_append_byte (buffer, data[i]);
6586 _dbus_message_loader_return_buffer (loader, buffer, 1);
6589 /* Write the body data one byte at a time */
6590 data = _dbus_string_get_const_data (&message->body);
6591 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
6595 _dbus_message_loader_get_buffer (loader, &buffer);
6596 _dbus_string_append_byte (buffer, data[i]);
6597 _dbus_message_loader_return_buffer (loader, buffer, 1);
6600 dbus_message_unref (message);
6602 /* Now pop back the message */
6603 if (!_dbus_message_loader_queue_messages (loader))
6604 _dbus_assert_not_reached ("no memory to queue messages");
6606 if (_dbus_message_loader_get_is_corrupted (loader))
6607 _dbus_assert_not_reached ("message loader corrupted");
6609 message = _dbus_message_loader_pop_message (loader);
6611 _dbus_assert_not_reached ("received a NULL message");
6613 if (dbus_message_get_reply_serial (message) != 0x12345678)
6614 _dbus_assert_not_reached ("reply serial fields differ");
6616 message_iter_test (message);
6618 dbus_message_unref (message);
6619 _dbus_message_loader_unref (loader);
6621 /* Now load every message in test_data_dir if we have one */
6622 if (test_data_dir == NULL)
6625 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6626 (DBusForeachMessageFileFunc)
6627 dbus_internal_do_not_use_try_message_file,
6631 #endif /* DBUS_BUILD_TESTS */