Remove unused _dbus_string_append_4_aligned, _dbus_string_append_8_aligned
[platform/upstream/dbus.git] / dbus / dbus-string.c
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-string.c String utility class (internal to D-Bus implementation)
3  * 
4  * Copyright (C) 2002, 2003, 2004, 2005 Red Hat, Inc.
5  * Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
6  *
7  * Licensed under the Academic Free License version 2.1
8  * 
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  * 
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22  *
23  */
24
25 #include <config.h>
26 #include "dbus-internals.h"
27 #include "dbus-string.h"
28 /* we allow a system header here, for speed/convenience */
29 #include <string.h>
30 /* for vsnprintf */
31 #include <stdio.h>
32 #define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
33 #include "dbus-string-private.h"
34 #include "dbus-marshal-basic.h" /* probably should be removed by moving the usage of DBUS_TYPE
35                                  * into the marshaling-related files
36                                  */
37 /* for DBUS_VA_COPY */
38 #include "dbus-sysdeps.h"
39
40 /**
41  * @defgroup DBusString DBusString class
42  * @ingroup  DBusInternals
43  * @brief DBusString data structure for safer string handling
44  *
45  * Types and functions related to DBusString. DBusString is intended
46  * to be a string class that makes it hard to mess up security issues
47  * (and just in general harder to write buggy code).  It should be
48  * used (or extended and then used) rather than the libc stuff in
49  * string.h.  The string class is a bit inconvenient at spots because
50  * it handles out-of-memory failures and tries to be extra-robust.
51  * 
52  * A DBusString has a maximum length set at initialization time; this
53  * can be used to ensure that a buffer doesn't get too big.  The
54  * _dbus_string_lengthen() method checks for overflow, and for max
55  * length being exceeded.
56  * 
57  * Try to avoid conversion to a plain C string, i.e. add methods on
58  * the string object instead, only convert to C string when passing
59  * things out to the public API. In particular, no sprintf, strcpy,
60  * strcat, any of that should be used. The GString feature of
61  * accepting negative numbers for "length of string" is also absent,
62  * because it could keep us from detecting bogus huge lengths. i.e. if
63  * we passed in some bogus huge length it would be taken to mean
64  * "current length of string" instead of "broken crack"
65  *
66  * @todo #DBusString needs a lot of cleaning up; some of the
67  * API is no longer used, and the API is pretty inconsistent.
68  * In particular all the "append" APIs, especially those involving
69  * alignment but probably lots of them, are no longer used by the
70  * marshaling code which always does "inserts" now.
71  */
72
73 /**
74  * @addtogroup DBusString
75  * @{
76  */
77
78 static void
79 fixup_alignment (DBusRealString *real)
80 {
81   unsigned char *aligned;
82   unsigned char *real_block;
83   unsigned int old_align_offset;
84
85   /* we have to have extra space in real->allocated for the align offset and nul byte */
86   _dbus_assert (real->len <= real->allocated - _DBUS_STRING_ALLOCATION_PADDING);
87   
88   old_align_offset = real->align_offset;
89   real_block = real->str - old_align_offset;
90   
91   aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);
92
93   real->align_offset = aligned - real_block;
94   real->str = aligned;
95   
96   if (old_align_offset != real->align_offset)
97     {
98       /* Here comes the suck */
99       memmove (real_block + real->align_offset,
100                real_block + old_align_offset,
101                real->len + 1);
102     }
103
104   _dbus_assert (real->align_offset < 8);
105   _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
106 }
107
108 static void
109 undo_alignment (DBusRealString *real)
110 {
111   if (real->align_offset != 0)
112     {
113       memmove (real->str - real->align_offset,
114                real->str,
115                real->len + 1);
116
117       real->str = real->str - real->align_offset;
118       real->align_offset = 0;
119     }
120 }
121
122 /**
123  * Initializes a string that can be up to the given allocation size
124  * before it has to realloc. The string starts life with zero length.
125  * The string must eventually be freed with _dbus_string_free().
126  * 
127  * @param str memory to hold the string
128  * @param allocate_size amount to preallocate
129  * @returns #TRUE on success, #FALSE if no memory
130  */
131 dbus_bool_t
132 _dbus_string_init_preallocated (DBusString *str,
133                                 int         allocate_size)
134 {
135   DBusRealString *real;
136   
137   _dbus_assert (str != NULL);
138
139   _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
140   
141   real = (DBusRealString*) str;
142
143   /* It's very important not to touch anything
144    * other than real->str if we're going to fail,
145    * since we also use this function to reset
146    * an existing string, e.g. in _dbus_string_steal_data()
147    */
148   
149   real->str = dbus_malloc (_DBUS_STRING_ALLOCATION_PADDING + allocate_size);
150   if (real->str == NULL)
151     return FALSE;  
152   
153   real->allocated = _DBUS_STRING_ALLOCATION_PADDING + allocate_size;
154   real->len = 0;
155   real->str[real->len] = '\0';
156   
157   real->constant = FALSE;
158   real->locked = FALSE;
159   real->invalid = FALSE;
160   real->align_offset = 0;
161   
162   fixup_alignment (real);
163   
164   return TRUE;
165 }
166
167 /**
168  * Initializes a string. The string starts life with zero length.  The
169  * string must eventually be freed with _dbus_string_free().
170  * 
171  * @param str memory to hold the string
172  * @returns #TRUE on success, #FALSE if no memory
173  */
174 dbus_bool_t
175 _dbus_string_init (DBusString *str)
176 {
177   return _dbus_string_init_preallocated (str, 0);
178 }
179
180 /**
181  * Initializes a constant string. The value parameter is not copied
182  * (should be static), and the string may never be modified.
183  * It is safe but not necessary to call _dbus_string_free()
184  * on a const string. The string has a length limit of MAXINT - 8.
185  * 
186  * @param str memory to use for the string
187  * @param value a string to be stored in str (not copied!!!)
188  */
189 void
190 _dbus_string_init_const (DBusString *str,
191                          const char *value)
192 {
193   _dbus_assert (value != NULL);
194   
195   _dbus_string_init_const_len (str, value,
196                                strlen (value));
197 }
198
199 /**
200  * Initializes a constant string with a length. The value parameter is
201  * not copied (should be static), and the string may never be
202  * modified.  It is safe but not necessary to call _dbus_string_free()
203  * on a const string.
204  * 
205  * @param str memory to use for the string
206  * @param value a string to be stored in str (not copied!!!)
207  * @param len the length to use
208  */
209 void
210 _dbus_string_init_const_len (DBusString *str,
211                              const char *value,
212                              int         len)
213 {
214   DBusRealString *real;
215   
216   _dbus_assert (str != NULL);
217   _dbus_assert (len == 0 || value != NULL);
218   _dbus_assert (len <= _DBUS_STRING_MAX_LENGTH);
219   _dbus_assert (len >= 0);
220   
221   real = (DBusRealString*) str;
222   
223   real->str = (unsigned char*) value;
224   real->len = len;
225   real->allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
226   real->constant = TRUE;
227   real->locked = TRUE;
228   real->invalid = FALSE;
229   real->align_offset = 0;
230
231   /* We don't require const strings to be 8-byte aligned as the
232    * memory is coming from elsewhere.
233    */
234 }
235
236 /**
237  * Frees a string created by _dbus_string_init().
238  *
239  * @param str memory where the string is stored.
240  */
241 void
242 _dbus_string_free (DBusString *str)
243 {
244   DBusRealString *real = (DBusRealString*) str;
245   DBUS_GENERIC_STRING_PREAMBLE (real);
246   
247   if (real->constant)
248     return;
249   dbus_free (real->str - real->align_offset);
250
251   real->invalid = TRUE;
252 }
253
254 static dbus_bool_t
255 compact (DBusRealString *real,
256          int             max_waste)
257 {
258   unsigned char *new_str;
259   int new_allocated;
260   int waste;
261
262   waste = real->allocated - (real->len + _DBUS_STRING_ALLOCATION_PADDING);
263
264   if (waste <= max_waste)
265     return TRUE;
266
267   new_allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING;
268
269   new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
270   if (_DBUS_UNLIKELY (new_str == NULL))
271     return FALSE;
272
273   real->str = new_str + real->align_offset;
274   real->allocated = new_allocated;
275   fixup_alignment (real);
276
277   return TRUE;
278 }
279
280 #ifdef DBUS_BUILD_TESTS
281 /* Not using this feature at the moment,
282  * so marked DBUS_BUILD_TESTS-only
283  */
284 /**
285  * Locks a string such that any attempts to change the string will
286  * result in aborting the program. Also, if the string is wasting a
287  * lot of memory (allocation is sufficiently larger than what the
288  * string is really using), _dbus_string_lock() will realloc the
289  * string's data to "compact" it.
290  *
291  * @param str the string to lock.
292  */
293 void
294 _dbus_string_lock (DBusString *str)
295 {  
296   DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
297
298   real->locked = TRUE;
299
300   /* Try to realloc to avoid excess memory usage, since
301    * we know we won't change the string further
302    */
303 #define MAX_WASTE 48
304   compact (real, MAX_WASTE);
305 }
306 #endif /* DBUS_BUILD_TESTS */
307
308 static dbus_bool_t
309 reallocate_for_length (DBusRealString *real,
310                        int             new_length)
311 {
312   int new_allocated;
313   unsigned char *new_str;
314
315   /* at least double our old allocation to avoid O(n), avoiding
316    * overflow
317    */
318   if (real->allocated > (_DBUS_STRING_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING) / 2)
319     new_allocated = _DBUS_STRING_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING;
320   else
321     new_allocated = real->allocated * 2;
322
323   /* if you change the code just above here, run the tests without
324    * the following assert-only hack before you commit
325    */
326   /* This is keyed off asserts in addition to tests so when you
327    * disable asserts to profile, you don't get this destroyer
328    * of profiles.
329    */
330 #ifdef DBUS_DISABLE_ASSERT
331 #else
332 #ifdef DBUS_BUILD_TESTS
333   new_allocated = 0; /* ensure a realloc every time so that we go
334                       * through all malloc failure codepaths
335                       */
336 #endif /* DBUS_BUILD_TESTS */
337 #endif /* !DBUS_DISABLE_ASSERT */
338
339   /* But be sure we always alloc at least space for the new length */
340   new_allocated = MAX (new_allocated,
341                        new_length + _DBUS_STRING_ALLOCATION_PADDING);
342
343   _dbus_assert (new_allocated >= real->allocated); /* code relies on this */
344   new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
345   if (_DBUS_UNLIKELY (new_str == NULL))
346     return FALSE;
347
348   real->str = new_str + real->align_offset;
349   real->allocated = new_allocated;
350   fixup_alignment (real);
351
352   return TRUE;
353 }
354
355 /**
356  * Compacts the string to avoid wasted memory.  Wasted memory is
357  * memory that is allocated but not actually required to store the
358  * current length of the string.  The compact is only done if more
359  * than the given amount of memory is being wasted (otherwise the
360  * waste is ignored and the call does nothing).
361  *
362  * @param str the string
363  * @param max_waste the maximum amount of waste to ignore
364  * @returns #FALSE if the compact failed due to realloc failure
365  */
366 dbus_bool_t
367 _dbus_string_compact (DBusString *str,
368                       int         max_waste)
369 {
370   DBUS_STRING_PREAMBLE (str);
371
372   return compact (real, max_waste);
373 }
374
375 static dbus_bool_t
376 set_length (DBusRealString *real,
377             int             new_length)
378 {
379   /* Note, we are setting the length not including nul termination */
380
381   /* exceeding max length is the same as failure to allocate memory */
382   if (_DBUS_UNLIKELY (new_length > _DBUS_STRING_MAX_LENGTH))
383     return FALSE;
384   else if (new_length > (real->allocated - _DBUS_STRING_ALLOCATION_PADDING) &&
385            _DBUS_UNLIKELY (!reallocate_for_length (real, new_length)))
386     return FALSE;
387   else
388     {
389       real->len = new_length;
390       real->str[new_length] = '\0';
391       return TRUE;
392     }
393 }
394
395 static dbus_bool_t
396 open_gap (int             len,
397           DBusRealString *dest,
398           int             insert_at)
399 {
400   if (len == 0)
401     return TRUE;
402
403   if (len > _DBUS_STRING_MAX_LENGTH - dest->len)
404     return FALSE; /* detected overflow of dest->len + len below */
405   
406   if (!set_length (dest, dest->len + len))
407     return FALSE;
408
409   memmove (dest->str + insert_at + len, 
410            dest->str + insert_at,
411            dest->len - len - insert_at);
412
413   return TRUE;
414 }
415
416 #ifndef _dbus_string_get_data
417 /**
418  * Gets the raw character buffer from the string.  The returned buffer
419  * will be nul-terminated, but note that strings may contain binary
420  * data so there may be extra nul characters prior to the termination.
421  * This function should be little-used, extend DBusString or add
422  * stuff to dbus-sysdeps.c instead. It's an error to use this
423  * function on a const string.
424  *
425  * @param str the string
426  * @returns the data
427  */
428 char*
429 _dbus_string_get_data (DBusString *str)
430 {
431   DBUS_STRING_PREAMBLE (str);
432   
433   return (char*) real->str;
434 }
435 #endif /* _dbus_string_get_data */
436
437 /* only do the function if we don't have the macro */
438 #ifndef _dbus_string_get_const_data
439 /**
440  * Gets the raw character buffer from a const string.
441  *
442  * @param str the string
443  * @returns the string data
444  */
445 const char*
446 _dbus_string_get_const_data (const DBusString  *str)
447 {
448   DBUS_CONST_STRING_PREAMBLE (str);
449   
450   return (const char*) real->str;
451 }
452 #endif /* _dbus_string_get_const_data */
453
454 /**
455  * Gets a sub-portion of the raw character buffer from the
456  * string. The "len" field is required simply for error
457  * checking, to be sure you don't try to use more
458  * string than exists. The nul termination of the
459  * returned buffer remains at the end of the entire
460  * string, not at start + len.
461  *
462  * @param str the string
463  * @param start byte offset to return
464  * @param len length of segment to return
465  * @returns the string data
466  */
467 char*
468 _dbus_string_get_data_len (DBusString *str,
469                            int         start,
470                            int         len)
471 {
472   DBUS_STRING_PREAMBLE (str);
473   _dbus_assert (start >= 0);
474   _dbus_assert (len >= 0);
475   _dbus_assert (start <= real->len);
476   _dbus_assert (len <= real->len - start);
477   
478   return (char*) real->str + start;
479 }
480
481 /* only do the function if we don't have the macro */
482 #ifndef _dbus_string_get_const_data_len
483 /**
484  * const version of _dbus_string_get_data_len().
485  *
486  * @param str the string
487  * @param start byte offset to return
488  * @param len length of segment to return
489  * @returns the string data
490  */
491 const char*
492 _dbus_string_get_const_data_len (const DBusString  *str,
493                                  int                start,
494                                  int                len)
495 {
496   DBUS_CONST_STRING_PREAMBLE (str);
497   _dbus_assert (start >= 0);
498   _dbus_assert (len >= 0);
499   _dbus_assert (start <= real->len);
500   _dbus_assert (len <= real->len - start);
501   
502   return (const char*) real->str + start;
503 }
504 #endif /* _dbus_string_get_const_data_len */
505
506 /* only do the function if we don't have the macro */
507 #ifndef _dbus_string_set_byte
508 /**
509  * Sets the value of the byte at the given position.
510  *
511  * @param str the string
512  * @param i the position
513  * @param byte the new value
514  */
515 void
516 _dbus_string_set_byte (DBusString    *str,
517                        int            i,
518                        unsigned char  byte)
519 {
520   DBUS_STRING_PREAMBLE (str);
521   _dbus_assert (i < real->len);
522   _dbus_assert (i >= 0);
523   
524   real->str[i] = byte;
525 }
526 #endif /* _dbus_string_set_byte */
527
528 /* only have the function if we didn't create a macro */
529 #ifndef _dbus_string_get_byte
530 /**
531  * Gets the byte at the given position. It is
532  * allowed to ask for the nul byte at the end of
533  * the string.
534  *
535  * @param str the string
536  * @param start the position
537  * @returns the byte at that position
538  */
539 unsigned char
540 _dbus_string_get_byte (const DBusString  *str,
541                        int                start)
542 {
543   DBUS_CONST_STRING_PREAMBLE (str);
544   _dbus_assert (start <= real->len);
545   _dbus_assert (start >= 0);
546   
547   return real->str[start];
548 }
549 #endif /* _dbus_string_get_byte */
550
551 /**
552  * Inserts a number of bytes of a given value at the
553  * given position.
554  *
555  * @param str the string
556  * @param i the position
557  * @param n_bytes number of bytes
558  * @param byte the value to insert
559  * @returns #TRUE on success
560  */
561 dbus_bool_t
562 _dbus_string_insert_bytes (DBusString   *str,
563                            int           i,
564                            int           n_bytes,
565                            unsigned char byte)
566 {
567   DBUS_STRING_PREAMBLE (str);
568   _dbus_assert (i <= real->len);
569   _dbus_assert (i >= 0);
570   _dbus_assert (n_bytes >= 0);
571
572   if (n_bytes == 0)
573     return TRUE;
574   
575   if (!open_gap (n_bytes, real, i))
576     return FALSE;
577   
578   memset (real->str + i, byte, n_bytes);
579
580   return TRUE;
581 }
582
583 /**
584  * Inserts a single byte at the given position.
585  *
586  * @param str the string
587  * @param i the position
588  * @param byte the value to insert
589  * @returns #TRUE on success
590  */
591 dbus_bool_t
592 _dbus_string_insert_byte (DBusString   *str,
593                            int           i,
594                            unsigned char byte)
595 {
596   DBUS_STRING_PREAMBLE (str);
597   _dbus_assert (i <= real->len);
598   _dbus_assert (i >= 0);
599   
600   if (!open_gap (1, real, i))
601     return FALSE;
602
603   real->str[i] = byte;
604
605   return TRUE;
606 }
607
608 /**
609  * Like _dbus_string_get_data(), but removes the
610  * gotten data from the original string. The caller
611  * must free the data returned. This function may
612  * fail due to lack of memory, and return #FALSE.
613  *
614  * @param str the string
615  * @param data_return location to return the buffer
616  * @returns #TRUE on success
617  */
618 dbus_bool_t
619 _dbus_string_steal_data (DBusString        *str,
620                          char             **data_return)
621 {
622   DBUS_STRING_PREAMBLE (str);
623   _dbus_assert (data_return != NULL);
624
625   undo_alignment (real);
626   
627   *data_return = (char*) real->str;
628
629   /* reset the string */
630   if (!_dbus_string_init (str))
631     {
632       /* hrm, put it back then */
633       real->str = (unsigned char*) *data_return;
634       *data_return = NULL;
635       fixup_alignment (real);
636       return FALSE;
637     }
638
639   return TRUE;
640 }
641
642 /**
643  * Copies the data from the string into a char*
644  *
645  * @param str the string
646  * @param data_return place to return the data
647  * @returns #TRUE on success, #FALSE on no memory
648  */
649 dbus_bool_t
650 _dbus_string_copy_data (const DBusString  *str,
651                         char             **data_return)
652 {
653   DBUS_CONST_STRING_PREAMBLE (str);
654   _dbus_assert (data_return != NULL);
655   
656   *data_return = dbus_malloc (real->len + 1);
657   if (*data_return == NULL)
658     return FALSE;
659
660   memcpy (*data_return, real->str, real->len + 1);
661
662   return TRUE;
663 }
664
665 /**
666  * Copies the contents of a DBusString into a different buffer. It is
667  * a bug if avail_len is too short to hold the string contents. nul
668  * termination is not copied, just the supplied bytes.
669  * 
670  * @param str a string
671  * @param buffer a C buffer to copy data to
672  * @param avail_len maximum length of C buffer
673  */
674 void
675 _dbus_string_copy_to_buffer (const DBusString  *str,
676                              char              *buffer,
677                              int                avail_len)
678 {
679   DBUS_CONST_STRING_PREAMBLE (str);
680
681   _dbus_assert (avail_len >= 0);
682   _dbus_assert (avail_len >= real->len);
683   
684   memcpy (buffer, real->str, real->len);
685 }
686
687 /**
688  * Copies the contents of a DBusString into a different buffer. It is
689  * a bug if avail_len is too short to hold the string contents plus a
690  * nul byte. 
691  * 
692  * @param str a string
693  * @param buffer a C buffer to copy data to
694  * @param avail_len maximum length of C buffer
695  */
696 void
697 _dbus_string_copy_to_buffer_with_nul (const DBusString  *str,
698                                       char              *buffer,
699                                       int                avail_len)
700 {
701   DBUS_CONST_STRING_PREAMBLE (str);
702
703   _dbus_assert (avail_len >= 0);
704   _dbus_assert (avail_len > real->len);
705   
706   memcpy (buffer, real->str, real->len+1);
707 }
708
709 /* Only have the function if we don't have the macro */
710 #ifndef _dbus_string_get_length
711 /**
712  * Gets the length of a string (not including nul termination).
713  *
714  * @returns the length.
715  */
716 int
717 _dbus_string_get_length (const DBusString  *str)
718 {
719   DBUS_CONST_STRING_PREAMBLE (str);
720   
721   return real->len;
722 }
723 #endif /* !_dbus_string_get_length */
724
725 /**
726  * Makes a string longer by the given number of bytes.  Checks whether
727  * adding additional_length to the current length would overflow an
728  * integer, and checks for exceeding a string's max length.
729  * The new bytes are not initialized, other than nul-terminating
730  * the end of the string. The uninitialized bytes may contain
731  * nul bytes or other junk.
732  *
733  * @param str a string
734  * @param additional_length length to add to the string.
735  * @returns #TRUE on success.
736  */
737 dbus_bool_t
738 _dbus_string_lengthen (DBusString *str,
739                        int         additional_length)
740 {
741   DBUS_STRING_PREAMBLE (str);  
742   _dbus_assert (additional_length >= 0);
743
744   if (_DBUS_UNLIKELY (additional_length > _DBUS_STRING_MAX_LENGTH - real->len))
745     return FALSE; /* would overflow */
746   
747   return set_length (real,
748                      real->len + additional_length);
749 }
750
751 /**
752  * Makes a string shorter by the given number of bytes.
753  *
754  * @param str a string
755  * @param length_to_remove length to remove from the string.
756  */
757 void
758 _dbus_string_shorten (DBusString *str,
759                       int         length_to_remove)
760 {
761   DBUS_STRING_PREAMBLE (str);
762   _dbus_assert (length_to_remove >= 0);
763   _dbus_assert (length_to_remove <= real->len);
764
765   set_length (real,
766               real->len - length_to_remove);
767 }
768
769 /**
770  * Sets the length of a string. Can be used to truncate or lengthen
771  * the string. If the string is lengthened, the function may fail and
772  * return #FALSE. Newly-added bytes are not initialized, as with
773  * _dbus_string_lengthen().
774  *
775  * @param str a string
776  * @param length new length of the string.
777  * @returns #FALSE on failure.
778  */
779 dbus_bool_t
780 _dbus_string_set_length (DBusString *str,
781                          int         length)
782 {
783   DBUS_STRING_PREAMBLE (str);
784   _dbus_assert (length >= 0);
785
786   return set_length (real, length);
787 }
788
789 static dbus_bool_t
790 align_insert_point_then_open_gap (DBusString *str,
791                                   int        *insert_at_p,
792                                   int         alignment,
793                                   int         gap_size)
794 {
795   unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
796   unsigned long gap_pos;
797   int insert_at;
798   int delta;
799   DBUS_STRING_PREAMBLE (str);
800   _dbus_assert (alignment >= 1);
801   _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
802
803   insert_at = *insert_at_p;
804
805   _dbus_assert (insert_at <= real->len);
806   
807   gap_pos = _DBUS_ALIGN_VALUE (insert_at, alignment);
808   new_len = real->len + (gap_pos - insert_at) + gap_size;
809   
810   if (_DBUS_UNLIKELY (new_len > (unsigned long) _DBUS_STRING_MAX_LENGTH))
811     return FALSE;
812   
813   delta = new_len - real->len;
814   _dbus_assert (delta >= 0);
815
816   if (delta == 0) /* only happens if gap_size == 0 and insert_at is aligned already */
817     {
818       _dbus_assert (((unsigned long) *insert_at_p) == gap_pos);
819       return TRUE;
820     }
821
822   if (_DBUS_UNLIKELY (!open_gap (new_len - real->len,
823                                  real, insert_at)))
824     return FALSE;
825
826   /* nul the padding if we had to add any padding */
827   if (gap_size < delta)
828     {
829       memset (&real->str[insert_at], '\0',
830               gap_pos - insert_at);
831     }
832
833   *insert_at_p = gap_pos;
834   
835   return TRUE;
836 }
837
838 static dbus_bool_t
839 align_length_then_lengthen (DBusString *str,
840                             int         alignment,
841                             int         then_lengthen_by)
842 {
843   int insert_at;
844
845   insert_at = _dbus_string_get_length (str);
846   
847   return align_insert_point_then_open_gap (str,
848                                            &insert_at,
849                                            alignment, then_lengthen_by);
850 }
851
852 /**
853  * Align the length of a string to a specific alignment (typically 4 or 8)
854  * by appending nul bytes to the string.
855  *
856  * @param str a string
857  * @param alignment the alignment
858  * @returns #FALSE if no memory
859  */
860 dbus_bool_t
861 _dbus_string_align_length (DBusString *str,
862                            int         alignment)
863 {
864   return align_length_then_lengthen (str, alignment, 0);
865 }
866
867 /**
868  * Preallocate extra_bytes such that a future lengthening of the
869  * string by extra_bytes is guaranteed to succeed without an out of
870  * memory error.
871  *
872  * @param str a string
873  * @param extra_bytes bytes to alloc
874  * @returns #FALSE if no memory
875  */
876 dbus_bool_t
877 _dbus_string_alloc_space (DBusString        *str,
878                           int                extra_bytes)
879 {
880   if (!_dbus_string_lengthen (str, extra_bytes))
881     return FALSE;
882   _dbus_string_shorten (str, extra_bytes);
883
884   return TRUE;
885 }
886
887 static dbus_bool_t
888 append (DBusRealString *real,
889         const char     *buffer,
890         int             buffer_len)
891 {
892   if (buffer_len == 0)
893     return TRUE;
894
895   if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
896     return FALSE;
897
898   memcpy (real->str + (real->len - buffer_len),
899           buffer,
900           buffer_len);
901
902   return TRUE;
903 }
904
905 /**
906  * Appends a nul-terminated C-style string to a DBusString.
907  *
908  * @param str the DBusString
909  * @param buffer the nul-terminated characters to append
910  * @returns #FALSE if not enough memory.
911  */
912 dbus_bool_t
913 _dbus_string_append (DBusString *str,
914                      const char *buffer)
915 {
916   unsigned long buffer_len;
917   
918   DBUS_STRING_PREAMBLE (str);
919   _dbus_assert (buffer != NULL);
920   
921   buffer_len = strlen (buffer);
922   if (buffer_len > (unsigned long) _DBUS_STRING_MAX_LENGTH)
923     return FALSE;
924   
925   return append (real, buffer, buffer_len);
926 }
927
928 /** assign 2 bytes from one string to another */
929 #define ASSIGN_2_OCTETS(p, octets) \
930   *((dbus_uint16_t*)(p)) = *((dbus_uint16_t*)(octets));
931
932 /** assign 4 bytes from one string to another */
933 #define ASSIGN_4_OCTETS(p, octets) \
934   *((dbus_uint32_t*)(p)) = *((dbus_uint32_t*)(octets));
935
936 #ifdef DBUS_HAVE_INT64
937 /** assign 8 bytes from one string to another */
938 #define ASSIGN_8_OCTETS(p, octets) \
939   *((dbus_uint64_t*)(p)) = *((dbus_uint64_t*)(octets));
940 #else
941 /** assign 8 bytes from one string to another */
942 #define ASSIGN_8_OCTETS(p, octets)              \
943 do {                                            \
944   unsigned char *b;                             \
945                                                 \
946   b = p;                                        \
947                                                 \
948   *b++ = octets[0];                             \
949   *b++ = octets[1];                             \
950   *b++ = octets[2];                             \
951   *b++ = octets[3];                             \
952   *b++ = octets[4];                             \
953   *b++ = octets[5];                             \
954   *b++ = octets[6];                             \
955   *b++ = octets[7];                             \
956   _dbus_assert (b == p + 8);                    \
957 } while (0)
958 #endif /* DBUS_HAVE_INT64 */
959
960 /**
961  * Inserts 2 bytes aligned on a 2 byte boundary
962  * with any alignment padding initialized to 0.
963  *
964  * @param str the DBusString
965  * @param insert_at where to insert
966  * @param octets 2 bytes to insert
967  * @returns #FALSE if not enough memory.
968  */
969 dbus_bool_t
970 _dbus_string_insert_2_aligned (DBusString         *str,
971                                int                 insert_at,
972                                const unsigned char octets[4])
973 {
974   DBUS_STRING_PREAMBLE (str);
975   
976   if (!align_insert_point_then_open_gap (str, &insert_at, 2, 2))
977     return FALSE;
978
979   ASSIGN_2_OCTETS (real->str + insert_at, octets);
980
981   return TRUE;
982 }
983
984 /**
985  * Inserts 4 bytes aligned on a 4 byte boundary
986  * with any alignment padding initialized to 0.
987  *
988  * @param str the DBusString
989  * @param insert_at where to insert
990  * @param octets 4 bytes to insert
991  * @returns #FALSE if not enough memory.
992  */
993 dbus_bool_t
994 _dbus_string_insert_4_aligned (DBusString         *str,
995                                int                 insert_at,
996                                const unsigned char octets[4])
997 {
998   DBUS_STRING_PREAMBLE (str);
999   
1000   if (!align_insert_point_then_open_gap (str, &insert_at, 4, 4))
1001     return FALSE;
1002
1003   ASSIGN_4_OCTETS (real->str + insert_at, octets);
1004
1005   return TRUE;
1006 }
1007
1008 /**
1009  * Inserts 8 bytes aligned on an 8 byte boundary
1010  * with any alignment padding initialized to 0.
1011  *
1012  * @param str the DBusString
1013  * @param insert_at where to insert
1014  * @param octets 8 bytes to insert
1015  * @returns #FALSE if not enough memory.
1016  */
1017 dbus_bool_t
1018 _dbus_string_insert_8_aligned (DBusString         *str,
1019                                int                 insert_at,
1020                                const unsigned char octets[8])
1021 {
1022   DBUS_STRING_PREAMBLE (str);
1023   
1024   if (!align_insert_point_then_open_gap (str, &insert_at, 8, 8))
1025     return FALSE;
1026
1027   _dbus_assert (_DBUS_ALIGN_VALUE (insert_at, 8) == (unsigned) insert_at);
1028   
1029   ASSIGN_8_OCTETS (real->str + insert_at, octets);
1030
1031   return TRUE;
1032 }
1033
1034
1035 /**
1036  * Inserts padding at *insert_at such to align it to the given
1037  * boundary. Initializes the padding to nul bytes. Sets *insert_at
1038  * to the aligned position.
1039  *
1040  * @param str the DBusString
1041  * @param insert_at location to be aligned
1042  * @param alignment alignment boundary (1, 2, 4, or 8)
1043  * @returns #FALSE if not enough memory.
1044  */
1045 dbus_bool_t
1046 _dbus_string_insert_alignment (DBusString        *str,
1047                                int               *insert_at,
1048                                int                alignment)
1049 {
1050   DBUS_STRING_PREAMBLE (str);
1051   
1052   if (!align_insert_point_then_open_gap (str, insert_at, alignment, 0))
1053     return FALSE;
1054
1055   _dbus_assert (_DBUS_ALIGN_VALUE (*insert_at, alignment) == (unsigned) *insert_at);
1056
1057   return TRUE;
1058 }
1059
1060 /**
1061  * Appends a printf-style formatted string
1062  * to the #DBusString.
1063  *
1064  * @param str the string
1065  * @param format printf format
1066  * @param args variable argument list
1067  * @returns #FALSE if no memory
1068  */
1069 dbus_bool_t
1070 _dbus_string_append_printf_valist  (DBusString        *str,
1071                                     const char        *format,
1072                                     va_list            args)
1073 {
1074   int len;
1075   va_list args_copy;
1076
1077   DBUS_STRING_PREAMBLE (str);
1078
1079   DBUS_VA_COPY (args_copy, args);
1080
1081   /* Measure the message length without terminating nul */
1082   len = _dbus_printf_string_upper_bound (format, args);
1083
1084   if (len < 0)
1085     return FALSE;
1086
1087   if (!_dbus_string_lengthen (str, len))
1088     {
1089       /* don't leak the copy */
1090       va_end (args_copy);
1091       return FALSE;
1092     }
1093   
1094   vsprintf ((char*) (real->str + (real->len - len)),
1095             format, args_copy);
1096
1097   va_end (args_copy);
1098
1099   return TRUE;
1100 }
1101
1102 /**
1103  * Appends a printf-style formatted string
1104  * to the #DBusString.
1105  *
1106  * @param str the string
1107  * @param format printf format
1108  * @returns #FALSE if no memory
1109  */
1110 dbus_bool_t
1111 _dbus_string_append_printf (DBusString        *str,
1112                             const char        *format,
1113                             ...)
1114 {
1115   va_list args;
1116   dbus_bool_t retval;
1117   
1118   va_start (args, format);
1119   retval = _dbus_string_append_printf_valist (str, format, args);
1120   va_end (args);
1121
1122   return retval;
1123 }
1124
1125 /**
1126  * Appends block of bytes with the given length to a DBusString.
1127  *
1128  * @param str the DBusString
1129  * @param buffer the bytes to append
1130  * @param len the number of bytes to append
1131  * @returns #FALSE if not enough memory.
1132  */
1133 dbus_bool_t
1134 _dbus_string_append_len (DBusString *str,
1135                          const char *buffer,
1136                          int         len)
1137 {
1138   DBUS_STRING_PREAMBLE (str);
1139   _dbus_assert (buffer != NULL);
1140   _dbus_assert (len >= 0);
1141
1142   return append (real, buffer, len);
1143 }
1144
1145 /**
1146  * Appends a single byte to the string, returning #FALSE
1147  * if not enough memory.
1148  *
1149  * @param str the string
1150  * @param byte the byte to append
1151  * @returns #TRUE on success
1152  */
1153 dbus_bool_t
1154 _dbus_string_append_byte (DBusString    *str,
1155                           unsigned char  byte)
1156 {
1157   DBUS_STRING_PREAMBLE (str);
1158
1159   if (!set_length (real, real->len + 1))
1160     return FALSE;
1161
1162   real->str[real->len-1] = byte;
1163
1164   return TRUE;
1165 }
1166
1167 #ifdef DBUS_BUILD_TESTS
1168 /**
1169  * Appends a single Unicode character, encoding the character
1170  * in UTF-8 format.
1171  *
1172  * @param str the string
1173  * @param ch the Unicode character
1174  */
1175 dbus_bool_t
1176 _dbus_string_append_unichar (DBusString    *str,
1177                              dbus_unichar_t ch)
1178 {
1179   int len;
1180   int first;
1181   int i;
1182   unsigned char *out;
1183   
1184   DBUS_STRING_PREAMBLE (str);
1185
1186   /* this code is from GLib but is pretty standard I think */
1187   
1188   len = 0;
1189   
1190   if (ch < 0x80)
1191     {
1192       first = 0;
1193       len = 1;
1194     }
1195   else if (ch < 0x800)
1196     {
1197       first = 0xc0;
1198       len = 2;
1199     }
1200   else if (ch < 0x10000)
1201     {
1202       first = 0xe0;
1203       len = 3;
1204     }
1205    else if (ch < 0x200000)
1206     {
1207       first = 0xf0;
1208       len = 4;
1209     }
1210   else if (ch < 0x4000000)
1211     {
1212       first = 0xf8;
1213       len = 5;
1214     }
1215   else
1216     {
1217       first = 0xfc;
1218       len = 6;
1219     }
1220
1221   if (len > (_DBUS_STRING_MAX_LENGTH - real->len))
1222     return FALSE; /* real->len + len would overflow */
1223   
1224   if (!set_length (real, real->len + len))
1225     return FALSE;
1226
1227   out = real->str + (real->len - len);
1228   
1229   for (i = len - 1; i > 0; --i)
1230     {
1231       out[i] = (ch & 0x3f) | 0x80;
1232       ch >>= 6;
1233     }
1234   out[0] = ch | first;
1235
1236   return TRUE;
1237 }
1238 #endif /* DBUS_BUILD_TESTS */
1239
1240 static void
1241 delete (DBusRealString *real,
1242         int             start,
1243         int             len)
1244 {
1245   if (len == 0)
1246     return;
1247   
1248   memmove (real->str + start, real->str + start + len, real->len - (start + len));
1249   real->len -= len;
1250   real->str[real->len] = '\0';
1251 }
1252
1253 /**
1254  * Deletes a segment of a DBusString with length len starting at
1255  * start. (Hint: to clear an entire string, setting length to 0
1256  * with _dbus_string_set_length() is easier.)
1257  *
1258  * @param str the DBusString
1259  * @param start where to start deleting
1260  * @param len the number of bytes to delete
1261  */
1262 void
1263 _dbus_string_delete (DBusString       *str,
1264                      int               start,
1265                      int               len)
1266 {
1267   DBUS_STRING_PREAMBLE (str);
1268   _dbus_assert (start >= 0);
1269   _dbus_assert (len >= 0);
1270   _dbus_assert (start <= real->len);
1271   _dbus_assert (len <= real->len - start);
1272   
1273   delete (real, start, len);
1274 }
1275
1276 static dbus_bool_t
1277 copy (DBusRealString *source,
1278       int             start,
1279       int             len,
1280       DBusRealString *dest,
1281       int             insert_at)
1282 {
1283   if (len == 0)
1284     return TRUE;
1285
1286   if (!open_gap (len, dest, insert_at))
1287     return FALSE;
1288   
1289   memmove (dest->str + insert_at,
1290            source->str + start,
1291            len);
1292
1293   return TRUE;
1294 }
1295
1296 /**
1297  * Checks assertions for two strings we're copying a segment between,
1298  * and declares real_source/real_dest variables.
1299  *
1300  * @param source the source string
1301  * @param start the starting offset
1302  * @param dest the dest string
1303  * @param insert_at where the copied segment is inserted
1304  */
1305 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at)       \
1306   DBusRealString *real_source = (DBusRealString*) source;               \
1307   DBusRealString *real_dest = (DBusRealString*) dest;                   \
1308   _dbus_assert ((source) != (dest));                                    \
1309   DBUS_GENERIC_STRING_PREAMBLE (real_source);                           \
1310   DBUS_GENERIC_STRING_PREAMBLE (real_dest);                             \
1311   _dbus_assert (!real_dest->constant);                                  \
1312   _dbus_assert (!real_dest->locked);                                    \
1313   _dbus_assert ((start) >= 0);                                          \
1314   _dbus_assert ((start) <= real_source->len);                           \
1315   _dbus_assert ((insert_at) >= 0);                                      \
1316   _dbus_assert ((insert_at) <= real_dest->len)
1317
1318 /**
1319  * Moves the end of one string into another string. Both strings
1320  * must be initialized, valid strings.
1321  *
1322  * @param source the source string
1323  * @param start where to chop off the source string
1324  * @param dest the destination string
1325  * @param insert_at where to move the chopped-off part of source string
1326  * @returns #FALSE if not enough memory
1327  */
1328 dbus_bool_t
1329 _dbus_string_move (DBusString       *source,
1330                    int               start,
1331                    DBusString       *dest,
1332                    int               insert_at)
1333 {
1334   DBusRealString *real_source = (DBusRealString*) source;
1335   _dbus_assert (start <= real_source->len);
1336   
1337   return _dbus_string_move_len (source, start,
1338                                 real_source->len - start,
1339                                 dest, insert_at);
1340 }
1341
1342 /**
1343  * Like _dbus_string_move(), but does not delete the section
1344  * of the source string that's copied to the dest string.
1345  *
1346  * @param source the source string
1347  * @param start where to start copying the source string
1348  * @param dest the destination string
1349  * @param insert_at where to place the copied part of source string
1350  * @returns #FALSE if not enough memory
1351  */
1352 dbus_bool_t
1353 _dbus_string_copy (const DBusString *source,
1354                    int               start,
1355                    DBusString       *dest,
1356                    int               insert_at)
1357 {
1358   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1359
1360   return copy (real_source, start,
1361                real_source->len - start,
1362                real_dest,
1363                insert_at);
1364 }
1365
1366 /**
1367  * Like _dbus_string_move(), but can move a segment from
1368  * the middle of the source string.
1369  *
1370  * @param source the source string
1371  * @param start first byte of source string to move
1372  * @param len length of segment to move
1373  * @param dest the destination string
1374  * @param insert_at where to move the bytes from the source string
1375  * @returns #FALSE if not enough memory
1376  */
1377 dbus_bool_t
1378 _dbus_string_move_len (DBusString       *source,
1379                        int               start,
1380                        int               len,
1381                        DBusString       *dest,
1382                        int               insert_at)
1383
1384 {
1385   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1386   _dbus_assert (len >= 0);
1387   _dbus_assert ((start + len) <= real_source->len);
1388
1389
1390   if (len == 0)
1391     {
1392       return TRUE;
1393     }
1394   else if (start == 0 &&
1395            len == real_source->len &&
1396            real_dest->len == 0)
1397     {
1398       /* Short-circuit moving an entire existing string to an empty string
1399        * by just swapping the buffers.
1400        */
1401       /* we assume ->constant doesn't matter as you can't have
1402        * a constant string involved in a move.
1403        */
1404 #define ASSIGN_DATA(a, b) do {                  \
1405         (a)->str = (b)->str;                    \
1406         (a)->len = (b)->len;                    \
1407         (a)->allocated = (b)->allocated;        \
1408         (a)->align_offset = (b)->align_offset;  \
1409       } while (0)
1410       
1411       DBusRealString tmp;
1412
1413       ASSIGN_DATA (&tmp, real_source);
1414       ASSIGN_DATA (real_source, real_dest);
1415       ASSIGN_DATA (real_dest, &tmp);
1416
1417       return TRUE;
1418     }
1419   else
1420     {
1421       if (!copy (real_source, start, len,
1422                  real_dest,
1423                  insert_at))
1424         return FALSE;
1425       
1426       delete (real_source, start,
1427               len);
1428       
1429       return TRUE;
1430     }
1431 }
1432
1433 /**
1434  * Like _dbus_string_copy(), but can copy a segment from the middle of
1435  * the source string.
1436  *
1437  * @param source the source string
1438  * @param start where to start copying the source string
1439  * @param len length of segment to copy
1440  * @param dest the destination string
1441  * @param insert_at where to place the copied segment of source string
1442  * @returns #FALSE if not enough memory
1443  */
1444 dbus_bool_t
1445 _dbus_string_copy_len (const DBusString *source,
1446                        int               start,
1447                        int               len,
1448                        DBusString       *dest,
1449                        int               insert_at)
1450 {
1451   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1452   _dbus_assert (len >= 0);
1453   _dbus_assert (start <= real_source->len);
1454   _dbus_assert (len <= real_source->len - start);
1455   
1456   return copy (real_source, start, len,
1457                real_dest,
1458                insert_at);
1459 }
1460
1461 /**
1462  * Replaces a segment of dest string with a segment of source string.
1463  *
1464  * @param source the source string
1465  * @param start where to start copying the source string
1466  * @param len length of segment to copy
1467  * @param dest the destination string
1468  * @param replace_at start of segment of dest string to replace
1469  * @param replace_len length of segment of dest string to replace
1470  * @returns #FALSE if not enough memory
1471  *
1472  */
1473 dbus_bool_t
1474 _dbus_string_replace_len (const DBusString *source,
1475                           int               start,
1476                           int               len,
1477                           DBusString       *dest,
1478                           int               replace_at,
1479                           int               replace_len)
1480 {
1481   DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1482   _dbus_assert (len >= 0);
1483   _dbus_assert (start <= real_source->len);
1484   _dbus_assert (len <= real_source->len - start);
1485   _dbus_assert (replace_at >= 0);
1486   _dbus_assert (replace_at <= real_dest->len);
1487   _dbus_assert (replace_len <= real_dest->len - replace_at);
1488
1489   if (len == replace_len)
1490     {
1491       memmove (real_dest->str + replace_at,
1492                real_source->str + start, len);
1493     }
1494   else if (len < replace_len)
1495     {
1496       memmove (real_dest->str + replace_at,
1497                real_source->str + start, len);
1498       delete (real_dest, replace_at + len,
1499               replace_len - len);
1500     }
1501   else
1502     {
1503       int diff;
1504
1505       _dbus_assert (len > replace_len);
1506
1507       diff = len - replace_len;
1508
1509       /* First of all we check if destination string can be enlarged as
1510        * required, then we overwrite previous bytes
1511        */
1512
1513       if (!copy (real_source, start + replace_len, diff,
1514                  real_dest, replace_at + replace_len))
1515         return FALSE;
1516
1517       memmove (real_dest->str + replace_at,
1518                real_source->str + start, replace_len);
1519     }
1520
1521   return TRUE;
1522 }
1523
1524 /**
1525  * Looks for the first occurance of a byte, deletes that byte,
1526  * and moves everything after the byte to the beginning of a
1527  * separate string.  Both strings must be initialized, valid
1528  * strings.
1529  *
1530  * @param source the source string
1531  * @param byte the byte to remove and split the string at
1532  * @param tail the split off string
1533  * @returns #FALSE if not enough memory or if byte could not be found
1534  *
1535  */
1536 dbus_bool_t
1537 _dbus_string_split_on_byte (DBusString        *source,
1538                             unsigned char      byte,
1539                             DBusString        *tail)
1540 {
1541   int byte_position;
1542   char byte_string[2] = "";
1543   int head_length;
1544   int tail_length;
1545
1546   byte_string[0] = (char) byte;
1547
1548   if (!_dbus_string_find (source, 0, byte_string, &byte_position))
1549     return FALSE;
1550
1551   head_length = byte_position;
1552   tail_length = _dbus_string_get_length (source) - head_length - 1;
1553
1554   if (!_dbus_string_move_len (source, byte_position + 1, tail_length,
1555                               tail, 0))
1556     return FALSE;
1557
1558   /* remove the trailing delimiter byte from the head now.
1559    */
1560   if (!_dbus_string_set_length (source, head_length))
1561     return FALSE;
1562
1563   return TRUE;
1564 }
1565
1566 /* Unicode macros and utf8_validate() from GLib Owen Taylor, Havoc
1567  * Pennington, and Tom Tromey are the authors and authorized relicense.
1568  */
1569
1570 /** computes length and mask of a unicode character
1571  * @param Char the char
1572  * @param Mask the mask variable to assign to
1573  * @param Len the length variable to assign to
1574  */
1575 #define UTF8_COMPUTE(Char, Mask, Len)                                         \
1576   if (Char < 128)                                                             \
1577     {                                                                         \
1578       Len = 1;                                                                \
1579       Mask = 0x7f;                                                            \
1580     }                                                                         \
1581   else if ((Char & 0xe0) == 0xc0)                                             \
1582     {                                                                         \
1583       Len = 2;                                                                \
1584       Mask = 0x1f;                                                            \
1585     }                                                                         \
1586   else if ((Char & 0xf0) == 0xe0)                                             \
1587     {                                                                         \
1588       Len = 3;                                                                \
1589       Mask = 0x0f;                                                            \
1590     }                                                                         \
1591   else if ((Char & 0xf8) == 0xf0)                                             \
1592     {                                                                         \
1593       Len = 4;                                                                \
1594       Mask = 0x07;                                                            \
1595     }                                                                         \
1596   else if ((Char & 0xfc) == 0xf8)                                             \
1597     {                                                                         \
1598       Len = 5;                                                                \
1599       Mask = 0x03;                                                            \
1600     }                                                                         \
1601   else if ((Char & 0xfe) == 0xfc)                                             \
1602     {                                                                         \
1603       Len = 6;                                                                \
1604       Mask = 0x01;                                                            \
1605     }                                                                         \
1606   else                                                                        \
1607     {                                                                         \
1608       Len = 0;                                                               \
1609       Mask = 0;                                                               \
1610     }
1611
1612 /**
1613  * computes length of a unicode character in UTF-8
1614  * @param Char the char
1615  */
1616 #define UTF8_LENGTH(Char)              \
1617   ((Char) < 0x80 ? 1 :                 \
1618    ((Char) < 0x800 ? 2 :               \
1619     ((Char) < 0x10000 ? 3 :            \
1620      ((Char) < 0x200000 ? 4 :          \
1621       ((Char) < 0x4000000 ? 5 : 6)))))
1622    
1623 /**
1624  * Gets a UTF-8 value.
1625  *
1626  * @param Result variable for extracted unicode char.
1627  * @param Chars the bytes to decode
1628  * @param Count counter variable
1629  * @param Mask mask for this char
1630  * @param Len length for this char in bytes
1631  */
1632 #define UTF8_GET(Result, Chars, Count, Mask, Len)                             \
1633   (Result) = (Chars)[0] & (Mask);                                             \
1634   for ((Count) = 1; (Count) < (Len); ++(Count))                               \
1635     {                                                                         \
1636       if (((Chars)[(Count)] & 0xc0) != 0x80)                                  \
1637         {                                                                     \
1638           (Result) = -1;                                                      \
1639           break;                                                              \
1640         }                                                                     \
1641       (Result) <<= 6;                                                         \
1642       (Result) |= ((Chars)[(Count)] & 0x3f);                                  \
1643     }
1644
1645 /**
1646  * Check whether a Unicode (5.2) char is in a valid range.
1647  *
1648  * The first check comes from the Unicode guarantee to never encode
1649  * a point above 0x0010ffff, since UTF-16 couldn't represent it.
1650  *
1651  * The second check covers surrogate pairs (category Cs).
1652  *
1653  * The last two checks cover "Noncharacter": defined as:
1654  *   "A code point that is permanently reserved for
1655  *    internal use, and that should never be interchanged. In
1656  *    Unicode 3.1, these consist of the values U+nFFFE and U+nFFFF
1657  *    (where n is from 0 to 10_16) and the values U+FDD0..U+FDEF."
1658  *
1659  * @param Char the character
1660  */
1661 #define UNICODE_VALID(Char)                   \
1662     ((Char) < 0x110000 &&                     \
1663      (((Char) & 0xFFFFF800) != 0xD800) &&     \
1664      ((Char) < 0xFDD0 || (Char) > 0xFDEF) &&  \
1665      ((Char) & 0xFFFE) != 0xFFFE)
1666
1667 #ifdef DBUS_BUILD_TESTS
1668 /**
1669  * Gets a unicode character from a UTF-8 string. Does no validation;
1670  * you must verify that the string is valid UTF-8 in advance and must
1671  * pass in the start of a character.
1672  *
1673  * @param str the string
1674  * @param start the start of the UTF-8 character.
1675  * @param ch_return location to return the character
1676  * @param end_return location to return the byte index of next character
1677  */
1678 void
1679 _dbus_string_get_unichar (const DBusString *str,
1680                           int               start,
1681                           dbus_unichar_t   *ch_return,
1682                           int              *end_return)
1683 {
1684   int i, mask, len;
1685   dbus_unichar_t result;
1686   unsigned char c;
1687   unsigned char *p;
1688   DBUS_CONST_STRING_PREAMBLE (str);
1689   _dbus_assert (start >= 0);
1690   _dbus_assert (start <= real->len);
1691   
1692   if (ch_return)
1693     *ch_return = 0;
1694   if (end_return)
1695     *end_return = real->len;
1696   
1697   mask = 0;
1698   p = real->str + start;
1699   c = *p;
1700   
1701   UTF8_COMPUTE (c, mask, len);
1702   if (len == 0)
1703     return;
1704   UTF8_GET (result, p, i, mask, len);
1705
1706   if (result == (dbus_unichar_t)-1)
1707     return;
1708
1709   if (ch_return)
1710     *ch_return = result;
1711   if (end_return)
1712     *end_return = start + len;
1713 }
1714 #endif /* DBUS_BUILD_TESTS */
1715
1716 /**
1717  * Finds the given substring in the string,
1718  * returning #TRUE and filling in the byte index
1719  * where the substring was found, if it was found.
1720  * Returns #FALSE if the substring wasn't found.
1721  * Sets *start to the length of the string if the substring
1722  * is not found.
1723  *
1724  * @param str the string
1725  * @param start where to start looking
1726  * @param substr the substring
1727  * @param found return location for where it was found, or #NULL
1728  * @returns #TRUE if found
1729  */
1730 dbus_bool_t
1731 _dbus_string_find (const DBusString *str,
1732                    int               start,
1733                    const char       *substr,
1734                    int              *found)
1735 {
1736   return _dbus_string_find_to (str, start,
1737                                ((const DBusRealString*)str)->len,
1738                                substr, found);
1739 }
1740
1741 /**
1742  * Finds end of line ("\r\n" or "\n") in the string,
1743  * returning #TRUE and filling in the byte index
1744  * where the eol string was found, if it was found.
1745  * Returns #FALSE if eol wasn't found.
1746  *
1747  * @param str the string
1748  * @param start where to start looking
1749  * @param found return location for where eol was found or string length otherwise
1750  * @param found_len return length of found eol string or zero otherwise
1751  * @returns #TRUE if found
1752  */
1753 dbus_bool_t
1754 _dbus_string_find_eol (const DBusString *str,
1755                        int               start,
1756                        int              *found,
1757                        int              *found_len)
1758 {
1759   int i;
1760
1761   DBUS_CONST_STRING_PREAMBLE (str);
1762   _dbus_assert (start <= real->len);
1763   _dbus_assert (start >= 0);
1764   
1765   i = start;
1766   while (i < real->len)
1767     {
1768       if (real->str[i] == '\r') 
1769         {
1770           if ((i+1) < real->len && real->str[i+1] == '\n') /* "\r\n" */
1771             {
1772               if (found) 
1773                 *found = i;
1774               if (found_len)
1775                 *found_len = 2;
1776               return TRUE;
1777             } 
1778           else /* only "\r" */
1779             {
1780               if (found) 
1781                 *found = i;
1782               if (found_len)
1783                 *found_len = 1;
1784               return TRUE;
1785             }
1786         } 
1787       else if (real->str[i] == '\n')  /* only "\n" */
1788         {
1789           if (found) 
1790             *found = i;
1791           if (found_len)
1792             *found_len = 1;
1793           return TRUE;
1794         }
1795       ++i;
1796     }
1797
1798   if (found)
1799     *found = real->len;
1800
1801   if (found_len)
1802     *found_len = 0;
1803   
1804   return FALSE;
1805 }
1806
1807 /**
1808  * Finds the given substring in the string,
1809  * up to a certain position,
1810  * returning #TRUE and filling in the byte index
1811  * where the substring was found, if it was found.
1812  * Returns #FALSE if the substring wasn't found.
1813  * Sets *start to the length of the string if the substring
1814  * is not found.
1815  *
1816  * @param str the string
1817  * @param start where to start looking
1818  * @param end where to stop looking
1819  * @param substr the substring
1820  * @param found return location for where it was found, or #NULL
1821  * @returns #TRUE if found
1822  */
1823 dbus_bool_t
1824 _dbus_string_find_to (const DBusString *str,
1825                       int               start,
1826                       int               end,
1827                       const char       *substr,
1828                       int              *found)
1829 {
1830   int i;
1831   DBUS_CONST_STRING_PREAMBLE (str);
1832   _dbus_assert (substr != NULL);
1833   _dbus_assert (start <= real->len);
1834   _dbus_assert (start >= 0);
1835   _dbus_assert (substr != NULL);
1836   _dbus_assert (end <= real->len);
1837   _dbus_assert (start <= end);
1838
1839   /* we always "find" an empty string */
1840   if (*substr == '\0')
1841     {
1842       if (found)
1843         *found = start;
1844       return TRUE;
1845     }
1846
1847   i = start;
1848   while (i < end)
1849     {
1850       if (real->str[i] == substr[0])
1851         {
1852           int j = i + 1;
1853           
1854           while (j < end)
1855             {
1856               if (substr[j - i] == '\0')
1857                 break;
1858               else if (real->str[j] != substr[j - i])
1859                 break;
1860               
1861               ++j;
1862             }
1863
1864           if (substr[j - i] == '\0')
1865             {
1866               if (found)
1867                 *found = i;
1868               return TRUE;
1869             }
1870         }
1871       
1872       ++i;
1873     }
1874
1875   if (found)
1876     *found = end;
1877   
1878   return FALSE;  
1879 }
1880
1881 /**
1882  * Finds a blank (space or tab) in the string. Returns #TRUE
1883  * if found, #FALSE otherwise. If a blank is not found sets
1884  * *found to the length of the string.
1885  *
1886  * @param str the string
1887  * @param start byte index to start looking
1888  * @param found place to store the location of the first blank
1889  * @returns #TRUE if a blank was found
1890  */
1891 dbus_bool_t
1892 _dbus_string_find_blank (const DBusString *str,
1893                          int               start,
1894                          int              *found)
1895 {
1896   int i;
1897   DBUS_CONST_STRING_PREAMBLE (str);
1898   _dbus_assert (start <= real->len);
1899   _dbus_assert (start >= 0);
1900   
1901   i = start;
1902   while (i < real->len)
1903     {
1904       if (real->str[i] == ' ' ||
1905           real->str[i] == '\t')
1906         {
1907           if (found)
1908             *found = i;
1909           return TRUE;
1910         }
1911       
1912       ++i;
1913     }
1914
1915   if (found)
1916     *found = real->len;
1917   
1918   return FALSE;
1919 }
1920
1921 /**
1922  * Skips blanks from start, storing the first non-blank in *end
1923  * (blank is space or tab).
1924  *
1925  * @param str the string
1926  * @param start where to start
1927  * @param end where to store the first non-blank byte index
1928  */
1929 void
1930 _dbus_string_skip_blank (const DBusString *str,
1931                          int               start,
1932                          int              *end)
1933 {
1934   int i;
1935   DBUS_CONST_STRING_PREAMBLE (str);
1936   _dbus_assert (start <= real->len);
1937   _dbus_assert (start >= 0);
1938   
1939   i = start;
1940   while (i < real->len)
1941     {
1942       if (!DBUS_IS_ASCII_BLANK (real->str[i]))
1943         break;
1944       
1945       ++i;
1946     }
1947
1948   _dbus_assert (i == real->len || !DBUS_IS_ASCII_WHITE (real->str[i]));
1949   
1950   if (end)
1951     *end = i;
1952 }
1953
1954
1955 /**
1956  * Skips whitespace from start, storing the first non-whitespace in *end.
1957  * (whitespace is space, tab, newline, CR).
1958  *
1959  * @param str the string
1960  * @param start where to start
1961  * @param end where to store the first non-whitespace byte index
1962  */
1963 void
1964 _dbus_string_skip_white (const DBusString *str,
1965                          int               start,
1966                          int              *end)
1967 {
1968   int i;
1969   DBUS_CONST_STRING_PREAMBLE (str);
1970   _dbus_assert (start <= real->len);
1971   _dbus_assert (start >= 0);
1972   
1973   i = start;
1974   while (i < real->len)
1975     {
1976       if (!DBUS_IS_ASCII_WHITE (real->str[i]))
1977         break;
1978       
1979       ++i;
1980     }
1981
1982   _dbus_assert (i == real->len || !(DBUS_IS_ASCII_WHITE (real->str[i])));
1983   
1984   if (end)
1985     *end = i;
1986 }
1987
1988 /**
1989  * Skips whitespace from end, storing the start index of the trailing
1990  * whitespace in *start. (whitespace is space, tab, newline, CR).
1991  *
1992  * @param str the string
1993  * @param end where to start scanning backward
1994  * @param start where to store the start of whitespace chars
1995  */
1996 void
1997 _dbus_string_skip_white_reverse (const DBusString *str,
1998                                  int               end,
1999                                  int              *start)
2000 {
2001   int i;
2002   DBUS_CONST_STRING_PREAMBLE (str);
2003   _dbus_assert (end <= real->len);
2004   _dbus_assert (end >= 0);
2005   
2006   i = end;
2007   while (i > 0)
2008     {
2009       if (!DBUS_IS_ASCII_WHITE (real->str[i-1]))
2010         break;
2011       --i;
2012     }
2013
2014   _dbus_assert (i >= 0 && (i == 0 || !(DBUS_IS_ASCII_WHITE (real->str[i-1]))));
2015   
2016   if (start)
2017     *start = i;
2018 }
2019
2020 /**
2021  * Assigns a newline-terminated or \\r\\n-terminated line from the front
2022  * of the string to the given dest string. The dest string's previous
2023  * contents are deleted. If the source string contains no newline,
2024  * moves the entire source string to the dest string.
2025  *
2026  * @todo owen correctly notes that this is a stupid function (it was
2027  * written purely for test code,
2028  * e.g. dbus-message-builder.c). Probably should be enforced as test
2029  * code only with ifdef DBUS_BUILD_TESTS
2030  * 
2031  * @param source the source string
2032  * @param dest the destination string (contents are replaced)
2033  * @returns #FALSE if no memory, or source has length 0
2034  */
2035 dbus_bool_t
2036 _dbus_string_pop_line (DBusString *source,
2037                        DBusString *dest)
2038 {
2039   int eol, eol_len;
2040   
2041   _dbus_string_set_length (dest, 0);
2042   
2043   eol = 0;
2044   eol_len = 0;
2045   if (!_dbus_string_find_eol (source, 0, &eol, &eol_len))
2046     {
2047       _dbus_assert (eol == _dbus_string_get_length (source));
2048       if (eol == 0)
2049         {
2050           /* If there's no newline and source has zero length, we're done */
2051           return FALSE;
2052         }
2053       /* otherwise, the last line of the file has no eol characters */
2054     }
2055
2056   /* remember eol can be 0 if it's an empty line, but eol_len should not be zero also
2057    * since find_eol returned TRUE
2058    */
2059   
2060   if (!_dbus_string_move_len (source, 0, eol + eol_len, dest, 0))
2061     return FALSE;
2062   
2063   /* remove line ending */
2064   if (!_dbus_string_set_length (dest, eol))
2065     {
2066       _dbus_assert_not_reached ("out of memory when shortening a string");
2067       return FALSE;
2068     }
2069
2070   return TRUE;
2071 }
2072
2073 #ifdef DBUS_BUILD_TESTS
2074 /**
2075  * Deletes up to and including the first blank space
2076  * in the string.
2077  *
2078  * @param str the string
2079  */
2080 void
2081 _dbus_string_delete_first_word (DBusString *str)
2082 {
2083   int i;
2084   
2085   if (_dbus_string_find_blank (str, 0, &i))
2086     _dbus_string_skip_blank (str, i, &i);
2087
2088   _dbus_string_delete (str, 0, i);
2089 }
2090 #endif
2091
2092 #ifdef DBUS_BUILD_TESTS
2093 /**
2094  * Deletes any leading blanks in the string
2095  *
2096  * @param str the string
2097  */
2098 void
2099 _dbus_string_delete_leading_blanks (DBusString *str)
2100 {
2101   int i;
2102   
2103   _dbus_string_skip_blank (str, 0, &i);
2104
2105   if (i > 0)
2106     _dbus_string_delete (str, 0, i);
2107 }
2108 #endif
2109
2110 /**
2111  * Deletes leading and trailing whitespace
2112  * 
2113  * @param str the string
2114  */
2115 void
2116 _dbus_string_chop_white(DBusString *str)
2117 {
2118   int i;
2119   
2120   _dbus_string_skip_white (str, 0, &i);
2121
2122   if (i > 0)
2123     _dbus_string_delete (str, 0, i);
2124   
2125   _dbus_string_skip_white_reverse (str, _dbus_string_get_length (str), &i);
2126
2127   _dbus_string_set_length (str, i);
2128 }
2129
2130 /**
2131  * Tests two DBusString for equality.
2132  *
2133  * @todo memcmp is probably faster
2134  *
2135  * @param a first string
2136  * @param b second string
2137  * @returns #TRUE if equal
2138  */
2139 dbus_bool_t
2140 _dbus_string_equal (const DBusString *a,
2141                     const DBusString *b)
2142 {
2143   const unsigned char *ap;
2144   const unsigned char *bp;
2145   const unsigned char *a_end;
2146   const DBusRealString *real_a = (const DBusRealString*) a;
2147   const DBusRealString *real_b = (const DBusRealString*) b;
2148   DBUS_GENERIC_STRING_PREAMBLE (real_a);
2149   DBUS_GENERIC_STRING_PREAMBLE (real_b);
2150
2151   if (real_a->len != real_b->len)
2152     return FALSE;
2153
2154   ap = real_a->str;
2155   bp = real_b->str;
2156   a_end = real_a->str + real_a->len;
2157   while (ap != a_end)
2158     {
2159       if (*ap != *bp)
2160         return FALSE;
2161       
2162       ++ap;
2163       ++bp;
2164     }
2165
2166   return TRUE;
2167 }
2168
2169 /**
2170  * Tests two DBusString for equality up to the given length.
2171  * The strings may be shorter than the given length.
2172  *
2173  * @todo write a unit test
2174  *
2175  * @todo memcmp is probably faster
2176  *
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
2181  */
2182 dbus_bool_t
2183 _dbus_string_equal_len (const DBusString *a,
2184                         const DBusString *b,
2185                         int               len)
2186 {
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);
2194
2195   if (real_a->len != real_b->len &&
2196       (real_a->len < len || real_b->len < len))
2197     return FALSE;
2198
2199   ap = real_a->str;
2200   bp = real_b->str;
2201   a_end = real_a->str + MIN (real_a->len, len);
2202   while (ap != a_end)
2203     {
2204       if (*ap != *bp)
2205         return FALSE;
2206       
2207       ++ap;
2208       ++bp;
2209     }
2210
2211   return TRUE;
2212 }
2213
2214 /**
2215  * Tests two sub-parts of two DBusString for equality.  The specified
2216  * range of the first string must exist; the specified start position
2217  * of the second string must exist.
2218  *
2219  * @todo write a unit test
2220  *
2221  * @todo memcmp is probably faster
2222  *
2223  * @param a first string
2224  * @param a_start where to start substring in first string
2225  * @param a_len length of substring in first string
2226  * @param b second string
2227  * @param b_start where to start substring in second string
2228  * @returns #TRUE if the two substrings are equal
2229  */
2230 dbus_bool_t
2231 _dbus_string_equal_substring (const DBusString  *a,
2232                               int                a_start,
2233                               int                a_len,
2234                               const DBusString  *b,
2235                               int                b_start)
2236 {
2237   const unsigned char *ap;
2238   const unsigned char *bp;
2239   const unsigned char *a_end;
2240   const DBusRealString *real_a = (const DBusRealString*) a;
2241   const DBusRealString *real_b = (const DBusRealString*) b;
2242   DBUS_GENERIC_STRING_PREAMBLE (real_a);
2243   DBUS_GENERIC_STRING_PREAMBLE (real_b);
2244   _dbus_assert (a_start >= 0);
2245   _dbus_assert (a_len >= 0);
2246   _dbus_assert (a_start <= real_a->len);
2247   _dbus_assert (a_len <= real_a->len - a_start);
2248   _dbus_assert (b_start >= 0);
2249   _dbus_assert (b_start <= real_b->len);
2250   
2251   if (a_len > real_b->len - b_start)
2252     return FALSE;
2253
2254   ap = real_a->str + a_start;
2255   bp = real_b->str + b_start;
2256   a_end = ap + a_len;
2257   while (ap != a_end)
2258     {
2259       if (*ap != *bp)
2260         return FALSE;
2261       
2262       ++ap;
2263       ++bp;
2264     }
2265
2266   _dbus_assert (bp <= (real_b->str + real_b->len));
2267   
2268   return TRUE;
2269 }
2270
2271 /**
2272  * Checks whether a string is equal to a C string.
2273  *
2274  * @param a the string
2275  * @param c_str the C string
2276  * @returns #TRUE if equal
2277  */
2278 dbus_bool_t
2279 _dbus_string_equal_c_str (const DBusString *a,
2280                           const char       *c_str)
2281 {
2282   const unsigned char *ap;
2283   const unsigned char *bp;
2284   const unsigned char *a_end;
2285   const DBusRealString *real_a = (const DBusRealString*) a;
2286   DBUS_GENERIC_STRING_PREAMBLE (real_a);
2287   _dbus_assert (c_str != NULL);
2288   
2289   ap = real_a->str;
2290   bp = (const unsigned char*) c_str;
2291   a_end = real_a->str + real_a->len;
2292   while (ap != a_end && *bp)
2293     {
2294       if (*ap != *bp)
2295         return FALSE;
2296       
2297       ++ap;
2298       ++bp;
2299     }
2300
2301   if (ap != a_end || *bp)
2302     return FALSE;
2303   
2304   return TRUE;
2305 }
2306
2307 #ifdef DBUS_BUILD_TESTS
2308 /**
2309  * Checks whether a string starts with the given C string.
2310  *
2311  * @param a the string
2312  * @param c_str the C string
2313  * @returns #TRUE if string starts with it
2314  */
2315 dbus_bool_t
2316 _dbus_string_starts_with_c_str (const DBusString *a,
2317                                 const char       *c_str)
2318 {
2319   const unsigned char *ap;
2320   const unsigned char *bp;
2321   const unsigned char *a_end;
2322   const DBusRealString *real_a = (const DBusRealString*) a;
2323   DBUS_GENERIC_STRING_PREAMBLE (real_a);
2324   _dbus_assert (c_str != NULL);
2325   
2326   ap = real_a->str;
2327   bp = (const unsigned char*) c_str;
2328   a_end = real_a->str + real_a->len;
2329   while (ap != a_end && *bp)
2330     {
2331       if (*ap != *bp)
2332         return FALSE;
2333       
2334       ++ap;
2335       ++bp;
2336     }
2337
2338   if (*bp == '\0')
2339     return TRUE;
2340   else
2341     return FALSE;
2342 }
2343 #endif /* DBUS_BUILD_TESTS */
2344
2345 /**
2346  * Appends a two-character hex digit to a string, where the hex digit
2347  * has the value of the given byte.
2348  *
2349  * @param str the string
2350  * @param byte the byte
2351  * @returns #FALSE if no memory
2352  */
2353 dbus_bool_t
2354 _dbus_string_append_byte_as_hex (DBusString *str,
2355                                  int         byte)
2356 {
2357   const char hexdigits[16] = {
2358     '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
2359     'a', 'b', 'c', 'd', 'e', 'f'
2360   };
2361
2362   if (!_dbus_string_append_byte (str,
2363                                  hexdigits[(byte >> 4)]))
2364     return FALSE;
2365   
2366   if (!_dbus_string_append_byte (str,
2367                                  hexdigits[(byte & 0x0f)]))
2368     {
2369       _dbus_string_set_length (str,
2370                                _dbus_string_get_length (str) - 1);
2371       return FALSE;
2372     }
2373
2374   return TRUE;
2375 }
2376
2377 /**
2378  * Encodes a string in hex, the way MD5 and SHA-1 are usually
2379  * encoded. (Each byte is two hex digits.)
2380  *
2381  * @param source the string to encode
2382  * @param start byte index to start encoding
2383  * @param dest string where encoded data should be placed
2384  * @param insert_at where to place encoded data
2385  * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2386  */
2387 dbus_bool_t
2388 _dbus_string_hex_encode (const DBusString *source,
2389                          int               start,
2390                          DBusString       *dest,
2391                          int               insert_at)
2392 {
2393   DBusString result;
2394   const unsigned char *p;
2395   const unsigned char *end;
2396   dbus_bool_t retval;
2397   
2398   _dbus_assert (start <= _dbus_string_get_length (source));
2399
2400   if (!_dbus_string_init (&result))
2401     return FALSE;
2402
2403   retval = FALSE;
2404   
2405   p = (const unsigned char*) _dbus_string_get_const_data (source);
2406   end = p + _dbus_string_get_length (source);
2407   p += start;
2408   
2409   while (p != end)
2410     {
2411       if (!_dbus_string_append_byte_as_hex (&result, *p))
2412         goto out;
2413       
2414       ++p;
2415     }
2416
2417   if (!_dbus_string_move (&result, 0, dest, insert_at))
2418     goto out;
2419
2420   retval = TRUE;
2421
2422  out:
2423   _dbus_string_free (&result);
2424   return retval;
2425 }
2426
2427 /**
2428  * Decodes a string from hex encoding.
2429  *
2430  * @param source the string to decode
2431  * @param start byte index to start decode
2432  * @param end_return return location of the end of the hex data, or #NULL
2433  * @param dest string where decoded data should be placed
2434  * @param insert_at where to place decoded data
2435  * @returns #TRUE if decoding was successful, #FALSE if no memory.
2436  */
2437 dbus_bool_t
2438 _dbus_string_hex_decode (const DBusString *source,
2439                          int               start,
2440                          int              *end_return,
2441                          DBusString       *dest,
2442                          int               insert_at)
2443 {
2444   DBusString result;
2445   const unsigned char *p;
2446   const unsigned char *end;
2447   dbus_bool_t retval;
2448   dbus_bool_t high_bits;
2449   
2450   _dbus_assert (start <= _dbus_string_get_length (source));
2451
2452   if (!_dbus_string_init (&result))
2453     return FALSE;
2454
2455   retval = FALSE;
2456
2457   high_bits = TRUE;
2458   p = (const unsigned char*) _dbus_string_get_const_data (source);
2459   end = p + _dbus_string_get_length (source);
2460   p += start;
2461   
2462   while (p != end)
2463     {
2464       unsigned int val;
2465
2466       switch (*p)
2467         {
2468         case '0':
2469           val = 0;
2470           break;
2471         case '1':
2472           val = 1;
2473           break;
2474         case '2':
2475           val = 2;
2476           break;
2477         case '3':
2478           val = 3;
2479           break;
2480         case '4':
2481           val = 4;
2482           break;
2483         case '5':
2484           val = 5;
2485           break;
2486         case '6':
2487           val = 6;
2488           break;
2489         case '7':
2490           val = 7;
2491           break;
2492         case '8':
2493           val = 8;
2494           break;
2495         case '9':
2496           val = 9;
2497           break;
2498         case 'a':
2499         case 'A':
2500           val = 10;
2501           break;
2502         case 'b':
2503         case 'B':
2504           val = 11;
2505           break;
2506         case 'c':
2507         case 'C':
2508           val = 12;
2509           break;
2510         case 'd':
2511         case 'D':
2512           val = 13;
2513           break;
2514         case 'e':
2515         case 'E':
2516           val = 14;
2517           break;
2518         case 'f':
2519         case 'F':
2520           val = 15;
2521           break;
2522         default:
2523           goto done;
2524         }
2525
2526       if (high_bits)
2527         {
2528           if (!_dbus_string_append_byte (&result,
2529                                          val << 4))
2530             goto out;
2531         }
2532       else
2533         {
2534           int len;
2535           unsigned char b;
2536
2537           len = _dbus_string_get_length (&result);
2538           
2539           b = _dbus_string_get_byte (&result, len - 1);
2540
2541           b |= val;
2542
2543           _dbus_string_set_byte (&result, len - 1, b);
2544         }
2545
2546       high_bits = !high_bits;
2547
2548       ++p;
2549     }
2550
2551  done:
2552   if (!_dbus_string_move (&result, 0, dest, insert_at))
2553     goto out;
2554
2555   if (end_return)
2556     *end_return = p - (const unsigned char*) _dbus_string_get_const_data (source);
2557
2558   retval = TRUE;
2559   
2560  out:
2561   _dbus_string_free (&result);  
2562   return retval;
2563 }
2564
2565 /**
2566  * Checks that the given range of the string is valid ASCII with no
2567  * nul bytes. If the given range is not entirely contained in the
2568  * string, returns #FALSE.
2569  *
2570  * @todo this is inconsistent with most of DBusString in that
2571  * it allows a start,len range that extends past the string end.
2572  * 
2573  * @param str the string
2574  * @param start first byte index to check
2575  * @param len number of bytes to check
2576  * @returns #TRUE if the byte range exists and is all valid ASCII
2577  */
2578 dbus_bool_t
2579 _dbus_string_validate_ascii (const DBusString *str,
2580                              int               start,
2581                              int               len)
2582 {
2583   const unsigned char *s;
2584   const unsigned char *end;
2585   DBUS_CONST_STRING_PREAMBLE (str);
2586   _dbus_assert (start >= 0);
2587   _dbus_assert (start <= real->len);
2588   _dbus_assert (len >= 0);
2589   
2590   if (len > real->len - start)
2591     return FALSE;
2592   
2593   s = real->str + start;
2594   end = s + len;
2595   while (s != end)
2596     {
2597       if (_DBUS_UNLIKELY (!_DBUS_ISASCII (*s)))
2598         return FALSE;
2599         
2600       ++s;
2601     }
2602   
2603   return TRUE;
2604 }
2605
2606 /**
2607  * Converts the given range of the string to lower case.
2608  *
2609  * @param str the string
2610  * @param start first byte index to convert
2611  * @param len number of bytes to convert
2612  */
2613 void
2614 _dbus_string_tolower_ascii (const DBusString *str,
2615                             int               start,
2616                             int               len)
2617 {
2618   unsigned char *s;
2619   unsigned char *end;
2620   DBUS_STRING_PREAMBLE (str);
2621   _dbus_assert (start >= 0);
2622   _dbus_assert (start <= real->len);
2623   _dbus_assert (len >= 0);
2624   _dbus_assert (len <= real->len - start);
2625
2626   s = real->str + start;
2627   end = s + len;
2628
2629   while (s != end)
2630     {
2631       if (*s >= 'A' && *s <= 'Z')
2632           *s += 'a' - 'A';
2633       ++s;
2634     }
2635 }
2636
2637 /**
2638  * Converts the given range of the string to upper case.
2639  *
2640  * @param str the string
2641  * @param start first byte index to convert
2642  * @param len number of bytes to convert
2643  */
2644 void
2645 _dbus_string_toupper_ascii (const DBusString *str,
2646                             int               start,
2647                             int               len)
2648 {
2649   unsigned char *s;
2650   unsigned char *end;
2651   DBUS_STRING_PREAMBLE (str);
2652   _dbus_assert (start >= 0);
2653   _dbus_assert (start <= real->len);
2654   _dbus_assert (len >= 0);
2655   _dbus_assert (len <= real->len - start);
2656
2657   s = real->str + start;
2658   end = s + len;
2659
2660   while (s != end)
2661     {
2662       if (*s >= 'a' && *s <= 'z')
2663           *s += 'A' - 'a';
2664       ++s;
2665     }
2666 }
2667
2668 /**
2669  * Checks that the given range of the string is valid UTF-8. If the
2670  * given range is not entirely contained in the string, returns
2671  * #FALSE. If the string contains any nul bytes in the given range,
2672  * returns #FALSE. If the start and start+len are not on character
2673  * boundaries, returns #FALSE.
2674  *
2675  * @todo this is inconsistent with most of DBusString in that
2676  * it allows a start,len range that extends past the string end.
2677  * 
2678  * @param str the string
2679  * @param start first byte index to check
2680  * @param len number of bytes to check
2681  * @returns #TRUE if the byte range exists and is all valid UTF-8
2682  */
2683 dbus_bool_t
2684 _dbus_string_validate_utf8  (const DBusString *str,
2685                              int               start,
2686                              int               len)
2687 {
2688   const unsigned char *p;
2689   const unsigned char *end;
2690   DBUS_CONST_STRING_PREAMBLE (str);
2691   _dbus_assert (start >= 0);
2692   _dbus_assert (start <= real->len);
2693   _dbus_assert (len >= 0);
2694
2695   /* we are doing _DBUS_UNLIKELY() here which might be
2696    * dubious in a generic library like GLib, but in D-Bus
2697    * we know we're validating messages and that it would
2698    * only be evil/broken apps that would have invalid
2699    * UTF-8. Also, this function seems to be a performance
2700    * bottleneck in profiles.
2701    */
2702   
2703   if (_DBUS_UNLIKELY (len > real->len - start))
2704     return FALSE;
2705   
2706   p = real->str + start;
2707   end = p + len;
2708   
2709   while (p < end)
2710     {
2711       int i, mask, char_len;
2712       dbus_unichar_t result;
2713
2714       /* nul bytes considered invalid */
2715       if (*p == '\0')
2716         break;
2717       
2718       /* Special-case ASCII; this makes us go a lot faster in
2719        * D-Bus profiles where we are typically validating
2720        * function names and such. We have to know that
2721        * all following checks will pass for ASCII though,
2722        * comments follow ...
2723        */      
2724       if (*p < 128)
2725         {
2726           ++p;
2727           continue;
2728         }
2729       
2730       UTF8_COMPUTE (*p, mask, char_len);
2731
2732       if (_DBUS_UNLIKELY (char_len == 0))  /* ASCII: char_len == 1 */
2733         break;
2734
2735       /* check that the expected number of bytes exists in the remaining length */
2736       if (_DBUS_UNLIKELY ((end - p) < char_len)) /* ASCII: p < end and char_len == 1 */
2737         break;
2738         
2739       UTF8_GET (result, p, i, mask, char_len);
2740
2741       /* Check for overlong UTF-8 */
2742       if (_DBUS_UNLIKELY (UTF8_LENGTH (result) != char_len)) /* ASCII: UTF8_LENGTH == 1 */
2743         break;
2744 #if 0
2745       /* The UNICODE_VALID check below will catch this */
2746       if (_DBUS_UNLIKELY (result == (dbus_unichar_t)-1)) /* ASCII: result = ascii value */
2747         break;
2748 #endif
2749
2750       if (_DBUS_UNLIKELY (!UNICODE_VALID (result))) /* ASCII: always valid */
2751         break;
2752
2753       /* UNICODE_VALID should have caught it */
2754       _dbus_assert (result != (dbus_unichar_t)-1);
2755       
2756       p += char_len;
2757     }
2758
2759   /* See that we covered the entire length if a length was
2760    * passed in
2761    */
2762   if (_DBUS_UNLIKELY (p != end))
2763     return FALSE;
2764   else
2765     return TRUE;
2766 }
2767
2768 /**
2769  * Checks that the given range of the string is all nul bytes. If the
2770  * given range is not entirely contained in the string, returns
2771  * #FALSE.
2772  *
2773  * @todo this is inconsistent with most of DBusString in that
2774  * it allows a start,len range that extends past the string end.
2775  * 
2776  * @param str the string
2777  * @param start first byte index to check
2778  * @param len number of bytes to check
2779  * @returns #TRUE if the byte range exists and is all nul bytes
2780  */
2781 dbus_bool_t
2782 _dbus_string_validate_nul (const DBusString *str,
2783                            int               start,
2784                            int               len)
2785 {
2786   const unsigned char *s;
2787   const unsigned char *end;
2788   DBUS_CONST_STRING_PREAMBLE (str);
2789   _dbus_assert (start >= 0);
2790   _dbus_assert (len >= 0);
2791   _dbus_assert (start <= real->len);
2792   
2793   if (len > real->len - start)
2794     return FALSE;
2795   
2796   s = real->str + start;
2797   end = s + len;
2798   while (s != end)
2799     {
2800       if (_DBUS_UNLIKELY (*s != '\0'))
2801         return FALSE;
2802       ++s;
2803     }
2804   
2805   return TRUE;
2806 }
2807
2808 /**
2809  * Clears all allocated bytes in the string to zero.
2810  *
2811  * @param str the string
2812  */
2813 void
2814 _dbus_string_zero (DBusString *str)
2815 {
2816   DBUS_STRING_PREAMBLE (str);
2817
2818   memset (real->str - real->align_offset, '\0', real->allocated);
2819 }
2820 /** @} */
2821
2822 /* tests are in dbus-string-util.c */