1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-message-builder.c Build messages from text files for testing (internal to D-BUS implementation)
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 1.2
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #ifdef DBUS_BUILD_TESTS
27 #include "dbus-message-builder.h"
28 #include "dbus-hash.h"
29 #include "dbus-internals.h"
30 #include "dbus-marshal.h"
33 * @defgroup DBusMessageBuilder code for loading test message data
34 * @ingroup DBusInternals
35 * @brief code for loading up test data for unit tests
37 * The code in here is used for unit testing, it loads
38 * up message data from a description in a file.
46 int start; /**< Calculate length since here */
47 int length; /**< length to write */
48 int offset; /**< where to write it into the data */
49 int endian; /**< endianness to write with */
53 free_saved_length (void *data)
55 SavedLength *sl = data;
58 return; /* all hash free functions have to accept NULL */
60 _dbus_string_free (&sl->name);
65 ensure_saved_length (DBusHashTable *hash,
66 const DBusString *name)
71 s = _dbus_string_get_const_data (name);
73 sl = _dbus_hash_table_lookup_string (hash, s);
77 sl = dbus_new0 (SavedLength, 1);
79 if (!_dbus_string_init (&sl->name))
85 if (!_dbus_string_copy (name, 0, &sl->name, 0))
88 s = _dbus_string_get_const_data (&sl->name);
90 if (!_dbus_hash_table_insert_string (hash, (char*)s, sl))
101 free_saved_length (sl);
106 save_start (DBusHashTable *hash,
107 const DBusString *name,
112 sl = ensure_saved_length (hash, name);
116 else if (sl->start >= 0)
118 _dbus_warn ("Same START_LENGTH given twice\n");
128 save_length (DBusHashTable *hash,
129 const DBusString *name,
134 sl = ensure_saved_length (hash, name);
138 else if (sl->length >= 0)
140 _dbus_warn ("Same END_LENGTH given twice\n");
150 save_offset (DBusHashTable *hash,
151 const DBusString *name,
157 sl = ensure_saved_length (hash, name);
161 else if (sl->offset >= 0)
163 _dbus_warn ("Same LENGTH given twice\n");
175 /** Saves the segment to delete in order to unalign the next item */
176 #define SAVE_FOR_UNALIGN(str, boundary) \
177 int align_pad_start = _dbus_string_get_length (str); \
178 int align_pad_end = _DBUS_ALIGN_VALUE (align_pad_start, (boundary))
180 /** Deletes the alignment padding */
181 #define PERFORM_UNALIGN(str) \
184 _dbus_string_delete ((str), align_pad_start, \
185 align_pad_end - align_pad_start); \
191 append_quoted_string (DBusString *dest,
192 const DBusString *quoted,
196 dbus_bool_t in_quotes = FALSE;
199 /* FIXME: We might want to add escaping in case we want to put '
200 * characters in our strings.
204 while (i < _dbus_string_get_length (quoted))
208 b = _dbus_string_get_byte (quoted, i);
216 if (!_dbus_string_append_byte (dest, b))
224 else if (b == ' ' || b == '\n' || b == '\t')
225 break; /* end on whitespace if not quoted */
228 if (!_dbus_string_append_byte (dest, b))
239 if (!_dbus_string_append_byte (dest, '\0'))
245 append_saved_length (DBusString *dest,
246 DBusHashTable *length_hash,
247 const DBusString *name,
251 if (!save_offset (length_hash, name,
254 _dbus_warn ("failed to save offset to LENGTH\n");
258 if (!_dbus_marshal_uint32 (dest, endian,
261 _dbus_warn ("failed to append a length\n");
269 * Reads the given filename, which should be in "message description
270 * language" (look at some examples), and builds up the message data
271 * from it. The message data may be invalid, or valid.
273 * The parser isn't very strict, it's just a hack for test programs.
275 * The file format is:
277 * VALID_HEADER normal header; byte order, padding, header len, body len, serial
278 * BIG_ENDIAN switch to big endian
279 * LITTLE_ENDIAN switch to little endian
280 * OPPOSITE_ENDIAN switch to opposite endian
281 * ALIGN <N> aligns to the given value
282 * UNALIGN skips alignment for the next marshal
283 * BYTE <N> inserts the given integer in [0,255] or char in 'a' format
284 * START_LENGTH <name> marks the start of a length to measure
285 * END_LENGTH <name> records the length since START_LENGTH under the given name
286 * (or if no START_LENGTH, absolute length)
287 * LENGTH <name> inserts the saved length of the same name
288 * CHOP <N> chops last N bytes off the data
289 * FIELD_NAME <abcd> inserts 4-byte field name
290 * TYPE <typename> inserts a typecode byte
293 * Following commands insert aligned data unless
294 * preceded by "UNALIGN":
296 * INT32 <N> marshals an INT32
297 * UINT32 <N> marshals a UINT32
298 * DOUBLE <N> marshals a double
299 * STRING 'Foo' marshals a string
300 * INT32_ARRAY { 3, 4, 5, 6} marshals an INT32 array
301 * UINT32_ARRAY { 3, 4, 5, 6} marshals an UINT32 array
302 * DOUBLE_ARRAY { 1.0, 2.0, 3.0, 4.0} marshals a DOUBLE array
305 * @todo add support for array types INT32_ARRAY { 3, 4, 5, 6 }
308 * @param dest the string to append the message data to
309 * @param filename the filename to load
310 * @returns #TRUE on success
313 _dbus_message_data_load (DBusString *dest,
314 const DBusString *filename)
322 DBusHashTable *length_hash;
329 if (!_dbus_string_init (&file))
332 if (!_dbus_string_init (&line))
334 _dbus_string_free (&file);
338 _dbus_verbose ("Loading %s\n", _dbus_string_get_const_data (filename));
340 dbus_error_init (&error);
341 if (!_dbus_file_get_contents (&file, filename, &error))
343 _dbus_warn ("Getting contents of %s failed: %s\n",
344 _dbus_string_get_const_data (filename), error.message);
345 dbus_error_free (&error);
349 length_hash = _dbus_hash_table_new (DBUS_HASH_STRING,
352 if (length_hash == NULL)
355 endian = DBUS_COMPILER_BYTE_ORDER;
359 while (_dbus_string_pop_line (&file, &line))
361 dbus_bool_t just_set_unalign;
363 just_set_unalign = FALSE;
366 _dbus_string_delete_leading_blanks (&line);
368 if (_dbus_string_get_length (&line) == 0)
373 else if (_dbus_string_starts_with_c_str (&line,
376 /* Ignore this comment */
379 else if (_dbus_string_starts_with_c_str (&line,
385 if (!_dbus_string_append_byte (dest, endian))
387 _dbus_warn ("could not append endianness\n");
394 if (!_dbus_string_append_byte (dest, '\0'))
396 _dbus_warn ("could not append nul pad\n");
402 _dbus_string_init_const (&name, "Header");
403 if (!append_saved_length (dest, length_hash,
404 &name, _dbus_string_get_length (dest),
408 _dbus_string_init_const (&name, "Body");
409 if (!append_saved_length (dest, length_hash,
410 &name, _dbus_string_get_length (dest),
415 if (!_dbus_marshal_int32 (dest, endian, 1))
417 _dbus_warn ("couldn't append client serial\n");
421 else if (_dbus_string_starts_with_c_str (&line,
424 endian = DBUS_BIG_ENDIAN;
426 else if (_dbus_string_starts_with_c_str (&line,
429 endian = DBUS_LITTLE_ENDIAN;
431 else if (_dbus_string_starts_with_c_str (&line,
434 if (endian == DBUS_BIG_ENDIAN)
435 endian = DBUS_LITTLE_ENDIAN;
437 endian = DBUS_BIG_ENDIAN;
439 else if (_dbus_string_starts_with_c_str (&line,
446 _dbus_string_delete_first_word (&line);
448 if (!_dbus_string_parse_int (&line, 0, &val, &end))
450 _dbus_warn ("Failed to parse integer\n");
456 _dbus_warn ("Aligning to %ld boundary is crack\n",
461 orig_len = _dbus_string_get_length (dest);
463 if (!_dbus_string_align_length (dest, val))
466 if (_dbus_string_parse_int (&line, end, &val, NULL))
468 /* If there's an optional second int argument,
469 * fill in align padding with that value
471 if (val < 0 || val > 255)
473 _dbus_warn ("can't fill align padding with %ld, must be a byte value\n", val);
478 while (end < _dbus_string_get_length (dest))
480 _dbus_string_set_byte (dest, end, val);
485 else if (_dbus_string_starts_with_c_str (&line, "UNALIGN"))
488 just_set_unalign = TRUE;
490 else if (_dbus_string_starts_with_c_str (&line, "CHOP"))
494 /* FIXME if you CHOP the offset for a LENGTH
495 * command, we segfault.
498 _dbus_string_delete_first_word (&line);
500 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
502 _dbus_warn ("Failed to parse integer to chop\n");
506 if (val > _dbus_string_get_length (dest))
508 _dbus_warn ("Trying to chop %ld bytes but we only have %d\n",
510 _dbus_string_get_length (dest));
514 _dbus_string_shorten (dest, val);
516 else if (_dbus_string_starts_with_c_str (&line, "BYTE"))
518 unsigned char the_byte;
520 _dbus_string_delete_first_word (&line);
522 if (_dbus_string_equal_c_str (&line, "'\\''"))
524 else if (_dbus_string_get_byte (&line, 0) == '\'' &&
525 _dbus_string_get_length (&line) >= 3 &&
526 _dbus_string_get_byte (&line, 2) == '\'')
527 the_byte = _dbus_string_get_byte (&line, 1);
531 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
533 _dbus_warn ("Failed to parse integer for BYTE\n");
539 _dbus_warn ("A byte must be in range 0-255 not %ld\n",
543 the_byte = (unsigned char) val;
546 _dbus_string_append_byte (dest, the_byte);
548 else if (_dbus_string_starts_with_c_str (&line,
551 _dbus_string_delete_first_word (&line);
553 if (!save_start (length_hash, &line,
554 _dbus_string_get_length (dest)))
556 _dbus_warn ("failed to save length start\n");
560 else if (_dbus_string_starts_with_c_str (&line,
563 _dbus_string_delete_first_word (&line);
565 if (!save_length (length_hash, &line,
566 _dbus_string_get_length (dest)))
568 _dbus_warn ("failed to save length end\n");
572 else if (_dbus_string_starts_with_c_str (&line,
575 SAVE_FOR_UNALIGN (dest, 4);
577 _dbus_string_delete_first_word (&line);
579 if (!append_saved_length (dest, length_hash,
581 unalign ? align_pad_start : align_pad_end,
584 _dbus_warn ("failed to add LENGTH\n");
588 PERFORM_UNALIGN (dest);
590 else if (_dbus_string_starts_with_c_str (&line,
593 _dbus_string_delete_first_word (&line);
595 if (_dbus_string_get_length (&line) != 4)
597 _dbus_warn ("Field name must be four characters not \"%s\"\n",
598 _dbus_string_get_const_data (&line));
605 _dbus_string_align_length (dest, 4);
607 if (!_dbus_string_copy (&line, 0, dest,
608 _dbus_string_get_length (dest)))
611 else if (_dbus_string_starts_with_c_str (&line,
616 _dbus_string_delete_first_word (&line);
618 if (_dbus_string_starts_with_c_str (&line, "INVALID"))
619 code = DBUS_TYPE_INVALID;
620 else if (_dbus_string_starts_with_c_str (&line, "NIL"))
621 code = DBUS_TYPE_NIL;
622 else if (_dbus_string_starts_with_c_str (&line, "BOOLEAN_ARRAY"))
623 code = DBUS_TYPE_BOOLEAN_ARRAY;
624 else if (_dbus_string_starts_with_c_str (&line, "INT32_ARRAY"))
625 code = DBUS_TYPE_INT32_ARRAY;
626 else if (_dbus_string_starts_with_c_str (&line, "UINT32_ARRAY"))
627 code = DBUS_TYPE_UINT32_ARRAY;
628 else if (_dbus_string_starts_with_c_str (&line, "DOUBLE_ARRAY"))
629 code = DBUS_TYPE_DOUBLE_ARRAY;
630 else if (_dbus_string_starts_with_c_str (&line, "BYTE_ARRAY"))
631 code = DBUS_TYPE_BYTE_ARRAY;
632 else if (_dbus_string_starts_with_c_str (&line, "STRING_ARRAY"))
633 code = DBUS_TYPE_STRING_ARRAY;
634 else if (_dbus_string_starts_with_c_str (&line, "BOOLEAN"))
635 code = DBUS_TYPE_BOOLEAN;
636 else if (_dbus_string_starts_with_c_str (&line, "INT32"))
637 code = DBUS_TYPE_INT32;
638 else if (_dbus_string_starts_with_c_str (&line, "UINT32"))
639 code = DBUS_TYPE_UINT32;
640 else if (_dbus_string_starts_with_c_str (&line, "DOUBLE"))
641 code = DBUS_TYPE_DOUBLE;
642 else if (_dbus_string_starts_with_c_str (&line, "STRING"))
643 code = DBUS_TYPE_STRING;
644 else if (_dbus_string_starts_with_c_str (&line, "DICT"))
645 code = DBUS_TYPE_DICT;
648 _dbus_warn ("%s is not a valid type name\n", _dbus_string_get_const_data (&line));
652 if (!_dbus_string_append_byte (dest, code))
654 _dbus_warn ("could not append typecode byte\n");
658 else if (_dbus_string_starts_with_c_str (&line,
661 SAVE_FOR_UNALIGN (dest, 4);
662 int i, len, allocated;
663 unsigned char *values;
664 unsigned char b, val;
667 values = dbus_new (unsigned char, allocated);
670 _dbus_warn ("could not allocate memory for BOOLEAN_ARRAY\n");
676 _dbus_string_delete_first_word (&line);
677 _dbus_string_skip_blank (&line, 0, &i);
678 b = _dbus_string_get_byte (&line, i++);
683 while (i < _dbus_string_get_length (&line))
685 _dbus_string_skip_blank (&line, i, &i);
687 if (_dbus_string_find_to (&line, i, i + 5,
693 else if (_dbus_string_find_to (&line, i, i + 4,
701 _dbus_warn ("could not parse BOOLEAN_ARRAY\n");
706 if (len == allocated)
709 values = dbus_realloc (values, allocated * sizeof (unsigned char));
712 _dbus_warn ("could not allocate memory for BOOLEAN_ARRAY\n");
717 _dbus_string_skip_blank (&line, i, &i);
719 b = _dbus_string_get_byte (&line, i++);
727 if (!_dbus_marshal_int32 (dest, endian, len) ||
728 !_dbus_string_append_len (dest, values, len))
730 _dbus_warn ("failed to append BOOLEAN_ARRAY\n");
735 PERFORM_UNALIGN (dest);
737 else if (_dbus_string_starts_with_c_str (&line,
740 SAVE_FOR_UNALIGN (dest, 4);
741 int i, len, allocated;
742 dbus_int32_t *values;
747 values = dbus_new (dbus_int32_t, allocated);
750 _dbus_warn ("could not allocate memory for INT32_ARRAY\n");
756 _dbus_string_delete_first_word (&line);
757 _dbus_string_skip_blank (&line, 0, &i);
758 b = _dbus_string_get_byte (&line, i++);
763 while (i < _dbus_string_get_length (&line))
765 _dbus_string_skip_blank (&line, i, &i);
767 if (!_dbus_string_parse_int (&line, i, &val, &i))
769 _dbus_warn ("could not parse integer for INT32_ARRAY\n");
774 if (len == allocated)
777 values = dbus_realloc (values, allocated * sizeof (dbus_int32_t));
780 _dbus_warn ("could not allocate memory for INT32_ARRAY\n");
785 _dbus_string_skip_blank (&line, i, &i);
787 b = _dbus_string_get_byte (&line, i++);
795 if (!_dbus_marshal_int32_array (dest, endian, values, len))
797 _dbus_warn ("failed to append INT32_ARRAY\n");
802 PERFORM_UNALIGN (dest);
804 else if (_dbus_string_starts_with_c_str (&line,
807 SAVE_FOR_UNALIGN (dest, 4);
808 int i, len, allocated;
809 dbus_uint32_t *values;
814 values = dbus_new (dbus_uint32_t, allocated);
817 _dbus_warn ("could not allocate memory for UINT32_ARRAY\n");
823 _dbus_string_delete_first_word (&line);
824 _dbus_string_skip_blank (&line, 0, &i);
825 b = _dbus_string_get_byte (&line, i++);
830 while (i < _dbus_string_get_length (&line))
832 _dbus_string_skip_blank (&line, i, &i);
834 if (!_dbus_string_parse_int (&line, i, &val, &i))
836 _dbus_warn ("could not parse integer for UINT32_ARRAY\n");
841 if (len == allocated)
844 values = dbus_realloc (values, allocated * sizeof (dbus_uint32_t));
847 _dbus_warn ("could not allocate memory for UINT32_ARRAY\n");
852 _dbus_string_skip_blank (&line, i, &i);
854 b = _dbus_string_get_byte (&line, i++);
862 if (!_dbus_marshal_uint32_array (dest, endian, values, len))
864 _dbus_warn ("failed to append UINT32_ARRAY\n");
869 PERFORM_UNALIGN (dest);
871 else if (_dbus_string_starts_with_c_str (&line,
874 SAVE_FOR_UNALIGN (dest, 8);
875 int i, len, allocated;
881 values = dbus_new (double, allocated);
884 _dbus_warn ("could not allocate memory for DOUBLE_ARRAY\n");
890 _dbus_string_delete_first_word (&line);
891 _dbus_string_skip_blank (&line, 0, &i);
892 b = _dbus_string_get_byte (&line, i++);
897 while (i < _dbus_string_get_length (&line))
899 _dbus_string_skip_blank (&line, i, &i);
901 if (!_dbus_string_parse_double (&line, i, &val, &i))
903 _dbus_warn ("could not parse double for DOUBLE_ARRAY\n");
908 if (len == allocated)
911 values = dbus_realloc (values, allocated * sizeof (double));
914 _dbus_warn ("could not allocate memory for DOUBLE_ARRAY\n");
919 _dbus_string_skip_blank (&line, i, &i);
921 b = _dbus_string_get_byte (&line, i++);
929 if (!_dbus_marshal_double_array (dest, endian, values, len))
931 _dbus_warn ("failed to append DOUBLE_ARRAY\n");
936 PERFORM_UNALIGN (dest);
938 else if (_dbus_string_starts_with_c_str (&line,
941 SAVE_FOR_UNALIGN (dest, 4);
942 int i, len, allocated;
949 values = dbus_new (char *, allocated);
952 _dbus_warn ("could not allocate memory for DOUBLE_ARRAY\n");
958 _dbus_string_delete_first_word (&line);
959 _dbus_string_skip_blank (&line, 0, &i);
960 b = _dbus_string_get_byte (&line, i++);
965 _dbus_string_init (&val_str);
966 while (i < _dbus_string_get_length (&line))
968 _dbus_string_skip_blank (&line, i, &i);
970 if (!append_quoted_string (&val_str, &line, i, &i))
972 _dbus_warn ("could not parse quoted string for STRING_ARRAY\n");
977 if (!_dbus_string_steal_data (&val_str, &val))
979 _dbus_warn ("could not allocate memory for STRING_ARRAY string\n");
984 if (len == allocated)
987 values = dbus_realloc (values, allocated * sizeof (char *));
990 _dbus_warn ("could not allocate memory for STRING_ARRAY\n");
995 _dbus_string_skip_blank (&line, i, &i);
997 b = _dbus_string_get_byte (&line, i++);
1003 _dbus_warn ("missing comma when parsing STRING_ARRAY\n");
1007 _dbus_string_free (&val_str);
1009 if (!_dbus_marshal_string_array (dest, endian, (const char **)values, len))
1011 _dbus_warn ("failed to append STRING_ARRAY\n");
1016 dbus_free_string_array (values);
1018 PERFORM_UNALIGN (dest);
1020 else if (_dbus_string_starts_with_c_str (&line,
1025 _dbus_string_delete_first_word (&line);
1027 if (_dbus_string_starts_with_c_str (&line, "true"))
1029 else if (_dbus_string_starts_with_c_str (&line, "false"))
1033 _dbus_warn ("could not parse BOOLEAN\n");
1036 if (!_dbus_string_append_byte (dest, val))
1038 _dbus_warn ("failed to append BOOLEAN\n");
1043 else if (_dbus_string_starts_with_c_str (&line,
1046 SAVE_FOR_UNALIGN (dest, 4);
1049 _dbus_string_delete_first_word (&line);
1051 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
1053 _dbus_warn ("could not parse integer for INT32\n");
1057 if (!_dbus_marshal_int32 (dest, endian,
1060 _dbus_warn ("failed to append INT32\n");
1064 PERFORM_UNALIGN (dest);
1066 else if (_dbus_string_starts_with_c_str (&line,
1069 SAVE_FOR_UNALIGN (dest, 4);
1072 _dbus_string_delete_first_word (&line);
1074 /* FIXME should have _dbus_string_parse_uint32 */
1075 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
1078 if (!_dbus_marshal_uint32 (dest, endian,
1081 _dbus_warn ("failed to append UINT32\n");
1085 PERFORM_UNALIGN (dest);
1087 else if (_dbus_string_starts_with_c_str (&line,
1090 SAVE_FOR_UNALIGN (dest, 8);
1093 _dbus_string_delete_first_word (&line);
1095 if (!_dbus_string_parse_double (&line, 0, &val, NULL))
1098 if (!_dbus_marshal_double (dest, endian,
1101 _dbus_warn ("failed to append DOUBLE\n");
1105 PERFORM_UNALIGN (dest);
1107 else if (_dbus_string_starts_with_c_str (&line,
1110 SAVE_FOR_UNALIGN (dest, 4);
1114 _dbus_string_delete_first_word (&line);
1116 size_offset = _dbus_string_get_length (dest);
1117 size_offset = _DBUS_ALIGN_VALUE (size_offset, 4);
1118 if (!_dbus_marshal_uint32 (dest, endian, 0))
1120 _dbus_warn ("Failed to append string size\n");
1124 old_len = _dbus_string_get_length (dest);
1125 if (!append_quoted_string (dest, &line, 0, NULL))
1127 _dbus_warn ("Failed to append quoted string\n");
1131 _dbus_marshal_set_uint32 (dest, endian, size_offset,
1132 /* subtract 1 for nul */
1133 _dbus_string_get_length (dest) - old_len - 1);
1135 PERFORM_UNALIGN (dest);
1140 if (!just_set_unalign && unalign)
1142 _dbus_warn ("UNALIGN prior to something that isn't aligned\n");
1146 goto next_iteration; /* skip parse_failed */
1150 _dbus_warn ("couldn't process line %d \"%s\"\n",
1151 line_no, _dbus_string_get_const_data (&line));
1156 _dbus_hash_iter_init (length_hash, &iter);
1157 while (_dbus_hash_iter_next (&iter))
1159 SavedLength *sl = _dbus_hash_iter_get_value (&iter);
1162 s = _dbus_string_get_const_data (&sl->name);
1166 _dbus_warn ("Used LENGTH %s but never did END_LENGTH\n",
1170 else if (sl->offset < 0)
1172 _dbus_warn ("Did END_LENGTH %s but never used LENGTH\n",
1181 _dbus_verbose ("Filling in length %s endian = %d offset = %d start = %d length = %d\n",
1182 s, sl->endian, sl->offset, sl->start, sl->length);
1183 _dbus_marshal_set_int32 (dest,
1186 sl->length - sl->start);
1189 _dbus_hash_iter_remove_entry (&iter);
1195 if (length_hash != NULL)
1196 _dbus_hash_table_unref (length_hash);
1198 _dbus_string_free (&file);
1199 _dbus_string_free (&line);
1204 #endif /* DBUS_BUILD_TESTS */