1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-string.c String utility class (internal to D-BUS implementation)
4 * Copyright (C) 2002 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 * @defgroup DBusString string class
31 * @ingroup DBusInternals
32 * @brief DBusString data structure
34 * Types and functions related to DBusString. DBusString is intended
35 * to be a string class that makes it hard to mess up security issues
36 * (and just in general harder to write buggy code). It should be
37 * used (or extended and then used) rather than the libc stuff in
38 * string.h. The string class is a bit inconvenient at spots because
39 * it handles out-of-memory failures and tries to be extra-robust.
41 * A DBusString has a maximum length set at initialization time; this
42 * can be used to ensure that a buffer doesn't get too big. The
43 * _dbus_string_lengthen() method checks for overflow, and for max
44 * length being exceeded.
46 * Try to avoid conversion to a plain C string, i.e. add methods on
47 * the string object instead, only convert to C string when passing
48 * things out to the public API. In particular, no sprintf, strcpy,
49 * strcat, any of that should be used. The GString feature of
50 * accepting negative numbers for "length of string" is also absent,
51 * because it could keep us from detecting bogus huge lengths. i.e. if
52 * we passed in some bogus huge length it would be taken to mean
53 * "current length of string" instead of "broken crack"
57 * @defgroup DBusStringInternals DBusString implementation details
58 * @ingroup DBusInternals
59 * @brief DBusString implementation details
61 * The guts of DBusString.
67 * @brief Internals of DBusString.
69 * DBusString internals. DBusString is an opaque objects, it must be
70 * used via accessor functions.
74 unsigned char *str; /**< String data, plus nul termination */
75 int len; /**< Length without nul */
76 int allocated; /**< Allocated size of data */
77 int max_length; /**< Max length of this string. */
78 unsigned int constant : 1; /**< String data is not owned by DBusString */
79 unsigned int locked : 1; /**< DBusString has been locked and can't be changed */
80 unsigned int invalid : 1; /**< DBusString is invalid (e.g. already freed) */
84 * Checks a bunch of assertions about a string object
86 * @param real the DBusRealString
88 #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); _dbus_assert ((real)->len <= (real)->max_length)
91 * Checks assertions about a string object that needs to be
92 * modifiable - may not be locked or const. Also declares
93 * the "real" variable pointing to DBusRealString.
94 * @param str the string
96 #define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
97 DBUS_GENERIC_STRING_PREAMBLE (real); \
98 _dbus_assert (!(real)->constant); \
99 _dbus_assert (!(real)->locked)
102 * Checks assertions about a string object that may be locked but
103 * can't be const. i.e. a string object that we can free. Also
104 * declares the "real" variable pointing to DBusRealString.
106 * @param str the string
108 #define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
109 DBUS_GENERIC_STRING_PREAMBLE (real); \
110 _dbus_assert (!(real)->constant)
113 * Checks assertions about a string that may be const or locked. Also
114 * declares the "real" variable pointing to DBusRealString.
115 * @param str the string.
117 #define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
118 DBUS_GENERIC_STRING_PREAMBLE (real)
123 * @addtogroup DBusString
127 /** Assert that the string's memory is 8-byte aligned.
129 * @todo Currently we just hope libc returns 8-byte aligned memory
130 * (which is true for GNU libc), but really we need to ensure it by
131 * allocating 8 extra bytes and keeping an "align_offset : 3" field
132 * in DBusString, or something along those lines.
134 #define ASSERT_8_BYTE_ALIGNED(s) \
135 _dbus_assert (_DBUS_ALIGN_ADDRESS (((const DBusRealString*)s)->str, 8) == ((const DBusRealString*)s)->str)
138 * Initializes a string. The maximum length may be _DBUS_INT_MAX for
139 * no maximum. The string starts life with zero length.
140 * The string must eventually be freed with _dbus_string_free().
142 * @param str memory to hold the string
143 * @param max_length the maximum size of the string
144 * @returns #TRUE on success
147 _dbus_string_init (DBusString *str,
150 DBusRealString *real;
152 _dbus_assert (str != NULL);
153 _dbus_assert (max_length >= 0);
155 _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
157 real = (DBusRealString*) str;
159 /* It's very important not to touch anything
160 * other than real->str if we're going to fail,
161 * since we also use this function to reset
162 * an existing string, e.g. in _dbus_string_steal_data()
165 #define INITIAL_ALLOC 2
167 real->str = dbus_malloc (INITIAL_ALLOC);
168 if (real->str == NULL)
171 real->allocated = INITIAL_ALLOC;
173 real->str[real->len] = '\0';
175 real->max_length = max_length;
176 real->constant = FALSE;
177 real->locked = FALSE;
178 real->invalid = FALSE;
180 ASSERT_8_BYTE_ALIGNED (str);
186 * Initializes a constant string. The value parameter is not copied
187 * (should be static), and the string may never be modified.
188 * It is safe but not necessary to call _dbus_string_free()
191 * @param str memory to use for the string
192 * @param value a string to be stored in str (not copied!!!)
195 _dbus_string_init_const (DBusString *str,
198 _dbus_string_init_const_len (str, value,
203 * Initializes a constant string with a length. The value parameter is
204 * not copied (should be static), and the string may never be
205 * modified. It is safe but not necessary to call _dbus_string_free()
208 * @param str memory to use for the string
209 * @param value a string to be stored in str (not copied!!!)
210 * @param len the length to use
213 _dbus_string_init_const_len (DBusString *str,
217 DBusRealString *real;
219 _dbus_assert (str != NULL);
220 _dbus_assert (value != NULL);
222 real = (DBusRealString*) str;
224 real->str = (char*) value;
226 real->allocated = real->len;
227 real->max_length = real->len;
228 real->constant = TRUE;
229 real->invalid = FALSE;
231 /* We don't require const strings to be 8-byte aligned as the
232 * memory is coming from elsewhere.
237 * Frees a string created by _dbus_string_init().
239 * @param str memory where the string is stored.
242 _dbus_string_free (DBusString *str)
244 DBUS_LOCKED_STRING_PREAMBLE (str);
249 dbus_free (real->str);
251 real->invalid = TRUE;
255 * Locks a string such that any attempts to change the string
256 * will result in aborting the program. Also, if the string
257 * is wasting a lot of memory (allocation is larger than what
258 * the string is really using), _dbus_string_lock() will realloc
259 * the string's data to "compact" it.
261 * @param str the string to lock.
264 _dbus_string_lock (DBusString *str)
266 DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
270 /* Try to realloc to avoid excess memory usage, since
271 * we know we won't change the string further
274 if (real->allocated > (real->len + MAX_WASTE))
279 new_allocated = real->len + 1;
281 new_str = dbus_realloc (real->str, new_allocated);
285 real->allocated = new_allocated;
286 ASSERT_8_BYTE_ALIGNED (str);
292 * Gets the raw character buffer from the string. The returned buffer
293 * will be nul-terminated, but note that strings may contain binary
294 * data so there may be extra nul characters prior to the termination.
295 * This function should be little-used, extend DBusString or add
296 * stuff to dbus-sysdeps.c instead. It's an error to use this
297 * function on a const string.
299 * @param str the string
300 * @param data_return place to store the returned data
303 _dbus_string_get_data (DBusString *str,
306 DBUS_STRING_PREAMBLE (str);
307 _dbus_assert (data_return != NULL);
309 *data_return = real->str;
313 * Gets the raw character buffer from a const string.
315 * @param str the string
316 * @param data_return location to store returned data
319 _dbus_string_get_const_data (const DBusString *str,
320 const char **data_return)
322 DBUS_CONST_STRING_PREAMBLE (str);
323 _dbus_assert (data_return != NULL);
325 *data_return = real->str;
329 * Gets a sub-portion of the raw character buffer from the
330 * string. The "len" field is required simply for error
331 * checking, to be sure you don't try to use more
332 * string than exists. The nul termination of the
333 * returned buffer remains at the end of the entire
334 * string, not at start + len.
336 * @param str the string
337 * @param data_return location to return the buffer
338 * @param start byte offset to return
339 * @param len length of segment to return
342 _dbus_string_get_data_len (DBusString *str,
347 DBUS_STRING_PREAMBLE (str);
348 _dbus_assert (data_return != NULL);
349 _dbus_assert (start >= 0);
350 _dbus_assert (len >= 0);
351 _dbus_assert ((start + len) <= real->len);
353 *data_return = real->str + start;
357 * const version of _dbus_string_get_data_len().
359 * @param str the string
360 * @param data_return location to return the buffer
361 * @param start byte offset to return
362 * @param len length of segment to return
365 _dbus_string_get_const_data_len (const DBusString *str,
366 const char **data_return,
370 DBUS_CONST_STRING_PREAMBLE (str);
371 _dbus_assert (data_return != NULL);
372 _dbus_assert (start >= 0);
373 _dbus_assert (len >= 0);
374 _dbus_assert ((start + len) <= real->len);
376 *data_return = real->str + start;
380 * Gets the byte at the given position.
382 * @param str the string
383 * @param start the position
384 * @returns the byte at that position
387 _dbus_string_get_byte (const DBusString *str,
390 DBUS_CONST_STRING_PREAMBLE (str);
391 _dbus_assert (start < real->len);
393 return real->str[start];
397 * Like _dbus_string_get_data(), but removes the
398 * gotten data from the original string. The caller
399 * must free the data returned. This function may
400 * fail due to lack of memory, and return #FALSE.
402 * @param str the string
403 * @param data_return location to return the buffer
404 * @returns #TRUE on success
407 _dbus_string_steal_data (DBusString *str,
410 DBUS_STRING_PREAMBLE (str);
411 _dbus_assert (data_return != NULL);
413 *data_return = real->str;
415 /* reset the string */
416 if (!_dbus_string_init (str, real->max_length))
418 /* hrm, put it back then */
419 real->str = *data_return;
428 * Like _dbus_string_get_data_len(), but removes the gotten data from
429 * the original string. The caller must free the data returned. This
430 * function may fail due to lack of memory, and return #FALSE.
431 * The returned string is nul-terminated and has length len.
433 * @param str the string
434 * @param data_return location to return the buffer
435 * @param start the start of segment to steal
436 * @param len the length of segment to steal
437 * @returns #TRUE on success
440 _dbus_string_steal_data_len (DBusString *str,
447 DBUS_STRING_PREAMBLE (str);
448 _dbus_assert (data_return != NULL);
449 _dbus_assert (start >= 0);
450 _dbus_assert (len >= 0);
451 _dbus_assert ((start + len) <= real->len);
453 if (!_dbus_string_init (&dest, real->max_length))
456 if (!_dbus_string_move_len (str, start, len, &dest, 0))
458 _dbus_string_free (&dest);
462 if (!_dbus_string_steal_data (&dest, data_return))
464 _dbus_string_free (&dest);
468 _dbus_string_free (&dest);
473 * Gets the length of a string (not including nul termination).
475 * @returns the length.
478 _dbus_string_get_length (const DBusString *str)
480 DBUS_CONST_STRING_PREAMBLE (str);
486 set_length (DBusRealString *real,
489 /* Note, we are setting the length without nul termination */
491 /* exceeding max length is the same as failure to allocate memory */
492 if (new_length > real->max_length)
495 while (new_length >= real->allocated)
500 new_allocated = 2 + real->allocated * 2;
501 if (new_allocated < real->allocated)
502 return FALSE; /* overflow */
504 new_str = dbus_realloc (real->str, new_allocated);
509 real->allocated = new_allocated;
511 ASSERT_8_BYTE_ALIGNED (real);
514 real->len = new_length;
515 real->str[real->len] = '\0';
521 * Makes a string longer by the given number of bytes. Checks whether
522 * adding additional_length to the current length would overflow an
523 * integer, and checks for exceeding a string's max length.
524 * The new bytes are not initialized, other than nul-terminating
525 * the end of the string. The uninitialized bytes may contain
526 * unexpected nul bytes or other junk.
528 * @param str a string
529 * @param additional_length length to add to the string.
530 * @returns #TRUE on success.
533 _dbus_string_lengthen (DBusString *str,
534 int additional_length)
536 DBUS_STRING_PREAMBLE (str);
537 _dbus_assert (additional_length >= 0);
539 if ((real->len + additional_length) < real->len)
540 return FALSE; /* overflow */
542 return set_length (real,
543 real->len + additional_length);
547 * Makes a string shorter by the given number of bytes.
549 * @param str a string
550 * @param length_to_remove length to remove from the string.
553 _dbus_string_shorten (DBusString *str,
554 int length_to_remove)
556 DBUS_STRING_PREAMBLE (str);
557 _dbus_assert (length_to_remove >= 0);
558 _dbus_assert (length_to_remove <= real->len);
561 real->len - length_to_remove);
565 * Sets the length of a string. Can be used to truncate or lengthen
566 * the string. If the string is lengthened, the function may fail and
567 * return #FALSE. Newly-added bytes are not initialized, as with
568 * _dbus_string_lengthen().
570 * @param str a string
571 * @param length new length of the string.
572 * @returns #FALSE on failure.
575 _dbus_string_set_length (DBusString *str,
578 DBUS_STRING_PREAMBLE (str);
579 _dbus_assert (length >= 0);
581 return set_length (real, length);
585 * Align the length of a string to a specific alignment (typically 4 or 8)
586 * by appending nul bytes to the string.
588 * @param str a string
589 * @param alignment the alignment
590 * @returns #FALSE if no memory
593 _dbus_string_align_length (DBusString *str,
598 DBUS_STRING_PREAMBLE (str);
599 _dbus_assert (alignment >= 1);
600 _dbus_assert (alignment <= 16); /* arbitrary */
602 new_len = _DBUS_ALIGN_VALUE (real->len, alignment);
604 delta = new_len - real->len;
605 _dbus_assert (delta >= 0);
610 if (!set_length (real, new_len))
613 memset (real->str + (new_len - delta),
620 append (DBusRealString *real,
627 if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
630 memcpy (real->str + (real->len - buffer_len),
638 * Appends a nul-terminated C-style string to a DBusString.
640 * @param str the DBusString
641 * @param buffer the nul-terminated characters to append
642 * @returns #FALSE if not enough memory.
645 _dbus_string_append (DBusString *str,
650 DBUS_STRING_PREAMBLE (str);
651 _dbus_assert (buffer != NULL);
653 buffer_len = strlen (buffer);
655 return append (real, buffer, buffer_len);
659 * Appends block of bytes with the given length to a DBusString.
661 * @param str the DBusString
662 * @param buffer the bytes to append
663 * @param len the number of bytes to append
664 * @returns #FALSE if not enough memory.
667 _dbus_string_append_len (DBusString *str,
671 DBUS_STRING_PREAMBLE (str);
672 _dbus_assert (buffer != NULL);
673 _dbus_assert (len >= 0);
675 return append (real, buffer, len);
679 * Appends a single byte to the string, returning #FALSE
680 * if not enough memory.
682 * @param str the string
683 * @param byte the byte to append
684 * @returns #TRUE on success
687 _dbus_string_append_byte (DBusString *str,
690 DBUS_STRING_PREAMBLE (str);
692 if (!set_length (real, real->len + 1))
695 real->str[real->len-1] = byte;
701 * Appends a single Unicode character, encoding the character
704 * @param str the string
705 * @param ch the Unicode character
708 _dbus_string_append_unichar (DBusString *str,
716 DBUS_STRING_PREAMBLE (str);
718 /* this code is from GLib but is pretty standard I think */
732 else if (ch < 0x10000)
737 else if (ch < 0x200000)
742 else if (ch < 0x4000000)
753 if (!set_length (real, real->len + len))
756 out = real->str + (real->len - len);
758 for (i = len - 1; i > 0; --i)
760 out[i] = (ch & 0x3f) | 0x80;
769 delete (DBusRealString *real,
776 memmove (real->str + start, real->str + start + len, real->len - (start + len));
778 real->str[real->len] = '\0';
782 * Deletes a segment of a DBusString with length len starting at
783 * start. (Hint: to clear an entire string, setting length to 0
784 * with _dbus_string_set_length() is easier.)
786 * @param str the DBusString
787 * @param start where to start deleting
788 * @param len the number of bytes to delete
791 _dbus_string_delete (DBusString *str,
795 DBUS_STRING_PREAMBLE (str);
796 _dbus_assert (start >= 0);
797 _dbus_assert (len >= 0);
798 _dbus_assert ((start + len) <= real->len);
800 delete (real, start, len);
805 DBusRealString *dest,
811 if (!set_length (dest, dest->len + len))
814 memmove (dest->str + insert_at + len,
815 dest->str + insert_at,
816 dest->len - len - insert_at);
822 copy (DBusRealString *source,
825 DBusRealString *dest,
831 if (!open_gap (len, dest, insert_at))
834 memcpy (dest->str + insert_at,
842 * Checks assertions for two strings we're copying a segment between,
843 * and declares real_source/real_dest variables.
845 * @param source the source string
846 * @param start the starting offset
847 * @param dest the dest string
848 * @param insert_at where the copied segment is inserted
850 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at) \
851 DBusRealString *real_source = (DBusRealString*) source; \
852 DBusRealString *real_dest = (DBusRealString*) dest; \
853 _dbus_assert ((source) != (dest)); \
854 DBUS_GENERIC_STRING_PREAMBLE (real_source); \
855 DBUS_GENERIC_STRING_PREAMBLE (real_dest); \
856 _dbus_assert (!real_source->constant); \
857 _dbus_assert (!real_source->locked); \
858 _dbus_assert (!real_dest->constant); \
859 _dbus_assert (!real_dest->locked); \
860 _dbus_assert ((start) >= 0); \
861 _dbus_assert ((start) <= real_source->len); \
862 _dbus_assert ((insert_at) >= 0); \
863 _dbus_assert ((insert_at) <= real_dest->len)
866 * Moves the end of one string into another string. Both strings
867 * must be initialized, valid strings.
869 * @param source the source string
870 * @param start where to chop off the source string
871 * @param dest the destination string
872 * @param insert_at where to move the chopped-off part of source string
873 * @returns #FALSE if not enough memory
876 _dbus_string_move (DBusString *source,
881 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
883 if (!copy (real_source, start,
884 real_source->len - start,
889 delete (real_source, start,
890 real_source->len - start);
896 * Like _dbus_string_move(), but does not delete the section
897 * of the source string that's copied to the dest string.
899 * @param source the source string
900 * @param start where to start copying the source string
901 * @param dest the destination string
902 * @param insert_at where to place the copied part of source string
903 * @returns #FALSE if not enough memory
906 _dbus_string_copy (const DBusString *source,
911 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
913 return copy (real_source, start,
914 real_source->len - start,
920 * Like _dbus_string_move(), but can move a segment from
921 * the middle of the source string.
923 * @param source the source string
924 * @param start first byte of source string to move
925 * @param len length of segment to move
926 * @param dest the destination string
927 * @param insert_at where to move the bytes from the source string
928 * @returns #FALSE if not enough memory
931 _dbus_string_move_len (DBusString *source,
938 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
939 _dbus_assert (len >= 0);
940 _dbus_assert ((start + len) <= real_source->len);
942 if (!copy (real_source, start, len,
947 delete (real_source, start,
954 * Like _dbus_string_copy(), but can copy a segment from the middle of
957 * @param source the source string
958 * @param start where to start copying the source string
959 * @param len length of segment to copy
960 * @param dest the destination string
961 * @param insert_at where to place the copied segment of source string
962 * @returns #FALSE if not enough memory
965 _dbus_string_copy_len (const DBusString *source,
971 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
972 _dbus_assert (len >= 0);
973 _dbus_assert ((start + len) <= real_source->len);
975 return copy (real_source, start, len,
981 * Replaces a segment of dest string with a segment of source string.
983 * @todo optimize the case where the two lengths are the same, and
984 * avoid memmoving the data in the trailing part of the string twice.
986 * @param source the source string
987 * @param start where to start copying the source string
988 * @param len length of segment to copy
989 * @param dest the destination string
990 * @param replace_at start of segment of dest string to replace
991 * @param replace_len length of segment of dest string to replace
992 * @returns #FALSE if not enough memory
996 _dbus_string_replace_len (const DBusString *source,
1003 DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1004 _dbus_assert (len >= 0);
1005 _dbus_assert ((start + len) <= real_source->len);
1006 _dbus_assert (replace_at >= 0);
1007 _dbus_assert ((replace_at + replace_len) <= real_dest->len);
1009 if (!copy (real_source, start, len,
1010 real_dest, replace_at))
1013 delete (real_dest, replace_at + len, replace_len);
1018 /* Unicode macros from GLib */
1020 /** computes length and mask of a unicode character
1021 * @param Char the char
1022 * @param Mask the mask variable to assign to
1023 * @param Len the length variable to assign to
1025 #define UTF8_COMPUTE(Char, Mask, Len) \
1031 else if ((Char & 0xe0) == 0xc0) \
1036 else if ((Char & 0xf0) == 0xe0) \
1041 else if ((Char & 0xf8) == 0xf0) \
1046 else if ((Char & 0xfc) == 0xf8) \
1051 else if ((Char & 0xfe) == 0xfc) \
1060 * computes length of a unicode character in UTF-8
1061 * @param Char the char
1063 #define UTF8_LENGTH(Char) \
1064 ((Char) < 0x80 ? 1 : \
1065 ((Char) < 0x800 ? 2 : \
1066 ((Char) < 0x10000 ? 3 : \
1067 ((Char) < 0x200000 ? 4 : \
1068 ((Char) < 0x4000000 ? 5 : 6)))))
1071 * Gets a UTF-8 value.
1073 * @param Result variable for extracted unicode char.
1074 * @param Chars the bytes to decode
1075 * @param Count counter variable
1076 * @param Mask mask for this char
1077 * @param Len length for this char in bytes
1079 #define UTF8_GET(Result, Chars, Count, Mask, Len) \
1080 (Result) = (Chars)[0] & (Mask); \
1081 for ((Count) = 1; (Count) < (Len); ++(Count)) \
1083 if (((Chars)[(Count)] & 0xc0) != 0x80) \
1089 (Result) |= ((Chars)[(Count)] & 0x3f); \
1093 * Check whether a unicode char is in a valid range.
1095 * @param Char the character
1097 #define UNICODE_VALID(Char) \
1098 ((Char) < 0x110000 && \
1099 ((Char) < 0xD800 || (Char) >= 0xE000) && \
1100 (Char) != 0xFFFE && (Char) != 0xFFFF)
1103 * Gets a unicode character from a UTF-8 string. Does no validation;
1104 * you must verify that the string is valid UTF-8 in advance and must
1105 * pass in the start of a character.
1107 * @param str the string
1108 * @param start the start of the UTF-8 character.
1109 * @param ch_return location to return the character
1110 * @param end_return location to return the byte index of next character
1111 * @returns #TRUE on success, #FALSE otherwise.
1114 _dbus_string_get_unichar (const DBusString *str,
1116 dbus_unichar_t *ch_return,
1120 dbus_unichar_t result;
1123 DBUS_CONST_STRING_PREAMBLE (str);
1128 *end_return = real->len;
1131 p = real->str + start;
1134 UTF8_COMPUTE (c, mask, len);
1137 UTF8_GET (result, p, i, mask, len);
1139 if (result == (dbus_unichar_t)-1)
1143 *ch_return = result;
1145 *end_return = start + len;
1149 * Finds the given substring in the string,
1150 * returning #TRUE and filling in the byte index
1151 * where the substring was found, if it was found.
1152 * Returns #FALSE if the substring wasn't found.
1153 * Sets *start to the length of the string if the substring
1156 * @param str the string
1157 * @param start where to start looking
1158 * @param substr the substring
1159 * @param found return location for where it was found, or #NULL
1160 * @returns #TRUE if found
1163 _dbus_string_find (const DBusString *str,
1169 DBUS_CONST_STRING_PREAMBLE (str);
1170 _dbus_assert (substr != NULL);
1171 _dbus_assert (start <= real->len);
1173 /* we always "find" an empty string */
1174 if (*substr == '\0')
1182 while (i < real->len)
1184 if (real->str[i] == substr[0])
1188 while (j < real->len)
1190 if (substr[j - i] == '\0')
1192 else if (real->str[j] != substr[j - i])
1198 if (substr[j - i] == '\0')
1216 * Finds a blank (space or tab) in the string. Returns #TRUE
1217 * if found, #FALSE otherwise. If a blank is not found sets
1218 * *found to the length of the string.
1220 * @param str the string
1221 * @param start byte index to start looking
1222 * @param found place to store the location of the first blank
1223 * @returns #TRUE if a blank was found
1226 _dbus_string_find_blank (const DBusString *str,
1231 DBUS_CONST_STRING_PREAMBLE (str);
1232 _dbus_assert (start <= real->len);
1235 while (i < real->len)
1237 if (real->str[i] == ' ' ||
1238 real->str[i] == '\t')
1255 * Skips blanks from start, storing the first non-blank in *end
1257 * @param str the string
1258 * @param start where to start
1259 * @param end where to store the first non-blank byte index
1262 _dbus_string_skip_blank (const DBusString *str,
1267 DBUS_CONST_STRING_PREAMBLE (str);
1268 _dbus_assert (start <= real->len);
1271 while (i < real->len)
1273 if (!(real->str[i] == ' ' ||
1274 real->str[i] == '\t'))
1280 _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1281 real->str[i] == '\t'));
1288 * Tests two DBusString for equality.
1290 * @param a first string
1291 * @param b second string
1292 * @returns #TRUE if equal
1295 _dbus_string_equal (const DBusString *a,
1296 const DBusString *b)
1298 const unsigned char *ap;
1299 const unsigned char *bp;
1300 const unsigned char *a_end;
1301 const DBusRealString *real_a = (const DBusRealString*) a;
1302 const DBusRealString *real_b = (const DBusRealString*) b;
1303 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1304 DBUS_GENERIC_STRING_PREAMBLE (real_b);
1306 if (real_a->len != real_b->len)
1311 a_end = real_a->str + real_a->len;
1325 * Checks whether a string is equal to a C string.
1327 * @param a the string
1328 * @param c_str the C string
1329 * @returns #TRUE if equal
1332 _dbus_string_equal_c_str (const DBusString *a,
1335 const unsigned char *ap;
1336 const unsigned char *bp;
1337 const unsigned char *a_end;
1338 const DBusRealString *real_a = (const DBusRealString*) a;
1339 DBUS_GENERIC_STRING_PREAMBLE (real_a);
1342 bp = (const unsigned char*) c_str;
1343 a_end = real_a->str + real_a->len;
1344 while (ap != a_end && *bp)
1353 if (*ap && *bp == '\0')
1355 else if (ap == a_end && *bp)
1361 static const signed char base64_table[] = {
1428 /** The minimum char that's a valid char in Base64-encoded text */
1429 #define UNBASE64_MIN_CHAR (43)
1430 /** The maximum char that's a valid char in Base64-encoded text */
1431 #define UNBASE64_MAX_CHAR (122)
1432 /** Must subtract this from a char's integer value before offsetting
1433 * into unbase64_table
1435 #define UNBASE64_TABLE_OFFSET UNBASE64_MIN_CHAR
1436 static const signed char unbase64_table[] = {
1520 * Encodes a string using Base64, as documented in RFC 2045.
1522 * @param source the string to encode
1523 * @param start byte index to start encoding
1524 * @param dest string where encoded data should be placed
1525 * @param insert_at where to place encoded data
1526 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
1529 _dbus_string_base64_encode (const DBusString *source,
1536 const unsigned char *s;
1538 const unsigned char *triplet_end;
1539 const unsigned char *final_end;
1540 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1541 _dbus_assert (source != dest);
1543 /* For each 24 bits (3 bytes) of input, we have 4 chars of
1546 source_len = real_source->len - start;
1547 dest_len = (source_len / 3) * 4;
1548 if (source_len % 3 != 0)
1551 if (source_len == 0)
1554 if (!open_gap (dest_len, real_dest, insert_at))
1557 d = real_dest->str + insert_at;
1558 s = real_source->str + start;
1559 final_end = real_source->str + (start + source_len);
1560 triplet_end = final_end - (source_len % 3);
1561 _dbus_assert (triplet_end <= final_end);
1562 _dbus_assert ((final_end - triplet_end) < 3);
1564 #define ENCODE_64(v) (base64_table[ (unsigned char) (v) ])
1565 #define SIX_BITS_MASK (0x3f)
1566 _dbus_assert (SIX_BITS_MASK < _DBUS_N_ELEMENTS (base64_table));
1568 while (s != triplet_end)
1570 unsigned int triplet;
1572 triplet = s[0] | (s[1] << 8) | (s[2] << 16);
1574 /* Encode each 6 bits */
1576 *d++ = ENCODE_64 (triplet >> 18);
1577 *d++ = ENCODE_64 ((triplet >> 12) & SIX_BITS_MASK);
1578 *d++ = ENCODE_64 ((triplet >> 6) & SIX_BITS_MASK);
1579 *d++ = ENCODE_64 (triplet & SIX_BITS_MASK);
1584 switch (final_end - triplet_end)
1588 unsigned int doublet;
1590 doublet = s[0] | (s[1] << 8);
1592 *d++ = ENCODE_64 (doublet >> 12);
1593 *d++ = ENCODE_64 ((doublet >> 6) & SIX_BITS_MASK);
1594 *d++ = ENCODE_64 (doublet & SIX_BITS_MASK);
1600 unsigned int singlet;
1604 *d++ = ENCODE_64 ((singlet >> 6) & SIX_BITS_MASK);
1605 *d++ = ENCODE_64 (singlet & SIX_BITS_MASK);
1614 _dbus_assert (d == (real_dest->str + (insert_at + dest_len)));
1621 * Decodes a string from Base64, as documented in RFC 2045.
1623 * @param source the string to decode
1624 * @param start byte index to start decode
1625 * @param dest string where decoded data should be placed
1626 * @param insert_at where to place decoded data
1627 * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
1630 _dbus_string_base64_decode (const DBusString *source,
1639 unsigned int triplet = 0;
1642 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1643 _dbus_assert (source != dest);
1645 source_len = real_source->len - start;
1646 s = real_source->str + start;
1647 end = real_source->str + source_len;
1649 if (source_len == 0)
1652 if (!_dbus_string_init (&result, _DBUS_INT_MAX))
1659 /* The idea is to just skip anything that isn't
1660 * a base64 char - it's allowed to have whitespace,
1661 * newlines, etc. in here. We also ignore trailing
1662 * base64 chars, though that's suspicious.
1665 if (*s >= UNBASE64_MIN_CHAR &&
1666 *s <= UNBASE64_MAX_CHAR)
1670 /* '=' is padding, doesn't represent additional data
1671 * but does increment our count.
1680 val = unbase64_table[(*s) - UNBASE64_TABLE_OFFSET];
1685 triplet |= (unsigned int) val;
1690 if (sextet_count == 4)
1692 /* no pad = 3 bytes, 1 pad = 2 bytes, 2 pad = 1 byte */
1694 _dbus_string_append_byte (&result,
1698 _dbus_string_append_byte (&result,
1699 (triplet >> 8) & 0xff);
1702 _dbus_string_append_byte (&result,
1714 if (!_dbus_string_move (&result, 0, dest, insert_at))
1716 _dbus_string_free (&result);
1720 _dbus_string_free (&result);
1726 * Checks that the given range of the string
1727 * is valid ASCII. If the given range is not contained
1728 * in the string, returns #FALSE.
1730 * @param str the string
1731 * @param start first byte index to check
1732 * @param len number of bytes to check
1733 * @returns #TRUE if the byte range exists and is all valid ASCII
1736 _dbus_string_validate_ascii (const DBusString *str,
1740 const unsigned char *s;
1741 const unsigned char *end;
1742 DBUS_CONST_STRING_PREAMBLE (str);
1743 _dbus_assert (start >= 0);
1744 _dbus_assert (len >= 0);
1746 if ((start + len) > real->len)
1749 s = real->str + start;
1754 ((*s & ~0x7f) != 0))
1765 #ifdef DBUS_BUILD_TESTS
1766 #include "dbus-test.h"
1770 test_max_len (DBusString *str,
1775 if (!_dbus_string_set_length (str, max_len - 1))
1776 _dbus_assert_not_reached ("setting len to one less than max should have worked");
1779 if (!_dbus_string_set_length (str, max_len))
1780 _dbus_assert_not_reached ("setting len to max len should have worked");
1782 if (_dbus_string_set_length (str, max_len + 1))
1783 _dbus_assert_not_reached ("setting len to one more than max len should not have worked");
1785 if (!_dbus_string_set_length (str, 0))
1786 _dbus_assert_not_reached ("setting len to zero should have worked");
1790 test_base64_roundtrip (const unsigned char *data,
1798 len = strlen (data);
1800 if (!_dbus_string_init (&orig, _DBUS_INT_MAX))
1801 _dbus_assert_not_reached ("could not init string");
1803 if (!_dbus_string_init (&encoded, _DBUS_INT_MAX))
1804 _dbus_assert_not_reached ("could not init string");
1806 if (!_dbus_string_init (&decoded, _DBUS_INT_MAX))
1807 _dbus_assert_not_reached ("could not init string");
1809 if (!_dbus_string_append_len (&orig, data, len))
1810 _dbus_assert_not_reached ("couldn't append orig data");
1812 if (!_dbus_string_base64_encode (&orig, 0, &encoded, 0))
1813 _dbus_assert_not_reached ("could not encode");
1815 if (!_dbus_string_base64_decode (&encoded, 0, &decoded, 0))
1816 _dbus_assert_not_reached ("could not decode");
1818 if (!_dbus_string_equal (&orig, &decoded))
1822 printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
1823 _dbus_string_get_length (&orig),
1824 _dbus_string_get_length (&encoded),
1825 _dbus_string_get_length (&decoded));
1826 printf ("Original: %s\n", data);
1827 _dbus_string_get_const_data (&decoded, &s);
1828 printf ("Decoded: %s\n", s);
1829 _dbus_assert_not_reached ("original string not the same as string decoded from base64");
1832 _dbus_string_free (&orig);
1833 _dbus_string_free (&encoded);
1834 _dbus_string_free (&decoded);
1838 * @ingroup DBusStringInternals
1839 * Unit test for DBusString.
1841 * @todo Need to write tests for _dbus_string_copy() and
1842 * _dbus_string_move() moving to/from each of start/middle/end of a
1843 * string. Also need tests for _dbus_string_move_len ()
1845 * @returns #TRUE on success.
1848 _dbus_string_test (void)
1855 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 };
1860 while (i < _DBUS_N_ELEMENTS (lens))
1862 if (!_dbus_string_init (&str, lens[i]))
1863 _dbus_assert_not_reached ("failed to init string");
1865 test_max_len (&str, lens[i]);
1866 _dbus_string_free (&str);
1871 /* Test shortening and setting length */
1873 while (i < _DBUS_N_ELEMENTS (lens))
1877 if (!_dbus_string_init (&str, lens[i]))
1878 _dbus_assert_not_reached ("failed to init string");
1880 if (!_dbus_string_set_length (&str, lens[i]))
1881 _dbus_assert_not_reached ("failed to set string length");
1886 _dbus_assert (_dbus_string_get_length (&str) == j);
1889 _dbus_string_shorten (&str, 1);
1890 _dbus_assert (_dbus_string_get_length (&str) == (j - 1));
1895 _dbus_string_free (&str);
1900 /* Test appending data */
1901 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
1902 _dbus_assert_not_reached ("failed to init string");
1907 if (!_dbus_string_append (&str, "a"))
1908 _dbus_assert_not_reached ("failed to append string to string\n");
1910 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 1);
1912 if (!_dbus_string_append_byte (&str, 'b'))
1913 _dbus_assert_not_reached ("failed to append byte to string\n");
1915 _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 2);
1920 _dbus_string_free (&str);
1922 /* Check steal_data */
1924 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
1925 _dbus_assert_not_reached ("failed to init string");
1927 if (!_dbus_string_append (&str, "Hello World"))
1928 _dbus_assert_not_reached ("could not append to string");
1930 i = _dbus_string_get_length (&str);
1932 if (!_dbus_string_steal_data (&str, &s))
1933 _dbus_assert_not_reached ("failed to steal data");
1935 _dbus_assert (_dbus_string_get_length (&str) == 0);
1936 _dbus_assert (((int)strlen (s)) == i);
1942 if (!_dbus_string_append (&str, "Hello World"))
1943 _dbus_assert_not_reached ("could not append to string");
1945 i = _dbus_string_get_length (&str);
1947 if (!_dbus_string_init (&other, _DBUS_INT_MAX))
1948 _dbus_assert_not_reached ("could not init string");
1950 if (!_dbus_string_move (&str, 0, &other, 0))
1951 _dbus_assert_not_reached ("could not move");
1953 _dbus_assert (_dbus_string_get_length (&str) == 0);
1954 _dbus_assert (_dbus_string_get_length (&other) == i);
1956 if (!_dbus_string_append (&str, "Hello World"))
1957 _dbus_assert_not_reached ("could not append to string");
1959 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other)))
1960 _dbus_assert_not_reached ("could not move");
1962 _dbus_assert (_dbus_string_get_length (&str) == 0);
1963 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
1965 if (!_dbus_string_append (&str, "Hello World"))
1966 _dbus_assert_not_reached ("could not append to string");
1968 if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other) / 2))
1969 _dbus_assert_not_reached ("could not move");
1971 _dbus_assert (_dbus_string_get_length (&str) == 0);
1972 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
1974 _dbus_string_free (&other);
1978 if (!_dbus_string_append (&str, "Hello World"))
1979 _dbus_assert_not_reached ("could not append to string");
1981 i = _dbus_string_get_length (&str);
1983 if (!_dbus_string_init (&other, _DBUS_INT_MAX))
1984 _dbus_assert_not_reached ("could not init string");
1986 if (!_dbus_string_copy (&str, 0, &other, 0))
1987 _dbus_assert_not_reached ("could not copy");
1989 _dbus_assert (_dbus_string_get_length (&str) == i);
1990 _dbus_assert (_dbus_string_get_length (&other) == i);
1992 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other)))
1993 _dbus_assert_not_reached ("could not copy");
1995 _dbus_assert (_dbus_string_get_length (&str) == i);
1996 _dbus_assert (_dbus_string_get_length (&other) == i * 2);
1997 _dbus_assert (_dbus_string_equal_c_str (&other,
1998 "Hello WorldHello World"));
2000 if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2001 _dbus_assert_not_reached ("could not copy");
2003 _dbus_assert (_dbus_string_get_length (&str) == i);
2004 _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2005 _dbus_assert (_dbus_string_equal_c_str (&other,
2006 "Hello WorldHello WorldHello World"));
2008 _dbus_string_free (&str);
2009 _dbus_string_free (&other);
2013 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2014 _dbus_assert_not_reached ("failed to init string");
2016 if (!_dbus_string_append (&str, "Hello World"))
2017 _dbus_assert_not_reached ("could not append to string");
2019 i = _dbus_string_get_length (&str);
2021 if (!_dbus_string_init (&other, _DBUS_INT_MAX))
2022 _dbus_assert_not_reached ("could not init string");
2024 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
2025 &other, 0, _dbus_string_get_length (&other)))
2026 _dbus_assert_not_reached ("could not replace");
2028 _dbus_assert (_dbus_string_get_length (&str) == i);
2029 _dbus_assert (_dbus_string_get_length (&other) == i);
2030 _dbus_assert (_dbus_string_equal_c_str (&other, "Hello World"));
2032 if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
2034 _dbus_assert_not_reached ("could not replace center space");
2036 _dbus_assert (_dbus_string_get_length (&str) == i);
2037 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
2038 _dbus_assert (_dbus_string_equal_c_str (&other,
2039 "HelloHello WorldWorld"));
2042 if (!_dbus_string_replace_len (&str, 1, 1,
2044 _dbus_string_get_length (&other) - 1,
2046 _dbus_assert_not_reached ("could not replace end character");
2048 _dbus_assert (_dbus_string_get_length (&str) == i);
2049 _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
2050 _dbus_assert (_dbus_string_equal_c_str (&other,
2051 "HelloHello WorldWorle"));
2053 _dbus_string_free (&str);
2054 _dbus_string_free (&other);
2056 /* Check append/get unichar */
2058 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2059 _dbus_assert_not_reached ("failed to init string");
2062 if (!_dbus_string_append_unichar (&str, 0xfffc))
2063 _dbus_assert_not_reached ("failed to append unichar");
2065 _dbus_string_get_unichar (&str, 0, &ch, &i);
2067 _dbus_assert (ch == 0xfffc);
2068 _dbus_assert (i == _dbus_string_get_length (&str));
2070 _dbus_string_free (&str);
2072 /* Check append/parse int/double */
2074 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2075 _dbus_assert_not_reached ("failed to init string");
2077 if (!_dbus_string_append_int (&str, 27))
2078 _dbus_assert_not_reached ("failed to append int");
2080 i = _dbus_string_get_length (&str);
2082 if (!_dbus_string_parse_int (&str, 0, &v, &end))
2083 _dbus_assert_not_reached ("failed to parse int");
2085 _dbus_assert (v == 27);
2086 _dbus_assert (end == i);
2088 _dbus_string_free (&str);
2090 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2091 _dbus_assert_not_reached ("failed to init string");
2093 if (!_dbus_string_append_double (&str, 50.3))
2094 _dbus_assert_not_reached ("failed to append float");
2096 i = _dbus_string_get_length (&str);
2098 if (!_dbus_string_parse_double (&str, 0, &d, &end))
2099 _dbus_assert_not_reached ("failed to parse float");
2101 _dbus_assert (d > (50.3 - 1e-6) && d < (50.3 + 1e-6));
2102 _dbus_assert (end == i);
2104 _dbus_string_free (&str);
2107 if (!_dbus_string_init (&str, _DBUS_INT_MAX))
2108 _dbus_assert_not_reached ("failed to init string");
2110 if (!_dbus_string_append (&str, "Hello"))
2111 _dbus_assert_not_reached ("couldn't append to string");
2113 if (!_dbus_string_find (&str, 0, "He", &i))
2114 _dbus_assert_not_reached ("didn't find 'He'");
2115 _dbus_assert (i == 0);
2117 if (!_dbus_string_find (&str, 0, "ello", &i))
2118 _dbus_assert_not_reached ("didn't find 'ello'");
2119 _dbus_assert (i == 1);
2121 if (!_dbus_string_find (&str, 0, "lo", &i))
2122 _dbus_assert_not_reached ("didn't find 'lo'");
2123 _dbus_assert (i == 3);
2125 if (!_dbus_string_find (&str, 2, "lo", &i))
2126 _dbus_assert_not_reached ("didn't find 'lo'");
2127 _dbus_assert (i == 3);
2129 if (_dbus_string_find (&str, 4, "lo", &i))
2130 _dbus_assert_not_reached ("did find 'lo'");
2132 if (!_dbus_string_find (&str, 0, "l", &i))
2133 _dbus_assert_not_reached ("didn't find 'l'");
2134 _dbus_assert (i == 2);
2136 if (!_dbus_string_find (&str, 0, "H", &i))
2137 _dbus_assert_not_reached ("didn't find 'H'");
2138 _dbus_assert (i == 0);
2140 if (!_dbus_string_find (&str, 0, "", &i))
2141 _dbus_assert_not_reached ("didn't find ''");
2142 _dbus_assert (i == 0);
2144 if (_dbus_string_find (&str, 0, "Hello!", NULL))
2145 _dbus_assert_not_reached ("Did find 'Hello!'");
2147 if (_dbus_string_find (&str, 0, "Oh, Hello", NULL))
2148 _dbus_assert_not_reached ("Did find 'Oh, Hello'");
2150 if (_dbus_string_find (&str, 0, "ill", NULL))
2151 _dbus_assert_not_reached ("Did find 'ill'");
2153 if (_dbus_string_find (&str, 0, "q", NULL))
2154 _dbus_assert_not_reached ("Did find 'q'");
2156 _dbus_string_free (&str);
2159 test_base64_roundtrip ("Hello this is a string\n", -1);
2160 test_base64_roundtrip ("Hello this is a string\n1", -1);
2161 test_base64_roundtrip ("Hello this is a string\n12", -1);
2162 test_base64_roundtrip ("Hello this is a string\n123", -1);
2163 test_base64_roundtrip ("Hello this is a string\n1234", -1);
2164 test_base64_roundtrip ("Hello this is a string\n12345", -1);
2165 test_base64_roundtrip ("", 0);
2166 test_base64_roundtrip ("1", 1);
2167 test_base64_roundtrip ("12", 2);
2168 test_base64_roundtrip ("123", 3);
2169 test_base64_roundtrip ("1234", 4);
2170 test_base64_roundtrip ("12345", 5);
2171 test_base64_roundtrip ("", 1);
2172 test_base64_roundtrip ("1", 2);
2173 test_base64_roundtrip ("12", 3);
2174 test_base64_roundtrip ("123", 4);
2175 test_base64_roundtrip ("1234", 5);
2176 test_base64_roundtrip ("12345", 6);
2178 unsigned char buf[512];
2180 while (i < _DBUS_N_ELEMENTS (buf))
2186 while (i < _DBUS_N_ELEMENTS (buf))
2188 test_base64_roundtrip (buf, i);
2196 #endif /* DBUS_BUILD_TESTS */