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 name_offset; /**< Offset to name of field */
51 int value_offset; /**< Offset to value of field */
54 /** Offset to byte order from start of header */
55 #define BYTE_ORDER_OFFSET 0
56 /** Offset to type from start of header */
58 /** Offset to flags from start of header */
59 #define FLAGS_OFFSET 2
60 /** Offset to version from start of header */
61 #define VERSION_OFFSET 3
62 /** Offset to header length from start of header */
63 #define HEADER_LENGTH_OFFSET 4
64 /** Offset to body length from start of header */
65 #define BODY_LENGTH_OFFSET 8
66 /** Offset to client serial from start of header */
67 #define CLIENT_SERIAL_OFFSET 12
71 * @brief Internals of DBusMessage
73 * Object representing a message received from or to be sent to
74 * another application. This is an opaque object, all members
79 DBusAtomic refcount; /**< Reference count */
81 DBusString header; /**< Header network data, stored
82 * separately from body so we can
83 * independently realloc it.
86 HeaderField header_fields[DBUS_HEADER_FIELD_LAST + 1]; /**< Track the location
87 * of each field in "header"
90 dbus_uint32_t client_serial; /**< Cached client serial value for speed */
91 dbus_uint32_t reply_serial; /**< Cached reply serial value for speed */
93 int header_padding; /**< bytes of alignment in header */
95 DBusString body; /**< Body network data. */
97 char byte_order; /**< Message byte order. */
99 DBusList *size_counters; /**< 0-N DBusCounter used to track message size. */
100 long size_counter_delta; /**< Size we incremented the size counters by. */
102 dbus_uint32_t changed_stamp; /**< Incremented when iterators are invalidated. */
104 unsigned int locked : 1; /**< Message being sent, no modifications allowed. */
106 DBusDataSlotList slot_list; /**< Data stored by allocated integer ID */
108 DBusString signature; /**< Signature */
112 DBUS_MESSAGE_ITER_TYPE_MESSAGE,
113 DBUS_MESSAGE_ITER_TYPE_ARRAY,
114 DBUS_MESSAGE_ITER_TYPE_DICT
117 /** typedef for internals of message iterator */
118 typedef struct DBusMessageRealIter DBusMessageRealIter;
121 * @brief Internals of DBusMessageIter
123 * Object representing a position in a message. All fields are internal.
125 struct DBusMessageRealIter
127 DBusMessageRealIter *parent_iter; /**< parent iter, or NULL */
128 DBusMessage *message; /**< Message used */
129 dbus_uint32_t changed_stamp; /**< stamp to detect invalid iters */
131 /* This is an int instead of an enum to get a guaranteed size for the dummy: */
132 int type; /**< type of iter */
134 int pos; /**< Current position in the string */
135 int end; /**< position right after the container */
136 int container_start; /**< offset of the start of the container */
137 int container_length_pos; /**< offset of the length of the container */
139 int wrote_dict_key; /**< whether we wrote the dict key for the current dict element */
141 int array_type_pos; /**< pointer to the position of the array element type */
142 int array_type_done; /**< TRUE if the array type is fully finished */
146 * Gets the data to be sent over the network for this message.
147 * The header and then the body should be written out.
148 * This function is guaranteed to always return the same
149 * data once a message is locked (with _dbus_message_lock()).
151 * @param message the message.
152 * @param header return location for message header data.
153 * @param body return location for message body data.
156 _dbus_message_get_network_data (DBusMessage *message,
157 const DBusString **header,
158 const DBusString **body)
160 _dbus_assert (message->locked);
162 *header = &message->header;
163 *body = &message->body;
167 clear_header_padding (DBusMessage *message)
169 _dbus_string_shorten (&message->header,
170 message->header_padding);
171 message->header_padding = 0;
175 append_header_padding (DBusMessage *message)
178 old_len = _dbus_string_get_length (&message->header);
179 if (!_dbus_string_align_length (&message->header, 8))
182 message->header_padding = _dbus_string_get_length (&message->header) - old_len;
187 #ifdef DBUS_BUILD_TESTS
188 /* tests-only until it's actually used */
190 get_int_field (DBusMessage *message,
195 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
197 offset = message->header_fields[field].value_offset;
200 return -1; /* useless if -1 is a valid value of course */
202 return _dbus_demarshal_int32 (&message->header,
210 get_uint_field (DBusMessage *message,
215 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
217 offset = message->header_fields[field].value_offset;
220 return -1; /* useless if -1 is a valid value of course */
222 return _dbus_demarshal_uint32 (&message->header,
229 get_string_field (DBusMessage *message,
236 offset = message->header_fields[field].value_offset;
238 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
243 /* offset points to string length, string data follows it */
244 /* FIXME _dbus_demarshal_const_string() that returned
245 * a reference to the string plus its len might be nice.
249 *len = _dbus_demarshal_uint32 (&message->header,
254 data = _dbus_string_get_const_data (&message->header);
256 return data + (offset + 4);
259 /* returns FALSE if no memory, TRUE with NULL path if no field */
261 get_path_field_decomposed (DBusMessage *message,
267 offset = message->header_fields[field].value_offset;
269 _dbus_assert (field <= DBUS_HEADER_FIELD_LAST);
277 return _dbus_demarshal_object_path (&message->header,
284 #ifdef DBUS_BUILD_TESTS
286 append_int_field (DBusMessage *message,
290 _dbus_assert (!message->locked);
292 clear_header_padding (message);
294 message->header_fields[field].name_offset =
295 _dbus_string_get_length (&message->header);
297 if (!_dbus_string_append_byte (&message->header, field))
300 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_INT32))
303 if (!_dbus_string_align_length (&message->header, 4))
306 message->header_fields[field].value_offset =
307 _dbus_string_get_length (&message->header);
309 if (!_dbus_marshal_int32 (&message->header, message->byte_order,
313 if (!append_header_padding (message))
319 _dbus_string_set_length (&message->header,
320 message->header_fields[field].name_offset);
321 message->header_fields[field].name_offset = -1;
322 message->header_fields[field].value_offset = -1;
324 /* this must succeed because it was allocated on function entry and
325 * DBusString doesn't ever realloc smaller
327 if (!append_header_padding (message))
328 _dbus_assert_not_reached ("failed to reappend header padding");
334 append_uint_field (DBusMessage *message,
338 _dbus_assert (!message->locked);
340 clear_header_padding (message);
342 message->header_fields[field].name_offset =
343 _dbus_string_get_length (&message->header);
345 if (!_dbus_string_append_byte (&message->header, field))
348 if (!_dbus_string_append_byte (&message->header, DBUS_TYPE_UINT32))
351 if (!_dbus_string_align_length (&message->header, 4))
354 message->header_fields[field].value_offset =
355 _dbus_string_get_length (&message->header);
357 if (!_dbus_marshal_uint32 (&message->header, message->byte_order,
361 if (!append_header_padding (message))
367 _dbus_string_set_length (&message->header,
368 message->header_fields[field].name_offset);
369 message->header_fields[field].name_offset = -1;
370 message->header_fields[field].value_offset = -1;
372 /* this must succeed because it was allocated on function entry and
373 * DBusString doesn't ever realloc smaller
375 if (!append_header_padding (message))
376 _dbus_assert_not_reached ("failed to reappend header padding");
381 append_string_field (DBusMessage *message,
386 _dbus_assert (!message->locked);
388 clear_header_padding (message);
390 message->header_fields[field].name_offset =
391 _dbus_string_get_length (&message->header);
393 if (!_dbus_string_append_byte (&message->header, field))
396 if (!_dbus_string_append_byte (&message->header, type))
399 if (!_dbus_string_align_length (&message->header, 4))
402 message->header_fields[field].value_offset =
403 _dbus_string_get_length (&message->header);
405 if (!_dbus_marshal_string (&message->header, message->byte_order,
409 if (!append_header_padding (message))
415 _dbus_string_set_length (&message->header,
416 message->header_fields[field].name_offset);
417 message->header_fields[field].name_offset = -1;
418 message->header_fields[field].value_offset = -1;
420 /* this must succeed because it was allocated on function entry and
421 * DBusString doesn't ever realloc smaller
423 if (!append_header_padding (message))
424 _dbus_assert_not_reached ("failed to reappend header padding");
430 get_next_field (DBusMessage *message,
433 int offset = message->header_fields[field].name_offset;
436 int retval = DBUS_HEADER_FIELD_INVALID;
439 closest = _DBUS_INT_MAX;
440 while (i < DBUS_HEADER_FIELD_LAST)
442 if (message->header_fields[i].name_offset > offset &&
443 message->header_fields[i].name_offset < closest)
445 closest = message->header_fields[i].name_offset;
455 re_align_field_recurse (DBusMessage *message,
459 int old_name_offset = message->header_fields[field].name_offset;
460 int old_value_offset = message->header_fields[field].value_offset;
461 int prev_padding, padding, delta;
466 /* padding between the typecode byte and the value itself */
467 prev_padding = old_value_offset - old_name_offset + 2;
470 type = _dbus_string_get_byte (&message->header, pos);
477 case DBUS_TYPE_BOOLEAN:
480 case DBUS_TYPE_INT32:
481 case DBUS_TYPE_UINT32:
482 case DBUS_TYPE_STRING:
483 case DBUS_TYPE_OBJECT_PATH:
484 padding = _DBUS_ALIGN_VALUE (pos, 4) - pos;
486 case DBUS_TYPE_INT64:
487 case DBUS_TYPE_UINT64:
488 case DBUS_TYPE_DOUBLE:
489 padding = _DBUS_ALIGN_VALUE (pos, 8) - pos;
491 case DBUS_TYPE_NAMED:
492 case DBUS_TYPE_ARRAY:
494 /* FIXME This is no good; we have to handle undefined header fields
495 * also. SECURITY and spec compliance issue.
497 _dbus_assert_not_reached ("no defined header fields may contain a named, array or dict value");
499 case DBUS_TYPE_INVALID:
501 _dbus_assert_not_reached ("invalid type in marshalled header");
505 delta = padding - prev_padding;
508 if (!_dbus_string_insert_bytes (&message->header, pos, delta, 0))
513 _dbus_string_delete (&message->header, pos, -delta);
516 next_field = get_next_field (message, field);
517 if (next_field != DBUS_HEADER_FIELD_INVALID)
519 int next_offset = message->header_fields[next_field].name_offset;
521 _dbus_assert (next_offset > 0);
523 if (!re_align_field_recurse (message, field,
524 pos + padding + (next_offset - old_value_offset)))
529 if (!append_header_padding (message))
533 message->header_fields[field].name_offset = offset;
534 message->header_fields[field].value_offset = pos + padding;
541 _dbus_string_delete (&message->header, pos, delta);
545 /* this must succeed because it was allocated on function entry and
546 * DBusString doesn't ever realloc smaller
548 _dbus_string_insert_bytes (&message->header, pos, -delta, 0);
555 delete_field (DBusMessage *message,
558 int offset = message->header_fields[field].name_offset;
561 _dbus_assert (!message->locked);
566 clear_header_padding (message);
568 next_field = get_next_field (message, field);
569 if (next_field == DBUS_HEADER_FIELD_INVALID)
571 _dbus_string_set_length (&message->header, offset);
573 message->header_fields[field].name_offset = -1;
574 message->header_fields[field].value_offset = -1;
576 /* this must succeed because it was allocated on function entry and
577 * DBusString doesn't ever realloc smaller
579 if (!append_header_padding (message))
580 _dbus_assert_not_reached ("failed to reappend header padding");
587 int next_offset = message->header_fields[next_field].name_offset;
589 _dbus_assert (next_offset > 0);
591 if (!_dbus_string_init (&deleted))
594 if (!_dbus_string_move_len (&message->header,
595 offset, next_offset - offset,
598 _dbus_string_free (&deleted);
602 /* appends the header padding */
603 if (!re_align_field_recurse (message, next_field, offset))
605 /* this must succeed because it was allocated on function entry and
606 * DBusString doesn't ever realloc smaller
608 if (!_dbus_string_copy (&deleted, 0, &message->header, offset))
609 _dbus_assert_not_reached ("failed to revert to original field");
611 _dbus_string_free (&deleted);
615 _dbus_string_free (&deleted);
617 message->header_fields[field].name_offset = -1;
618 message->header_fields[field].value_offset = -1;
623 /* this must succeed because it was allocated on function entry and
624 * DBusString doesn't ever realloc smaller
626 if (!append_header_padding (message))
627 _dbus_assert_not_reached ("failed to reappend header padding");
633 #ifdef DBUS_BUILD_TESTS
635 set_int_field (DBusMessage *message,
639 int offset = message->header_fields[field].value_offset;
641 _dbus_assert (!message->locked);
645 /* need to append the field */
646 return append_int_field (message, field, value);
650 _dbus_marshal_set_int32 (&message->header,
660 set_uint_field (DBusMessage *message,
664 int offset = message->header_fields[field].value_offset;
666 _dbus_assert (!message->locked);
670 /* need to append the field */
671 return append_uint_field (message, field, value);
675 _dbus_marshal_set_uint32 (&message->header,
684 set_string_field (DBusMessage *message,
689 int offset = message->header_fields[field].value_offset;
691 _dbus_assert (!message->locked);
692 _dbus_assert (value != NULL);
696 /* need to append the field */
697 return append_string_field (message, field, type, value);
707 clear_header_padding (message);
709 old_value = _dbus_demarshal_string (&message->header,
716 len = strlen (value);
718 _dbus_string_init_const_len (&v, value,
719 len + 1); /* include nul */
720 if (!_dbus_marshal_set_string (&message->header,
724 dbus_free (old_value);
728 next_field = get_next_field (message, field);
729 if (next_field != DBUS_HEADER_FIELD_INVALID)
731 /* re-appends the header padding */
732 if (!re_align_field_recurse (message, next_field, next_offset))
734 len = strlen (old_value);
736 _dbus_string_init_const_len (&v, old_value,
737 len + 1); /* include nul */
738 if (!_dbus_marshal_set_string (&message->header,
741 _dbus_assert_not_reached ("failed to revert to original string");
743 dbus_free (old_value);
748 dbus_free (old_value);
753 /* this must succeed because it was allocated on function entry and
754 * DBusString doesn't ever realloc smaller
756 if (!append_header_padding (message))
757 _dbus_assert_not_reached ("failed to reappend header padding");
764 * Sets the serial number of a message.
765 * This can only be done once on a message.
767 * @param message the message
768 * @param serial the serial
771 _dbus_message_set_serial (DBusMessage *message,
774 _dbus_assert (!message->locked);
775 _dbus_assert (dbus_message_get_serial (message) == 0);
777 _dbus_marshal_set_uint32 (&message->header,
779 CLIENT_SERIAL_OFFSET,
782 message->client_serial = serial;
786 * Sets the reply serial of a message (the client serial
787 * of the message this is a reply to).
789 * @param message the message
790 * @param reply_serial the client serial
791 * @returns #FALSE if not enough memory
794 dbus_message_set_reply_serial (DBusMessage *message,
795 dbus_uint32_t reply_serial)
797 _dbus_assert (!message->locked);
799 if (set_uint_field (message,
800 DBUS_HEADER_FIELD_REPLY_SERIAL,
803 message->reply_serial = reply_serial;
811 * Returns the serial of a message or -1 if none has been specified.
812 * The message's serial number is provided by the application sending
813 * the message and is used to identify replies to this message.
815 * @param message the message
816 * @returns the client serial
819 dbus_message_get_serial (DBusMessage *message)
821 return message->client_serial;
825 * Returns the serial that the message is
826 * a reply to or 0 if none.
828 * @param message the message
829 * @returns the reply serial
832 dbus_message_get_reply_serial (DBusMessage *message)
834 return message->reply_serial;
838 * Adds a counter to be incremented immediately with the
839 * size of this message, and decremented by the size
840 * of this message when this message if finalized.
841 * The link contains a counter with its refcount already
842 * incremented, but the counter itself not incremented.
843 * Ownership of link and counter refcount is passed to
846 * @param message the message
847 * @param link link with counter as data
850 _dbus_message_add_size_counter_link (DBusMessage *message,
853 /* right now we don't recompute the delta when message
854 * size changes, and that's OK for current purposes
855 * I think, but could be important to change later.
856 * Do recompute it whenever there are no outstanding counters,
857 * since it's basically free.
859 if (message->size_counters == NULL)
861 message->size_counter_delta =
862 _dbus_string_get_length (&message->header) +
863 _dbus_string_get_length (&message->body);
866 _dbus_verbose ("message has size %ld\n",
867 message->size_counter_delta);
871 _dbus_list_append_link (&message->size_counters, link);
873 _dbus_counter_adjust (link->data, message->size_counter_delta);
877 * Adds a counter to be incremented immediately with the
878 * size of this message, and decremented by the size
879 * of this message when this message if finalized.
881 * @param message the message
882 * @param counter the counter
883 * @returns #FALSE if no memory
886 _dbus_message_add_size_counter (DBusMessage *message,
887 DBusCounter *counter)
891 link = _dbus_list_alloc_link (counter);
895 _dbus_counter_ref (counter);
896 _dbus_message_add_size_counter_link (message, link);
902 * Removes a counter tracking the size of this message, and decrements
903 * the counter by the size of this message.
905 * @param message the message
906 * @param link_return return the link used
907 * @param counter the counter
910 _dbus_message_remove_size_counter (DBusMessage *message,
911 DBusCounter *counter,
912 DBusList **link_return)
916 link = _dbus_list_find_last (&message->size_counters,
918 _dbus_assert (link != NULL);
920 _dbus_list_unlink (&message->size_counters,
925 _dbus_list_free_link (link);
927 _dbus_counter_adjust (counter, message->size_counter_delta);
929 _dbus_counter_unref (counter);
933 dbus_message_create_header (DBusMessage *message,
937 const char *interface,
939 const char *error_name)
943 _dbus_assert ((interface && member) ||
945 !(interface || member || error_name));
947 if (!_dbus_string_append_byte (&message->header, message->byte_order))
950 if (!_dbus_string_append_byte (&message->header, type))
954 if (!_dbus_string_append_byte (&message->header, flags))
957 if (!_dbus_string_append_byte (&message->header, DBUS_MAJOR_PROTOCOL_VERSION))
960 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
963 if (!_dbus_marshal_uint32 (&message->header, message->byte_order, 0))
966 if (!_dbus_marshal_int32 (&message->header, message->byte_order, -1))
969 /* Marshal all the fields (Marshall Fields?) */
973 if (!append_string_field (message,
974 DBUS_HEADER_FIELD_PATH,
975 DBUS_TYPE_OBJECT_PATH,
982 if (!append_string_field (message,
983 DBUS_HEADER_FIELD_SERVICE,
989 if (interface != NULL)
991 if (!append_string_field (message,
992 DBUS_HEADER_FIELD_INTERFACE,
1000 if (!append_string_field (message,
1001 DBUS_HEADER_FIELD_MEMBER,
1007 if (error_name != NULL)
1009 if (!append_string_field (message,
1010 DBUS_HEADER_FIELD_ERROR_NAME,
1020 * Locks a message. Allows checking that applications don't keep a
1021 * reference to a message in the outgoing queue and change it
1022 * underneath us. Messages are locked when they enter the outgoing
1023 * queue (dbus_connection_send_message()), and the library complains
1024 * if the message is modified while locked.
1026 * @param message the message to lock.
1029 _dbus_message_lock (DBusMessage *message)
1031 if (!message->locked)
1033 /* Fill in our lengths */
1034 _dbus_marshal_set_uint32 (&message->header,
1035 message->byte_order,
1036 HEADER_LENGTH_OFFSET,
1037 _dbus_string_get_length (&message->header));
1039 _dbus_marshal_set_uint32 (&message->header,
1040 message->byte_order,
1042 _dbus_string_get_length (&message->body));
1044 message->locked = TRUE;
1051 * @defgroup DBusMessage DBusMessage
1053 * @brief Message to be sent or received over a DBusConnection.
1055 * A DBusMessage is the most basic unit of communication over a
1056 * DBusConnection. A DBusConnection represents a stream of messages
1057 * received from a remote application, and a stream of messages
1058 * sent to a remote application.
1064 * @typedef DBusMessage
1066 * Opaque data type representing a message received from or to be
1067 * sent to another application.
1071 dbus_message_new_empty_header (void)
1073 DBusMessage *message;
1076 message = dbus_new0 (DBusMessage, 1);
1077 if (message == NULL)
1080 message->refcount.value = 1;
1081 message->byte_order = DBUS_COMPILER_BYTE_ORDER;
1082 message->client_serial = 0;
1083 message->reply_serial = 0;
1085 _dbus_data_slot_list_init (&message->slot_list);
1088 while (i <= DBUS_HEADER_FIELD_LAST)
1090 message->header_fields[i].name_offset = -1;
1091 message->header_fields[i].value_offset = -1;
1095 if (!_dbus_string_init_preallocated (&message->header, 64))
1097 dbus_free (message);
1101 if (!_dbus_string_init_preallocated (&message->body, 64))
1103 _dbus_string_free (&message->header);
1104 dbus_free (message);
1108 if (!_dbus_string_init_preallocated (&message->signature, 4))
1110 _dbus_string_free (&message->header);
1111 _dbus_string_free (&message->body);
1112 dbus_free (message);
1120 * Constructs a new message of the given message type.
1121 * Types include #DBUS_MESSAGE_TYPE_METHOD_CALL,
1122 * #DBUS_MESSAGE_TYPE_SIGNAL, and so forth.
1124 * @param message_type type of message
1125 * @returns new message or #NULL If no memory
1128 dbus_message_new (int message_type)
1130 DBusMessage *message;
1132 _dbus_return_val_if_fail (message_type != DBUS_MESSAGE_TYPE_INVALID, NULL);
1134 message = dbus_message_new_empty_header ();
1135 if (message == NULL)
1138 if (!dbus_message_create_header (message,
1140 NULL, NULL, NULL, NULL, NULL))
1142 dbus_message_unref (message);
1150 * Constructs a new message to invoke a method on a remote
1151 * object. Returns #NULL if memory can't be allocated for the
1152 * message. The service may be #NULL in which case no service is set;
1153 * this is appropriate when using D-BUS in a peer-to-peer context (no
1154 * message bus). The interface may be #NULL, which means that
1155 * if multiple methods with the given name exist it is undefined
1156 * which one will be invoked.
1158 * @param service service that the message should be sent to or #NULL
1159 * @param path object path the message should be sent to
1160 * @param interface interface to invoke method on
1161 * @param method method to invoke
1163 * @returns a new DBusMessage, free with dbus_message_unref()
1164 * @see dbus_message_unref()
1167 dbus_message_new_method_call (const char *service,
1169 const char *interface,
1172 DBusMessage *message;
1174 _dbus_return_val_if_fail (path != NULL, NULL);
1175 _dbus_return_val_if_fail (method != NULL, NULL);
1177 message = dbus_message_new_empty_header ();
1178 if (message == NULL)
1181 if (!dbus_message_create_header (message,
1182 DBUS_MESSAGE_TYPE_METHOD_CALL,
1183 service, path, interface, method, NULL))
1185 dbus_message_unref (message);
1193 * Constructs a message that is a reply to a method call. Returns
1194 * #NULL if memory can't be allocated for the message.
1196 * @param method_call the message which the created
1197 * message is a reply to.
1198 * @returns a new DBusMessage, free with dbus_message_unref()
1199 * @see dbus_message_new_method_call(), dbus_message_unref()
1202 dbus_message_new_method_return (DBusMessage *method_call)
1204 DBusMessage *message;
1207 _dbus_return_val_if_fail (method_call != NULL, NULL);
1209 sender = get_string_field (method_call,
1210 DBUS_HEADER_FIELD_SENDER_SERVICE,
1213 /* sender is allowed to be null here in peer-to-peer case */
1215 message = dbus_message_new_empty_header ();
1216 if (message == NULL)
1219 if (!dbus_message_create_header (message,
1220 DBUS_MESSAGE_TYPE_METHOD_RETURN,
1221 sender, NULL, NULL, NULL, NULL))
1223 dbus_message_unref (message);
1227 if (!dbus_message_set_reply_serial (message,
1228 dbus_message_get_serial (method_call)))
1230 dbus_message_unref (message);
1238 * Constructs a new message representing a signal emission. Returns
1239 * #NULL if memory can't be allocated for the message.
1240 * A signal is identified by its originating interface, and
1241 * the name of the signal.
1243 * @param path the path to the object emitting the signal
1244 * @param interface the interface the signal is emitted from
1245 * @param name name of the signal
1246 * @returns a new DBusMessage, free with dbus_message_unref()
1247 * @see dbus_message_unref()
1250 dbus_message_new_signal (const char *path,
1251 const char *interface,
1254 DBusMessage *message;
1256 _dbus_return_val_if_fail (path != NULL, NULL);
1257 _dbus_return_val_if_fail (interface != NULL, NULL);
1258 _dbus_return_val_if_fail (name != NULL, NULL);
1260 message = dbus_message_new_empty_header ();
1261 if (message == NULL)
1264 if (!dbus_message_create_header (message,
1265 DBUS_MESSAGE_TYPE_SIGNAL,
1266 NULL, path, interface, name, NULL))
1268 dbus_message_unref (message);
1276 * Creates a new message that is an error reply to a certain message.
1277 * Error replies are possible in response to method calls primarily.
1279 * @param reply_to the original message
1280 * @param error_name the error name
1281 * @param error_message the error message string or #NULL for none
1282 * @returns a new error message
1285 dbus_message_new_error (DBusMessage *reply_to,
1286 const char *error_name,
1287 const char *error_message)
1289 DBusMessage *message;
1291 DBusMessageIter iter;
1293 _dbus_return_val_if_fail (reply_to != NULL, NULL);
1294 _dbus_return_val_if_fail (error_name != NULL, NULL);
1296 sender = get_string_field (reply_to,
1297 DBUS_HEADER_FIELD_SENDER_SERVICE,
1300 /* sender may be NULL for non-message-bus case or
1301 * when the message bus is dealing with an unregistered
1304 message = dbus_message_new_empty_header ();
1305 if (message == NULL)
1308 if (!dbus_message_create_header (message,
1309 DBUS_MESSAGE_TYPE_ERROR,
1310 sender, NULL, NULL, NULL, error_name))
1312 dbus_message_unref (message);
1316 if (!dbus_message_set_reply_serial (message,
1317 dbus_message_get_serial (reply_to)))
1319 dbus_message_unref (message);
1323 if (error_message != NULL)
1325 dbus_message_append_iter_init (message, &iter);
1326 if (!dbus_message_iter_append_string (&iter, error_message))
1328 dbus_message_unref (message);
1337 * Creates a new message that is an exact replica of the message
1338 * specified, except that its refcount is set to 1.
1340 * @param message the message.
1341 * @returns the new message.
1344 dbus_message_copy (const DBusMessage *message)
1346 DBusMessage *retval;
1349 _dbus_return_val_if_fail (message != NULL, NULL);
1351 retval = dbus_new0 (DBusMessage, 1);
1355 retval->refcount.value = 1;
1356 retval->byte_order = message->byte_order;
1357 retval->client_serial = message->client_serial;
1358 retval->reply_serial = message->reply_serial;
1359 retval->header_padding = message->header_padding;
1360 retval->locked = FALSE;
1362 if (!_dbus_string_init_preallocated (&retval->header,
1363 _dbus_string_get_length (&message->header)))
1369 if (!_dbus_string_init_preallocated (&retval->body,
1370 _dbus_string_get_length (&message->body)))
1372 _dbus_string_free (&retval->header);
1377 if (!_dbus_string_init_preallocated (&retval->signature,
1378 _dbus_string_get_length (&message->signature)))
1380 _dbus_string_free (&retval->header);
1381 _dbus_string_free (&retval->body);
1386 if (!_dbus_string_copy (&message->header, 0,
1387 &retval->header, 0))
1390 if (!_dbus_string_copy (&message->body, 0,
1394 if (!_dbus_string_copy (&message->signature, 0,
1395 &retval->signature, 0))
1398 for (i = 0; i <= DBUS_HEADER_FIELD_LAST; i++)
1400 retval->header_fields[i] = message->header_fields[i];
1406 _dbus_string_free (&retval->header);
1407 _dbus_string_free (&retval->body);
1408 _dbus_string_free (&retval->signature);
1416 * Increments the reference count of a DBusMessage.
1418 * @param message The message
1419 * @see dbus_message_unref
1422 dbus_message_ref (DBusMessage *message)
1424 dbus_int32_t old_refcount;
1426 _dbus_return_if_fail (message != NULL);
1428 old_refcount = _dbus_atomic_inc (&message->refcount);
1429 _dbus_assert (old_refcount >= 1);
1433 free_size_counter (void *element,
1436 DBusCounter *counter = element;
1437 DBusMessage *message = data;
1439 _dbus_counter_adjust (counter, - message->size_counter_delta);
1441 _dbus_counter_unref (counter);
1445 * Decrements the reference count of a DBusMessage.
1447 * @param message The message
1448 * @see dbus_message_ref
1451 dbus_message_unref (DBusMessage *message)
1453 dbus_int32_t old_refcount;
1455 _dbus_return_if_fail (message != NULL);
1457 old_refcount = _dbus_atomic_dec (&message->refcount);
1459 _dbus_assert (old_refcount >= 0);
1461 if (old_refcount == 1)
1463 /* This calls application callbacks! */
1464 _dbus_data_slot_list_free (&message->slot_list);
1466 _dbus_list_foreach (&message->size_counters,
1467 free_size_counter, message);
1468 _dbus_list_clear (&message->size_counters);
1470 _dbus_string_free (&message->header);
1471 _dbus_string_free (&message->body);
1472 _dbus_string_free (&message->signature);
1474 dbus_free (message);
1479 * Gets the type of a message. Types include
1480 * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN,
1481 * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types
1482 * are allowed and all code must silently ignore messages of unknown
1483 * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however.
1486 * @param message the message
1487 * @returns the type of the message
1490 dbus_message_get_type (DBusMessage *message)
1494 type = _dbus_string_get_byte (&message->header, 1);
1495 _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID);
1501 * Sets the object path this message is being sent to (for
1502 * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being
1503 * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL).
1505 * @param message the message
1506 * @param object_path the path
1507 * @returns #FALSE if not enough memory
1510 dbus_message_set_path (DBusMessage *message,
1511 const char *object_path)
1513 _dbus_return_val_if_fail (message != NULL, FALSE);
1514 _dbus_return_val_if_fail (!message->locked, FALSE);
1516 if (object_path == NULL)
1518 delete_field (message, DBUS_HEADER_FIELD_PATH);
1523 return set_string_field (message,
1524 DBUS_HEADER_FIELD_PATH,
1525 DBUS_TYPE_OBJECT_PATH,
1531 * Gets the object path this message is being sent to
1532 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1533 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1535 * @param message the message
1536 * @returns the path (should not be freed)
1539 dbus_message_get_path (DBusMessage *message)
1541 _dbus_return_val_if_fail (message != NULL, NULL);
1543 return get_string_field (message, DBUS_HEADER_FIELD_PATH, NULL);
1547 * Gets the object path this message is being sent to
1548 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1549 * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed
1550 * format (one array element per path component).
1551 * Free the returned array with dbus_free_string_array().
1553 * An empty but non-NULL path array means the path "/".
1554 * So the path "/foo/bar" becomes { "foo", "bar", NULL }
1555 * and the path "/" becomes { NULL }.
1557 * @param message the message
1558 * @param path place to store allocated array of path components; #NULL set here if no path field exists
1559 * @returns #FALSE if no memory to allocate the array
1562 dbus_message_get_path_decomposed (DBusMessage *message,
1565 _dbus_return_val_if_fail (message != NULL, FALSE);
1566 _dbus_return_val_if_fail (path != NULL, FALSE);
1568 return get_path_field_decomposed (message,
1569 DBUS_HEADER_FIELD_PATH,
1574 * Sets the interface this message is being sent to
1575 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or
1576 * the interface a signal is being emitted from
1577 * (for DBUS_MESSAGE_TYPE_SIGNAL).
1579 * @param message the message
1580 * @param interface the interface
1581 * @returns #FALSE if not enough memory
1584 dbus_message_set_interface (DBusMessage *message,
1585 const char *interface)
1587 _dbus_return_val_if_fail (message != NULL, FALSE);
1588 _dbus_return_val_if_fail (!message->locked, FALSE);
1590 if (interface == NULL)
1592 delete_field (message, DBUS_HEADER_FIELD_INTERFACE);
1597 return set_string_field (message,
1598 DBUS_HEADER_FIELD_INTERFACE,
1605 * Gets the interface this message is being sent to
1606 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1607 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1608 * The interface name is fully-qualified (namespaced).
1610 * @param message the message
1611 * @returns the message interface (should not be freed)
1614 dbus_message_get_interface (DBusMessage *message)
1616 _dbus_return_val_if_fail (message != NULL, NULL);
1618 return get_string_field (message, DBUS_HEADER_FIELD_INTERFACE, NULL);
1622 * Sets the interface member being invoked
1623 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1624 * (DBUS_MESSAGE_TYPE_SIGNAL).
1625 * The interface name is fully-qualified (namespaced).
1627 * @param message the message
1628 * @param member the member
1629 * @returns #FALSE if not enough memory
1632 dbus_message_set_member (DBusMessage *message,
1635 _dbus_return_val_if_fail (message != NULL, FALSE);
1636 _dbus_return_val_if_fail (!message->locked, FALSE);
1640 delete_field (message, DBUS_HEADER_FIELD_MEMBER);
1645 return set_string_field (message,
1646 DBUS_HEADER_FIELD_MEMBER,
1653 * Gets the interface member being invoked
1654 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1655 * (DBUS_MESSAGE_TYPE_SIGNAL).
1657 * @param message the message
1658 * @returns the member name (should not be freed)
1661 dbus_message_get_member (DBusMessage *message)
1663 _dbus_return_val_if_fail (message != NULL, NULL);
1665 return get_string_field (message,
1666 DBUS_HEADER_FIELD_MEMBER,
1671 * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
1672 * The name is fully-qualified (namespaced).
1674 * @param message the message
1675 * @param error_name the name
1676 * @returns #FALSE if not enough memory
1679 dbus_message_set_error_name (DBusMessage *message,
1680 const char *error_name)
1682 _dbus_return_val_if_fail (message != NULL, FALSE);
1683 _dbus_return_val_if_fail (!message->locked, FALSE);
1685 if (error_name == NULL)
1687 delete_field (message, DBUS_HEADER_FIELD_ERROR_NAME);
1692 return set_string_field (message,
1693 DBUS_HEADER_FIELD_ERROR_NAME,
1700 * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only).
1702 * @param message the message
1703 * @returns the error name (should not be freed)
1706 dbus_message_get_error_name (DBusMessage *message)
1708 _dbus_return_val_if_fail (message != NULL, NULL);
1710 return get_string_field (message,
1711 DBUS_HEADER_FIELD_ERROR_NAME,
1716 * Sets the message's destination service.
1718 * @param message the message
1719 * @param destination the destination service name
1720 * @returns #FALSE if not enough memory
1723 dbus_message_set_destination (DBusMessage *message,
1724 const char *destination)
1726 _dbus_return_val_if_fail (message != NULL, FALSE);
1727 _dbus_return_val_if_fail (!message->locked, FALSE);
1729 if (destination == NULL)
1731 delete_field (message, DBUS_HEADER_FIELD_SERVICE);
1736 return set_string_field (message,
1737 DBUS_HEADER_FIELD_SERVICE,
1744 * Gets the destination service of a message.
1746 * @param message the message
1747 * @returns the message destination service (should not be freed)
1750 dbus_message_get_destination (DBusMessage *message)
1752 _dbus_return_val_if_fail (message != NULL, NULL);
1754 return get_string_field (message,
1755 DBUS_HEADER_FIELD_SERVICE,
1760 * Appends fields to a message given a variable argument list. The
1761 * variable argument list should contain the type of the argument
1762 * followed by the value to add. Array values are specified by an int
1763 * typecode followed by a pointer to the array followed by an int
1764 * giving the length of the array. The argument list must be
1765 * terminated with #DBUS_TYPE_INVALID.
1767 * This function doesn't support dicts or non-fundamental arrays.
1769 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1770 * only if #DBUS_HAVE_INT64 is defined.
1772 * @param message the message
1773 * @param first_arg_type type of the first argument
1774 * @param ... value of first argument, list of additional type-value pairs
1775 * @returns #TRUE on success
1778 dbus_message_append_args (DBusMessage *message,
1785 _dbus_return_val_if_fail (message != NULL, FALSE);
1787 va_start (var_args, first_arg_type);
1788 retval = dbus_message_append_args_valist (message,
1797 * This function takes a va_list for use by language bindings.
1798 * It's otherwise the same as dbus_message_append_args().
1800 * @todo: Shouldn't this function clean up the changes to the message
1801 * on failures? (Yes)
1803 * @see dbus_message_append_args.
1804 * @param message the message
1805 * @param first_arg_type type of first argument
1806 * @param var_args value of first argument, then list of type/value pairs
1807 * @returns #TRUE on success
1810 dbus_message_append_args_valist (DBusMessage *message,
1815 DBusMessageIter iter;
1817 _dbus_return_val_if_fail (message != NULL, FALSE);
1819 old_len = _dbus_string_get_length (&message->body);
1821 type = first_arg_type;
1823 dbus_message_append_iter_init (message, &iter);
1830 if (!dbus_message_iter_append_nil (&iter))
1833 case DBUS_TYPE_BOOLEAN:
1834 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1837 case DBUS_TYPE_INT32:
1838 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1841 case DBUS_TYPE_UINT32:
1842 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1845 #ifdef DBUS_HAVE_INT64
1846 case DBUS_TYPE_INT64:
1847 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1850 case DBUS_TYPE_UINT64:
1851 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1854 #endif /* DBUS_HAVE_INT64 */
1855 case DBUS_TYPE_DOUBLE:
1856 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1859 case DBUS_TYPE_STRING:
1860 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1863 case DBUS_TYPE_NAMED:
1866 unsigned char *data;
1869 name = va_arg (var_args, const char *);
1870 data = va_arg (var_args, unsigned char *);
1871 len = va_arg (var_args, int);
1873 if (!dbus_message_iter_append_named (&iter, name, data, len))
1877 case DBUS_TYPE_ARRAY:
1882 type = va_arg (var_args, int);
1883 data = va_arg (var_args, void *);
1884 len = va_arg (var_args, int);
1888 case DBUS_TYPE_BYTE:
1889 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1892 case DBUS_TYPE_BOOLEAN:
1893 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1896 case DBUS_TYPE_INT32:
1897 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1900 case DBUS_TYPE_UINT32:
1901 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1904 #ifdef DBUS_HAVE_INT64
1905 case DBUS_TYPE_INT64:
1906 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1909 case DBUS_TYPE_UINT64:
1910 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1913 #endif /* DBUS_HAVE_INT64 */
1914 case DBUS_TYPE_DOUBLE:
1915 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1918 case DBUS_TYPE_STRING:
1919 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1923 case DBUS_TYPE_ARRAY:
1924 case DBUS_TYPE_NAMED:
1925 case DBUS_TYPE_DICT:
1926 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1929 _dbus_warn ("Unknown field type %d\n", type);
1935 case DBUS_TYPE_DICT:
1936 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1939 _dbus_warn ("Unknown field type %d\n", type);
1943 type = va_arg (var_args, int);
1954 * Gets arguments from a message given a variable argument list.
1955 * The variable argument list should contain the type of the
1956 * argumen followed by a pointer to where the value should be
1957 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1959 * @param message the message
1960 * @param error error to be filled in on failure
1961 * @param first_arg_type the first argument type
1962 * @param ... location for first argument value, then list of type-location pairs
1963 * @returns #FALSE if the error was set
1966 dbus_message_get_args (DBusMessage *message,
1974 _dbus_return_val_if_fail (message != NULL, FALSE);
1975 _dbus_return_val_if_error_is_set (error, FALSE);
1977 va_start (var_args, first_arg_type);
1978 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1985 * This function takes a va_list for use by language bindings
1987 * @todo We need to free the argument data when an error occurs.
1989 * @see dbus_message_get_args
1990 * @param message the message
1991 * @param error error to be filled in
1992 * @param first_arg_type type of the first argument
1993 * @param var_args return location for first argument, followed by list of type/location pairs
1994 * @returns #FALSE if error was set
1997 dbus_message_get_args_valist (DBusMessage *message,
2002 DBusMessageIter iter;
2004 _dbus_return_val_if_fail (message != NULL, FALSE);
2005 _dbus_return_val_if_error_is_set (error, FALSE);
2007 dbus_message_iter_init (message, &iter);
2008 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
2012 * Gets arguments from a message iterator given a variable argument list.
2013 * The variable argument list should contain the type of the
2014 * argumen followed by a pointer to where the value should be
2015 * stored. The list is terminated with 0.
2017 * @param iter the message iterator
2018 * @param error error to be filled in on failure
2019 * @param first_arg_type the first argument type
2020 * @param ... location for first argument value, then list of type-location pairs
2021 * @returns #FALSE if the error was set
2024 dbus_message_iter_get_args (DBusMessageIter *iter,
2032 _dbus_return_val_if_fail (iter != NULL, FALSE);
2033 _dbus_return_val_if_error_is_set (error, FALSE);
2035 va_start (var_args, first_arg_type);
2036 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
2043 * This function takes a va_list for use by language bindings
2045 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
2046 * only if #DBUS_HAVE_INT64 is defined.
2048 * @todo this function (or some lower-level non-convenience function)
2049 * needs better error handling; should allow the application to
2050 * distinguish between out of memory, and bad data from the remote
2051 * app. It also needs to not leak a bunch of args when it gets
2052 * to the arg that's bad, as that would be a security hole
2053 * (allow one app to force another to leak memory)
2055 * @todo We need to free the argument data when an error occurs.
2057 * @see dbus_message_get_args
2058 * @param iter the message iter
2059 * @param error error to be filled in
2060 * @param first_arg_type type of the first argument
2061 * @param var_args return location for first argument, followed by list of type/location pairs
2062 * @returns #FALSE if error was set
2065 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
2070 int spec_type, msg_type, i;
2073 _dbus_return_val_if_fail (iter != NULL, FALSE);
2074 _dbus_return_val_if_error_is_set (error, FALSE);
2078 spec_type = first_arg_type;
2081 while (spec_type != 0)
2083 msg_type = dbus_message_iter_get_arg_type (iter);
2085 if (msg_type != spec_type)
2087 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2088 "Argument %d is specified to be of type \"%s\", but "
2089 "is actually of type \"%s\"\n", i,
2090 _dbus_type_to_string (spec_type),
2091 _dbus_type_to_string (msg_type));
2100 case DBUS_TYPE_BYTE:
2104 ptr = va_arg (var_args, unsigned char *);
2106 *ptr = dbus_message_iter_get_byte (iter);
2109 case DBUS_TYPE_BOOLEAN:
2113 ptr = va_arg (var_args, dbus_bool_t *);
2115 *ptr = dbus_message_iter_get_boolean (iter);
2118 case DBUS_TYPE_INT32:
2122 ptr = va_arg (var_args, dbus_int32_t *);
2124 *ptr = dbus_message_iter_get_int32 (iter);
2127 case DBUS_TYPE_UINT32:
2131 ptr = va_arg (var_args, dbus_uint32_t *);
2133 *ptr = dbus_message_iter_get_uint32 (iter);
2136 #ifdef DBUS_HAVE_INT64
2137 case DBUS_TYPE_INT64:
2141 ptr = va_arg (var_args, dbus_int64_t *);
2143 *ptr = dbus_message_iter_get_int64 (iter);
2146 case DBUS_TYPE_UINT64:
2150 ptr = va_arg (var_args, dbus_uint64_t *);
2152 *ptr = dbus_message_iter_get_uint64 (iter);
2155 #endif /* DBUS_HAVE_INT64 */
2157 case DBUS_TYPE_DOUBLE:
2161 ptr = va_arg (var_args, double *);
2163 *ptr = dbus_message_iter_get_double (iter);
2167 case DBUS_TYPE_STRING:
2171 ptr = va_arg (var_args, char **);
2173 *ptr = dbus_message_iter_get_string (iter);
2177 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2184 case DBUS_TYPE_NAMED:
2187 unsigned char **data;
2190 name = va_arg (var_args, char **);
2191 data = va_arg (var_args, unsigned char **);
2192 len = va_arg (var_args, int *);
2194 if (!dbus_message_iter_get_named (iter, name, data, len))
2196 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2201 case DBUS_TYPE_ARRAY:
2206 type = va_arg (var_args, int);
2207 data = va_arg (var_args, void *);
2208 len = va_arg (var_args, int *);
2210 if (dbus_message_iter_get_array_type (iter) != type)
2212 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2213 "Argument %d is specified to be of type \"array of %s\", but "
2214 "is actually of type \"array of %s\"\n", i,
2215 _dbus_type_to_string (type),
2216 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
2222 case DBUS_TYPE_BYTE:
2223 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
2225 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2229 case DBUS_TYPE_BOOLEAN:
2230 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
2232 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2236 case DBUS_TYPE_INT32:
2237 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
2239 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2243 case DBUS_TYPE_UINT32:
2244 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
2246 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2250 #ifdef DBUS_HAVE_INT64
2251 case DBUS_TYPE_INT64:
2252 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
2254 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2258 case DBUS_TYPE_UINT64:
2259 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
2261 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2265 #endif /* DBUS_HAVE_INT64 */
2266 case DBUS_TYPE_DOUBLE:
2267 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
2269 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2273 case DBUS_TYPE_STRING:
2274 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
2276 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2281 case DBUS_TYPE_ARRAY:
2282 case DBUS_TYPE_NAMED:
2283 case DBUS_TYPE_DICT:
2284 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
2285 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2288 _dbus_warn ("Unknown field type %d\n", type);
2289 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2294 case DBUS_TYPE_DICT:
2295 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
2296 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2299 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2300 _dbus_warn ("Unknown field type %d\n", spec_type);
2304 spec_type = va_arg (var_args, int);
2305 if (spec_type != 0 && !dbus_message_iter_next (iter))
2307 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2308 "Message has only %d arguments, but more were expected", i);
2324 * Initializes a DBusMessageIter representing the arguments of the
2325 * message passed in.
2327 * @param message the message
2328 * @param iter pointer to an iterator to initialize
2331 dbus_message_iter_init (DBusMessage *message,
2332 DBusMessageIter *iter)
2334 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2336 _dbus_return_if_fail (message != NULL);
2337 _dbus_return_if_fail (iter != NULL);
2339 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
2341 real->message = message;
2342 real->parent_iter = NULL;
2343 real->changed_stamp = message->changed_stamp;
2345 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2347 real->end = _dbus_string_get_length (&message->body);
2349 real->container_start = 0;
2350 real->container_length_pos = 0;
2351 real->wrote_dict_key = 0;
2352 real->array_type_pos = 0;
2355 #ifndef DBUS_DISABLE_CHECKS
2357 dbus_message_iter_check (DBusMessageRealIter *iter)
2361 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
2365 if (iter->changed_stamp != iter->message->changed_stamp)
2367 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
2371 if (iter->pos < 0 || iter->pos > iter->end)
2373 _dbus_warn ("dbus iterator check failed: invalid position\n");
2379 #endif /* DBUS_DISABLE_CHECKS */
2382 skip_array_type (DBusMessageRealIter *iter, int pos)
2388 data = _dbus_string_get_const_data_len (&iter->message->body,
2391 while (*data == DBUS_TYPE_ARRAY);
2396 /* FIXME what are these _dbus_type_is_valid() checks for?
2397 * haven't we validated the message?
2400 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
2407 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2408 data = _dbus_string_get_const_data_len (&iter->message->body,
2410 if (_dbus_type_is_valid (*data))
2413 *type = DBUS_TYPE_INVALID;
2415 return skip_array_type (iter, iter->pos);
2417 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2418 data = _dbus_string_get_const_data_len (&iter->message->body,
2419 iter->array_type_pos, 1);
2420 if (_dbus_type_is_valid (*data))
2423 *type = DBUS_TYPE_INVALID;
2427 case DBUS_MESSAGE_ITER_TYPE_DICT:
2428 /* Get the length of the string */
2429 len = _dbus_demarshal_uint32 (&iter->message->body,
2430 iter->message->byte_order,
2432 pos = pos + len + 1;
2434 data = _dbus_string_get_const_data_len (&iter->message->body,
2436 if (_dbus_type_is_valid (*data))
2439 *type = DBUS_TYPE_INVALID;
2441 return skip_array_type (iter, pos);
2444 _dbus_assert_not_reached ("Invalid iter type");
2447 *type = DBUS_TYPE_INVALID;
2453 * Checks if an iterator has any more fields.
2455 * @param iter the message iter
2456 * @returns #TRUE if there are more fields
2460 dbus_message_iter_has_next (DBusMessageIter *iter)
2462 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2466 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2468 if (real->pos >= real->end)
2471 pos = dbus_message_iter_get_data_start (real, &type);
2473 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2474 real->message->byte_order,
2475 type, pos, &end_pos))
2478 if (end_pos >= real->end)
2485 * Moves the iterator to the next field.
2487 * @param iter The message iter
2488 * @returns #TRUE if the iterator was moved to the next field
2491 dbus_message_iter_next (DBusMessageIter *iter)
2493 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2497 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2499 pos = dbus_message_iter_get_data_start (real, &type);
2501 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2502 real->message->byte_order,
2503 type, pos, &end_pos))
2506 if (end_pos >= real->end)
2509 real->pos = end_pos;
2515 * Returns the argument type of the argument that the
2516 * message iterator points at.
2518 * @param iter the message iter
2519 * @returns the field type
2522 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
2524 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2527 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2529 if (real->pos >= real->end)
2530 return DBUS_TYPE_INVALID;
2532 pos = dbus_message_iter_get_data_start (real, &type);
2537 /* FIXME why do we validate the typecode in here, hasn't the message
2538 * already been verified?
2541 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2544 int _array_type_pos;
2549 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2550 _array_type_pos = iter->pos + 1;
2552 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2553 _array_type_pos = iter->array_type_pos + 1;
2555 case DBUS_MESSAGE_ITER_TYPE_DICT:
2556 /* Get the length of the string */
2557 len = _dbus_demarshal_uint32 (&iter->message->body,
2558 iter->message->byte_order,
2560 pos = pos + len + 1;
2561 data = _dbus_string_get_const_data_len (&iter->message->body,
2563 _array_type_pos = pos + 1;
2566 _dbus_assert_not_reached ("wrong iter type");
2567 return DBUS_TYPE_INVALID;
2570 if (array_type_pos != NULL)
2571 *array_type_pos = _array_type_pos;
2573 data = _dbus_string_get_const_data_len (&iter->message->body,
2574 _array_type_pos, 1);
2575 if (_dbus_type_is_valid (*data))
2578 return DBUS_TYPE_INVALID;
2583 * Returns the element type of the array that the
2584 * message iterator points at. Note that you need
2585 * to check that the iterator points to an array
2586 * prior to using this function.
2588 * @param iter the message iter
2589 * @returns the field type
2592 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2594 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2597 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2599 if (real->pos >= real->end)
2600 return DBUS_TYPE_INVALID;
2602 pos = dbus_message_iter_get_data_start (real, &type);
2604 _dbus_assert (type == DBUS_TYPE_ARRAY);
2606 return iter_get_array_type (real, NULL);
2611 * Returns the string value that an iterator may point to.
2612 * Note that you need to check that the iterator points to
2613 * a string value before using this function.
2615 * @see dbus_message_iter_get_arg_type
2616 * @param iter the message iter
2617 * @returns the string
2620 dbus_message_iter_get_string (DBusMessageIter *iter)
2622 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2625 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2627 pos = dbus_message_iter_get_data_start (real, &type);
2629 _dbus_assert (type == DBUS_TYPE_STRING);
2631 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2636 * Returns the name and data from a named type that an
2637 * iterator may point to. Note that you need to check that
2638 * the iterator points to a named type before using this
2641 * @see dbus_message_iter_get_arg_type
2642 * @param iter the message iter
2643 * @param name return location for the name
2644 * @param value return location for data
2645 * @param len return location for length of data
2646 * @returns TRUE if get succeed
2650 dbus_message_iter_get_named (DBusMessageIter *iter,
2652 unsigned char **value,
2655 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2659 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2661 pos = dbus_message_iter_get_data_start (real, &type);
2663 _dbus_assert (type == DBUS_TYPE_NAMED);
2665 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2671 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2672 pos, NULL, value, len))
2684 * Returns the byte value that an iterator may point to.
2685 * Note that you need to check that the iterator points to
2686 * a byte value before using this function.
2688 * @see dbus_message_iter_get_arg_type
2689 * @param iter the message iter
2690 * @returns the byte value
2693 dbus_message_iter_get_byte (DBusMessageIter *iter)
2695 unsigned char value;
2696 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2699 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2701 pos = dbus_message_iter_get_data_start (real, &type);
2703 _dbus_assert (type == DBUS_TYPE_BYTE);
2705 value = _dbus_string_get_byte (&real->message->body, pos);
2712 * Returns the boolean value that an iterator may point to.
2713 * Note that you need to check that the iterator points to
2714 * a boolean value before using this function.
2716 * @see dbus_message_iter_get_arg_type
2717 * @param iter the message iter
2718 * @returns the boolean value
2721 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2723 unsigned char value;
2724 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2727 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2729 pos = dbus_message_iter_get_data_start (real, &type);
2731 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2733 value = _dbus_string_get_byte (&real->message->body, pos);
2739 * Returns the 32 bit signed integer value that an iterator may point to.
2740 * Note that you need to check that the iterator points to
2741 * a 32-bit integer value before using this function.
2743 * @see dbus_message_iter_get_arg_type
2744 * @param iter the message iter
2745 * @returns the integer
2748 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2750 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2753 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2755 pos = dbus_message_iter_get_data_start (real, &type);
2757 _dbus_assert (type == DBUS_TYPE_INT32);
2759 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2764 * Returns the 32 bit unsigned integer value that an iterator may point to.
2765 * Note that you need to check that the iterator points to
2766 * a 32-bit unsigned integer value before using this function.
2768 * @see dbus_message_iter_get_arg_type
2769 * @param iter the message iter
2770 * @returns the integer
2773 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2775 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2778 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2780 pos = dbus_message_iter_get_data_start (real, &type);
2782 _dbus_assert (type == DBUS_TYPE_UINT32);
2784 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2788 #ifdef DBUS_HAVE_INT64
2791 * Returns the 64 bit signed integer value that an iterator may point
2792 * to. Note that you need to check that the iterator points to a
2793 * 64-bit integer value before using this function.
2795 * This function only exists if #DBUS_HAVE_INT64 is defined.
2797 * @see dbus_message_iter_get_arg_type
2798 * @param iter the message iter
2799 * @returns the integer
2802 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2804 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2807 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2809 pos = dbus_message_iter_get_data_start (real, &type);
2811 _dbus_assert (type == DBUS_TYPE_INT64);
2813 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2818 * Returns the 64 bit unsigned integer value that an iterator may point to.
2819 * Note that you need to check that the iterator points to
2820 * a 64-bit unsigned integer value before using this function.
2822 * This function only exists if #DBUS_HAVE_INT64 is defined.
2824 * @see dbus_message_iter_get_arg_type
2825 * @param iter the message iter
2826 * @returns the integer
2829 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2831 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2834 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2836 pos = dbus_message_iter_get_data_start (real, &type);
2838 _dbus_assert (type == DBUS_TYPE_UINT64);
2840 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2844 #endif /* DBUS_HAVE_INT64 */
2847 * Returns the double value that an iterator may point to.
2848 * Note that you need to check that the iterator points to
2849 * a string value before using this function.
2851 * @see dbus_message_iter_get_arg_type
2852 * @param iter the message iter
2853 * @returns the double
2856 dbus_message_iter_get_double (DBusMessageIter *iter)
2858 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2861 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2863 pos = dbus_message_iter_get_data_start (real, &type);
2865 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2867 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2872 * Initializes an iterator for the array that the iterator
2873 * may point to. Note that you need to check that the iterator
2874 * points to an array prior to using this function.
2876 * The array element type is returned in array_type, and the array
2877 * iterator can only be used to get that type of data.
2879 * @param iter the iterator
2880 * @param array_iter pointer to an iterator to initialize
2881 * @param array_type gets set to the type of the array elements
2884 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2885 DBusMessageIter *array_iter,
2888 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2889 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2890 int type, pos, len_pos, len, array_type_pos;
2893 _dbus_return_if_fail (dbus_message_iter_check (real));
2895 pos = dbus_message_iter_get_data_start (real, &type);
2897 _dbus_assert (type == DBUS_TYPE_ARRAY);
2899 _array_type = iter_get_array_type (real, &array_type_pos);
2901 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2902 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2905 array_real->parent_iter = real;
2906 array_real->message = real->message;
2907 array_real->changed_stamp = real->message->changed_stamp;
2909 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2910 array_real->pos = pos;
2911 array_real->end = pos + len;
2913 array_real->container_start = pos;
2914 array_real->container_length_pos = len_pos;
2915 array_real->wrote_dict_key = 0;
2916 array_real->array_type_pos = array_type_pos;
2917 array_real->array_type_done = TRUE;
2919 if (array_type != NULL)
2920 *array_type = _array_type;
2925 * Initializes an iterator for the dict that the iterator
2926 * may point to. Note that you need to check that the iterator
2927 * points to a dict prior to using this function.
2929 * @param iter the iterator
2930 * @param dict_iter pointer to an iterator to initialize
2933 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2934 DBusMessageIter *dict_iter)
2936 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2937 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2938 int type, pos, len_pos, len;
2940 _dbus_return_if_fail (dbus_message_iter_check (real));
2942 pos = dbus_message_iter_get_data_start (real, &type);
2944 _dbus_assert (type == DBUS_TYPE_DICT);
2946 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2947 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2950 dict_real->parent_iter = real;
2951 dict_real->message = real->message;
2952 dict_real->changed_stamp = real->message->changed_stamp;
2954 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2955 dict_real->pos = pos;
2956 dict_real->end = pos + len;
2958 dict_real->container_start = pos;
2959 dict_real->container_length_pos = len_pos;
2960 dict_real->wrote_dict_key = 0;
2964 * Returns the byte array that the iterator may point to.
2965 * Note that you need to check that the iterator points
2966 * to a byte array prior to using this function.
2968 * @param iter the iterator
2969 * @param value return location for array values
2970 * @param len return location for length of byte array
2971 * @returns #TRUE on success
2974 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2975 unsigned char **value,
2978 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2981 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2983 pos = dbus_message_iter_get_data_start (real, &type);
2985 _dbus_assert (type == DBUS_TYPE_ARRAY);
2987 type = iter_get_array_type (real, NULL);
2989 _dbus_assert (type == DBUS_TYPE_BYTE);
2991 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2992 pos, NULL, value, len))
2999 * Returns the boolean array that the iterator may point to. Note that
3000 * you need to check that the iterator points to an array of the
3001 * correct type prior to using this function.
3003 * @param iter the iterator
3004 * @param value return location for the array
3005 * @param len return location for the array length
3006 * @returns #TRUE on success
3009 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
3010 unsigned char **value,
3013 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3016 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3018 pos = dbus_message_iter_get_data_start (real, &type);
3020 _dbus_assert (type == DBUS_TYPE_ARRAY);
3022 type = iter_get_array_type (real, NULL);
3024 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
3026 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
3027 pos, NULL, value, len))
3034 * Returns the 32 bit signed integer array that the iterator may point
3035 * to. Note that you need to check that the iterator points to an
3036 * array of the correct type prior to using this function.
3038 * @param iter the iterator
3039 * @param value return location for the array
3040 * @param len return location for the array length
3041 * @returns #TRUE on success
3044 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
3045 dbus_int32_t **value,
3048 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3051 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3053 pos = dbus_message_iter_get_data_start (real, &type);
3055 _dbus_assert (type == DBUS_TYPE_ARRAY);
3057 type = iter_get_array_type (real, NULL);
3059 _dbus_assert (type == DBUS_TYPE_INT32);
3061 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
3062 pos, NULL, value, len))
3069 * Returns the 32 bit unsigned integer array that the iterator may point
3070 * to. Note that you need to check that the iterator points to an
3071 * array of the correct type prior to using this function.
3073 * @param iter the iterator
3074 * @param value return location for the array
3075 * @param len return location for the array length
3076 * @returns #TRUE on success
3079 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
3080 dbus_uint32_t **value,
3083 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3086 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3088 pos = dbus_message_iter_get_data_start (real, &type);
3090 _dbus_assert (type == DBUS_TYPE_ARRAY);
3092 type = iter_get_array_type (real, NULL);
3093 _dbus_assert (type == DBUS_TYPE_UINT32);
3095 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
3096 pos, NULL, value, len))
3102 #ifdef DBUS_HAVE_INT64
3105 * Returns the 64 bit signed integer array that the iterator may point
3106 * to. Note that you need to check that the iterator points to an
3107 * array of the correct type prior to using this function.
3109 * This function only exists if #DBUS_HAVE_INT64 is defined.
3111 * @param iter the iterator
3112 * @param value return location for the array
3113 * @param len return location for the array length
3114 * @returns #TRUE on success
3117 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
3118 dbus_int64_t **value,
3121 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3124 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3126 pos = dbus_message_iter_get_data_start (real, &type);
3128 _dbus_assert (type == DBUS_TYPE_ARRAY);
3130 type = iter_get_array_type (real, NULL);
3132 _dbus_assert (type == DBUS_TYPE_INT64);
3134 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
3135 pos, NULL, value, len))
3142 * Returns the 64 bit unsigned integer array that the iterator may point
3143 * to. Note that you need to check that the iterator points to an
3144 * array of the correct type prior to using this function.
3146 * This function only exists if #DBUS_HAVE_INT64 is defined.
3148 * @param iter the iterator
3149 * @param value return location for the array
3150 * @param len return location for the array length
3151 * @returns #TRUE on success
3154 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
3155 dbus_uint64_t **value,
3158 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3161 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3163 pos = dbus_message_iter_get_data_start (real, &type);
3165 _dbus_assert (type == DBUS_TYPE_ARRAY);
3167 type = iter_get_array_type (real, NULL);
3168 _dbus_assert (type == DBUS_TYPE_UINT64);
3170 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
3171 pos, NULL, value, len))
3177 #endif /* DBUS_HAVE_INT64 */
3180 * Returns the double array that the iterator may point to. Note that
3181 * you need to check that the iterator points to an array of the
3182 * correct type prior to using this function.
3184 * @param iter the iterator
3185 * @param value return location for the array
3186 * @param len return location for the array length
3187 * @returns #TRUE on success
3190 dbus_message_iter_get_double_array (DBusMessageIter *iter,
3194 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3197 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3199 pos = dbus_message_iter_get_data_start (real, &type);
3201 _dbus_assert (type == DBUS_TYPE_ARRAY);
3203 type = iter_get_array_type (real, NULL);
3204 _dbus_assert (type == DBUS_TYPE_DOUBLE);
3206 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
3207 pos, NULL, value, len))
3214 * Returns the string array that the iterator may point to.
3215 * Note that you need to check that the iterator points
3216 * to a byte array prior to using this function.
3218 * The returned value is a #NULL-terminated array of strings.
3219 * Each string is a separate malloc block, and the array
3220 * itself is a malloc block. You can free this type of
3221 * string array with dbus_free_string_array().
3223 * @param iter the iterator
3224 * @param value return location for string values
3225 * @param len return location for length of byte array
3226 * @returns #TRUE on success
3229 dbus_message_iter_get_string_array (DBusMessageIter *iter,
3233 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3236 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3238 pos = dbus_message_iter_get_data_start (real, &type);
3240 _dbus_assert (type == DBUS_TYPE_ARRAY);
3242 type = iter_get_array_type (real, NULL);
3243 _dbus_assert (type == DBUS_TYPE_STRING);
3245 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
3246 pos, NULL, value, len))
3253 * Returns the key name fot the dict entry that an iterator
3254 * may point to. Note that you need to check that the iterator
3255 * points to a dict entry before using this function.
3257 * @see dbus_message_iter_init_dict_iterator
3258 * @param iter the message iter
3259 * @returns the key name
3262 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
3264 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3266 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
3268 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3270 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
3275 * Initializes a DBusMessageIter pointing to the end of the
3276 * message. This iterator can be used to append data to the
3279 * @param message the message
3280 * @param iter pointer to an iterator to initialize
3283 dbus_message_append_iter_init (DBusMessage *message,
3284 DBusMessageIter *iter)
3286 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3288 _dbus_return_if_fail (message != NULL);
3289 _dbus_return_if_fail (iter != NULL);
3291 real->message = message;
3292 real->parent_iter = NULL;
3293 real->changed_stamp = message->changed_stamp;
3295 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
3296 real->end = _dbus_string_get_length (&real->message->body);
3297 real->pos = real->end;
3299 real->container_length_pos = 0;
3300 real->wrote_dict_key = 0;
3303 #ifndef DBUS_DISABLE_CHECKS
3305 dbus_message_iter_append_check (DBusMessageRealIter *iter)
3309 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
3313 if (iter->message->locked)
3315 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
3319 if (iter->changed_stamp != iter->message->changed_stamp)
3321 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
3325 if (iter->pos != iter->end)
3327 _dbus_warn ("dbus iterator check failed: can only append at end of message");
3331 if (iter->pos != _dbus_string_get_length (&iter->message->body))
3333 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
3339 #endif /* DBUS_DISABLE_CHECKS */
3342 dbus_message_iter_append_type (DBusMessageRealIter *iter,
3348 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
3349 if (!_dbus_string_append_byte (&iter->message->signature, type))
3352 if (!_dbus_string_append_byte (&iter->message->body, type))
3354 _dbus_string_shorten (&iter->message->signature, 1);
3359 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
3360 data = _dbus_string_get_const_data_len (&iter->message->body,
3361 iter->array_type_pos, 1);
3364 _dbus_warn ("Appended element of wrong type for array\n");
3369 case DBUS_MESSAGE_ITER_TYPE_DICT:
3370 if (!iter->wrote_dict_key)
3372 _dbus_warn ("Appending dict data before key name\n");
3376 if (!_dbus_string_append_byte (&iter->message->body, type))
3382 _dbus_assert_not_reached ("Invalid iter type");
3390 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
3392 iter->changed_stamp = iter->message->changed_stamp;
3394 /* Set new end of iter */
3395 iter->end = _dbus_string_get_length (&iter->message->body);
3396 iter->pos = iter->end;
3398 /* Set container length */
3399 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
3400 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
3401 _dbus_marshal_set_uint32 (&iter->message->body,
3402 iter->message->byte_order,
3403 iter->container_length_pos,
3404 iter->end - iter->container_start);
3406 if (iter->parent_iter)
3407 dbus_message_iter_update_after_change (iter->parent_iter);
3411 dbus_message_iter_append_done (DBusMessageRealIter *iter)
3413 iter->message->changed_stamp++;
3414 dbus_message_iter_update_after_change (iter);
3415 iter->wrote_dict_key = FALSE;
3419 * Appends a nil value to the message
3421 * @param iter an iterator pointing to the end of the message
3422 * @returns #TRUE on success
3425 dbus_message_iter_append_nil (DBusMessageIter *iter)
3427 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3429 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3431 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
3434 dbus_message_iter_append_done (real);
3440 * Appends a boolean value to the message
3442 * @param iter an iterator pointing to the end of the message
3443 * @param value the boolean value
3444 * @returns #TRUE on success
3447 dbus_message_iter_append_boolean (DBusMessageIter *iter,
3450 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3452 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3454 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
3457 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
3459 _dbus_string_set_length (&real->message->body, real->pos);
3463 dbus_message_iter_append_done (real);
3469 * Appends a byte to the message
3471 * @param iter an iterator pointing to the end of the message
3472 * @param value the byte value
3473 * @returns #TRUE on success
3476 dbus_message_iter_append_byte (DBusMessageIter *iter,
3477 unsigned char value)
3479 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3481 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3483 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
3486 if (!_dbus_string_append_byte (&real->message->body, value))
3488 _dbus_string_set_length (&real->message->body, real->pos);
3492 dbus_message_iter_append_done (real);
3499 * Appends a 32 bit signed integer to the message.
3501 * @param iter an iterator pointing to the end of the message
3502 * @param value the integer value
3503 * @returns #TRUE on success
3506 dbus_message_iter_append_int32 (DBusMessageIter *iter,
3509 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3511 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3513 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
3516 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
3518 _dbus_string_set_length (&real->message->body, real->pos);
3522 dbus_message_iter_append_done (real);
3528 * Appends a 32 bit unsigned integer to the message.
3530 * @param iter an iterator pointing to the end of the message
3531 * @param value the integer value
3532 * @returns #TRUE on success
3535 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3536 dbus_uint32_t value)
3538 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3540 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3542 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3545 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3547 _dbus_string_set_length (&real->message->body, real->pos);
3551 dbus_message_iter_append_done (real);
3556 #ifdef DBUS_HAVE_INT64
3559 * Appends a 64 bit signed integer to the message.
3561 * This function only exists if #DBUS_HAVE_INT64 is defined.
3563 * @param iter an iterator pointing to the end of the message
3564 * @param value the integer value
3565 * @returns #TRUE on success
3568 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3571 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3573 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3575 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3578 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3580 _dbus_string_set_length (&real->message->body, real->pos);
3584 dbus_message_iter_append_done (real);
3590 * Appends a 64 bit unsigned integer to the message.
3592 * This function only exists if #DBUS_HAVE_INT64 is defined.
3594 * @param iter an iterator pointing to the end of the message
3595 * @param value the integer value
3596 * @returns #TRUE on success
3599 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3600 dbus_uint64_t value)
3602 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3604 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3606 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3609 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3611 _dbus_string_set_length (&real->message->body, real->pos);
3615 dbus_message_iter_append_done (real);
3620 #endif /* DBUS_HAVE_INT64 */
3623 * Appends a double value to the message.
3625 * @param iter an iterator pointing to the end of the message
3626 * @param value the double value
3627 * @returns #TRUE on success
3630 dbus_message_iter_append_double (DBusMessageIter *iter,
3633 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3635 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3637 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3640 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3642 _dbus_string_set_length (&real->message->body, real->pos);
3646 dbus_message_iter_append_done (real);
3652 * Appends a UTF-8 string to the message.
3654 * @param iter an iterator pointing to the end of the message
3655 * @param value the string
3656 * @returns #TRUE on success
3659 dbus_message_iter_append_string (DBusMessageIter *iter,
3662 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3664 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3666 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3669 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3671 _dbus_string_set_length (&real->message->body, real->pos);
3675 dbus_message_iter_append_done (real);
3681 * Appends a named type data chunk to the message. A named
3682 * type is simply an arbitrary UTF-8 string used as a type
3683 * tag, plus an array of arbitrary bytes to be interpreted
3684 * according to the type tag.
3686 * @param iter an iterator pointing to the end of the message
3687 * @param name the name of the type
3688 * @param data the binary data used to store the value
3689 * @param len the length of the binary data in bytes
3690 * @returns #TRUE on success
3693 dbus_message_iter_append_named (DBusMessageIter *iter,
3695 const unsigned char *data,
3698 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3700 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3702 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3705 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3707 _dbus_string_set_length (&real->message->body, real->pos);
3711 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3713 _dbus_string_set_length (&real->message->body, real->pos);
3717 dbus_message_iter_append_done (real);
3724 * Appends a dict key name to the message. The iterator used
3725 * must point to a dict.
3727 * @param iter an iterator pointing to the end of the message
3728 * @param value the string
3729 * @returns #TRUE on success
3732 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3735 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3737 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3738 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3740 if (real->wrote_dict_key)
3742 _dbus_warn ("Appendinging multiple dict key names\n");
3746 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3751 dbus_message_iter_append_done (real);
3752 real->wrote_dict_key = TRUE;
3758 array_iter_type_mark_done (DBusMessageRealIter *iter)
3762 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3763 array_iter_type_mark_done (iter->parent_iter);
3767 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3768 sizeof (dbus_uint32_t));
3770 /* Empty length for now, backfill later */
3771 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3773 _dbus_string_set_length (&iter->message->body, iter->pos);
3777 iter->container_start = _dbus_string_get_length (&iter->message->body);
3778 iter->container_length_pos = len_pos;
3779 iter->array_type_done = TRUE;
3785 append_array_type (DBusMessageRealIter *real,
3787 dbus_bool_t *array_type_done,
3788 int *array_type_pos)
3790 int existing_element_type;
3792 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3795 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3796 real->array_type_done)
3798 existing_element_type = iter_get_array_type (real, array_type_pos);
3799 if (existing_element_type != element_type)
3801 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3802 _dbus_type_to_string (element_type),
3803 _dbus_type_to_string (existing_element_type));
3804 _dbus_string_set_length (&real->message->body, real->pos);
3807 if (array_type_done != NULL)
3808 *array_type_done = TRUE;
3812 if (array_type_pos != NULL)
3813 *array_type_pos = _dbus_string_get_length (&real->message->body);
3816 if (!_dbus_string_append_byte (&real->message->signature, element_type))
3818 _dbus_string_set_length (&real->message->body, real->pos);
3822 /* Append element type */
3823 if (!_dbus_string_append_byte (&real->message->body, element_type))
3825 _dbus_string_shorten (&real->message->signature, 1);
3826 _dbus_string_set_length (&real->message->body, real->pos);
3830 if (array_type_done != NULL)
3831 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3833 if (element_type != DBUS_TYPE_ARRAY &&
3834 !array_iter_type_mark_done (real))
3836 _dbus_string_shorten (&real->message->signature, 1);
3845 * Appends an array to the message and initializes an iterator that
3846 * can be used to append to the array.
3848 * @param iter an iterator pointing to the end of the message
3849 * @param array_iter pointer to an iter that will be initialized
3850 * @param element_type the type of the array elements
3851 * @returns #TRUE on success
3854 dbus_message_iter_append_array (DBusMessageIter *iter,
3855 DBusMessageIter *array_iter,
3858 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3859 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3862 dbus_bool_t array_type_done;
3864 if (element_type == DBUS_TYPE_NIL)
3866 _dbus_warn ("Can't create NIL arrays\n");
3870 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3872 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3875 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3877 if (array_type_done)
3879 /* Empty length for now, backfill later */
3880 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3882 _dbus_string_set_length (&real->message->body, real->pos);
3887 array_real->parent_iter = real;
3888 array_real->message = real->message;
3889 array_real->changed_stamp = real->message->changed_stamp;
3891 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3892 array_real->pos = _dbus_string_get_length (&real->message->body);
3893 array_real->end = array_real->end;
3895 array_real->container_start = array_real->pos;
3896 array_real->container_length_pos = len_pos;
3897 array_real->wrote_dict_key = 0;
3898 array_real->array_type_done = array_type_done;
3899 array_real->array_type_pos = array_type_pos;
3901 dbus_message_iter_append_done (array_real);
3907 * Appends a dict to the message and initializes an iterator that
3908 * can be used to append to the dict.
3910 * @param iter an iterator pointing to the end of the message
3911 * @param dict_iter pointer to an iter that will be initialized
3912 * @returns #TRUE on success
3915 dbus_message_iter_append_dict (DBusMessageIter *iter,
3916 DBusMessageIter *dict_iter)
3918 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3919 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3922 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3924 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3927 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3929 /* Empty length for now, backfill later */
3930 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3932 _dbus_string_set_length (&real->message->body, real->pos);
3936 dict_real->parent_iter = real;
3937 dict_real->message = real->message;
3938 dict_real->changed_stamp = real->message->changed_stamp;
3940 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3941 dict_real->pos = _dbus_string_get_length (&real->message->body);
3942 dict_real->end = dict_real->end;
3944 dict_real->container_start = dict_real->pos;
3945 dict_real->container_length_pos = len_pos;
3946 dict_real->wrote_dict_key = 0;
3948 dbus_message_iter_append_done (dict_real);
3955 * Appends a boolean array to the message.
3957 * @param iter an iterator pointing to the end of the message
3958 * @param value the array
3959 * @param len the length of the array
3960 * @returns #TRUE on success
3963 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3964 unsigned const char *value,
3967 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3969 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3971 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3974 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3976 _dbus_string_set_length (&real->message->body, real->pos);
3980 dbus_message_iter_append_done (real);
3986 * Appends a 32 bit signed integer array to the message.
3988 * @param iter an iterator pointing to the end of the message
3989 * @param value the array
3990 * @param len the length of the array
3991 * @returns #TRUE on success
3994 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
3995 const dbus_int32_t *value,
3998 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4000 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4002 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
4005 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
4007 _dbus_string_set_length (&real->message->body, real->pos);
4011 dbus_message_iter_append_done (real);
4017 * Appends a 32 bit unsigned integer array to the message.
4019 * @param iter an iterator pointing to the end of the message
4020 * @param value the array
4021 * @param len the length of the array
4022 * @returns #TRUE on success
4025 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
4026 const dbus_uint32_t *value,
4029 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4031 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4033 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
4036 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
4038 _dbus_string_set_length (&real->message->body, real->pos);
4042 dbus_message_iter_append_done (real);
4047 #ifdef DBUS_HAVE_INT64
4050 * Appends a 64 bit signed integer array to the message.
4052 * This function only exists if #DBUS_HAVE_INT64 is defined.
4054 * @param iter an iterator pointing to the end of the message
4055 * @param value the array
4056 * @param len the length of the array
4057 * @returns #TRUE on success
4060 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
4061 const dbus_int64_t *value,
4064 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4066 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4068 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
4071 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
4073 _dbus_string_set_length (&real->message->body, real->pos);
4077 dbus_message_iter_append_done (real);
4083 * Appends a 64 bit unsigned integer array to the message.
4085 * This function only exists if #DBUS_HAVE_INT64 is defined.
4087 * @param iter an iterator pointing to the end of the message
4088 * @param value the array
4089 * @param len the length of the array
4090 * @returns #TRUE on success
4093 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
4094 const dbus_uint64_t *value,
4097 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4099 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4101 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
4104 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
4106 _dbus_string_set_length (&real->message->body, real->pos);
4110 dbus_message_iter_append_done (real);
4114 #endif /* DBUS_HAVE_INT64 */
4117 * Appends a double array to the message.
4119 * @param iter an iterator pointing to the end of the message
4120 * @param value the array
4121 * @param len the length of the array
4122 * @returns #TRUE on success
4125 dbus_message_iter_append_double_array (DBusMessageIter *iter,
4126 const double *value,
4129 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4131 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4133 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
4136 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
4138 _dbus_string_set_length (&real->message->body, real->pos);
4142 dbus_message_iter_append_done (real);
4148 * Appends a byte array to the message.
4150 * @param iter an iterator pointing to the end of the message
4151 * @param value the array
4152 * @param len the length of the array
4153 * @returns #TRUE on success
4156 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
4157 unsigned const char *value,
4160 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4162 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4164 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
4167 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
4169 _dbus_string_set_length (&real->message->body, real->pos);
4173 dbus_message_iter_append_done (real);
4179 * Appends a string array to the message.
4181 * @param iter an iterator pointing to the end of the message
4182 * @param value the array
4183 * @param len the length of the array
4184 * @returns #TRUE on success
4187 dbus_message_iter_append_string_array (DBusMessageIter *iter,
4191 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4193 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4195 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
4198 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
4200 _dbus_string_set_length (&real->message->body, real->pos);
4204 dbus_message_iter_append_done (real);
4210 * Sets the message sender.
4212 * @param message the message
4213 * @param sender the sender
4214 * @returns #FALSE if not enough memory
4217 dbus_message_set_sender (DBusMessage *message,
4220 _dbus_return_val_if_fail (message != NULL, FALSE);
4221 _dbus_return_val_if_fail (!message->locked, FALSE);
4225 delete_field (message, DBUS_HEADER_FIELD_SENDER_SERVICE);
4230 return set_string_field (message,
4231 DBUS_HEADER_FIELD_SENDER_SERVICE,
4238 * Sets a flag indicating that the message does not want a reply; if
4239 * this flag is set, the other end of the connection may (but is not
4240 * required to) optimize by not sending method return or error
4241 * replies. If this flag is set, there is no way to know whether the
4242 * message successfully arrived at the remote end.
4244 * @param message the message
4245 * @param no_reply #TRUE if no reply is desired
4248 dbus_message_set_no_reply (DBusMessage *message,
4249 dbus_bool_t no_reply)
4253 _dbus_return_if_fail (message != NULL);
4254 _dbus_return_if_fail (!message->locked);
4256 header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1);
4259 *header |= DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4261 *header &= ~DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4265 * Returns #TRUE if the message does not expect
4268 * @param message the message
4269 * @returns #TRUE if the message sender isn't waiting for a reply
4272 dbus_message_get_no_reply (DBusMessage *message)
4276 _dbus_return_val_if_fail (message != NULL, FALSE);
4278 header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1);
4280 return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0;
4284 * Gets the service which originated this message,
4285 * or #NULL if unknown or inapplicable.
4287 * @param message the message
4288 * @returns the service name or #NULL
4291 dbus_message_get_sender (DBusMessage *message)
4293 _dbus_return_val_if_fail (message != NULL, NULL);
4295 return get_string_field (message,
4296 DBUS_HEADER_FIELD_SENDER_SERVICE,
4301 * Gets the type signature of the message, i.e. the arguments in the
4302 * message payload. The signature includes only "in" arguments for
4303 * #DBUS_MESSAGE_TYPE_METHOD_CALL and only "out" arguments for
4304 * #DBUS_MESSAGE_TYPE_METHOD_RETURN, so is slightly different from
4305 * what you might expect (it does not include the signature of the
4306 * entire C++-style method).
4308 * The signature is a string made up of type codes such
4309 * as #DBUS_TYPE_STRING. The string is terminated with nul
4310 * (nul is also the value of #DBUS_TYPE_INVALID).
4312 * @param message the message
4313 * @returns the type signature
4316 dbus_message_get_signature (DBusMessage *message)
4318 _dbus_return_val_if_fail (message != NULL, NULL);
4320 return _dbus_string_get_const_data (&message->signature);
4324 _dbus_message_has_type_interface_member (DBusMessage *message,
4326 const char *interface,
4331 _dbus_assert (message != NULL);
4332 _dbus_assert (interface != NULL);
4333 _dbus_assert (method != NULL);
4335 if (dbus_message_get_type (message) != type)
4338 /* Optimize by checking the short method name first
4339 * instead of the longer interface name
4342 n = dbus_message_get_member (message);
4344 if (n && strcmp (n, method) == 0)
4346 n = dbus_message_get_interface (message);
4348 if (n && strcmp (n, interface) == 0)
4356 * Checks whether the message is a method call with the given
4357 * interface and member fields. If the message is not
4358 * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or member field,
4361 * @param message the message
4362 * @param interface the name to check (must not be #NULL)
4363 * @param method the name to check (must not be #NULL)
4365 * @returns #TRUE if the message is the specified method call
4368 dbus_message_is_method_call (DBusMessage *message,
4369 const char *interface,
4372 _dbus_return_val_if_fail (message != NULL, FALSE);
4373 _dbus_return_val_if_fail (interface != NULL, FALSE);
4374 _dbus_return_val_if_fail (method != NULL, FALSE);
4376 return _dbus_message_has_type_interface_member (message,
4377 DBUS_MESSAGE_TYPE_METHOD_CALL,
4382 * Checks whether the message is a signal with the given
4383 * interface and member fields. If the message is not
4384 * #DBUS_MESSAGE_TYPE_SIGNAL, or has a different interface or member field,
4387 * @param message the message
4388 * @param interface the name to check (must not be #NULL)
4389 * @param signal_name the name to check (must not be #NULL)
4391 * @returns #TRUE if the message is the specified signal
4394 dbus_message_is_signal (DBusMessage *message,
4395 const char *interface,
4396 const char *signal_name)
4398 _dbus_return_val_if_fail (message != NULL, FALSE);
4399 _dbus_return_val_if_fail (interface != NULL, FALSE);
4400 _dbus_return_val_if_fail (signal_name != NULL, FALSE);
4402 return _dbus_message_has_type_interface_member (message,
4403 DBUS_MESSAGE_TYPE_SIGNAL,
4404 interface, signal_name);
4408 * Checks whether the message is an error reply with the given error
4409 * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a
4410 * different name, returns #FALSE.
4412 * @param message the message
4413 * @param error_name the name to check (must not be #NULL)
4415 * @returns #TRUE if the message is the specified error
4418 dbus_message_is_error (DBusMessage *message,
4419 const char *error_name)
4423 _dbus_return_val_if_fail (message != NULL, FALSE);
4424 _dbus_return_val_if_fail (error_name != NULL, FALSE);
4426 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4429 n = dbus_message_get_error_name (message);
4431 if (n && strcmp (n, error_name) == 0)
4438 * Checks whether the message was sent to the given service. If the
4439 * message has no service specified or has a different name, returns
4442 * @param message the message
4443 * @param service the service to check (must not be #NULL)
4445 * @returns #TRUE if the message has the given destination service
4448 dbus_message_has_destination (DBusMessage *message,
4449 const char *service)
4453 _dbus_return_val_if_fail (message != NULL, FALSE);
4454 _dbus_return_val_if_fail (service != NULL, FALSE);
4456 s = dbus_message_get_destination (message);
4458 if (s && strcmp (s, service) == 0)
4465 * Checks whether the message has the given service as its sender. If
4466 * the message has no sender specified or has a different sender,
4467 * returns #FALSE. Note that if a peer application owns multiple
4468 * services, its messages will have only one of those services as the
4469 * sender (usually the base service). So you can't use this
4470 * function to prove the sender didn't own service Foo, you can
4471 * only use it to prove that it did.
4473 * @param message the message
4474 * @param service the service to check (must not be #NULL)
4476 * @returns #TRUE if the message has the given origin service
4479 dbus_message_has_sender (DBusMessage *message,
4480 const char *service)
4484 _dbus_return_val_if_fail (message != NULL, FALSE);
4485 _dbus_return_val_if_fail (service != NULL, FALSE);
4487 s = dbus_message_get_sender (message);
4489 if (s && strcmp (s, service) == 0)
4496 * Checks whether the message has the given signature;
4497 * see dbus_message_get_signature() for more details on
4498 * what the signature looks like.
4500 * @param message the message
4501 * @param signature typecode array
4502 * @returns #TRUE if message has the given signature
4505 dbus_message_has_signature (DBusMessage *message,
4506 const char *signature)
4508 _dbus_return_val_if_fail (message != NULL, FALSE);
4509 _dbus_return_val_if_fail (signature != NULL, FALSE);
4511 return _dbus_string_equal_c_str (&message->signature, signature);
4515 * Sets a #DBusError based on the contents of the given
4516 * message. The error is only set if the message
4517 * is an error message, as in DBUS_MESSAGE_TYPE_ERROR.
4518 * The name of the error is set to the name of the message,
4519 * and the error message is set to the first argument
4520 * if the argument exists and is a string.
4522 * The return value indicates whether the error was set (the error is
4523 * set if and only if the message is an error message).
4524 * So you can check for an error reply and convert it to DBusError
4527 * @param error the error to set
4528 * @param message the message to set it from
4529 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
4532 dbus_set_error_from_message (DBusError *error,
4533 DBusMessage *message)
4537 _dbus_return_val_if_fail (message != NULL, FALSE);
4538 _dbus_return_val_if_error_is_set (error, FALSE);
4540 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4544 dbus_message_get_args (message, NULL,
4545 DBUS_TYPE_STRING, &str,
4548 dbus_set_error (error, dbus_message_get_error_name (message),
4549 str ? "%s" : NULL, str);
4559 * @addtogroup DBusMessageInternals
4564 * @typedef DBusMessageLoader
4566 * The DBusMessageLoader object encapsulates the process of converting
4567 * a byte stream into a series of DBusMessage. It buffers the incoming
4568 * bytes as efficiently as possible, and generates a queue of
4569 * messages. DBusMessageLoader is typically used as part of a
4570 * DBusTransport implementation. The DBusTransport then hands off
4571 * the loaded messages to a DBusConnection, making the messages
4572 * visible to the application.
4574 * @todo write tests for break-loader that a) randomly delete header
4575 * fields and b) set string fields to zero-length and other funky
4580 /* we definitely use signed ints for sizes, so don't exceed
4581 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
4582 * over 128M is pretty nuts anyhow.
4586 * The maximum sane message size.
4588 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
4591 * Implementation details of DBusMessageLoader.
4592 * All members are private.
4594 struct DBusMessageLoader
4596 int refcount; /**< Reference count. */
4598 DBusString data; /**< Buffered data */
4600 DBusList *messages; /**< Complete messages. */
4602 long max_message_size; /**< Maximum size of a message */
4604 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
4606 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
4610 * The initial buffer size of the message loader.
4612 * @todo this should be based on min header size plus some average
4613 * body size, or something. Or rather, the min header size only, if we
4614 * want to try to read only the header, store that in a DBusMessage,
4615 * then read only the body and store that, etc., depends on
4616 * how we optimize _dbus_message_loader_get_buffer() and what
4617 * the exact message format is.
4619 #define INITIAL_LOADER_DATA_LEN 32
4622 * Creates a new message loader. Returns #NULL if memory can't
4625 * @returns new loader, or #NULL.
4628 _dbus_message_loader_new (void)
4630 DBusMessageLoader *loader;
4632 loader = dbus_new0 (DBusMessageLoader, 1);
4636 loader->refcount = 1;
4638 /* Try to cap message size at something that won't *totally* hose
4639 * the system if we have a couple of them.
4641 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
4643 if (!_dbus_string_init (&loader->data))
4649 /* preallocate the buffer for speed, ignore failure */
4650 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
4651 _dbus_string_set_length (&loader->data, 0);
4657 * Increments the reference count of the loader.
4659 * @param loader the loader.
4662 _dbus_message_loader_ref (DBusMessageLoader *loader)
4664 loader->refcount += 1;
4668 * Decrements the reference count of the loader and finalizes the
4669 * loader when the count reaches zero.
4671 * @param loader the loader.
4674 _dbus_message_loader_unref (DBusMessageLoader *loader)
4676 loader->refcount -= 1;
4677 if (loader->refcount == 0)
4679 _dbus_list_foreach (&loader->messages,
4680 (DBusForeachFunction) dbus_message_unref,
4682 _dbus_list_clear (&loader->messages);
4683 _dbus_string_free (&loader->data);
4689 * Gets the buffer to use for reading data from the network. Network
4690 * data is read directly into an allocated buffer, which is then used
4691 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4692 * The buffer must always be returned immediately using
4693 * _dbus_message_loader_return_buffer(), even if no bytes are
4694 * successfully read.
4696 * @todo this function can be a lot more clever. For example
4697 * it can probably always return a buffer size to read exactly
4698 * the body of the next message, thus avoiding any memory wastage
4701 * @todo we need to enforce a max length on strings in header fields.
4703 * @param loader the message loader.
4704 * @param buffer the buffer
4707 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4708 DBusString **buffer)
4710 _dbus_assert (!loader->buffer_outstanding);
4712 *buffer = &loader->data;
4714 loader->buffer_outstanding = TRUE;
4718 * The smallest header size that can occur.
4719 * (It won't be valid)
4721 #define DBUS_MINIMUM_HEADER_SIZE 16
4724 decode_string_field (const DBusString *data,
4726 HeaderField *header_field,
4727 DBusString *field_data,
4731 int string_data_pos;
4733 _dbus_assert (header_field != NULL);
4734 _dbus_assert (field_data != NULL);
4736 if (header_field->name_offset >= 0)
4738 _dbus_verbose ("%s field provided twice\n",
4739 _dbus_header_field_to_string (field));
4743 if (type != DBUS_TYPE_STRING)
4745 _dbus_verbose ("%s field has wrong type %s\n",
4746 _dbus_header_field_to_string (field),
4747 _dbus_type_to_string (type));
4751 /* skip padding after typecode, skip string length;
4752 * we assume that the string arg has already been validated
4753 * for sanity and UTF-8
4755 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4756 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4758 _dbus_string_init_const (field_data,
4759 _dbus_string_get_const_data (data) + string_data_pos);
4761 header_field->name_offset = pos;
4762 header_field->value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4765 _dbus_verbose ("Found field %s at offset %d\n",
4766 _dbus_header_field_to_string (field),
4767 header_field->value_offset);
4774 decode_header_data (const DBusString *data,
4778 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1],
4779 int *message_padding)
4781 DBusString field_data;
4787 if (header_len < 16)
4789 _dbus_verbose ("Header length %d is too short\n", header_len);
4794 while (i <= DBUS_HEADER_FIELD_LAST)
4796 fields[i].name_offset = -1;
4797 fields[i].value_offset = -1;
4802 while (pos < header_len)
4804 field = _dbus_string_get_byte (data, pos);
4805 if (field == DBUS_HEADER_FIELD_INVALID)
4806 break; /* Must be padding */
4809 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4811 _dbus_verbose ("Failed to validate type of named header field\n");
4815 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4817 _dbus_verbose ("Failed to validate argument to named header field\n");
4821 if (new_pos > header_len)
4823 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4829 case DBUS_HEADER_FIELD_SERVICE:
4830 if (!decode_string_field (data, field, &fields[field],
4831 &field_data, pos, type))
4834 if (!_dbus_string_validate_service (&field_data, 0,
4835 _dbus_string_get_length (&field_data)))
4837 _dbus_verbose ("service field has invalid content \"%s\"\n",
4838 _dbus_string_get_const_data (&field_data));
4843 case DBUS_HEADER_FIELD_INTERFACE:
4844 if (!decode_string_field (data, field, &fields[field],
4845 &field_data, pos, type))
4848 if (!_dbus_string_validate_interface (&field_data, 0,
4849 _dbus_string_get_length (&field_data)))
4851 _dbus_verbose ("interface field has invalid content \"%s\"\n",
4852 _dbus_string_get_const_data (&field_data));
4856 if (_dbus_string_equal_c_str (&field_data,
4857 DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL))
4859 _dbus_verbose ("Message is on the local interface\n");
4864 case DBUS_HEADER_FIELD_MEMBER:
4865 if (!decode_string_field (data, field, &fields[field],
4866 &field_data, pos, type))
4869 if (!_dbus_string_validate_member (&field_data, 0,
4870 _dbus_string_get_length (&field_data)))
4872 _dbus_verbose ("member field has invalid content \"%s\"\n",
4873 _dbus_string_get_const_data (&field_data));
4878 case DBUS_HEADER_FIELD_ERROR_NAME:
4879 if (!decode_string_field (data, field, &fields[field],
4880 &field_data, pos, type))
4883 if (!_dbus_string_validate_error_name (&field_data, 0,
4884 _dbus_string_get_length (&field_data)))
4886 _dbus_verbose ("error-name field has invalid content \"%s\"\n",
4887 _dbus_string_get_const_data (&field_data));
4892 case DBUS_HEADER_FIELD_SENDER_SERVICE:
4893 if (!decode_string_field (data, field, &fields[field],
4894 &field_data, pos, type))
4897 if (!_dbus_string_validate_service (&field_data, 0,
4898 _dbus_string_get_length (&field_data)))
4900 _dbus_verbose ("sender-service field has invalid content \"%s\"\n",
4901 _dbus_string_get_const_data (&field_data));
4906 case DBUS_HEADER_FIELD_PATH:
4908 /* Path was already validated as part of standard
4909 * type validation, since there's an OBJECT_PATH
4913 if (fields[field].name_offset >= 0)
4915 _dbus_verbose ("path field provided twice\n");
4918 if (type != DBUS_TYPE_OBJECT_PATH)
4920 _dbus_verbose ("path field has wrong type\n");
4924 fields[field].name_offset = pos;
4925 fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4927 /* No forging signals from the local path */
4930 s = _dbus_string_get_const_data_len (data,
4931 fields[field].value_offset,
4932 _dbus_string_get_length (data) -
4933 fields[field].value_offset);
4934 if (strcmp (s, DBUS_PATH_ORG_FREEDESKTOP_LOCAL) == 0)
4936 _dbus_verbose ("Message is on the local path\n");
4941 _dbus_verbose ("Found path at offset %d\n",
4942 fields[field].value_offset);
4945 case DBUS_HEADER_FIELD_REPLY_SERIAL:
4946 if (fields[field].name_offset >= 0)
4948 _dbus_verbose ("reply field provided twice\n");
4952 if (type != DBUS_TYPE_UINT32)
4954 _dbus_verbose ("reply field has wrong type\n");
4958 fields[field].name_offset = pos;
4959 fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4961 _dbus_verbose ("Found reply serial at offset %d\n",
4962 fields[field].value_offset);
4966 _dbus_verbose ("Ignoring an unknown header field: %d at offset %d\n",
4973 if (pos < header_len)
4975 /* Alignment padding, verify that it's nul */
4976 if ((header_len - pos) >= 8)
4978 _dbus_verbose ("too much header alignment padding\n");
4982 if (!_dbus_string_validate_nul (data,
4983 pos, (header_len - pos)))
4985 _dbus_verbose ("header alignment padding is not nul\n");
4990 /* Depending on message type, enforce presence of certain fields. */
4991 switch (message_type)
4993 case DBUS_MESSAGE_TYPE_SIGNAL:
4994 case DBUS_MESSAGE_TYPE_METHOD_CALL:
4995 if (fields[DBUS_HEADER_FIELD_PATH].value_offset < 0)
4997 _dbus_verbose ("No path field provided\n");
5000 /* FIXME make this optional, only for method calls */
5001 if (fields[DBUS_HEADER_FIELD_INTERFACE].value_offset < 0)
5003 _dbus_verbose ("No interface field provided\n");
5006 if (fields[DBUS_HEADER_FIELD_MEMBER].value_offset < 0)
5008 _dbus_verbose ("No member field provided\n");
5012 case DBUS_MESSAGE_TYPE_ERROR:
5013 if (fields[DBUS_HEADER_FIELD_ERROR_NAME].value_offset < 0)
5015 _dbus_verbose ("No error-name field provided\n");
5019 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
5022 /* An unknown type, spec requires us to ignore it */
5026 if (message_padding)
5027 *message_padding = header_len - pos;
5033 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
5034 * indicating to the loader how many bytes of the buffer were filled
5035 * in. This function must always be called, even if no bytes were
5036 * successfully read.
5038 * @param loader the loader.
5039 * @param buffer the buffer.
5040 * @param bytes_read number of bytes that were read into the buffer.
5043 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
5047 _dbus_assert (loader->buffer_outstanding);
5048 _dbus_assert (buffer == &loader->data);
5050 loader->buffer_outstanding = FALSE;
5054 * Converts buffered data into messages.
5056 * @todo we need to check that the proper named header fields exist
5057 * for each message type.
5059 * @todo If a message has unknown type, we should probably eat it
5060 * right here rather than passing it out to applications. However
5061 * it's not an error to see messages of unknown type.
5063 * @param loader the loader.
5064 * @returns #TRUE if we had enough memory to finish.
5067 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
5069 if (loader->corrupted)
5072 while (_dbus_string_get_length (&loader->data) >= 16)
5074 DBusMessage *message;
5075 const char *header_data;
5076 int byte_order, message_type, header_len, body_len, header_padding;
5077 dbus_uint32_t header_len_unsigned, body_len_unsigned;
5079 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
5081 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
5083 if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION)
5085 _dbus_verbose ("Message has protocol version %d ours is %d\n",
5086 (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION);
5087 loader->corrupted = TRUE;
5091 byte_order = header_data[BYTE_ORDER_OFFSET];
5093 if (byte_order != DBUS_LITTLE_ENDIAN &&
5094 byte_order != DBUS_BIG_ENDIAN)
5096 _dbus_verbose ("Message with bad byte order '%c' received\n",
5098 loader->corrupted = TRUE;
5102 /* Unknown types are ignored, but INVALID is
5105 message_type = header_data[TYPE_OFFSET];
5106 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
5108 _dbus_verbose ("Message with bad type '%d' received\n",
5110 loader->corrupted = TRUE;
5114 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
5115 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
5117 if (header_len_unsigned < 16)
5119 _dbus_verbose ("Message had broken too-small header length %u\n",
5120 header_len_unsigned);
5121 loader->corrupted = TRUE;
5125 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
5126 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
5128 _dbus_verbose ("Header or body length too large (%u %u)\n",
5129 header_len_unsigned,
5131 loader->corrupted = TRUE;
5135 /* Now that we know the values are in signed range, get
5136 * rid of stupid unsigned, just causes bugs
5138 header_len = header_len_unsigned;
5139 body_len = body_len_unsigned;
5141 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
5144 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
5146 loader->corrupted = TRUE;
5150 if (header_len + body_len > loader->max_message_size)
5152 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
5153 header_len, body_len, loader->max_message_size);
5154 loader->corrupted = TRUE;
5158 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
5160 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1];
5165 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
5167 if (!decode_header_data (&loader->data,
5168 header_len, byte_order,
5170 fields, &header_padding))
5172 _dbus_verbose ("Header was invalid\n");
5173 loader->corrupted = TRUE;
5177 next_arg = header_len;
5178 while (next_arg < (header_len + body_len))
5181 int prev = next_arg;
5183 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
5186 _dbus_verbose ("invalid typecode at offset %d\n", prev);
5187 loader->corrupted = TRUE;
5191 if (!_dbus_marshal_validate_arg (&loader->data,
5198 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
5199 loader->corrupted = TRUE;
5203 _dbus_assert (next_arg > prev);
5206 if (next_arg > (header_len + body_len))
5208 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
5209 next_arg, header_len, body_len,
5210 header_len + body_len);
5211 loader->corrupted = TRUE;
5215 message = dbus_message_new_empty_header ();
5216 if (message == NULL)
5218 _dbus_verbose ("Failed to allocate empty message\n");
5222 message->byte_order = byte_order;
5223 message->header_padding = header_padding;
5225 /* Copy in the offsets we found */
5227 while (i <= DBUS_HEADER_FIELD_LAST)
5229 message->header_fields[i] = fields[i];
5233 if (!_dbus_list_append (&loader->messages, message))
5235 _dbus_verbose ("Failed to append new message to loader queue\n");
5236 dbus_message_unref (message);
5240 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
5241 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
5243 _dbus_assert (_dbus_string_get_length (&loader->data) >=
5244 (header_len + body_len));
5246 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
5248 _dbus_verbose ("Failed to move header into new message\n");
5249 _dbus_list_remove_last (&loader->messages, message);
5250 dbus_message_unref (message);
5254 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
5258 _dbus_verbose ("Failed to move body into new message\n");
5260 /* put the header back, we'll try again later */
5261 result = _dbus_string_copy_len (&message->header, 0, header_len,
5263 _dbus_assert (result); /* because DBusString never reallocs smaller */
5265 _dbus_list_remove_last (&loader->messages, message);
5266 dbus_message_unref (message);
5270 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
5271 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
5273 /* Fill in caches (we checked the types of these fields
5276 message->reply_serial = get_uint_field (message,
5277 DBUS_HEADER_FIELD_REPLY_SERIAL);
5279 message->client_serial = _dbus_demarshal_uint32 (&message->header,
5280 message->byte_order,
5281 CLIENT_SERIAL_OFFSET,
5284 /* Fill in signature (FIXME should do this during validation,
5285 * but I didn't want to spend time on it since we want to change
5286 * the wire format to contain the signature anyway)
5289 DBusMessageIter iter;
5291 dbus_message_iter_init (message, &iter);
5297 t = dbus_message_iter_get_arg_type (&iter);
5298 if (t == DBUS_TYPE_INVALID)
5301 if (!_dbus_string_append_byte (&message->signature,
5304 _dbus_verbose ("failed to append type byte to signature\n");
5305 _dbus_list_remove_last (&loader->messages, message);
5306 dbus_message_unref (message);
5310 if (t == DBUS_TYPE_ARRAY)
5312 DBusMessageIter child_iter;
5317 while (array_type == DBUS_TYPE_ARRAY)
5319 DBusMessageIter parent_iter = child_iter;
5320 dbus_message_iter_init_array_iterator (&parent_iter,
5324 if (!_dbus_string_append_byte (&message->signature,
5327 _dbus_verbose ("failed to append array type byte to signature\n");
5328 _dbus_list_remove_last (&loader->messages, message);
5329 dbus_message_unref (message);
5335 while (dbus_message_iter_next (&iter));
5338 _dbus_verbose ("Loaded message %p\n", message);
5348 * Peeks at first loaded message, returns #NULL if no messages have
5351 * @param loader the loader.
5352 * @returns the next message, or #NULL if none.
5355 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
5357 if (loader->messages)
5358 return loader->messages->data;
5364 * Pops a loaded message (passing ownership of the message
5365 * to the caller). Returns #NULL if no messages have been
5368 * @param loader the loader.
5369 * @returns the next message, or #NULL if none.
5372 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
5374 return _dbus_list_pop_first (&loader->messages);
5378 * Pops a loaded message inside a list link (passing ownership of the
5379 * message and link to the caller). Returns #NULL if no messages have
5382 * @param loader the loader.
5383 * @returns the next message link, or #NULL if none.
5386 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
5388 return _dbus_list_pop_first_link (&loader->messages);
5392 * Returns a popped message link, used to undo a pop.
5394 * @param loader the loader
5395 * @param link the link with a message in it
5398 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
5401 _dbus_list_prepend_link (&loader->messages, link);
5405 * Checks whether the loader is confused due to bad data.
5406 * If messages are received that are invalid, the
5407 * loader gets confused and gives up permanently.
5408 * This state is called "corrupted."
5410 * @param loader the loader
5411 * @returns #TRUE if the loader is hosed.
5414 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
5416 return loader->corrupted;
5420 * Sets the maximum size message we allow.
5422 * @param loader the loader
5423 * @param size the max message size in bytes
5426 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
5429 if (size > MAX_SANE_MESSAGE_SIZE)
5431 _dbus_verbose ("clamping requested max message size %ld to %d\n",
5432 size, MAX_SANE_MESSAGE_SIZE);
5433 size = MAX_SANE_MESSAGE_SIZE;
5435 loader->max_message_size = size;
5439 * Gets the maximum allowed message size in bytes.
5441 * @param loader the loader
5442 * @returns max size in bytes
5445 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
5447 return loader->max_message_size;
5450 static DBusDataSlotAllocator slot_allocator;
5451 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
5454 * Allocates an integer ID to be used for storing application-specific
5455 * data on any DBusMessage. The allocated ID may then be used
5456 * with dbus_message_set_data() and dbus_message_get_data().
5457 * The passed-in slot must be initialized to -1, and is filled in
5458 * with the slot ID. If the passed-in slot is not -1, it's assumed
5459 * to be already allocated, and its refcount is incremented.
5461 * The allocated slot is global, i.e. all DBusMessage objects will
5462 * have a slot with the given integer ID reserved.
5464 * @param slot_p address of a global variable storing the slot
5465 * @returns #FALSE on failure (no memory)
5468 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
5470 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5471 _DBUS_LOCK_NAME (message_slots),
5476 * Deallocates a global ID for message data slots.
5477 * dbus_message_get_data() and dbus_message_set_data() may no
5478 * longer be used with this slot. Existing data stored on existing
5479 * DBusMessage objects will be freed when the message is
5480 * finalized, but may not be retrieved (and may only be replaced if
5481 * someone else reallocates the slot). When the refcount on the
5482 * passed-in slot reaches 0, it is set to -1.
5484 * @param slot_p address storing the slot to deallocate
5487 dbus_message_free_data_slot (dbus_int32_t *slot_p)
5489 _dbus_return_if_fail (*slot_p >= 0);
5491 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5495 * Stores a pointer on a DBusMessage, along
5496 * with an optional function to be used for freeing
5497 * the data when the data is set again, or when
5498 * the message is finalized. The slot number
5499 * must have been allocated with dbus_message_allocate_data_slot().
5501 * @param message the message
5502 * @param slot the slot number
5503 * @param data the data to store
5504 * @param free_data_func finalizer function for the data
5505 * @returns #TRUE if there was enough memory to store the data
5508 dbus_message_set_data (DBusMessage *message,
5511 DBusFreeFunction free_data_func)
5513 DBusFreeFunction old_free_func;
5517 _dbus_return_val_if_fail (message != NULL, FALSE);
5518 _dbus_return_val_if_fail (slot >= 0, FALSE);
5520 retval = _dbus_data_slot_list_set (&slot_allocator,
5521 &message->slot_list,
5522 slot, data, free_data_func,
5523 &old_free_func, &old_data);
5527 /* Do the actual free outside the message lock */
5529 (* old_free_func) (old_data);
5536 * Retrieves data previously set with dbus_message_set_data().
5537 * The slot must still be allocated (must not have been freed).
5539 * @param message the message
5540 * @param slot the slot to get data from
5541 * @returns the data, or #NULL if not found
5544 dbus_message_get_data (DBusMessage *message,
5549 _dbus_return_val_if_fail (message != NULL, NULL);
5551 res = _dbus_data_slot_list_get (&slot_allocator,
5552 &message->slot_list,
5559 * Utility function to convert a machine-readable (not translated)
5560 * string into a D-BUS message type.
5563 * "method_call" -> DBUS_MESSAGE_TYPE_METHOD_CALL
5564 * "method_return" -> DBUS_MESSAGE_TYPE_METHOD_RETURN
5565 * "signal" -> DBUS_MESSAGE_TYPE_SIGNAL
5566 * "error" -> DBUS_MESSAGE_TYPE_ERROR
5567 * anything else -> DBUS_MESSAGE_TYPE_INVALID
5572 dbus_message_type_from_string (const char *type_str)
5574 if (strcmp (type_str, "method_call") == 0)
5575 return DBUS_MESSAGE_TYPE_METHOD_CALL;
5576 if (strcmp (type_str, "method_return") == 0)
5577 return DBUS_MESSAGE_TYPE_METHOD_RETURN;
5578 else if (strcmp (type_str, "signal") == 0)
5579 return DBUS_MESSAGE_TYPE_SIGNAL;
5580 else if (strcmp (type_str, "error") == 0)
5581 return DBUS_MESSAGE_TYPE_ERROR;
5583 return DBUS_MESSAGE_TYPE_INVALID;
5587 #ifdef DBUS_BUILD_TESTS
5588 #include "dbus-test.h"
5592 message_iter_test (DBusMessage *message)
5594 DBusMessageIter iter, dict, array, array2;
5596 unsigned char *data;
5597 dbus_int32_t *our_int_array;
5600 dbus_message_iter_init (message, &iter);
5603 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
5604 _dbus_assert_not_reached ("Argument type isn't string");
5606 str = dbus_message_iter_get_string (&iter);
5607 if (strcmp (str, "Test string") != 0)
5608 _dbus_assert_not_reached ("Strings differ");
5611 if (!dbus_message_iter_next (&iter))
5612 _dbus_assert_not_reached ("Reached end of arguments");
5614 /* Signed integer tests */
5615 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
5616 _dbus_assert_not_reached ("Argument type isn't int32");
5618 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
5619 _dbus_assert_not_reached ("Signed integers differ");
5621 if (!dbus_message_iter_next (&iter))
5622 _dbus_assert_not_reached ("Reached end of fields");
5624 /* Unsigned integer tests */
5625 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5626 _dbus_assert_not_reached ("Argument type isn't int32");
5628 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
5629 _dbus_assert_not_reached ("Unsigned integers differ");
5631 if (!dbus_message_iter_next (&iter))
5632 _dbus_assert_not_reached ("Reached end of arguments");
5635 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
5636 _dbus_assert_not_reached ("Argument type isn't double");
5638 if (dbus_message_iter_get_double (&iter) != 3.14159)
5639 _dbus_assert_not_reached ("Doubles differ");
5641 if (!dbus_message_iter_next (&iter))
5642 _dbus_assert_not_reached ("Reached end of arguments");
5644 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
5645 _dbus_assert_not_reached ("Argument type not an array");
5647 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
5648 _dbus_assert_not_reached ("Array type not double");
5651 dbus_message_iter_init_array_iterator (&iter, &array, NULL);
5653 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5654 _dbus_assert_not_reached ("Argument type isn't double");
5656 if (dbus_message_iter_get_double (&array) != 1.5)
5657 _dbus_assert_not_reached ("Unsigned integers differ");
5659 if (!dbus_message_iter_next (&array))
5660 _dbus_assert_not_reached ("Reached end of arguments");
5662 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5663 _dbus_assert_not_reached ("Argument type isn't double");
5665 if (dbus_message_iter_get_double (&array) != 2.5)
5666 _dbus_assert_not_reached ("Unsigned integers differ");
5668 if (dbus_message_iter_next (&array))
5669 _dbus_assert_not_reached ("Didn't reach end of arguments");
5671 if (!dbus_message_iter_next (&iter))
5672 _dbus_assert_not_reached ("Reached end of arguments");
5677 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5678 _dbus_assert_not_reached ("not dict type");
5680 dbus_message_iter_init_dict_iterator (&iter, &dict);
5682 str = dbus_message_iter_get_dict_key (&dict);
5683 if (str == NULL || strcmp (str, "test") != 0)
5684 _dbus_assert_not_reached ("wrong dict key");
5687 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5688 _dbus_assert_not_reached ("wrong dict entry type");
5690 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
5691 _dbus_assert_not_reached ("wrong dict entry value");
5693 if (!dbus_message_iter_next (&dict))
5694 _dbus_assert_not_reached ("reached end of dict");
5696 /* array of array of int32 (in dict) */
5698 str = dbus_message_iter_get_dict_key (&dict);
5699 if (str == NULL || strcmp (str, "array") != 0)
5700 _dbus_assert_not_reached ("wrong dict key");
5703 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
5704 _dbus_assert_not_reached ("Argument type not an array");
5706 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
5707 _dbus_assert_not_reached ("Array type not array");
5709 dbus_message_iter_init_array_iterator (&dict, &array, NULL);
5711 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
5712 _dbus_assert_not_reached ("Argument type isn't array");
5714 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5715 _dbus_assert_not_reached ("Array type not int32");
5717 dbus_message_iter_init_array_iterator (&array, &array2, NULL);
5719 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
5720 _dbus_assert_not_reached ("Argument type isn't int32");
5722 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
5723 _dbus_assert_not_reached ("Signed integers differ");
5725 if (!dbus_message_iter_next (&array2))
5726 _dbus_assert_not_reached ("Reached end of arguments");
5728 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
5729 _dbus_assert_not_reached ("Signed integers differ");
5731 if (dbus_message_iter_next (&array2))
5732 _dbus_assert_not_reached ("Didn't reached end of arguments");
5734 if (!dbus_message_iter_next (&array))
5735 _dbus_assert_not_reached ("Reached end of arguments");
5737 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5738 _dbus_assert_not_reached ("Array type not int32");
5740 if (!dbus_message_iter_get_int32_array (&array,
5743 _dbus_assert_not_reached ("couldn't get int32 array");
5745 _dbus_assert (len == 3);
5746 _dbus_assert (our_int_array[0] == 0x34567812 &&
5747 our_int_array[1] == 0x45678123 &&
5748 our_int_array[2] == 0x56781234);
5749 dbus_free (our_int_array);
5751 if (dbus_message_iter_next (&array))
5752 _dbus_assert_not_reached ("Didn't reach end of array");
5754 if (dbus_message_iter_next (&dict))
5755 _dbus_assert_not_reached ("Didn't reach end of dict");
5757 if (!dbus_message_iter_next (&iter))
5758 _dbus_assert_not_reached ("Reached end of arguments");
5760 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
5762 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
5763 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
5766 if (dbus_message_iter_get_byte (&iter) != 0xF0)
5767 _dbus_assert_not_reached ("wrong value after dict");
5770 if (!dbus_message_iter_next (&iter))
5771 _dbus_assert_not_reached ("Reached end of arguments");
5773 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
5774 _dbus_assert_not_reached ("not a nil type");
5776 if (!dbus_message_iter_next (&iter))
5777 _dbus_assert_not_reached ("Reached end of arguments");
5779 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
5780 _dbus_assert_not_reached ("wrong type after dict");
5782 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
5783 _dbus_assert_not_reached ("failed to get named");
5785 _dbus_assert (strcmp (str, "named")==0);
5786 _dbus_assert (len == 5);
5787 _dbus_assert (strcmp (data, "data")==0);
5791 if (dbus_message_iter_next (&iter))
5792 _dbus_assert_not_reached ("Didn't reach end of arguments");
5797 check_message_handling_type (DBusMessageIter *iter,
5800 DBusMessageIter child_iter;
5806 case DBUS_TYPE_BYTE:
5807 dbus_message_iter_get_byte (iter);
5809 case DBUS_TYPE_BOOLEAN:
5810 dbus_message_iter_get_boolean (iter);
5812 case DBUS_TYPE_INT32:
5813 dbus_message_iter_get_int32 (iter);
5815 case DBUS_TYPE_UINT32:
5816 dbus_message_iter_get_uint32 (iter);
5818 case DBUS_TYPE_INT64:
5819 #ifdef DBUS_HAVE_INT64
5820 dbus_message_iter_get_int64 (iter);
5823 case DBUS_TYPE_UINT64:
5824 #ifdef DBUS_HAVE_INT64
5825 dbus_message_iter_get_uint64 (iter);
5828 case DBUS_TYPE_DOUBLE:
5829 dbus_message_iter_get_double (iter);
5831 case DBUS_TYPE_STRING:
5834 str = dbus_message_iter_get_string (iter);
5837 _dbus_warn ("NULL string in message\n");
5843 case DBUS_TYPE_NAMED:
5846 unsigned char *data;
5849 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
5851 _dbus_warn ("error reading name from named type\n");
5858 case DBUS_TYPE_ARRAY:
5862 dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type);
5864 while (dbus_message_iter_has_next (&child_iter))
5866 if (!check_message_handling_type (&child_iter, array_type))
5868 _dbus_warn ("error in array element\n");
5872 if (!dbus_message_iter_next (&child_iter))
5877 case DBUS_TYPE_DICT:
5882 dbus_message_iter_init_dict_iterator (iter, &child_iter);
5884 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5886 key = dbus_message_iter_get_dict_key (&child_iter);
5889 _dbus_warn ("error reading dict key\n");
5894 if (!check_message_handling_type (&child_iter, entry_type))
5896 _dbus_warn ("error in dict value\n");
5900 if (!dbus_message_iter_next (&child_iter))
5907 _dbus_warn ("unknown type %d\n", type);
5916 check_message_handling (DBusMessage *message)
5918 DBusMessageIter iter;
5921 dbus_uint32_t client_serial;
5925 client_serial = dbus_message_get_serial (message);
5927 /* can't use set_serial due to the assertions at the start of it */
5928 _dbus_marshal_set_uint32 (&message->header,
5929 message->byte_order,
5930 CLIENT_SERIAL_OFFSET,
5933 if (client_serial != dbus_message_get_serial (message))
5935 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5939 /* If we implement message_set_arg (message, n, value)
5940 * then we would want to test it here
5943 dbus_message_iter_init (message, &iter);
5944 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5946 if (!check_message_handling_type (&iter, type))
5949 if (!dbus_message_iter_next (&iter))
5960 check_have_valid_message (DBusMessageLoader *loader)
5962 DBusMessage *message;
5968 if (!_dbus_message_loader_queue_messages (loader))
5969 _dbus_assert_not_reached ("no memory to queue messages");
5971 if (_dbus_message_loader_get_is_corrupted (loader))
5973 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5977 message = _dbus_message_loader_pop_message (loader);
5978 if (message == NULL)
5980 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5984 if (_dbus_string_get_length (&loader->data) > 0)
5986 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5990 /* Verify that we're able to properly deal with the message.
5991 * For example, this would detect improper handling of messages
5992 * in nonstandard byte order.
5994 if (!check_message_handling (message))
6001 dbus_message_unref (message);
6007 check_invalid_message (DBusMessageLoader *loader)
6013 if (!_dbus_message_loader_queue_messages (loader))
6014 _dbus_assert_not_reached ("no memory to queue messages");
6016 if (!_dbus_message_loader_get_is_corrupted (loader))
6018 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
6029 check_incomplete_message (DBusMessageLoader *loader)
6031 DBusMessage *message;
6037 if (!_dbus_message_loader_queue_messages (loader))
6038 _dbus_assert_not_reached ("no memory to queue messages");
6040 if (_dbus_message_loader_get_is_corrupted (loader))
6042 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
6046 message = _dbus_message_loader_pop_message (loader);
6047 if (message != NULL)
6049 _dbus_warn ("loaded message that was expected to be incomplete\n");
6057 dbus_message_unref (message);
6062 check_loader_results (DBusMessageLoader *loader,
6063 DBusMessageValidity validity)
6065 if (!_dbus_message_loader_queue_messages (loader))
6066 _dbus_assert_not_reached ("no memory to queue messages");
6070 case _DBUS_MESSAGE_VALID:
6071 return check_have_valid_message (loader);
6072 case _DBUS_MESSAGE_INVALID:
6073 return check_invalid_message (loader);
6074 case _DBUS_MESSAGE_INCOMPLETE:
6075 return check_incomplete_message (loader);
6076 case _DBUS_MESSAGE_UNKNOWN:
6080 _dbus_assert_not_reached ("bad DBusMessageValidity");
6086 * Loads the message in the given message file.
6088 * @param filename filename to load
6089 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
6090 * @param data string to load message into
6091 * @returns #TRUE if the message was loaded
6094 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
6106 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
6107 dbus_error_init (&error);
6108 if (!_dbus_file_get_contents (data, filename, &error))
6110 _dbus_warn ("Could not load message file %s: %s\n",
6111 _dbus_string_get_const_data (filename),
6113 dbus_error_free (&error);
6119 if (!_dbus_message_data_load (data, filename))
6121 _dbus_warn ("Could not load message file %s\n",
6122 _dbus_string_get_const_data (filename));
6135 * Tries loading the message in the given message file
6136 * and verifies that DBusMessageLoader can handle it.
6138 * @param filename filename to load
6139 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
6140 * @param expected_validity what the message has to be like to return #TRUE
6141 * @returns #TRUE if the message has the expected validity
6144 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
6146 DBusMessageValidity expected_validity)
6153 if (!_dbus_string_init (&data))
6154 _dbus_assert_not_reached ("could not allocate string\n");
6156 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
6160 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
6166 if (_dbus_string_get_length (&data) > 0)
6167 _dbus_verbose_bytes_of_string (&data, 0,
6168 _dbus_string_get_length (&data));
6170 _dbus_warn ("Failed message loader test on %s\n",
6171 _dbus_string_get_const_data (filename));
6174 _dbus_string_free (&data);
6180 * Tries loading the given message data.
6183 * @param data the message data
6184 * @param expected_validity what the message has to be like to return #TRUE
6185 * @returns #TRUE if the message has the expected validity
6188 dbus_internal_do_not_use_try_message_data (const DBusString *data,
6189 DBusMessageValidity expected_validity)
6191 DBusMessageLoader *loader;
6199 /* Write the data one byte at a time */
6201 loader = _dbus_message_loader_new ();
6203 /* check some trivial loader functions */
6204 _dbus_message_loader_ref (loader);
6205 _dbus_message_loader_unref (loader);
6206 _dbus_message_loader_get_max_message_size (loader);
6208 len = _dbus_string_get_length (data);
6209 for (i = 0; i < len; i++)
6213 _dbus_message_loader_get_buffer (loader, &buffer);
6214 _dbus_string_append_byte (buffer,
6215 _dbus_string_get_byte (data, i));
6216 _dbus_message_loader_return_buffer (loader, buffer, 1);
6219 if (!check_loader_results (loader, expected_validity))
6222 _dbus_message_loader_unref (loader);
6225 /* Write the data all at once */
6227 loader = _dbus_message_loader_new ();
6232 _dbus_message_loader_get_buffer (loader, &buffer);
6233 _dbus_string_copy (data, 0, buffer,
6234 _dbus_string_get_length (buffer));
6235 _dbus_message_loader_return_buffer (loader, buffer, 1);
6238 if (!check_loader_results (loader, expected_validity))
6241 _dbus_message_loader_unref (loader);
6244 /* Write the data 2 bytes at a time */
6246 loader = _dbus_message_loader_new ();
6248 len = _dbus_string_get_length (data);
6249 for (i = 0; i < len; i += 2)
6253 _dbus_message_loader_get_buffer (loader, &buffer);
6254 _dbus_string_append_byte (buffer,
6255 _dbus_string_get_byte (data, i));
6257 _dbus_string_append_byte (buffer,
6258 _dbus_string_get_byte (data, i+1));
6259 _dbus_message_loader_return_buffer (loader, buffer, 1);
6262 if (!check_loader_results (loader, expected_validity))
6265 _dbus_message_loader_unref (loader);
6273 _dbus_message_loader_unref (loader);
6279 process_test_subdir (const DBusString *test_base_dir,
6281 DBusMessageValidity validity,
6282 DBusForeachMessageFileFunc function,
6285 DBusString test_directory;
6286 DBusString filename;
6294 if (!_dbus_string_init (&test_directory))
6295 _dbus_assert_not_reached ("didn't allocate test_directory\n");
6297 _dbus_string_init_const (&filename, subdir);
6299 if (!_dbus_string_copy (test_base_dir, 0,
6300 &test_directory, 0))
6301 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
6303 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
6304 _dbus_assert_not_reached ("couldn't allocate full path");
6306 _dbus_string_free (&filename);
6307 if (!_dbus_string_init (&filename))
6308 _dbus_assert_not_reached ("didn't allocate filename string\n");
6310 dbus_error_init (&error);
6311 dir = _dbus_directory_open (&test_directory, &error);
6314 _dbus_warn ("Could not open %s: %s\n",
6315 _dbus_string_get_const_data (&test_directory),
6317 dbus_error_free (&error);
6321 printf ("Testing %s:\n", subdir);
6324 while (_dbus_directory_get_next_file (dir, &filename, &error))
6326 DBusString full_path;
6329 if (!_dbus_string_init (&full_path))
6330 _dbus_assert_not_reached ("couldn't init string");
6332 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
6333 _dbus_assert_not_reached ("couldn't copy dir to full_path");
6335 if (!_dbus_concat_dir_and_file (&full_path, &filename))
6336 _dbus_assert_not_reached ("couldn't concat file to dir");
6338 if (_dbus_string_ends_with_c_str (&filename, ".message"))
6340 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
6344 _dbus_verbose ("Skipping non-.message file %s\n",
6345 _dbus_string_get_const_data (&filename));
6346 _dbus_string_free (&full_path);
6351 _dbus_string_get_const_data (&filename));
6353 _dbus_verbose (" expecting %s for %s\n",
6354 validity == _DBUS_MESSAGE_VALID ? "valid" :
6355 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
6356 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")),
6357 _dbus_string_get_const_data (&filename));
6359 if (! (*function) (&full_path, is_raw, validity, user_data))
6361 _dbus_string_free (&full_path);
6365 _dbus_string_free (&full_path);
6368 if (dbus_error_is_set (&error))
6370 _dbus_warn ("Could not get next file in %s: %s\n",
6371 _dbus_string_get_const_data (&test_directory),
6373 dbus_error_free (&error);
6382 _dbus_directory_close (dir);
6383 _dbus_string_free (&test_directory);
6384 _dbus_string_free (&filename);
6390 * Runs the given function on every message file in the test suite.
6391 * The function should return #FALSE on test failure or fatal error.
6393 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
6394 * @param func the function to run
6395 * @param user_data data for function
6396 * @returns #FALSE if there's a failure
6399 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
6400 DBusForeachMessageFileFunc func,
6403 DBusString test_directory;
6408 _dbus_string_init_const (&test_directory, test_data_dir);
6410 if (!process_test_subdir (&test_directory, "valid-messages",
6411 _DBUS_MESSAGE_VALID, func, user_data))
6414 if (!process_test_subdir (&test_directory, "invalid-messages",
6415 _DBUS_MESSAGE_INVALID, func, user_data))
6418 if (!process_test_subdir (&test_directory, "incomplete-messages",
6419 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
6426 _dbus_string_free (&test_directory);
6432 verify_test_message (DBusMessage *message)
6434 DBusMessageIter iter, dict;
6436 dbus_int32_t our_int;
6439 dbus_bool_t our_bool;
6440 dbus_uint32_t our_uint32;
6441 dbus_int32_t *our_uint32_array;
6442 int our_uint32_array_len;
6443 dbus_int32_t *our_int32_array;
6444 int our_int32_array_len;
6445 char **our_string_array;
6446 int our_string_array_len;
6447 #ifdef DBUS_HAVE_INT64
6448 dbus_int64_t our_int64;
6449 dbus_uint64_t our_uint64;
6450 dbus_int64_t *our_uint64_array;
6451 int our_uint64_array_len;
6452 dbus_int64_t *our_int64_array;
6453 int our_int64_array_len;
6455 double *our_double_array;
6456 int our_double_array_len;
6457 unsigned char *our_byte_array;
6458 int our_byte_array_len;
6459 unsigned char *our_boolean_array;
6460 int our_boolean_array_len;
6462 dbus_message_iter_init (message, &iter);
6464 dbus_error_init (&error);
6465 if (!dbus_message_iter_get_args (&iter, &error,
6466 DBUS_TYPE_INT32, &our_int,
6467 #ifdef DBUS_HAVE_INT64
6468 DBUS_TYPE_INT64, &our_int64,
6469 DBUS_TYPE_UINT64, &our_uint64,
6471 DBUS_TYPE_STRING, &our_str,
6472 DBUS_TYPE_DOUBLE, &our_double,
6473 DBUS_TYPE_BOOLEAN, &our_bool,
6474 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
6475 &our_uint32_array, &our_uint32_array_len,
6476 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
6477 &our_int32_array, &our_int32_array_len,
6478 #ifdef DBUS_HAVE_INT64
6479 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
6480 &our_uint64_array, &our_uint64_array_len,
6481 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
6482 &our_int64_array, &our_int64_array_len,
6484 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
6485 &our_string_array, &our_string_array_len,
6486 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
6487 &our_double_array, &our_double_array_len,
6488 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
6489 &our_byte_array, &our_byte_array_len,
6490 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
6491 &our_boolean_array, &our_boolean_array_len,
6494 _dbus_warn ("error: %s - %s\n", error.name,
6495 (error.message != NULL) ? error.message : "no message");
6496 _dbus_assert_not_reached ("Could not get arguments");
6499 if (our_int != -0x12345678)
6500 _dbus_assert_not_reached ("integers differ!");
6502 #ifdef DBUS_HAVE_INT64
6503 if (our_int64 != -0x123456789abcd)
6504 _dbus_assert_not_reached ("64-bit integers differ!");
6505 if (our_uint64 != 0x123456789abcd)
6506 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
6509 if (our_double != 3.14159)
6510 _dbus_assert_not_reached ("doubles differ!");
6512 if (strcmp (our_str, "Test string") != 0)
6513 _dbus_assert_not_reached ("strings differ!");
6514 dbus_free (our_str);
6517 _dbus_assert_not_reached ("booleans differ");
6519 if (our_uint32_array_len != 4 ||
6520 our_uint32_array[0] != 0x12345678 ||
6521 our_uint32_array[1] != 0x23456781 ||
6522 our_uint32_array[2] != 0x34567812 ||
6523 our_uint32_array[3] != 0x45678123)
6524 _dbus_assert_not_reached ("uint array differs");
6525 dbus_free (our_uint32_array);
6527 if (our_int32_array_len != 4 ||
6528 our_int32_array[0] != 0x12345678 ||
6529 our_int32_array[1] != -0x23456781 ||
6530 our_int32_array[2] != 0x34567812 ||
6531 our_int32_array[3] != -0x45678123)
6532 _dbus_assert_not_reached ("int array differs");
6533 dbus_free (our_int32_array);
6535 #ifdef DBUS_HAVE_INT64
6536 if (our_uint64_array_len != 4 ||
6537 our_uint64_array[0] != 0x12345678 ||
6538 our_uint64_array[1] != 0x23456781 ||
6539 our_uint64_array[2] != 0x34567812 ||
6540 our_uint64_array[3] != 0x45678123)
6541 _dbus_assert_not_reached ("uint64 array differs");
6542 dbus_free (our_uint64_array);
6544 if (our_int64_array_len != 4 ||
6545 our_int64_array[0] != 0x12345678 ||
6546 our_int64_array[1] != -0x23456781 ||
6547 our_int64_array[2] != 0x34567812 ||
6548 our_int64_array[3] != -0x45678123)
6549 _dbus_assert_not_reached ("int64 array differs");
6550 dbus_free (our_int64_array);
6551 #endif /* DBUS_HAVE_INT64 */
6553 if (our_string_array_len != 4)
6554 _dbus_assert_not_reached ("string array has wrong length");
6556 if (strcmp (our_string_array[0], "Foo") != 0 ||
6557 strcmp (our_string_array[1], "bar") != 0 ||
6558 strcmp (our_string_array[2], "") != 0 ||
6559 strcmp (our_string_array[3], "woo woo woo woo") != 0)
6560 _dbus_assert_not_reached ("string array differs");
6562 dbus_free_string_array (our_string_array);
6564 if (our_double_array_len != 3)
6565 _dbus_assert_not_reached ("double array had wrong length");
6567 /* On all IEEE machines (i.e. everything sane) exact equality
6568 * should be preserved over the wire
6570 if (our_double_array[0] != 0.1234 ||
6571 our_double_array[1] != 9876.54321 ||
6572 our_double_array[2] != -300.0)
6573 _dbus_assert_not_reached ("double array had wrong values");
6575 dbus_free (our_double_array);
6577 if (our_byte_array_len != 4)
6578 _dbus_assert_not_reached ("byte array had wrong length");
6580 if (our_byte_array[0] != 'a' ||
6581 our_byte_array[1] != 'b' ||
6582 our_byte_array[2] != 'c' ||
6583 our_byte_array[3] != 234)
6584 _dbus_assert_not_reached ("byte array had wrong values");
6586 dbus_free (our_byte_array);
6588 if (our_boolean_array_len != 5)
6589 _dbus_assert_not_reached ("bool array had wrong length");
6591 if (our_boolean_array[0] != TRUE ||
6592 our_boolean_array[1] != FALSE ||
6593 our_boolean_array[2] != TRUE ||
6594 our_boolean_array[3] != TRUE ||
6595 our_boolean_array[4] != FALSE)
6596 _dbus_assert_not_reached ("bool array had wrong values");
6598 dbus_free (our_boolean_array);
6600 if (!dbus_message_iter_next (&iter))
6601 _dbus_assert_not_reached ("Reached end of arguments");
6603 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
6604 _dbus_assert_not_reached ("not dict type");
6606 dbus_message_iter_init_dict_iterator (&iter, &dict);
6608 our_str = dbus_message_iter_get_dict_key (&dict);
6609 if (our_str == NULL || strcmp (our_str, "test") != 0)
6610 _dbus_assert_not_reached ("wrong dict key");
6611 dbus_free (our_str);
6613 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
6615 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
6616 _dbus_assert_not_reached ("wrong dict entry type");
6619 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
6621 _dbus_verbose ("dict entry val: %x\n", our_uint32);
6622 _dbus_assert_not_reached ("wrong dict entry value");
6625 if (dbus_message_iter_next (&dict))
6626 _dbus_assert_not_reached ("Didn't reach end of dict");
6628 if (!dbus_message_iter_next (&iter))
6629 _dbus_assert_not_reached ("Reached end of arguments");
6631 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
6632 _dbus_assert_not_reached ("wrong type after dict");
6634 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
6635 _dbus_assert_not_reached ("wrong value after dict");
6637 if (dbus_message_iter_next (&iter))
6638 _dbus_assert_not_reached ("Didn't reach end of arguments");
6642 * @ingroup DBusMessageInternals
6643 * Unit test for DBusMessage.
6645 * @returns #TRUE on success.
6648 _dbus_message_test (const char *test_data_dir)
6650 DBusMessage *message;
6651 DBusMessageLoader *loader;
6652 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
6658 const dbus_uint32_t our_uint32_array[] =
6659 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6660 const dbus_uint32_t our_int32_array[] =
6661 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6662 #ifdef DBUS_HAVE_INT64
6663 const dbus_uint64_t our_uint64_array[] =
6664 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6665 const dbus_uint64_t our_int64_array[] =
6666 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6668 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
6669 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
6670 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
6671 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
6675 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
6677 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6678 "/org/freedesktop/TestPath",
6679 "Foo.TestInterface",
6681 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6682 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
6684 _dbus_assert (strcmp (dbus_message_get_path (message),
6685 "/org/freedesktop/TestPath") == 0);
6686 _dbus_message_set_serial (message, 1234);
6687 /* string length including nul byte not a multiple of 4 */
6688 if (!dbus_message_set_sender (message, "org.foo.bar1"))
6689 _dbus_assert_not_reached ("out of memory");
6690 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar1"));
6691 dbus_message_set_reply_serial (message, 5678);
6692 if (!dbus_message_set_sender (message, NULL))
6693 _dbus_assert_not_reached ("out of memory");
6694 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar1"));
6695 _dbus_assert (dbus_message_get_serial (message) == 1234);
6696 _dbus_assert (dbus_message_get_reply_serial (message) == 5678);
6697 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6699 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6700 dbus_message_set_no_reply (message, TRUE);
6701 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
6702 dbus_message_set_no_reply (message, FALSE);
6703 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6706 /* Set/get some header fields */
6708 if (!dbus_message_set_path (message, "/foo"))
6709 _dbus_assert_not_reached ("out of memory");
6710 _dbus_assert (strcmp (dbus_message_get_path (message),
6713 if (!dbus_message_set_interface (message, "org.Foo"))
6714 _dbus_assert_not_reached ("out of memory");
6715 _dbus_assert (strcmp (dbus_message_get_interface (message),
6718 if (!dbus_message_set_member (message, "Bar"))
6719 _dbus_assert_not_reached ("out of memory");
6720 _dbus_assert (strcmp (dbus_message_get_member (message),
6723 /* Set/get them with longer values */
6724 if (!dbus_message_set_path (message, "/foo/bar"))
6725 _dbus_assert_not_reached ("out of memory");
6726 _dbus_assert (strcmp (dbus_message_get_path (message),
6729 if (!dbus_message_set_interface (message, "org.Foo.Bar"))
6730 _dbus_assert_not_reached ("out of memory");
6731 _dbus_assert (strcmp (dbus_message_get_interface (message),
6732 "org.Foo.Bar") == 0);
6734 if (!dbus_message_set_member (message, "BarFoo"))
6735 _dbus_assert_not_reached ("out of memory");
6736 _dbus_assert (strcmp (dbus_message_get_member (message),
6739 /* Realloc shorter again */
6741 if (!dbus_message_set_path (message, "/foo"))
6742 _dbus_assert_not_reached ("out of memory");
6743 _dbus_assert (strcmp (dbus_message_get_path (message),
6746 if (!dbus_message_set_interface (message, "org.Foo"))
6747 _dbus_assert_not_reached ("out of memory");
6748 _dbus_assert (strcmp (dbus_message_get_interface (message),
6751 if (!dbus_message_set_member (message, "Bar"))
6752 _dbus_assert_not_reached ("out of memory");
6753 _dbus_assert (strcmp (dbus_message_get_member (message),
6757 dbus_message_unref (message);
6759 /* Test the vararg functions */
6760 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6761 "/org/freedesktop/TestPath",
6762 "Foo.TestInterface",
6764 _dbus_message_set_serial (message, 1);
6765 dbus_message_append_args (message,
6766 DBUS_TYPE_INT32, -0x12345678,
6767 #ifdef DBUS_HAVE_INT64
6768 DBUS_TYPE_INT64, -0x123456789abcd,
6769 DBUS_TYPE_UINT64, 0x123456789abcd,
6771 DBUS_TYPE_STRING, "Test string",
6772 DBUS_TYPE_DOUBLE, 3.14159,
6773 DBUS_TYPE_BOOLEAN, TRUE,
6774 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
6775 _DBUS_N_ELEMENTS (our_uint32_array),
6776 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
6777 _DBUS_N_ELEMENTS (our_int32_array),
6778 #ifdef DBUS_HAVE_INT64
6779 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
6780 _DBUS_N_ELEMENTS (our_uint64_array),
6781 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
6782 _DBUS_N_ELEMENTS (our_int64_array),
6784 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
6785 _DBUS_N_ELEMENTS (our_string_array),
6786 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
6787 _DBUS_N_ELEMENTS (our_double_array),
6788 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
6789 _DBUS_N_ELEMENTS (our_byte_array),
6790 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
6791 _DBUS_N_ELEMENTS (our_boolean_array),
6794 dbus_message_append_iter_init (message, &iter);
6795 dbus_message_iter_append_dict (&iter, &child_iter);
6796 dbus_message_iter_append_dict_key (&child_iter, "test");
6797 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6798 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
6801 sig[i++] = DBUS_TYPE_INT32;
6802 #ifdef DBUS_HAVE_INT64
6803 sig[i++] = DBUS_TYPE_INT64;
6804 sig[i++] = DBUS_TYPE_UINT64;
6806 sig[i++] = DBUS_TYPE_STRING;
6807 sig[i++] = DBUS_TYPE_DOUBLE;
6808 sig[i++] = DBUS_TYPE_BOOLEAN;
6809 sig[i++] = DBUS_TYPE_ARRAY;
6810 sig[i++] = DBUS_TYPE_UINT32;
6811 sig[i++] = DBUS_TYPE_ARRAY;
6812 sig[i++] = DBUS_TYPE_INT32;
6813 #ifdef DBUS_HAVE_INT64
6814 sig[i++] = DBUS_TYPE_ARRAY;
6815 sig[i++] = DBUS_TYPE_UINT64;
6816 sig[i++] = DBUS_TYPE_ARRAY;
6817 sig[i++] = DBUS_TYPE_INT64;
6819 sig[i++] = DBUS_TYPE_ARRAY;
6820 sig[i++] = DBUS_TYPE_STRING;
6821 sig[i++] = DBUS_TYPE_ARRAY;
6822 sig[i++] = DBUS_TYPE_DOUBLE;
6823 sig[i++] = DBUS_TYPE_ARRAY;
6824 sig[i++] = DBUS_TYPE_BYTE;
6825 sig[i++] = DBUS_TYPE_ARRAY;
6826 sig[i++] = DBUS_TYPE_BOOLEAN;
6827 sig[i++] = DBUS_TYPE_DICT;
6828 sig[i++] = DBUS_TYPE_UINT32;
6829 sig[i++] = DBUS_TYPE_INVALID;
6831 _dbus_assert (i < (int) _DBUS_N_ELEMENTS (sig));
6833 _dbus_verbose_bytes_of_string (&message->header, 0,
6834 _dbus_string_get_length (&message->header));
6835 _dbus_verbose_bytes_of_string (&message->body, 0,
6836 _dbus_string_get_length (&message->body));
6838 _dbus_verbose ("Signature expected \"%s\" actual \"%s\"\n",
6839 sig, dbus_message_get_signature (message));
6841 s = dbus_message_get_signature (message);
6843 _dbus_assert (dbus_message_has_signature (message, sig));
6844 _dbus_assert (strcmp (s, sig) == 0);
6846 verify_test_message (message);
6848 copy = dbus_message_copy (message);
6850 _dbus_assert (message->client_serial == copy->client_serial);
6851 _dbus_assert (message->reply_serial == copy->reply_serial);
6852 _dbus_assert (message->header_padding == copy->header_padding);
6854 _dbus_assert (_dbus_string_get_length (&message->header) ==
6855 _dbus_string_get_length (©->header));
6857 _dbus_assert (_dbus_string_get_length (&message->body) ==
6858 _dbus_string_get_length (©->body));
6860 _dbus_assert (_dbus_string_get_length (&message->signature) ==
6861 _dbus_string_get_length (©->signature));
6863 verify_test_message (copy);
6865 name1 = dbus_message_get_interface (message);
6866 name2 = dbus_message_get_interface (copy);
6868 _dbus_assert (strcmp (name1, name2) == 0);
6870 name1 = dbus_message_get_member (message);
6871 name2 = dbus_message_get_member (copy);
6873 _dbus_assert (strcmp (name1, name2) == 0);
6875 dbus_message_unref (message);
6876 dbus_message_unref (copy);
6878 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6879 "/org/freedesktop/TestPath",
6880 "Foo.TestInterface",
6883 _dbus_message_set_serial (message, 1);
6884 dbus_message_set_reply_serial (message, 0x12345678);
6886 dbus_message_append_iter_init (message, &iter);
6887 dbus_message_iter_append_string (&iter, "Test string");
6888 dbus_message_iter_append_int32 (&iter, -0x12345678);
6889 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
6890 dbus_message_iter_append_double (&iter, 3.14159);
6892 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
6893 dbus_message_iter_append_double (&child_iter, 1.5);
6894 dbus_message_iter_append_double (&child_iter, 2.5);
6897 dbus_message_iter_append_dict (&iter, &child_iter);
6898 dbus_message_iter_append_dict_key (&child_iter, "test");
6899 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6901 /* array of array of int32 (in dict) */
6902 dbus_message_iter_append_dict_key (&child_iter, "array");
6903 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
6904 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6905 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
6906 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
6907 _dbus_warn ("next call expected to fail with wrong array type\n");
6908 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
6909 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6910 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
6911 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
6912 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
6914 dbus_message_iter_append_byte (&iter, 0xF0);
6916 dbus_message_iter_append_nil (&iter);
6918 dbus_message_iter_append_named (&iter, "named",
6921 message_iter_test (message);
6923 /* Message loader test */
6924 _dbus_message_lock (message);
6925 loader = _dbus_message_loader_new ();
6927 /* check ref/unref */
6928 _dbus_message_loader_ref (loader);
6929 _dbus_message_loader_unref (loader);
6931 /* Write the header data one byte at a time */
6932 data = _dbus_string_get_const_data (&message->header);
6933 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
6937 _dbus_message_loader_get_buffer (loader, &buffer);
6938 _dbus_string_append_byte (buffer, data[i]);
6939 _dbus_message_loader_return_buffer (loader, buffer, 1);
6942 /* Write the body data one byte at a time */
6943 data = _dbus_string_get_const_data (&message->body);
6944 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
6948 _dbus_message_loader_get_buffer (loader, &buffer);
6949 _dbus_string_append_byte (buffer, data[i]);
6950 _dbus_message_loader_return_buffer (loader, buffer, 1);
6953 dbus_message_unref (message);
6955 /* Now pop back the message */
6956 if (!_dbus_message_loader_queue_messages (loader))
6957 _dbus_assert_not_reached ("no memory to queue messages");
6959 if (_dbus_message_loader_get_is_corrupted (loader))
6960 _dbus_assert_not_reached ("message loader corrupted");
6962 message = _dbus_message_loader_pop_message (loader);
6964 _dbus_assert_not_reached ("received a NULL message");
6966 if (dbus_message_get_reply_serial (message) != 0x12345678)
6967 _dbus_assert_not_reached ("reply serial fields differ");
6969 message_iter_test (message);
6971 dbus_message_unref (message);
6972 _dbus_message_loader_unref (loader);
6974 /* Now load every message in test_data_dir if we have one */
6975 if (test_data_dir == NULL)
6978 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6979 (DBusForeachMessageFileFunc)
6980 dbus_internal_do_not_use_try_message_file,
6984 #endif /* DBUS_BUILD_TESTS */