1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-string.c String utility class (internal to D-Bus implementation)
4 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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 #define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
31 #include "dbus-string-private.h"
32 #include "dbus-marshal-basic.h" /* probably should be removed by moving the usage of DBUS_TYPE
33 * into the marshaling-related files
35 /* for DBUS_VA_COPY */
36 #include "dbus-sysdeps.h"
39 * @defgroup DBusString DBusString class
40 * @ingroup DBusInternals
41 * @brief DBusString data structure for safer string handling
43 * Types and functions related to DBusString. DBusString is intended
44 * to be a string class that makes it hard to mess up security issues
45 * (and just in general harder to write buggy code). It should be
46 * used (or extended and then used) rather than the libc stuff in
47 * string.h. The string class is a bit inconvenient at spots because
48 * it handles out-of-memory failures and tries to be extra-robust.
50 * A DBusString has a maximum length set at initialization time; this
51 * can be used to ensure that a buffer doesn't get too big. The
52 * _dbus_string_lengthen() method checks for overflow, and for max
53 * length being exceeded.
55 * Try to avoid conversion to a plain C string, i.e. add methods on
56 * the string object instead, only convert to C string when passing
57 * things out to the public API. In particular, no sprintf, strcpy,
58 * strcat, any of that should be used. The GString feature of
59 * accepting negative numbers for "length of string" is also absent,
60 * because it could keep us from detecting bogus huge lengths. i.e. if
61 * we passed in some bogus huge length it would be taken to mean
62 * "current length of string" instead of "broken crack"
64 * @todo #DBusString needs a lot of cleaning up; some of the
65 * API is no longer used, and the API is pretty inconsistent.
66 * In particular all the "append" APIs, especially those involving
67 * alignment but probably lots of them, are no longer used by the
68 * marshaling code which always does "inserts" now.
72 * @addtogroup DBusString
77 fixup_alignment (DBusRealString *real)
79 unsigned char *aligned;
80 unsigned char *real_block;
81 unsigned int old_align_offset;
83 /* we have to have extra space in real->allocated for the align offset and nul byte */
84 _dbus_assert (real->len <= real->allocated - _DBUS_STRING_ALLOCATION_PADDING);
86 old_align_offset = real->align_offset;
87 real_block = real->str - old_align_offset;
89 aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);
91 real->align_offset = aligned - real_block;
94 if (old_align_offset != real->align_offset)
96 /* Here comes the suck */
97 memmove (real_block + real->align_offset,
98 real_block + old_align_offset,
102 _dbus_assert (real->align_offset < 8);
103 _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
107 undo_alignment (DBusRealString *real)
109 if (real->align_offset != 0)
111 memmove (real->str - real->align_offset,
115 real->str = real->str - real->align_offset;
116 real->align_offset = 0;
121 * Initializes a string that can be up to the given allocation size
122 * before it has to realloc. The string starts life with zero length.
123 * The string must eventually be freed with _dbus_string_free().
125 * @param str memory to hold the string
126 * @param allocate_size amount to preallocate
127 * @returns #TRUE on success, #FALSE if no memory
130 _dbus_string_init_preallocated (DBusString *str,
133 DBusRealString *real;
135 _dbus_assert (str != NULL);
137 _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
139 real = (DBusRealString*) str;
141 /* It's very important not to touch anything
142 * other than real->str if we're going to fail,
143 * since we also use this function to reset
144 * an existing string, e.g. in _dbus_string_steal_data()
147 real->str = dbus_malloc (_DBUS_STRING_ALLOCATION_PADDING + allocate_size);
148 if (real->str == NULL)
151 real->allocated = _DBUS_STRING_ALLOCATION_PADDING + allocate_size;
153 real->str[real->len] = '\0';
155 real->max_length = _DBUS_STRING_MAX_MAX_LENGTH;
156 real->constant = FALSE;
157 real->locked = FALSE;
158 real->invalid = FALSE;
159 real->align_offset = 0;
161 fixup_alignment (real);
167 * Initializes a string. The string starts life with zero length. The
168 * string must eventually be freed with _dbus_string_free().
170 * @param str memory to hold the string
171 * @returns #TRUE on success, #FALSE if no memory
174 _dbus_string_init (DBusString *str)
176 return _dbus_string_init_preallocated (str, 0);
179 #ifdef DBUS_BUILD_TESTS
180 /* The max length thing is sort of a historical artifact
181 * from a feature that turned out to be dumb; perhaps
182 * we should purge it entirely. The problem with
183 * the feature is that it looks like memory allocation
184 * failure, but is not a transient or resolvable failure.
187 set_max_length (DBusString *str,
190 DBusRealString *real;
192 real = (DBusRealString*) str;
194 real->max_length = max_length;
196 #endif /* DBUS_BUILD_TESTS */
199 * Initializes a constant string. The value parameter is not copied
200 * (should be static), and the string may never be modified.
201 * It is safe but not necessary to call _dbus_string_free()
202 * on a const string. The string has a length limit of MAXINT - 8.
204 * @param str memory to use for the string
205 * @param value a string to be stored in str (not copied!!!)
208 _dbus_string_init_const (DBusString *str,
211 _dbus_assert (value != NULL);
213 _dbus_string_init_const_len (str, value,
218 * Initializes a constant string with a length. The value parameter is
219 * not copied (should be static), and the string may never be
220 * modified. It is safe but not necessary to call _dbus_string_free()
223 * @param str memory to use for the string
224 * @param value a string to be stored in str (not copied!!!)
225 * @param len the length to use
228 _dbus_string_init_const_len (DBusString *str,
232 DBusRealString *real;
234 _dbus_assert (str != NULL);
235 _dbus_assert (len == 0 || value != NULL);
236 _dbus_assert (len <= _DBUS_STRING_MAX_MAX_LENGTH);
237 _dbus_assert (len >= 0);
239 real = (DBusRealString*) str;
241 real->str = (unsigned char*) value;
243 real->allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
244 real->max_length = real->len + 1;
245 real->constant = TRUE;
247 real->invalid = FALSE;
248 real->align_offset = 0;
250 /* We don't require const strings to be 8-byte aligned as the
251 * memory is coming from elsewhere.
256 * Frees a string created by _dbus_string_init().
258 * @param str memory where the string is stored.
261 _dbus_string_free (DBusString *str)
263 DBusRealString *real = (DBusRealString*) str;
264 DBUS_GENERIC_STRING_PREAMBLE (real);
268 dbus_free (real->str - real->align_offset);
270 real->invalid = TRUE;
273 #ifdef DBUS_BUILD_TESTS
274 /* Not using this feature at the moment,
275 * so marked DBUS_BUILD_TESTS-only
278 * Locks a string such that any attempts to change the string will
279 * result in aborting the program. Also, if the string is wasting a
280 * lot of memory (allocation is sufficiently larger than what the
281 * string is really using), _dbus_string_lock() will realloc the
282 * string's data to "compact" it.
284 * @param str the string to lock.
287 _dbus_string_lock (DBusString *str)
289 DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
293 /* Try to realloc to avoid excess memory usage, since
294 * we know we won't change the string further
297 if (real->allocated - MAX_WASTE > real->len)
299 unsigned char *new_str;
302 new_allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING;
304 new_str = dbus_realloc (real->str - real->align_offset,
308 real->str = new_str + real->align_offset;
309 real->allocated = new_allocated;
310 fixup_alignment (real);
314 #endif /* DBUS_BUILD_TESTS */
317 reallocate_for_length (DBusRealString *real,
321 unsigned char *new_str;
323 /* at least double our old allocation to avoid O(n), avoiding
326 if (real->allocated > (_DBUS_STRING_MAX_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING) / 2)
327 new_allocated = _DBUS_STRING_MAX_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING;
329 new_allocated = real->allocated * 2;
331 /* if you change the code just above here, run the tests without
332 * the following assert-only hack before you commit
334 /* This is keyed off asserts in addition to tests so when you
335 * disable asserts to profile, you don't get this destroyer
338 #ifdef DBUS_DISABLE_ASSERT
340 #ifdef DBUS_BUILD_TESTS
341 new_allocated = 0; /* ensure a realloc every time so that we go
342 * through all malloc failure codepaths
344 #endif /* DBUS_BUILD_TESTS */
345 #endif /* !DBUS_DISABLE_ASSERT */
347 /* But be sure we always alloc at least space for the new length */
348 new_allocated = MAX (new_allocated,
349 new_length + _DBUS_STRING_ALLOCATION_PADDING);
351 _dbus_assert (new_allocated >= real->allocated); /* code relies on this */
352 new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
353 if (_DBUS_UNLIKELY (new_str == NULL))
356 real->str = new_str + real->align_offset;
357 real->allocated = new_allocated;
358 fixup_alignment (real);
364 set_length (DBusRealString *real,
367 /* Note, we are setting the length not including nul termination */
369 /* exceeding max length is the same as failure to allocate memory */
370 if (_DBUS_UNLIKELY (new_length > real->max_length))
372 else if (new_length > (real->allocated - _DBUS_STRING_ALLOCATION_PADDING) &&
373 _DBUS_UNLIKELY (!reallocate_for_length (real, new_length)))
377 real->len = new_length;
378 real->str[new_length] = '\0';
385 DBusRealString *dest,
391 if (len > dest->max_length - dest->len)
392 return FALSE; /* detected overflow of dest->len + len below */
394 if (!set_length (dest, dest->len + len))
397 memmove (dest->str + insert_at + len,
398 dest->str + insert_at,
399 dest->len - len - insert_at);
404 #ifndef _dbus_string_get_data
406 * Gets the raw character buffer from the string. The returned buffer
407 * will be nul-terminated, but note that strings may contain binary
408 * data so there may be extra nul characters prior to the termination.
409 * This function should be little-used, extend DBusString or add
410 * stuff to dbus-sysdeps.c instead. It's an error to use this
411 * function on a const string.
413 * @param str the string
417 _dbus_string_get_data (DBusString *str)
419 DBUS_STRING_PREAMBLE (str);
421 return (char*) real->str;
423 #endif /* _dbus_string_get_data */
425 /* only do the function if we don't have the macro */
426 #ifndef _dbus_string_get_const_data
428 * Gets the raw character buffer from a const string.
430 * @param str the string
431 * @returns the string data
434 _dbus_string_get_const_data (const DBusString *str)
436 DBUS_CONST_STRING_PREAMBLE (str);
438 return (const char*) real->str;
440 #endif /* _dbus_string_get_const_data */
443 * Gets a sub-portion of the raw character buffer from the
444 * string. The "len" field is required simply for error
445 * checking, to be sure you don't try to use more
446 * string than exists. The nul termination of the
447 * returned buffer remains at the end of the entire
448 * string, not at start + len.
450 * @param str the string
451 * @param start byte offset to return
452 * @param len length of segment to return
453 * @returns the string data
456 _dbus_string_get_data_len (DBusString *str,
460 DBUS_STRING_PREAMBLE (str);
461 _dbus_assert (start >= 0);
462 _dbus_assert (len >= 0);
463 _dbus_assert (start <= real->len);
464 _dbus_assert (len <= real->len - start);
466 return (char*) real->str + start;
469 /* only do the function if we don't have the macro */
470 #ifndef _dbus_string_get_const_data_len
472 * const version of _dbus_string_get_data_len().
474 * @param str the string
475 * @param start byte offset to return
476 * @param len length of segment to return
477 * @returns the string data
480 _dbus_string_get_const_data_len (const DBusString *str,
484 DBUS_CONST_STRING_PREAMBLE (str);
485 _dbus_assert (start >= 0);
486 _dbus_assert (len >= 0);
487 _dbus_assert (start <= real->len);
488 _dbus_assert (len <= real->len - start);
490 return (const char*) real->str + start;
492 #endif /* _dbus_string_get_const_data_len */
494 /* only do the function if we don't have the macro */
495 #ifndef _dbus_string_set_byte
497 * Sets the value of the byte at the given position.
499 * @param str the string
500 * @param i the position
501 * @param byte the new value
504 _dbus_string_set_byte (DBusString *str,
508 DBUS_STRING_PREAMBLE (str);
509 _dbus_assert (i < real->len);
510 _dbus_assert (i >= 0);
514 #endif /* _dbus_string_set_byte */
516 /* only have the function if we didn't create a macro */
517 #ifndef _dbus_string_get_byte
519 * Gets the byte at the given position. It is
520 * allowed to ask for the nul byte at the end of
523 * @param str the string
524 * @param start the position
525 * @returns the byte at that position
528 _dbus_string_get_byte (const DBusString *str,
531 DBUS_CONST_STRING_PREAMBLE (str);
532 _dbus_assert (start <= real->len);
533 _dbus_assert (start >= 0);
535 return real->str[start];
537 #endif /* _dbus_string_get_byte */
540 * Inserts a number of bytes of a given value at the
543 * @param str the string
544 * @param i the position
545 * @param n_bytes number of bytes
546 * @param byte the value to insert
547 * @returns #TRUE on success
550 _dbus_string_insert_bytes (DBusString *str,
555 DBUS_STRING_PREAMBLE (str);
556 _dbus_assert (i <= real->len);
557 _dbus_assert (i >= 0);
558 _dbus_assert (n_bytes >= 0);
563 if (!open_gap (n_bytes, real, i))
566 memset (real->str + i, byte, n_bytes);
572 * Inserts a single byte at the given position.
574 * @param str the string
575 * @param i the position
576 * @param byte the value to insert
577 * @returns #TRUE on success
580 _dbus_string_insert_byte (DBusString *str,
584 DBUS_STRING_PREAMBLE (str);
585 _dbus_assert (i <= real->len);
586 _dbus_assert (i >= 0);
588 if (!open_gap (1, real, i))
597 * Like _dbus_string_get_data(), but removes the
598 * gotten data from the original string. The caller
599 * must free the data returned. This function may
600 * fail due to lack of memory, and return #FALSE.
602 * @param str the string
603 * @param data_return location to return the buffer
604 * @returns #TRUE on success
607 _dbus_string_steal_data (DBusString *str,
611 DBUS_STRING_PREAMBLE (str);
612 _dbus_assert (data_return != NULL);
614 undo_alignment (real);
616 *data_return = (char*) real->str;
618 old_max_length = real->max_length;
620 /* reset the string */
621 if (!_dbus_string_init (str))
623 /* hrm, put it back then */
624 real->str = (unsigned char*) *data_return;
626 fixup_alignment (real);
630 real->max_length = old_max_length;
635 #ifdef DBUS_BUILD_TESTS
637 * Like _dbus_string_get_data_len(), but removes the gotten data from
638 * the original string. The caller must free the data returned. This
639 * function may fail due to lack of memory, and return #FALSE.
640 * The returned string is nul-terminated and has length len.
642 * @todo this function is broken because on failure it
643 * may corrupt the source string.
645 * @param str the string
646 * @param data_return location to return the buffer
647 * @param start the start of segment to steal
648 * @param len the length of segment to steal
649 * @returns #TRUE on success
652 _dbus_string_steal_data_len (DBusString *str,
658 DBUS_STRING_PREAMBLE (str);
659 _dbus_assert (data_return != NULL);
660 _dbus_assert (start >= 0);
661 _dbus_assert (len >= 0);
662 _dbus_assert (start <= real->len);
663 _dbus_assert (len <= real->len - start);
665 if (!_dbus_string_init (&dest))
668 set_max_length (&dest, real->max_length);
670 if (!_dbus_string_move_len (str, start, len, &dest, 0))
672 _dbus_string_free (&dest);
676 _dbus_warn ("Broken code in _dbus_string_steal_data_len(), see @todo, FIXME\n");
677 if (!_dbus_string_steal_data (&dest, data_return))
679 _dbus_string_free (&dest);
683 _dbus_string_free (&dest);
686 #endif /* DBUS_BUILD_TESTS */
689 * Copies the data from the string into a char*
691 * @param str the string
692 * @param data_return place to return the data
693 * @returns #TRUE on success, #FALSE on no memory
696 _dbus_string_copy_data (const DBusString *str,
699 DBUS_CONST_STRING_PREAMBLE (str);
700 _dbus_assert (data_return != NULL);
702 *data_return = dbus_malloc (real->len + 1);
703 if (*data_return == NULL)
706 memcpy (*data_return, real->str, real->len + 1);
712 * Copies the contents of a DBusString into a different
713 * buffer. The resulting buffer will be nul-terminated.
715 * @param str a string
716 * @param buffer a C buffer to copy data to
717 * @param avail_len maximum length of C buffer
720 _dbus_string_copy_to_buffer (const DBusString *str,
725 DBUS_CONST_STRING_PREAMBLE (str);
727 _dbus_assert (avail_len >= 0);
729 copy_len = MIN (avail_len, real->len+1);
730 memcpy (buffer, real->str, copy_len);
731 if (avail_len > 0 && avail_len == copy_len)
732 buffer[avail_len-1] = '\0';
735 #ifdef DBUS_BUILD_TESTS
737 * Copies a segment of the string into a char*
739 * @param str the string
740 * @param data_return place to return the data
741 * @param start start index
742 * @param len length to copy
743 * @returns #FALSE if no memory
746 _dbus_string_copy_data_len (const DBusString *str,
753 DBUS_CONST_STRING_PREAMBLE (str);
754 _dbus_assert (data_return != NULL);
755 _dbus_assert (start >= 0);
756 _dbus_assert (len >= 0);
757 _dbus_assert (start <= real->len);
758 _dbus_assert (len <= real->len - start);
760 if (!_dbus_string_init (&dest))
763 set_max_length (&dest, real->max_length);
765 if (!_dbus_string_copy_len (str, start, len, &dest, 0))
767 _dbus_string_free (&dest);
771 if (!_dbus_string_steal_data (&dest, data_return))
773 _dbus_string_free (&dest);
777 _dbus_string_free (&dest);
780 #endif /* DBUS_BUILD_TESTS */
782 /* Only have the function if we don't have the macro */
783 #ifndef _dbus_string_get_length
785 * Gets the length of a string (not including nul termination).
787 * @returns the length.
790 _dbus_string_get_length (const DBusString *str)
792 DBUS_CONST_STRING_PREAMBLE (str);
796 #endif /* !_dbus_string_get_length */
799 * Makes a string longer by the given number of bytes. Checks whether
800 * adding additional_length to the current length would overflow an
801 * integer, and checks for exceeding a string's max length.
802 * The new bytes are not initialized, other than nul-terminating
803 * the end of the string. The uninitialized bytes may contain
804 * nul bytes or other junk.
806 * @param str a string
807 * @param additional_length length to add to the string.
808 * @returns #TRUE on success.
811 _dbus_string_lengthen (DBusString *str,
812 int additional_length)
814 DBUS_STRING_PREAMBLE (str);
815 _dbus_assert (additional_length >= 0);
817 if (_DBUS_UNLIKELY (additional_length > real->max_length - real->len))
818 return FALSE; /* would overflow */
820 return set_length (real,
821 real->len + additional_length);
825 * Makes a string shorter by the given number of bytes.
827 * @param str a string
828 * @param length_to_remove length to remove from the string.
831 _dbus_string_shorten (DBusString *str,
832 int length_to_remove)
834 DBUS_STRING_PREAMBLE (str);
835 _dbus_assert (length_to_remove >= 0);
836 _dbus_assert (length_to_remove <= real->len);
839 real->len - length_to_remove);
843 * Sets the length of a string. Can be used to truncate or lengthen
844 * the string. If the string is lengthened, the function may fail and
845 * return #FALSE. Newly-added bytes are not initialized, as with
846 * _dbus_string_lengthen().
848 * @param str a string
849 * @param length new length of the string.
850 * @returns #FALSE on failure.
853 _dbus_string_set_length (DBusString *str,
856 DBUS_STRING_PREAMBLE (str);
857 _dbus_assert (length >= 0);
859 return set_length (real, length);
863 align_insert_point_then_open_gap (DBusString *str,
868 unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
869 unsigned long gap_pos;
872 DBUS_STRING_PREAMBLE (str);
873 _dbus_assert (alignment >= 1);
874 _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
876 insert_at = *insert_at_p;
878 _dbus_assert (insert_at <= real->len);
880 gap_pos = _DBUS_ALIGN_VALUE (insert_at, alignment);
881 new_len = real->len + (gap_pos - insert_at) + gap_size;
883 if (_DBUS_UNLIKELY (new_len > (unsigned long) real->max_length))
886 delta = new_len - real->len;
887 _dbus_assert (delta >= 0);
889 if (delta == 0) /* only happens if gap_size == 0 and insert_at is aligned already */
891 _dbus_assert (((unsigned long) *insert_at_p) == gap_pos);
895 if (_DBUS_UNLIKELY (!open_gap (new_len - real->len,
899 /* nul the padding if we had to add any padding */
900 if (gap_size < delta)
902 memset (&real->str[insert_at], '\0',
903 gap_pos - insert_at);
906 *insert_at_p = gap_pos;
912 align_length_then_lengthen (DBusString *str,
914 int then_lengthen_by)
918 insert_at = _dbus_string_get_length (str);
920 return align_insert_point_then_open_gap (str,
922 alignment, then_lengthen_by);
926 * Align the length of a string to a specific alignment (typically 4 or 8)
927 * by appending nul bytes to the string.
929 * @param str a string
930 * @param alignment the alignment
931 * @returns #FALSE if no memory
934 _dbus_string_align_length (DBusString *str,
937 return align_length_then_lengthen (str, alignment, 0);
941 * Preallocate extra_bytes such that a future lengthening of the
942 * string by extra_bytes is guaranteed to succeed without an out of
945 * @param str a string
946 * @param extra_bytes bytes to alloc
947 * @returns #FALSE if no memory
950 _dbus_string_alloc_space (DBusString *str,
953 if (!_dbus_string_lengthen (str, extra_bytes))
955 _dbus_string_shorten (str, extra_bytes);
961 append (DBusRealString *real,
968 if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
971 memcpy (real->str + (real->len - buffer_len),
979 * Appends a nul-terminated C-style string to a DBusString.
981 * @param str the DBusString
982 * @param buffer the nul-terminated characters to append
983 * @returns #FALSE if not enough memory.
986 _dbus_string_append (DBusString *str,
989 unsigned long buffer_len;
991 DBUS_STRING_PREAMBLE (str);
992 _dbus_assert (buffer != NULL);
994 buffer_len = strlen (buffer);
995 if (buffer_len > (unsigned long) real->max_length)
998 return append (real, buffer, buffer_len);
1001 /** assign 2 bytes from one string to another */
1002 #define ASSIGN_2_OCTETS(p, octets) \
1003 *((dbus_uint16_t*)(p)) = *((dbus_uint16_t*)(octets));
1005 /** assign 4 bytes from one string to another */
1006 #define ASSIGN_4_OCTETS(p, octets) \
1007 *((dbus_uint32_t*)(p)) = *((dbus_uint32_t*)(octets));
1009 #ifdef DBUS_HAVE_INT64
1010 /** assign 8 bytes from one string to another */
1011 #define ASSIGN_8_OCTETS(p, octets) \
1012 *((dbus_uint64_t*)(p)) = *((dbus_uint64_t*)(octets));
1014 /** assign 8 bytes from one string to another */
1015 #define ASSIGN_8_OCTETS(p, octets) \
1029 _dbus_assert (b == p + 8); \
1031 #endif /* DBUS_HAVE_INT64 */
1033 #ifdef DBUS_BUILD_TESTS
1035 * Appends 4 bytes aligned on a 4 byte boundary
1036 * with any alignment padding initialized to 0.
1038 * @param str the DBusString
1039 * @param octets 4 bytes to append
1040 * @returns #FALSE if not enough memory.
1043 _dbus_string_append_4_aligned (DBusString *str,
1044 const unsigned char octets[4])
1046 DBUS_STRING_PREAMBLE (str);
1048 if (!align_length_then_lengthen (str, 4, 4))
1051 ASSIGN_4_OCTETS (real->str + (real->len - 4), octets);
1055 #endif /* DBUS_BUILD_TESTS */
1057 #ifdef DBUS_BUILD_TESTS
1059 * Appends 8 bytes aligned on an 8 byte boundary
1060 * with any alignment padding initialized to 0.
1062 * @param str the DBusString
1063 * @param octets 8 bytes to append
1064 * @returns #FALSE if not enough memory.
1067 _dbus_string_append_8_aligned (DBusString *str,
1068 const unsigned char octets[8])
1070 DBUS_STRING_PREAMBLE (str);
1072 if (!align_length_then_lengthen (str, 8, 8))
1075 ASSIGN_8_OCTETS (real->str + (real->len - 8), octets);
1079 #endif /* DBUS_BUILD_TESTS */
1082 * Inserts 2 bytes aligned on a 2 byte boundary
1083 * with any alignment padding initialized to 0.
1085 * @param str the DBusString
1086 * @param insert_at where to insert
1087 * @param octets 2 bytes to insert
1088 * @returns #FALSE if not enough memory.
1091 _dbus_string_insert_2_aligned (DBusString *str,
1093 const unsigned char octets[4])
1095 DBUS_STRING_PREAMBLE (str);
1097 if (!align_insert_point_then_open_gap (str, &insert_at, 2, 2))
1100 ASSIGN_2_OCTETS (real->str + insert_at, octets);
1106 * Inserts 4 bytes aligned on a 4 byte boundary
1107 * with any alignment padding initialized to 0.
1109 * @param str the DBusString
1110 * @param insert_at where to insert
1111 * @param octets 4 bytes to insert
1112 * @returns #FALSE if not enough memory.
1115 _dbus_string_insert_4_aligned (DBusString *str,
1117 const unsigned char octets[4])
1119 DBUS_STRING_PREAMBLE (str);
1121 if (!align_insert_point_then_open_gap (str, &insert_at, 4, 4))
1124 ASSIGN_4_OCTETS (real->str + insert_at, octets);
1130 * Inserts 8 bytes aligned on an 8 byte boundary
1131 * with any alignment padding initialized to 0.
1133 * @param str the DBusString
1134 * @param insert_at where to insert
1135 * @param octets 8 bytes to insert
1136 * @returns #FALSE if not enough memory.
1139 _dbus_string_insert_8_aligned (DBusString *str,
1141 const unsigned char octets[8])
1143 DBUS_STRING_PREAMBLE (str);
1145 if (!align_insert_point_then_open_gap (str, &insert_at, 8, 8))
1148 _dbus_assert (_DBUS_ALIGN_VALUE (insert_at, 8) == (unsigned) insert_at);
1150 ASSIGN_8_OCTETS (real->str + insert_at, octets);
1157 * Inserts padding at *insert_at such to align it to the given
1158 * boundary. Initializes the padding to nul bytes. Sets *insert_at
1159 * to the aligned position.
1161 * @param str the DBusString
1162 * @param insert_at location to be aligned
1163 * @param alignment alignment boundary (1, 2, 4, or 8)
1164 * @returns #FALSE if not enough memory.
1167 _dbus_string_insert_alignment (DBusString *str,
1171 DBUS_STRING_PREAMBLE (str);
1173 if (!align_insert_point_then_open_gap (str, insert_at, alignment, 0))
1176 _dbus_assert (_DBUS_ALIGN_VALUE (*insert_at, alignment) == (unsigned) *insert_at);
1182 * Appends a printf-style formatted string
1183 * to the #DBusString.
1185 * @param str the string
1186 * @param format printf format
1187 * @param args variable argument list
1188 * @returns #FALSE if no memory
1191 _dbus_string_append_printf_valist (DBusString *str,
1198 DBUS_STRING_PREAMBLE (str);
1200 DBUS_VA_COPY (args_copy, args);
1202 /* Measure the message length without terminating nul */
1203 len = _dbus_printf_string_upper_bound (format, args);
1205 if (!_dbus_string_lengthen (str, len))
1207 /* don't leak the copy */
1212 vsprintf ((char*) (real->str + (real->len - len)),
1221 * Appends a printf-style formatted string
1222 * to the #DBusString.
1224 * @param str the string
1225 * @param format printf format
1226 * @returns #FALSE if no memory
1229 _dbus_string_append_printf (DBusString *str,
1236 va_start (args, format);
1237 retval = _dbus_string_append_printf_valist (str, format, args);
1244 * Appends block of bytes with the given length to a DBusString.
1246 * @param str the DBusString
1247 * @param buffer the bytes to append
1248 * @param len the number of bytes to append
1249 * @returns #FALSE if not enough memory.
1252 _dbus_string_append_len (DBusString *str,
1256 DBUS_STRING_PREAMBLE (str);
1257 _dbus_assert (buffer != NULL);
1258 _dbus_assert (len >= 0);
1260 return append (real, buffer, len);
1264 * Appends a single byte to the string, returning #FALSE
1265 * if not enough memory.
1267 * @param str the string
1268 * @param byte the byte to append
1269 * @returns #TRUE on success
1272 _dbus_string_append_byte (DBusString *str,
1275 DBUS_STRING_PREAMBLE (str);
1277 if (!set_length (real, real->len + 1))
1280 real->str[real->len-1] = byte;
1285 #ifdef DBUS_BUILD_TESTS
1287 * Appends a single Unicode character, encoding the character
1290 * @param str the string
1291 * @param ch the Unicode character
1294 _dbus_string_append_unichar (DBusString *str,
1302 DBUS_STRING_PREAMBLE (str);
1304 /* this code is from GLib but is pretty standard I think */
1313 else if (ch < 0x800)
1318 else if (ch < 0x10000)
1323 else if (ch < 0x200000)
1328 else if (ch < 0x4000000)
1339 if (len > (real->max_length - real->len))
1340 return FALSE; /* real->len + len would overflow */
1342 if (!set_length (real, real->len + len))
1345 out = real->str + (real->len - len);
1347 for (i = len - 1; i > 0; --i)
1349 out[i] = (ch & 0x3f) | 0x80;
1352 out[0] = ch | first;
1356 #endif /* DBUS_BUILD_TESTS */
1359 delete (DBusRealString *real,
1366 memmove (real->str + start, real->str + start + len, real->len - (start + len));
1368 real->str[real->len] = '\0';
1372 * Deletes a segment of a DBusString with length len starting at
1373 * start. (Hint: to clear an entire string, setting length to 0
1374 * with _dbus_string_set_length() is easier.)
1376 * @param str the DBusString
1377 * @param start where to start deleting
1378 * @param len the number of bytes to delete
1381 _dbus_string_delete (DBusString *str,
1385 DBUS_STRING_PREAMBLE (str);
1386 _dbus_assert (start >= 0);
1387 _dbus_assert (len >= 0);
1388 _dbus_assert (start <= real->len);
1389 _dbus_assert (len <= real->len - start);
1391 delete (real, start, len);
1395 copy (DBusRealString *source,
1398 DBusRealString *dest,
1404 if (!open_gap (len, dest, insert_at))
1407 memmove (dest->str + insert_at,
1408 source->str + start,
1415 * Checks assertions for two strings we're copying a segment between,
1416 * and declares real_source/real_dest variables.
1418 * @param source the source string
1419 * @param start the starting offset
1420 * @param dest the dest string
1421 * @param insert_at where the copied segment is inserted
1423 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at) \
1424 DBusRealString *real_source = (DBusRealString*) source; \
1425 DBusRealString *real_dest = (DBusRealString*) dest; \
1426 _dbus_assert ((source) != (dest)); \
1427 DBUS_GENERIC_STRING_PREAMBLE (real_source); \
1428 DBUS_GENERIC_STRING_PREAMBLE (real_dest); \
1429 _dbus_assert (!real_dest->constant); \
1430 _dbus_assert (!real_dest->locked); \
1431 _dbus_assert ((start) >= 0); \
1432 _dbus_assert ((start) <= real_source->len); \
1433 _dbus_assert ((insert_at) >= 0); \
1434 _dbus_assert ((insert_at) <= real_dest->len)
1437 * Moves the end of one string into another string. Both strings
1438 * must be initialized, valid strings.
1440 * @param source the source string
1441 * @param start where to chop off the source string
1442 * @param dest the destination string
1443 * @param insert_at where to move the chopped-off part of source string
1444 * @returns #FALSE if not enough memory
1447 _dbus_string_move (DBusString *source,
1452 DBusRealString *real_source = (DBusRealString*) source;
1453 _dbus_assert (start <= real_source->len);
1455 return _dbus_string_move_len (source, start,
1456 real_source->len - start,
1461 * Like _dbus_string_move(), but does not delete the section
1462 * of the source string that's copied to the dest string.
1464 * @param source the source string
1465 * @param start where to start copying the source string
1466 * @param dest the destination string
1467 * @param insert_at where to place the copied part of source string
1468 * @returns #FALSE if not enough memory
1471 _dbus_string_copy (const DBusString *source,
1476 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1478 return copy (real_source, start,
1479 real_source->len - start,
1485 * Like _dbus_string_move(), but can move a segment from
1486 * the middle of the source string.
1488 * @todo this doesn't do anything with max_length field.
1489 * we should probably just kill the max_length field though.
1491 * @param source the source string
1492 * @param start first byte of source string to move
1493 * @param len length of segment to move
1494 * @param dest the destination string
1495 * @param insert_at where to move the bytes from the source string
1496 * @returns #FALSE if not enough memory
1499 _dbus_string_move_len (DBusString *source,
1506 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1507 _dbus_assert (len >= 0);
1508 _dbus_assert ((start + len) <= real_source->len);
1515 else if (start == 0 &&
1516 len == real_source->len &&
1517 real_dest->len == 0)
1519 /* Short-circuit moving an entire existing string to an empty string
1520 * by just swapping the buffers.
1522 /* we assume ->constant doesn't matter as you can't have
1523 * a constant string involved in a move.
1525 #define ASSIGN_DATA(a, b) do { \
1526 (a)->str = (b)->str; \
1527 (a)->len = (b)->len; \
1528 (a)->allocated = (b)->allocated; \
1529 (a)->align_offset = (b)->align_offset; \
1534 ASSIGN_DATA (&tmp, real_source);
1535 ASSIGN_DATA (real_source, real_dest);
1536 ASSIGN_DATA (real_dest, &tmp);
1542 if (!copy (real_source, start, len,
1547 delete (real_source, start,
1555 * Like _dbus_string_copy(), but can copy a segment from the middle of
1556 * the source string.
1558 * @param source the source string
1559 * @param start where to start copying the source string
1560 * @param len length of segment to copy
1561 * @param dest the destination string
1562 * @param insert_at where to place the copied segment of source string
1563 * @returns #FALSE if not enough memory
1566 _dbus_string_copy_len (const DBusString *source,
1572 DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1573 _dbus_assert (len >= 0);
1574 _dbus_assert (start <= real_source->len);
1575 _dbus_assert (len <= real_source->len - start);
1577 return copy (real_source, start, len,
1583 * Replaces a segment of dest string with a segment of source string.
1585 * @todo optimize the case where the two lengths are the same, and
1586 * avoid memmoving the data in the trailing part of the string twice.
1588 * @todo avoid inserting the source into dest, then deleting
1589 * the replaced chunk of dest (which creates a potentially large
1590 * intermediate string). Instead, extend the replaced chunk
1591 * of dest with padding to the same size as the source chunk,
1592 * then copy in the source bytes.
1594 * @param source the source string
1595 * @param start where to start copying the source string
1596 * @param len length of segment to copy
1597 * @param dest the destination string
1598 * @param replace_at start of segment of dest string to replace
1599 * @param replace_len length of segment of dest string to replace
1600 * @returns #FALSE if not enough memory
1604 _dbus_string_replace_len (const DBusString *source,
1611 DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1612 _dbus_assert (len >= 0);
1613 _dbus_assert (start <= real_source->len);
1614 _dbus_assert (len <= real_source->len - start);
1615 _dbus_assert (replace_at >= 0);
1616 _dbus_assert (replace_at <= real_dest->len);
1617 _dbus_assert (replace_len <= real_dest->len - replace_at);
1619 if (!copy (real_source, start, len,
1620 real_dest, replace_at))
1623 delete (real_dest, replace_at + len, replace_len);
1628 /* Unicode macros and utf8_validate() from GLib Owen Taylor, Havoc
1629 * Pennington, and Tom Tromey are the authors and authorized relicense.
1632 /** computes length and mask of a unicode character
1633 * @param Char the char
1634 * @param Mask the mask variable to assign to
1635 * @param Len the length variable to assign to
1637 #define UTF8_COMPUTE(Char, Mask, Len) \
1643 else if ((Char & 0xe0) == 0xc0) \
1648 else if ((Char & 0xf0) == 0xe0) \
1653 else if ((Char & 0xf8) == 0xf0) \
1658 else if ((Char & 0xfc) == 0xf8) \
1663 else if ((Char & 0xfe) == 0xfc) \
1675 * computes length of a unicode character in UTF-8
1676 * @param Char the char
1678 #define UTF8_LENGTH(Char) \
1679 ((Char) < 0x80 ? 1 : \
1680 ((Char) < 0x800 ? 2 : \
1681 ((Char) < 0x10000 ? 3 : \
1682 ((Char) < 0x200000 ? 4 : \
1683 ((Char) < 0x4000000 ? 5 : 6)))))
1686 * Gets a UTF-8 value.
1688 * @param Result variable for extracted unicode char.
1689 * @param Chars the bytes to decode
1690 * @param Count counter variable
1691 * @param Mask mask for this char
1692 * @param Len length for this char in bytes
1694 #define UTF8_GET(Result, Chars, Count, Mask, Len) \
1695 (Result) = (Chars)[0] & (Mask); \
1696 for ((Count) = 1; (Count) < (Len); ++(Count)) \
1698 if (((Chars)[(Count)] & 0xc0) != 0x80) \
1704 (Result) |= ((Chars)[(Count)] & 0x3f); \
1708 * Check whether a unicode char is in a valid range.
1710 * @param Char the character
1712 #define UNICODE_VALID(Char) \
1713 ((Char) < 0x110000 && \
1714 (((Char) & 0xFFFFF800) != 0xD800) && \
1715 ((Char) < 0xFDD0 || (Char) > 0xFDEF) && \
1716 ((Char) & 0xFFFF) != 0xFFFF)
1718 #ifdef DBUS_BUILD_TESTS
1720 * Gets a unicode character from a UTF-8 string. Does no validation;
1721 * you must verify that the string is valid UTF-8 in advance and must
1722 * pass in the start of a character.
1724 * @param str the string
1725 * @param start the start of the UTF-8 character.
1726 * @param ch_return location to return the character
1727 * @param end_return location to return the byte index of next character
1730 _dbus_string_get_unichar (const DBusString *str,
1732 dbus_unichar_t *ch_return,
1736 dbus_unichar_t result;
1739 DBUS_CONST_STRING_PREAMBLE (str);
1740 _dbus_assert (start >= 0);
1741 _dbus_assert (start <= real->len);
1746 *end_return = real->len;
1749 p = real->str + start;
1752 UTF8_COMPUTE (c, mask, len);
1755 UTF8_GET (result, p, i, mask, len);
1757 if (result == (dbus_unichar_t)-1)
1761 *ch_return = result;
1763 *end_return = start + len;
1765 #endif /* DBUS_BUILD_TESTS */
1768 * Finds the given substring in the string,
1769 * returning #TRUE and filling in the byte index
1770 * where the substring was found, if it was found.
1771 * Returns #FALSE if the substring wasn't found.
1772 * Sets *start to the length of the string if the substring
1775 * @param str the string
1776 * @param start where to start looking
1777 * @param substr the substring
1778 * @param found return location for where it was found, or #NULL
1779 * @returns #TRUE if found
1782 _dbus_string_find (const DBusString *str,
1787 return _dbus_string_find_to (str, start,
1788 ((const DBusRealString*)str)->len,
1793 * Finds the given substring in the string,
1794 * up to a certain position,
1795 * returning #TRUE and filling in the byte index
1796 * where the substring was found, if it was found.
1797 * Returns #FALSE if the substring wasn't found.
1798 * Sets *start to the length of the string if the substring
1801 * @param str the string
1802 * @param start where to start looking
1803 * @param end where to stop looking
1804 * @param substr the substring
1805 * @param found return location for where it was found, or #NULL
1806 * @returns #TRUE if found
1809 _dbus_string_find_to (const DBusString *str,
1816 DBUS_CONST_STRING_PREAMBLE (str);
1817 _dbus_assert (substr != NULL);
1818 _dbus_assert (start <= real->len);
1819 _dbus_assert (start >= 0);
1820 _dbus_assert (substr != NULL);
1821 _dbus_assert (end <= real->len);
1822 _dbus_assert (start <= end);
1824 /* we always "find" an empty string */
1825 if (*substr == '\0')
1835 if (real->str[i] == substr[0])
1841 if (substr[j - i] == '\0')
1843 else if (real->str[j] != substr[j - i])
1849 if (substr[j - i] == '\0')
1867 * Finds a blank (space or tab) in the string. Returns #TRUE
1868 * if found, #FALSE otherwise. If a blank is not found sets
1869 * *found to the length of the string.
1871 * @param str the string
1872 * @param start byte index to start looking
1873 * @param found place to store the location of the first blank
1874 * @returns #TRUE if a blank was found
1877 _dbus_string_find_blank (const DBusString *str,
1882 DBUS_CONST_STRING_PREAMBLE (str);
1883 _dbus_assert (start <= real->len);
1884 _dbus_assert (start >= 0);
1887 while (i < real->len)
1889 if (real->str[i] == ' ' ||
1890 real->str[i] == '\t')
1907 * Skips blanks from start, storing the first non-blank in *end
1908 * (blank is space or tab).
1910 * @param str the string
1911 * @param start where to start
1912 * @param end where to store the first non-blank byte index
1915 _dbus_string_skip_blank (const DBusString *str,
1920 DBUS_CONST_STRING_PREAMBLE (str);
1921 _dbus_assert (start <= real->len);
1922 _dbus_assert (start >= 0);
1925 while (i < real->len)
1927 if (!DBUS_IS_ASCII_BLANK (real->str[i]))
1933 _dbus_assert (i == real->len || !DBUS_IS_ASCII_WHITE (real->str[i]));
1941 * Skips whitespace from start, storing the first non-whitespace in *end.
1942 * (whitespace is space, tab, newline, CR).
1944 * @param str the string
1945 * @param start where to start
1946 * @param end where to store the first non-whitespace byte index
1949 _dbus_string_skip_white (const DBusString *str,
1954 DBUS_CONST_STRING_PREAMBLE (str);
1955 _dbus_assert (start <= real->len);
1956 _dbus_assert (start >= 0);
1959 while (i < real->len)
1961 if (!DBUS_IS_ASCII_WHITE (real->str[i]))
1967 _dbus_assert (i == real->len || !(DBUS_IS_ASCII_WHITE (real->str[i])));
1974 * Skips whitespace from end, storing the start index of the trailing
1975 * whitespace in *start. (whitespace is space, tab, newline, CR).
1977 * @param str the string
1978 * @param end where to start scanning backward
1979 * @param start where to store the start of whitespace chars
1982 _dbus_string_skip_white_reverse (const DBusString *str,
1987 DBUS_CONST_STRING_PREAMBLE (str);
1988 _dbus_assert (end <= real->len);
1989 _dbus_assert (end >= 0);
1994 if (!DBUS_IS_ASCII_WHITE (real->str[i-1]))
1999 _dbus_assert (i >= 0 && (i == 0 || !(DBUS_IS_ASCII_WHITE (real->str[i-1]))));
2006 * Assigns a newline-terminated or \\r\\n-terminated line from the front
2007 * of the string to the given dest string. The dest string's previous
2008 * contents are deleted. If the source string contains no newline,
2009 * moves the entire source string to the dest string.
2011 * @todo owen correctly notes that this is a stupid function (it was
2012 * written purely for test code,
2013 * e.g. dbus-message-builder.c). Probably should be enforced as test
2014 * code only with ifdef DBUS_BUILD_TESTS
2016 * @param source the source string
2017 * @param dest the destination string (contents are replaced)
2018 * @returns #FALSE if no memory, or source has length 0
2021 _dbus_string_pop_line (DBusString *source,
2025 dbus_bool_t have_newline;
2027 _dbus_string_set_length (dest, 0);
2030 if (_dbus_string_find (source, 0, "\n", &eol))
2032 have_newline = TRUE;
2033 eol += 1; /* include newline */
2037 eol = _dbus_string_get_length (source);
2038 have_newline = FALSE;
2042 return FALSE; /* eof */
2044 if (!_dbus_string_move_len (source, 0, eol,
2050 /* dump the newline and the \r if we have one */
2053 dbus_bool_t have_cr;
2055 _dbus_assert (_dbus_string_get_length (dest) > 0);
2057 if (_dbus_string_get_length (dest) > 1 &&
2058 _dbus_string_get_byte (dest,
2059 _dbus_string_get_length (dest) - 2) == '\r')
2064 _dbus_string_set_length (dest,
2065 _dbus_string_get_length (dest) -
2072 #ifdef DBUS_BUILD_TESTS
2074 * Deletes up to and including the first blank space
2077 * @param str the string
2080 _dbus_string_delete_first_word (DBusString *str)
2084 if (_dbus_string_find_blank (str, 0, &i))
2085 _dbus_string_skip_blank (str, i, &i);
2087 _dbus_string_delete (str, 0, i);
2091 #ifdef DBUS_BUILD_TESTS
2093 * Deletes any leading blanks in the string
2095 * @param str the string
2098 _dbus_string_delete_leading_blanks (DBusString *str)
2102 _dbus_string_skip_blank (str, 0, &i);
2105 _dbus_string_delete (str, 0, i);
2110 * Deletes leading and trailing whitespace
2112 * @param str the string
2115 _dbus_string_chop_white(DBusString *str)
2119 _dbus_string_skip_white (str, 0, &i);
2122 _dbus_string_delete (str, 0, i);
2124 _dbus_string_skip_white_reverse (str, _dbus_string_get_length (str), &i);
2126 _dbus_string_set_length (str, i);
2130 * Tests two DBusString for equality.
2132 * @todo memcmp is probably faster
2134 * @param a first string
2135 * @param b second string
2136 * @returns #TRUE if equal
2139 _dbus_string_equal (const DBusString *a,
2140 const DBusString *b)
2142 const unsigned char *ap;
2143 const unsigned char *bp;
2144 const unsigned char *a_end;
2145 const DBusRealString *real_a = (const DBusRealString*) a;
2146 const DBusRealString *real_b = (const DBusRealString*) b;
2147 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2148 DBUS_GENERIC_STRING_PREAMBLE (real_b);
2150 if (real_a->len != real_b->len)
2155 a_end = real_a->str + real_a->len;
2168 #ifdef DBUS_BUILD_TESTS
2170 * Tests two DBusString for equality up to the given length.
2171 * The strings may be shorter than the given length.
2173 * @todo write a unit test
2175 * @todo memcmp is probably faster
2177 * @param a first string
2178 * @param b second string
2179 * @param len the maximum length to look at
2180 * @returns #TRUE if equal for the given number of bytes
2183 _dbus_string_equal_len (const DBusString *a,
2184 const DBusString *b,
2187 const unsigned char *ap;
2188 const unsigned char *bp;
2189 const unsigned char *a_end;
2190 const DBusRealString *real_a = (const DBusRealString*) a;
2191 const DBusRealString *real_b = (const DBusRealString*) b;
2192 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2193 DBUS_GENERIC_STRING_PREAMBLE (real_b);
2195 if (real_a->len != real_b->len &&
2196 (real_a->len < len || real_b->len < len))
2201 a_end = real_a->str + MIN (real_a->len, len);
2213 #endif /* DBUS_BUILD_TESTS */
2216 * Tests two sub-parts of two DBusString for equality. The specified
2217 * range of the first string must exist; the specified start position
2218 * of the second string must exist.
2220 * @todo write a unit test
2222 * @todo memcmp is probably faster
2224 * @param a first string
2225 * @param a_start where to start substring in first string
2226 * @param a_len length of substring in first string
2227 * @param b second string
2228 * @param b_start where to start substring in second string
2229 * @returns #TRUE if the two substrings are equal
2232 _dbus_string_equal_substring (const DBusString *a,
2235 const DBusString *b,
2238 const unsigned char *ap;
2239 const unsigned char *bp;
2240 const unsigned char *a_end;
2241 const DBusRealString *real_a = (const DBusRealString*) a;
2242 const DBusRealString *real_b = (const DBusRealString*) b;
2243 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2244 DBUS_GENERIC_STRING_PREAMBLE (real_b);
2245 _dbus_assert (a_start >= 0);
2246 _dbus_assert (a_len >= 0);
2247 _dbus_assert (a_start <= real_a->len);
2248 _dbus_assert (a_len <= real_a->len - a_start);
2249 _dbus_assert (b_start >= 0);
2250 _dbus_assert (b_start <= real_b->len);
2252 if (a_len > real_b->len - b_start)
2255 ap = real_a->str + a_start;
2256 bp = real_b->str + b_start;
2267 _dbus_assert (bp <= (real_b->str + real_b->len));
2273 * Checks whether a string is equal to a C string.
2275 * @param a the string
2276 * @param c_str the C string
2277 * @returns #TRUE if equal
2280 _dbus_string_equal_c_str (const DBusString *a,
2283 const unsigned char *ap;
2284 const unsigned char *bp;
2285 const unsigned char *a_end;
2286 const DBusRealString *real_a = (const DBusRealString*) a;
2287 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2288 _dbus_assert (c_str != NULL);
2291 bp = (const unsigned char*) c_str;
2292 a_end = real_a->str + real_a->len;
2293 while (ap != a_end && *bp)
2302 if (ap != a_end || *bp)
2308 #ifdef DBUS_BUILD_TESTS
2310 * Checks whether a string starts with the given C string.
2312 * @param a the string
2313 * @param c_str the C string
2314 * @returns #TRUE if string starts with it
2317 _dbus_string_starts_with_c_str (const DBusString *a,
2320 const unsigned char *ap;
2321 const unsigned char *bp;
2322 const unsigned char *a_end;
2323 const DBusRealString *real_a = (const DBusRealString*) a;
2324 DBUS_GENERIC_STRING_PREAMBLE (real_a);
2325 _dbus_assert (c_str != NULL);
2328 bp = (const unsigned char*) c_str;
2329 a_end = real_a->str + real_a->len;
2330 while (ap != a_end && *bp)
2344 #endif /* DBUS_BUILD_TESTS */
2347 * Appends a two-character hex digit to a string, where the hex digit
2348 * has the value of the given byte.
2350 * @param str the string
2351 * @param byte the byte
2352 * @returns #FALSE if no memory
2355 _dbus_string_append_byte_as_hex (DBusString *str,
2358 const char hexdigits[16] = {
2359 '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
2360 'a', 'b', 'c', 'd', 'e', 'f'
2363 if (!_dbus_string_append_byte (str,
2364 hexdigits[(byte >> 4)]))
2367 if (!_dbus_string_append_byte (str,
2368 hexdigits[(byte & 0x0f)]))
2370 _dbus_string_set_length (str,
2371 _dbus_string_get_length (str) - 1);
2379 * Encodes a string in hex, the way MD5 and SHA-1 are usually
2380 * encoded. (Each byte is two hex digits.)
2382 * @param source the string to encode
2383 * @param start byte index to start encoding
2384 * @param dest string where encoded data should be placed
2385 * @param insert_at where to place encoded data
2386 * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2389 _dbus_string_hex_encode (const DBusString *source,
2395 const unsigned char *p;
2396 const unsigned char *end;
2399 _dbus_assert (start <= _dbus_string_get_length (source));
2401 if (!_dbus_string_init (&result))
2406 p = (const unsigned char*) _dbus_string_get_const_data (source);
2407 end = p + _dbus_string_get_length (source);
2412 if (!_dbus_string_append_byte_as_hex (&result, *p))
2418 if (!_dbus_string_move (&result, 0, dest, insert_at))
2424 _dbus_string_free (&result);
2429 * Decodes a string from hex encoding.
2431 * @param source the string to decode
2432 * @param start byte index to start decode
2433 * @param end_return return location of the end of the hex data, or #NULL
2434 * @param dest string where decoded data should be placed
2435 * @param insert_at where to place decoded data
2436 * @returns #TRUE if decoding was successful, #FALSE if no memory.
2439 _dbus_string_hex_decode (const DBusString *source,
2446 const unsigned char *p;
2447 const unsigned char *end;
2449 dbus_bool_t high_bits;
2451 _dbus_assert (start <= _dbus_string_get_length (source));
2453 if (!_dbus_string_init (&result))
2459 p = (const unsigned char*) _dbus_string_get_const_data (source);
2460 end = p + _dbus_string_get_length (source);
2529 if (!_dbus_string_append_byte (&result,
2538 len = _dbus_string_get_length (&result);
2540 b = _dbus_string_get_byte (&result, len - 1);
2544 _dbus_string_set_byte (&result, len - 1, b);
2547 high_bits = !high_bits;
2553 if (!_dbus_string_move (&result, 0, dest, insert_at))
2557 *end_return = p - (const unsigned char*) _dbus_string_get_const_data (source);
2562 _dbus_string_free (&result);
2567 * Checks that the given range of the string is valid ASCII with no
2568 * nul bytes. If the given range is not entirely contained in the
2569 * string, returns #FALSE.
2571 * @todo this is inconsistent with most of DBusString in that
2572 * it allows a start,len range that extends past the string end.
2574 * @param str the string
2575 * @param start first byte index to check
2576 * @param len number of bytes to check
2577 * @returns #TRUE if the byte range exists and is all valid ASCII
2580 _dbus_string_validate_ascii (const DBusString *str,
2584 const unsigned char *s;
2585 const unsigned char *end;
2586 DBUS_CONST_STRING_PREAMBLE (str);
2587 _dbus_assert (start >= 0);
2588 _dbus_assert (start <= real->len);
2589 _dbus_assert (len >= 0);
2591 if (len > real->len - start)
2594 s = real->str + start;
2598 if (_DBUS_UNLIKELY (!_DBUS_ISASCII (*s)))
2608 * Checks that the given range of the string is valid UTF-8. If the
2609 * given range is not entirely contained in the string, returns
2610 * #FALSE. If the string contains any nul bytes in the given range,
2611 * returns #FALSE. If the start and start+len are not on character
2612 * boundaries, returns #FALSE.
2614 * @todo this is inconsistent with most of DBusString in that
2615 * it allows a start,len range that extends past the string end.
2617 * @param str the string
2618 * @param start first byte index to check
2619 * @param len number of bytes to check
2620 * @returns #TRUE if the byte range exists and is all valid UTF-8
2623 _dbus_string_validate_utf8 (const DBusString *str,
2627 const unsigned char *p;
2628 const unsigned char *end;
2629 DBUS_CONST_STRING_PREAMBLE (str);
2630 _dbus_assert (start >= 0);
2631 _dbus_assert (start <= real->len);
2632 _dbus_assert (len >= 0);
2634 /* we are doing _DBUS_UNLIKELY() here which might be
2635 * dubious in a generic library like GLib, but in D-Bus
2636 * we know we're validating messages and that it would
2637 * only be evil/broken apps that would have invalid
2638 * UTF-8. Also, this function seems to be a performance
2639 * bottleneck in profiles.
2642 if (_DBUS_UNLIKELY (len > real->len - start))
2645 p = real->str + start;
2650 int i, mask, char_len;
2651 dbus_unichar_t result;
2653 /* nul bytes considered invalid */
2657 /* Special-case ASCII; this makes us go a lot faster in
2658 * D-Bus profiles where we are typically validating
2659 * function names and such. We have to know that
2660 * all following checks will pass for ASCII though,
2661 * comments follow ...
2669 UTF8_COMPUTE (*p, mask, char_len);
2671 if (_DBUS_UNLIKELY (char_len == 0)) /* ASCII: char_len == 1 */
2674 /* check that the expected number of bytes exists in the remaining length */
2675 if (_DBUS_UNLIKELY ((end - p) < char_len)) /* ASCII: p < end and char_len == 1 */
2678 UTF8_GET (result, p, i, mask, char_len);
2680 /* Check for overlong UTF-8 */
2681 if (_DBUS_UNLIKELY (UTF8_LENGTH (result) != char_len)) /* ASCII: UTF8_LENGTH == 1 */
2684 /* The UNICODE_VALID check below will catch this */
2685 if (_DBUS_UNLIKELY (result == (dbus_unichar_t)-1)) /* ASCII: result = ascii value */
2689 if (_DBUS_UNLIKELY (!UNICODE_VALID (result))) /* ASCII: always valid */
2692 /* UNICODE_VALID should have caught it */
2693 _dbus_assert (result != (dbus_unichar_t)-1);
2698 /* See that we covered the entire length if a length was
2701 if (_DBUS_UNLIKELY (p != end))
2708 * Checks that the given range of the string is all nul bytes. If the
2709 * given range is not entirely contained in the string, returns
2712 * @todo this is inconsistent with most of DBusString in that
2713 * it allows a start,len range that extends past the string end.
2715 * @param str the string
2716 * @param start first byte index to check
2717 * @param len number of bytes to check
2718 * @returns #TRUE if the byte range exists and is all nul bytes
2721 _dbus_string_validate_nul (const DBusString *str,
2725 const unsigned char *s;
2726 const unsigned char *end;
2727 DBUS_CONST_STRING_PREAMBLE (str);
2728 _dbus_assert (start >= 0);
2729 _dbus_assert (len >= 0);
2730 _dbus_assert (start <= real->len);
2732 if (len > real->len - start)
2735 s = real->str + start;
2739 if (_DBUS_UNLIKELY (*s != '\0'))
2748 * Clears all allocated bytes in the string to zero.
2750 * @param str the string
2753 _dbus_string_zero (DBusString *str)
2755 DBUS_STRING_PREAMBLE (str);
2757 memset (real->str - real->align_offset, '\0', real->allocated);
2761 /* tests are in dbus-string-util.c */