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 */
28 #include "dbus-marshal.h"
29 #define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
30 #include "dbus-string-private.h"
33 * @defgroup DBusString string class
34 * @ingroup DBusInternals
35 * @brief DBusString data structure
37 * Types and functions related to DBusString. DBusString is intended
38 * to be a string class that makes it hard to mess up security issues
39 * (and just in general harder to write buggy code). It should be
40 * used (or extended and then used) rather than the libc stuff in
41 * string.h. The string class is a bit inconvenient at spots because
42 * it handles out-of-memory failures and tries to be extra-robust.
44 * A DBusString has a maximum length set at initialization time; this
45 * can be used to ensure that a buffer doesn't get too big. The
46 * _dbus_string_lengthen() method checks for overflow, and for max
47 * length being exceeded.
49 * Try to avoid conversion to a plain C string, i.e. add methods on
50 * the string object instead, only convert to C string when passing
51 * things out to the public API. In particular, no sprintf, strcpy,
52 * strcat, any of that should be used. The GString feature of
53 * accepting negative numbers for "length of string" is also absent,
54 * because it could keep us from detecting bogus huge lengths. i.e. if
55 * we passed in some bogus huge length it would be taken to mean
56 * "current length of string" instead of "broken crack"
60 * @defgroup DBusStringInternals DBusString implementation details
61 * @ingroup DBusInternals
62 * @brief DBusString implementation details
64 * The guts of DBusString.
70 * We allocate 1 byte for nul termination, plus 7 bytes for possible
71 * align_offset, so we always need 8 bytes on top of the string's
72 * length to be in the allocated block.
74 #define ALLOCATION_PADDING 8
77 * This is the maximum max length (and thus also the maximum length)
80 #define MAX_MAX_LENGTH (_DBUS_INT_MAX - ALLOCATION_PADDING)
83 * Checks a bunch of assertions about a string object
85 * @param real the DBusRealString
87 #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)
90 * Checks assertions about a string object that needs to be
91 * modifiable - may not be locked or const. Also declares
92 * the "real" variable pointing to DBusRealString.
93 * @param str the string
95 #define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
96 DBUS_GENERIC_STRING_PREAMBLE (real); \
97 _dbus_assert (!(real)->constant); \
98 _dbus_assert (!(real)->locked)
101 * Checks assertions about a string object that may be locked but
102 * can't be const. i.e. a string object that we can free. Also
103 * declares the "real" variable pointing to DBusRealString.
105 * @param str the string
107 #define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
108 DBUS_GENERIC_STRING_PREAMBLE (real); \
109 _dbus_assert (!(real)->constant)
112 * Checks assertions about a string that may be const or locked. Also
113 * declares the "real" variable pointing to DBusRealString.
114 * @param str the string.
116 #define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
117 DBUS_GENERIC_STRING_PREAMBLE (real)
122 * @addtogroup DBusString
127 fixup_alignment (DBusRealString *real)
131 unsigned int old_align_offset;
133 /* we have to have extra space in real->allocated for the align offset and nul byte */
134 _dbus_assert (real->len <= real->allocated - ALLOCATION_PADDING);
136 old_align_offset = real->align_offset;
137 real_block = real->str - old_align_offset;
139 aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);
141 real->align_offset = aligned - real_block;
144 if (old_align_offset != real->align_offset)
146 /* Here comes the suck */
147 memmove (real_block + real->align_offset,
148 real_block + old_align_offset,
152 _dbus_assert (real->align_offset < 8);
153 _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
157 undo_alignment (DBusRealString *real)
159 if (real->align_offset != 0)
161 memmove (real->str - real->align_offset,
165 real->str = real->str - real->align_offset;
166 real->align_offset = 0;
171 * Initializes a string. The string starts life with zero length. The
172 * string must eventually be freed with _dbus_string_free().
174 * @param str memory to hold the string
175 * @returns #TRUE on success, #FALSE if no memory
178 _dbus_string_init (DBusString *str)
180 DBusRealString *real;
182 _dbus_assert (str != NULL);
184 _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
186 real = (DBusRealString*) str;
188 /* It's very important not to touch anything
189 * other than real->str if we're going to fail,
190 * since we also use this function to reset
191 * an existing string, e.g. in _dbus_string_steal_data()
194 real->str = dbus_malloc (ALLOCATION_PADDING);
195 if (real->str == NULL)
198 real->allocated = ALLOCATION_PADDING;
200 real->str[real->len] = '\0';
202 real->max_length = MAX_MAX_LENGTH;
203 real->constant = FALSE;
204 real->locked = FALSE;
205 real->invalid = FALSE;
206 real->align_offset = 0;
208 fixup_alignment (real);
213 /* The max length thing is sort of a historical artifact
214 * from a feature that turned out to be dumb; perhaps
215 * we should purge it entirely. The problem with
216 * the feature is that it looks like memory allocation
217 * failure, but is not a transient or resolvable failure.
220 set_max_length (DBusString *str,
223 DBusRealString *real;
225 real = (DBusRealString*) str;
227 real->max_length = max_length;
231 * Initializes a constant string. The value parameter is not copied
232 * (should be static), and the string may never be modified.
233 * It is safe but not necessary to call _dbus_string_free()
234 * on a const string. The string has a length limit of MAXINT - 8.
236 * @param str memory to use for the string
237 * @param value a string to be stored in str (not copied!!!)
240 _dbus_string_init_const (DBusString *str,
243 _dbus_assert (value != NULL);
245 _dbus_string_init_const_len (str, value,
250 * Initializes a constant string with a length. The value parameter is
251 * not copied (should be static), and the string may never be
252 * modified. It is safe but not necessary to call _dbus_string_free()
255 * @param str memory to use for the string
256 * @param value a string to be stored in str (not copied!!!)
257 * @param len the length to use
260 _dbus_string_init_const_len (DBusString *str,
264 DBusRealString *real;
266 _dbus_assert (str != NULL);
267 _dbus_assert (value != NULL);
268 _dbus_assert (len <= MAX_MAX_LENGTH);
269 _dbus_assert (len >= 0);
271 real = (DBusRealString*) str;
273 real->str = (char*) value;
275 real->allocated = real->len + ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
276 real->max_length = real->len + 1;
277 real->constant = TRUE;
278 real->invalid = FALSE;
280 /* We don't require const strings to be 8-byte aligned as the
281 * memory is coming from elsewhere.
286 * Frees a string created by _dbus_string_init().
288 * @param str memory where the string is stored.
291 _dbus_string_free (DBusString *str)
293 DBusRealString *real = (DBusRealString*) str;
294 DBUS_GENERIC_STRING_PREAMBLE (real);
298 dbus_free (real->str - real->align_offset);
300 real->invalid = TRUE;
304 * Locks a string such that any attempts to change the string will
305 * result in aborting the program. Also, if the string is wasting a
306 * lot of memory (allocation is sufficiently larger than what the
307 * string is really using), _dbus_string_lock() will realloc the
308 * string's data to "compact" it.
310 * @param str the string to lock.
313 _dbus_string_lock (DBusString *str)
315 DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
319 /* Try to realloc to avoid excess memory usage, since
320 * we know we won't change the string further
323 if (real->allocated - MAX_WASTE > real->len)
328 new_allocated = real->len + ALLOCATION_PADDING;
330 new_str = dbus_realloc (real->str - real->align_offset,
334 real->str = new_str + real->align_offset;
335 real->allocated = new_allocated;
336 fixup_alignment (real);
342 set_length (DBusRealString *real,
345 /* Note, we are setting the length without nul termination */
347 /* exceeding max length is the same as failure to allocate memory */
348 if (new_length > real->max_length)
351 if (new_length > (real->allocated - ALLOCATION_PADDING))
356 /* at least double our old allocation to avoid O(n), avoiding
359 if (real->allocated > (MAX_MAX_LENGTH + ALLOCATION_PADDING) / 2)
360 new_allocated = MAX_MAX_LENGTH + ALLOCATION_PADDING;
362 new_allocated = real->allocated * 2;
364 /* But be sure we always alloc at least space for the new length */
365 new_allocated = MAX (real->allocated, new_length + ALLOCATION_PADDING);
367 new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
371 real->str = new_str + real->align_offset;
372 real->allocated = new_allocated;
373 fixup_alignment (real);
376 real->len = new_length;
377 real->str[real->len] = '\0';
384 DBusRealString *dest,
390 if (len > dest->max_length - dest->len)
391 return FALSE; /* detected overflow of dest->len + len below */
393 if (!set_length (dest, dest->len + len))
396 memmove (dest->str + insert_at + len,
397 dest->str + insert_at,
398 dest->len - len - insert_at);
404 * Gets the raw character buffer from the string. The returned buffer
405 * will be nul-terminated, but note that strings may contain binary
406 * data so there may be extra nul characters prior to the termination.
407 * This function should be little-used, extend DBusString or add
408 * stuff to dbus-sysdeps.c instead. It's an error to use this
409 * function on a const string.
411 * @param str the string
415 _dbus_string_get_data (DBusString *str)
417 DBUS_STRING_PREAMBLE (str);
423 * Gets the raw character buffer from a const string.
425 * @param str the string
426 * @returns the string data
429 _dbus_string_get_const_data (const DBusString *str)
431 DBUS_CONST_STRING_PREAMBLE (str);
437 * Gets a sub-portion of the raw character buffer from the
438 * string. The "len" field is required simply for error
439 * checking, to be sure you don't try to use more
440 * string than exists. The nul termination of the
441 * returned buffer remains at the end of the entire
442 * string, not at start + len.
444 * @param str the string
445 * @param start byte offset to return
446 * @param len length of segment to return
447 * @returns the string data
450 _dbus_string_get_data_len (DBusString *str,
454 DBUS_STRING_PREAMBLE (str);
455 _dbus_assert (start >= 0);
456 _dbus_assert (len >= 0);
457 _dbus_assert (start <= real->len);
458 _dbus_assert (len <= real->len - start);
460 return real->str + start;
464 * const version of _dbus_string_get_data_len().
466 * @todo should return the const char* instead of using an out param;
467 * the temporary variable encourages a bug where you use const data
468 * after modifying the string and possibly causing a realloc.
470 * @param str the string
471 * @param start byte offset to return
472 * @param len length of segment to return
473 * @returns the string data
476 _dbus_string_get_const_data_len (const DBusString *str,
480 DBUS_CONST_STRING_PREAMBLE (str);
481 _dbus_assert (start >= 0);
482 _dbus_assert (len >= 0);
483 _dbus_assert (start <= real->len);
484 _dbus_assert (len <= real->len - start);
486 return real->str + start;
490 * Sets the value of the byte at the given position.
492 * @param str the string
493 * @param i the position
494 * @param byte the new value
497 _dbus_string_set_byte (DBusString *str,
501 DBUS_STRING_PREAMBLE (str);
502 _dbus_assert (i < real->len);
503 _dbus_assert (i >= 0);
509 * Gets the byte at the given position.
511 * @param str the string
512 * @param start the position
513 * @returns the byte at that position
516 _dbus_string_get_byte (const DBusString *str,
519 DBUS_CONST_STRING_PREAMBLE (str);
520 _dbus_assert (start < real->len);
521 _dbus_assert (start >= 0);
523 return real->str[start];
527 * Inserts the given byte at the given position.
529 * @param str the string
530 * @param i the position
531 * @param byte the value to insert
532 * @returns #TRUE on success
535 _dbus_string_insert_byte (DBusString *str,
539 DBUS_STRING_PREAMBLE (str);
540 _dbus_assert (i <= real->len);
541 _dbus_assert (i >= 0);
543 if (!open_gap (1, real, i))
552 * Like _dbus_string_get_data(), but removes the
553 * gotten data from the original string. The caller
554 * must free the data returned. This function may
555 * fail due to lack of memory, and return #FALSE.
557 * @param str the string
558 * @param data_return location to return the buffer
559 * @returns #TRUE on success
562 _dbus_string_steal_data (DBusString *str,
566 DBUS_STRING_PREAMBLE (str);
567 _dbus_assert (data_return != NULL);
569 undo_alignment (real);
571 *data_return = real->str;
573 old_max_length = real->max_length;
575 /* reset the string */
576 if (!_dbus_string_init (str))
578 /* hrm, put it back then */
579 real->str = *data_return;
581 fixup_alignment (real);
585 real->max_length = old_max_length;
591 * Like _dbus_string_get_data_len(), but removes the gotten data from
592 * the original string. The caller must free the data returned. This
593 * function may fail due to lack of memory, and return #FALSE.
594 * The returned string is nul-terminated and has length len.
596 * @todo this function is broken because on failure it
597 * may corrupt the source string.
599 * @param str the string
600 * @param data_return location to return the buffer
601 * @param start the start of segment to steal
602 * @param len the length of segment to steal
603 * @returns #TRUE on success
606 _dbus_string_steal_data_len (DBusString *str,
612 DBUS_STRING_PREAMBLE (str);
613 _dbus_assert (data_return != NULL);
614 _dbus_assert (start >= 0);
615 _dbus_assert (len >= 0);
616 _dbus_assert (start <= real->len);
617 _dbus_assert (len <= real->len - start);
619 if (!_dbus_string_init (&dest))
622 set_max_length (&dest, real->max_length);
624 if (!_dbus_string_move_len (str, start, len, &dest, 0))
626 _dbus_string_free (&dest);
630 _dbus_warn ("Broken code in _dbus_string_steal_data_len(), see @todo, FIXME\n");
631 if (!_dbus_string_steal_data (&dest, data_return))
633 _dbus_string_free (&dest);
637 _dbus_string_free (&dest);
643 * Copies the data from the string into a char*
645 * @param str the string
646 * @param data_return place to return the data
647 * @returns #TRUE on success, #FALSE on no memory
650 _dbus_string_copy_data (const DBusString *str,
653 DBUS_CONST_STRING_PREAMBLE (str);
654 _dbus_assert (data_return != NULL);
656 *data_return = dbus_malloc (real->len + 1);
657 if (*data_return == NULL)
660 memcpy (*data_return, real->str, real->len + 1);
666 * Copies a segment of the string into a char*
668 * @param str the string
669 * @param data_return place to return the data
670 * @param start start index
671 * @param len length to copy
672 * @returns #FALSE if no memory
675 _dbus_string_copy_data_len (const DBusString *str,
682 DBUS_CONST_STRING_PREAMBLE (str);
683 _dbus_assert (data_return != NULL);
684 _dbus_assert (start >= 0);
685 _dbus_assert (len >= 0);
686 _dbus_assert (start <= real->len);
687 _dbus_assert (len <= real->len - start);
689 if (!_dbus_string_init (&dest))
692 set_max_length (&dest, real->max_length);
694 if (!_dbus_string_copy_len (str, start, len, &dest, 0))
696 _dbus_string_free (&dest);
700 if (!_dbus_string_steal_data (&dest, data_return))
702 _dbus_string_free (&dest);
706 _dbus_string_free (&dest);
711 * Gets the length of a string (not including nul termination).
713 * @returns the length.
716 _dbus_string_get_length (const DBusString *str)
718 DBUS_CONST_STRING_PREAMBLE (str);
724 * Makes a string longer by the given number of bytes. Checks whether
725 * adding additional_length to the current length would overflow an
726 * integer, and checks for exceeding a string's max length.
727 * The new bytes are not initialized, other than nul-terminating
728 * the end of the string. The uninitialized bytes may contain
729 * nul bytes or other junk.
731 * @param str a string
732 * @param additional_length length to add to the string.
733 * @returns #TRUE on success.
736 _dbus_string_lengthen (DBusString *str,
737 int additional_length)
739 DBUS_STRING_PREAMBLE (str);
740 _dbus_assert (additional_length >= 0);
742 if (additional_length > real->max_length - real->len)
743 return FALSE; /* would overflow */
745 return set_length (real,
746 real->len + additional_length);
750 * Makes a string shorter by the given number of bytes.
752 * @param str a string
753 * @param length_to_remove length to remove from the string.
756 _dbus_string_shorten (DBusString *str,
757 int length_to_remove)
759 DBUS_STRING_PREAMBLE (str);
760 _dbus_assert (length_to_remove >= 0);
761 _dbus_assert (length_to_remove <= real->len);
764 real->len - length_to_remove);
768 * Sets the length of a string. Can be used to truncate or lengthen
769 * the string. If the string is lengthened, the function may fail and
770 * return #FALSE. Newly-added bytes are not initialized, as with
771 * _dbus_string_lengthen().
773 * @param str a string
774 * @param length new length of the string.
775 * @returns #FALSE on failure.
778 _dbus_string_set_length (DBusString *str,
781 DBUS_STRING_PREAMBLE (str);
782 _dbus_assert (length >= 0);
784 return set_length (real, length);
788 * Align the length of a string to a specific alignment (typically 4 or 8)
789 * by appending nul bytes to the string.
791 * @param str a string
792 * @param alignment the alignment
793 * @returns #FALSE if no memory
796 _dbus_string_align_length (DBusString *str,
799 unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
801 DBUS_STRING_PREAMBLE (str);
802 _dbus_assert (alignment >= 1);
803 _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
805 new_len = _DBUS_ALIGN_VALUE (real->len, alignment);
806 if (new_len > (unsigned long) real->max_length)
809 delta = new_len - real->len;
810 _dbus_assert (delta >= 0);
815 if (!set_length (real, new_len))
818 memset (real->str + (new_len - delta),
825 append (DBusRealString *real,
832 if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
835 memcpy (real->str + (real->len - buffer_len),
843 * Appends a nul-terminated C-style string to a DBusString.
845 * @param str the DBusString
846 * @param buffer the nul-terminated characters to append
847 * @returns #FALSE if not enough memory.
850 _dbus_string_append (DBusString *str,
853 unsigned long buffer_len;
855 DBUS_STRING_PREAMBLE (str);
856 _dbus_assert (buffer != NULL);
858 buffer_len = strlen (buffer);
859 if (buffer_len > (unsigned long) real->max_length)
862 return append (real, buffer, buffer_len);
866 * Appends block of bytes with the given length to a DBusString.
868 * @param str the DBusString
869 * @param buffer the bytes to append
870 * @param len the number of bytes to append
871 * @returns #FALSE if not enough memory.
874 _dbus_string_append_len (DBusString *str,
878 DBUS_STRING_PREAMBLE (str);
879 _dbus_assert (buffer != NULL);
880 _dbus_assert (len >= 0);
882 return append (real, buffer, len);
886 * Appends a single byte to the string, returning #FALSE
887 * if not enough memory.
889 * @param str the string
890 * @param byte the byte to append
891 * @returns #TRUE on success
894 _dbus_string_append_byte (DBusString *str,
897 DBUS_STRING_PREAMBLE (str);
899 if (!set_length (real, real->len + 1))
902 real->str[real->len-1] = byte;
908 * Appends a single Unicode character, encoding the character
911 * @param str the string
912 * @param ch the Unicode character
915 _dbus_string_append_unichar (DBusString *str,
923 DBUS_STRING_PREAMBLE (str);
925 /* this code is from GLib but is pretty standard I think */
939 else if (ch < 0x10000)
944 else if (ch < 0x200000)
949 else if (ch < 0x4000000)
960 if (len > (real->max_length - real->len))
961 return FALSE; /* real->len + len would overflow */
963 if (!set_length (real, real->len + len))
966 out = real->str + (real->len - len);
968 for (i = len - 1; i > 0; --i)
970 out[i] = (ch & 0x3f) | 0x80;
979 delete (DBusRealString *real,
986 memmove (real->str + start, real->str + start + len, real->len - (start + len));
988 real->str[real->len] = '\0';
992 * Deletes a segment of a DBusString with length len starting at
993 * start. (Hint: to clear an entire string, setting length to 0
994 * with _dbus_string_set_length() is easier.)
996 * @param str the DBusString
997 * @param start where to start deleting
998 * @param len the number of bytes to delete
1001 _dbus_string_delete (DBusString *str,
1005 DBUS_STRING_PREAMBLE (str);
1006 _dbus_assert (start >= 0);
1007 _dbus_assert (len >= 0);
1008 _dbus_assert (start <= real->len);
1009 _dbus_assert (len <= real->len - start);
1011 delete (real, start, len);
1015 copy (DBusRealString *source,
1018 DBusRealString *dest,
1024 if (!open_gap (len, dest, insert_at))
1027 memcpy (dest->str + insert_at,
1028 source->str + start,
1035 * Checks assertions for two strings we're copying a segment between,
1036 * and declares real_source/real_dest variables.
1038 * @param source the source string
1039 * @param start the starting offset
1040 * @param dest the dest string
1041 * @param insert_at where the copied segment is inserted
1043 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at) \
1044 DBusRealString *real_source = (DBusRealString*) source; \
1045 DBusRealString *real_dest = (DBusRealString*) dest; \
1046 _dbus_assert ((source) != (dest)); \
1047 DBUS_GENERIC_STRING_PREAMBLE (real_source); \
1048 DBUS_GENERIC_STRING_PREAMBLE (real_dest); \
1049 _dbus_assert (!real_dest->constant); \
1050 _dbus_assert (!real_dest->locked); \
1051 _dbus_assert ((start) >= 0); \
1052 _dbus_assert ((start) <= real_source->len); \
1053 _dbus_assert ((insert_at) >= 0); \
1054 _dbus_assert ((insert_at) <= real_dest->len)
1057 * Moves the end of one string into another string. Both strings
1058 * must be initialized, valid strings.
1060 * @param source the source string
1061 * @param start where to chop off the source string
1062 * @param dest the destination string
1063 * @param insert_at where to move the chopped-off part of source string
1064 * @returns #FALSE if not enough memory
1067 _dbus_string_move (DBusString *source,
1072 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1074 if (!copy (real_source, start,
1075 real_source->len - start,
1080 delete (real_source, start,
1081 real_source->len - start);
1087 * Like _dbus_string_move(), but does not delete the section
1088 * of the source string that's copied to the dest string.
1090 * @param source the source string
1091 * @param start where to start copying the source string
1092 * @param dest the destination string
1093 * @param insert_at where to place the copied part of source string
1094 * @returns #FALSE if not enough memory
1097 _dbus_string_copy (const DBusString *source,
1102 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1104 return copy (real_source, start,
1105 real_source->len - start,
1111 * Like _dbus_string_move(), but can move a segment from
1112 * the middle of the source string.
1114 * @param source the source string
1115 * @param start first byte of source string to move
1116 * @param len length of segment to move
1117 * @param dest the destination string
1118 * @param insert_at where to move the bytes from the source string
1119 * @returns #FALSE if not enough memory
1122 _dbus_string_move_len (DBusString *source,
1129 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1130 _dbus_assert (len >= 0);
1131 _dbus_assert ((start + len) <= real_source->len);
1133 if (!copy (real_source, start, len,
1138 delete (real_source, start,
1145 * Like _dbus_string_copy(), but can copy a segment from the middle of
1146 * the source string.
1148 * @param source the source string
1149 * @param start where to start copying the source string
1150 * @param len length of segment to copy
1151 * @param dest the destination string
1152 * @param insert_at where to place the copied segment of source string
1153 * @returns #FALSE if not enough memory
1156 _dbus_string_copy_len (const DBusString *source,
1162 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1163 _dbus_assert (len >= 0);
1164 _dbus_assert (start <= real_source->len);
1165 _dbus_assert (len <= real_source->len - start);
1167 return copy (real_source, start, len,
1173 * Replaces a segment of dest string with a segment of source string.
1175 * @todo optimize the case where the two lengths are the same, and
1176 * avoid memmoving the data in the trailing part of the string twice.
1178 * @todo avoid inserting the source into dest, then deleting
1179 * the replaced chunk of dest (which creates a potentially large
1180 * intermediate string). Instead, extend the replaced chunk
1181 * of dest with padding to the same size as the source chunk,
1182 * then copy in the source bytes.
1184 * @param source the source string
1185 * @param start where to start copying the source string
1186 * @param len length of segment to copy
1187 * @param dest the destination string
1188 * @param replace_at start of segment of dest string to replace
1189 * @param replace_len length of segment of dest string to replace
1190 * @returns #FALSE if not enough memory
1194 _dbus_string_replace_len (const DBusString *source,
1201 DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1202 _dbus_assert (len >= 0);
1203 _dbus_assert (start <= real_source->len);
1204 _dbus_assert (len <= real_source->len - start);
1205 _dbus_assert (replace_at >= 0);
1206 _dbus_assert (replace_at <= real_dest->len);
1207 _dbus_assert (replace_len <= real_dest->len - replace_at);
1209 if (!copy (real_source, start, len,
1210 real_dest, replace_at))
1213 delete (real_dest, replace_at + len, replace_len);
1218 /* Unicode macros and utf8_validate() from GLib Owen Taylor, Havoc
1219 * Pennington, and Tom Tromey are the authors and authorized relicense.
1222 /** computes length and mask of a unicode character
1223 * @param Char the char
1224 * @param Mask the mask variable to assign to
1225 * @param Len the length variable to assign to
1227 #define UTF8_COMPUTE(Char, Mask, Len) \
1233 else if ((Char & 0xe0) == 0xc0) \
1238 else if ((Char & 0xf0) == 0xe0) \
1243 else if ((Char & 0xf8) == 0xf0) \
1248 else if ((Char & 0xfc) == 0xf8) \
1253 else if ((Char & 0xfe) == 0xfc) \
1262 * computes length of a unicode character in UTF-8
1263 * @param Char the char
1265 #define UTF8_LENGTH(Char) \
1266 ((Char) < 0x80 ? 1 : \
1267 ((Char) < 0x800 ? 2 : \
1268 ((Char) < 0x10000 ? 3 : \
1269 ((Char) < 0x200000 ? 4 : \
1270 ((Char) < 0x4000000 ? 5 : 6)))))
1273 * Gets a UTF-8 value.
1275 * @param Result variable for extracted unicode char.
1276 * @param Chars the bytes to decode
1277 * @param Count counter variable
1278 * @param Mask mask for this char
1279 * @param Len length for this char in bytes
1281 #define UTF8_GET(Result, Chars, Count, Mask, Len) \
1282 (Result) = (Chars)[0] & (Mask); \
1283 for ((Count) = 1; (Count) < (Len); ++(Count)) \
1285 if (((Chars)[(Count)] & 0xc0) != 0x80) \
1291 (Result) |= ((Chars)[(Count)] & 0x3f); \
1295 * Check whether a unicode char is in a valid range.
1297 * @param Char the character
1299 #define UNICODE_VALID(Char) \
1300 ((Char) < 0x110000 && \
1301 (((Char) & 0xFFFFF800) != 0xD800) && \
1302 ((Char) < 0xFDD0 || (Char) > 0xFDEF) && \
1303 ((Char) & 0xFFFF) != 0xFFFF)
1306 * Gets a unicode character from a UTF-8 string. Does no validation;
1307 * you must verify that the string is valid UTF-8 in advance and must
1308 * pass in the start of a character.
1310 * @param str the string
1311 * @param start the start of the UTF-8 character.
1312 * @param ch_return location to return the character
1313 * @param end_return location to return the byte index of next character
1316 _dbus_string_get_unichar (const DBusString *str,
1318 dbus_unichar_t *ch_return,
1322 dbus_unichar_t result;
1325 DBUS_CONST_STRING_PREAMBLE (str);
1326 _dbus_assert (start >= 0);
1327 _dbus_assert (start <= real->len);
1332 *end_return = real->len;
1335 p = real->str + start;
1338 UTF8_COMPUTE (c, mask, len);
1341 UTF8_GET (result, p, i, mask, len);
1343 if (result == (dbus_unichar_t)-1)
1347 *ch_return = result;
1349 *end_return = start + len;
1353 * Finds the given substring in the string,
1354 * returning #TRUE and filling in the byte index
1355 * where the substring was found, if it was found.
1356 * Returns #FALSE if the substring wasn't found.
1357 * Sets *start to the length of the string if the substring
1360 * @param str the string
1361 * @param start where to start looking
1362 * @param substr the substring
1363 * @param found return location for where it was found, or #NULL
1364 * @returns #TRUE if found
1367 _dbus_string_find (const DBusString *str,
1372 return _dbus_string_find_to (str, start,
1373 ((const DBusRealString*)str)->len,
1378 * Finds the given substring in the string,
1379 * up to a certain position,
1380 * returning #TRUE and filling in the byte index
1381 * where the substring was found, if it was found.
1382 * Returns #FALSE if the substring wasn't found.
1383 * Sets *start to the length of the string if the substring
1386 * @param str the string
1387 * @param start where to start looking
1388 * @param end where to stop looking
1389 * @param substr the substring
1390 * @param found return location for where it was found, or #NULL
1391 * @returns #TRUE if found
1394 _dbus_string_find_to (const DBusString *str,
1401 DBUS_CONST_STRING_PREAMBLE (str);
1402 _dbus_assert (substr != NULL);
1403 _dbus_assert (start <= real->len);
1404 _dbus_assert (start >= 0);
1405 _dbus_assert (substr != NULL);
1406 _dbus_assert (end <= real->len);
1407 _dbus_assert (start <= end);
1409 /* we always "find" an empty string */
1410 if (*substr == '\0')
1420 if (real->str[i] == substr[0])
1426 if (substr[j - i] == '\0')
1428 else if (real->str[j] != substr[j - i])
1434 if (substr[j - i] == '\0')
1452 * Find the given byte scanning backward from the given start.
1453 * Sets *found to -1 if the byte is not found.
1455 * @param str the string
1456 * @param byte the byte to find
1457 * @param found return location for where it was found
1458 * @returns #TRUE if found
1461 _dbus_string_find_byte_backward (const DBusString *str,
1467 DBUS_CONST_STRING_PREAMBLE (str);
1468 _dbus_assert (start <= real->len);
1469 _dbus_assert (start >= 0);
1470 _dbus_assert (found != NULL);
1475 if (real->str[i] == byte)
1488 * Finds a blank (space or tab) in the string. Returns #TRUE
1489 * if found, #FALSE otherwise. If a blank is not found sets
1490 * *found to the length of the string.
1492 * @param str the string
1493 * @param start byte index to start looking
1494 * @param found place to store the location of the first blank
1495 * @returns #TRUE if a blank was found
1498 _dbus_string_find_blank (const DBusString *str,
1503 DBUS_CONST_STRING_PREAMBLE (str);
1504 _dbus_assert (start <= real->len);
1505 _dbus_assert (start >= 0);
1508 while (i < real->len)
1510 if (real->str[i] == ' ' ||
1511 real->str[i] == '\t')
1528 * Skips blanks from start, storing the first non-blank in *end
1529 * (blank is space or tab).
1531 * @param str the string
1532 * @param start where to start
1533 * @param end where to store the first non-blank byte index
1536 _dbus_string_skip_blank (const DBusString *str,
1541 DBUS_CONST_STRING_PREAMBLE (str);
1542 _dbus_assert (start <= real->len);
1543 _dbus_assert (start >= 0);
1546 while (i < real->len)
1548 if (!(real->str[i] == ' ' ||
1549 real->str[i] == '\t'))
1555 _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1556 real->str[i] == '\t'));
1563 * Skips whitespace from start, storing the first non-whitespace in *end.
1564 * (whitespace is space, tab, newline, CR).
1566 * @param str the string
1567 * @param start where to start
1568 * @param end where to store the first non-whitespace byte index
1571 _dbus_string_skip_white (const DBusString *str,
1576 DBUS_CONST_STRING_PREAMBLE (str);
1577 _dbus_assert (start <= real->len);
1578 _dbus_assert (start >= 0);
1581 while (i < real->len)
1583 if (!(real->str[i] == ' ' ||
1584 real->str[i] == '\n' ||
1585 real->str[i] == '\r' ||
1586 real->str[i] == '\t'))
1592 _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1593 real->str[i] == '\t'));
1600 * Assigns a newline-terminated or \r\n-terminated line from the front
1601 * of the string to the given dest string. The dest string's previous
1602 * contents are deleted. If the source string contains no newline,
1603 * moves the entire source string to the dest string.
1605 * @todo owen correctly notes that this is a stupid function (it was
1606 * written purely for test code,
1607 * e.g. dbus-message-builder.c). Probably should be enforced as test
1608 * code only with #ifdef DBUS_BUILD_TESTS
1610 * @param source the source string
1611 * @param dest the destination string (contents are replaced)
1612 * @returns #FALSE if no memory, or source has length 0
1615 _dbus_string_pop_line (DBusString *source,
1619 dbus_bool_t have_newline;
1621 _dbus_string_set_length (dest, 0);
1624 if (_dbus_string_find (source, 0, "\n", &eol))
1626 have_newline = TRUE;
1627 eol += 1; /* include newline */
1631 eol = _dbus_string_get_length (source);
1632 have_newline = FALSE;
1636 return FALSE; /* eof */
1638 if (!_dbus_string_move_len (source, 0, eol,
1644 /* dump the newline and the \r if we have one */
1647 dbus_bool_t have_cr;
1649 _dbus_assert (_dbus_string_get_length (dest) > 0);
1651 if (_dbus_string_get_length (dest) > 1 &&
1652 _dbus_string_get_byte (dest,
1653 _dbus_string_get_length (dest) - 2) == '\r')
1658 _dbus_string_set_length (dest,
1659 _dbus_string_get_length (dest) -
1667 * Deletes up to and including the first blank space
1670 * @param str the string
1673 _dbus_string_delete_first_word (DBusString *str)
1677 if (_dbus_string_find_blank (str, 0, &i))
1678 _dbus_string_skip_blank (str, i, &i);
1680 _dbus_string_delete (str, 0, i);
1684 * Deletes any leading blanks in the string
1686 * @param str the string
1689 _dbus_string_delete_leading_blanks (DBusString *str)
1693 _dbus_string_skip_blank (str, 0, &i);
1696 _dbus_string_delete (str, 0, i);
1700 * Tests two DBusString for equality.
1702 * @todo memcmp is probably faster
1704 * @param a first string
1705 * @param b second string
1706 * @returns #TRUE if equal
1709 _dbus_string_equal (const DBusString *a,
1710 const DBusString *b)
1712 const unsigned char *ap;
1713 const unsigned char *bp;
1714 const unsigned char *a_end;
1715 const DBusRealString *real_a = (const DBusRealString*) a;
1716 const DBusRealString *real_b = (const DBusRealString*) b;
1717 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1718 DBUS_GENERIC_STRING_PREAMBLE (real_b);
1720 if (real_a->len != real_b->len)
1725 a_end = real_a->str + real_a->len;
1739 * Tests two DBusString for equality up to the given length.
1741 * @todo write a unit test
1743 * @todo memcmp is probably faster
1745 * @param a first string
1746 * @param b second string
1747 * @param len the lengh
1748 * @returns #TRUE if equal for the given number of bytes
1751 _dbus_string_equal_len (const DBusString *a,
1752 const DBusString *b,
1755 const unsigned char *ap;
1756 const unsigned char *bp;
1757 const unsigned char *a_end;
1758 const DBusRealString *real_a = (const DBusRealString*) a;
1759 const DBusRealString *real_b = (const DBusRealString*) b;
1760 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1761 DBUS_GENERIC_STRING_PREAMBLE (real_b);
1763 if (real_a->len != real_b->len &&
1764 (real_a->len < len || real_b->len < len))
1769 a_end = real_a->str + MIN (real_a->len, len);
1783 * Checks whether a string is equal to a C string.
1785 * @param a the string
1786 * @param c_str the C string
1787 * @returns #TRUE if equal
1790 _dbus_string_equal_c_str (const DBusString *a,
1793 const unsigned char *ap;
1794 const unsigned char *bp;
1795 const unsigned char *a_end;
1796 const DBusRealString *real_a = (const DBusRealString*) a;
1797 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1798 _dbus_assert (c_str != NULL);
1801 bp = (const unsigned char*) c_str;
1802 a_end = real_a->str + real_a->len;
1803 while (ap != a_end && *bp)
1812 if (ap != a_end || *bp)
1819 * Checks whether a string starts with the given C string.
1821 * @param a the string
1822 * @param c_str the C string
1823 * @returns #TRUE if string starts with it
1826 _dbus_string_starts_with_c_str (const DBusString *a,
1829 const unsigned char *ap;
1830 const unsigned char *bp;
1831 const unsigned char *a_end;
1832 const DBusRealString *real_a = (const DBusRealString*) a;
1833 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1834 _dbus_assert (c_str != NULL);
1837 bp = (const unsigned char*) c_str;
1838 a_end = real_a->str + real_a->len;
1839 while (ap != a_end && *bp)
1855 * Returns whether a string ends with the given suffix
1857 * @todo memcmp might make this faster.
1859 * @param a the string
1860 * @param c_str the C-style string
1861 * @returns #TRUE if the string ends with the suffix
1864 _dbus_string_ends_with_c_str (const DBusString *a,
1867 const unsigned char *ap;
1868 const unsigned char *bp;
1869 const unsigned char *a_end;
1870 unsigned long c_str_len;
1871 const DBusRealString *real_a = (const DBusRealString*) a;
1872 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1873 _dbus_assert (c_str != NULL);
1875 c_str_len = strlen (c_str);
1876 if (((unsigned long)real_a->len) < c_str_len)
1879 ap = real_a->str + (real_a->len - c_str_len);
1880 bp = (const unsigned char*) c_str;
1881 a_end = real_a->str + real_a->len;
1891 _dbus_assert (*ap == '\0');
1892 _dbus_assert (*bp == '\0');
1897 static const signed char base64_table[] = {
1964 /** The minimum char that's a valid char in Base64-encoded text */
1965 #define UNBASE64_MIN_CHAR (43)
1966 /** The maximum char that's a valid char in Base64-encoded text */
1967 #define UNBASE64_MAX_CHAR (122)
1968 /** Must subtract this from a char's integer value before offsetting
1969 * into unbase64_table
1971 #define UNBASE64_TABLE_OFFSET UNBASE64_MIN_CHAR
1972 static const signed char unbase64_table[] = {
2056 * Encodes a string using Base64, as documented in RFC 2045.
2058 * @param source the string to encode
2059 * @param start byte index to start encoding
2060 * @param dest string where encoded data should be placed
2061 * @param insert_at where to place encoded data
2062 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2065 _dbus_string_base64_encode (const DBusString *source,
2071 unsigned int dest_len; /* unsigned for overflow checks below */
2072 const unsigned char *s;
2074 const unsigned char *triplet_end;
2075 const unsigned char *final_end;
2076 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2077 _dbus_assert (source != dest);
2079 /* For each 24 bits (3 bytes) of input, we have 4 bytes of
2082 source_len = real_source->len - start;
2083 dest_len = (source_len / 3) * 4;
2084 if (source_len % 3 != 0)
2087 if (dest_len > (unsigned int) real_dest->max_length)
2090 if (source_len == 0)
2093 if (!open_gap (dest_len, real_dest, insert_at))
2096 d = real_dest->str + insert_at;
2097 s = real_source->str + start;
2098 final_end = real_source->str + (start + source_len);
2099 triplet_end = final_end - (source_len % 3);
2100 _dbus_assert (triplet_end <= final_end);
2101 _dbus_assert ((final_end - triplet_end) < 3);
2103 #define ENCODE_64(v) (base64_table[ (unsigned char) (v) ])
2104 #define SIX_BITS_MASK (0x3f)
2105 _dbus_assert (SIX_BITS_MASK < _DBUS_N_ELEMENTS (base64_table));
2107 while (s != triplet_end)
2109 unsigned int triplet;
2111 triplet = s[2] | (s[1] << 8) | (s[0] << 16);
2113 /* Encode each 6 bits. */
2115 *d++ = ENCODE_64 (triplet >> 18);
2116 *d++ = ENCODE_64 ((triplet >> 12) & SIX_BITS_MASK);
2117 *d++ = ENCODE_64 ((triplet >> 6) & SIX_BITS_MASK);
2118 *d++ = ENCODE_64 (triplet & SIX_BITS_MASK);
2123 switch (final_end - triplet_end)
2127 unsigned int doublet;
2129 doublet = s[1] | (s[0] << 8);
2131 *d++ = ENCODE_64 (doublet >> 12);
2132 *d++ = ENCODE_64 ((doublet >> 6) & SIX_BITS_MASK);
2133 *d++ = ENCODE_64 (doublet & SIX_BITS_MASK);
2139 unsigned int singlet;
2143 *d++ = ENCODE_64 ((singlet >> 6) & SIX_BITS_MASK);
2144 *d++ = ENCODE_64 (singlet & SIX_BITS_MASK);
2153 _dbus_assert (d == (real_dest->str + (insert_at + dest_len)));
2159 * Decodes a string from Base64, as documented in RFC 2045.
2161 * @todo sort out the AUDIT comment in here. The case it mentions
2162 * ("====" or "x===") is not allowed in correct base64, so need to
2163 * decide what to do with that kind of input. Probably ignore it
2164 * since we ignore any other junk seen.
2166 * @param source the string to decode
2167 * @param start byte index to start decode
2168 * @param dest string where decoded data should be placed
2169 * @param insert_at where to place decoded data
2170 * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2173 _dbus_string_base64_decode (const DBusString *source,
2182 unsigned int triplet = 0;
2185 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2186 _dbus_assert (source != dest);
2188 source_len = real_source->len - start;
2189 s = real_source->str + start;
2190 end = real_source->str + source_len;
2192 if (source_len == 0)
2195 if (!_dbus_string_init (&result))
2202 /* The idea is to just skip anything that isn't
2203 * a base64 char - it's allowed to have whitespace,
2204 * newlines, etc. in here. We also ignore trailing
2205 * base64 chars, though that's suspicious.
2208 if (*s >= UNBASE64_MIN_CHAR &&
2209 *s <= UNBASE64_MAX_CHAR)
2213 /* '=' is padding, doesn't represent additional data
2214 * but does increment our count.
2223 val = unbase64_table[(*s) - UNBASE64_TABLE_OFFSET];
2228 triplet |= (unsigned int) val;
2233 if (sextet_count == 4)
2235 /* no pad = 3 bytes, 1 pad = 2 bytes, 2 pad = 1 byte */
2238 /* AUDIT: Comment doesn't mention 4 pad => 0,
2239 * 3 pad => 1 byte, though the code should
2240 * work fine if those are the required outputs.
2242 * I assume that the spec requires dropping
2243 * the top two bits of, say, ///= which is > 2
2244 * bytes worth of bits. (Or otherwise, you couldn't
2245 * actually represent 2 byte sequences.
2250 if (!_dbus_string_append_byte (&result,
2257 if (!_dbus_string_append_byte (&result,
2258 (triplet >> 8) & 0xff))
2262 if (!_dbus_string_append_byte (&result,
2275 if (!_dbus_string_move (&result, 0, dest, insert_at))
2277 _dbus_string_free (&result);
2281 _dbus_string_free (&result);
2286 _dbus_string_free (&result);
2292 * Encodes a string in hex, the way MD5 and SHA-1 are usually
2293 * encoded. (Each byte is two hex digits.)
2295 * @param source the string to encode
2296 * @param start byte index to start encoding
2297 * @param dest string where encoded data should be placed
2298 * @param insert_at where to place encoded data
2299 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2302 _dbus_string_hex_encode (const DBusString *source,
2308 const char hexdigits[16] = {
2309 '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
2310 'a', 'b', 'c', 'd', 'e', 'f'
2312 const unsigned char *p;
2313 const unsigned char *end;
2316 _dbus_assert (start <= _dbus_string_get_length (source));
2318 if (!_dbus_string_init (&result))
2323 p = (const unsigned char*) _dbus_string_get_const_data (source);
2324 end = p + _dbus_string_get_length (source);
2329 if (!_dbus_string_append_byte (&result,
2330 hexdigits[(*p >> 4)]))
2333 if (!_dbus_string_append_byte (&result,
2334 hexdigits[(*p & 0x0f)]))
2340 if (!_dbus_string_move (&result, 0, dest, insert_at))
2346 _dbus_string_free (&result);
2351 * Decodes a string from hex encoding.
2353 * @param source the string to decode
2354 * @param start byte index to start decode
2355 * @param dest string where decoded data should be placed
2356 * @param insert_at where to place decoded data
2357 * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2360 _dbus_string_hex_decode (const DBusString *source,
2366 const unsigned char *p;
2367 const unsigned char *end;
2369 dbus_bool_t high_bits;
2371 _dbus_assert (start <= _dbus_string_get_length (source));
2373 if (!_dbus_string_init (&result))
2379 p = (const unsigned char*) _dbus_string_get_const_data (source);
2380 end = p + _dbus_string_get_length (source);
2445 _dbus_verbose ("invalid character '%c' in hex encoded text\n",
2452 if (!_dbus_string_append_byte (&result,
2461 len = _dbus_string_get_length (&result);
2463 b = _dbus_string_get_byte (&result, len - 1);
2467 _dbus_string_set_byte (&result, len - 1, b);
2470 high_bits = !high_bits;
2475 if (!_dbus_string_move (&result, 0, dest, insert_at))
2481 _dbus_string_free (&result);
2486 * Checks that the given range of the string is valid ASCII with no
2487 * nul bytes. If the given range is not entirely contained in the
2488 * string, returns #FALSE.
2490 * @todo this is inconsistent with most of DBusString in that
2491 * it allows a start,len range that isn't in the string.
2493 * @param str the string
2494 * @param start first byte index to check
2495 * @param len number of bytes to check
2496 * @returns #TRUE if the byte range exists and is all valid ASCII
2499 _dbus_string_validate_ascii (const DBusString *str,
2503 const unsigned char *s;
2504 const unsigned char *end;
2505 DBUS_CONST_STRING_PREAMBLE (str);
2506 _dbus_assert (start >= 0);
2507 _dbus_assert (start <= real->len);
2508 _dbus_assert (len >= 0);
2510 if (len > real->len - start)
2513 s = real->str + start;
2518 ((*s & ~0x7f) != 0))
2528 * Checks that the given range of the string is valid UTF-8. If the
2529 * given range is not entirely contained in the string, returns
2530 * #FALSE. If the string contains any nul bytes in the given range,
2531 * returns #FALSE. If the start and start+len are not on character
2532 * boundaries, returns #FALSE.
2534 * @todo this is inconsistent with most of DBusString in that
2535 * it allows a start,len range that isn't in the string.
2537 * @param str the string
2538 * @param start first byte index to check
2539 * @param len number of bytes to check
2540 * @returns #TRUE if the byte range exists and is all valid UTF-8
2543 _dbus_string_validate_utf8 (const DBusString *str,
2547 const unsigned char *p;
2548 const unsigned char *end;
2549 DBUS_CONST_STRING_PREAMBLE (str);
2550 _dbus_assert (start >= 0);
2551 _dbus_assert (start <= real->len);
2552 _dbus_assert (len >= 0);
2554 if (len > real->len - start)
2557 p = real->str + start;
2562 int i, mask = 0, char_len;
2563 dbus_unichar_t result;
2564 unsigned char c = (unsigned char) *p;
2566 UTF8_COMPUTE (c, mask, char_len);
2571 /* check that the expected number of bytes exists in the remaining length */
2572 if ((end - p) < char_len)
2575 UTF8_GET (result, p, i, mask, char_len);
2577 if (UTF8_LENGTH (result) != char_len) /* Check for overlong UTF-8 */
2580 if (result == (dbus_unichar_t)-1)
2583 if (!UNICODE_VALID (result))
2589 /* See that we covered the entire length if a length was
2599 * Checks that the given range of the string is all nul bytes. If the
2600 * given range is not entirely contained in the string, returns
2603 * @todo this is inconsistent with most of DBusString in that
2604 * it allows a start,len range that isn't in the string.
2606 * @param str the string
2607 * @param start first byte index to check
2608 * @param len number of bytes to check
2609 * @returns #TRUE if the byte range exists and is all nul bytes
2612 _dbus_string_validate_nul (const DBusString *str,
2616 const unsigned char *s;
2617 const unsigned char *end;
2618 DBUS_CONST_STRING_PREAMBLE (str);
2619 _dbus_assert (start >= 0);
2620 _dbus_assert (len >= 0);
2621 _dbus_assert (start <= real->len);
2623 if (len > real->len - start)
2626 s = real->str + start;
2639 * Clears all allocated bytes in the string to zero.
2641 * @param str the string
2644 _dbus_string_zero (DBusString *str)
2646 DBUS_STRING_PREAMBLE (str);
2648 memset (real->str, '\0', real->allocated);
2652 #ifdef DBUS_BUILD_TESTS
2653 #include "dbus-test.h"
2657 test_max_len (DBusString *str,
2662 if (!_dbus_string_set_length (str, max_len - 1))
2663 _dbus_assert_not_reached ("setting len to one less than max should have worked");
2666 if (!_dbus_string_set_length (str, max_len))
2667 _dbus_assert_not_reached ("setting len to max len should have worked");
2669 if (_dbus_string_set_length (str, max_len + 1))
2670 _dbus_assert_not_reached ("setting len to one more than max len should not have worked");
2672 if (!_dbus_string_set_length (str, 0))
2673 _dbus_assert_not_reached ("setting len to zero should have worked");
2677 test_base64_roundtrip (const unsigned char *data,
2685 len = strlen (data);
2687 if (!_dbus_string_init (&orig))
2688 _dbus_assert_not_reached ("could not init string");
2690 if (!_dbus_string_init (&encoded))
2691 _dbus_assert_not_reached ("could not init string");
2693 if (!_dbus_string_init (&decoded))
2694 _dbus_assert_not_reached ("could not init string");
2696 if (!_dbus_string_append_len (&orig, data, len))
2697 _dbus_assert_not_reached ("couldn't append orig data");
2699 if (!_dbus_string_base64_encode (&orig, 0, &encoded, 0))
2700 _dbus_assert_not_reached ("could not encode");
2702 if (!_dbus_string_base64_decode (&encoded, 0, &decoded, 0))
2703 _dbus_assert_not_reached ("could not decode");
2705 if (!_dbus_string_equal (&orig, &decoded))
2709 printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
2710 _dbus_string_get_length (&orig),
2711 _dbus_string_get_length (&encoded),
2712 _dbus_string_get_length (&decoded));
2713 printf ("Original: %s\n", data);
2714 s = _dbus_string_get_const_data (&decoded);
2715 printf ("Decoded: %s\n", s);
2716 _dbus_assert_not_reached ("original string not the same as string decoded from base64");
2719 _dbus_string_free (&orig);
2720 _dbus_string_free (&encoded);
2721 _dbus_string_free (&decoded);
2725 test_hex_roundtrip (const unsigned char *data,
2733 len = strlen (data);
2735 if (!_dbus_string_init (&orig))
2736 _dbus_assert_not_reached ("could not init string");
2738 if (!_dbus_string_init (&encoded))
2739 _dbus_assert_not_reached ("could not init string");
2741 if (!_dbus_string_init (&decoded))
2742 _dbus_assert_not_reached ("could not init string");
2744 if (!_dbus_string_append_len (&orig, data, len))
2745 _dbus_assert_not_reached ("couldn't append orig data");
2747 if (!_dbus_string_hex_encode (&orig, 0, &encoded, 0))
2748 _dbus_assert_not_reached ("could not encode");
2750 if (!_dbus_string_hex_decode (&encoded, 0, &decoded, 0))
2751 _dbus_assert_not_reached ("could not decode");
2753 if (!_dbus_string_equal (&orig, &decoded))
2757 printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
2758 _dbus_string_get_length (&orig),
2759 _dbus_string_get_length (&encoded),
2760 _dbus_string_get_length (&decoded));
2761 printf ("Original: %s\n", data);
2762 s = _dbus_string_get_const_data (&decoded);
2763 printf ("Decoded: %s\n", s);
2764 _dbus_assert_not_reached ("original string not the same as string decoded from base64");
2767 _dbus_string_free (&orig);
2768 _dbus_string_free (&encoded);
2769 _dbus_string_free (&decoded);
2772 typedef void (* TestRoundtripFunc) (const unsigned char *data,
2775 test_roundtrips (TestRoundtripFunc func)
2777 (* func) ("Hello this is a string\n", -1);
2778 (* func) ("Hello this is a string\n1", -1);
2779 (* func) ("Hello this is a string\n12", -1);
2780 (* func) ("Hello this is a string\n123", -1);
2781 (* func) ("Hello this is a string\n1234", -1);
2782 (* func) ("Hello this is a string\n12345", -1);
2786 (* func) ("123", 3);
2787 (* func) ("1234", 4);
2788 (* func) ("12345", 5);
2792 (* func) ("123", 4);
2793 (* func) ("1234", 5);
2794 (* func) ("12345", 6);
2796 unsigned char buf[512];
2800 while (i < _DBUS_N_ELEMENTS (buf))
2806 while (i < _DBUS_N_ELEMENTS (buf))
2816 * @ingroup DBusStringInternals
2817 * Unit test for DBusString.
2819 * @todo Need to write tests for _dbus_string_copy() and
2820 * _dbus_string_move() moving to/from each of start/middle/end of a
2821 * string. Also need tests for _dbus_string_move_len ()
2823 * @returns #TRUE on success.
2826 _dbus_string_test (void)
2833 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 };
2838 while (i < _DBUS_N_ELEMENTS (lens))
2840 if (!_dbus_string_init (&str))
2841 _dbus_assert_not_reached ("failed to init string");
2843 set_max_length (&str, lens[i]);
2845 test_max_len (&str, lens[i]);
2846 _dbus_string_free (&str);
2851 /* Test shortening and setting length */
2853 while (i < _DBUS_N_ELEMENTS (lens))
2857 if (!_dbus_string_init (&str))
2858 _dbus_assert_not_reached ("failed to init string");
2860 set_max_length (&str, lens[i]);
2862 if (!_dbus_string_set_length (&str, lens[i]))
2863 _dbus_assert_not_reached ("failed to set string length");
2868 _dbus_assert (_dbus_string_get_length (&str) == j);
2871 _dbus_string_shorten (&str, 1);
2872 _dbus_assert (_dbus_string_get_length (&str) == (j - 1));
2877 _dbus_string_free (&str);
2882 /* Test appending data */
2883 if (!_dbus_string_init (&str))
2884 _dbus_assert_not_reached ("failed to init string");
2889 if (!_dbus_string_append (&str, "a"))
2890 _dbus_assert_not_reached ("failed to append string to string\n");
2892 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 1);
2894 if (!_dbus_string_append_byte (&str, 'b'))
2895 _dbus_assert_not_reached ("failed to append byte to string\n");
2897 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 2);
2902 _dbus_string_free (&str);
2904 /* Check steal_data */
2906 if (!_dbus_string_init (&str))
2907 _dbus_assert_not_reached ("failed to init string");
2909 if (!_dbus_string_append (&str, "Hello World"))
2910 _dbus_assert_not_reached ("could not append to string");
2912 i = _dbus_string_get_length (&str);
2914 if (!_dbus_string_steal_data (&str, &s))
2915 _dbus_assert_not_reached ("failed to steal data");
2917 _dbus_assert (_dbus_string_get_length (&str) == 0);
2918 _dbus_assert (((int)strlen (s)) == i);
2924 if (!_dbus_string_append (&str, "Hello World"))
2925 _dbus_assert_not_reached ("could not append to string");
2927 i = _dbus_string_get_length (&str);
2929 if (!_dbus_string_init (&other))
2930 _dbus_assert_not_reached ("could not init string");
2932 if (!_dbus_string_move (&str, 0, &other, 0))
2933 _dbus_assert_not_reached ("could not move");
2935 _dbus_assert (_dbus_string_get_length (&str) == 0);
2936 _dbus_assert (_dbus_string_get_length (&other) == i);
2938 if (!_dbus_string_append (&str, "Hello World"))
2939 _dbus_assert_not_reached ("could not append to string");
2941 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other)))
2942 _dbus_assert_not_reached ("could not move");
2944 _dbus_assert (_dbus_string_get_length (&str) == 0);
2945 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
2947 if (!_dbus_string_append (&str, "Hello World"))
2948 _dbus_assert_not_reached ("could not append to string");
2950 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2951 _dbus_assert_not_reached ("could not move");
2953 _dbus_assert (_dbus_string_get_length (&str) == 0);
2954 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2956 _dbus_string_free (&other);
2960 if (!_dbus_string_append (&str, "Hello World"))
2961 _dbus_assert_not_reached ("could not append to string");
2963 i = _dbus_string_get_length (&str);
2965 if (!_dbus_string_init (&other))
2966 _dbus_assert_not_reached ("could not init string");
2968 if (!_dbus_string_copy (&str, 0, &other, 0))
2969 _dbus_assert_not_reached ("could not copy");
2971 _dbus_assert (_dbus_string_get_length (&str) == i);
2972 _dbus_assert (_dbus_string_get_length (&other) == i);
2974 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other)))
2975 _dbus_assert_not_reached ("could not copy");
2977 _dbus_assert (_dbus_string_get_length (&str) == i);
2978 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
2979 _dbus_assert (_dbus_string_equal_c_str (&other,
2980 "Hello WorldHello World"));
2982 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2983 _dbus_assert_not_reached ("could not copy");
2985 _dbus_assert (_dbus_string_get_length (&str) == i);
2986 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2987 _dbus_assert (_dbus_string_equal_c_str (&other,
2988 "Hello WorldHello WorldHello World"));
2990 _dbus_string_free (&str);
2991 _dbus_string_free (&other);
2995 if (!_dbus_string_init (&str))
2996 _dbus_assert_not_reached ("failed to init string");
2998 if (!_dbus_string_append (&str, "Hello World"))
2999 _dbus_assert_not_reached ("could not append to string");
3001 i = _dbus_string_get_length (&str);
3003 if (!_dbus_string_init (&other))
3004 _dbus_assert_not_reached ("could not init string");
3006 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3007 &other, 0, _dbus_string_get_length (&other)))
3008 _dbus_assert_not_reached ("could not replace");
3010 _dbus_assert (_dbus_string_get_length (&str) == i);
3011 _dbus_assert (_dbus_string_get_length (&other) == i);
3012 _dbus_assert (_dbus_string_equal_c_str (&other, "Hello World"));
3014 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3016 _dbus_assert_not_reached ("could not replace center space");
3018 _dbus_assert (_dbus_string_get_length (&str) == i);
3019 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3020 _dbus_assert (_dbus_string_equal_c_str (&other,
3021 "HelloHello WorldWorld"));
3024 if (!_dbus_string_replace_len (&str, 1, 1,
3026 _dbus_string_get_length (&other) - 1,
3028 _dbus_assert_not_reached ("could not replace end character");
3030 _dbus_assert (_dbus_string_get_length (&str) == i);
3031 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3032 _dbus_assert (_dbus_string_equal_c_str (&other,
3033 "HelloHello WorldWorle"));
3035 _dbus_string_free (&str);
3036 _dbus_string_free (&other);
3038 /* Check append/get unichar */
3040 if (!_dbus_string_init (&str))
3041 _dbus_assert_not_reached ("failed to init string");
3044 if (!_dbus_string_append_unichar (&str, 0xfffc))
3045 _dbus_assert_not_reached ("failed to append unichar");
3047 _dbus_string_get_unichar (&str, 0, &ch, &i);
3049 _dbus_assert (ch == 0xfffc);
3050 _dbus_assert (i == _dbus_string_get_length (&str));
3052 _dbus_string_free (&str);
3054 /* Check insert/set/get byte */
3056 if (!_dbus_string_init (&str))
3057 _dbus_assert_not_reached ("failed to init string");
3059 if (!_dbus_string_append (&str, "Hello"))
3060 _dbus_assert_not_reached ("failed to append Hello");
3062 _dbus_assert (_dbus_string_get_byte (&str, 0) == 'H');
3063 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'e');
3064 _dbus_assert (_dbus_string_get_byte (&str, 2) == 'l');
3065 _dbus_assert (_dbus_string_get_byte (&str, 3) == 'l');
3066 _dbus_assert (_dbus_string_get_byte (&str, 4) == 'o');
3068 _dbus_string_set_byte (&str, 1, 'q');
3069 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'q');
3071 if (!_dbus_string_insert_byte (&str, 0, 255))
3072 _dbus_assert_not_reached ("can't insert byte");
3074 if (!_dbus_string_insert_byte (&str, 2, 'Z'))
3075 _dbus_assert_not_reached ("can't insert byte");
3077 if (!_dbus_string_insert_byte (&str, _dbus_string_get_length (&str), 'W'))
3078 _dbus_assert_not_reached ("can't insert byte");
3080 _dbus_assert (_dbus_string_get_byte (&str, 0) == 255);
3081 _dbus_assert (_dbus_string_get_byte (&str, 1) == 'H');
3082 _dbus_assert (_dbus_string_get_byte (&str, 2) == 'Z');
3083 _dbus_assert (_dbus_string_get_byte (&str, 3) == 'q');
3084 _dbus_assert (_dbus_string_get_byte (&str, 4) == 'l');
3085 _dbus_assert (_dbus_string_get_byte (&str, 5) == 'l');
3086 _dbus_assert (_dbus_string_get_byte (&str, 6) == 'o');
3087 _dbus_assert (_dbus_string_get_byte (&str, 7) == 'W');
3089 _dbus_string_free (&str);
3091 /* Check append/parse int/double */
3093 if (!_dbus_string_init (&str))
3094 _dbus_assert_not_reached ("failed to init string");
3096 if (!_dbus_string_append_int (&str, 27))
3097 _dbus_assert_not_reached ("failed to append int");
3099 i = _dbus_string_get_length (&str);
3101 if (!_dbus_string_parse_int (&str, 0, &v, &end))
3102 _dbus_assert_not_reached ("failed to parse int");
3104 _dbus_assert (v == 27);
3105 _dbus_assert (end == i);
3107 _dbus_string_free (&str);
3109 if (!_dbus_string_init (&str))
3110 _dbus_assert_not_reached ("failed to init string");
3112 if (!_dbus_string_append_double (&str, 50.3))
3113 _dbus_assert_not_reached ("failed to append float");
3115 i = _dbus_string_get_length (&str);
3117 if (!_dbus_string_parse_double (&str, 0, &d, &end))
3118 _dbus_assert_not_reached ("failed to parse float");
3120 _dbus_assert (d > (50.3 - 1e-6) && d < (50.3 + 1e-6));
3121 _dbus_assert (end == i);
3123 _dbus_string_free (&str);
3126 if (!_dbus_string_init (&str))
3127 _dbus_assert_not_reached ("failed to init string");
3129 if (!_dbus_string_append (&str, "Hello"))
3130 _dbus_assert_not_reached ("couldn't append to string");
3132 if (!_dbus_string_find (&str, 0, "He", &i))
3133 _dbus_assert_not_reached ("didn't find 'He'");
3134 _dbus_assert (i == 0);
3136 if (!_dbus_string_find (&str, 0, "Hello", &i))
3137 _dbus_assert_not_reached ("didn't find 'Hello'");
3138 _dbus_assert (i == 0);
3140 if (!_dbus_string_find (&str, 0, "ello", &i))
3141 _dbus_assert_not_reached ("didn't find 'ello'");
3142 _dbus_assert (i == 1);
3144 if (!_dbus_string_find (&str, 0, "lo", &i))
3145 _dbus_assert_not_reached ("didn't find 'lo'");
3146 _dbus_assert (i == 3);
3148 if (!_dbus_string_find (&str, 2, "lo", &i))
3149 _dbus_assert_not_reached ("didn't find 'lo'");
3150 _dbus_assert (i == 3);
3152 if (_dbus_string_find (&str, 4, "lo", &i))
3153 _dbus_assert_not_reached ("did find 'lo'");
3155 if (!_dbus_string_find (&str, 0, "l", &i))
3156 _dbus_assert_not_reached ("didn't find 'l'");
3157 _dbus_assert (i == 2);
3159 if (!_dbus_string_find (&str, 0, "H", &i))
3160 _dbus_assert_not_reached ("didn't find 'H'");
3161 _dbus_assert (i == 0);
3163 if (!_dbus_string_find (&str, 0, "", &i))
3164 _dbus_assert_not_reached ("didn't find ''");
3165 _dbus_assert (i == 0);
3167 if (_dbus_string_find (&str, 0, "Hello!", NULL))
3168 _dbus_assert_not_reached ("Did find 'Hello!'");
3170 if (_dbus_string_find (&str, 0, "Oh, Hello", NULL))
3171 _dbus_assert_not_reached ("Did find 'Oh, Hello'");
3173 if (_dbus_string_find (&str, 0, "ill", NULL))
3174 _dbus_assert_not_reached ("Did find 'ill'");
3176 if (_dbus_string_find (&str, 0, "q", NULL))
3177 _dbus_assert_not_reached ("Did find 'q'");
3179 if (!_dbus_string_find_to (&str, 0, 2, "He", NULL))
3180 _dbus_assert_not_reached ("Didn't find 'He'");
3182 if (_dbus_string_find_to (&str, 0, 2, "Hello", NULL))
3183 _dbus_assert_not_reached ("Did find 'Hello'");
3185 if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'H', &i))
3186 _dbus_assert_not_reached ("Did not find 'H'");
3187 _dbus_assert (i == 0);
3189 if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'o', &i))
3190 _dbus_assert_not_reached ("Did not find 'o'");
3191 _dbus_assert (i == _dbus_string_get_length (&str) - 1);
3193 if (_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str) - 1, 'o', &i))
3194 _dbus_assert_not_reached ("Did find 'o'");
3195 _dbus_assert (i == -1);
3197 if (_dbus_string_find_byte_backward (&str, 1, 'e', &i))
3198 _dbus_assert_not_reached ("Did find 'e'");
3199 _dbus_assert (i == -1);
3201 if (!_dbus_string_find_byte_backward (&str, 2, 'e', &i))
3202 _dbus_assert_not_reached ("Didn't find 'e'");
3203 _dbus_assert (i == 1);
3205 _dbus_string_free (&str);
3207 /* Base 64 and Hex encoding */
3208 test_roundtrips (test_base64_roundtrip);
3209 test_roundtrips (test_hex_roundtrip);
3214 #endif /* DBUS_BUILD_TESTS */