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 _dbus_string_get_const_data (name, &s);
73 sl = _dbus_hash_table_lookup_string (hash, s);
77 sl = dbus_new0 (SavedLength, 1);
79 if (!_dbus_string_init (&sl->name, _DBUS_INT_MAX))
85 if (!_dbus_string_copy (name, 0, &sl->name, 0))
88 _dbus_string_get_const_data (&sl->name, &s);
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)
194 dbus_bool_t in_quotes = FALSE;
198 while (i < _dbus_string_get_length (quoted))
202 b = _dbus_string_get_byte (quoted, i);
210 if (!_dbus_string_append_byte (dest, b))
218 else if (b == ' ' || b == '\n' || b == '\t')
219 break; /* end on whitespace if not quoted */
222 if (!_dbus_string_append_byte (dest, b))
230 if (!_dbus_string_append_byte (dest, '\0'))
236 append_saved_length (DBusString *dest,
237 DBusHashTable *length_hash,
238 const DBusString *name,
242 if (!save_offset (length_hash, name,
245 _dbus_warn ("failed to save offset to LENGTH\n");
249 if (!_dbus_marshal_uint32 (dest, endian,
252 _dbus_warn ("failed to append a length\n");
260 * Reads the given filename, which should be in "message description
261 * language" (look at some examples), and builds up the message data
262 * from it. The message data may be invalid, or valid.
264 * The parser isn't very strict, it's just a hack for test programs.
266 * The file format is:
268 * VALID_HEADER normal header; byte order, padding, header len, body len, serial
269 * BIG_ENDIAN switch to big endian
270 * LITTLE_ENDIAN switch to little endian
271 * OPPOSITE_ENDIAN switch to opposite endian
272 * ALIGN <N> aligns to the given value
273 * UNALIGN skips alignment for the next marshal
274 * BYTE <N> inserts the given integer in [0,255] or char in 'a' format
275 * START_LENGTH <name> marks the start of a length to measure
276 * END_LENGTH <name> records the length since START_LENGTH under the given name
277 * (or if no START_LENGTH, absolute length)
278 * LENGTH <name> inserts the saved length of the same name
279 * CHOP <N> chops last N bytes off the data
280 * FIELD_NAME <abcd> inserts 4-byte field name
281 * TYPE <typename> inserts a typecode byte
284 * Following commands insert aligned data unless
285 * preceded by "UNALIGN":
287 * INT32 <N> marshals an INT32
288 * UINT32 <N> marshals a UINT32
289 * DOUBLE <N> marshals a double
290 * STRING 'Foo' marshals a string
293 * @todo add support for array types INT32_ARRAY { 3, 4, 5, 6 }
296 * @param dest the string to append the message data to
297 * @param filename the filename to load
298 * @returns #TRUE on success
301 _dbus_message_data_load (DBusString *dest,
302 const DBusString *filename)
305 DBusResultCode result;
310 DBusHashTable *length_hash;
317 if (!_dbus_string_init (&file, _DBUS_INT_MAX))
320 if (!_dbus_string_init (&line, _DBUS_INT_MAX))
322 _dbus_string_free (&file);
326 if ((result = _dbus_file_get_contents (&file, filename)) != DBUS_RESULT_SUCCESS)
329 _dbus_string_get_const_data (filename, &s);
330 _dbus_warn ("Getting contents of %s failed: %s\n",
331 s, dbus_result_to_string (result));
336 length_hash = _dbus_hash_table_new (DBUS_HASH_STRING,
339 if (length_hash == NULL)
342 endian = DBUS_COMPILER_BYTE_ORDER;
346 while (_dbus_string_pop_line (&file, &line))
348 dbus_bool_t just_set_unalign;
350 just_set_unalign = FALSE;
353 _dbus_string_delete_leading_blanks (&line);
355 if (_dbus_string_get_length (&line) == 0)
360 else if (_dbus_string_starts_with_c_str (&line,
363 /* Ignore this comment */
366 else if (_dbus_string_starts_with_c_str (&line,
372 if (!_dbus_string_append_byte (dest, endian))
374 _dbus_warn ("could not append endianness\n");
381 if (!_dbus_string_append_byte (dest, '\0'))
383 _dbus_warn ("could not append nul pad\n");
389 _dbus_string_init_const (&name, "Header");
390 if (!append_saved_length (dest, length_hash,
391 &name, _dbus_string_get_length (dest),
395 _dbus_string_init_const (&name, "Body");
396 if (!append_saved_length (dest, length_hash,
397 &name, _dbus_string_get_length (dest),
402 if (!_dbus_marshal_int32 (dest, endian, 1))
404 _dbus_warn ("couldn't append client serial\n");
408 else if (_dbus_string_starts_with_c_str (&line,
411 endian = DBUS_BIG_ENDIAN;
413 else if (_dbus_string_starts_with_c_str (&line,
416 endian = DBUS_LITTLE_ENDIAN;
418 else if (_dbus_string_starts_with_c_str (&line,
421 if (endian == DBUS_BIG_ENDIAN)
422 endian = DBUS_LITTLE_ENDIAN;
424 endian = DBUS_BIG_ENDIAN;
426 else if (_dbus_string_starts_with_c_str (&line,
431 _dbus_string_delete_first_word (&line);
433 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
435 _dbus_warn ("Failed to parse integer\n");
441 _dbus_warn ("Aligning to %ld boundary is crack\n",
446 if (!_dbus_string_align_length (dest, val))
449 else if (_dbus_string_starts_with_c_str (&line, "UNALIGN"))
452 just_set_unalign = TRUE;
454 else if (_dbus_string_starts_with_c_str (&line, "CHOP"))
458 /* FIXME if you CHOP the offset for a LENGTH
459 * command, we segfault.
462 _dbus_string_delete_first_word (&line);
464 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
466 _dbus_warn ("Failed to parse integer to chop\n");
470 if (val > _dbus_string_get_length (dest))
472 _dbus_warn ("Trying to chop %ld bytes but we only have %d\n",
474 _dbus_string_get_length (dest));
478 _dbus_string_shorten (dest, val);
480 else if (_dbus_string_starts_with_c_str (&line, "BYTE"))
482 unsigned char the_byte;
484 _dbus_string_delete_first_word (&line);
486 if (_dbus_string_equal_c_str (&line, "'\\''"))
488 else if (_dbus_string_get_byte (&line, 0) == '\'' &&
489 _dbus_string_get_length (&line) >= 3 &&
490 _dbus_string_get_byte (&line, 2) == '\'')
491 the_byte = _dbus_string_get_byte (&line, 1);
495 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
497 _dbus_warn ("Failed to parse integer for BYTE\n");
503 _dbus_warn ("A byte must be in range 0-255 not %ld\n",
507 the_byte = (unsigned char) val;
510 _dbus_string_append_byte (dest, the_byte);
512 else if (_dbus_string_starts_with_c_str (&line,
515 _dbus_string_delete_first_word (&line);
517 if (!save_start (length_hash, &line,
518 _dbus_string_get_length (dest)))
520 _dbus_warn ("failed to save length start\n");
524 else if (_dbus_string_starts_with_c_str (&line,
527 _dbus_string_delete_first_word (&line);
529 if (!save_length (length_hash, &line,
530 _dbus_string_get_length (dest)))
532 _dbus_warn ("failed to save length end\n");
536 else if (_dbus_string_starts_with_c_str (&line,
539 SAVE_FOR_UNALIGN (dest, 4);
541 _dbus_string_delete_first_word (&line);
543 if (!append_saved_length (dest, length_hash,
545 unalign ? align_pad_start : align_pad_end,
548 _dbus_warn ("failed to add LENGTH\n");
552 PERFORM_UNALIGN (dest);
554 else if (_dbus_string_starts_with_c_str (&line,
557 _dbus_string_delete_first_word (&line);
559 if (_dbus_string_get_length (&line) != 4)
562 _dbus_string_get_const_data (&line, &s);
563 _dbus_warn ("Field name must be four characters not \"%s\"\n",
571 _dbus_string_align_length (dest, 4);
573 if (!_dbus_string_copy (&line, 0, dest,
574 _dbus_string_get_length (dest)))
577 else if (_dbus_string_starts_with_c_str (&line,
582 _dbus_string_delete_first_word (&line);
584 if (_dbus_string_starts_with_c_str (&line, "INVALID"))
585 code = DBUS_TYPE_INVALID;
586 else if (_dbus_string_starts_with_c_str (&line, "NIL"))
587 code = DBUS_TYPE_NIL;
588 else if (_dbus_string_starts_with_c_str (&line, "INT32"))
589 code = DBUS_TYPE_INT32;
590 else if (_dbus_string_starts_with_c_str (&line, "UINT32"))
591 code = DBUS_TYPE_UINT32;
592 else if (_dbus_string_starts_with_c_str (&line, "DOUBLE"))
593 code = DBUS_TYPE_DOUBLE;
594 else if (_dbus_string_starts_with_c_str (&line, "STRING"))
595 code = DBUS_TYPE_STRING;
596 else if (_dbus_string_starts_with_c_str (&line, "INT32_ARRAY"))
597 code = DBUS_TYPE_INT32_ARRAY;
598 else if (_dbus_string_starts_with_c_str (&line, "UINT32_ARRAY"))
599 code = DBUS_TYPE_UINT32_ARRAY;
600 else if (_dbus_string_starts_with_c_str (&line, "DOUBLE_ARRAY"))
601 code = DBUS_TYPE_DOUBLE_ARRAY;
602 else if (_dbus_string_starts_with_c_str (&line, "BYTE_ARRAY"))
603 code = DBUS_TYPE_BYTE_ARRAY;
604 else if (_dbus_string_starts_with_c_str (&line, "STRING_ARRAY"))
605 code = DBUS_TYPE_STRING_ARRAY;
609 _dbus_string_get_const_data (&line, &s);
610 _dbus_warn ("%s is not a valid type name\n", s);
614 if (!_dbus_string_append_byte (dest, code))
616 _dbus_warn ("could not append typecode byte\n");
620 else if (_dbus_string_starts_with_c_str (&line,
623 SAVE_FOR_UNALIGN (dest, 4);
626 _dbus_string_delete_first_word (&line);
628 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
630 _dbus_warn ("could not parse integer for INT32\n");
634 if (!_dbus_marshal_int32 (dest, endian,
637 _dbus_warn ("failed to append INT32\n");
641 PERFORM_UNALIGN (dest);
643 else if (_dbus_string_starts_with_c_str (&line,
646 SAVE_FOR_UNALIGN (dest, 4);
649 _dbus_string_delete_first_word (&line);
651 /* FIXME should have _dbus_string_parse_uint32 */
652 if (!_dbus_string_parse_int (&line, 0, &val, NULL))
655 if (!_dbus_marshal_uint32 (dest, endian,
658 _dbus_warn ("failed to append UINT32\n");
662 PERFORM_UNALIGN (dest);
664 else if (_dbus_string_starts_with_c_str (&line,
667 SAVE_FOR_UNALIGN (dest, 8);
670 _dbus_string_delete_first_word (&line);
672 if (!_dbus_string_parse_double (&line, 0, &val, NULL))
675 if (!_dbus_marshal_double (dest, endian,
678 _dbus_warn ("failed to append DOUBLE\n");
682 PERFORM_UNALIGN (dest);
684 else if (_dbus_string_starts_with_c_str (&line,
687 SAVE_FOR_UNALIGN (dest, 4);
691 _dbus_string_delete_first_word (&line);
693 size_offset = _dbus_string_get_length (dest);
694 size_offset = _DBUS_ALIGN_VALUE (size_offset, 4);
695 if (!_dbus_marshal_uint32 (dest, endian, 0))
697 _dbus_warn ("Failed to append string size\n");
701 old_len = _dbus_string_get_length (dest);
702 if (!append_quoted_string (dest, &line))
704 _dbus_warn ("Failed to append quoted string\n");
708 _dbus_marshal_set_uint32 (dest, endian, size_offset,
709 /* subtract 1 for nul */
710 _dbus_string_get_length (dest) - old_len - 1);
712 PERFORM_UNALIGN (dest);
717 if (!just_set_unalign && unalign)
719 _dbus_warn ("UNALIGN prior to something that isn't aligned\n");
723 goto next_iteration; /* skip parse_failed */
728 _dbus_string_get_const_data (&line, &s);
729 _dbus_warn ("couldn't process line %d \"%s\"\n",
735 _dbus_hash_iter_init (length_hash, &iter);
736 while (_dbus_hash_iter_next (&iter))
738 SavedLength *sl = _dbus_hash_iter_get_value (&iter);
741 _dbus_string_get_const_data (&sl->name, &s);
745 _dbus_warn ("Used LENGTH %s but never did END_LENGTH\n",
749 else if (sl->offset < 0)
751 _dbus_warn ("Did END_LENGTH %s but never used LENGTH\n",
760 _dbus_verbose ("Filling in length %s endian = %d offset = %d start = %d length = %d\n",
761 s, sl->endian, sl->offset, sl->start, sl->length);
762 _dbus_marshal_set_int32 (dest,
765 sl->length - sl->start);
772 if (length_hash != NULL)
773 _dbus_hash_table_unref (length_hash);
775 _dbus_string_free (&file);
776 _dbus_string_free (&line);
781 #endif /* DBUS_BUILD_TESTS */