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 dbus_message_set_no_reply (message, TRUE);
1229 if (!dbus_message_set_reply_serial (message,
1230 dbus_message_get_serial (method_call)))
1232 dbus_message_unref (message);
1240 * Constructs a new message representing a signal emission. Returns
1241 * #NULL if memory can't be allocated for the message.
1242 * A signal is identified by its originating interface, and
1243 * the name of the signal.
1245 * @param path the path to the object emitting the signal
1246 * @param interface the interface the signal is emitted from
1247 * @param name name of the signal
1248 * @returns a new DBusMessage, free with dbus_message_unref()
1249 * @see dbus_message_unref()
1252 dbus_message_new_signal (const char *path,
1253 const char *interface,
1256 DBusMessage *message;
1258 _dbus_return_val_if_fail (path != NULL, NULL);
1259 _dbus_return_val_if_fail (interface != NULL, NULL);
1260 _dbus_return_val_if_fail (name != NULL, NULL);
1262 message = dbus_message_new_empty_header ();
1263 if (message == NULL)
1266 if (!dbus_message_create_header (message,
1267 DBUS_MESSAGE_TYPE_SIGNAL,
1268 NULL, path, interface, name, NULL))
1270 dbus_message_unref (message);
1274 dbus_message_set_no_reply (message, TRUE);
1280 * Creates a new message that is an error reply to a certain message.
1281 * Error replies are possible in response to method calls primarily.
1283 * @param reply_to the original message
1284 * @param error_name the error name
1285 * @param error_message the error message string or #NULL for none
1286 * @returns a new error message
1289 dbus_message_new_error (DBusMessage *reply_to,
1290 const char *error_name,
1291 const char *error_message)
1293 DBusMessage *message;
1295 DBusMessageIter iter;
1297 _dbus_return_val_if_fail (reply_to != NULL, NULL);
1298 _dbus_return_val_if_fail (error_name != NULL, NULL);
1300 sender = get_string_field (reply_to,
1301 DBUS_HEADER_FIELD_SENDER_SERVICE,
1304 /* sender may be NULL for non-message-bus case or
1305 * when the message bus is dealing with an unregistered
1308 message = dbus_message_new_empty_header ();
1309 if (message == NULL)
1312 if (!dbus_message_create_header (message,
1313 DBUS_MESSAGE_TYPE_ERROR,
1314 sender, NULL, NULL, NULL, error_name))
1316 dbus_message_unref (message);
1320 dbus_message_set_no_reply (message, TRUE);
1322 if (!dbus_message_set_reply_serial (message,
1323 dbus_message_get_serial (reply_to)))
1325 dbus_message_unref (message);
1329 if (error_message != NULL)
1331 dbus_message_append_iter_init (message, &iter);
1332 if (!dbus_message_iter_append_string (&iter, error_message))
1334 dbus_message_unref (message);
1343 * Creates a new message that is an exact replica of the message
1344 * specified, except that its refcount is set to 1.
1346 * @param message the message.
1347 * @returns the new message.
1350 dbus_message_copy (const DBusMessage *message)
1352 DBusMessage *retval;
1355 _dbus_return_val_if_fail (message != NULL, NULL);
1357 retval = dbus_new0 (DBusMessage, 1);
1361 retval->refcount.value = 1;
1362 retval->byte_order = message->byte_order;
1363 retval->client_serial = message->client_serial;
1364 retval->reply_serial = message->reply_serial;
1365 retval->header_padding = message->header_padding;
1366 retval->locked = FALSE;
1368 if (!_dbus_string_init_preallocated (&retval->header,
1369 _dbus_string_get_length (&message->header)))
1375 if (!_dbus_string_init_preallocated (&retval->body,
1376 _dbus_string_get_length (&message->body)))
1378 _dbus_string_free (&retval->header);
1383 if (!_dbus_string_init_preallocated (&retval->signature,
1384 _dbus_string_get_length (&message->signature)))
1386 _dbus_string_free (&retval->header);
1387 _dbus_string_free (&retval->body);
1392 if (!_dbus_string_copy (&message->header, 0,
1393 &retval->header, 0))
1396 if (!_dbus_string_copy (&message->body, 0,
1400 if (!_dbus_string_copy (&message->signature, 0,
1401 &retval->signature, 0))
1404 for (i = 0; i <= DBUS_HEADER_FIELD_LAST; i++)
1406 retval->header_fields[i] = message->header_fields[i];
1412 _dbus_string_free (&retval->header);
1413 _dbus_string_free (&retval->body);
1414 _dbus_string_free (&retval->signature);
1422 * Increments the reference count of a DBusMessage.
1424 * @param message The message
1425 * @see dbus_message_unref
1428 dbus_message_ref (DBusMessage *message)
1430 dbus_int32_t old_refcount;
1432 _dbus_return_if_fail (message != NULL);
1434 old_refcount = _dbus_atomic_inc (&message->refcount);
1435 _dbus_assert (old_refcount >= 1);
1439 free_size_counter (void *element,
1442 DBusCounter *counter = element;
1443 DBusMessage *message = data;
1445 _dbus_counter_adjust (counter, - message->size_counter_delta);
1447 _dbus_counter_unref (counter);
1451 * Decrements the reference count of a DBusMessage.
1453 * @param message The message
1454 * @see dbus_message_ref
1457 dbus_message_unref (DBusMessage *message)
1459 dbus_int32_t old_refcount;
1461 _dbus_return_if_fail (message != NULL);
1463 old_refcount = _dbus_atomic_dec (&message->refcount);
1465 _dbus_assert (old_refcount >= 0);
1467 if (old_refcount == 1)
1469 /* This calls application callbacks! */
1470 _dbus_data_slot_list_free (&message->slot_list);
1472 _dbus_list_foreach (&message->size_counters,
1473 free_size_counter, message);
1474 _dbus_list_clear (&message->size_counters);
1476 _dbus_string_free (&message->header);
1477 _dbus_string_free (&message->body);
1478 _dbus_string_free (&message->signature);
1480 dbus_free (message);
1485 * Gets the type of a message. Types include
1486 * DBUS_MESSAGE_TYPE_METHOD_CALL, DBUS_MESSAGE_TYPE_METHOD_RETURN,
1487 * DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_SIGNAL, but other types
1488 * are allowed and all code must silently ignore messages of unknown
1489 * type. DBUS_MESSAGE_TYPE_INVALID will never be returned, however.
1492 * @param message the message
1493 * @returns the type of the message
1496 dbus_message_get_type (DBusMessage *message)
1500 type = _dbus_string_get_byte (&message->header, 1);
1501 _dbus_assert (type != DBUS_MESSAGE_TYPE_INVALID);
1507 * Sets the object path this message is being sent to (for
1508 * DBUS_MESSAGE_TYPE_METHOD_CALL) or the one a signal is being
1509 * emitted from (for DBUS_MESSAGE_TYPE_SIGNAL).
1511 * @param message the message
1512 * @param object_path the path
1513 * @returns #FALSE if not enough memory
1516 dbus_message_set_path (DBusMessage *message,
1517 const char *object_path)
1519 _dbus_return_val_if_fail (message != NULL, FALSE);
1520 _dbus_return_val_if_fail (!message->locked, FALSE);
1522 if (object_path == NULL)
1524 delete_field (message, DBUS_HEADER_FIELD_PATH);
1529 return set_string_field (message,
1530 DBUS_HEADER_FIELD_PATH,
1531 DBUS_TYPE_OBJECT_PATH,
1537 * Gets the object path this message is being sent to
1538 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1539 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1541 * @param message the message
1542 * @returns the path (should not be freed)
1545 dbus_message_get_path (DBusMessage *message)
1547 _dbus_return_val_if_fail (message != NULL, NULL);
1549 return get_string_field (message, DBUS_HEADER_FIELD_PATH, NULL);
1553 * Gets the object path this message is being sent to
1554 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1555 * from (for DBUS_MESSAGE_TYPE_SIGNAL) in a decomposed
1556 * format (one array element per path component).
1557 * Free the returned array with dbus_free_string_array().
1559 * An empty but non-NULL path array means the path "/".
1560 * So the path "/foo/bar" becomes { "foo", "bar", NULL }
1561 * and the path "/" becomes { NULL }.
1563 * @param message the message
1564 * @param path place to store allocated array of path components; #NULL set here if no path field exists
1565 * @returns #FALSE if no memory to allocate the array
1568 dbus_message_get_path_decomposed (DBusMessage *message,
1571 _dbus_return_val_if_fail (message != NULL, FALSE);
1572 _dbus_return_val_if_fail (path != NULL, FALSE);
1574 return get_path_field_decomposed (message,
1575 DBUS_HEADER_FIELD_PATH,
1580 * Sets the interface this message is being sent to
1581 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or
1582 * the interface a signal is being emitted from
1583 * (for DBUS_MESSAGE_TYPE_SIGNAL).
1585 * @param message the message
1586 * @param interface the interface
1587 * @returns #FALSE if not enough memory
1590 dbus_message_set_interface (DBusMessage *message,
1591 const char *interface)
1593 _dbus_return_val_if_fail (message != NULL, FALSE);
1594 _dbus_return_val_if_fail (!message->locked, FALSE);
1596 if (interface == NULL)
1598 delete_field (message, DBUS_HEADER_FIELD_INTERFACE);
1603 return set_string_field (message,
1604 DBUS_HEADER_FIELD_INTERFACE,
1611 * Gets the interface this message is being sent to
1612 * (for DBUS_MESSAGE_TYPE_METHOD_CALL) or being emitted
1613 * from (for DBUS_MESSAGE_TYPE_SIGNAL).
1614 * The interface name is fully-qualified (namespaced).
1616 * @param message the message
1617 * @returns the message interface (should not be freed)
1620 dbus_message_get_interface (DBusMessage *message)
1622 _dbus_return_val_if_fail (message != NULL, NULL);
1624 return get_string_field (message, DBUS_HEADER_FIELD_INTERFACE, NULL);
1628 * Sets the interface member being invoked
1629 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1630 * (DBUS_MESSAGE_TYPE_SIGNAL).
1631 * The interface name is fully-qualified (namespaced).
1633 * @param message the message
1634 * @param member the member
1635 * @returns #FALSE if not enough memory
1638 dbus_message_set_member (DBusMessage *message,
1641 _dbus_return_val_if_fail (message != NULL, FALSE);
1642 _dbus_return_val_if_fail (!message->locked, FALSE);
1646 delete_field (message, DBUS_HEADER_FIELD_MEMBER);
1651 return set_string_field (message,
1652 DBUS_HEADER_FIELD_MEMBER,
1659 * Gets the interface member being invoked
1660 * (DBUS_MESSAGE_TYPE_METHOD_CALL) or emitted
1661 * (DBUS_MESSAGE_TYPE_SIGNAL).
1663 * @param message the message
1664 * @returns the member name (should not be freed)
1667 dbus_message_get_member (DBusMessage *message)
1669 _dbus_return_val_if_fail (message != NULL, NULL);
1671 return get_string_field (message,
1672 DBUS_HEADER_FIELD_MEMBER,
1677 * Sets the name of the error (DBUS_MESSAGE_TYPE_ERROR).
1678 * The name is fully-qualified (namespaced).
1680 * @param message the message
1681 * @param error_name the name
1682 * @returns #FALSE if not enough memory
1685 dbus_message_set_error_name (DBusMessage *message,
1686 const char *error_name)
1688 _dbus_return_val_if_fail (message != NULL, FALSE);
1689 _dbus_return_val_if_fail (!message->locked, FALSE);
1691 if (error_name == NULL)
1693 delete_field (message, DBUS_HEADER_FIELD_ERROR_NAME);
1698 return set_string_field (message,
1699 DBUS_HEADER_FIELD_ERROR_NAME,
1706 * Gets the error name (DBUS_MESSAGE_TYPE_ERROR only).
1708 * @param message the message
1709 * @returns the error name (should not be freed)
1712 dbus_message_get_error_name (DBusMessage *message)
1714 _dbus_return_val_if_fail (message != NULL, NULL);
1716 return get_string_field (message,
1717 DBUS_HEADER_FIELD_ERROR_NAME,
1722 * Sets the message's destination service.
1724 * @param message the message
1725 * @param destination the destination service name
1726 * @returns #FALSE if not enough memory
1729 dbus_message_set_destination (DBusMessage *message,
1730 const char *destination)
1732 _dbus_return_val_if_fail (message != NULL, FALSE);
1733 _dbus_return_val_if_fail (!message->locked, FALSE);
1735 if (destination == NULL)
1737 delete_field (message, DBUS_HEADER_FIELD_SERVICE);
1742 return set_string_field (message,
1743 DBUS_HEADER_FIELD_SERVICE,
1750 * Gets the destination service of a message.
1752 * @param message the message
1753 * @returns the message destination service (should not be freed)
1756 dbus_message_get_destination (DBusMessage *message)
1758 _dbus_return_val_if_fail (message != NULL, NULL);
1760 return get_string_field (message,
1761 DBUS_HEADER_FIELD_SERVICE,
1766 * Appends fields to a message given a variable argument list. The
1767 * variable argument list should contain the type of the argument
1768 * followed by the value to add. Array values are specified by an int
1769 * typecode followed by a pointer to the array followed by an int
1770 * giving the length of the array. The argument list must be
1771 * terminated with #DBUS_TYPE_INVALID.
1773 * This function doesn't support dicts or non-fundamental arrays.
1775 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
1776 * only if #DBUS_HAVE_INT64 is defined.
1778 * @param message the message
1779 * @param first_arg_type type of the first argument
1780 * @param ... value of first argument, list of additional type-value pairs
1781 * @returns #TRUE on success
1784 dbus_message_append_args (DBusMessage *message,
1791 _dbus_return_val_if_fail (message != NULL, FALSE);
1793 va_start (var_args, first_arg_type);
1794 retval = dbus_message_append_args_valist (message,
1803 * This function takes a va_list for use by language bindings.
1804 * It's otherwise the same as dbus_message_append_args().
1806 * @todo: Shouldn't this function clean up the changes to the message
1807 * on failures? (Yes)
1809 * @see dbus_message_append_args.
1810 * @param message the message
1811 * @param first_arg_type type of first argument
1812 * @param var_args value of first argument, then list of type/value pairs
1813 * @returns #TRUE on success
1816 dbus_message_append_args_valist (DBusMessage *message,
1821 DBusMessageIter iter;
1823 _dbus_return_val_if_fail (message != NULL, FALSE);
1825 old_len = _dbus_string_get_length (&message->body);
1827 type = first_arg_type;
1829 dbus_message_append_iter_init (message, &iter);
1836 if (!dbus_message_iter_append_nil (&iter))
1839 case DBUS_TYPE_BOOLEAN:
1840 if (!dbus_message_iter_append_boolean (&iter, va_arg (var_args, dbus_bool_t)))
1843 case DBUS_TYPE_INT32:
1844 if (!dbus_message_iter_append_int32 (&iter, va_arg (var_args, dbus_int32_t)))
1847 case DBUS_TYPE_UINT32:
1848 if (!dbus_message_iter_append_uint32 (&iter, va_arg (var_args, dbus_uint32_t)))
1851 #ifdef DBUS_HAVE_INT64
1852 case DBUS_TYPE_INT64:
1853 if (!dbus_message_iter_append_int64 (&iter, va_arg (var_args, dbus_int64_t)))
1856 case DBUS_TYPE_UINT64:
1857 if (!dbus_message_iter_append_uint64 (&iter, va_arg (var_args, dbus_uint64_t)))
1860 #endif /* DBUS_HAVE_INT64 */
1861 case DBUS_TYPE_DOUBLE:
1862 if (!dbus_message_iter_append_double (&iter, va_arg (var_args, double)))
1865 case DBUS_TYPE_STRING:
1866 if (!dbus_message_iter_append_string (&iter, va_arg (var_args, const char *)))
1869 case DBUS_TYPE_NAMED:
1872 unsigned char *data;
1875 name = va_arg (var_args, const char *);
1876 data = va_arg (var_args, unsigned char *);
1877 len = va_arg (var_args, int);
1879 if (!dbus_message_iter_append_named (&iter, name, data, len))
1883 case DBUS_TYPE_ARRAY:
1888 type = va_arg (var_args, int);
1889 data = va_arg (var_args, void *);
1890 len = va_arg (var_args, int);
1894 case DBUS_TYPE_BYTE:
1895 if (!dbus_message_iter_append_byte_array (&iter, (unsigned char *)data, len))
1898 case DBUS_TYPE_BOOLEAN:
1899 if (!dbus_message_iter_append_boolean_array (&iter, (unsigned char *)data, len))
1902 case DBUS_TYPE_INT32:
1903 if (!dbus_message_iter_append_int32_array (&iter, (dbus_int32_t *)data, len))
1906 case DBUS_TYPE_UINT32:
1907 if (!dbus_message_iter_append_uint32_array (&iter, (dbus_uint32_t *)data, len))
1910 #ifdef DBUS_HAVE_INT64
1911 case DBUS_TYPE_INT64:
1912 if (!dbus_message_iter_append_int64_array (&iter, (dbus_int64_t *)data, len))
1915 case DBUS_TYPE_UINT64:
1916 if (!dbus_message_iter_append_uint64_array (&iter, (dbus_uint64_t *)data, len))
1919 #endif /* DBUS_HAVE_INT64 */
1920 case DBUS_TYPE_DOUBLE:
1921 if (!dbus_message_iter_append_double_array (&iter, (double *)data, len))
1924 case DBUS_TYPE_STRING:
1925 if (!dbus_message_iter_append_string_array (&iter, (const char **)data, len))
1929 case DBUS_TYPE_ARRAY:
1930 case DBUS_TYPE_NAMED:
1931 case DBUS_TYPE_DICT:
1932 _dbus_warn ("dbus_message_append_args_valist doesn't support recursive arrays\n");
1935 _dbus_warn ("Unknown field type %d\n", type);
1941 case DBUS_TYPE_DICT:
1942 _dbus_warn ("dbus_message_append_args_valist doesn't support dicts\n");
1945 _dbus_warn ("Unknown field type %d\n", type);
1949 type = va_arg (var_args, int);
1960 * Gets arguments from a message given a variable argument list.
1961 * The variable argument list should contain the type of the
1962 * argumen followed by a pointer to where the value should be
1963 * stored. The list is terminated with #DBUS_TYPE_INVALID.
1965 * @param message the message
1966 * @param error error to be filled in on failure
1967 * @param first_arg_type the first argument type
1968 * @param ... location for first argument value, then list of type-location pairs
1969 * @returns #FALSE if the error was set
1972 dbus_message_get_args (DBusMessage *message,
1980 _dbus_return_val_if_fail (message != NULL, FALSE);
1981 _dbus_return_val_if_error_is_set (error, FALSE);
1983 va_start (var_args, first_arg_type);
1984 retval = dbus_message_get_args_valist (message, error, first_arg_type, var_args);
1991 * This function takes a va_list for use by language bindings
1993 * @todo We need to free the argument data when an error occurs.
1995 * @see dbus_message_get_args
1996 * @param message the message
1997 * @param error error to be filled in
1998 * @param first_arg_type type of the first argument
1999 * @param var_args return location for first argument, followed by list of type/location pairs
2000 * @returns #FALSE if error was set
2003 dbus_message_get_args_valist (DBusMessage *message,
2008 DBusMessageIter iter;
2010 _dbus_return_val_if_fail (message != NULL, FALSE);
2011 _dbus_return_val_if_error_is_set (error, FALSE);
2013 dbus_message_iter_init (message, &iter);
2014 return dbus_message_iter_get_args_valist (&iter, error, first_arg_type, var_args);
2018 * Gets arguments from a message iterator given a variable argument list.
2019 * The variable argument list should contain the type of the
2020 * argumen followed by a pointer to where the value should be
2021 * stored. The list is terminated with 0.
2023 * @param iter the message iterator
2024 * @param error error to be filled in on failure
2025 * @param first_arg_type the first argument type
2026 * @param ... location for first argument value, then list of type-location pairs
2027 * @returns #FALSE if the error was set
2030 dbus_message_iter_get_args (DBusMessageIter *iter,
2038 _dbus_return_val_if_fail (iter != NULL, FALSE);
2039 _dbus_return_val_if_error_is_set (error, FALSE);
2041 va_start (var_args, first_arg_type);
2042 retval = dbus_message_iter_get_args_valist (iter, error, first_arg_type, var_args);
2049 * This function takes a va_list for use by language bindings
2051 * This function supports #DBUS_TYPE_INT64 and #DBUS_TYPE_UINT64
2052 * only if #DBUS_HAVE_INT64 is defined.
2054 * @todo this function (or some lower-level non-convenience function)
2055 * needs better error handling; should allow the application to
2056 * distinguish between out of memory, and bad data from the remote
2057 * app. It also needs to not leak a bunch of args when it gets
2058 * to the arg that's bad, as that would be a security hole
2059 * (allow one app to force another to leak memory)
2061 * @todo We need to free the argument data when an error occurs.
2063 * @see dbus_message_get_args
2064 * @param iter the message iter
2065 * @param error error to be filled in
2066 * @param first_arg_type type of the first argument
2067 * @param var_args return location for first argument, followed by list of type/location pairs
2068 * @returns #FALSE if error was set
2071 dbus_message_iter_get_args_valist (DBusMessageIter *iter,
2076 int spec_type, msg_type, i;
2079 _dbus_return_val_if_fail (iter != NULL, FALSE);
2080 _dbus_return_val_if_error_is_set (error, FALSE);
2084 spec_type = first_arg_type;
2087 while (spec_type != 0)
2089 msg_type = dbus_message_iter_get_arg_type (iter);
2091 if (msg_type != spec_type)
2093 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2094 "Argument %d is specified to be of type \"%s\", but "
2095 "is actually of type \"%s\"\n", i,
2096 _dbus_type_to_string (spec_type),
2097 _dbus_type_to_string (msg_type));
2106 case DBUS_TYPE_BYTE:
2110 ptr = va_arg (var_args, unsigned char *);
2112 *ptr = dbus_message_iter_get_byte (iter);
2115 case DBUS_TYPE_BOOLEAN:
2119 ptr = va_arg (var_args, dbus_bool_t *);
2121 *ptr = dbus_message_iter_get_boolean (iter);
2124 case DBUS_TYPE_INT32:
2128 ptr = va_arg (var_args, dbus_int32_t *);
2130 *ptr = dbus_message_iter_get_int32 (iter);
2133 case DBUS_TYPE_UINT32:
2137 ptr = va_arg (var_args, dbus_uint32_t *);
2139 *ptr = dbus_message_iter_get_uint32 (iter);
2142 #ifdef DBUS_HAVE_INT64
2143 case DBUS_TYPE_INT64:
2147 ptr = va_arg (var_args, dbus_int64_t *);
2149 *ptr = dbus_message_iter_get_int64 (iter);
2152 case DBUS_TYPE_UINT64:
2156 ptr = va_arg (var_args, dbus_uint64_t *);
2158 *ptr = dbus_message_iter_get_uint64 (iter);
2161 #endif /* DBUS_HAVE_INT64 */
2163 case DBUS_TYPE_DOUBLE:
2167 ptr = va_arg (var_args, double *);
2169 *ptr = dbus_message_iter_get_double (iter);
2173 case DBUS_TYPE_STRING:
2177 ptr = va_arg (var_args, char **);
2179 *ptr = dbus_message_iter_get_string (iter);
2183 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2190 case DBUS_TYPE_NAMED:
2193 unsigned char **data;
2196 name = va_arg (var_args, char **);
2197 data = va_arg (var_args, unsigned char **);
2198 len = va_arg (var_args, int *);
2200 if (!dbus_message_iter_get_named (iter, name, data, len))
2202 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2207 case DBUS_TYPE_ARRAY:
2212 type = va_arg (var_args, int);
2213 data = va_arg (var_args, void *);
2214 len = va_arg (var_args, int *);
2216 _dbus_return_val_if_fail (data != NULL, FALSE);
2217 _dbus_return_val_if_fail (len != NULL, FALSE);
2219 if (dbus_message_iter_get_array_type (iter) != type)
2221 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2222 "Argument %d is specified to be of type \"array of %s\", but "
2223 "is actually of type \"array of %s\"\n", i,
2224 _dbus_type_to_string (type),
2225 _dbus_type_to_string (dbus_message_iter_get_array_type (iter)));
2231 case DBUS_TYPE_BYTE:
2232 if (!dbus_message_iter_get_byte_array (iter, (unsigned char **)data, len))
2234 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2238 case DBUS_TYPE_BOOLEAN:
2239 if (!dbus_message_iter_get_boolean_array (iter, (unsigned char **)data, len))
2241 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2245 case DBUS_TYPE_INT32:
2246 if (!dbus_message_iter_get_int32_array (iter, (dbus_int32_t **)data, len))
2248 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2252 case DBUS_TYPE_UINT32:
2253 if (!dbus_message_iter_get_uint32_array (iter, (dbus_uint32_t **)data, len))
2255 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2259 #ifdef DBUS_HAVE_INT64
2260 case DBUS_TYPE_INT64:
2261 if (!dbus_message_iter_get_int64_array (iter, (dbus_int64_t **)data, len))
2263 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2267 case DBUS_TYPE_UINT64:
2268 if (!dbus_message_iter_get_uint64_array (iter, (dbus_uint64_t **)data, len))
2270 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2274 #endif /* DBUS_HAVE_INT64 */
2275 case DBUS_TYPE_DOUBLE:
2276 if (!dbus_message_iter_get_double_array (iter, (double **)data, len))
2278 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2282 case DBUS_TYPE_STRING:
2283 if (!dbus_message_iter_get_string_array (iter, (char ***)data, len))
2285 dbus_set_error (error, DBUS_ERROR_NO_MEMORY, NULL);
2290 case DBUS_TYPE_ARRAY:
2291 case DBUS_TYPE_NAMED:
2292 case DBUS_TYPE_DICT:
2293 _dbus_warn ("dbus_message_get_args_valist doesn't support recursive arrays\n");
2294 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2297 _dbus_warn ("Unknown field type %d\n", type);
2298 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2303 case DBUS_TYPE_DICT:
2304 _dbus_warn ("dbus_message_get_args_valist doesn't support dicts\n");
2305 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2308 dbus_set_error (error, DBUS_ERROR_NOT_SUPPORTED, NULL);
2309 _dbus_warn ("Unknown field type %d\n", spec_type);
2313 spec_type = va_arg (var_args, int);
2314 if (spec_type != 0 && !dbus_message_iter_next (iter))
2316 dbus_set_error (error, DBUS_ERROR_INVALID_ARGS,
2317 "Message has only %d arguments, but more were expected", i);
2333 * Initializes a DBusMessageIter representing the arguments of the
2334 * message passed in.
2336 * @param message the message
2337 * @param iter pointer to an iterator to initialize
2340 dbus_message_iter_init (DBusMessage *message,
2341 DBusMessageIter *iter)
2343 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2345 _dbus_return_if_fail (message != NULL);
2346 _dbus_return_if_fail (iter != NULL);
2348 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
2350 real->message = message;
2351 real->parent_iter = NULL;
2352 real->changed_stamp = message->changed_stamp;
2354 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
2356 real->end = _dbus_string_get_length (&message->body);
2358 real->container_start = 0;
2359 real->container_length_pos = 0;
2360 real->wrote_dict_key = 0;
2361 real->array_type_pos = 0;
2364 #ifndef DBUS_DISABLE_CHECKS
2366 dbus_message_iter_check (DBusMessageRealIter *iter)
2370 _dbus_warn ("dbus iterator check failed: iterator is NULL\n");
2374 if (iter->changed_stamp != iter->message->changed_stamp)
2376 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message\n");
2380 if (iter->pos < 0 || iter->pos > iter->end)
2382 _dbus_warn ("dbus iterator check failed: invalid position\n");
2388 #endif /* DBUS_DISABLE_CHECKS */
2391 skip_array_type (DBusMessageRealIter *iter, int pos)
2397 data = _dbus_string_get_const_data_len (&iter->message->body,
2400 while (*data == DBUS_TYPE_ARRAY);
2405 /* FIXME what are these _dbus_type_is_valid() checks for?
2406 * haven't we validated the message?
2409 dbus_message_iter_get_data_start (DBusMessageRealIter *iter, int *type)
2416 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2417 data = _dbus_string_get_const_data_len (&iter->message->body,
2419 if (_dbus_type_is_valid (*data))
2422 *type = DBUS_TYPE_INVALID;
2424 return skip_array_type (iter, iter->pos);
2426 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2427 data = _dbus_string_get_const_data_len (&iter->message->body,
2428 iter->array_type_pos, 1);
2429 if (_dbus_type_is_valid (*data))
2432 *type = DBUS_TYPE_INVALID;
2436 case DBUS_MESSAGE_ITER_TYPE_DICT:
2437 /* Get the length of the string */
2438 len = _dbus_demarshal_uint32 (&iter->message->body,
2439 iter->message->byte_order,
2441 pos = pos + len + 1;
2443 data = _dbus_string_get_const_data_len (&iter->message->body,
2445 if (_dbus_type_is_valid (*data))
2448 *type = DBUS_TYPE_INVALID;
2450 return skip_array_type (iter, pos);
2453 _dbus_assert_not_reached ("Invalid iter type");
2456 *type = DBUS_TYPE_INVALID;
2462 * Checks if an iterator has any more fields.
2464 * @param iter the message iter
2465 * @returns #TRUE if there are more fields
2469 dbus_message_iter_has_next (DBusMessageIter *iter)
2471 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2475 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2477 if (real->pos >= real->end)
2480 pos = dbus_message_iter_get_data_start (real, &type);
2482 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2483 real->message->byte_order,
2484 type, pos, &end_pos))
2487 if (end_pos >= real->end)
2494 * Moves the iterator to the next field.
2496 * @param iter The message iter
2497 * @returns #TRUE if the iterator was moved to the next field
2500 dbus_message_iter_next (DBusMessageIter *iter)
2502 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2506 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2508 pos = dbus_message_iter_get_data_start (real, &type);
2510 if (!_dbus_marshal_get_arg_end_pos (&real->message->body,
2511 real->message->byte_order,
2512 type, pos, &end_pos))
2515 if (end_pos >= real->end)
2518 real->pos = end_pos;
2524 * Returns the argument type of the argument that the
2525 * message iterator points at.
2527 * @param iter the message iter
2528 * @returns the field type
2531 dbus_message_iter_get_arg_type (DBusMessageIter *iter)
2533 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2536 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2538 if (real->pos >= real->end)
2539 return DBUS_TYPE_INVALID;
2541 pos = dbus_message_iter_get_data_start (real, &type);
2546 /* FIXME why do we validate the typecode in here, hasn't the message
2547 * already been verified?
2550 iter_get_array_type (DBusMessageRealIter *iter, int *array_type_pos)
2553 int _array_type_pos;
2558 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
2559 _array_type_pos = iter->pos + 1;
2561 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
2562 _array_type_pos = iter->array_type_pos + 1;
2564 case DBUS_MESSAGE_ITER_TYPE_DICT:
2565 /* Get the length of the string */
2566 len = _dbus_demarshal_uint32 (&iter->message->body,
2567 iter->message->byte_order,
2569 pos = pos + len + 1;
2570 data = _dbus_string_get_const_data_len (&iter->message->body,
2572 _array_type_pos = pos + 1;
2575 _dbus_assert_not_reached ("wrong iter type");
2576 return DBUS_TYPE_INVALID;
2579 if (array_type_pos != NULL)
2580 *array_type_pos = _array_type_pos;
2582 data = _dbus_string_get_const_data_len (&iter->message->body,
2583 _array_type_pos, 1);
2584 if (_dbus_type_is_valid (*data))
2587 return DBUS_TYPE_INVALID;
2592 * Returns the element type of the array that the
2593 * message iterator points at. Note that you need
2594 * to check that the iterator points to an array
2595 * prior to using this function.
2597 * @param iter the message iter
2598 * @returns the field type
2601 dbus_message_iter_get_array_type (DBusMessageIter *iter)
2603 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2606 _dbus_return_val_if_fail (dbus_message_iter_check (real), DBUS_TYPE_INVALID);
2608 if (real->pos >= real->end)
2609 return DBUS_TYPE_INVALID;
2611 pos = dbus_message_iter_get_data_start (real, &type);
2613 _dbus_assert (type == DBUS_TYPE_ARRAY);
2615 return iter_get_array_type (real, NULL);
2620 * Returns the string value that an iterator may point to.
2621 * Note that you need to check that the iterator points to
2622 * a string value before using this function.
2624 * @see dbus_message_iter_get_arg_type
2625 * @param iter the message iter
2626 * @returns the string
2629 dbus_message_iter_get_string (DBusMessageIter *iter)
2631 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2634 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
2636 pos = dbus_message_iter_get_data_start (real, &type);
2638 _dbus_assert (type == DBUS_TYPE_STRING);
2640 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2645 * Returns the name and data from a named type that an
2646 * iterator may point to. Note that you need to check that
2647 * the iterator points to a named type before using this
2650 * @see dbus_message_iter_get_arg_type
2651 * @param iter the message iter
2652 * @param name return location for the name
2653 * @param value return location for data
2654 * @param len return location for length of data
2655 * @returns TRUE if get succeed
2659 dbus_message_iter_get_named (DBusMessageIter *iter,
2661 unsigned char **value,
2664 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2668 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2670 pos = dbus_message_iter_get_data_start (real, &type);
2672 _dbus_assert (type == DBUS_TYPE_NAMED);
2674 _name = _dbus_demarshal_string (&real->message->body, real->message->byte_order,
2680 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
2681 pos, NULL, value, len))
2693 * Returns the byte value that an iterator may point to.
2694 * Note that you need to check that the iterator points to
2695 * a byte value before using this function.
2697 * @see dbus_message_iter_get_arg_type
2698 * @param iter the message iter
2699 * @returns the byte value
2702 dbus_message_iter_get_byte (DBusMessageIter *iter)
2704 unsigned char value;
2705 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2708 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2710 pos = dbus_message_iter_get_data_start (real, &type);
2712 _dbus_assert (type == DBUS_TYPE_BYTE);
2714 value = _dbus_string_get_byte (&real->message->body, pos);
2721 * Returns the boolean value that an iterator may point to.
2722 * Note that you need to check that the iterator points to
2723 * a boolean value before using this function.
2725 * @see dbus_message_iter_get_arg_type
2726 * @param iter the message iter
2727 * @returns the boolean value
2730 dbus_message_iter_get_boolean (DBusMessageIter *iter)
2732 unsigned char value;
2733 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2736 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2738 pos = dbus_message_iter_get_data_start (real, &type);
2740 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
2742 value = _dbus_string_get_byte (&real->message->body, pos);
2748 * Returns the 32 bit signed integer value that an iterator may point to.
2749 * Note that you need to check that the iterator points to
2750 * a 32-bit integer value before using this function.
2752 * @see dbus_message_iter_get_arg_type
2753 * @param iter the message iter
2754 * @returns the integer
2757 dbus_message_iter_get_int32 (DBusMessageIter *iter)
2759 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2762 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2764 pos = dbus_message_iter_get_data_start (real, &type);
2766 _dbus_assert (type == DBUS_TYPE_INT32);
2768 return _dbus_demarshal_int32 (&real->message->body, real->message->byte_order,
2773 * Returns the 32 bit unsigned integer value that an iterator may point to.
2774 * Note that you need to check that the iterator points to
2775 * a 32-bit unsigned integer value before using this function.
2777 * @see dbus_message_iter_get_arg_type
2778 * @param iter the message iter
2779 * @returns the integer
2782 dbus_message_iter_get_uint32 (DBusMessageIter *iter)
2784 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2787 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2789 pos = dbus_message_iter_get_data_start (real, &type);
2791 _dbus_assert (type == DBUS_TYPE_UINT32);
2793 return _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2797 #ifdef DBUS_HAVE_INT64
2800 * Returns the 64 bit signed integer value that an iterator may point
2801 * to. Note that you need to check that the iterator points to a
2802 * 64-bit integer value before using this function.
2804 * This function only exists if #DBUS_HAVE_INT64 is defined.
2806 * @see dbus_message_iter_get_arg_type
2807 * @param iter the message iter
2808 * @returns the integer
2811 dbus_message_iter_get_int64 (DBusMessageIter *iter)
2813 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2816 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2818 pos = dbus_message_iter_get_data_start (real, &type);
2820 _dbus_assert (type == DBUS_TYPE_INT64);
2822 return _dbus_demarshal_int64 (&real->message->body, real->message->byte_order,
2827 * Returns the 64 bit unsigned integer value that an iterator may point to.
2828 * Note that you need to check that the iterator points to
2829 * a 64-bit unsigned integer value before using this function.
2831 * This function only exists if #DBUS_HAVE_INT64 is defined.
2833 * @see dbus_message_iter_get_arg_type
2834 * @param iter the message iter
2835 * @returns the integer
2838 dbus_message_iter_get_uint64 (DBusMessageIter *iter)
2840 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2843 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0);
2845 pos = dbus_message_iter_get_data_start (real, &type);
2847 _dbus_assert (type == DBUS_TYPE_UINT64);
2849 return _dbus_demarshal_uint64 (&real->message->body, real->message->byte_order,
2853 #endif /* DBUS_HAVE_INT64 */
2856 * Returns the double value that an iterator may point to.
2857 * Note that you need to check that the iterator points to
2858 * a string value before using this function.
2860 * @see dbus_message_iter_get_arg_type
2861 * @param iter the message iter
2862 * @returns the double
2865 dbus_message_iter_get_double (DBusMessageIter *iter)
2867 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2870 _dbus_return_val_if_fail (dbus_message_iter_check (real), 0.0);
2872 pos = dbus_message_iter_get_data_start (real, &type);
2874 _dbus_assert (type == DBUS_TYPE_DOUBLE);
2876 return _dbus_demarshal_double (&real->message->body, real->message->byte_order,
2881 * Initializes an iterator for the array that the iterator
2882 * may point to. Note that you need to check that the iterator
2883 * points to an array prior to using this function.
2885 * The array element type is returned in array_type, and the array
2886 * iterator can only be used to get that type of data.
2888 * @param iter the iterator
2889 * @param array_iter pointer to an iterator to initialize
2890 * @param array_type gets set to the type of the array elements
2893 dbus_message_iter_init_array_iterator (DBusMessageIter *iter,
2894 DBusMessageIter *array_iter,
2897 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2898 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
2899 int type, pos, len_pos, len, array_type_pos;
2902 _dbus_return_if_fail (dbus_message_iter_check (real));
2904 pos = dbus_message_iter_get_data_start (real, &type);
2906 _dbus_assert (type == DBUS_TYPE_ARRAY);
2908 _array_type = iter_get_array_type (real, &array_type_pos);
2910 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2911 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2914 array_real->parent_iter = real;
2915 array_real->message = real->message;
2916 array_real->changed_stamp = real->message->changed_stamp;
2918 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
2919 array_real->pos = pos;
2920 array_real->end = pos + len;
2922 array_real->container_start = pos;
2923 array_real->container_length_pos = len_pos;
2924 array_real->wrote_dict_key = 0;
2925 array_real->array_type_pos = array_type_pos;
2926 array_real->array_type_done = TRUE;
2928 if (array_type != NULL)
2929 *array_type = _array_type;
2934 * Initializes an iterator for the dict that the iterator
2935 * may point to. Note that you need to check that the iterator
2936 * points to a dict prior to using this function.
2938 * @param iter the iterator
2939 * @param dict_iter pointer to an iterator to initialize
2942 dbus_message_iter_init_dict_iterator (DBusMessageIter *iter,
2943 DBusMessageIter *dict_iter)
2945 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2946 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
2947 int type, pos, len_pos, len;
2949 _dbus_return_if_fail (dbus_message_iter_check (real));
2951 pos = dbus_message_iter_get_data_start (real, &type);
2953 _dbus_assert (type == DBUS_TYPE_DICT);
2955 len_pos = _DBUS_ALIGN_VALUE (pos, sizeof (dbus_uint32_t));
2956 len = _dbus_demarshal_uint32 (&real->message->body, real->message->byte_order,
2959 dict_real->parent_iter = real;
2960 dict_real->message = real->message;
2961 dict_real->changed_stamp = real->message->changed_stamp;
2963 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
2964 dict_real->pos = pos;
2965 dict_real->end = pos + len;
2967 dict_real->container_start = pos;
2968 dict_real->container_length_pos = len_pos;
2969 dict_real->wrote_dict_key = 0;
2973 * Returns the byte array that the iterator may point to.
2974 * Note that you need to check that the iterator points
2975 * to a byte array prior to using this function.
2977 * @param iter the iterator
2978 * @param value return location for array values
2979 * @param len return location for length of byte array
2980 * @returns #TRUE on success
2983 dbus_message_iter_get_byte_array (DBusMessageIter *iter,
2984 unsigned char **value,
2987 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
2990 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
2992 pos = dbus_message_iter_get_data_start (real, &type);
2994 _dbus_assert (type == DBUS_TYPE_ARRAY);
2996 type = iter_get_array_type (real, NULL);
2998 _dbus_assert (type == DBUS_TYPE_BYTE);
3000 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
3001 pos, NULL, value, len))
3008 * Returns the boolean array that the iterator may point to. Note that
3009 * you need to check that the iterator points to an array of the
3010 * correct type prior to using this function.
3012 * @param iter the iterator
3013 * @param value return location for the array
3014 * @param len return location for the array length
3015 * @returns #TRUE on success
3018 dbus_message_iter_get_boolean_array (DBusMessageIter *iter,
3019 unsigned char **value,
3022 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3025 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3027 pos = dbus_message_iter_get_data_start (real, &type);
3029 _dbus_assert (type == DBUS_TYPE_ARRAY);
3031 type = iter_get_array_type (real, NULL);
3033 _dbus_assert (type == DBUS_TYPE_BOOLEAN);
3035 if (!_dbus_demarshal_byte_array (&real->message->body, real->message->byte_order,
3036 pos, NULL, value, len))
3043 * Returns the 32 bit signed integer array that the iterator may point
3044 * to. Note that you need to check that the iterator points to an
3045 * array of the correct type prior to using this function.
3047 * @param iter the iterator
3048 * @param value return location for the array
3049 * @param len return location for the array length
3050 * @returns #TRUE on success
3053 dbus_message_iter_get_int32_array (DBusMessageIter *iter,
3054 dbus_int32_t **value,
3057 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3060 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3062 pos = dbus_message_iter_get_data_start (real, &type);
3064 _dbus_assert (type == DBUS_TYPE_ARRAY);
3066 type = iter_get_array_type (real, NULL);
3068 _dbus_assert (type == DBUS_TYPE_INT32);
3070 if (!_dbus_demarshal_int32_array (&real->message->body, real->message->byte_order,
3071 pos, NULL, value, len))
3078 * Returns the 32 bit unsigned integer array that the iterator may point
3079 * to. Note that you need to check that the iterator points to an
3080 * array of the correct type prior to using this function.
3082 * @param iter the iterator
3083 * @param value return location for the array
3084 * @param len return location for the array length
3085 * @returns #TRUE on success
3088 dbus_message_iter_get_uint32_array (DBusMessageIter *iter,
3089 dbus_uint32_t **value,
3092 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3095 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3097 pos = dbus_message_iter_get_data_start (real, &type);
3099 _dbus_assert (type == DBUS_TYPE_ARRAY);
3101 type = iter_get_array_type (real, NULL);
3102 _dbus_assert (type == DBUS_TYPE_UINT32);
3104 if (!_dbus_demarshal_uint32_array (&real->message->body, real->message->byte_order,
3105 pos, NULL, value, len))
3111 #ifdef DBUS_HAVE_INT64
3114 * Returns the 64 bit signed integer array that the iterator may point
3115 * to. Note that you need to check that the iterator points to an
3116 * array of the correct type prior to using this function.
3118 * This function only exists if #DBUS_HAVE_INT64 is defined.
3120 * @param iter the iterator
3121 * @param value return location for the array
3122 * @param len return location for the array length
3123 * @returns #TRUE on success
3126 dbus_message_iter_get_int64_array (DBusMessageIter *iter,
3127 dbus_int64_t **value,
3130 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3133 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3135 pos = dbus_message_iter_get_data_start (real, &type);
3137 _dbus_assert (type == DBUS_TYPE_ARRAY);
3139 type = iter_get_array_type (real, NULL);
3141 _dbus_assert (type == DBUS_TYPE_INT64);
3143 if (!_dbus_demarshal_int64_array (&real->message->body, real->message->byte_order,
3144 pos, NULL, value, len))
3151 * Returns the 64 bit unsigned integer array that the iterator may point
3152 * to. Note that you need to check that the iterator points to an
3153 * array of the correct type prior to using this function.
3155 * This function only exists if #DBUS_HAVE_INT64 is defined.
3157 * @param iter the iterator
3158 * @param value return location for the array
3159 * @param len return location for the array length
3160 * @returns #TRUE on success
3163 dbus_message_iter_get_uint64_array (DBusMessageIter *iter,
3164 dbus_uint64_t **value,
3167 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3170 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3172 pos = dbus_message_iter_get_data_start (real, &type);
3174 _dbus_assert (type == DBUS_TYPE_ARRAY);
3176 type = iter_get_array_type (real, NULL);
3177 _dbus_assert (type == DBUS_TYPE_UINT64);
3179 if (!_dbus_demarshal_uint64_array (&real->message->body, real->message->byte_order,
3180 pos, NULL, value, len))
3186 #endif /* DBUS_HAVE_INT64 */
3189 * Returns the double array that the iterator may point to. Note that
3190 * you need to check that the iterator points to an array of the
3191 * correct type prior to using this function.
3193 * @param iter the iterator
3194 * @param value return location for the array
3195 * @param len return location for the array length
3196 * @returns #TRUE on success
3199 dbus_message_iter_get_double_array (DBusMessageIter *iter,
3203 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3206 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3208 pos = dbus_message_iter_get_data_start (real, &type);
3210 _dbus_assert (type == DBUS_TYPE_ARRAY);
3212 type = iter_get_array_type (real, NULL);
3213 _dbus_assert (type == DBUS_TYPE_DOUBLE);
3215 if (!_dbus_demarshal_double_array (&real->message->body, real->message->byte_order,
3216 pos, NULL, value, len))
3223 * Returns the string array that the iterator may point to.
3224 * Note that you need to check that the iterator points
3225 * to a byte array prior to using this function.
3227 * The returned value is a #NULL-terminated array of strings.
3228 * Each string is a separate malloc block, and the array
3229 * itself is a malloc block. You can free this type of
3230 * string array with dbus_free_string_array().
3232 * @param iter the iterator
3233 * @param value return location for string values
3234 * @param len return location for length of byte array
3235 * @returns #TRUE on success
3238 dbus_message_iter_get_string_array (DBusMessageIter *iter,
3242 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3245 _dbus_return_val_if_fail (dbus_message_iter_check (real), FALSE);
3247 pos = dbus_message_iter_get_data_start (real, &type);
3249 _dbus_assert (type == DBUS_TYPE_ARRAY);
3251 type = iter_get_array_type (real, NULL);
3252 _dbus_assert (type == DBUS_TYPE_STRING);
3254 if (!_dbus_demarshal_string_array (&real->message->body, real->message->byte_order,
3255 pos, NULL, value, len))
3262 * Returns the key name fot the dict entry that an iterator
3263 * may point to. Note that you need to check that the iterator
3264 * points to a dict entry before using this function.
3266 * @see dbus_message_iter_init_dict_iterator
3267 * @param iter the message iter
3268 * @returns the key name
3271 dbus_message_iter_get_dict_key (DBusMessageIter *iter)
3273 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3275 _dbus_return_val_if_fail (dbus_message_iter_check (real), NULL);
3277 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3279 return _dbus_demarshal_string (&real->message->body, real->message->byte_order,
3284 * Initializes a DBusMessageIter pointing to the end of the
3285 * message. This iterator can be used to append data to the
3288 * @param message the message
3289 * @param iter pointer to an iterator to initialize
3292 dbus_message_append_iter_init (DBusMessage *message,
3293 DBusMessageIter *iter)
3295 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3297 _dbus_return_if_fail (message != NULL);
3298 _dbus_return_if_fail (iter != NULL);
3300 real->message = message;
3301 real->parent_iter = NULL;
3302 real->changed_stamp = message->changed_stamp;
3304 real->type = DBUS_MESSAGE_ITER_TYPE_MESSAGE;
3305 real->end = _dbus_string_get_length (&real->message->body);
3306 real->pos = real->end;
3308 real->container_length_pos = 0;
3309 real->wrote_dict_key = 0;
3312 #ifndef DBUS_DISABLE_CHECKS
3314 dbus_message_iter_append_check (DBusMessageRealIter *iter)
3318 _dbus_warn ("dbus iterator check failed: NULL iterator\n");
3322 if (iter->message->locked)
3324 _dbus_warn ("dbus iterator check failed: message is locked (has already been sent)\n");
3328 if (iter->changed_stamp != iter->message->changed_stamp)
3330 _dbus_warn ("dbus iterator check failed: invalid iterator, must re-initialize it after modifying the message");
3334 if (iter->pos != iter->end)
3336 _dbus_warn ("dbus iterator check failed: can only append at end of message");
3340 if (iter->pos != _dbus_string_get_length (&iter->message->body))
3342 _dbus_warn ("dbus iterator check failed: append pos not at end of message string");
3348 #endif /* DBUS_DISABLE_CHECKS */
3351 dbus_message_iter_append_type (DBusMessageRealIter *iter,
3357 case DBUS_MESSAGE_ITER_TYPE_MESSAGE:
3358 if (!_dbus_string_append_byte (&iter->message->signature, type))
3361 if (!_dbus_string_append_byte (&iter->message->body, type))
3363 _dbus_string_shorten (&iter->message->signature, 1);
3368 case DBUS_MESSAGE_ITER_TYPE_ARRAY:
3369 data = _dbus_string_get_const_data_len (&iter->message->body,
3370 iter->array_type_pos, 1);
3373 _dbus_warn ("Appended element of wrong type for array\n");
3378 case DBUS_MESSAGE_ITER_TYPE_DICT:
3379 if (!iter->wrote_dict_key)
3381 _dbus_warn ("Appending dict data before key name\n");
3385 if (!_dbus_string_append_byte (&iter->message->body, type))
3391 _dbus_assert_not_reached ("Invalid iter type");
3399 dbus_message_iter_update_after_change (DBusMessageRealIter *iter)
3401 iter->changed_stamp = iter->message->changed_stamp;
3403 /* Set new end of iter */
3404 iter->end = _dbus_string_get_length (&iter->message->body);
3405 iter->pos = iter->end;
3407 /* Set container length */
3408 if (iter->type == DBUS_MESSAGE_ITER_TYPE_DICT ||
3409 (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY && iter->array_type_done))
3410 _dbus_marshal_set_uint32 (&iter->message->body,
3411 iter->message->byte_order,
3412 iter->container_length_pos,
3413 iter->end - iter->container_start);
3415 if (iter->parent_iter)
3416 dbus_message_iter_update_after_change (iter->parent_iter);
3420 dbus_message_iter_append_done (DBusMessageRealIter *iter)
3422 iter->message->changed_stamp++;
3423 dbus_message_iter_update_after_change (iter);
3424 iter->wrote_dict_key = FALSE;
3428 * Appends a nil value to the message
3430 * @param iter an iterator pointing to the end of the message
3431 * @returns #TRUE on success
3434 dbus_message_iter_append_nil (DBusMessageIter *iter)
3436 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3438 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3440 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NIL))
3443 dbus_message_iter_append_done (real);
3449 * Appends a boolean value to the message
3451 * @param iter an iterator pointing to the end of the message
3452 * @param value the boolean value
3453 * @returns #TRUE on success
3456 dbus_message_iter_append_boolean (DBusMessageIter *iter,
3459 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3461 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3463 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BOOLEAN))
3466 if (!_dbus_string_append_byte (&real->message->body, (value != FALSE)))
3468 _dbus_string_set_length (&real->message->body, real->pos);
3472 dbus_message_iter_append_done (real);
3478 * Appends a byte to the message
3480 * @param iter an iterator pointing to the end of the message
3481 * @param value the byte value
3482 * @returns #TRUE on success
3485 dbus_message_iter_append_byte (DBusMessageIter *iter,
3486 unsigned char value)
3488 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3490 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3492 if (!dbus_message_iter_append_type (real, DBUS_TYPE_BYTE))
3495 if (!_dbus_string_append_byte (&real->message->body, value))
3497 _dbus_string_set_length (&real->message->body, real->pos);
3501 dbus_message_iter_append_done (real);
3508 * Appends a 32 bit signed integer to the message.
3510 * @param iter an iterator pointing to the end of the message
3511 * @param value the integer value
3512 * @returns #TRUE on success
3515 dbus_message_iter_append_int32 (DBusMessageIter *iter,
3518 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3520 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3522 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT32))
3525 if (!_dbus_marshal_int32 (&real->message->body, real->message->byte_order, value))
3527 _dbus_string_set_length (&real->message->body, real->pos);
3531 dbus_message_iter_append_done (real);
3537 * Appends a 32 bit unsigned integer to the message.
3539 * @param iter an iterator pointing to the end of the message
3540 * @param value the integer value
3541 * @returns #TRUE on success
3544 dbus_message_iter_append_uint32 (DBusMessageIter *iter,
3545 dbus_uint32_t value)
3547 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3549 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3551 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT32))
3554 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, value))
3556 _dbus_string_set_length (&real->message->body, real->pos);
3560 dbus_message_iter_append_done (real);
3565 #ifdef DBUS_HAVE_INT64
3568 * Appends a 64 bit signed integer to the message.
3570 * This function only exists if #DBUS_HAVE_INT64 is defined.
3572 * @param iter an iterator pointing to the end of the message
3573 * @param value the integer value
3574 * @returns #TRUE on success
3577 dbus_message_iter_append_int64 (DBusMessageIter *iter,
3580 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3582 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3584 if (!dbus_message_iter_append_type (real, DBUS_TYPE_INT64))
3587 if (!_dbus_marshal_int64 (&real->message->body, real->message->byte_order, value))
3589 _dbus_string_set_length (&real->message->body, real->pos);
3593 dbus_message_iter_append_done (real);
3599 * Appends a 64 bit unsigned integer to the message.
3601 * This function only exists if #DBUS_HAVE_INT64 is defined.
3603 * @param iter an iterator pointing to the end of the message
3604 * @param value the integer value
3605 * @returns #TRUE on success
3608 dbus_message_iter_append_uint64 (DBusMessageIter *iter,
3609 dbus_uint64_t value)
3611 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3613 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3615 if (!dbus_message_iter_append_type (real, DBUS_TYPE_UINT64))
3618 if (!_dbus_marshal_uint64 (&real->message->body, real->message->byte_order, value))
3620 _dbus_string_set_length (&real->message->body, real->pos);
3624 dbus_message_iter_append_done (real);
3629 #endif /* DBUS_HAVE_INT64 */
3632 * Appends a double value to the message.
3634 * @param iter an iterator pointing to the end of the message
3635 * @param value the double value
3636 * @returns #TRUE on success
3639 dbus_message_iter_append_double (DBusMessageIter *iter,
3642 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3644 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3646 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DOUBLE))
3649 if (!_dbus_marshal_double (&real->message->body, real->message->byte_order, value))
3651 _dbus_string_set_length (&real->message->body, real->pos);
3655 dbus_message_iter_append_done (real);
3661 * Appends a UTF-8 string to the message.
3663 * @param iter an iterator pointing to the end of the message
3664 * @param value the string
3665 * @returns #TRUE on success
3668 dbus_message_iter_append_string (DBusMessageIter *iter,
3671 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3673 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3675 if (!dbus_message_iter_append_type (real, DBUS_TYPE_STRING))
3678 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3680 _dbus_string_set_length (&real->message->body, real->pos);
3684 dbus_message_iter_append_done (real);
3690 * Appends a named type data chunk to the message. A named
3691 * type is simply an arbitrary UTF-8 string used as a type
3692 * tag, plus an array of arbitrary bytes to be interpreted
3693 * according to the type tag.
3695 * @param iter an iterator pointing to the end of the message
3696 * @param name the name of the type
3697 * @param data the binary data used to store the value
3698 * @param len the length of the binary data in bytes
3699 * @returns #TRUE on success
3702 dbus_message_iter_append_named (DBusMessageIter *iter,
3704 const unsigned char *data,
3707 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3709 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3711 if (!dbus_message_iter_append_type (real, DBUS_TYPE_NAMED))
3714 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, name))
3716 _dbus_string_set_length (&real->message->body, real->pos);
3720 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, data, len))
3722 _dbus_string_set_length (&real->message->body, real->pos);
3726 dbus_message_iter_append_done (real);
3733 * Appends a dict key name to the message. The iterator used
3734 * must point to a dict.
3736 * @param iter an iterator pointing to the end of the message
3737 * @param value the string
3738 * @returns #TRUE on success
3741 dbus_message_iter_append_dict_key (DBusMessageIter *iter,
3744 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3746 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3747 _dbus_assert (real->type == DBUS_MESSAGE_ITER_TYPE_DICT);
3749 if (real->wrote_dict_key)
3751 _dbus_warn ("Appendinging multiple dict key names\n");
3755 if (!_dbus_marshal_string (&real->message->body, real->message->byte_order, value))
3760 dbus_message_iter_append_done (real);
3761 real->wrote_dict_key = TRUE;
3767 array_iter_type_mark_done (DBusMessageRealIter *iter)
3771 if (iter->type == DBUS_MESSAGE_ITER_TYPE_ARRAY)
3772 array_iter_type_mark_done (iter->parent_iter);
3776 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&iter->message->body),
3777 sizeof (dbus_uint32_t));
3779 /* Empty length for now, backfill later */
3780 if (!_dbus_marshal_uint32 (&iter->message->body, iter->message->byte_order, 0))
3782 _dbus_string_set_length (&iter->message->body, iter->pos);
3786 iter->container_start = _dbus_string_get_length (&iter->message->body);
3787 iter->container_length_pos = len_pos;
3788 iter->array_type_done = TRUE;
3794 append_array_type (DBusMessageRealIter *real,
3796 dbus_bool_t *array_type_done,
3797 int *array_type_pos)
3799 int existing_element_type;
3801 if (!dbus_message_iter_append_type (real, DBUS_TYPE_ARRAY))
3804 if (real->type == DBUS_MESSAGE_ITER_TYPE_ARRAY &&
3805 real->array_type_done)
3807 existing_element_type = iter_get_array_type (real, array_type_pos);
3808 if (existing_element_type != element_type)
3810 _dbus_warn ("Appending array of %s, when expecting array of %s\n",
3811 _dbus_type_to_string (element_type),
3812 _dbus_type_to_string (existing_element_type));
3813 _dbus_string_set_length (&real->message->body, real->pos);
3816 if (array_type_done != NULL)
3817 *array_type_done = TRUE;
3821 if (array_type_pos != NULL)
3822 *array_type_pos = _dbus_string_get_length (&real->message->body);
3825 if (!_dbus_string_append_byte (&real->message->signature, element_type))
3827 _dbus_string_set_length (&real->message->body, real->pos);
3831 /* Append element type */
3832 if (!_dbus_string_append_byte (&real->message->body, element_type))
3834 _dbus_string_shorten (&real->message->signature, 1);
3835 _dbus_string_set_length (&real->message->body, real->pos);
3839 if (array_type_done != NULL)
3840 *array_type_done = element_type != DBUS_TYPE_ARRAY;
3842 if (element_type != DBUS_TYPE_ARRAY &&
3843 !array_iter_type_mark_done (real))
3845 _dbus_string_shorten (&real->message->signature, 1);
3854 * Appends an array to the message and initializes an iterator that
3855 * can be used to append to the array.
3857 * @param iter an iterator pointing to the end of the message
3858 * @param array_iter pointer to an iter that will be initialized
3859 * @param element_type the type of the array elements
3860 * @returns #TRUE on success
3863 dbus_message_iter_append_array (DBusMessageIter *iter,
3864 DBusMessageIter *array_iter,
3867 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3868 DBusMessageRealIter *array_real = (DBusMessageRealIter *)array_iter;
3871 dbus_bool_t array_type_done;
3873 if (element_type == DBUS_TYPE_NIL)
3875 _dbus_warn ("Can't create NIL arrays\n");
3879 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3881 if (!append_array_type (real, element_type, &array_type_done, &array_type_pos))
3884 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3886 if (array_type_done)
3888 /* Empty length for now, backfill later */
3889 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3891 _dbus_string_set_length (&real->message->body, real->pos);
3896 array_real->parent_iter = real;
3897 array_real->message = real->message;
3898 array_real->changed_stamp = real->message->changed_stamp;
3900 array_real->type = DBUS_MESSAGE_ITER_TYPE_ARRAY;
3901 array_real->pos = _dbus_string_get_length (&real->message->body);
3902 array_real->end = array_real->end;
3904 array_real->container_start = array_real->pos;
3905 array_real->container_length_pos = len_pos;
3906 array_real->wrote_dict_key = 0;
3907 array_real->array_type_done = array_type_done;
3908 array_real->array_type_pos = array_type_pos;
3910 dbus_message_iter_append_done (array_real);
3916 * Appends a dict to the message and initializes an iterator that
3917 * can be used to append to the dict.
3919 * @param iter an iterator pointing to the end of the message
3920 * @param dict_iter pointer to an iter that will be initialized
3921 * @returns #TRUE on success
3924 dbus_message_iter_append_dict (DBusMessageIter *iter,
3925 DBusMessageIter *dict_iter)
3927 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3928 DBusMessageRealIter *dict_real = (DBusMessageRealIter *)dict_iter;
3931 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3933 if (!dbus_message_iter_append_type (real, DBUS_TYPE_DICT))
3936 len_pos = _DBUS_ALIGN_VALUE (_dbus_string_get_length (&real->message->body), sizeof (dbus_uint32_t));
3938 /* Empty length for now, backfill later */
3939 if (!_dbus_marshal_uint32 (&real->message->body, real->message->byte_order, 0))
3941 _dbus_string_set_length (&real->message->body, real->pos);
3945 dict_real->parent_iter = real;
3946 dict_real->message = real->message;
3947 dict_real->changed_stamp = real->message->changed_stamp;
3949 dict_real->type = DBUS_MESSAGE_ITER_TYPE_DICT;
3950 dict_real->pos = _dbus_string_get_length (&real->message->body);
3951 dict_real->end = dict_real->end;
3953 dict_real->container_start = dict_real->pos;
3954 dict_real->container_length_pos = len_pos;
3955 dict_real->wrote_dict_key = 0;
3957 dbus_message_iter_append_done (dict_real);
3964 * Appends a boolean array to the message.
3966 * @param iter an iterator pointing to the end of the message
3967 * @param value the array
3968 * @param len the length of the array
3969 * @returns #TRUE on success
3972 dbus_message_iter_append_boolean_array (DBusMessageIter *iter,
3973 unsigned const char *value,
3976 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
3978 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
3980 if (!append_array_type (real, DBUS_TYPE_BOOLEAN, NULL, NULL))
3983 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
3985 _dbus_string_set_length (&real->message->body, real->pos);
3989 dbus_message_iter_append_done (real);
3995 * Appends a 32 bit signed integer array to the message.
3997 * @param iter an iterator pointing to the end of the message
3998 * @param value the array
3999 * @param len the length of the array
4000 * @returns #TRUE on success
4003 dbus_message_iter_append_int32_array (DBusMessageIter *iter,
4004 const dbus_int32_t *value,
4007 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4009 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4011 if (!append_array_type (real, DBUS_TYPE_INT32, NULL, NULL))
4014 if (!_dbus_marshal_int32_array (&real->message->body, real->message->byte_order, value, len))
4016 _dbus_string_set_length (&real->message->body, real->pos);
4020 dbus_message_iter_append_done (real);
4026 * Appends a 32 bit unsigned integer array to the message.
4028 * @param iter an iterator pointing to the end of the message
4029 * @param value the array
4030 * @param len the length of the array
4031 * @returns #TRUE on success
4034 dbus_message_iter_append_uint32_array (DBusMessageIter *iter,
4035 const dbus_uint32_t *value,
4038 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4040 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4042 if (!append_array_type (real, DBUS_TYPE_UINT32, NULL, NULL))
4045 if (!_dbus_marshal_uint32_array (&real->message->body, real->message->byte_order, value, len))
4047 _dbus_string_set_length (&real->message->body, real->pos);
4051 dbus_message_iter_append_done (real);
4056 #ifdef DBUS_HAVE_INT64
4059 * Appends a 64 bit signed integer array to the message.
4061 * This function only exists if #DBUS_HAVE_INT64 is defined.
4063 * @param iter an iterator pointing to the end of the message
4064 * @param value the array
4065 * @param len the length of the array
4066 * @returns #TRUE on success
4069 dbus_message_iter_append_int64_array (DBusMessageIter *iter,
4070 const dbus_int64_t *value,
4073 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4075 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4077 if (!append_array_type (real, DBUS_TYPE_INT64, NULL, NULL))
4080 if (!_dbus_marshal_int64_array (&real->message->body, real->message->byte_order, value, len))
4082 _dbus_string_set_length (&real->message->body, real->pos);
4086 dbus_message_iter_append_done (real);
4092 * Appends a 64 bit unsigned integer array to the message.
4094 * This function only exists if #DBUS_HAVE_INT64 is defined.
4096 * @param iter an iterator pointing to the end of the message
4097 * @param value the array
4098 * @param len the length of the array
4099 * @returns #TRUE on success
4102 dbus_message_iter_append_uint64_array (DBusMessageIter *iter,
4103 const dbus_uint64_t *value,
4106 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4108 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4110 if (!append_array_type (real, DBUS_TYPE_UINT64, NULL, NULL))
4113 if (!_dbus_marshal_uint64_array (&real->message->body, real->message->byte_order, value, len))
4115 _dbus_string_set_length (&real->message->body, real->pos);
4119 dbus_message_iter_append_done (real);
4123 #endif /* DBUS_HAVE_INT64 */
4126 * Appends a double array to the message.
4128 * @param iter an iterator pointing to the end of the message
4129 * @param value the array
4130 * @param len the length of the array
4131 * @returns #TRUE on success
4134 dbus_message_iter_append_double_array (DBusMessageIter *iter,
4135 const double *value,
4138 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4140 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4142 if (!append_array_type (real, DBUS_TYPE_DOUBLE, NULL, NULL))
4145 if (!_dbus_marshal_double_array (&real->message->body, real->message->byte_order, value, len))
4147 _dbus_string_set_length (&real->message->body, real->pos);
4151 dbus_message_iter_append_done (real);
4157 * Appends a byte array to the message.
4159 * @param iter an iterator pointing to the end of the message
4160 * @param value the array
4161 * @param len the length of the array
4162 * @returns #TRUE on success
4165 dbus_message_iter_append_byte_array (DBusMessageIter *iter,
4166 unsigned const char *value,
4169 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4171 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4173 if (!append_array_type (real, DBUS_TYPE_BYTE, NULL, NULL))
4176 if (!_dbus_marshal_byte_array (&real->message->body, real->message->byte_order, value, len))
4178 _dbus_string_set_length (&real->message->body, real->pos);
4182 dbus_message_iter_append_done (real);
4188 * Appends a string array to the message.
4190 * @param iter an iterator pointing to the end of the message
4191 * @param value the array
4192 * @param len the length of the array
4193 * @returns #TRUE on success
4196 dbus_message_iter_append_string_array (DBusMessageIter *iter,
4200 DBusMessageRealIter *real = (DBusMessageRealIter *)iter;
4202 _dbus_return_val_if_fail (dbus_message_iter_append_check (real), FALSE);
4204 if (!append_array_type (real, DBUS_TYPE_STRING, NULL, NULL))
4207 if (!_dbus_marshal_string_array (&real->message->body, real->message->byte_order, value, len))
4209 _dbus_string_set_length (&real->message->body, real->pos);
4213 dbus_message_iter_append_done (real);
4219 * Sets the message sender.
4221 * @param message the message
4222 * @param sender the sender
4223 * @returns #FALSE if not enough memory
4226 dbus_message_set_sender (DBusMessage *message,
4229 _dbus_return_val_if_fail (message != NULL, FALSE);
4230 _dbus_return_val_if_fail (!message->locked, FALSE);
4234 delete_field (message, DBUS_HEADER_FIELD_SENDER_SERVICE);
4239 return set_string_field (message,
4240 DBUS_HEADER_FIELD_SENDER_SERVICE,
4247 * Sets a flag indicating that the message does not want a reply; if
4248 * this flag is set, the other end of the connection may (but is not
4249 * required to) optimize by not sending method return or error
4250 * replies. If this flag is set, there is no way to know whether the
4251 * message successfully arrived at the remote end.
4253 * @param message the message
4254 * @param no_reply #TRUE if no reply is desired
4257 dbus_message_set_no_reply (DBusMessage *message,
4258 dbus_bool_t no_reply)
4262 _dbus_return_if_fail (message != NULL);
4263 _dbus_return_if_fail (!message->locked);
4265 header = _dbus_string_get_data_len (&message->header, FLAGS_OFFSET, 1);
4268 *header |= DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4270 *header &= ~DBUS_HEADER_FLAG_NO_REPLY_EXPECTED;
4274 * Returns #TRUE if the message does not expect
4277 * @param message the message
4278 * @returns #TRUE if the message sender isn't waiting for a reply
4281 dbus_message_get_no_reply (DBusMessage *message)
4285 _dbus_return_val_if_fail (message != NULL, FALSE);
4287 header = _dbus_string_get_const_data_len (&message->header, FLAGS_OFFSET, 1);
4289 return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0;
4293 * Gets the service which originated this message,
4294 * or #NULL if unknown or inapplicable.
4296 * @param message the message
4297 * @returns the service name or #NULL
4300 dbus_message_get_sender (DBusMessage *message)
4302 _dbus_return_val_if_fail (message != NULL, NULL);
4304 return get_string_field (message,
4305 DBUS_HEADER_FIELD_SENDER_SERVICE,
4310 * Gets the type signature of the message, i.e. the arguments in the
4311 * message payload. The signature includes only "in" arguments for
4312 * #DBUS_MESSAGE_TYPE_METHOD_CALL and only "out" arguments for
4313 * #DBUS_MESSAGE_TYPE_METHOD_RETURN, so is slightly different from
4314 * what you might expect (it does not include the signature of the
4315 * entire C++-style method).
4317 * The signature is a string made up of type codes such
4318 * as #DBUS_TYPE_STRING. The string is terminated with nul
4319 * (nul is also the value of #DBUS_TYPE_INVALID).
4321 * @param message the message
4322 * @returns the type signature
4325 dbus_message_get_signature (DBusMessage *message)
4327 _dbus_return_val_if_fail (message != NULL, NULL);
4329 return _dbus_string_get_const_data (&message->signature);
4333 _dbus_message_has_type_interface_member (DBusMessage *message,
4335 const char *interface,
4340 _dbus_assert (message != NULL);
4341 _dbus_assert (interface != NULL);
4342 _dbus_assert (method != NULL);
4344 if (dbus_message_get_type (message) != type)
4347 /* Optimize by checking the short method name first
4348 * instead of the longer interface name
4351 n = dbus_message_get_member (message);
4353 if (n && strcmp (n, method) == 0)
4355 n = dbus_message_get_interface (message);
4357 if (n && strcmp (n, interface) == 0)
4365 * Checks whether the message is a method call with the given
4366 * interface and member fields. If the message is not
4367 * #DBUS_MESSAGE_TYPE_METHOD_CALL, or has a different interface or member field,
4370 * @param message the message
4371 * @param interface the name to check (must not be #NULL)
4372 * @param method the name to check (must not be #NULL)
4374 * @returns #TRUE if the message is the specified method call
4377 dbus_message_is_method_call (DBusMessage *message,
4378 const char *interface,
4381 _dbus_return_val_if_fail (message != NULL, FALSE);
4382 _dbus_return_val_if_fail (interface != NULL, FALSE);
4383 _dbus_return_val_if_fail (method != NULL, FALSE);
4385 return _dbus_message_has_type_interface_member (message,
4386 DBUS_MESSAGE_TYPE_METHOD_CALL,
4391 * Checks whether the message is a signal with the given
4392 * interface and member fields. If the message is not
4393 * #DBUS_MESSAGE_TYPE_SIGNAL, or has a different interface or member field,
4396 * @param message the message
4397 * @param interface the name to check (must not be #NULL)
4398 * @param signal_name the name to check (must not be #NULL)
4400 * @returns #TRUE if the message is the specified signal
4403 dbus_message_is_signal (DBusMessage *message,
4404 const char *interface,
4405 const char *signal_name)
4407 _dbus_return_val_if_fail (message != NULL, FALSE);
4408 _dbus_return_val_if_fail (interface != NULL, FALSE);
4409 _dbus_return_val_if_fail (signal_name != NULL, FALSE);
4411 return _dbus_message_has_type_interface_member (message,
4412 DBUS_MESSAGE_TYPE_SIGNAL,
4413 interface, signal_name);
4417 * Checks whether the message is an error reply with the given error
4418 * name. If the message is not #DBUS_MESSAGE_TYPE_ERROR, or has a
4419 * different name, returns #FALSE.
4421 * @param message the message
4422 * @param error_name the name to check (must not be #NULL)
4424 * @returns #TRUE if the message is the specified error
4427 dbus_message_is_error (DBusMessage *message,
4428 const char *error_name)
4432 _dbus_return_val_if_fail (message != NULL, FALSE);
4433 _dbus_return_val_if_fail (error_name != NULL, FALSE);
4435 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4438 n = dbus_message_get_error_name (message);
4440 if (n && strcmp (n, error_name) == 0)
4447 * Checks whether the message was sent to the given service. If the
4448 * message has no service specified or has a different name, returns
4451 * @param message the message
4452 * @param service the service to check (must not be #NULL)
4454 * @returns #TRUE if the message has the given destination service
4457 dbus_message_has_destination (DBusMessage *message,
4458 const char *service)
4462 _dbus_return_val_if_fail (message != NULL, FALSE);
4463 _dbus_return_val_if_fail (service != NULL, FALSE);
4465 s = dbus_message_get_destination (message);
4467 if (s && strcmp (s, service) == 0)
4474 * Checks whether the message has the given service as its sender. If
4475 * the message has no sender specified or has a different sender,
4476 * returns #FALSE. Note that if a peer application owns multiple
4477 * services, its messages will have only one of those services as the
4478 * sender (usually the base service). So you can't use this
4479 * function to prove the sender didn't own service Foo, you can
4480 * only use it to prove that it did.
4482 * @param message the message
4483 * @param service the service to check (must not be #NULL)
4485 * @returns #TRUE if the message has the given origin service
4488 dbus_message_has_sender (DBusMessage *message,
4489 const char *service)
4493 _dbus_return_val_if_fail (message != NULL, FALSE);
4494 _dbus_return_val_if_fail (service != NULL, FALSE);
4496 s = dbus_message_get_sender (message);
4498 if (s && strcmp (s, service) == 0)
4505 * Checks whether the message has the given signature;
4506 * see dbus_message_get_signature() for more details on
4507 * what the signature looks like.
4509 * @param message the message
4510 * @param signature typecode array
4511 * @returns #TRUE if message has the given signature
4514 dbus_message_has_signature (DBusMessage *message,
4515 const char *signature)
4517 _dbus_return_val_if_fail (message != NULL, FALSE);
4518 _dbus_return_val_if_fail (signature != NULL, FALSE);
4520 return _dbus_string_equal_c_str (&message->signature, signature);
4524 * Sets a #DBusError based on the contents of the given
4525 * message. The error is only set if the message
4526 * is an error message, as in DBUS_MESSAGE_TYPE_ERROR.
4527 * The name of the error is set to the name of the message,
4528 * and the error message is set to the first argument
4529 * if the argument exists and is a string.
4531 * The return value indicates whether the error was set (the error is
4532 * set if and only if the message is an error message).
4533 * So you can check for an error reply and convert it to DBusError
4536 * @param error the error to set
4537 * @param message the message to set it from
4538 * @returns #TRUE if dbus_message_get_is_error() returns #TRUE for the message
4541 dbus_set_error_from_message (DBusError *error,
4542 DBusMessage *message)
4546 _dbus_return_val_if_fail (message != NULL, FALSE);
4547 _dbus_return_val_if_error_is_set (error, FALSE);
4549 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_ERROR)
4553 dbus_message_get_args (message, NULL,
4554 DBUS_TYPE_STRING, &str,
4557 dbus_set_error (error, dbus_message_get_error_name (message),
4558 str ? "%s" : NULL, str);
4568 * @addtogroup DBusMessageInternals
4573 * @typedef DBusMessageLoader
4575 * The DBusMessageLoader object encapsulates the process of converting
4576 * a byte stream into a series of DBusMessage. It buffers the incoming
4577 * bytes as efficiently as possible, and generates a queue of
4578 * messages. DBusMessageLoader is typically used as part of a
4579 * DBusTransport implementation. The DBusTransport then hands off
4580 * the loaded messages to a DBusConnection, making the messages
4581 * visible to the application.
4583 * @todo write tests for break-loader that a) randomly delete header
4584 * fields and b) set string fields to zero-length and other funky
4589 /* we definitely use signed ints for sizes, so don't exceed
4590 * _DBUS_INT_MAX; and add 16 for paranoia, since a message
4591 * over 128M is pretty nuts anyhow.
4595 * The maximum sane message size.
4597 #define MAX_SANE_MESSAGE_SIZE (_DBUS_INT_MAX/16)
4600 * Implementation details of DBusMessageLoader.
4601 * All members are private.
4603 struct DBusMessageLoader
4605 int refcount; /**< Reference count. */
4607 DBusString data; /**< Buffered data */
4609 DBusList *messages; /**< Complete messages. */
4611 long max_message_size; /**< Maximum size of a message */
4613 unsigned int buffer_outstanding : 1; /**< Someone is using the buffer to read */
4615 unsigned int corrupted : 1; /**< We got broken data, and are no longer working */
4619 * The initial buffer size of the message loader.
4621 * @todo this should be based on min header size plus some average
4622 * body size, or something. Or rather, the min header size only, if we
4623 * want to try to read only the header, store that in a DBusMessage,
4624 * then read only the body and store that, etc., depends on
4625 * how we optimize _dbus_message_loader_get_buffer() and what
4626 * the exact message format is.
4628 #define INITIAL_LOADER_DATA_LEN 32
4631 * Creates a new message loader. Returns #NULL if memory can't
4634 * @returns new loader, or #NULL.
4637 _dbus_message_loader_new (void)
4639 DBusMessageLoader *loader;
4641 loader = dbus_new0 (DBusMessageLoader, 1);
4645 loader->refcount = 1;
4647 /* Try to cap message size at something that won't *totally* hose
4648 * the system if we have a couple of them.
4650 loader->max_message_size = _DBUS_ONE_MEGABYTE * 32;
4652 if (!_dbus_string_init (&loader->data))
4658 /* preallocate the buffer for speed, ignore failure */
4659 _dbus_string_set_length (&loader->data, INITIAL_LOADER_DATA_LEN);
4660 _dbus_string_set_length (&loader->data, 0);
4666 * Increments the reference count of the loader.
4668 * @param loader the loader.
4671 _dbus_message_loader_ref (DBusMessageLoader *loader)
4673 loader->refcount += 1;
4677 * Decrements the reference count of the loader and finalizes the
4678 * loader when the count reaches zero.
4680 * @param loader the loader.
4683 _dbus_message_loader_unref (DBusMessageLoader *loader)
4685 loader->refcount -= 1;
4686 if (loader->refcount == 0)
4688 _dbus_list_foreach (&loader->messages,
4689 (DBusForeachFunction) dbus_message_unref,
4691 _dbus_list_clear (&loader->messages);
4692 _dbus_string_free (&loader->data);
4698 * Gets the buffer to use for reading data from the network. Network
4699 * data is read directly into an allocated buffer, which is then used
4700 * in the DBusMessage, to avoid as many extra memcpy's as possible.
4701 * The buffer must always be returned immediately using
4702 * _dbus_message_loader_return_buffer(), even if no bytes are
4703 * successfully read.
4705 * @todo this function can be a lot more clever. For example
4706 * it can probably always return a buffer size to read exactly
4707 * the body of the next message, thus avoiding any memory wastage
4710 * @todo we need to enforce a max length on strings in header fields.
4712 * @param loader the message loader.
4713 * @param buffer the buffer
4716 _dbus_message_loader_get_buffer (DBusMessageLoader *loader,
4717 DBusString **buffer)
4719 _dbus_assert (!loader->buffer_outstanding);
4721 *buffer = &loader->data;
4723 loader->buffer_outstanding = TRUE;
4727 * The smallest header size that can occur.
4728 * (It won't be valid)
4730 #define DBUS_MINIMUM_HEADER_SIZE 16
4733 decode_string_field (const DBusString *data,
4735 HeaderField *header_field,
4736 DBusString *field_data,
4740 int string_data_pos;
4742 _dbus_assert (header_field != NULL);
4743 _dbus_assert (field_data != NULL);
4745 if (header_field->name_offset >= 0)
4747 _dbus_verbose ("%s field provided twice\n",
4748 _dbus_header_field_to_string (field));
4752 if (type != DBUS_TYPE_STRING)
4754 _dbus_verbose ("%s field has wrong type %s\n",
4755 _dbus_header_field_to_string (field),
4756 _dbus_type_to_string (type));
4760 /* skip padding after typecode, skip string length;
4761 * we assume that the string arg has already been validated
4762 * for sanity and UTF-8
4764 string_data_pos = _DBUS_ALIGN_VALUE (pos, 4) + 4;
4765 _dbus_assert (string_data_pos < _dbus_string_get_length (data));
4767 _dbus_string_init_const (field_data,
4768 _dbus_string_get_const_data (data) + string_data_pos);
4770 header_field->name_offset = pos;
4771 header_field->value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4774 _dbus_verbose ("Found field %s at offset %d\n",
4775 _dbus_header_field_to_string (field),
4776 header_field->value_offset);
4783 decode_header_data (const DBusString *data,
4787 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1],
4788 int *message_padding)
4790 DBusString field_data;
4796 if (header_len < 16)
4798 _dbus_verbose ("Header length %d is too short\n", header_len);
4803 while (i <= DBUS_HEADER_FIELD_LAST)
4805 fields[i].name_offset = -1;
4806 fields[i].value_offset = -1;
4811 while (pos < header_len)
4813 field = _dbus_string_get_byte (data, pos);
4814 if (field == DBUS_HEADER_FIELD_INVALID)
4815 break; /* Must be padding */
4818 if (!_dbus_marshal_validate_type (data, pos, &type, &pos))
4820 _dbus_verbose ("Failed to validate type of named header field\n");
4824 if (!_dbus_marshal_validate_arg (data, byte_order, 0, type, -1, pos, &new_pos))
4826 _dbus_verbose ("Failed to validate argument to named header field\n");
4830 if (new_pos > header_len)
4832 _dbus_verbose ("Named header field tries to extend beyond header length\n");
4838 case DBUS_HEADER_FIELD_SERVICE:
4839 if (!decode_string_field (data, field, &fields[field],
4840 &field_data, pos, type))
4843 if (!_dbus_string_validate_service (&field_data, 0,
4844 _dbus_string_get_length (&field_data)))
4846 _dbus_verbose ("service field has invalid content \"%s\"\n",
4847 _dbus_string_get_const_data (&field_data));
4852 case DBUS_HEADER_FIELD_INTERFACE:
4853 if (!decode_string_field (data, field, &fields[field],
4854 &field_data, pos, type))
4857 if (!_dbus_string_validate_interface (&field_data, 0,
4858 _dbus_string_get_length (&field_data)))
4860 _dbus_verbose ("interface field has invalid content \"%s\"\n",
4861 _dbus_string_get_const_data (&field_data));
4865 if (_dbus_string_equal_c_str (&field_data,
4866 DBUS_INTERFACE_ORG_FREEDESKTOP_LOCAL))
4868 _dbus_verbose ("Message is on the local interface\n");
4873 case DBUS_HEADER_FIELD_MEMBER:
4874 if (!decode_string_field (data, field, &fields[field],
4875 &field_data, pos, type))
4878 if (!_dbus_string_validate_member (&field_data, 0,
4879 _dbus_string_get_length (&field_data)))
4881 _dbus_verbose ("member field has invalid content \"%s\"\n",
4882 _dbus_string_get_const_data (&field_data));
4887 case DBUS_HEADER_FIELD_ERROR_NAME:
4888 if (!decode_string_field (data, field, &fields[field],
4889 &field_data, pos, type))
4892 if (!_dbus_string_validate_error_name (&field_data, 0,
4893 _dbus_string_get_length (&field_data)))
4895 _dbus_verbose ("error-name field has invalid content \"%s\"\n",
4896 _dbus_string_get_const_data (&field_data));
4901 case DBUS_HEADER_FIELD_SENDER_SERVICE:
4902 if (!decode_string_field (data, field, &fields[field],
4903 &field_data, pos, type))
4906 if (!_dbus_string_validate_service (&field_data, 0,
4907 _dbus_string_get_length (&field_data)))
4909 _dbus_verbose ("sender-service field has invalid content \"%s\"\n",
4910 _dbus_string_get_const_data (&field_data));
4915 case DBUS_HEADER_FIELD_PATH:
4917 /* Path was already validated as part of standard
4918 * type validation, since there's an OBJECT_PATH
4922 if (fields[field].name_offset >= 0)
4924 _dbus_verbose ("path field provided twice\n");
4927 if (type != DBUS_TYPE_OBJECT_PATH)
4929 _dbus_verbose ("path field has wrong type\n");
4933 fields[field].name_offset = pos;
4934 fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4936 /* No forging signals from the local path */
4939 s = _dbus_string_get_const_data_len (data,
4940 fields[field].value_offset,
4941 _dbus_string_get_length (data) -
4942 fields[field].value_offset);
4943 if (strcmp (s, DBUS_PATH_ORG_FREEDESKTOP_LOCAL) == 0)
4945 _dbus_verbose ("Message is on the local path\n");
4950 _dbus_verbose ("Found path at offset %d\n",
4951 fields[field].value_offset);
4954 case DBUS_HEADER_FIELD_REPLY_SERIAL:
4955 if (fields[field].name_offset >= 0)
4957 _dbus_verbose ("reply field provided twice\n");
4961 if (type != DBUS_TYPE_UINT32)
4963 _dbus_verbose ("reply field has wrong type\n");
4967 fields[field].name_offset = pos;
4968 fields[field].value_offset = _DBUS_ALIGN_VALUE (pos, 4);
4970 _dbus_verbose ("Found reply serial at offset %d\n",
4971 fields[field].value_offset);
4975 _dbus_verbose ("Ignoring an unknown header field: %d at offset %d\n",
4982 if (pos < header_len)
4984 /* Alignment padding, verify that it's nul */
4985 if ((header_len - pos) >= 8)
4987 _dbus_verbose ("too much header alignment padding\n");
4991 if (!_dbus_string_validate_nul (data,
4992 pos, (header_len - pos)))
4994 _dbus_verbose ("header alignment padding is not nul\n");
4999 /* Depending on message type, enforce presence of certain fields. */
5000 switch (message_type)
5002 case DBUS_MESSAGE_TYPE_SIGNAL:
5003 case DBUS_MESSAGE_TYPE_METHOD_CALL:
5004 if (fields[DBUS_HEADER_FIELD_PATH].value_offset < 0)
5006 _dbus_verbose ("No path field provided\n");
5009 /* FIXME make this optional, only for method calls */
5010 if (fields[DBUS_HEADER_FIELD_INTERFACE].value_offset < 0)
5012 _dbus_verbose ("No interface field provided\n");
5015 if (fields[DBUS_HEADER_FIELD_MEMBER].value_offset < 0)
5017 _dbus_verbose ("No member field provided\n");
5021 case DBUS_MESSAGE_TYPE_ERROR:
5022 if (fields[DBUS_HEADER_FIELD_ERROR_NAME].value_offset < 0)
5024 _dbus_verbose ("No error-name field provided\n");
5028 case DBUS_MESSAGE_TYPE_METHOD_RETURN:
5031 /* An unknown type, spec requires us to ignore it */
5035 if (message_padding)
5036 *message_padding = header_len - pos;
5042 * Returns a buffer obtained from _dbus_message_loader_get_buffer(),
5043 * indicating to the loader how many bytes of the buffer were filled
5044 * in. This function must always be called, even if no bytes were
5045 * successfully read.
5047 * @param loader the loader.
5048 * @param buffer the buffer.
5049 * @param bytes_read number of bytes that were read into the buffer.
5052 _dbus_message_loader_return_buffer (DBusMessageLoader *loader,
5056 _dbus_assert (loader->buffer_outstanding);
5057 _dbus_assert (buffer == &loader->data);
5059 loader->buffer_outstanding = FALSE;
5063 * Converts buffered data into messages.
5065 * @todo we need to check that the proper named header fields exist
5066 * for each message type.
5068 * @todo If a message has unknown type, we should probably eat it
5069 * right here rather than passing it out to applications. However
5070 * it's not an error to see messages of unknown type.
5072 * @param loader the loader.
5073 * @returns #TRUE if we had enough memory to finish.
5076 _dbus_message_loader_queue_messages (DBusMessageLoader *loader)
5078 if (loader->corrupted)
5081 while (_dbus_string_get_length (&loader->data) >= 16)
5083 DBusMessage *message;
5084 const char *header_data;
5085 int byte_order, message_type, header_len, body_len, header_padding;
5086 dbus_uint32_t header_len_unsigned, body_len_unsigned;
5088 header_data = _dbus_string_get_const_data_len (&loader->data, 0, 16);
5090 _dbus_assert (_DBUS_ALIGN_ADDRESS (header_data, 4) == header_data);
5092 if (header_data[VERSION_OFFSET] != DBUS_MAJOR_PROTOCOL_VERSION)
5094 _dbus_verbose ("Message has protocol version %d ours is %d\n",
5095 (int) header_data[VERSION_OFFSET], DBUS_MAJOR_PROTOCOL_VERSION);
5096 loader->corrupted = TRUE;
5100 byte_order = header_data[BYTE_ORDER_OFFSET];
5102 if (byte_order != DBUS_LITTLE_ENDIAN &&
5103 byte_order != DBUS_BIG_ENDIAN)
5105 _dbus_verbose ("Message with bad byte order '%c' received\n",
5107 loader->corrupted = TRUE;
5111 /* Unknown types are ignored, but INVALID is
5114 message_type = header_data[TYPE_OFFSET];
5115 if (message_type == DBUS_MESSAGE_TYPE_INVALID)
5117 _dbus_verbose ("Message with bad type '%d' received\n",
5119 loader->corrupted = TRUE;
5123 header_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 4);
5124 body_len_unsigned = _dbus_unpack_uint32 (byte_order, header_data + 8);
5126 if (header_len_unsigned < 16)
5128 _dbus_verbose ("Message had broken too-small header length %u\n",
5129 header_len_unsigned);
5130 loader->corrupted = TRUE;
5134 if (header_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE ||
5135 body_len_unsigned > (unsigned) MAX_SANE_MESSAGE_SIZE)
5137 _dbus_verbose ("Header or body length too large (%u %u)\n",
5138 header_len_unsigned,
5140 loader->corrupted = TRUE;
5144 /* Now that we know the values are in signed range, get
5145 * rid of stupid unsigned, just causes bugs
5147 header_len = header_len_unsigned;
5148 body_len = body_len_unsigned;
5150 if (_DBUS_ALIGN_VALUE (header_len, 8) != header_len_unsigned)
5153 _dbus_verbose ("header length %d is not aligned to 8 bytes\n",
5155 loader->corrupted = TRUE;
5159 if (header_len + body_len > loader->max_message_size)
5161 _dbus_verbose ("Message claimed length header = %d body = %d exceeds max message length %ld\n",
5162 header_len, body_len, loader->max_message_size);
5163 loader->corrupted = TRUE;
5167 if (_dbus_string_get_length (&loader->data) >= (header_len + body_len))
5169 HeaderField fields[DBUS_HEADER_FIELD_LAST + 1];
5174 _dbus_verbose_bytes_of_string (&loader->data, 0, header_len + body_len);
5176 if (!decode_header_data (&loader->data,
5177 header_len, byte_order,
5179 fields, &header_padding))
5181 _dbus_verbose ("Header was invalid\n");
5182 loader->corrupted = TRUE;
5186 next_arg = header_len;
5187 while (next_arg < (header_len + body_len))
5190 int prev = next_arg;
5192 if (!_dbus_marshal_validate_type (&loader->data, next_arg,
5195 _dbus_verbose ("invalid typecode at offset %d\n", prev);
5196 loader->corrupted = TRUE;
5200 if (!_dbus_marshal_validate_arg (&loader->data,
5207 _dbus_verbose ("invalid type data at %d, next_arg\n", next_arg);
5208 loader->corrupted = TRUE;
5212 _dbus_assert (next_arg > prev);
5215 if (next_arg > (header_len + body_len))
5217 _dbus_verbose ("end of last arg at %d but message has len %d+%d=%d\n",
5218 next_arg, header_len, body_len,
5219 header_len + body_len);
5220 loader->corrupted = TRUE;
5224 message = dbus_message_new_empty_header ();
5225 if (message == NULL)
5227 _dbus_verbose ("Failed to allocate empty message\n");
5231 message->byte_order = byte_order;
5232 message->header_padding = header_padding;
5234 /* Copy in the offsets we found */
5236 while (i <= DBUS_HEADER_FIELD_LAST)
5238 message->header_fields[i] = fields[i];
5242 if (!_dbus_list_append (&loader->messages, message))
5244 _dbus_verbose ("Failed to append new message to loader queue\n");
5245 dbus_message_unref (message);
5249 _dbus_assert (_dbus_string_get_length (&message->header) == 0);
5250 _dbus_assert (_dbus_string_get_length (&message->body) == 0);
5252 _dbus_assert (_dbus_string_get_length (&loader->data) >=
5253 (header_len + body_len));
5255 if (!_dbus_string_move_len (&loader->data, 0, header_len, &message->header, 0))
5257 _dbus_verbose ("Failed to move header into new message\n");
5258 _dbus_list_remove_last (&loader->messages, message);
5259 dbus_message_unref (message);
5263 if (!_dbus_string_move_len (&loader->data, 0, body_len, &message->body, 0))
5267 _dbus_verbose ("Failed to move body into new message\n");
5269 /* put the header back, we'll try again later */
5270 result = _dbus_string_copy_len (&message->header, 0, header_len,
5272 _dbus_assert (result); /* because DBusString never reallocs smaller */
5274 _dbus_list_remove_last (&loader->messages, message);
5275 dbus_message_unref (message);
5279 _dbus_assert (_dbus_string_get_length (&message->header) == header_len);
5280 _dbus_assert (_dbus_string_get_length (&message->body) == body_len);
5282 /* Fill in caches (we checked the types of these fields
5285 message->reply_serial = get_uint_field (message,
5286 DBUS_HEADER_FIELD_REPLY_SERIAL);
5288 message->client_serial = _dbus_demarshal_uint32 (&message->header,
5289 message->byte_order,
5290 CLIENT_SERIAL_OFFSET,
5293 /* Fill in signature (FIXME should do this during validation,
5294 * but I didn't want to spend time on it since we want to change
5295 * the wire format to contain the signature anyway)
5298 DBusMessageIter iter;
5300 dbus_message_iter_init (message, &iter);
5306 t = dbus_message_iter_get_arg_type (&iter);
5307 if (t == DBUS_TYPE_INVALID)
5310 if (!_dbus_string_append_byte (&message->signature,
5313 _dbus_verbose ("failed to append type byte to signature\n");
5314 _dbus_list_remove_last (&loader->messages, message);
5315 dbus_message_unref (message);
5319 if (t == DBUS_TYPE_ARRAY)
5321 DBusMessageIter child_iter;
5326 while (array_type == DBUS_TYPE_ARRAY)
5328 DBusMessageIter parent_iter = child_iter;
5329 dbus_message_iter_init_array_iterator (&parent_iter,
5333 if (!_dbus_string_append_byte (&message->signature,
5336 _dbus_verbose ("failed to append array type byte to signature\n");
5337 _dbus_list_remove_last (&loader->messages, message);
5338 dbus_message_unref (message);
5344 while (dbus_message_iter_next (&iter));
5347 _dbus_verbose ("Loaded message %p\n", message);
5357 * Peeks at first loaded message, returns #NULL if no messages have
5360 * @param loader the loader.
5361 * @returns the next message, or #NULL if none.
5364 _dbus_message_loader_peek_message (DBusMessageLoader *loader)
5366 if (loader->messages)
5367 return loader->messages->data;
5373 * Pops a loaded message (passing ownership of the message
5374 * to the caller). Returns #NULL if no messages have been
5377 * @param loader the loader.
5378 * @returns the next message, or #NULL if none.
5381 _dbus_message_loader_pop_message (DBusMessageLoader *loader)
5383 return _dbus_list_pop_first (&loader->messages);
5387 * Pops a loaded message inside a list link (passing ownership of the
5388 * message and link to the caller). Returns #NULL if no messages have
5391 * @param loader the loader.
5392 * @returns the next message link, or #NULL if none.
5395 _dbus_message_loader_pop_message_link (DBusMessageLoader *loader)
5397 return _dbus_list_pop_first_link (&loader->messages);
5401 * Returns a popped message link, used to undo a pop.
5403 * @param loader the loader
5404 * @param link the link with a message in it
5407 _dbus_message_loader_putback_message_link (DBusMessageLoader *loader,
5410 _dbus_list_prepend_link (&loader->messages, link);
5414 * Checks whether the loader is confused due to bad data.
5415 * If messages are received that are invalid, the
5416 * loader gets confused and gives up permanently.
5417 * This state is called "corrupted."
5419 * @param loader the loader
5420 * @returns #TRUE if the loader is hosed.
5423 _dbus_message_loader_get_is_corrupted (DBusMessageLoader *loader)
5425 return loader->corrupted;
5429 * Sets the maximum size message we allow.
5431 * @param loader the loader
5432 * @param size the max message size in bytes
5435 _dbus_message_loader_set_max_message_size (DBusMessageLoader *loader,
5438 if (size > MAX_SANE_MESSAGE_SIZE)
5440 _dbus_verbose ("clamping requested max message size %ld to %d\n",
5441 size, MAX_SANE_MESSAGE_SIZE);
5442 size = MAX_SANE_MESSAGE_SIZE;
5444 loader->max_message_size = size;
5448 * Gets the maximum allowed message size in bytes.
5450 * @param loader the loader
5451 * @returns max size in bytes
5454 _dbus_message_loader_get_max_message_size (DBusMessageLoader *loader)
5456 return loader->max_message_size;
5459 static DBusDataSlotAllocator slot_allocator;
5460 _DBUS_DEFINE_GLOBAL_LOCK (message_slots);
5463 * Allocates an integer ID to be used for storing application-specific
5464 * data on any DBusMessage. The allocated ID may then be used
5465 * with dbus_message_set_data() and dbus_message_get_data().
5466 * The passed-in slot must be initialized to -1, and is filled in
5467 * with the slot ID. If the passed-in slot is not -1, it's assumed
5468 * to be already allocated, and its refcount is incremented.
5470 * The allocated slot is global, i.e. all DBusMessage objects will
5471 * have a slot with the given integer ID reserved.
5473 * @param slot_p address of a global variable storing the slot
5474 * @returns #FALSE on failure (no memory)
5477 dbus_message_allocate_data_slot (dbus_int32_t *slot_p)
5479 return _dbus_data_slot_allocator_alloc (&slot_allocator,
5480 _DBUS_LOCK_NAME (message_slots),
5485 * Deallocates a global ID for message data slots.
5486 * dbus_message_get_data() and dbus_message_set_data() may no
5487 * longer be used with this slot. Existing data stored on existing
5488 * DBusMessage objects will be freed when the message is
5489 * finalized, but may not be retrieved (and may only be replaced if
5490 * someone else reallocates the slot). When the refcount on the
5491 * passed-in slot reaches 0, it is set to -1.
5493 * @param slot_p address storing the slot to deallocate
5496 dbus_message_free_data_slot (dbus_int32_t *slot_p)
5498 _dbus_return_if_fail (*slot_p >= 0);
5500 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
5504 * Stores a pointer on a DBusMessage, along
5505 * with an optional function to be used for freeing
5506 * the data when the data is set again, or when
5507 * the message is finalized. The slot number
5508 * must have been allocated with dbus_message_allocate_data_slot().
5510 * @param message the message
5511 * @param slot the slot number
5512 * @param data the data to store
5513 * @param free_data_func finalizer function for the data
5514 * @returns #TRUE if there was enough memory to store the data
5517 dbus_message_set_data (DBusMessage *message,
5520 DBusFreeFunction free_data_func)
5522 DBusFreeFunction old_free_func;
5526 _dbus_return_val_if_fail (message != NULL, FALSE);
5527 _dbus_return_val_if_fail (slot >= 0, FALSE);
5529 retval = _dbus_data_slot_list_set (&slot_allocator,
5530 &message->slot_list,
5531 slot, data, free_data_func,
5532 &old_free_func, &old_data);
5536 /* Do the actual free outside the message lock */
5538 (* old_free_func) (old_data);
5545 * Retrieves data previously set with dbus_message_set_data().
5546 * The slot must still be allocated (must not have been freed).
5548 * @param message the message
5549 * @param slot the slot to get data from
5550 * @returns the data, or #NULL if not found
5553 dbus_message_get_data (DBusMessage *message,
5558 _dbus_return_val_if_fail (message != NULL, NULL);
5560 res = _dbus_data_slot_list_get (&slot_allocator,
5561 &message->slot_list,
5568 * Utility function to convert a machine-readable (not translated)
5569 * string into a D-BUS message type.
5572 * "method_call" -> DBUS_MESSAGE_TYPE_METHOD_CALL
5573 * "method_return" -> DBUS_MESSAGE_TYPE_METHOD_RETURN
5574 * "signal" -> DBUS_MESSAGE_TYPE_SIGNAL
5575 * "error" -> DBUS_MESSAGE_TYPE_ERROR
5576 * anything else -> DBUS_MESSAGE_TYPE_INVALID
5581 dbus_message_type_from_string (const char *type_str)
5583 if (strcmp (type_str, "method_call") == 0)
5584 return DBUS_MESSAGE_TYPE_METHOD_CALL;
5585 if (strcmp (type_str, "method_return") == 0)
5586 return DBUS_MESSAGE_TYPE_METHOD_RETURN;
5587 else if (strcmp (type_str, "signal") == 0)
5588 return DBUS_MESSAGE_TYPE_SIGNAL;
5589 else if (strcmp (type_str, "error") == 0)
5590 return DBUS_MESSAGE_TYPE_ERROR;
5592 return DBUS_MESSAGE_TYPE_INVALID;
5596 #ifdef DBUS_BUILD_TESTS
5597 #include "dbus-test.h"
5601 message_iter_test (DBusMessage *message)
5603 DBusMessageIter iter, dict, array, array2;
5605 unsigned char *data;
5606 dbus_int32_t *our_int_array;
5609 dbus_message_iter_init (message, &iter);
5612 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_STRING)
5613 _dbus_assert_not_reached ("Argument type isn't string");
5615 str = dbus_message_iter_get_string (&iter);
5616 if (strcmp (str, "Test string") != 0)
5617 _dbus_assert_not_reached ("Strings differ");
5620 if (!dbus_message_iter_next (&iter))
5621 _dbus_assert_not_reached ("Reached end of arguments");
5623 /* Signed integer tests */
5624 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_INT32)
5625 _dbus_assert_not_reached ("Argument type isn't int32");
5627 if (dbus_message_iter_get_int32 (&iter) != -0x12345678)
5628 _dbus_assert_not_reached ("Signed integers differ");
5630 if (!dbus_message_iter_next (&iter))
5631 _dbus_assert_not_reached ("Reached end of fields");
5633 /* Unsigned integer tests */
5634 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
5635 _dbus_assert_not_reached ("Argument type isn't int32");
5637 if (dbus_message_iter_get_uint32 (&iter) != 0xedd1e)
5638 _dbus_assert_not_reached ("Unsigned integers differ");
5640 if (!dbus_message_iter_next (&iter))
5641 _dbus_assert_not_reached ("Reached end of arguments");
5644 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DOUBLE)
5645 _dbus_assert_not_reached ("Argument type isn't double");
5647 if (dbus_message_iter_get_double (&iter) != 3.14159)
5648 _dbus_assert_not_reached ("Doubles differ");
5650 if (!dbus_message_iter_next (&iter))
5651 _dbus_assert_not_reached ("Reached end of arguments");
5653 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_ARRAY)
5654 _dbus_assert_not_reached ("Argument type not an array");
5656 if (dbus_message_iter_get_array_type (&iter) != DBUS_TYPE_DOUBLE)
5657 _dbus_assert_not_reached ("Array type not double");
5660 dbus_message_iter_init_array_iterator (&iter, &array, NULL);
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) != 1.5)
5666 _dbus_assert_not_reached ("Unsigned integers differ");
5668 if (!dbus_message_iter_next (&array))
5669 _dbus_assert_not_reached ("Reached end of arguments");
5671 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_DOUBLE)
5672 _dbus_assert_not_reached ("Argument type isn't double");
5674 if (dbus_message_iter_get_double (&array) != 2.5)
5675 _dbus_assert_not_reached ("Unsigned integers differ");
5677 if (dbus_message_iter_next (&array))
5678 _dbus_assert_not_reached ("Didn't reach end of arguments");
5680 if (!dbus_message_iter_next (&iter))
5681 _dbus_assert_not_reached ("Reached end of arguments");
5686 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
5687 _dbus_assert_not_reached ("not dict type");
5689 dbus_message_iter_init_dict_iterator (&iter, &dict);
5691 str = dbus_message_iter_get_dict_key (&dict);
5692 if (str == NULL || strcmp (str, "test") != 0)
5693 _dbus_assert_not_reached ("wrong dict key");
5696 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
5697 _dbus_assert_not_reached ("wrong dict entry type");
5699 if (dbus_message_iter_get_uint32 (&dict) != 0xDEADBEEF)
5700 _dbus_assert_not_reached ("wrong dict entry value");
5702 if (!dbus_message_iter_next (&dict))
5703 _dbus_assert_not_reached ("reached end of dict");
5705 /* array of array of int32 (in dict) */
5707 str = dbus_message_iter_get_dict_key (&dict);
5708 if (str == NULL || strcmp (str, "array") != 0)
5709 _dbus_assert_not_reached ("wrong dict key");
5712 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_ARRAY)
5713 _dbus_assert_not_reached ("Argument type not an array");
5715 if (dbus_message_iter_get_array_type (&dict) != DBUS_TYPE_ARRAY)
5716 _dbus_assert_not_reached ("Array type not array");
5718 dbus_message_iter_init_array_iterator (&dict, &array, NULL);
5720 if (dbus_message_iter_get_arg_type (&array) != DBUS_TYPE_ARRAY)
5721 _dbus_assert_not_reached ("Argument type isn't array");
5723 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5724 _dbus_assert_not_reached ("Array type not int32");
5726 dbus_message_iter_init_array_iterator (&array, &array2, NULL);
5728 if (dbus_message_iter_get_arg_type (&array2) != DBUS_TYPE_INT32)
5729 _dbus_assert_not_reached ("Argument type isn't int32");
5731 if (dbus_message_iter_get_int32 (&array2) != 0x12345678)
5732 _dbus_assert_not_reached ("Signed integers differ");
5734 if (!dbus_message_iter_next (&array2))
5735 _dbus_assert_not_reached ("Reached end of arguments");
5737 if (dbus_message_iter_get_int32 (&array2) != 0x23456781)
5738 _dbus_assert_not_reached ("Signed integers differ");
5740 if (dbus_message_iter_next (&array2))
5741 _dbus_assert_not_reached ("Didn't reached end of arguments");
5743 if (!dbus_message_iter_next (&array))
5744 _dbus_assert_not_reached ("Reached end of arguments");
5746 if (dbus_message_iter_get_array_type (&array) != DBUS_TYPE_INT32)
5747 _dbus_assert_not_reached ("Array type not int32");
5749 if (!dbus_message_iter_get_int32_array (&array,
5752 _dbus_assert_not_reached ("couldn't get int32 array");
5754 _dbus_assert (len == 3);
5755 _dbus_assert (our_int_array[0] == 0x34567812 &&
5756 our_int_array[1] == 0x45678123 &&
5757 our_int_array[2] == 0x56781234);
5758 dbus_free (our_int_array);
5760 if (dbus_message_iter_next (&array))
5761 _dbus_assert_not_reached ("Didn't reach end of array");
5763 if (dbus_message_iter_next (&dict))
5764 _dbus_assert_not_reached ("Didn't reach end of dict");
5766 if (!dbus_message_iter_next (&iter))
5767 _dbus_assert_not_reached ("Reached end of arguments");
5769 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_BYTE)
5771 _dbus_warn ("type was: %d\n", dbus_message_iter_get_arg_type (&iter));
5772 _dbus_assert_not_reached ("wrong type after dict (should be byte)");
5775 if (dbus_message_iter_get_byte (&iter) != 0xF0)
5776 _dbus_assert_not_reached ("wrong value after dict");
5779 if (!dbus_message_iter_next (&iter))
5780 _dbus_assert_not_reached ("Reached end of arguments");
5782 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NIL)
5783 _dbus_assert_not_reached ("not a nil type");
5785 if (!dbus_message_iter_next (&iter))
5786 _dbus_assert_not_reached ("Reached end of arguments");
5788 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_NAMED)
5789 _dbus_assert_not_reached ("wrong type after dict");
5791 if (!dbus_message_iter_get_named (&iter, &str, &data, &len))
5792 _dbus_assert_not_reached ("failed to get named");
5794 _dbus_assert (strcmp (str, "named")==0);
5795 _dbus_assert (len == 5);
5796 _dbus_assert (strcmp (data, "data")==0);
5800 if (dbus_message_iter_next (&iter))
5801 _dbus_assert_not_reached ("Didn't reach end of arguments");
5806 check_message_handling_type (DBusMessageIter *iter,
5809 DBusMessageIter child_iter;
5815 case DBUS_TYPE_BYTE:
5816 dbus_message_iter_get_byte (iter);
5818 case DBUS_TYPE_BOOLEAN:
5819 dbus_message_iter_get_boolean (iter);
5821 case DBUS_TYPE_INT32:
5822 dbus_message_iter_get_int32 (iter);
5824 case DBUS_TYPE_UINT32:
5825 dbus_message_iter_get_uint32 (iter);
5827 case DBUS_TYPE_INT64:
5828 #ifdef DBUS_HAVE_INT64
5829 dbus_message_iter_get_int64 (iter);
5832 case DBUS_TYPE_UINT64:
5833 #ifdef DBUS_HAVE_INT64
5834 dbus_message_iter_get_uint64 (iter);
5837 case DBUS_TYPE_DOUBLE:
5838 dbus_message_iter_get_double (iter);
5840 case DBUS_TYPE_STRING:
5843 str = dbus_message_iter_get_string (iter);
5846 _dbus_warn ("NULL string in message\n");
5852 case DBUS_TYPE_NAMED:
5855 unsigned char *data;
5858 if (!dbus_message_iter_get_named (iter, &name, &data, &len))
5860 _dbus_warn ("error reading name from named type\n");
5867 case DBUS_TYPE_ARRAY:
5871 dbus_message_iter_init_array_iterator (iter, &child_iter, &array_type);
5873 while (dbus_message_iter_has_next (&child_iter))
5875 if (!check_message_handling_type (&child_iter, array_type))
5877 _dbus_warn ("error in array element\n");
5881 if (!dbus_message_iter_next (&child_iter))
5886 case DBUS_TYPE_DICT:
5891 dbus_message_iter_init_dict_iterator (iter, &child_iter);
5893 while ((entry_type = dbus_message_iter_get_arg_type (&child_iter)) != DBUS_TYPE_INVALID)
5895 key = dbus_message_iter_get_dict_key (&child_iter);
5898 _dbus_warn ("error reading dict key\n");
5903 if (!check_message_handling_type (&child_iter, entry_type))
5905 _dbus_warn ("error in dict value\n");
5909 if (!dbus_message_iter_next (&child_iter))
5916 _dbus_warn ("unknown type %d\n", type);
5925 check_message_handling (DBusMessage *message)
5927 DBusMessageIter iter;
5930 dbus_uint32_t client_serial;
5934 client_serial = dbus_message_get_serial (message);
5936 /* can't use set_serial due to the assertions at the start of it */
5937 _dbus_marshal_set_uint32 (&message->header,
5938 message->byte_order,
5939 CLIENT_SERIAL_OFFSET,
5942 if (client_serial != dbus_message_get_serial (message))
5944 _dbus_warn ("get/set cycle for client_serial did not succeed\n");
5948 /* If we implement message_set_arg (message, n, value)
5949 * then we would want to test it here
5952 dbus_message_iter_init (message, &iter);
5953 while ((type = dbus_message_iter_get_arg_type (&iter)) != DBUS_TYPE_INVALID)
5955 if (!check_message_handling_type (&iter, type))
5958 if (!dbus_message_iter_next (&iter))
5969 check_have_valid_message (DBusMessageLoader *loader)
5971 DBusMessage *message;
5977 if (!_dbus_message_loader_queue_messages (loader))
5978 _dbus_assert_not_reached ("no memory to queue messages");
5980 if (_dbus_message_loader_get_is_corrupted (loader))
5982 _dbus_warn ("loader corrupted on message that was expected to be valid\n");
5986 message = _dbus_message_loader_pop_message (loader);
5987 if (message == NULL)
5989 _dbus_warn ("didn't load message that was expected to be valid (message not popped)\n");
5993 if (_dbus_string_get_length (&loader->data) > 0)
5995 _dbus_warn ("had leftover bytes from expected-to-be-valid single message\n");
5999 /* Verify that we're able to properly deal with the message.
6000 * For example, this would detect improper handling of messages
6001 * in nonstandard byte order.
6003 if (!check_message_handling (message))
6010 dbus_message_unref (message);
6016 check_invalid_message (DBusMessageLoader *loader)
6022 if (!_dbus_message_loader_queue_messages (loader))
6023 _dbus_assert_not_reached ("no memory to queue messages");
6025 if (!_dbus_message_loader_get_is_corrupted (loader))
6027 _dbus_warn ("loader not corrupted on message that was expected to be invalid\n");
6038 check_incomplete_message (DBusMessageLoader *loader)
6040 DBusMessage *message;
6046 if (!_dbus_message_loader_queue_messages (loader))
6047 _dbus_assert_not_reached ("no memory to queue messages");
6049 if (_dbus_message_loader_get_is_corrupted (loader))
6051 _dbus_warn ("loader corrupted on message that was expected to be valid (but incomplete)\n");
6055 message = _dbus_message_loader_pop_message (loader);
6056 if (message != NULL)
6058 _dbus_warn ("loaded message that was expected to be incomplete\n");
6066 dbus_message_unref (message);
6071 check_loader_results (DBusMessageLoader *loader,
6072 DBusMessageValidity validity)
6074 if (!_dbus_message_loader_queue_messages (loader))
6075 _dbus_assert_not_reached ("no memory to queue messages");
6079 case _DBUS_MESSAGE_VALID:
6080 return check_have_valid_message (loader);
6081 case _DBUS_MESSAGE_INVALID:
6082 return check_invalid_message (loader);
6083 case _DBUS_MESSAGE_INCOMPLETE:
6084 return check_incomplete_message (loader);
6085 case _DBUS_MESSAGE_UNKNOWN:
6089 _dbus_assert_not_reached ("bad DBusMessageValidity");
6095 * Loads the message in the given message file.
6097 * @param filename filename to load
6098 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
6099 * @param data string to load message into
6100 * @returns #TRUE if the message was loaded
6103 dbus_internal_do_not_use_load_message_file (const DBusString *filename,
6115 _dbus_verbose ("Loading raw %s\n", _dbus_string_get_const_data (filename));
6116 dbus_error_init (&error);
6117 if (!_dbus_file_get_contents (data, filename, &error))
6119 _dbus_warn ("Could not load message file %s: %s\n",
6120 _dbus_string_get_const_data (filename),
6122 dbus_error_free (&error);
6128 if (!_dbus_message_data_load (data, filename))
6130 _dbus_warn ("Could not load message file %s\n",
6131 _dbus_string_get_const_data (filename));
6144 * Tries loading the message in the given message file
6145 * and verifies that DBusMessageLoader can handle it.
6147 * @param filename filename to load
6148 * @param is_raw if #TRUE load as binary data, if #FALSE as message builder language
6149 * @param expected_validity what the message has to be like to return #TRUE
6150 * @returns #TRUE if the message has the expected validity
6153 dbus_internal_do_not_use_try_message_file (const DBusString *filename,
6155 DBusMessageValidity expected_validity)
6162 if (!_dbus_string_init (&data))
6163 _dbus_assert_not_reached ("could not allocate string\n");
6165 if (!dbus_internal_do_not_use_load_message_file (filename, is_raw,
6169 retval = dbus_internal_do_not_use_try_message_data (&data, expected_validity);
6175 if (_dbus_string_get_length (&data) > 0)
6176 _dbus_verbose_bytes_of_string (&data, 0,
6177 _dbus_string_get_length (&data));
6179 _dbus_warn ("Failed message loader test on %s\n",
6180 _dbus_string_get_const_data (filename));
6183 _dbus_string_free (&data);
6189 * Tries loading the given message data.
6192 * @param data the message data
6193 * @param expected_validity what the message has to be like to return #TRUE
6194 * @returns #TRUE if the message has the expected validity
6197 dbus_internal_do_not_use_try_message_data (const DBusString *data,
6198 DBusMessageValidity expected_validity)
6200 DBusMessageLoader *loader;
6208 /* Write the data one byte at a time */
6210 loader = _dbus_message_loader_new ();
6212 /* check some trivial loader functions */
6213 _dbus_message_loader_ref (loader);
6214 _dbus_message_loader_unref (loader);
6215 _dbus_message_loader_get_max_message_size (loader);
6217 len = _dbus_string_get_length (data);
6218 for (i = 0; i < len; i++)
6222 _dbus_message_loader_get_buffer (loader, &buffer);
6223 _dbus_string_append_byte (buffer,
6224 _dbus_string_get_byte (data, i));
6225 _dbus_message_loader_return_buffer (loader, buffer, 1);
6228 if (!check_loader_results (loader, expected_validity))
6231 _dbus_message_loader_unref (loader);
6234 /* Write the data all at once */
6236 loader = _dbus_message_loader_new ();
6241 _dbus_message_loader_get_buffer (loader, &buffer);
6242 _dbus_string_copy (data, 0, buffer,
6243 _dbus_string_get_length (buffer));
6244 _dbus_message_loader_return_buffer (loader, buffer, 1);
6247 if (!check_loader_results (loader, expected_validity))
6250 _dbus_message_loader_unref (loader);
6253 /* Write the data 2 bytes at a time */
6255 loader = _dbus_message_loader_new ();
6257 len = _dbus_string_get_length (data);
6258 for (i = 0; i < len; i += 2)
6262 _dbus_message_loader_get_buffer (loader, &buffer);
6263 _dbus_string_append_byte (buffer,
6264 _dbus_string_get_byte (data, i));
6266 _dbus_string_append_byte (buffer,
6267 _dbus_string_get_byte (data, i+1));
6268 _dbus_message_loader_return_buffer (loader, buffer, 1);
6271 if (!check_loader_results (loader, expected_validity))
6274 _dbus_message_loader_unref (loader);
6282 _dbus_message_loader_unref (loader);
6288 process_test_subdir (const DBusString *test_base_dir,
6290 DBusMessageValidity validity,
6291 DBusForeachMessageFileFunc function,
6294 DBusString test_directory;
6295 DBusString filename;
6303 if (!_dbus_string_init (&test_directory))
6304 _dbus_assert_not_reached ("didn't allocate test_directory\n");
6306 _dbus_string_init_const (&filename, subdir);
6308 if (!_dbus_string_copy (test_base_dir, 0,
6309 &test_directory, 0))
6310 _dbus_assert_not_reached ("couldn't copy test_base_dir to test_directory");
6312 if (!_dbus_concat_dir_and_file (&test_directory, &filename))
6313 _dbus_assert_not_reached ("couldn't allocate full path");
6315 _dbus_string_free (&filename);
6316 if (!_dbus_string_init (&filename))
6317 _dbus_assert_not_reached ("didn't allocate filename string\n");
6319 dbus_error_init (&error);
6320 dir = _dbus_directory_open (&test_directory, &error);
6323 _dbus_warn ("Could not open %s: %s\n",
6324 _dbus_string_get_const_data (&test_directory),
6326 dbus_error_free (&error);
6330 printf ("Testing %s:\n", subdir);
6333 while (_dbus_directory_get_next_file (dir, &filename, &error))
6335 DBusString full_path;
6338 if (!_dbus_string_init (&full_path))
6339 _dbus_assert_not_reached ("couldn't init string");
6341 if (!_dbus_string_copy (&test_directory, 0, &full_path, 0))
6342 _dbus_assert_not_reached ("couldn't copy dir to full_path");
6344 if (!_dbus_concat_dir_and_file (&full_path, &filename))
6345 _dbus_assert_not_reached ("couldn't concat file to dir");
6347 if (_dbus_string_ends_with_c_str (&filename, ".message"))
6349 else if (_dbus_string_ends_with_c_str (&filename, ".message-raw"))
6353 _dbus_verbose ("Skipping non-.message file %s\n",
6354 _dbus_string_get_const_data (&filename));
6355 _dbus_string_free (&full_path);
6360 _dbus_string_get_const_data (&filename));
6362 _dbus_verbose (" expecting %s for %s\n",
6363 validity == _DBUS_MESSAGE_VALID ? "valid" :
6364 (validity == _DBUS_MESSAGE_INVALID ? "invalid" :
6365 (validity == _DBUS_MESSAGE_INCOMPLETE ? "incomplete" : "unknown")),
6366 _dbus_string_get_const_data (&filename));
6368 if (! (*function) (&full_path, is_raw, validity, user_data))
6370 _dbus_string_free (&full_path);
6374 _dbus_string_free (&full_path);
6377 if (dbus_error_is_set (&error))
6379 _dbus_warn ("Could not get next file in %s: %s\n",
6380 _dbus_string_get_const_data (&test_directory),
6382 dbus_error_free (&error);
6391 _dbus_directory_close (dir);
6392 _dbus_string_free (&test_directory);
6393 _dbus_string_free (&filename);
6399 * Runs the given function on every message file in the test suite.
6400 * The function should return #FALSE on test failure or fatal error.
6402 * @param test_data_dir root dir of the test suite data files (top_srcdir/test/data)
6403 * @param func the function to run
6404 * @param user_data data for function
6405 * @returns #FALSE if there's a failure
6408 dbus_internal_do_not_use_foreach_message_file (const char *test_data_dir,
6409 DBusForeachMessageFileFunc func,
6412 DBusString test_directory;
6417 _dbus_string_init_const (&test_directory, test_data_dir);
6419 if (!process_test_subdir (&test_directory, "valid-messages",
6420 _DBUS_MESSAGE_VALID, func, user_data))
6423 if (!process_test_subdir (&test_directory, "invalid-messages",
6424 _DBUS_MESSAGE_INVALID, func, user_data))
6427 if (!process_test_subdir (&test_directory, "incomplete-messages",
6428 _DBUS_MESSAGE_INCOMPLETE, func, user_data))
6435 _dbus_string_free (&test_directory);
6441 verify_test_message (DBusMessage *message)
6443 DBusMessageIter iter, dict;
6445 dbus_int32_t our_int;
6448 dbus_bool_t our_bool;
6449 dbus_uint32_t our_uint32;
6450 dbus_int32_t *our_uint32_array;
6451 int our_uint32_array_len;
6452 dbus_int32_t *our_int32_array;
6453 int our_int32_array_len;
6454 char **our_string_array;
6455 int our_string_array_len;
6456 #ifdef DBUS_HAVE_INT64
6457 dbus_int64_t our_int64;
6458 dbus_uint64_t our_uint64;
6459 dbus_int64_t *our_uint64_array;
6460 int our_uint64_array_len;
6461 dbus_int64_t *our_int64_array;
6462 int our_int64_array_len;
6464 double *our_double_array;
6465 int our_double_array_len;
6466 unsigned char *our_byte_array;
6467 int our_byte_array_len;
6468 unsigned char *our_boolean_array;
6469 int our_boolean_array_len;
6471 dbus_message_iter_init (message, &iter);
6473 dbus_error_init (&error);
6474 if (!dbus_message_iter_get_args (&iter, &error,
6475 DBUS_TYPE_INT32, &our_int,
6476 #ifdef DBUS_HAVE_INT64
6477 DBUS_TYPE_INT64, &our_int64,
6478 DBUS_TYPE_UINT64, &our_uint64,
6480 DBUS_TYPE_STRING, &our_str,
6481 DBUS_TYPE_DOUBLE, &our_double,
6482 DBUS_TYPE_BOOLEAN, &our_bool,
6483 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32,
6484 &our_uint32_array, &our_uint32_array_len,
6485 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32,
6486 &our_int32_array, &our_int32_array_len,
6487 #ifdef DBUS_HAVE_INT64
6488 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64,
6489 &our_uint64_array, &our_uint64_array_len,
6490 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64,
6491 &our_int64_array, &our_int64_array_len,
6493 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING,
6494 &our_string_array, &our_string_array_len,
6495 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE,
6496 &our_double_array, &our_double_array_len,
6497 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
6498 &our_byte_array, &our_byte_array_len,
6499 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN,
6500 &our_boolean_array, &our_boolean_array_len,
6503 _dbus_warn ("error: %s - %s\n", error.name,
6504 (error.message != NULL) ? error.message : "no message");
6505 _dbus_assert_not_reached ("Could not get arguments");
6508 if (our_int != -0x12345678)
6509 _dbus_assert_not_reached ("integers differ!");
6511 #ifdef DBUS_HAVE_INT64
6512 if (our_int64 != -0x123456789abcd)
6513 _dbus_assert_not_reached ("64-bit integers differ!");
6514 if (our_uint64 != 0x123456789abcd)
6515 _dbus_assert_not_reached ("64-bit unsigned integers differ!");
6518 if (our_double != 3.14159)
6519 _dbus_assert_not_reached ("doubles differ!");
6521 if (strcmp (our_str, "Test string") != 0)
6522 _dbus_assert_not_reached ("strings differ!");
6523 dbus_free (our_str);
6526 _dbus_assert_not_reached ("booleans differ");
6528 if (our_uint32_array_len != 4 ||
6529 our_uint32_array[0] != 0x12345678 ||
6530 our_uint32_array[1] != 0x23456781 ||
6531 our_uint32_array[2] != 0x34567812 ||
6532 our_uint32_array[3] != 0x45678123)
6533 _dbus_assert_not_reached ("uint array differs");
6534 dbus_free (our_uint32_array);
6536 if (our_int32_array_len != 4 ||
6537 our_int32_array[0] != 0x12345678 ||
6538 our_int32_array[1] != -0x23456781 ||
6539 our_int32_array[2] != 0x34567812 ||
6540 our_int32_array[3] != -0x45678123)
6541 _dbus_assert_not_reached ("int array differs");
6542 dbus_free (our_int32_array);
6544 #ifdef DBUS_HAVE_INT64
6545 if (our_uint64_array_len != 4 ||
6546 our_uint64_array[0] != 0x12345678 ||
6547 our_uint64_array[1] != 0x23456781 ||
6548 our_uint64_array[2] != 0x34567812 ||
6549 our_uint64_array[3] != 0x45678123)
6550 _dbus_assert_not_reached ("uint64 array differs");
6551 dbus_free (our_uint64_array);
6553 if (our_int64_array_len != 4 ||
6554 our_int64_array[0] != 0x12345678 ||
6555 our_int64_array[1] != -0x23456781 ||
6556 our_int64_array[2] != 0x34567812 ||
6557 our_int64_array[3] != -0x45678123)
6558 _dbus_assert_not_reached ("int64 array differs");
6559 dbus_free (our_int64_array);
6560 #endif /* DBUS_HAVE_INT64 */
6562 if (our_string_array_len != 4)
6563 _dbus_assert_not_reached ("string array has wrong length");
6565 if (strcmp (our_string_array[0], "Foo") != 0 ||
6566 strcmp (our_string_array[1], "bar") != 0 ||
6567 strcmp (our_string_array[2], "") != 0 ||
6568 strcmp (our_string_array[3], "woo woo woo woo") != 0)
6569 _dbus_assert_not_reached ("string array differs");
6571 dbus_free_string_array (our_string_array);
6573 if (our_double_array_len != 3)
6574 _dbus_assert_not_reached ("double array had wrong length");
6576 /* On all IEEE machines (i.e. everything sane) exact equality
6577 * should be preserved over the wire
6579 if (our_double_array[0] != 0.1234 ||
6580 our_double_array[1] != 9876.54321 ||
6581 our_double_array[2] != -300.0)
6582 _dbus_assert_not_reached ("double array had wrong values");
6584 dbus_free (our_double_array);
6586 if (our_byte_array_len != 4)
6587 _dbus_assert_not_reached ("byte array had wrong length");
6589 if (our_byte_array[0] != 'a' ||
6590 our_byte_array[1] != 'b' ||
6591 our_byte_array[2] != 'c' ||
6592 our_byte_array[3] != 234)
6593 _dbus_assert_not_reached ("byte array had wrong values");
6595 dbus_free (our_byte_array);
6597 if (our_boolean_array_len != 5)
6598 _dbus_assert_not_reached ("bool array had wrong length");
6600 if (our_boolean_array[0] != TRUE ||
6601 our_boolean_array[1] != FALSE ||
6602 our_boolean_array[2] != TRUE ||
6603 our_boolean_array[3] != TRUE ||
6604 our_boolean_array[4] != FALSE)
6605 _dbus_assert_not_reached ("bool array had wrong values");
6607 dbus_free (our_boolean_array);
6609 if (!dbus_message_iter_next (&iter))
6610 _dbus_assert_not_reached ("Reached end of arguments");
6612 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_DICT)
6613 _dbus_assert_not_reached ("not dict type");
6615 dbus_message_iter_init_dict_iterator (&iter, &dict);
6617 our_str = dbus_message_iter_get_dict_key (&dict);
6618 if (our_str == NULL || strcmp (our_str, "test") != 0)
6619 _dbus_assert_not_reached ("wrong dict key");
6620 dbus_free (our_str);
6622 if (dbus_message_iter_get_arg_type (&dict) != DBUS_TYPE_UINT32)
6624 _dbus_verbose ("dict entry type: %d\n", dbus_message_iter_get_arg_type (&dict));
6625 _dbus_assert_not_reached ("wrong dict entry type");
6628 if ((our_uint32 = dbus_message_iter_get_uint32 (&dict)) != 0xDEADBEEF)
6630 _dbus_verbose ("dict entry val: %x\n", our_uint32);
6631 _dbus_assert_not_reached ("wrong dict entry value");
6634 if (dbus_message_iter_next (&dict))
6635 _dbus_assert_not_reached ("Didn't reach end of dict");
6637 if (!dbus_message_iter_next (&iter))
6638 _dbus_assert_not_reached ("Reached end of arguments");
6640 if (dbus_message_iter_get_arg_type (&iter) != DBUS_TYPE_UINT32)
6641 _dbus_assert_not_reached ("wrong type after dict");
6643 if (dbus_message_iter_get_uint32 (&iter) != 0xCAFEBABE)
6644 _dbus_assert_not_reached ("wrong value after dict");
6646 if (dbus_message_iter_next (&iter))
6647 _dbus_assert_not_reached ("Didn't reach end of arguments");
6651 * @ingroup DBusMessageInternals
6652 * Unit test for DBusMessage.
6654 * @returns #TRUE on success.
6657 _dbus_message_test (const char *test_data_dir)
6659 DBusMessage *message;
6660 DBusMessageLoader *loader;
6661 DBusMessageIter iter, child_iter, child_iter2, child_iter3;
6667 const dbus_uint32_t our_uint32_array[] =
6668 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6669 const dbus_uint32_t our_int32_array[] =
6670 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6671 #ifdef DBUS_HAVE_INT64
6672 const dbus_uint64_t our_uint64_array[] =
6673 { 0x12345678, 0x23456781, 0x34567812, 0x45678123 };
6674 const dbus_uint64_t our_int64_array[] =
6675 { 0x12345678, -0x23456781, 0x34567812, -0x45678123 };
6677 const char *our_string_array[] = { "Foo", "bar", "", "woo woo woo woo" };
6678 const double our_double_array[] = { 0.1234, 9876.54321, -300.0 };
6679 const unsigned char our_byte_array[] = { 'a', 'b', 'c', 234 };
6680 const unsigned char our_boolean_array[] = { TRUE, FALSE, TRUE, TRUE, FALSE };
6684 _dbus_assert (sizeof (DBusMessageRealIter) <= sizeof (DBusMessageIter));
6686 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6687 "/org/freedesktop/TestPath",
6688 "Foo.TestInterface",
6690 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6691 _dbus_assert (dbus_message_is_method_call (message, "Foo.TestInterface",
6693 _dbus_assert (strcmp (dbus_message_get_path (message),
6694 "/org/freedesktop/TestPath") == 0);
6695 _dbus_message_set_serial (message, 1234);
6696 /* string length including nul byte not a multiple of 4 */
6697 if (!dbus_message_set_sender (message, "org.foo.bar1"))
6698 _dbus_assert_not_reached ("out of memory");
6699 _dbus_assert (dbus_message_has_sender (message, "org.foo.bar1"));
6700 dbus_message_set_reply_serial (message, 5678);
6701 if (!dbus_message_set_sender (message, NULL))
6702 _dbus_assert_not_reached ("out of memory");
6703 _dbus_assert (!dbus_message_has_sender (message, "org.foo.bar1"));
6704 _dbus_assert (dbus_message_get_serial (message) == 1234);
6705 _dbus_assert (dbus_message_get_reply_serial (message) == 5678);
6706 _dbus_assert (dbus_message_has_destination (message, "org.freedesktop.DBus.TestService"));
6708 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6709 dbus_message_set_no_reply (message, TRUE);
6710 _dbus_assert (dbus_message_get_no_reply (message) == TRUE);
6711 dbus_message_set_no_reply (message, FALSE);
6712 _dbus_assert (dbus_message_get_no_reply (message) == FALSE);
6715 /* Set/get some header fields */
6717 if (!dbus_message_set_path (message, "/foo"))
6718 _dbus_assert_not_reached ("out of memory");
6719 _dbus_assert (strcmp (dbus_message_get_path (message),
6722 if (!dbus_message_set_interface (message, "org.Foo"))
6723 _dbus_assert_not_reached ("out of memory");
6724 _dbus_assert (strcmp (dbus_message_get_interface (message),
6727 if (!dbus_message_set_member (message, "Bar"))
6728 _dbus_assert_not_reached ("out of memory");
6729 _dbus_assert (strcmp (dbus_message_get_member (message),
6732 /* Set/get them with longer values */
6733 if (!dbus_message_set_path (message, "/foo/bar"))
6734 _dbus_assert_not_reached ("out of memory");
6735 _dbus_assert (strcmp (dbus_message_get_path (message),
6738 if (!dbus_message_set_interface (message, "org.Foo.Bar"))
6739 _dbus_assert_not_reached ("out of memory");
6740 _dbus_assert (strcmp (dbus_message_get_interface (message),
6741 "org.Foo.Bar") == 0);
6743 if (!dbus_message_set_member (message, "BarFoo"))
6744 _dbus_assert_not_reached ("out of memory");
6745 _dbus_assert (strcmp (dbus_message_get_member (message),
6748 /* Realloc shorter again */
6750 if (!dbus_message_set_path (message, "/foo"))
6751 _dbus_assert_not_reached ("out of memory");
6752 _dbus_assert (strcmp (dbus_message_get_path (message),
6755 if (!dbus_message_set_interface (message, "org.Foo"))
6756 _dbus_assert_not_reached ("out of memory");
6757 _dbus_assert (strcmp (dbus_message_get_interface (message),
6760 if (!dbus_message_set_member (message, "Bar"))
6761 _dbus_assert_not_reached ("out of memory");
6762 _dbus_assert (strcmp (dbus_message_get_member (message),
6766 dbus_message_unref (message);
6768 /* Test the vararg functions */
6769 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6770 "/org/freedesktop/TestPath",
6771 "Foo.TestInterface",
6773 _dbus_message_set_serial (message, 1);
6774 dbus_message_append_args (message,
6775 DBUS_TYPE_INT32, -0x12345678,
6776 #ifdef DBUS_HAVE_INT64
6777 DBUS_TYPE_INT64, -0x123456789abcd,
6778 DBUS_TYPE_UINT64, 0x123456789abcd,
6780 DBUS_TYPE_STRING, "Test string",
6781 DBUS_TYPE_DOUBLE, 3.14159,
6782 DBUS_TYPE_BOOLEAN, TRUE,
6783 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT32, our_uint32_array,
6784 _DBUS_N_ELEMENTS (our_uint32_array),
6785 DBUS_TYPE_ARRAY, DBUS_TYPE_INT32, our_int32_array,
6786 _DBUS_N_ELEMENTS (our_int32_array),
6787 #ifdef DBUS_HAVE_INT64
6788 DBUS_TYPE_ARRAY, DBUS_TYPE_UINT64, our_uint64_array,
6789 _DBUS_N_ELEMENTS (our_uint64_array),
6790 DBUS_TYPE_ARRAY, DBUS_TYPE_INT64, our_int64_array,
6791 _DBUS_N_ELEMENTS (our_int64_array),
6793 DBUS_TYPE_ARRAY, DBUS_TYPE_STRING, our_string_array,
6794 _DBUS_N_ELEMENTS (our_string_array),
6795 DBUS_TYPE_ARRAY, DBUS_TYPE_DOUBLE, our_double_array,
6796 _DBUS_N_ELEMENTS (our_double_array),
6797 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE, our_byte_array,
6798 _DBUS_N_ELEMENTS (our_byte_array),
6799 DBUS_TYPE_ARRAY, DBUS_TYPE_BOOLEAN, our_boolean_array,
6800 _DBUS_N_ELEMENTS (our_boolean_array),
6803 dbus_message_append_iter_init (message, &iter);
6804 dbus_message_iter_append_dict (&iter, &child_iter);
6805 dbus_message_iter_append_dict_key (&child_iter, "test");
6806 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6807 dbus_message_iter_append_uint32 (&iter, 0xCAFEBABE);
6810 sig[i++] = DBUS_TYPE_INT32;
6811 #ifdef DBUS_HAVE_INT64
6812 sig[i++] = DBUS_TYPE_INT64;
6813 sig[i++] = DBUS_TYPE_UINT64;
6815 sig[i++] = DBUS_TYPE_STRING;
6816 sig[i++] = DBUS_TYPE_DOUBLE;
6817 sig[i++] = DBUS_TYPE_BOOLEAN;
6818 sig[i++] = DBUS_TYPE_ARRAY;
6819 sig[i++] = DBUS_TYPE_UINT32;
6820 sig[i++] = DBUS_TYPE_ARRAY;
6821 sig[i++] = DBUS_TYPE_INT32;
6822 #ifdef DBUS_HAVE_INT64
6823 sig[i++] = DBUS_TYPE_ARRAY;
6824 sig[i++] = DBUS_TYPE_UINT64;
6825 sig[i++] = DBUS_TYPE_ARRAY;
6826 sig[i++] = DBUS_TYPE_INT64;
6828 sig[i++] = DBUS_TYPE_ARRAY;
6829 sig[i++] = DBUS_TYPE_STRING;
6830 sig[i++] = DBUS_TYPE_ARRAY;
6831 sig[i++] = DBUS_TYPE_DOUBLE;
6832 sig[i++] = DBUS_TYPE_ARRAY;
6833 sig[i++] = DBUS_TYPE_BYTE;
6834 sig[i++] = DBUS_TYPE_ARRAY;
6835 sig[i++] = DBUS_TYPE_BOOLEAN;
6836 sig[i++] = DBUS_TYPE_DICT;
6837 sig[i++] = DBUS_TYPE_UINT32;
6838 sig[i++] = DBUS_TYPE_INVALID;
6840 _dbus_assert (i < (int) _DBUS_N_ELEMENTS (sig));
6842 _dbus_verbose_bytes_of_string (&message->header, 0,
6843 _dbus_string_get_length (&message->header));
6844 _dbus_verbose_bytes_of_string (&message->body, 0,
6845 _dbus_string_get_length (&message->body));
6847 _dbus_verbose ("Signature expected \"%s\" actual \"%s\"\n",
6848 sig, dbus_message_get_signature (message));
6850 s = dbus_message_get_signature (message);
6852 _dbus_assert (dbus_message_has_signature (message, sig));
6853 _dbus_assert (strcmp (s, sig) == 0);
6855 verify_test_message (message);
6857 copy = dbus_message_copy (message);
6859 _dbus_assert (message->client_serial == copy->client_serial);
6860 _dbus_assert (message->reply_serial == copy->reply_serial);
6861 _dbus_assert (message->header_padding == copy->header_padding);
6863 _dbus_assert (_dbus_string_get_length (&message->header) ==
6864 _dbus_string_get_length (©->header));
6866 _dbus_assert (_dbus_string_get_length (&message->body) ==
6867 _dbus_string_get_length (©->body));
6869 _dbus_assert (_dbus_string_get_length (&message->signature) ==
6870 _dbus_string_get_length (©->signature));
6872 verify_test_message (copy);
6874 name1 = dbus_message_get_interface (message);
6875 name2 = dbus_message_get_interface (copy);
6877 _dbus_assert (strcmp (name1, name2) == 0);
6879 name1 = dbus_message_get_member (message);
6880 name2 = dbus_message_get_member (copy);
6882 _dbus_assert (strcmp (name1, name2) == 0);
6884 dbus_message_unref (message);
6885 dbus_message_unref (copy);
6887 message = dbus_message_new_method_call ("org.freedesktop.DBus.TestService",
6888 "/org/freedesktop/TestPath",
6889 "Foo.TestInterface",
6892 _dbus_message_set_serial (message, 1);
6893 dbus_message_set_reply_serial (message, 0x12345678);
6895 dbus_message_append_iter_init (message, &iter);
6896 dbus_message_iter_append_string (&iter, "Test string");
6897 dbus_message_iter_append_int32 (&iter, -0x12345678);
6898 dbus_message_iter_append_uint32 (&iter, 0xedd1e);
6899 dbus_message_iter_append_double (&iter, 3.14159);
6901 dbus_message_iter_append_array (&iter, &child_iter, DBUS_TYPE_DOUBLE);
6902 dbus_message_iter_append_double (&child_iter, 1.5);
6903 dbus_message_iter_append_double (&child_iter, 2.5);
6906 dbus_message_iter_append_dict (&iter, &child_iter);
6907 dbus_message_iter_append_dict_key (&child_iter, "test");
6908 dbus_message_iter_append_uint32 (&child_iter, 0xDEADBEEF);
6910 /* array of array of int32 (in dict) */
6911 dbus_message_iter_append_dict_key (&child_iter, "array");
6912 dbus_message_iter_append_array (&child_iter, &child_iter2, DBUS_TYPE_ARRAY);
6913 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6914 dbus_message_iter_append_int32 (&child_iter3, 0x12345678);
6915 dbus_message_iter_append_int32 (&child_iter3, 0x23456781);
6916 _dbus_warn ("next call expected to fail with wrong array type\n");
6917 _dbus_assert (!dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_UINT32));
6918 dbus_message_iter_append_array (&child_iter2, &child_iter3, DBUS_TYPE_INT32);
6919 dbus_message_iter_append_int32 (&child_iter3, 0x34567812);
6920 dbus_message_iter_append_int32 (&child_iter3, 0x45678123);
6921 dbus_message_iter_append_int32 (&child_iter3, 0x56781234);
6923 dbus_message_iter_append_byte (&iter, 0xF0);
6925 dbus_message_iter_append_nil (&iter);
6927 dbus_message_iter_append_named (&iter, "named",
6930 message_iter_test (message);
6932 /* Message loader test */
6933 _dbus_message_lock (message);
6934 loader = _dbus_message_loader_new ();
6936 /* check ref/unref */
6937 _dbus_message_loader_ref (loader);
6938 _dbus_message_loader_unref (loader);
6940 /* Write the header data one byte at a time */
6941 data = _dbus_string_get_const_data (&message->header);
6942 for (i = 0; i < _dbus_string_get_length (&message->header); i++)
6946 _dbus_message_loader_get_buffer (loader, &buffer);
6947 _dbus_string_append_byte (buffer, data[i]);
6948 _dbus_message_loader_return_buffer (loader, buffer, 1);
6951 /* Write the body data one byte at a time */
6952 data = _dbus_string_get_const_data (&message->body);
6953 for (i = 0; i < _dbus_string_get_length (&message->body); i++)
6957 _dbus_message_loader_get_buffer (loader, &buffer);
6958 _dbus_string_append_byte (buffer, data[i]);
6959 _dbus_message_loader_return_buffer (loader, buffer, 1);
6962 dbus_message_unref (message);
6964 /* Now pop back the message */
6965 if (!_dbus_message_loader_queue_messages (loader))
6966 _dbus_assert_not_reached ("no memory to queue messages");
6968 if (_dbus_message_loader_get_is_corrupted (loader))
6969 _dbus_assert_not_reached ("message loader corrupted");
6971 message = _dbus_message_loader_pop_message (loader);
6973 _dbus_assert_not_reached ("received a NULL message");
6975 if (dbus_message_get_reply_serial (message) != 0x12345678)
6976 _dbus_assert_not_reached ("reply serial fields differ");
6978 message_iter_test (message);
6980 dbus_message_unref (message);
6981 _dbus_message_loader_unref (loader);
6983 /* Now load every message in test_data_dir if we have one */
6984 if (test_data_dir == NULL)
6987 return dbus_internal_do_not_use_foreach_message_file (test_data_dir,
6988 (DBusForeachMessageFileFunc)
6989 dbus_internal_do_not_use_try_message_file,
6993 #endif /* DBUS_BUILD_TESTS */