dbus/dbus-string.c

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