1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-string.c String utility class (internal to D-BUS implementation)
4 * Copyright (C) 2002, 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
24 #include "dbus-internals.h"
25 #include "dbus-string.h"
26 /* we allow a system header here, for speed/convenience */
30 #include "dbus-marshal.h"
31 #define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
32 #include "dbus-string-private.h"
33 #include "dbus-protocol.h"
36 * @defgroup DBusString string class
37 * @ingroup DBusInternals
38 * @brief DBusString data structure
40 * Types and functions related to DBusString. DBusString is intended
41 * to be a string class that makes it hard to mess up security issues
42 * (and just in general harder to write buggy code). It should be
43 * used (or extended and then used) rather than the libc stuff in
44 * string.h. The string class is a bit inconvenient at spots because
45 * it handles out-of-memory failures and tries to be extra-robust.
47 * A DBusString has a maximum length set at initialization time; this
48 * can be used to ensure that a buffer doesn't get too big. The
49 * _dbus_string_lengthen() method checks for overflow, and for max
50 * length being exceeded.
52 * Try to avoid conversion to a plain C string, i.e. add methods on
53 * the string object instead, only convert to C string when passing
54 * things out to the public API. In particular, no sprintf, strcpy,
55 * strcat, any of that should be used. The GString feature of
56 * accepting negative numbers for "length of string" is also absent,
57 * because it could keep us from detecting bogus huge lengths. i.e. if
58 * we passed in some bogus huge length it would be taken to mean
59 * "current length of string" instead of "broken crack"
63 * @defgroup DBusStringInternals DBusString implementation details
64 * @ingroup DBusInternals
65 * @brief DBusString implementation details
67 * The guts of DBusString.
73 * We allocate 1 byte for nul termination, plus 7 bytes for possible
74 * align_offset, so we always need 8 bytes on top of the string's
75 * length to be in the allocated block.
77 #define ALLOCATION_PADDING 8
80 * This is the maximum max length (and thus also the maximum length)
83 #define MAX_MAX_LENGTH (_DBUS_INT_MAX - ALLOCATION_PADDING)
86 * Checks a bunch of assertions about a string object
88 * @param real the DBusRealString
90 #define DBUS_GENERIC_STRING_PREAMBLE(real) _dbus_assert ((real) != NULL); _dbus_assert (!(real)->invalid); _dbus_assert ((real)->len >= 0); _dbus_assert ((real)->allocated >= 0); _dbus_assert ((real)->max_length >= 0); _dbus_assert ((real)->len <= ((real)->allocated - ALLOCATION_PADDING)); _dbus_assert ((real)->len <= (real)->max_length)
93 * Checks assertions about a string object that needs to be
94 * modifiable - may not be locked or const. Also declares
95 * the "real" variable pointing to DBusRealString.
96 * @param str the string
98 #define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
99 DBUS_GENERIC_STRING_PREAMBLE (real); \
100 _dbus_assert (!(real)->constant); \
101 _dbus_assert (!(real)->locked)
104 * Checks assertions about a string object that may be locked but
105 * can't be const. i.e. a string object that we can free. Also
106 * declares the "real" variable pointing to DBusRealString.
108 * @param str the string
110 #define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
111 DBUS_GENERIC_STRING_PREAMBLE (real); \
112 _dbus_assert (!(real)->constant)
115 * Checks assertions about a string that may be const or locked. Also
116 * declares the "real" variable pointing to DBusRealString.
117 * @param str the string.
119 #define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
120 DBUS_GENERIC_STRING_PREAMBLE (real)
125 * @addtogroup DBusString
130 fixup_alignment (DBusRealString *real)
134 unsigned int old_align_offset;
136 /* we have to have extra space in real->allocated for the align offset and nul byte */
137 _dbus_assert (real->len <= real->allocated - ALLOCATION_PADDING);
139 old_align_offset = real->align_offset;
140 real_block = real->str - old_align_offset;
142 aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);
144 real->align_offset = aligned - real_block;
147 if (old_align_offset != real->align_offset)
149 /* Here comes the suck */
150 memmove (real_block + real->align_offset,
151 real_block + old_align_offset,
155 _dbus_assert (real->align_offset < 8);
156 _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
160 undo_alignment (DBusRealString *real)
162 if (real->align_offset != 0)
164 memmove (real->str - real->align_offset,
168 real->str = real->str - real->align_offset;
169 real->align_offset = 0;
174 * Initializes a string that can be up to the given allocation size
175 * before it has to realloc. The string starts life with zero length.
176 * The string must eventually be freed with _dbus_string_free().
178 * @param str memory to hold the string
179 * @param allocate_size amount to preallocate
180 * @returns #TRUE on success, #FALSE if no memory
183 _dbus_string_init_preallocated (DBusString *str,
186 DBusRealString *real;
188 _dbus_assert (str != NULL);
190 _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
192 real = (DBusRealString*) str;
194 /* It's very important not to touch anything
195 * other than real->str if we're going to fail,
196 * since we also use this function to reset
197 * an existing string, e.g. in _dbus_string_steal_data()
200 real->str = dbus_malloc (ALLOCATION_PADDING + allocate_size);
201 if (real->str == NULL)
204 real->allocated = ALLOCATION_PADDING + allocate_size;
206 real->str[real->len] = '\0';
208 real->max_length = MAX_MAX_LENGTH;
209 real->constant = FALSE;
210 real->locked = FALSE;
211 real->invalid = FALSE;
212 real->align_offset = 0;
214 fixup_alignment (real);
220 * Initializes a string. The string starts life with zero length. The
221 * string must eventually be freed with _dbus_string_free().
223 * @param str memory to hold the string
224 * @returns #TRUE on success, #FALSE if no memory
227 _dbus_string_init (DBusString *str)
229 return _dbus_string_init_preallocated (str, 0);
232 /* The max length thing is sort of a historical artifact
233 * from a feature that turned out to be dumb; perhaps
234 * we should purge it entirely. The problem with
235 * the feature is that it looks like memory allocation
236 * failure, but is not a transient or resolvable failure.
239 set_max_length (DBusString *str,
242 DBusRealString *real;
244 real = (DBusRealString*) str;
246 real->max_length = max_length;
250 * Initializes a constant string. The value parameter is not copied
251 * (should be static), and the string may never be modified.
252 * It is safe but not necessary to call _dbus_string_free()
253 * on a const string. The string has a length limit of MAXINT - 8.
255 * @param str memory to use for the string
256 * @param value a string to be stored in str (not copied!!!)
259 _dbus_string_init_const (DBusString *str,
262 _dbus_assert (value != NULL);
264 _dbus_string_init_const_len (str, value,
269 * Initializes a constant string with a length. The value parameter is
270 * not copied (should be static), and the string may never be
271 * modified. It is safe but not necessary to call _dbus_string_free()
274 * @param str memory to use for the string
275 * @param value a string to be stored in str (not copied!!!)
276 * @param len the length to use
279 _dbus_string_init_const_len (DBusString *str,
283 DBusRealString *real;
285 _dbus_assert (str != NULL);
286 _dbus_assert (value != NULL);
287 _dbus_assert (len <= MAX_MAX_LENGTH);
288 _dbus_assert (len >= 0);
290 real = (DBusRealString*) str;
292 real->str = (char*) value;
294 real->allocated = real->len + ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
295 real->max_length = real->len + 1;
296 real->constant = TRUE;
297 real->invalid = FALSE;
299 /* We don't require const strings to be 8-byte aligned as the
300 * memory is coming from elsewhere.
305 * Frees a string created by _dbus_string_init().
307 * @param str memory where the string is stored.
310 _dbus_string_free (DBusString *str)
312 DBusRealString *real = (DBusRealString*) str;
313 DBUS_GENERIC_STRING_PREAMBLE (real);
317 dbus_free (real->str - real->align_offset);
319 real->invalid = TRUE;
322 #ifdef DBUS_BUILD_TESTS
323 /* Not using this feature at the moment,
324 * so marked DBUS_BUILD_TESTS-only
327 * Locks a string such that any attempts to change the string will
328 * result in aborting the program. Also, if the string is wasting a
329 * lot of memory (allocation is sufficiently larger than what the
330 * string is really using), _dbus_string_lock() will realloc the
331 * string's data to "compact" it.
333 * @param str the string to lock.
336 _dbus_string_lock (DBusString *str)
338 DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
342 /* Try to realloc to avoid excess memory usage, since
343 * we know we won't change the string further
346 if (real->allocated - MAX_WASTE > real->len)
351 new_allocated = real->len + ALLOCATION_PADDING;
353 new_str = dbus_realloc (real->str - real->align_offset,
357 real->str = new_str + real->align_offset;
358 real->allocated = new_allocated;
359 fixup_alignment (real);
363 #endif /* DBUS_BUILD_TESTS */
366 reallocate_for_length (DBusRealString *real,
372 /* at least double our old allocation to avoid O(n), avoiding
375 if (real->allocated > (MAX_MAX_LENGTH + ALLOCATION_PADDING) / 2)
376 new_allocated = MAX_MAX_LENGTH + ALLOCATION_PADDING;
378 new_allocated = real->allocated * 2;
380 /* if you change the code just above here, run the tests without
381 * the following before you commit
383 #ifdef DBUS_BUILD_TESTS
384 new_allocated = 0; /* ensure a realloc every time so that we go
385 * through all malloc failure codepaths
389 /* But be sure we always alloc at least space for the new length */
390 new_allocated = MAX (new_allocated, new_length + ALLOCATION_PADDING);
392 _dbus_assert (new_allocated >= real->allocated); /* code relies on this */
393 new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
397 real->str = new_str + real->align_offset;
398 real->allocated = new_allocated;
399 fixup_alignment (real);
405 set_length (DBusRealString *real,
408 /* Note, we are setting the length not including nul termination */
410 /* exceeding max length is the same as failure to allocate memory */
411 if (new_length > real->max_length)
413 else if (new_length > (real->allocated - ALLOCATION_PADDING) &&
414 !reallocate_for_length (real, new_length))
418 real->len = new_length;
419 real->str[real->len] = '\0';
426 DBusRealString *dest,
432 if (len > dest->max_length - dest->len)
433 return FALSE; /* detected overflow of dest->len + len below */
435 if (!set_length (dest, dest->len + len))
438 memmove (dest->str + insert_at + len,
439 dest->str + insert_at,
440 dest->len - len - insert_at);
446 * Gets the raw character buffer from the string. The returned buffer
447 * will be nul-terminated, but note that strings may contain binary
448 * data so there may be extra nul characters prior to the termination.
449 * This function should be little-used, extend DBusString or add
450 * stuff to dbus-sysdeps.c instead. It's an error to use this
451 * function on a const string.
453 * @param str the string
457 _dbus_string_get_data (DBusString *str)
459 DBUS_STRING_PREAMBLE (str);
465 * Gets the raw character buffer from a const string.
467 * @param str the string
468 * @returns the string data
471 _dbus_string_get_const_data (const DBusString *str)
473 DBUS_CONST_STRING_PREAMBLE (str);
479 * Gets a sub-portion of the raw character buffer from the
480 * string. The "len" field is required simply for error
481 * checking, to be sure you don't try to use more
482 * string than exists. The nul termination of the
483 * returned buffer remains at the end of the entire
484 * string, not at start + len.
486 * @param str the string
487 * @param start byte offset to return
488 * @param len length of segment to return
489 * @returns the string data
492 _dbus_string_get_data_len (DBusString *str,
496 DBUS_STRING_PREAMBLE (str);
497 _dbus_assert (start >= 0);
498 _dbus_assert (len >= 0);
499 _dbus_assert (start <= real->len);
500 _dbus_assert (len <= real->len - start);
502 return real->str + start;
506 * const version of _dbus_string_get_data_len().
508 * @param str the string
509 * @param start byte offset to return
510 * @param len length of segment to return
511 * @returns the string data
514 _dbus_string_get_const_data_len (const DBusString *str,
518 DBUS_CONST_STRING_PREAMBLE (str);
519 _dbus_assert (start >= 0);
520 _dbus_assert (len >= 0);
521 _dbus_assert (start <= real->len);
522 _dbus_assert (len <= real->len - start);
524 return real->str + start;
528 * Sets the value of the byte at the given position.
530 * @param str the string
531 * @param i the position
532 * @param byte the new value
535 _dbus_string_set_byte (DBusString *str,
539 DBUS_STRING_PREAMBLE (str);
540 _dbus_assert (i < real->len);
541 _dbus_assert (i >= 0);
547 * Gets the byte at the given position. It is
548 * allowed to ask for the nul byte at the end of
551 * @param str the string
552 * @param start the position
553 * @returns the byte at that position
556 _dbus_string_get_byte (const DBusString *str,
559 DBUS_CONST_STRING_PREAMBLE (str);
560 _dbus_assert (start <= real->len);
561 _dbus_assert (start >= 0);
563 return real->str[start];
567 * Inserts a number of bytes of a given value at the
570 * @param str the string
571 * @param i the position
572 * @param n_bytes number of bytes
573 * @param byte the value to insert
574 * @returns #TRUE on success
577 _dbus_string_insert_bytes (DBusString *str,
582 DBUS_STRING_PREAMBLE (str);
583 _dbus_assert (i <= real->len);
584 _dbus_assert (i >= 0);
585 _dbus_assert (n_bytes >= 0);
590 if (!open_gap (n_bytes, real, i))
593 memset (real->str + i, byte, n_bytes);
599 * Like _dbus_string_get_data(), but removes the
600 * gotten data from the original string. The caller
601 * must free the data returned. This function may
602 * fail due to lack of memory, and return #FALSE.
604 * @param str the string
605 * @param data_return location to return the buffer
606 * @returns #TRUE on success
609 _dbus_string_steal_data (DBusString *str,
613 DBUS_STRING_PREAMBLE (str);
614 _dbus_assert (data_return != NULL);
616 undo_alignment (real);
618 *data_return = real->str;
620 old_max_length = real->max_length;
622 /* reset the string */
623 if (!_dbus_string_init (str))
625 /* hrm, put it back then */
626 real->str = *data_return;
628 fixup_alignment (real);
632 real->max_length = old_max_length;
638 * Like _dbus_string_get_data_len(), but removes the gotten data from
639 * the original string. The caller must free the data returned. This
640 * function may fail due to lack of memory, and return #FALSE.
641 * The returned string is nul-terminated and has length len.
643 * @todo this function is broken because on failure it
644 * may corrupt the source string.
646 * @param str the string
647 * @param data_return location to return the buffer
648 * @param start the start of segment to steal
649 * @param len the length of segment to steal
650 * @returns #TRUE on success
653 _dbus_string_steal_data_len (DBusString *str,
659 DBUS_STRING_PREAMBLE (str);
660 _dbus_assert (data_return != NULL);
661 _dbus_assert (start >= 0);
662 _dbus_assert (len >= 0);
663 _dbus_assert (start <= real->len);
664 _dbus_assert (len <= real->len - start);
666 if (!_dbus_string_init (&dest))
669 set_max_length (&dest, real->max_length);
671 if (!_dbus_string_move_len (str, start, len, &dest, 0))
673 _dbus_string_free (&dest);
677 _dbus_warn ("Broken code in _dbus_string_steal_data_len(), see @todo, FIXME\n");
678 if (!_dbus_string_steal_data (&dest, data_return))
680 _dbus_string_free (&dest);
684 _dbus_string_free (&dest);
690 * Copies the data from the string into a char*
692 * @param str the string
693 * @param data_return place to return the data
694 * @returns #TRUE on success, #FALSE on no memory
697 _dbus_string_copy_data (const DBusString *str,
700 DBUS_CONST_STRING_PREAMBLE (str);
701 _dbus_assert (data_return != NULL);
703 *data_return = dbus_malloc (real->len + 1);
704 if (*data_return == NULL)
707 memcpy (*data_return, real->str, real->len + 1);
713 * Copies a segment of the string into a char*
715 * @param str the string
716 * @param data_return place to return the data
717 * @param start start index
718 * @param len length to copy
719 * @returns #FALSE if no memory
722 _dbus_string_copy_data_len (const DBusString *str,
729 DBUS_CONST_STRING_PREAMBLE (str);
730 _dbus_assert (data_return != NULL);
731 _dbus_assert (start >= 0);
732 _dbus_assert (len >= 0);
733 _dbus_assert (start <= real->len);
734 _dbus_assert (len <= real->len - start);
736 if (!_dbus_string_init (&dest))
739 set_max_length (&dest, real->max_length);
741 if (!_dbus_string_copy_len (str, start, len, &dest, 0))
743 _dbus_string_free (&dest);
747 if (!_dbus_string_steal_data (&dest, data_return))
749 _dbus_string_free (&dest);
753 _dbus_string_free (&dest);
758 * Gets the length of a string (not including nul termination).
760 * @returns the length.
763 _dbus_string_get_length (const DBusString *str)
765 DBUS_CONST_STRING_PREAMBLE (str);
771 * Makes a string longer by the given number of bytes. Checks whether
772 * adding additional_length to the current length would overflow an
773 * integer, and checks for exceeding a string's max length.
774 * The new bytes are not initialized, other than nul-terminating
775 * the end of the string. The uninitialized bytes may contain
776 * nul bytes or other junk.
778 * @param str a string
779 * @param additional_length length to add to the string.
780 * @returns #TRUE on success.
783 _dbus_string_lengthen (DBusString *str,
784 int additional_length)
786 DBUS_STRING_PREAMBLE (str);
787 _dbus_assert (additional_length >= 0);
789 if (additional_length > real->max_length - real->len)
790 return FALSE; /* would overflow */
792 return set_length (real,
793 real->len + additional_length);
797 * Makes a string shorter by the given number of bytes.
799 * @param str a string
800 * @param length_to_remove length to remove from the string.
803 _dbus_string_shorten (DBusString *str,
804 int length_to_remove)
806 DBUS_STRING_PREAMBLE (str);
807 _dbus_assert (length_to_remove >= 0);
808 _dbus_assert (length_to_remove <= real->len);
811 real->len - length_to_remove);
815 * Sets the length of a string. Can be used to truncate or lengthen
816 * the string. If the string is lengthened, the function may fail and
817 * return #FALSE. Newly-added bytes are not initialized, as with
818 * _dbus_string_lengthen().
820 * @param str a string
821 * @param length new length of the string.
822 * @returns #FALSE on failure.
825 _dbus_string_set_length (DBusString *str,
828 DBUS_STRING_PREAMBLE (str);
829 _dbus_assert (length >= 0);
831 return set_length (real, length);
835 align_length_then_lengthen (DBusString *str,
837 int then_lengthen_by)
839 unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
841 DBUS_STRING_PREAMBLE (str);
842 _dbus_assert (alignment >= 1);
843 _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
845 new_len = _DBUS_ALIGN_VALUE (real->len, alignment);
846 if (new_len > (unsigned long) real->max_length - then_lengthen_by)
848 new_len += then_lengthen_by;
850 delta = new_len - real->len;
851 _dbus_assert (delta >= 0);
856 if (!set_length (real, new_len))
859 /* delta == padding + then_lengthen_by
860 * new_len == old_len + padding + then_lengthen_by
862 if (then_lengthen_by < delta)
866 while (i < (new_len - then_lengthen_by))
877 * Align the length of a string to a specific alignment (typically 4 or 8)
878 * by appending nul bytes to the string.
880 * @param str a string
881 * @param alignment the alignment
882 * @returns #FALSE if no memory
885 _dbus_string_align_length (DBusString *str,
888 return align_length_then_lengthen (str, alignment, 0);
892 append (DBusRealString *real,
899 if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
902 memcpy (real->str + (real->len - buffer_len),
910 * Appends a nul-terminated C-style string to a DBusString.
912 * @param str the DBusString
913 * @param buffer the nul-terminated characters to append
914 * @returns #FALSE if not enough memory.
917 _dbus_string_append (DBusString *str,
920 unsigned long buffer_len;
922 DBUS_STRING_PREAMBLE (str);
923 _dbus_assert (buffer != NULL);
925 buffer_len = strlen (buffer);
926 if (buffer_len > (unsigned long) real->max_length)
929 return append (real, buffer, buffer_len);
933 * Appends 4 bytes aligned on a 4 byte boundary
934 * with any alignment padding initialized to 0.
936 * @param str the DBusString
937 * @param octets 4 bytes to append
938 * @returns #FALSE if not enough memory.
941 _dbus_string_append_4_aligned (DBusString *str,
942 const unsigned char octets[4])
945 DBUS_STRING_PREAMBLE (str);
947 if (!align_length_then_lengthen (str, 4, 4))
950 p = (dbus_uint32_t*) (real->str + (real->len - 4));
951 *p = *((dbus_uint32_t*)octets);
957 * Appends 8 bytes aligned on an 8 byte boundary
958 * with any alignment padding initialized to 0.
960 * @param str the DBusString
961 * @param octets 4 bytes to append
962 * @returns #FALSE if not enough memory.
965 _dbus_string_append_8_aligned (DBusString *str,
966 const unsigned char octets[8])
968 #ifdef DBUS_HAVE_INT64
970 DBUS_STRING_PREAMBLE (str);
972 if (!align_length_then_lengthen (str, 8, 8))
975 p = (dbus_uint64_t*) (real->str + (real->len - 8));
976 *p = *((dbus_uint64_t*)octets);
979 DBUS_STRING_PREAMBLE (str);
981 if (!align_length_then_lengthen (str, 8, 8))
984 p = real->str + (real->len - 8);
994 _dbus_assert (p == (real->str + real->len));
1001 * Appends a printf-style formatted string
1002 * to the #DBusString.
1004 * @param str the string
1005 * @param format printf format
1006 * @param args variable argument list
1007 * @returns #FALSE if no memory
1010 _dbus_string_append_printf_valist (DBusString *str,
1016 DBUS_STRING_PREAMBLE (str);
1018 /* Measure the message length without terminating nul */
1019 len = vsnprintf (&c, 1, format, args);
1021 if (!_dbus_string_lengthen (str, len))
1024 vsprintf (real->str + (real->len - len),
1031 * Appends a printf-style formatted string
1032 * to the #DBusString.
1034 * @param str the string
1035 * @param format printf format
1036 * @returns #FALSE if no memory
1039 _dbus_string_append_printf (DBusString *str,
1046 va_start (args, format);
1047 retval = _dbus_string_append_printf_valist (str, format, args);
1054 * Appends block of bytes with the given length to a DBusString.
1056 * @param str the DBusString
1057 * @param buffer the bytes to append
1058 * @param len the number of bytes to append
1059 * @returns #FALSE if not enough memory.
1062 _dbus_string_append_len (DBusString *str,
1066 DBUS_STRING_PREAMBLE (str);
1067 _dbus_assert (buffer != NULL);
1068 _dbus_assert (len >= 0);
1070 return append (real, buffer, len);
1074 * Appends a single byte to the string, returning #FALSE
1075 * if not enough memory.
1077 * @param str the string
1078 * @param byte the byte to append
1079 * @returns #TRUE on success
1082 _dbus_string_append_byte (DBusString *str,
1085 DBUS_STRING_PREAMBLE (str);
1087 if (!set_length (real, real->len + 1))
1090 real->str[real->len-1] = byte;
1096 * Appends a single Unicode character, encoding the character
1099 * @param str the string
1100 * @param ch the Unicode character
1103 _dbus_string_append_unichar (DBusString *str,
1111 DBUS_STRING_PREAMBLE (str);
1113 /* this code is from GLib but is pretty standard I think */
1122 else if (ch < 0x800)
1127 else if (ch < 0x10000)
1132 else if (ch < 0x200000)
1137 else if (ch < 0x4000000)
1148 if (len > (real->max_length - real->len))
1149 return FALSE; /* real->len + len would overflow */
1151 if (!set_length (real, real->len + len))
1154 out = real->str + (real->len - len);
1156 for (i = len - 1; i > 0; --i)
1158 out[i] = (ch & 0x3f) | 0x80;
1161 out[0] = ch | first;
1167 delete (DBusRealString *real,
1174 memmove (real->str + start, real->str + start + len, real->len - (start + len));
1176 real->str[real->len] = '\0';
1180 * Deletes a segment of a DBusString with length len starting at
1181 * start. (Hint: to clear an entire string, setting length to 0
1182 * with _dbus_string_set_length() is easier.)
1184 * @param str the DBusString
1185 * @param start where to start deleting
1186 * @param len the number of bytes to delete
1189 _dbus_string_delete (DBusString *str,
1193 DBUS_STRING_PREAMBLE (str);
1194 _dbus_assert (start >= 0);
1195 _dbus_assert (len >= 0);
1196 _dbus_assert (start <= real->len);
1197 _dbus_assert (len <= real->len - start);
1199 delete (real, start, len);
1203 copy (DBusRealString *source,
1206 DBusRealString *dest,
1212 if (!open_gap (len, dest, insert_at))
1215 memcpy (dest->str + insert_at,
1216 source->str + start,
1223 * Checks assertions for two strings we're copying a segment between,
1224 * and declares real_source/real_dest variables.
1226 * @param source the source string
1227 * @param start the starting offset
1228 * @param dest the dest string
1229 * @param insert_at where the copied segment is inserted
1231 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at) \
1232 DBusRealString *real_source = (DBusRealString*) source; \
1233 DBusRealString *real_dest = (DBusRealString*) dest; \
1234 _dbus_assert ((source) != (dest)); \
1235 DBUS_GENERIC_STRING_PREAMBLE (real_source); \
1236 DBUS_GENERIC_STRING_PREAMBLE (real_dest); \
1237 _dbus_assert (!real_dest->constant); \
1238 _dbus_assert (!real_dest->locked); \
1239 _dbus_assert ((start) >= 0); \
1240 _dbus_assert ((start) <= real_source->len); \
1241 _dbus_assert ((insert_at) >= 0); \
1242 _dbus_assert ((insert_at) <= real_dest->len)
1245 * Moves the end of one string into another string. Both strings
1246 * must be initialized, valid strings.
1248 * @param source the source string
1249 * @param start where to chop off the source string
1250 * @param dest the destination string
1251 * @param insert_at where to move the chopped-off part of source string
1252 * @returns #FALSE if not enough memory
1255 _dbus_string_move (DBusString *source,
1260 DBusRealString *real_source = (DBusRealString*) source;
1261 _dbus_assert (start <= real_source->len);
1263 return _dbus_string_move_len (source, start,
1264 real_source->len - start,
1269 * Like _dbus_string_move(), but does not delete the section
1270 * of the source string that's copied to the dest string.
1272 * @param source the source string
1273 * @param start where to start copying the source string
1274 * @param dest the destination string
1275 * @param insert_at where to place the copied part of source string
1276 * @returns #FALSE if not enough memory
1279 _dbus_string_copy (const DBusString *source,
1284 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1286 return copy (real_source, start,
1287 real_source->len - start,
1293 * Like _dbus_string_move(), but can move a segment from
1294 * the middle of the source string.
1296 * @todo this doesn't do anything with max_length field.
1297 * we should probably just kill the max_length field though.
1299 * @param source the source string
1300 * @param start first byte of source string to move
1301 * @param len length of segment to move
1302 * @param dest the destination string
1303 * @param insert_at where to move the bytes from the source string
1304 * @returns #FALSE if not enough memory
1307 _dbus_string_move_len (DBusString *source,
1314 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1315 _dbus_assert (len >= 0);
1316 _dbus_assert ((start + len) <= real_source->len);
1323 else if (start == 0 &&
1324 len == real_source->len &&
1325 real_dest->len == 0)
1327 /* Short-circuit moving an entire existing string to an empty string
1328 * by just swapping the buffers.
1330 /* we assume ->constant doesn't matter as you can't have
1331 * a constant string involved in a move.
1333 #define ASSIGN_DATA(a, b) do { \
1334 (a)->str = (b)->str; \
1335 (a)->len = (b)->len; \
1336 (a)->allocated = (b)->allocated; \
1337 (a)->align_offset = (b)->align_offset; \
1342 ASSIGN_DATA (&tmp, real_source);
1343 ASSIGN_DATA (real_source, real_dest);
1344 ASSIGN_DATA (real_dest, &tmp);
1350 if (!copy (real_source, start, len,
1355 delete (real_source, start,
1363 * Like _dbus_string_copy(), but can copy a segment from the middle of
1364 * the source string.
1366 * @param source the source string
1367 * @param start where to start copying the source string
1368 * @param len length of segment to copy
1369 * @param dest the destination string
1370 * @param insert_at where to place the copied segment of source string
1371 * @returns #FALSE if not enough memory
1374 _dbus_string_copy_len (const DBusString *source,
1380 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1381 _dbus_assert (len >= 0);
1382 _dbus_assert (start <= real_source->len);
1383 _dbus_assert (len <= real_source->len - start);
1385 return copy (real_source, start, len,
1391 * Replaces a segment of dest string with a segment of source string.
1393 * @todo optimize the case where the two lengths are the same, and
1394 * avoid memmoving the data in the trailing part of the string twice.
1396 * @todo avoid inserting the source into dest, then deleting
1397 * the replaced chunk of dest (which creates a potentially large
1398 * intermediate string). Instead, extend the replaced chunk
1399 * of dest with padding to the same size as the source chunk,
1400 * then copy in the source bytes.
1402 * @param source the source string
1403 * @param start where to start copying the source string
1404 * @param len length of segment to copy
1405 * @param dest the destination string
1406 * @param replace_at start of segment of dest string to replace
1407 * @param replace_len length of segment of dest string to replace
1408 * @returns #FALSE if not enough memory
1412 _dbus_string_replace_len (const DBusString *source,
1419 DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1420 _dbus_assert (len >= 0);
1421 _dbus_assert (start <= real_source->len);
1422 _dbus_assert (len <= real_source->len - start);
1423 _dbus_assert (replace_at >= 0);
1424 _dbus_assert (replace_at <= real_dest->len);
1425 _dbus_assert (replace_len <= real_dest->len - replace_at);
1427 if (!copy (real_source, start, len,
1428 real_dest, replace_at))
1431 delete (real_dest, replace_at + len, replace_len);
1436 /* Unicode macros and utf8_validate() from GLib Owen Taylor, Havoc
1437 * Pennington, and Tom Tromey are the authors and authorized relicense.
1440 /** computes length and mask of a unicode character
1441 * @param Char the char
1442 * @param Mask the mask variable to assign to
1443 * @param Len the length variable to assign to
1445 #define UTF8_COMPUTE(Char, Mask, Len) \
1451 else if ((Char & 0xe0) == 0xc0) \
1456 else if ((Char & 0xf0) == 0xe0) \
1461 else if ((Char & 0xf8) == 0xf0) \
1466 else if ((Char & 0xfc) == 0xf8) \
1471 else if ((Char & 0xfe) == 0xfc) \
1480 * computes length of a unicode character in UTF-8
1481 * @param Char the char
1483 #define UTF8_LENGTH(Char) \
1484 ((Char) < 0x80 ? 1 : \
1485 ((Char) < 0x800 ? 2 : \
1486 ((Char) < 0x10000 ? 3 : \
1487 ((Char) < 0x200000 ? 4 : \
1488 ((Char) < 0x4000000 ? 5 : 6)))))
1491 * Gets a UTF-8 value.
1493 * @param Result variable for extracted unicode char.
1494 * @param Chars the bytes to decode
1495 * @param Count counter variable
1496 * @param Mask mask for this char
1497 * @param Len length for this char in bytes
1499 #define UTF8_GET(Result, Chars, Count, Mask, Len) \
1500 (Result) = (Chars)[0] & (Mask); \
1501 for ((Count) = 1; (Count) < (Len); ++(Count)) \
1503 if (((Chars)[(Count)] & 0xc0) != 0x80) \
1509 (Result) |= ((Chars)[(Count)] & 0x3f); \
1513 * Check whether a unicode char is in a valid range.
1515 * @param Char the character
1517 #define UNICODE_VALID(Char) \
1518 ((Char) < 0x110000 && \
1519 (((Char) & 0xFFFFF800) != 0xD800) && \
1520 ((Char) < 0xFDD0 || (Char) > 0xFDEF) && \
1521 ((Char) & 0xFFFF) != 0xFFFF)
1524 * Gets a unicode character from a UTF-8 string. Does no validation;
1525 * you must verify that the string is valid UTF-8 in advance and must
1526 * pass in the start of a character.
1528 * @param str the string
1529 * @param start the start of the UTF-8 character.
1530 * @param ch_return location to return the character
1531 * @param end_return location to return the byte index of next character
1534 _dbus_string_get_unichar (const DBusString *str,
1536 dbus_unichar_t *ch_return,
1540 dbus_unichar_t result;
1543 DBUS_CONST_STRING_PREAMBLE (str);
1544 _dbus_assert (start >= 0);
1545 _dbus_assert (start <= real->len);
1550 *end_return = real->len;
1553 p = real->str + start;
1556 UTF8_COMPUTE (c, mask, len);
1559 UTF8_GET (result, p, i, mask, len);
1561 if (result == (dbus_unichar_t)-1)
1565 *ch_return = result;
1567 *end_return = start + len;
1571 * Finds the given substring in the string,
1572 * returning #TRUE and filling in the byte index
1573 * where the substring was found, if it was found.
1574 * Returns #FALSE if the substring wasn't found.
1575 * Sets *start to the length of the string if the substring
1578 * @param str the string
1579 * @param start where to start looking
1580 * @param substr the substring
1581 * @param found return location for where it was found, or #NULL
1582 * @returns #TRUE if found
1585 _dbus_string_find (const DBusString *str,
1590 return _dbus_string_find_to (str, start,
1591 ((const DBusRealString*)str)->len,
1596 * Finds the given substring in the string,
1597 * up to a certain position,
1598 * returning #TRUE and filling in the byte index
1599 * where the substring was found, if it was found.
1600 * Returns #FALSE if the substring wasn't found.
1601 * Sets *start to the length of the string if the substring
1604 * @param str the string
1605 * @param start where to start looking
1606 * @param end where to stop looking
1607 * @param substr the substring
1608 * @param found return location for where it was found, or #NULL
1609 * @returns #TRUE if found
1612 _dbus_string_find_to (const DBusString *str,
1619 DBUS_CONST_STRING_PREAMBLE (str);
1620 _dbus_assert (substr != NULL);
1621 _dbus_assert (start <= real->len);
1622 _dbus_assert (start >= 0);
1623 _dbus_assert (substr != NULL);
1624 _dbus_assert (end <= real->len);
1625 _dbus_assert (start <= end);
1627 /* we always "find" an empty string */
1628 if (*substr == '\0')
1638 if (real->str[i] == substr[0])
1644 if (substr[j - i] == '\0')
1646 else if (real->str[j] != substr[j - i])
1652 if (substr[j - i] == '\0')
1670 * Find the given byte scanning backward from the given start.
1671 * Sets *found to -1 if the byte is not found.
1673 * @param str the string
1674 * @param start the place to start scanning (will not find the byte at this point)
1675 * @param byte the byte to find
1676 * @param found return location for where it was found
1677 * @returns #TRUE if found
1680 _dbus_string_find_byte_backward (const DBusString *str,
1686 DBUS_CONST_STRING_PREAMBLE (str);
1687 _dbus_assert (start <= real->len);
1688 _dbus_assert (start >= 0);
1689 _dbus_assert (found != NULL);
1694 if (real->str[i] == byte)
1707 * Finds a blank (space or tab) in the string. Returns #TRUE
1708 * if found, #FALSE otherwise. If a blank is not found sets
1709 * *found to the length of the string.
1711 * @param str the string
1712 * @param start byte index to start looking
1713 * @param found place to store the location of the first blank
1714 * @returns #TRUE if a blank was found
1717 _dbus_string_find_blank (const DBusString *str,
1722 DBUS_CONST_STRING_PREAMBLE (str);
1723 _dbus_assert (start <= real->len);
1724 _dbus_assert (start >= 0);
1727 while (i < real->len)
1729 if (real->str[i] == ' ' ||
1730 real->str[i] == '\t')
1747 * Skips blanks from start, storing the first non-blank in *end
1748 * (blank is space or tab).
1750 * @param str the string
1751 * @param start where to start
1752 * @param end where to store the first non-blank byte index
1755 _dbus_string_skip_blank (const DBusString *str,
1760 DBUS_CONST_STRING_PREAMBLE (str);
1761 _dbus_assert (start <= real->len);
1762 _dbus_assert (start >= 0);
1765 while (i < real->len)
1767 if (!(real->str[i] == ' ' ||
1768 real->str[i] == '\t'))
1774 _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1775 real->str[i] == '\t'));
1782 * Skips whitespace from start, storing the first non-whitespace in *end.
1783 * (whitespace is space, tab, newline, CR).
1785 * @param str the string
1786 * @param start where to start
1787 * @param end where to store the first non-whitespace byte index
1790 _dbus_string_skip_white (const DBusString *str,
1795 DBUS_CONST_STRING_PREAMBLE (str);
1796 _dbus_assert (start <= real->len);
1797 _dbus_assert (start >= 0);
1800 while (i < real->len)
1802 if (!(real->str[i] == ' ' ||
1803 real->str[i] == '\n' ||
1804 real->str[i] == '\r' ||
1805 real->str[i] == '\t'))
1811 _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1812 real->str[i] == '\t'));
1819 * Assigns a newline-terminated or \\r\\n-terminated line from the front
1820 * of the string to the given dest string. The dest string's previous
1821 * contents are deleted. If the source string contains no newline,
1822 * moves the entire source string to the dest string.
1824 * @todo owen correctly notes that this is a stupid function (it was
1825 * written purely for test code,
1826 * e.g. dbus-message-builder.c). Probably should be enforced as test
1827 * code only with #ifdef DBUS_BUILD_TESTS
1829 * @param source the source string
1830 * @param dest the destination string (contents are replaced)
1831 * @returns #FALSE if no memory, or source has length 0
1834 _dbus_string_pop_line (DBusString *source,
1838 dbus_bool_t have_newline;
1840 _dbus_string_set_length (dest, 0);
1843 if (_dbus_string_find (source, 0, "\n", &eol))
1845 have_newline = TRUE;
1846 eol += 1; /* include newline */
1850 eol = _dbus_string_get_length (source);
1851 have_newline = FALSE;
1855 return FALSE; /* eof */
1857 if (!_dbus_string_move_len (source, 0, eol,
1863 /* dump the newline and the \r if we have one */
1866 dbus_bool_t have_cr;
1868 _dbus_assert (_dbus_string_get_length (dest) > 0);
1870 if (_dbus_string_get_length (dest) > 1 &&
1871 _dbus_string_get_byte (dest,
1872 _dbus_string_get_length (dest) - 2) == '\r')
1877 _dbus_string_set_length (dest,
1878 _dbus_string_get_length (dest) -
1886 * Deletes up to and including the first blank space
1889 * @param str the string
1892 _dbus_string_delete_first_word (DBusString *str)
1896 if (_dbus_string_find_blank (str, 0, &i))
1897 _dbus_string_skip_blank (str, i, &i);
1899 _dbus_string_delete (str, 0, i);
1903 * Deletes any leading blanks in the string
1905 * @param str the string
1908 _dbus_string_delete_leading_blanks (DBusString *str)
1912 _dbus_string_skip_blank (str, 0, &i);
1915 _dbus_string_delete (str, 0, i);
1919 * Tests two DBusString for equality.
1921 * @todo memcmp is probably faster
1923 * @param a first string
1924 * @param b second string
1925 * @returns #TRUE if equal
1928 _dbus_string_equal (const DBusString *a,
1929 const DBusString *b)
1931 const unsigned char *ap;
1932 const unsigned char *bp;
1933 const unsigned char *a_end;
1934 const DBusRealString *real_a = (const DBusRealString*) a;
1935 const DBusRealString *real_b = (const DBusRealString*) b;
1936 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1937 DBUS_GENERIC_STRING_PREAMBLE (real_b);
1939 if (real_a->len != real_b->len)
1944 a_end = real_a->str + real_a->len;
1958 * Tests two DBusString for equality up to the given length.
1960 * @todo write a unit test
1962 * @todo memcmp is probably faster
1964 * @param a first string
1965 * @param b second string
1966 * @param len the lengh
1967 * @returns #TRUE if equal for the given number of bytes
1970 _dbus_string_equal_len (const DBusString *a,
1971 const DBusString *b,
1974 const unsigned char *ap;
1975 const unsigned char *bp;
1976 const unsigned char *a_end;
1977 const DBusRealString *real_a = (const DBusRealString*) a;
1978 const DBusRealString *real_b = (const DBusRealString*) b;
1979 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1980 DBUS_GENERIC_STRING_PREAMBLE (real_b);
1982 if (real_a->len != real_b->len &&
1983 (real_a->len < len || real_b->len < len))
1988 a_end = real_a->str + MIN (real_a->len, len);
2002 * Checks whether a string is equal to a C string.
2004 * @param a the string
2005 * @param c_str the C string
2006 * @returns #TRUE if equal
2009 _dbus_string_equal_c_str (const DBusString *a,
2012 const unsigned char *ap;
2013 const unsigned char *bp;
2014 const unsigned char *a_end;
2015 const DBusRealString *real_a = (const DBusRealString*) a;
2016 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2017 _dbus_assert (c_str != NULL);
2020 bp = (const unsigned char*) c_str;
2021 a_end = real_a->str + real_a->len;
2022 while (ap != a_end && *bp)
2031 if (ap != a_end || *bp)
2038 * Checks whether a string starts with the given C string.
2040 * @param a the string
2041 * @param c_str the C string
2042 * @returns #TRUE if string starts with it
2045 _dbus_string_starts_with_c_str (const DBusString *a,
2048 const unsigned char *ap;
2049 const unsigned char *bp;
2050 const unsigned char *a_end;
2051 const DBusRealString *real_a = (const DBusRealString*) a;
2052 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2053 _dbus_assert (c_str != NULL);
2056 bp = (const unsigned char*) c_str;
2057 a_end = real_a->str + real_a->len;
2058 while (ap != a_end && *bp)
2074 * Returns whether a string ends with the given suffix
2076 * @todo memcmp might make this faster.
2078 * @param a the string
2079 * @param c_str the C-style string
2080 * @returns #TRUE if the string ends with the suffix
2083 _dbus_string_ends_with_c_str (const DBusString *a,
2086 const unsigned char *ap;
2087 const unsigned char *bp;
2088 const unsigned char *a_end;
2089 unsigned long c_str_len;
2090 const DBusRealString *real_a = (const DBusRealString*) a;
2091 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2092 _dbus_assert (c_str != NULL);
2094 c_str_len = strlen (c_str);
2095 if (((unsigned long)real_a->len) < c_str_len)
2098 ap = real_a->str + (real_a->len - c_str_len);
2099 bp = (const unsigned char*) c_str;
2100 a_end = real_a->str + real_a->len;
2110 _dbus_assert (*ap == '\0');
2111 _dbus_assert (*bp == '\0');
2116 static const signed char base64_table[] = {
2183 /** The minimum char that's a valid char in Base64-encoded text */
2184 #define UNBASE64_MIN_CHAR (43)
2185 /** The maximum char that's a valid char in Base64-encoded text */
2186 #define UNBASE64_MAX_CHAR (122)
2187 /** Must subtract this from a char's integer value before offsetting
2188 * into unbase64_table
2190 #define UNBASE64_TABLE_OFFSET UNBASE64_MIN_CHAR
2191 static const signed char unbase64_table[] = {
2275 * Encodes a string using Base64, as documented in RFC 2045.
2277 * @param source the string to encode
2278 * @param start byte index to start encoding
2279 * @param dest string where encoded data should be placed
2280 * @param insert_at where to place encoded data
2281 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2284 _dbus_string_base64_encode (const DBusString *source,
2290 unsigned int dest_len; /* unsigned for overflow checks below */
2291 const unsigned char *s;
2293 const unsigned char *triplet_end;
2294 const unsigned char *final_end;
2295 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2296 _dbus_assert (source != dest);
2298 /* For each 24 bits (3 bytes) of input, we have 4 bytes of
2301 source_len = real_source->len - start;
2302 dest_len = (source_len / 3) * 4;
2303 if (source_len % 3 != 0)
2306 if (dest_len > (unsigned int) real_dest->max_length)
2309 if (source_len == 0)
2312 if (!open_gap (dest_len, real_dest, insert_at))
2315 d = real_dest->str + insert_at;
2316 s = real_source->str + start;
2317 final_end = real_source->str + (start + source_len);
2318 triplet_end = final_end - (source_len % 3);
2319 _dbus_assert (triplet_end <= final_end);
2320 _dbus_assert ((final_end - triplet_end) < 3);
2322 #define ENCODE_64(v) (base64_table[ (unsigned char) (v) ])
2323 #define SIX_BITS_MASK (0x3f)
2324 _dbus_assert (SIX_BITS_MASK < _DBUS_N_ELEMENTS (base64_table));
2326 while (s != triplet_end)
2328 unsigned int triplet;
2330 triplet = s[2] | (s[1] << 8) | (s[0] << 16);
2332 /* Encode each 6 bits. */
2334 *d++ = ENCODE_64 (triplet >> 18);
2335 *d++ = ENCODE_64 ((triplet >> 12) & SIX_BITS_MASK);
2336 *d++ = ENCODE_64 ((triplet >> 6) & SIX_BITS_MASK);
2337 *d++ = ENCODE_64 (triplet & SIX_BITS_MASK);
2342 switch (final_end - triplet_end)
2346 unsigned int doublet;
2348 doublet = s[1] | (s[0] << 8);
2350 *d++ = ENCODE_64 (doublet >> 12);
2351 *d++ = ENCODE_64 ((doublet >> 6) & SIX_BITS_MASK);
2352 *d++ = ENCODE_64 (doublet & SIX_BITS_MASK);
2358 unsigned int singlet;
2362 *d++ = ENCODE_64 ((singlet >> 6) & SIX_BITS_MASK);
2363 *d++ = ENCODE_64 (singlet & SIX_BITS_MASK);
2372 _dbus_assert (d == (real_dest->str + (insert_at + dest_len)));
2378 * Decodes a string from Base64, as documented in RFC 2045.
2380 * @todo sort out the AUDIT comment in here. The case it mentions
2381 * ("====" or "x===") is not allowed in correct base64, so need to
2382 * decide what to do with that kind of input. Probably ignore it
2383 * since we ignore any other junk seen.
2385 * @param source the string to decode
2386 * @param start byte index to start decode
2387 * @param dest string where decoded data should be placed
2388 * @param insert_at where to place decoded data
2389 * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2392 _dbus_string_base64_decode (const DBusString *source,
2401 unsigned int triplet = 0;
2404 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2405 _dbus_assert (source != dest);
2407 source_len = real_source->len - start;
2408 s = real_source->str + start;
2409 end = real_source->str + source_len;
2411 if (source_len == 0)
2414 if (!_dbus_string_init (&result))
2421 /* The idea is to just skip anything that isn't
2422 * a base64 char - it's allowed to have whitespace,
2423 * newlines, etc. in here. We also ignore trailing
2424 * base64 chars, though that's suspicious.
2427 if (*s >= UNBASE64_MIN_CHAR &&
2428 *s <= UNBASE64_MAX_CHAR)
2432 /* '=' is padding, doesn't represent additional data
2433 * but does increment our count.
2442 val = unbase64_table[(*s) - UNBASE64_TABLE_OFFSET];
2447 triplet |= (unsigned int) val;
2452 if (sextet_count == 4)
2454 /* no pad = 3 bytes, 1 pad = 2 bytes, 2 pad = 1 byte */
2457 /* AUDIT: Comment doesn't mention 4 pad => 0,
2458 * 3 pad => 1 byte, though the code should
2459 * work fine if those are the required outputs.
2461 * I assume that the spec requires dropping
2462 * the top two bits of, say, ///= which is > 2
2463 * bytes worth of bits. (Or otherwise, you couldn't
2464 * actually represent 2 byte sequences.
2469 if (!_dbus_string_append_byte (&result,
2476 if (!_dbus_string_append_byte (&result,
2477 (triplet >> 8) & 0xff))
2481 if (!_dbus_string_append_byte (&result,
2494 if (!_dbus_string_move (&result, 0, dest, insert_at))
2496 _dbus_string_free (&result);
2500 _dbus_string_free (&result);
2505 _dbus_string_free (&result);
2511 * Encodes a string in hex, the way MD5 and SHA-1 are usually
2512 * encoded. (Each byte is two hex digits.)
2514 * @param source the string to encode
2515 * @param start byte index to start encoding
2516 * @param dest string where encoded data should be placed
2517 * @param insert_at where to place encoded data
2518 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2521 _dbus_string_hex_encode (const DBusString *source,
2527 const char hexdigits[16] = {
2528 '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
2529 'a', 'b', 'c', 'd', 'e', 'f'
2531 const unsigned char *p;
2532 const unsigned char *end;
2535 _dbus_assert (start <= _dbus_string_get_length (source));
2537 if (!_dbus_string_init (&result))
2542 p = (const unsigned char*) _dbus_string_get_const_data (source);
2543 end = p + _dbus_string_get_length (source);
2548 if (!_dbus_string_append_byte (&result,
2549 hexdigits[(*p >> 4)]))
2552 if (!_dbus_string_append_byte (&result,
2553 hexdigits[(*p & 0x0f)]))
2559 if (!_dbus_string_move (&result, 0, dest, insert_at))
2565 _dbus_string_free (&result);
2570 * Decodes a string from hex encoding.
2572 * @param source the string to decode
2573 * @param start byte index to start decode
2574 * @param dest string where decoded data should be placed
2575 * @param insert_at where to place decoded data
2576 * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2579 _dbus_string_hex_decode (const DBusString *source,
2585 const unsigned char *p;
2586 const unsigned char *end;
2588 dbus_bool_t high_bits;
2590 _dbus_assert (start <= _dbus_string_get_length (source));
2592 if (!_dbus_string_init (&result))
2598 p = (const unsigned char*) _dbus_string_get_const_data (source);
2599 end = p + _dbus_string_get_length (source);
2664 _dbus_verbose ("invalid character '%c' in hex encoded text\n",
2671 if (!_dbus_string_append_byte (&result,
2680 len = _dbus_string_get_length (&result);
2682 b = _dbus_string_get_byte (&result, len - 1);
2686 _dbus_string_set_byte (&result, len - 1, b);
2689 high_bits = !high_bits;
2694 if (!_dbus_string_move (&result, 0, dest, insert_at))
2700 _dbus_string_free (&result);
2705 * Checks that the given range of the string is valid ASCII with no
2706 * nul bytes. If the given range is not entirely contained in the
2707 * string, returns #FALSE.
2709 * @todo this is inconsistent with most of DBusString in that
2710 * it allows a start,len range that isn't in the string.
2712 * @param str the string
2713 * @param start first byte index to check
2714 * @param len number of bytes to check
2715 * @returns #TRUE if the byte range exists and is all valid ASCII
2718 _dbus_string_validate_ascii (const DBusString *str,
2722 const unsigned char *s;
2723 const unsigned char *end;
2724 DBUS_CONST_STRING_PREAMBLE (str);
2725 _dbus_assert (start >= 0);
2726 _dbus_assert (start <= real->len);
2727 _dbus_assert (len >= 0);
2729 if (len > real->len - start)
2732 s = real->str + start;
2736 if (_DBUS_UNLIKELY (*s == '\0' ||
2737 ((*s & ~0x7f) != 0)))
2747 * Checks that the given range of the string is valid UTF-8. If the
2748 * given range is not entirely contained in the string, returns
2749 * #FALSE. If the string contains any nul bytes in the given range,
2750 * returns #FALSE. If the start and start+len are not on character
2751 * boundaries, returns #FALSE.
2753 * @todo this is inconsistent with most of DBusString in that
2754 * it allows a start,len range that isn't in the string.
2756 * @param str the string
2757 * @param start first byte index to check
2758 * @param len number of bytes to check
2759 * @returns #TRUE if the byte range exists and is all valid UTF-8
2762 _dbus_string_validate_utf8 (const DBusString *str,
2766 const unsigned char *p;
2767 const unsigned char *end;
2768 DBUS_CONST_STRING_PREAMBLE (str);
2769 _dbus_assert (start >= 0);
2770 _dbus_assert (start <= real->len);
2771 _dbus_assert (len >= 0);
2773 /* we are doing _DBUS_UNLIKELY() here which might be
2774 * dubious in a generic library like GLib, but in D-BUS
2775 * we know we're validating messages and that it would
2776 * only be evil/broken apps that would have invalid
2777 * UTF-8. Also, this function seems to be a performance
2778 * bottleneck in profiles.
2781 if (_DBUS_UNLIKELY (len > real->len - start))
2784 p = real->str + start;
2789 int i, mask = 0, char_len;
2790 dbus_unichar_t result;
2791 unsigned char c = (unsigned char) *p;
2793 UTF8_COMPUTE (c, mask, char_len);
2795 if (_DBUS_UNLIKELY (char_len == -1))
2798 /* check that the expected number of bytes exists in the remaining length */
2799 if (_DBUS_UNLIKELY ((end - p) < char_len))
2802 UTF8_GET (result, p, i, mask, char_len);
2804 if (_DBUS_UNLIKELY (UTF8_LENGTH (result) != char_len)) /* Check for overlong UTF-8 */
2807 if (_DBUS_UNLIKELY (result == (dbus_unichar_t)-1))
2810 if (_DBUS_UNLIKELY (!UNICODE_VALID (result)))
2816 /* See that we covered the entire length if a length was
2819 if (_DBUS_UNLIKELY (p != end))
2826 * Checks that the given range of the string is all nul bytes. If the
2827 * given range is not entirely contained in the string, returns
2830 * @todo this is inconsistent with most of DBusString in that
2831 * it allows a start,len range that isn't in the string.
2833 * @param str the string
2834 * @param start first byte index to check
2835 * @param len number of bytes to check
2836 * @returns #TRUE if the byte range exists and is all nul bytes
2839 _dbus_string_validate_nul (const DBusString *str,
2843 const unsigned char *s;
2844 const unsigned char *end;
2845 DBUS_CONST_STRING_PREAMBLE (str);
2846 _dbus_assert (start >= 0);
2847 _dbus_assert (len >= 0);
2848 _dbus_assert (start <= real->len);
2850 if (len > real->len - start)
2853 s = real->str + start;
2857 if (_DBUS_UNLIKELY (*s != '\0'))
2866 * Checks that the given range of the string is a valid object path
2867 * name in the D-BUS protocol. This includes a length restriction,
2868 * etc., see the specification. It does not validate UTF-8, that has
2869 * to be done separately for now.
2871 * @todo this is inconsistent with most of DBusString in that
2872 * it allows a start,len range that isn't in the string.
2874 * @todo change spec to disallow more things, such as spaces in the
2877 * @param str the string
2878 * @param start first byte index to check
2879 * @param len number of bytes to check
2880 * @returns #TRUE if the byte range exists and is a valid name
2883 _dbus_string_validate_path (const DBusString *str,
2887 const unsigned char *s;
2888 const unsigned char *end;
2889 const unsigned char *last_slash;
2891 DBUS_CONST_STRING_PREAMBLE (str);
2892 _dbus_assert (start >= 0);
2893 _dbus_assert (len >= 0);
2894 _dbus_assert (start <= real->len);
2896 if (len > real->len - start)
2899 if (len > DBUS_MAXIMUM_NAME_LENGTH)
2905 s = real->str + start;
2917 if ((s - last_slash) < 2)
2918 return FALSE; /* no empty path components allowed */
2926 if ((end - last_slash) < 2 &&
2928 return FALSE; /* trailing slash not allowed unless the string is "/" */
2933 #define VALID_INITIAL_NAME_CHARACTER(c) \
2934 ( ((c) >= 'A' && (c) <= 'Z') || \
2935 ((c) >= 'a' && (c) <= 'z') || \
2938 #define VALID_NAME_CHARACTER(c) \
2939 ( ((c) >= '0' && (c) <= '9') || \
2940 ((c) >= 'A' && (c) <= 'Z') || \
2941 ((c) >= 'a' && (c) <= 'z') || \
2945 * Checks that the given range of the string is a valid interface name
2946 * in the D-BUS protocol. This includes a length restriction and an
2947 * ASCII subset, see the specification.
2949 * @todo this is inconsistent with most of DBusString in that
2950 * it allows a start,len range that isn't in the string.
2952 * @param str the string
2953 * @param start first byte index to check
2954 * @param len number of bytes to check
2955 * @returns #TRUE if the byte range exists and is a valid name
2958 _dbus_string_validate_interface (const DBusString *str,
2962 const unsigned char *s;
2963 const unsigned char *end;
2964 const unsigned char *iface;
2965 const unsigned char *last_dot;
2967 DBUS_CONST_STRING_PREAMBLE (str);
2968 _dbus_assert (start >= 0);
2969 _dbus_assert (len >= 0);
2970 _dbus_assert (start <= real->len);
2972 if (len > real->len - start)
2975 if (len > DBUS_MAXIMUM_NAME_LENGTH)
2982 iface = real->str + start;
2986 /* check special cases of first char so it doesn't have to be done
2987 * in the loop. Note we know len > 0
2989 if (_DBUS_UNLIKELY (*s == '.')) /* disallow starting with a . */
2991 else if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*s)))
3000 if (_DBUS_UNLIKELY ((s + 1) == end))
3002 else if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*(s + 1))))
3005 ++s; /* we just validated the next char, so skip two */
3007 else if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
3015 if (_DBUS_UNLIKELY (last_dot == NULL))
3022 * Checks that the given range of the string is a valid member name
3023 * in the D-BUS protocol. This includes a length restriction, etc.,
3024 * see the specification.
3026 * @todo this is inconsistent with most of DBusString in that
3027 * it allows a start,len range that isn't in the string.
3029 * @param str the string
3030 * @param start first byte index to check
3031 * @param len number of bytes to check
3032 * @returns #TRUE if the byte range exists and is a valid name
3035 _dbus_string_validate_member (const DBusString *str,
3039 const unsigned char *s;
3040 const unsigned char *end;
3041 const unsigned char *member;
3043 DBUS_CONST_STRING_PREAMBLE (str);
3044 _dbus_assert (start >= 0);
3045 _dbus_assert (len >= 0);
3046 _dbus_assert (start <= real->len);
3048 if (len > real->len - start)
3051 if (len > DBUS_MAXIMUM_NAME_LENGTH)
3057 member = real->str + start;
3061 /* check special cases of first char so it doesn't have to be done
3062 * in the loop. Note we know len > 0
3065 if (_DBUS_UNLIKELY (!VALID_INITIAL_NAME_CHARACTER (*s)))
3072 if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
3084 * Checks that the given range of the string is a valid error name
3085 * in the D-BUS protocol. This includes a length restriction, etc.,
3086 * see the specification.
3088 * @todo this is inconsistent with most of DBusString in that
3089 * it allows a start,len range that isn't in the string.
3091 * @param str the string
3092 * @param start first byte index to check
3093 * @param len number of bytes to check
3094 * @returns #TRUE if the byte range exists and is a valid name
3097 _dbus_string_validate_error_name (const DBusString *str,
3101 /* Same restrictions as interface name at the moment */
3102 return _dbus_string_validate_interface (str, start, len);
3105 /* This assumes the first char exists and is ':' */
3107 _dbus_string_validate_base_service (const DBusString *str,
3111 const unsigned char *s;
3112 const unsigned char *end;
3113 const unsigned char *service;
3115 DBUS_CONST_STRING_PREAMBLE (str);
3116 _dbus_assert (start >= 0);
3117 _dbus_assert (len >= 0);
3118 _dbus_assert (start <= real->len);
3120 if (len > real->len - start)
3123 if (len > DBUS_MAXIMUM_NAME_LENGTH)
3126 _dbus_assert (len > 0);
3128 service = real->str + start;
3129 end = service + len;
3130 _dbus_assert (*service == ':');
3137 if (_DBUS_UNLIKELY ((s + 1) == end))
3139 if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*(s + 1))))
3141 ++s; /* we just validated the next char, so skip two */
3143 else if (_DBUS_UNLIKELY (!VALID_NAME_CHARACTER (*s)))
3155 * Checks that the given range of the string is a valid service name
3156 * in the D-BUS protocol. This includes a length restriction, etc.,
3157 * see the specification.
3159 * @todo this is inconsistent with most of DBusString in that
3160 * it allows a start,len range that isn't in the string.
3162 * @param str the string
3163 * @param start first byte index to check
3164 * @param len number of bytes to check
3165 * @returns #TRUE if the byte range exists and is a valid name
3168 _dbus_string_validate_service (const DBusString *str,
3172 if (_DBUS_UNLIKELY (len == 0))
3174 if (_dbus_string_get_byte (str, start) == ':')
3175 return _dbus_string_validate_base_service (str, start, len);
3177 return _dbus_string_validate_interface (str, start, len);
3181 * Clears all allocated bytes in the string to zero.
3183 * @param str the string
3186 _dbus_string_zero (DBusString *str)
3188 DBUS_STRING_PREAMBLE (str);
3190 memset (real->str - real->align_offset, '\0', real->allocated);
3194 #ifdef DBUS_BUILD_TESTS
3195 #include "dbus-test.h"
3199 test_max_len (DBusString *str,
3204 if (!_dbus_string_set_length (str, max_len - 1))
3205 _dbus_assert_not_reached ("setting len to one less than max should have worked");
3208 if (!_dbus_string_set_length (str, max_len))
3209 _dbus_assert_not_reached ("setting len to max len should have worked");
3211 if (_dbus_string_set_length (str, max_len + 1))
3212 _dbus_assert_not_reached ("setting len to one more than max len should not have worked");
3214 if (!_dbus_string_set_length (str, 0))
3215 _dbus_assert_not_reached ("setting len to zero should have worked");
3219 test_base64_roundtrip (const unsigned char *data,
3227 len = strlen (data);
3229 if (!_dbus_string_init (&orig))
3230 _dbus_assert_not_reached ("could not init string");
3232 if (!_dbus_string_init (&encoded))
3233 _dbus_assert_not_reached ("could not init string");
3235 if (!_dbus_string_init (&decoded))
3236 _dbus_assert_not_reached ("could not init string");
3238 if (!_dbus_string_append_len (&orig, data, len))
3239 _dbus_assert_not_reached ("couldn't append orig data");
3241 if (!_dbus_string_base64_encode (&orig, 0, &encoded, 0))
3242 _dbus_assert_not_reached ("could not encode");
3244 if (!_dbus_string_base64_decode (&encoded, 0, &decoded, 0))
3245 _dbus_assert_not_reached ("could not decode");
3247 if (!_dbus_string_equal (&orig, &decoded))
3251 printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
3252 _dbus_string_get_length (&orig),
3253 _dbus_string_get_length (&encoded),
3254 _dbus_string_get_length (&decoded));
3255 printf ("Original: %s\n", data);
3256 s = _dbus_string_get_const_data (&decoded);
3257 printf ("Decoded: %s\n", s);
3258 _dbus_assert_not_reached ("original string not the same as string decoded from base64");
3261 _dbus_string_free (&orig);
3262 _dbus_string_free (&encoded);
3263 _dbus_string_free (&decoded);
3267 test_hex_roundtrip (const unsigned char *data,
3275 len = strlen (data);
3277 if (!_dbus_string_init (&orig))
3278 _dbus_assert_not_reached ("could not init string");
3280 if (!_dbus_string_init (&encoded))
3281 _dbus_assert_not_reached ("could not init string");
3283 if (!_dbus_string_init (&decoded))
3284 _dbus_assert_not_reached ("could not init string");
3286 if (!_dbus_string_append_len (&orig, data, len))
3287 _dbus_assert_not_reached ("couldn't append orig data");
3289 if (!_dbus_string_hex_encode (&orig, 0, &encoded, 0))
3290 _dbus_assert_not_reached ("could not encode");
3292 if (!_dbus_string_hex_decode (&encoded, 0, &decoded, 0))
3293 _dbus_assert_not_reached ("could not decode");
3295 if (!_dbus_string_equal (&orig, &decoded))
3299 printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
3300 _dbus_string_get_length (&orig),
3301 _dbus_string_get_length (&encoded),
3302 _dbus_string_get_length (&decoded));
3303 printf ("Original: %s\n", data);
3304 s = _dbus_string_get_const_data (&decoded);
3305 printf ("Decoded: %s\n", s);
3306 _dbus_assert_not_reached ("original string not the same as string decoded from base64");
3309 _dbus_string_free (&orig);
3310 _dbus_string_free (&encoded);
3311 _dbus_string_free (&decoded);
3314 typedef void (* TestRoundtripFunc) (const unsigned char *data,
3317 test_roundtrips (TestRoundtripFunc func)
3319 (* func) ("Hello this is a string\n", -1);
3320 (* func) ("Hello this is a string\n1", -1);
3321 (* func) ("Hello this is a string\n12", -1);
3322 (* func) ("Hello this is a string\n123", -1);
3323 (* func) ("Hello this is a string\n1234", -1);
3324 (* func) ("Hello this is a string\n12345", -1);
3328 (* func) ("123", 3);
3329 (* func) ("1234", 4);
3330 (* func) ("12345", 5);
3334 (* func) ("123", 4);
3335 (* func) ("1234", 5);
3336 (* func) ("12345", 6);
3338 unsigned char buf[512];
3342 while (i < _DBUS_N_ELEMENTS (buf))
3348 while (i < _DBUS_N_ELEMENTS (buf))
3358 * @ingroup DBusStringInternals
3359 * Unit test for DBusString.
3361 * @todo Need to write tests for _dbus_string_copy() and
3362 * _dbus_string_move() moving to/from each of start/middle/end of a
3363 * string. Also need tests for _dbus_string_move_len ()
3365 * @returns #TRUE on success.
3368 _dbus_string_test (void)
3375 int lens[] = { 0, 1, 2, 3, 4, 5, 10, 16, 17, 18, 25, 31, 32, 33, 34, 35, 63, 64, 65, 66, 67, 68, 69, 70, 71, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136 };
3378 const char *valid_paths[] = {
3384 const char *invalid_paths[] = {
3400 const char *valid_interfaces[] = {
3401 "org.freedesktop.Foo",
3403 "Blah.Blah.Blah.Blah.Blah",
3406 "a0.b1.c2.d3.e4.f5.g6",
3409 const char *invalid_interfaces[] = {
3437 const char *valid_base_services[] = {
3446 ":abce.freedesktop.blah"
3448 const char *invalid_base_services[] = {
3462 const char *valid_members[] = {
3470 const char *invalid_members[] = {
3486 while (i < _DBUS_N_ELEMENTS (lens))
3488 if (!_dbus_string_init (&str))
3489 _dbus_assert_not_reached ("failed to init string");
3491 set_max_length (&str, lens[i]);
3493 test_max_len (&str, lens[i]);
3494 _dbus_string_free (&str);
3499 /* Test shortening and setting length */
3501 while (i < _DBUS_N_ELEMENTS (lens))
3505 if (!_dbus_string_init (&str))
3506 _dbus_assert_not_reached ("failed to init string");
3508 set_max_length (&str, lens[i]);
3510 if (!_dbus_string_set_length (&str, lens[i]))
3511 _dbus_assert_not_reached ("failed to set string length");
3516 _dbus_assert (_dbus_string_get_length (&str) == j);
3519 _dbus_string_shorten (&str, 1);
3520 _dbus_assert (_dbus_string_get_length (&str) == (j - 1));
3525 _dbus_string_free (&str);
3530 /* Test appending data */
3531 if (!_dbus_string_init (&str))
3532 _dbus_assert_not_reached ("failed to init string");
3537 if (!_dbus_string_append (&str, "a"))
3538 _dbus_assert_not_reached ("failed to append string to string\n");
3540 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 1);
3542 if (!_dbus_string_append_byte (&str, 'b'))
3543 _dbus_assert_not_reached ("failed to append byte to string\n");
3545 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 2);
3550 _dbus_string_free (&str);
3552 /* Check steal_data */
3554 if (!_dbus_string_init (&str))
3555 _dbus_assert_not_reached ("failed to init string");
3557 if (!_dbus_string_append (&str, "Hello World"))
3558 _dbus_assert_not_reached ("could not append to string");
3560 i = _dbus_string_get_length (&str);
3562 if (!_dbus_string_steal_data (&str, &s))
3563 _dbus_assert_not_reached ("failed to steal data");
3565 _dbus_assert (_dbus_string_get_length (&str) == 0);
3566 _dbus_assert (((int)strlen (s)) == i);
3572 if (!_dbus_string_append (&str, "Hello World"))
3573 _dbus_assert_not_reached ("could not append to string");
3575 i = _dbus_string_get_length (&str);
3577 if (!_dbus_string_init (&other))
3578 _dbus_assert_not_reached ("could not init string");
3580 if (!_dbus_string_move (&str, 0, &other, 0))
3581 _dbus_assert_not_reached ("could not move");
3583 _dbus_assert (_dbus_string_get_length (&str) == 0);
3584 _dbus_assert (_dbus_string_get_length (&other) == i);
3586 if (!_dbus_string_append (&str, "Hello World"))
3587 _dbus_assert_not_reached ("could not append to string");
3589 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other)))
3590 _dbus_assert_not_reached ("could not move");
3592 _dbus_assert (_dbus_string_get_length (&str) == 0);
3593 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
3595 if (!_dbus_string_append (&str, "Hello World"))
3596 _dbus_assert_not_reached ("could not append to string");
3598 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other) / 2))
3599 _dbus_assert_not_reached ("could not move");
3601 _dbus_assert (_dbus_string_get_length (&str) == 0);
3602 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
3604 _dbus_string_free (&other);
3608 if (!_dbus_string_append (&str, "Hello World"))
3609 _dbus_assert_not_reached ("could not append to string");
3611 i = _dbus_string_get_length (&str);
3613 if (!_dbus_string_init (&other))
3614 _dbus_assert_not_reached ("could not init string");
3616 if (!_dbus_string_copy (&str, 0, &other, 0))
3617 _dbus_assert_not_reached ("could not copy");
3619 _dbus_assert (_dbus_string_get_length (&str) == i);
3620 _dbus_assert (_dbus_string_get_length (&other) == i);
3622 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other)))
3623 _dbus_assert_not_reached ("could not copy");
3625 _dbus_assert (_dbus_string_get_length (&str) == i);
3626 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
3627 _dbus_assert (_dbus_string_equal_c_str (&other,
3628 "Hello WorldHello World"));
3630 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other) / 2))
3631 _dbus_assert_not_reached ("could not copy");
3633 _dbus_assert (_dbus_string_get_length (&str) == i);
3634 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
3635 _dbus_assert (_dbus_string_equal_c_str (&other,
3636 "Hello WorldHello WorldHello World"));
3638 _dbus_string_free (&str);
3639 _dbus_string_free (&other);
3643 if (!_dbus_string_init (&str))
3644 _dbus_assert_not_reached ("failed to init string");
3646 if (!_dbus_string_append (&str, "Hello World"))
3647 _dbus_assert_not_reached ("could not append to string");
3649 i = _dbus_string_get_length (&str);
3651 if (!_dbus_string_init (&other))
3652 _dbus_assert_not_reached ("could not init string");
3654 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3655 &other, 0, _dbus_string_get_length (&other)))
3656 _dbus_assert_not_reached ("could not replace");
3658 _dbus_assert (_dbus_string_get_length (&str) == i);
3659 _dbus_assert (_dbus_string_get_length (&other) == i);
3660 _dbus_assert (_dbus_string_equal_c_str (&other, "Hello World"));
3662 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3664 _dbus_assert_not_reached ("could not replace center space");
3666 _dbus_assert (_dbus_string_get_length (&str) == i);
3667 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3668 _dbus_assert (_dbus_string_equal_c_str (&other,
3669 "HelloHello WorldWorld"));
3672 if (!_dbus_string_replace_len (&str, 1, 1,
3674 _dbus_string_get_length (&other) - 1,
3676 _dbus_assert_not_reached ("could not replace end character");
3678 _dbus_assert (_dbus_string_get_length (&str) == i);
3679 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3680 _dbus_assert (_dbus_string_equal_c_str (&other,
3681 "HelloHello WorldWorle"));
3683 _dbus_string_free (&str);
3684 _dbus_string_free (&other);
3686 /* Check append/get unichar */
3688 if (!_dbus_string_init (&str))
3689 _dbus_assert_not_reached ("failed to init string");
3692 if (!_dbus_string_append_unichar (&str, 0xfffc))
3693 _dbus_assert_not_reached ("failed to append unichar");
3695 _dbus_string_get_unichar (&str, 0, &ch, &i);
3697 _dbus_assert (ch == 0xfffc);
3698 _dbus_assert (i == _dbus_string_get_length (&str));
3700 _dbus_string_free (&str);
3702 /* Check insert/set/get byte */
3704 if (!_dbus_string_init (&str))
3705 _dbus_assert_not_reached ("failed to init string");
3707 if (!_dbus_string_append (&str, "Hello"))
3708 _dbus_assert_not_reached ("failed to append Hello");
3710 _dbus_assert (_dbus_string_get_byte (&str, 0) == 'H');
3711 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'e');
3712 _dbus_assert (_dbus_string_get_byte (&str, 2) == 'l');
3713 _dbus_assert (_dbus_string_get_byte (&str, 3) == 'l');
3714 _dbus_assert (_dbus_string_get_byte (&str, 4) == 'o');
3716 _dbus_string_set_byte (&str, 1, 'q');
3717 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'q');
3719 if (!_dbus_string_insert_bytes (&str, 0, 1, 255))
3720 _dbus_assert_not_reached ("can't insert byte");
3722 if (!_dbus_string_insert_bytes (&str, 2, 4, 'Z'))
3723 _dbus_assert_not_reached ("can't insert byte");
3725 if (!_dbus_string_insert_bytes (&str, _dbus_string_get_length (&str), 1, 'W'))
3726 _dbus_assert_not_reached ("can't insert byte");
3728 _dbus_assert (_dbus_string_get_byte (&str, 0) == 255);
3729 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'H');
3730 _dbus_assert (_dbus_string_get_byte (&str, 2) == 'Z');
3731 _dbus_assert (_dbus_string_get_byte (&str, 3) == 'Z');
3732 _dbus_assert (_dbus_string_get_byte (&str, 4) == 'Z');
3733 _dbus_assert (_dbus_string_get_byte (&str, 5) == 'Z');
3734 _dbus_assert (_dbus_string_get_byte (&str, 6) == 'q');
3735 _dbus_assert (_dbus_string_get_byte (&str, 7) == 'l');
3736 _dbus_assert (_dbus_string_get_byte (&str, 8) == 'l');
3737 _dbus_assert (_dbus_string_get_byte (&str, 9) == 'o');
3738 _dbus_assert (_dbus_string_get_byte (&str, 10) == 'W');
3740 _dbus_string_free (&str);
3742 /* Check append/parse int/double */
3744 if (!_dbus_string_init (&str))
3745 _dbus_assert_not_reached ("failed to init string");
3747 if (!_dbus_string_append_int (&str, 27))
3748 _dbus_assert_not_reached ("failed to append int");
3750 i = _dbus_string_get_length (&str);
3752 if (!_dbus_string_parse_int (&str, 0, &v, &end))
3753 _dbus_assert_not_reached ("failed to parse int");
3755 _dbus_assert (v == 27);
3756 _dbus_assert (end == i);
3758 _dbus_string_free (&str);
3760 if (!_dbus_string_init (&str))
3761 _dbus_assert_not_reached ("failed to init string");
3763 if (!_dbus_string_append_double (&str, 50.3))
3764 _dbus_assert_not_reached ("failed to append float");
3766 i = _dbus_string_get_length (&str);
3768 if (!_dbus_string_parse_double (&str, 0, &d, &end))
3769 _dbus_assert_not_reached ("failed to parse float");
3771 _dbus_assert (d > (50.3 - 1e-6) && d < (50.3 + 1e-6));
3772 _dbus_assert (end == i);
3774 _dbus_string_free (&str);
3777 if (!_dbus_string_init (&str))
3778 _dbus_assert_not_reached ("failed to init string");
3780 if (!_dbus_string_append (&str, "Hello"))
3781 _dbus_assert_not_reached ("couldn't append to string");
3783 if (!_dbus_string_find (&str, 0, "He", &i))
3784 _dbus_assert_not_reached ("didn't find 'He'");
3785 _dbus_assert (i == 0);
3787 if (!_dbus_string_find (&str, 0, "Hello", &i))
3788 _dbus_assert_not_reached ("didn't find 'Hello'");
3789 _dbus_assert (i == 0);
3791 if (!_dbus_string_find (&str, 0, "ello", &i))
3792 _dbus_assert_not_reached ("didn't find 'ello'");
3793 _dbus_assert (i == 1);
3795 if (!_dbus_string_find (&str, 0, "lo", &i))
3796 _dbus_assert_not_reached ("didn't find 'lo'");
3797 _dbus_assert (i == 3);
3799 if (!_dbus_string_find (&str, 2, "lo", &i))
3800 _dbus_assert_not_reached ("didn't find 'lo'");
3801 _dbus_assert (i == 3);
3803 if (_dbus_string_find (&str, 4, "lo", &i))
3804 _dbus_assert_not_reached ("did find 'lo'");
3806 if (!_dbus_string_find (&str, 0, "l", &i))
3807 _dbus_assert_not_reached ("didn't find 'l'");
3808 _dbus_assert (i == 2);
3810 if (!_dbus_string_find (&str, 0, "H", &i))
3811 _dbus_assert_not_reached ("didn't find 'H'");
3812 _dbus_assert (i == 0);
3814 if (!_dbus_string_find (&str, 0, "", &i))
3815 _dbus_assert_not_reached ("didn't find ''");
3816 _dbus_assert (i == 0);
3818 if (_dbus_string_find (&str, 0, "Hello!", NULL))
3819 _dbus_assert_not_reached ("Did find 'Hello!'");
3821 if (_dbus_string_find (&str, 0, "Oh, Hello", NULL))
3822 _dbus_assert_not_reached ("Did find 'Oh, Hello'");
3824 if (_dbus_string_find (&str, 0, "ill", NULL))
3825 _dbus_assert_not_reached ("Did find 'ill'");
3827 if (_dbus_string_find (&str, 0, "q", NULL))
3828 _dbus_assert_not_reached ("Did find 'q'");
3830 if (!_dbus_string_find_to (&str, 0, 2, "He", NULL))
3831 _dbus_assert_not_reached ("Didn't find 'He'");
3833 if (_dbus_string_find_to (&str, 0, 2, "Hello", NULL))
3834 _dbus_assert_not_reached ("Did find 'Hello'");
3836 if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'H', &i))
3837 _dbus_assert_not_reached ("Did not find 'H'");
3838 _dbus_assert (i == 0);
3840 if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'o', &i))
3841 _dbus_assert_not_reached ("Did not find 'o'");
3842 _dbus_assert (i == _dbus_string_get_length (&str) - 1);
3844 if (_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str) - 1, 'o', &i))
3845 _dbus_assert_not_reached ("Did find 'o'");
3846 _dbus_assert (i == -1);
3848 if (_dbus_string_find_byte_backward (&str, 1, 'e', &i))
3849 _dbus_assert_not_reached ("Did find 'e'");
3850 _dbus_assert (i == -1);
3852 if (!_dbus_string_find_byte_backward (&str, 2, 'e', &i))
3853 _dbus_assert_not_reached ("Didn't find 'e'");
3854 _dbus_assert (i == 1);
3856 _dbus_string_free (&str);
3858 /* Base 64 and Hex encoding */
3859 test_roundtrips (test_base64_roundtrip);
3860 test_roundtrips (test_hex_roundtrip);
3862 /* Path validation */
3864 while (i < (int) _DBUS_N_ELEMENTS (valid_paths))
3866 _dbus_string_init_const (&str, valid_paths[i]);
3868 if (!_dbus_string_validate_path (&str, 0,
3869 _dbus_string_get_length (&str)))
3871 _dbus_warn ("Path \"%s\" should have been valid\n", valid_paths[i]);
3872 _dbus_assert_not_reached ("invalid path");
3879 while (i < (int) _DBUS_N_ELEMENTS (invalid_paths))
3881 _dbus_string_init_const (&str, invalid_paths[i]);
3883 if (_dbus_string_validate_path (&str, 0,
3884 _dbus_string_get_length (&str)))
3886 _dbus_warn ("Path \"%s\" should have been invalid\n", invalid_paths[i]);
3887 _dbus_assert_not_reached ("valid path");
3893 /* Interface validation */
3895 while (i < (int) _DBUS_N_ELEMENTS (valid_interfaces))
3897 _dbus_string_init_const (&str, valid_interfaces[i]);
3899 if (!_dbus_string_validate_interface (&str, 0,
3900 _dbus_string_get_length (&str)))
3902 _dbus_warn ("Interface \"%s\" should have been valid\n", valid_interfaces[i]);
3903 _dbus_assert_not_reached ("invalid interface");
3910 while (i < (int) _DBUS_N_ELEMENTS (invalid_interfaces))
3912 _dbus_string_init_const (&str, invalid_interfaces[i]);
3914 if (_dbus_string_validate_interface (&str, 0,
3915 _dbus_string_get_length (&str)))
3917 _dbus_warn ("Interface \"%s\" should have been invalid\n", invalid_interfaces[i]);
3918 _dbus_assert_not_reached ("valid interface");
3924 /* Service validation (check that valid interfaces are valid services,
3925 * and invalid interfaces are invalid services except if they start with ':')
3928 while (i < (int) _DBUS_N_ELEMENTS (valid_interfaces))
3930 _dbus_string_init_const (&str, valid_interfaces[i]);
3932 if (!_dbus_string_validate_service (&str, 0,
3933 _dbus_string_get_length (&str)))
3935 _dbus_warn ("Service \"%s\" should have been valid\n", valid_interfaces[i]);
3936 _dbus_assert_not_reached ("invalid service");
3943 while (i < (int) _DBUS_N_ELEMENTS (invalid_interfaces))
3945 if (invalid_interfaces[i][0] != ':')
3947 _dbus_string_init_const (&str, invalid_interfaces[i]);
3949 if (_dbus_string_validate_service (&str, 0,
3950 _dbus_string_get_length (&str)))
3952 _dbus_warn ("Service \"%s\" should have been invalid\n", invalid_interfaces[i]);
3953 _dbus_assert_not_reached ("valid service");
3960 /* Base service validation */
3962 while (i < (int) _DBUS_N_ELEMENTS (valid_base_services))
3964 _dbus_string_init_const (&str, valid_base_services[i]);
3966 if (!_dbus_string_validate_service (&str, 0,
3967 _dbus_string_get_length (&str)))
3969 _dbus_warn ("Service \"%s\" should have been valid\n", valid_base_services[i]);
3970 _dbus_assert_not_reached ("invalid base service");
3977 while (i < (int) _DBUS_N_ELEMENTS (invalid_base_services))
3979 _dbus_string_init_const (&str, invalid_base_services[i]);
3981 if (_dbus_string_validate_service (&str, 0,
3982 _dbus_string_get_length (&str)))
3984 _dbus_warn ("Service \"%s\" should have been invalid\n", invalid_base_services[i]);
3985 _dbus_assert_not_reached ("valid base service");
3992 /* Error name validation (currently identical to interfaces)
3995 while (i < (int) _DBUS_N_ELEMENTS (valid_interfaces))
3997 _dbus_string_init_const (&str, valid_interfaces[i]);
3999 if (!_dbus_string_validate_error_name (&str, 0,
4000 _dbus_string_get_length (&str)))
4002 _dbus_warn ("Error name \"%s\" should have been valid\n", valid_interfaces[i]);
4003 _dbus_assert_not_reached ("invalid error name");
4010 while (i < (int) _DBUS_N_ELEMENTS (invalid_interfaces))
4012 if (invalid_interfaces[i][0] != ':')
4014 _dbus_string_init_const (&str, invalid_interfaces[i]);
4016 if (_dbus_string_validate_error_name (&str, 0,
4017 _dbus_string_get_length (&str)))
4019 _dbus_warn ("Error name \"%s\" should have been invalid\n", invalid_interfaces[i]);
4020 _dbus_assert_not_reached ("valid error name");
4027 /* Member validation */
4029 while (i < (int) _DBUS_N_ELEMENTS (valid_members))
4031 _dbus_string_init_const (&str, valid_members[i]);
4033 if (!_dbus_string_validate_member (&str, 0,
4034 _dbus_string_get_length (&str)))
4036 _dbus_warn ("Member \"%s\" should have been valid\n", valid_members[i]);
4037 _dbus_assert_not_reached ("invalid member");
4044 while (i < (int) _DBUS_N_ELEMENTS (invalid_members))
4046 _dbus_string_init_const (&str, invalid_members[i]);
4048 if (_dbus_string_validate_member (&str, 0,
4049 _dbus_string_get_length (&str)))
4051 _dbus_warn ("Member \"%s\" should have been invalid\n", invalid_members[i]);
4052 _dbus_assert_not_reached ("valid member");
4058 /* Validate claimed length longer than real length */
4059 _dbus_string_init_const (&str, "abc.efg");
4060 if (_dbus_string_validate_service (&str, 0, 8))
4061 _dbus_assert_not_reached ("validated too-long string");
4062 if (_dbus_string_validate_interface (&str, 0, 8))
4063 _dbus_assert_not_reached ("validated too-long string");
4064 if (_dbus_string_validate_error_name (&str, 0, 8))
4065 _dbus_assert_not_reached ("validated too-long string");
4067 _dbus_string_init_const (&str, "abc");
4068 if (_dbus_string_validate_member (&str, 0, 4))
4069 _dbus_assert_not_reached ("validated too-long string");
4071 /* Validate string exceeding max name length */
4072 if (!_dbus_string_init (&str))
4073 _dbus_assert_not_reached ("no memory");
4075 while (_dbus_string_get_length (&str) <= DBUS_MAXIMUM_NAME_LENGTH)
4076 if (!_dbus_string_append (&str, "abc.def"))
4077 _dbus_assert_not_reached ("no memory");
4079 if (_dbus_string_validate_service (&str, 0, _dbus_string_get_length (&str)))
4080 _dbus_assert_not_reached ("validated overmax string");
4081 if (_dbus_string_validate_interface (&str, 0, _dbus_string_get_length (&str)))
4082 _dbus_assert_not_reached ("validated overmax string");
4083 if (_dbus_string_validate_error_name (&str, 0, _dbus_string_get_length (&str)))
4084 _dbus_assert_not_reached ("validated overmax string");
4086 /* overlong member */
4087 _dbus_string_set_length (&str, 0);
4088 while (_dbus_string_get_length (&str) <= DBUS_MAXIMUM_NAME_LENGTH)
4089 if (!_dbus_string_append (&str, "abc"))
4090 _dbus_assert_not_reached ("no memory");
4092 if (_dbus_string_validate_member (&str, 0, _dbus_string_get_length (&str)))
4093 _dbus_assert_not_reached ("validated overmax string");
4095 /* overlong base service */
4096 _dbus_string_set_length (&str, 0);
4097 _dbus_string_append (&str, ":");
4098 while (_dbus_string_get_length (&str) <= DBUS_MAXIMUM_NAME_LENGTH)
4099 if (!_dbus_string_append (&str, "abc"))
4100 _dbus_assert_not_reached ("no memory");
4102 if (_dbus_string_validate_service (&str, 0, _dbus_string_get_length (&str)))
4103 _dbus_assert_not_reached ("validated overmax string");
4105 _dbus_string_free (&str);
4110 #endif /* DBUS_BUILD_TESTS */