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 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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 #include "dbus-marshal.h"
  29 #define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
  30 #include "dbus-string-private.h"
  31
  32 /**
  33  * @defgroup DBusString string class
  34  * @ingroup  DBusInternals
  35  * @brief DBusString data structure
  36  *
  37  * Types and functions related to DBusString. DBusString is intended
  38  * to be a string class that makes it hard to mess up security issues
  39  * (and just in general harder to write buggy code).  It should be
  40  * used (or extended and then used) rather than the libc stuff in
  41  * string.h.  The string class is a bit inconvenient at spots because
  42  * it handles out-of-memory failures and tries to be extra-robust.
  43  *
  44  * A DBusString has a maximum length set at initialization time; this
  45  * can be used to ensure that a buffer doesn't get too big.  The
  46  * _dbus_string_lengthen() method checks for overflow, and for max
  47  * length being exceeded.
  48  *
  49  * Try to avoid conversion to a plain C string, i.e. add methods on
  50  * the string object instead, only convert to C string when passing
  51  * things out to the public API. In particular, no sprintf, strcpy,
  52  * strcat, any of that should be used. The GString feature of
  53  * accepting negative numbers for "length of string" is also absent,
  54  * because it could keep us from detecting bogus huge lengths. i.e. if
  55  * we passed in some bogus huge length it would be taken to mean
  56  * "current length of string" instead of "broken crack"
  57  */
  58
  59 /**
  60  * @defgroup DBusStringInternals DBusString implementation details
  61  * @ingroup  DBusInternals
  62  * @brief DBusString implementation details
  63  *
  64  * The guts of DBusString.
  65  *
  66  * @{
  67  */
  68
  69 /**
  70  * We allocate 1 byte for nul termination, plus 7 bytes for possible
  71  * align_offset, so we always need 8 bytes on top of the string's
  72  * length to be in the allocated block.
  73  */
  74 #define ALLOCATION_PADDING 8
  75
  76 /**
  77  * This is the maximum max length (and thus also the maximum length)
  78  * of a DBusString
  79  */
  80 #define MAX_MAX_LENGTH (_DBUS_INT_MAX - ALLOCATION_PADDING)
  81
  82 /**
  83  * Checks a bunch of assertions about a string object
  84  *
  85  * @param real the DBusRealString
  86  */
  87 #define DBUS_GENERIC_STRING_PREAMBLE(real) _dbus_assert ((real) != NULL); _dbus_assert (!(real)->invalid); _dbus_assert ((real)->len >= 0); _dbus_assert ((real)->allocated >= 0); _dbus_assert ((real)->max_length >= 0); _dbus_assert ((real)->len <= ((real)->allocated - ALLOCATION_PADDING)); _dbus_assert ((real)->len <= (real)->max_length)
  88
  89 /**
  90  * Checks assertions about a string object that needs to be
  91  * modifiable - may not be locked or const. Also declares
  92  * the "real" variable pointing to DBusRealString.
  93  * @param str the string
  94  */
  95 #define DBUS_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
  96   DBUS_GENERIC_STRING_PREAMBLE (real);                                          \
  97   _dbus_assert (!(real)->constant);                                             \
  98   _dbus_assert (!(real)->locked)
  99
 100 /**
 101  * Checks assertions about a string object that may be locked but
 102  * can't be const. i.e. a string object that we can free.  Also
 103  * declares the "real" variable pointing to DBusRealString.
 104  *
 105  * @param str the string
 106  */
 107 #define DBUS_LOCKED_STRING_PREAMBLE(str) DBusRealString *real = (DBusRealString*) str; \
 108   DBUS_GENERIC_STRING_PREAMBLE (real);                                                 \
 109   _dbus_assert (!(real)->constant)
 110
 111 /**
 112  * Checks assertions about a string that may be const or locked.  Also
 113  * declares the "real" variable pointing to DBusRealString.
 114  * @param str the string.
 115  */
 116 #define DBUS_CONST_STRING_PREAMBLE(str) const DBusRealString *real = (DBusRealString*) str; \
 117   DBUS_GENERIC_STRING_PREAMBLE (real)
 118
 119 /** @} */
 120
 121 /**
 122  * @addtogroup DBusString
 123  * @{
 124  */
 125
 126 static void
 127 fixup_alignment (DBusRealString *real)
 128 {
 129   char *aligned;
 130   char *real_block;
 131   unsigned int old_align_offset;
 132
 133   /* we have to have extra space in real->allocated for the align offset and nul byte */
 134   _dbus_assert (real->len <= real->allocated - ALLOCATION_PADDING);
 135
 136   old_align_offset = real->align_offset;
 137   real_block = real->str - old_align_offset;
 138
 139   aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);
 140
 141   real->align_offset = aligned - real_block;
 142   real->str = aligned;
 143
 144   if (old_align_offset != real->align_offset)
 145     {
 146       /* Here comes the suck */
 147       memmove (real_block + real->align_offset,
 148                real_block + old_align_offset,
 149                real->len + 1);
 150     }
 151
 152   _dbus_assert (real->align_offset < 8);
 153   _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
 154 }
 155
 156 static void
 157 undo_alignment (DBusRealString *real)
 158 {
 159   if (real->align_offset != 0)
 160     {
 161       memmove (real->str - real->align_offset,
 162                real->str,
 163                real->len + 1);
 164
 165       real->str = real->str - real->align_offset;
 166       real->align_offset = 0;
 167     }
 168 }
 169
 170 /**
 171  * Initializes a string. The string starts life with zero length.  The
 172  * string must eventually be freed with _dbus_string_free().
 173  *
 174  * @param str memory to hold the string
 175  * @returns #TRUE on success, #FALSE if no memory
 176  */
 177 dbus_bool_t
 178 _dbus_string_init (DBusString *str)
 179 {
 180   DBusRealString *real;
 181
 182   _dbus_assert (str != NULL);
 183
 184   _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
 185
 186   real = (DBusRealString*) str;
 187
 188   /* It's very important not to touch anything
 189    * other than real->str if we're going to fail,
 190    * since we also use this function to reset
 191    * an existing string, e.g. in _dbus_string_steal_data()
 192    */
 193
 194   real->str = dbus_malloc (ALLOCATION_PADDING);
 195   if (real->str == NULL)
 196     return FALSE;
 197
 198   real->allocated = ALLOCATION_PADDING;
 199   real->len = 0;
 200   real->str[real->len] = '\0';
 201
 202   real->max_length = MAX_MAX_LENGTH;
 203   real->constant = FALSE;
 204   real->locked = FALSE;
 205   real->invalid = FALSE;
 206   real->align_offset = 0;
 207
 208   fixup_alignment (real);
 209
 210   return TRUE;
 211 }
 212
 213 /* The max length thing is sort of a historical artifact
 214  * from a feature that turned out to be dumb; perhaps
 215  * we should purge it entirely. The problem with
 216  * the feature is that it looks like memory allocation
 217  * failure, but is not a transient or resolvable failure.
 218  */
 219 static void
 220 set_max_length (DBusString *str,
 221                 int         max_length)
 222 {
 223   DBusRealString *real;
 224
 225   real = (DBusRealString*) str;
 226
 227   real->max_length = max_length;
 228 }
 229
 230 /**
 231  * Initializes a constant string. The value parameter is not copied
 232  * (should be static), and the string may never be modified.
 233  * It is safe but not necessary to call _dbus_string_free()
 234  * on a const string. The string has a length limit of MAXINT - 8.
 235  *
 236  * @param str memory to use for the string
 237  * @param value a string to be stored in str (not copied!!!)
 238  */
 239 void
 240 _dbus_string_init_const (DBusString *str,
 241                          const char *value)
 242 {
 243   _dbus_assert (value != NULL);
 244
 245   _dbus_string_init_const_len (str, value,
 246                                strlen (value));
 247 }
 248
 249 /**
 250  * Initializes a constant string with a length. The value parameter is
 251  * not copied (should be static), and the string may never be
 252  * modified.  It is safe but not necessary to call _dbus_string_free()
 253  * on a const string.
 254  *
 255  * @param str memory to use for the string
 256  * @param value a string to be stored in str (not copied!!!)
 257  * @param len the length to use
 258  */
 259 void
 260 _dbus_string_init_const_len (DBusString *str,
 261                              const char *value,
 262                              int         len)
 263 {
 264   DBusRealString *real;
 265
 266   _dbus_assert (str != NULL);
 267   _dbus_assert (value != NULL);
 268   _dbus_assert (len <= MAX_MAX_LENGTH);
 269   _dbus_assert (len >= 0);
 270
 271   real = (DBusRealString*) str;
 272
 273   real->str = (char*) value;
 274   real->len = len;
 275   real->allocated = real->len + ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
 276   real->max_length = real->len + 1;
 277   real->constant = TRUE;
 278   real->invalid = FALSE;
 279
 280   /* We don't require const strings to be 8-byte aligned as the
 281    * memory is coming from elsewhere.
 282    */
 283 }
 284
 285 /**
 286  * Frees a string created by _dbus_string_init().
 287  *
 288  * @param str memory where the string is stored.
 289  */
 290 void
 291 _dbus_string_free (DBusString *str)
 292 {
 293   DBusRealString *real = (DBusRealString*) str;
 294   DBUS_GENERIC_STRING_PREAMBLE (real);
 295
 296   if (real->constant)
 297     return;
 298   dbus_free (real->str - real->align_offset);
 299
 300   real->invalid = TRUE;
 301 }
 302
 303 /**
 304  * Locks a string such that any attempts to change the string will
 305  * result in aborting the program. Also, if the string is wasting a
 306  * lot of memory (allocation is sufficiently larger than what the
 307  * string is really using), _dbus_string_lock() will realloc the
 308  * string's data to "compact" it.
 309  *
 310  * @param str the string to lock.
 311  */
 312 void
 313 _dbus_string_lock (DBusString *str)
 314 {
 315   DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */
 316
 317   real->locked = TRUE;
 318
 319   /* Try to realloc to avoid excess memory usage, since
 320    * we know we won't change the string further
 321    */
 322 #define MAX_WASTE 48
 323   if (real->allocated - MAX_WASTE > real->len)
 324     {
 325       char *new_str;
 326       int new_allocated;
 327
 328       new_allocated = real->len + ALLOCATION_PADDING;
 329
 330       new_str = dbus_realloc (real->str - real->align_offset,
 331                               new_allocated);
 332       if (new_str != NULL)
 333         {
 334           real->str = new_str + real->align_offset;
 335           real->allocated = new_allocated;
 336           fixup_alignment (real);
 337         }
 338     }
 339 }
 340
 341 static dbus_bool_t
 342 set_length (DBusRealString *real,
 343             int             new_length)
 344 {
 345   /* Note, we are setting the length without nul termination */
 346
 347   /* exceeding max length is the same as failure to allocate memory */
 348   if (new_length > real->max_length)
 349     return FALSE;
 350
 351   if (new_length > (real->allocated - ALLOCATION_PADDING))
 352     {
 353       int new_allocated;
 354       char *new_str;
 355
 356       /* at least double our old allocation to avoid O(n), avoiding
 357        * overflow
 358        */
 359       if (real->allocated > (MAX_MAX_LENGTH + ALLOCATION_PADDING) / 2)
 360         new_allocated = MAX_MAX_LENGTH + ALLOCATION_PADDING;
 361       else
 362         new_allocated = real->allocated * 2;
 363
 364       /* if you change the code just above here, run the tests without
 365        * the following before you commit
 366        */
 367 #ifdef DBUS_BUILD_TESTS
 368       new_allocated = 0; /* ensure a realloc every time so that we go
 369                           * through all malloc failure codepaths
 370                           */
 371 #endif
 372
 373       /* But be sure we always alloc at least space for the new length */
 374       new_allocated = MAX (new_allocated, new_length + ALLOCATION_PADDING);
 375
 376       new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
 377       if (new_str == NULL)
 378         return FALSE;
 379
 380       real->str = new_str + real->align_offset;
 381       real->allocated = new_allocated;
 382       fixup_alignment (real);
 383     }
 384
 385   real->len = new_length;
 386   real->str[real->len] = '\0';
 387
 388   return TRUE;
 389 }
 390
 391 static dbus_bool_t
 392 open_gap (int             len,
 393           DBusRealString *dest,
 394           int             insert_at)
 395 {
 396   if (len == 0)
 397     return TRUE;
 398
 399   if (len > dest->max_length - dest->len)
 400     return FALSE; /* detected overflow of dest->len + len below */
 401
 402   if (!set_length (dest, dest->len + len))
 403     return FALSE;
 404
 405   memmove (dest->str + insert_at + len,
 406            dest->str + insert_at,
 407            dest->len - len - insert_at);
 408
 409   return TRUE;
 410 }
 411
 412 /**
 413  * Gets the raw character buffer from the string.  The returned buffer
 414  * will be nul-terminated, but note that strings may contain binary
 415  * data so there may be extra nul characters prior to the termination.
 416  * This function should be little-used, extend DBusString or add
 417  * stuff to dbus-sysdeps.c instead. It's an error to use this
 418  * function on a const string.
 419  *
 420  * @param str the string
 421  * @returns the data
 422  */
 423 char*
 424 _dbus_string_get_data (DBusString *str)
 425 {
 426   DBUS_STRING_PREAMBLE (str);
 427
 428   return real->str;
 429 }
 430
 431 /**
 432  * Gets the raw character buffer from a const string.
 433  *
 434  * @param str the string
 435  * @returns the string data
 436  */
 437 const char*
 438 _dbus_string_get_const_data (const DBusString  *str)
 439 {
 440   DBUS_CONST_STRING_PREAMBLE (str);
 441
 442   return real->str;
 443 }
 444
 445 /**
 446  * Gets a sub-portion of the raw character buffer from the
 447  * string. The "len" field is required simply for error
 448  * checking, to be sure you don't try to use more
 449  * string than exists. The nul termination of the
 450  * returned buffer remains at the end of the entire
 451  * string, not at start + len.
 452  *
 453  * @param str the string
 454  * @param start byte offset to return
 455  * @param len length of segment to return
 456  * @returns the string data
 457  */
 458 char*
 459 _dbus_string_get_data_len (DBusString *str,
 460                            int         start,
 461                            int         len)
 462 {
 463   DBUS_STRING_PREAMBLE (str);
 464   _dbus_assert (start >= 0);
 465   _dbus_assert (len >= 0);
 466   _dbus_assert (start <= real->len);
 467   _dbus_assert (len <= real->len - start);
 468
 469   return real->str + start;
 470 }
 471
 472 /**
 473  * const version of _dbus_string_get_data_len().
 474  *
 475  * @todo should return the const char* instead of using an out param;
 476  * the temporary variable encourages a bug where you use const data
 477  * after modifying the string and possibly causing a realloc.
 478  *
 479  * @param str the string
 480  * @param start byte offset to return
 481  * @param len length of segment to return
 482  * @returns the string data
 483  */
 484 const char*
 485 _dbus_string_get_const_data_len (const DBusString  *str,
 486                                  int                start,
 487                                  int                len)
 488 {
 489   DBUS_CONST_STRING_PREAMBLE (str);
 490   _dbus_assert (start >= 0);
 491   _dbus_assert (len >= 0);
 492   _dbus_assert (start <= real->len);
 493   _dbus_assert (len <= real->len - start);
 494
 495   return real->str + start;
 496 }
 497
 498 /**
 499  * Sets the value of the byte at the given position.
 500  *
 501  * @param str the string
 502  * @param i the position
 503  * @param byte the new value
 504  */
 505 void
 506 _dbus_string_set_byte (DBusString    *str,
 507                        int            i,
 508                        unsigned char  byte)
 509 {
 510   DBUS_STRING_PREAMBLE (str);
 511   _dbus_assert (i < real->len);
 512   _dbus_assert (i >= 0);
 513
 514   real->str[i] = byte;
 515 }
 516
 517 /**
 518  * Gets the byte at the given position.
 519  *
 520  * @param str the string
 521  * @param start the position
 522  * @returns the byte at that position
 523  */
 524 unsigned char
 525 _dbus_string_get_byte (const DBusString  *str,
 526                        int                start)
 527 {
 528   DBUS_CONST_STRING_PREAMBLE (str);
 529   _dbus_assert (start < real->len);
 530   _dbus_assert (start >= 0);
 531
 532   return real->str[start];
 533 }
 534
 535 /**
 536  * Inserts the given byte at the given position.
 537  *
 538  * @param str the string
 539  * @param i the position
 540  * @param byte the value to insert
 541  * @returns #TRUE on success
 542  */
 543 dbus_bool_t
 544 _dbus_string_insert_byte (DBusString   *str,
 545                           int           i,
 546                           unsigned char byte)
 547 {
 548   DBUS_STRING_PREAMBLE (str);
 549   _dbus_assert (i <= real->len);
 550   _dbus_assert (i >= 0);
 551
 552   if (!open_gap (1, real, i))
 553     return FALSE;
 554
 555   real->str[i] = byte;
 556
 557   return TRUE;
 558 }
 559
 560 /**
 561  * Like _dbus_string_get_data(), but removes the
 562  * gotten data from the original string. The caller
 563  * must free the data returned. This function may
 564  * fail due to lack of memory, and return #FALSE.
 565  *
 566  * @param str the string
 567  * @param data_return location to return the buffer
 568  * @returns #TRUE on success
 569  */
 570 dbus_bool_t
 571 _dbus_string_steal_data (DBusString        *str,
 572                          char             **data_return)
 573 {
 574   int old_max_length;
 575   DBUS_STRING_PREAMBLE (str);
 576   _dbus_assert (data_return != NULL);
 577
 578   undo_alignment (real);
 579
 580   *data_return = real->str;
 581
 582   old_max_length = real->max_length;
 583
 584   /* reset the string */
 585   if (!_dbus_string_init (str))
 586     {
 587       /* hrm, put it back then */
 588       real->str = *data_return;
 589       *data_return = NULL;
 590       fixup_alignment (real);
 591       return FALSE;
 592     }
 593
 594   real->max_length = old_max_length;
 595
 596   return TRUE;
 597 }
 598
 599 /**
 600  * Like _dbus_string_get_data_len(), but removes the gotten data from
 601  * the original string. The caller must free the data returned. This
 602  * function may fail due to lack of memory, and return #FALSE.
 603  * The returned string is nul-terminated and has length len.
 604  *
 605  * @todo this function is broken because on failure it
 606  * may corrupt the source string.
 607  *
 608  * @param str the string
 609  * @param data_return location to return the buffer
 610  * @param start the start of segment to steal
 611  * @param len the length of segment to steal
 612  * @returns #TRUE on success
 613  */
 614 dbus_bool_t
 615 _dbus_string_steal_data_len (DBusString        *str,
 616                              char             **data_return,
 617                              int                start,
 618                              int                len)
 619 {
 620   DBusString dest;
 621   DBUS_STRING_PREAMBLE (str);
 622   _dbus_assert (data_return != NULL);
 623   _dbus_assert (start >= 0);
 624   _dbus_assert (len >= 0);
 625   _dbus_assert (start <= real->len);
 626   _dbus_assert (len <= real->len - start);
 627
 628   if (!_dbus_string_init (&dest))
 629     return FALSE;
 630
 631   set_max_length (&dest, real->max_length);
 632
 633   if (!_dbus_string_move_len (str, start, len, &dest, 0))
 634     {
 635       _dbus_string_free (&dest);
 636       return FALSE;
 637     }
 638
 639   _dbus_warn ("Broken code in _dbus_string_steal_data_len(), see @todo, FIXME\n");
 640   if (!_dbus_string_steal_data (&dest, data_return))
 641     {
 642       _dbus_string_free (&dest);
 643       return FALSE;
 644     }
 645
 646   _dbus_string_free (&dest);
 647   return TRUE;
 648 }
 649
 650
 651 /**
 652  * Copies the data from the string into a char*
 653  *
 654  * @param str the string
 655  * @param data_return place to return the data
 656  * @returns #TRUE on success, #FALSE on no memory
 657  */
 658 dbus_bool_t
 659 _dbus_string_copy_data (const DBusString  *str,
 660                         char             **data_return)
 661 {
 662   DBUS_CONST_STRING_PREAMBLE (str);
 663   _dbus_assert (data_return != NULL);
 664
 665   *data_return = dbus_malloc (real->len + 1);
 666   if (*data_return == NULL)
 667     return FALSE;
 668
 669   memcpy (*data_return, real->str, real->len + 1);
 670
 671   return TRUE;
 672 }
 673
 674 /**
 675  * Copies a segment of the string into a char*
 676  *
 677  * @param str the string
 678  * @param data_return place to return the data
 679  * @param start start index
 680  * @param len length to copy
 681  * @returns #FALSE if no memory
 682  */
 683 dbus_bool_t
 684 _dbus_string_copy_data_len (const DBusString  *str,
 685                             char             **data_return,
 686                             int                start,
 687                             int                len)
 688 {
 689   DBusString dest;
 690
 691   DBUS_CONST_STRING_PREAMBLE (str);
 692   _dbus_assert (data_return != NULL);
 693   _dbus_assert (start >= 0);
 694   _dbus_assert (len >= 0);
 695   _dbus_assert (start <= real->len);
 696   _dbus_assert (len <= real->len - start);
 697
 698   if (!_dbus_string_init (&dest))
 699     return FALSE;
 700
 701   set_max_length (&dest, real->max_length);
 702
 703   if (!_dbus_string_copy_len (str, start, len, &dest, 0))
 704     {
 705       _dbus_string_free (&dest);
 706       return FALSE;
 707     }
 708
 709   if (!_dbus_string_steal_data (&dest, data_return))
 710     {
 711       _dbus_string_free (&dest);
 712       return FALSE;
 713     }
 714
 715   _dbus_string_free (&dest);
 716   return TRUE;
 717 }
 718
 719 /**
 720  * Gets the length of a string (not including nul termination).
 721  *
 722  * @returns the length.
 723  */
 724 int
 725 _dbus_string_get_length (const DBusString  *str)
 726 {
 727   DBUS_CONST_STRING_PREAMBLE (str);
 728
 729   return real->len;
 730 }
 731
 732 /**
 733  * Makes a string longer by the given number of bytes.  Checks whether
 734  * adding additional_length to the current length would overflow an
 735  * integer, and checks for exceeding a string's max length.
 736  * The new bytes are not initialized, other than nul-terminating
 737  * the end of the string. The uninitialized bytes may contain
 738  * nul bytes or other junk.
 739  *
 740  * @param str a string
 741  * @param additional_length length to add to the string.
 742  * @returns #TRUE on success.
 743  */
 744 dbus_bool_t
 745 _dbus_string_lengthen (DBusString *str,
 746                        int         additional_length)
 747 {
 748   DBUS_STRING_PREAMBLE (str);
 749   _dbus_assert (additional_length >= 0);
 750
 751   if (additional_length > real->max_length - real->len)
 752     return FALSE; /* would overflow */
 753
 754   return set_length (real,
 755                      real->len + additional_length);
 756 }
 757
 758 /**
 759  * Makes a string shorter by the given number of bytes.
 760  *
 761  * @param str a string
 762  * @param length_to_remove length to remove from the string.
 763  */
 764 void
 765 _dbus_string_shorten (DBusString *str,
 766                       int         length_to_remove)
 767 {
 768   DBUS_STRING_PREAMBLE (str);
 769   _dbus_assert (length_to_remove >= 0);
 770   _dbus_assert (length_to_remove <= real->len);
 771
 772   set_length (real,
 773               real->len - length_to_remove);
 774 }
 775
 776 /**
 777  * Sets the length of a string. Can be used to truncate or lengthen
 778  * the string. If the string is lengthened, the function may fail and
 779  * return #FALSE. Newly-added bytes are not initialized, as with
 780  * _dbus_string_lengthen().
 781  *
 782  * @param str a string
 783  * @param length new length of the string.
 784  * @returns #FALSE on failure.
 785  */
 786 dbus_bool_t
 787 _dbus_string_set_length (DBusString *str,
 788                          int         length)
 789 {
 790   DBUS_STRING_PREAMBLE (str);
 791   _dbus_assert (length >= 0);
 792
 793   return set_length (real, length);
 794 }
 795
 796 /**
 797  * Align the length of a string to a specific alignment (typically 4 or 8)
 798  * by appending nul bytes to the string.
 799  *
 800  * @param str a string
 801  * @param alignment the alignment
 802  * @returns #FALSE if no memory
 803  */
 804 dbus_bool_t
 805 _dbus_string_align_length (DBusString *str,
 806                            int         alignment)
 807 {
 808   unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
 809   int delta;
 810   DBUS_STRING_PREAMBLE (str);
 811   _dbus_assert (alignment >= 1);
 812   _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
 813
 814   new_len = _DBUS_ALIGN_VALUE (real->len, alignment);
 815   if (new_len > (unsigned long) real->max_length)
 816     return FALSE;
 817
 818   delta = new_len - real->len;
 819   _dbus_assert (delta >= 0);
 820
 821   if (delta == 0)
 822     return TRUE;
 823
 824   if (!set_length (real, new_len))
 825     return FALSE;
 826
 827   memset (real->str + (new_len - delta),
 828           '\0', delta);
 829
 830   return TRUE;
 831 }
 832
 833 static dbus_bool_t
 834 append (DBusRealString *real,
 835         const char     *buffer,
 836         int             buffer_len)
 837 {
 838   if (buffer_len == 0)
 839     return TRUE;
 840
 841   if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
 842     return FALSE;
 843
 844   memcpy (real->str + (real->len - buffer_len),
 845           buffer,
 846           buffer_len);
 847
 848   return TRUE;
 849 }
 850
 851 /**
 852  * Appends a nul-terminated C-style string to a DBusString.
 853  *
 854  * @param str the DBusString
 855  * @param buffer the nul-terminated characters to append
 856  * @returns #FALSE if not enough memory.
 857  */
 858 dbus_bool_t
 859 _dbus_string_append (DBusString *str,
 860                      const char *buffer)
 861 {
 862   unsigned long buffer_len;
 863
 864   DBUS_STRING_PREAMBLE (str);
 865   _dbus_assert (buffer != NULL);
 866
 867   buffer_len = strlen (buffer);
 868   if (buffer_len > (unsigned long) real->max_length)
 869     return FALSE;
 870
 871   return append (real, buffer, buffer_len);
 872 }
 873
 874 /**
 875  * Appends block of bytes with the given length to a DBusString.
 876  *
 877  * @param str the DBusString
 878  * @param buffer the bytes to append
 879  * @param len the number of bytes to append
 880  * @returns #FALSE if not enough memory.
 881  */
 882 dbus_bool_t
 883 _dbus_string_append_len (DBusString *str,
 884                          const char *buffer,
 885                          int         len)
 886 {
 887   DBUS_STRING_PREAMBLE (str);
 888   _dbus_assert (buffer != NULL);
 889   _dbus_assert (len >= 0);
 890
 891   return append (real, buffer, len);
 892 }
 893
 894 /**
 895  * Appends a single byte to the string, returning #FALSE
 896  * if not enough memory.
 897  *
 898  * @param str the string
 899  * @param byte the byte to append
 900  * @returns #TRUE on success
 901  */
 902 dbus_bool_t
 903 _dbus_string_append_byte (DBusString    *str,
 904                           unsigned char  byte)
 905 {
 906   DBUS_STRING_PREAMBLE (str);
 907
 908   if (!set_length (real, real->len + 1))
 909     return FALSE;
 910
 911   real->str[real->len-1] = byte;
 912
 913   return TRUE;
 914 }
 915
 916 /**
 917  * Appends a single Unicode character, encoding the character
 918  * in UTF-8 format.
 919  *
 920  * @param str the string
 921  * @param ch the Unicode character
 922  */
 923 dbus_bool_t
 924 _dbus_string_append_unichar (DBusString    *str,
 925                              dbus_unichar_t ch)
 926 {
 927   int len;
 928   int first;
 929   int i;
 930   char *out;
 931
 932   DBUS_STRING_PREAMBLE (str);
 933
 934   /* this code is from GLib but is pretty standard I think */
 935
 936   len = 0;
 937
 938   if (ch < 0x80)
 939     {
 940       first = 0;
 941       len = 1;
 942     }
 943   else if (ch < 0x800)
 944     {
 945       first = 0xc0;
 946       len = 2;
 947     }
 948   else if (ch < 0x10000)
 949     {
 950       first = 0xe0;
 951       len = 3;
 952     }
 953    else if (ch < 0x200000)
 954     {
 955       first = 0xf0;
 956       len = 4;
 957     }
 958   else if (ch < 0x4000000)
 959     {
 960       first = 0xf8;
 961       len = 5;
 962     }
 963   else
 964     {
 965       first = 0xfc;
 966       len = 6;
 967     }
 968
 969   if (len > (real->max_length - real->len))
 970     return FALSE; /* real->len + len would overflow */
 971
 972   if (!set_length (real, real->len + len))
 973     return FALSE;
 974
 975   out = real->str + (real->len - len);
 976
 977   for (i = len - 1; i > 0; --i)
 978     {
 979       out[i] = (ch & 0x3f) | 0x80;
 980       ch >>= 6;
 981     }
 982   out[0] = ch | first;
 983
 984   return TRUE;
 985 }
 986
 987 static void
 988 delete (DBusRealString *real,
 989         int             start,
 990         int             len)
 991 {
 992   if (len == 0)
 993     return;
 994
 995   memmove (real->str + start, real->str + start + len, real->len - (start + len));
 996   real->len -= len;
 997   real->str[real->len] = '\0';
 998 }
 999
1000 /**
1001  * Deletes a segment of a DBusString with length len starting at
1002  * start. (Hint: to clear an entire string, setting length to 0
1003  * with _dbus_string_set_length() is easier.)
1004  *
1005  * @param str the DBusString
1006  * @param start where to start deleting
1007  * @param len the number of bytes to delete
1008  */
1009 void
1010 _dbus_string_delete (DBusString       *str,
1011                      int               start,
1012                      int               len)
1013 {
1014   DBUS_STRING_PREAMBLE (str);
1015   _dbus_assert (start >= 0);
1016   _dbus_assert (len >= 0);
1017   _dbus_assert (start <= real->len);
1018   _dbus_assert (len <= real->len - start);
1019
1020   delete (real, start, len);
1021 }
1022
1023 static dbus_bool_t
1024 copy (DBusRealString *source,
1025       int             start,
1026       int             len,
1027       DBusRealString *dest,
1028       int             insert_at)
1029 {
1030   if (len == 0)
1031     return TRUE;
1032
1033   if (!open_gap (len, dest, insert_at))
1034     return FALSE;
1035
1036   memcpy (dest->str + insert_at,
1037           source->str + start,
1038           len);
1039
1040   return TRUE;
1041 }
1042
1043 /**
1044  * Checks assertions for two strings we're copying a segment between,
1045  * and declares real_source/real_dest variables.
1046  *
1047  * @param source the source string
1048  * @param start the starting offset
1049  * @param dest the dest string
1050  * @param insert_at where the copied segment is inserted
1051  */
1052 #define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at)       \
1053   DBusRealString *real_source = (DBusRealString*) source;               \
1054   DBusRealString *real_dest = (DBusRealString*) dest;                   \
1055   _dbus_assert ((source) != (dest));                                    \
1056   DBUS_GENERIC_STRING_PREAMBLE (real_source);                           \
1057   DBUS_GENERIC_STRING_PREAMBLE (real_dest);                             \
1058   _dbus_assert (!real_dest->constant);                                  \
1059   _dbus_assert (!real_dest->locked);                                    \
1060   _dbus_assert ((start) >= 0);                                          \
1061   _dbus_assert ((start) <= real_source->len);                           \
1062   _dbus_assert ((insert_at) >= 0);                                      \
1063   _dbus_assert ((insert_at) <= real_dest->len)
1064
1065 /**
1066  * Moves the end of one string into another string. Both strings
1067  * must be initialized, valid strings.
1068  *
1069  * @param source the source string
1070  * @param start where to chop off the source string
1071  * @param dest the destination string
1072  * @param insert_at where to move the chopped-off part of source string
1073  * @returns #FALSE if not enough memory
1074  */
1075 dbus_bool_t
1076 _dbus_string_move (DBusString       *source,
1077                    int               start,
1078                    DBusString       *dest,
1079                    int               insert_at)
1080 {
1081   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1082
1083   if (!copy (real_source, start,
1084              real_source->len - start,
1085              real_dest,
1086              insert_at))
1087     return FALSE;
1088
1089   delete (real_source, start,
1090           real_source->len - start);
1091
1092   return TRUE;
1093 }
1094
1095 /**
1096  * Like _dbus_string_move(), but does not delete the section
1097  * of the source string that's copied to the dest string.
1098  *
1099  * @param source the source string
1100  * @param start where to start copying the source string
1101  * @param dest the destination string
1102  * @param insert_at where to place the copied part of source string
1103  * @returns #FALSE if not enough memory
1104  */
1105 dbus_bool_t
1106 _dbus_string_copy (const DBusString *source,
1107                    int               start,
1108                    DBusString       *dest,
1109                    int               insert_at)
1110 {
1111   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1112
1113   return copy (real_source, start,
1114                real_source->len - start,
1115                real_dest,
1116                insert_at);
1117 }
1118
1119 /**
1120  * Like _dbus_string_move(), but can move a segment from
1121  * the middle of the source string.
1122  *
1123  * @param source the source string
1124  * @param start first byte of source string to move
1125  * @param len length of segment to move
1126  * @param dest the destination string
1127  * @param insert_at where to move the bytes from the source string
1128  * @returns #FALSE if not enough memory
1129  */
1130 dbus_bool_t
1131 _dbus_string_move_len (DBusString       *source,
1132                        int               start,
1133                        int               len,
1134                        DBusString       *dest,
1135                        int               insert_at)
1136
1137 {
1138   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1139   _dbus_assert (len >= 0);
1140   _dbus_assert ((start + len) <= real_source->len);
1141
1142   if (!copy (real_source, start, len,
1143              real_dest,
1144              insert_at))
1145     return FALSE;
1146
1147   delete (real_source, start,
1148           len);
1149
1150   return TRUE;
1151 }
1152
1153 /**
1154  * Like _dbus_string_copy(), but can copy a segment from the middle of
1155  * the source string.
1156  *
1157  * @param source the source string
1158  * @param start where to start copying the source string
1159  * @param len length of segment to copy
1160  * @param dest the destination string
1161  * @param insert_at where to place the copied segment of source string
1162  * @returns #FALSE if not enough memory
1163  */
1164 dbus_bool_t
1165 _dbus_string_copy_len (const DBusString *source,
1166                        int               start,
1167                        int               len,
1168                        DBusString       *dest,
1169                        int               insert_at)
1170 {
1171   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
1172   _dbus_assert (len >= 0);
1173   _dbus_assert (start <= real_source->len);
1174   _dbus_assert (len <= real_source->len - start);
1175
1176   return copy (real_source, start, len,
1177                real_dest,
1178                insert_at);
1179 }
1180
1181 /**
1182  * Replaces a segment of dest string with a segment of source string.
1183  *
1184  * @todo optimize the case where the two lengths are the same, and
1185  * avoid memmoving the data in the trailing part of the string twice.
1186  *
1187  * @todo avoid inserting the source into dest, then deleting
1188  * the replaced chunk of dest (which creates a potentially large
1189  * intermediate string). Instead, extend the replaced chunk
1190  * of dest with padding to the same size as the source chunk,
1191  * then copy in the source bytes.
1192  *
1193  * @param source the source string
1194  * @param start where to start copying the source string
1195  * @param len length of segment to copy
1196  * @param dest the destination string
1197  * @param replace_at start of segment of dest string to replace
1198  * @param replace_len length of segment of dest string to replace
1199  * @returns #FALSE if not enough memory
1200  *
1201  */
1202 dbus_bool_t
1203 _dbus_string_replace_len (const DBusString *source,
1204                           int               start,
1205                           int               len,
1206                           DBusString       *dest,
1207                           int               replace_at,
1208                           int               replace_len)
1209 {
1210   DBUS_STRING_COPY_PREAMBLE (source, start, dest, replace_at);
1211   _dbus_assert (len >= 0);
1212   _dbus_assert (start <= real_source->len);
1213   _dbus_assert (len <= real_source->len - start);
1214   _dbus_assert (replace_at >= 0);
1215   _dbus_assert (replace_at <= real_dest->len);
1216   _dbus_assert (replace_len <= real_dest->len - replace_at);
1217
1218   if (!copy (real_source, start, len,
1219              real_dest, replace_at))
1220     return FALSE;
1221
1222   delete (real_dest, replace_at + len, replace_len);
1223
1224   return TRUE;
1225 }
1226
1227 /* Unicode macros and utf8_validate() from GLib Owen Taylor, Havoc
1228  * Pennington, and Tom Tromey are the authors and authorized relicense.
1229  */
1230
1231 /** computes length and mask of a unicode character
1232  * @param Char the char
1233  * @param Mask the mask variable to assign to
1234  * @param Len the length variable to assign to
1235  */
1236 #define UTF8_COMPUTE(Char, Mask, Len)                                         \
1237   if (Char < 128)                                                             \
1238     {                                                                         \
1239       Len = 1;                                                                \
1240       Mask = 0x7f;                                                            \
1241     }                                                                         \
1242   else if ((Char & 0xe0) == 0xc0)                                             \
1243     {                                                                         \
1244       Len = 2;                                                                \
1245       Mask = 0x1f;                                                            \
1246     }                                                                         \
1247   else if ((Char & 0xf0) == 0xe0)                                             \
1248     {                                                                         \
1249       Len = 3;                                                                \
1250       Mask = 0x0f;                                                            \
1251     }                                                                         \
1252   else if ((Char & 0xf8) == 0xf0)                                             \
1253     {                                                                         \
1254       Len = 4;                                                                \
1255       Mask = 0x07;                                                            \
1256     }                                                                         \
1257   else if ((Char & 0xfc) == 0xf8)                                             \
1258     {                                                                         \
1259       Len = 5;                                                                \
1260       Mask = 0x03;                                                            \
1261     }                                                                         \
1262   else if ((Char & 0xfe) == 0xfc)                                             \
1263     {                                                                         \
1264       Len = 6;                                                                \
1265       Mask = 0x01;                                                            \
1266     }                                                                         \
1267   else                                                                        \
1268     Len = -1;
1269
1270 /**
1271  * computes length of a unicode character in UTF-8
1272  * @param Char the char
1273  */
1274 #define UTF8_LENGTH(Char)              \
1275   ((Char) < 0x80 ? 1 :                 \
1276    ((Char) < 0x800 ? 2 :               \
1277     ((Char) < 0x10000 ? 3 :            \
1278      ((Char) < 0x200000 ? 4 :          \
1279       ((Char) < 0x4000000 ? 5 : 6)))))
1280
1281 /**
1282  * Gets a UTF-8 value.
1283  *
1284  * @param Result variable for extracted unicode char.
1285  * @param Chars the bytes to decode
1286  * @param Count counter variable
1287  * @param Mask mask for this char
1288  * @param Len length for this char in bytes
1289  */
1290 #define UTF8_GET(Result, Chars, Count, Mask, Len)                             \
1291   (Result) = (Chars)[0] & (Mask);                                             \
1292   for ((Count) = 1; (Count) < (Len); ++(Count))                               \
1293     {                                                                         \
1294       if (((Chars)[(Count)] & 0xc0) != 0x80)                                  \
1295         {                                                                     \
1296           (Result) = -1;                                                      \
1297           break;                                                              \
1298         }                                                                     \
1299       (Result) <<= 6;                                                         \
1300       (Result) |= ((Chars)[(Count)] & 0x3f);                                  \
1301     }
1302
1303 /**
1304  * Check whether a unicode char is in a valid range.
1305  *
1306  * @param Char the character
1307  */
1308 #define UNICODE_VALID(Char)                   \
1309     ((Char) < 0x110000 &&                     \
1310      (((Char) & 0xFFFFF800) != 0xD800) &&     \
1311      ((Char) < 0xFDD0 || (Char) > 0xFDEF) &&  \
1312      ((Char) & 0xFFFF) != 0xFFFF)
1313
1314 /**
1315  * Gets a unicode character from a UTF-8 string. Does no validation;
1316  * you must verify that the string is valid UTF-8 in advance and must
1317  * pass in the start of a character.
1318  *
1319  * @param str the string
1320  * @param start the start of the UTF-8 character.
1321  * @param ch_return location to return the character
1322  * @param end_return location to return the byte index of next character
1323  */
1324 void
1325 _dbus_string_get_unichar (const DBusString *str,
1326                           int               start,
1327                           dbus_unichar_t   *ch_return,
1328                           int              *end_return)
1329 {
1330   int i, mask, len;
1331   dbus_unichar_t result;
1332   unsigned char c;
1333   unsigned char *p;
1334   DBUS_CONST_STRING_PREAMBLE (str);
1335   _dbus_assert (start >= 0);
1336   _dbus_assert (start <= real->len);
1337
1338   if (ch_return)
1339     *ch_return = 0;
1340   if (end_return)
1341     *end_return = real->len;
1342
1343   mask = 0;
1344   p = real->str + start;
1345   c = *p;
1346
1347   UTF8_COMPUTE (c, mask, len);
1348   if (len == -1)
1349     return;
1350   UTF8_GET (result, p, i, mask, len);
1351
1352   if (result == (dbus_unichar_t)-1)
1353     return;
1354
1355   if (ch_return)
1356     *ch_return = result;
1357   if (end_return)
1358     *end_return = start + len;
1359 }
1360
1361 /**
1362  * Finds the given substring in the string,
1363  * returning #TRUE and filling in the byte index
1364  * where the substring was found, if it was found.
1365  * Returns #FALSE if the substring wasn't found.
1366  * Sets *start to the length of the string if the substring
1367  * is not found.
1368  *
1369  * @param str the string
1370  * @param start where to start looking
1371  * @param substr the substring
1372  * @param found return location for where it was found, or #NULL
1373  * @returns #TRUE if found
1374  */
1375 dbus_bool_t
1376 _dbus_string_find (const DBusString *str,
1377                    int               start,
1378                    const char       *substr,
1379                    int              *found)
1380 {
1381   return _dbus_string_find_to (str, start,
1382                                ((const DBusRealString*)str)->len,
1383                                substr, found);
1384 }
1385
1386 /**
1387  * Finds the given substring in the string,
1388  * up to a certain position,
1389  * returning #TRUE and filling in the byte index
1390  * where the substring was found, if it was found.
1391  * Returns #FALSE if the substring wasn't found.
1392  * Sets *start to the length of the string if the substring
1393  * is not found.
1394  *
1395  * @param str the string
1396  * @param start where to start looking
1397  * @param end where to stop looking
1398  * @param substr the substring
1399  * @param found return location for where it was found, or #NULL
1400  * @returns #TRUE if found
1401  */
1402 dbus_bool_t
1403 _dbus_string_find_to (const DBusString *str,
1404                       int               start,
1405                       int               end,
1406                       const char       *substr,
1407                       int              *found)
1408 {
1409   int i;
1410   DBUS_CONST_STRING_PREAMBLE (str);
1411   _dbus_assert (substr != NULL);
1412   _dbus_assert (start <= real->len);
1413   _dbus_assert (start >= 0);
1414   _dbus_assert (substr != NULL);
1415   _dbus_assert (end <= real->len);
1416   _dbus_assert (start <= end);
1417
1418   /* we always "find" an empty string */
1419   if (*substr == '\0')
1420     {
1421       if (found)
1422         *found = start;
1423       return TRUE;
1424     }
1425
1426   i = start;
1427   while (i < end)
1428     {
1429       if (real->str[i] == substr[0])
1430         {
1431           int j = i + 1;
1432
1433           while (j < end)
1434             {
1435               if (substr[j - i] == '\0')
1436                 break;
1437               else if (real->str[j] != substr[j - i])
1438                 break;
1439
1440               ++j;
1441             }
1442
1443           if (substr[j - i] == '\0')
1444             {
1445               if (found)
1446                 *found = i;
1447               return TRUE;
1448             }
1449         }
1450
1451       ++i;
1452     }
1453
1454   if (found)
1455     *found = end;
1456
1457   return FALSE;
1458 }
1459
1460 /**
1461  * Find the given byte scanning backward from the given start.
1462  * Sets *found to -1 if the byte is not found.
1463  *
1464  * @param str the string
1465  * @param start the place to start scanning (will not find the byte at this point)
1466  * @param byte the byte to find
1467  * @param found return location for where it was found
1468  * @returns #TRUE if found
1469  */
1470 dbus_bool_t
1471 _dbus_string_find_byte_backward (const DBusString  *str,
1472                                  int                start,
1473                                  unsigned char      byte,
1474                                  int               *found)
1475 {
1476   int i;
1477   DBUS_CONST_STRING_PREAMBLE (str);
1478   _dbus_assert (start <= real->len);
1479   _dbus_assert (start >= 0);
1480   _dbus_assert (found != NULL);
1481
1482   i = start - 1;
1483   while (i >= 0)
1484     {
1485       if (real->str[i] == byte)
1486         break;
1487
1488       --i;
1489     }
1490
1491   if (found)
1492     *found = i;
1493
1494   return i >= 0;
1495 }
1496
1497 /**
1498  * Finds a blank (space or tab) in the string. Returns #TRUE
1499  * if found, #FALSE otherwise. If a blank is not found sets
1500  * *found to the length of the string.
1501  *
1502  * @param str the string
1503  * @param start byte index to start looking
1504  * @param found place to store the location of the first blank
1505  * @returns #TRUE if a blank was found
1506  */
1507 dbus_bool_t
1508 _dbus_string_find_blank (const DBusString *str,
1509                          int               start,
1510                          int              *found)
1511 {
1512   int i;
1513   DBUS_CONST_STRING_PREAMBLE (str);
1514   _dbus_assert (start <= real->len);
1515   _dbus_assert (start >= 0);
1516
1517   i = start;
1518   while (i < real->len)
1519     {
1520       if (real->str[i] == ' ' ||
1521           real->str[i] == '\t')
1522         {
1523           if (found)
1524             *found = i;
1525           return TRUE;
1526         }
1527
1528       ++i;
1529     }
1530
1531   if (found)
1532     *found = real->len;
1533
1534   return FALSE;
1535 }
1536
1537 /**
1538  * Skips blanks from start, storing the first non-blank in *end
1539  * (blank is space or tab).
1540  *
1541  * @param str the string
1542  * @param start where to start
1543  * @param end where to store the first non-blank byte index
1544  */
1545 void
1546 _dbus_string_skip_blank (const DBusString *str,
1547                          int               start,
1548                          int              *end)
1549 {
1550   int i;
1551   DBUS_CONST_STRING_PREAMBLE (str);
1552   _dbus_assert (start <= real->len);
1553   _dbus_assert (start >= 0);
1554
1555   i = start;
1556   while (i < real->len)
1557     {
1558       if (!(real->str[i] == ' ' ||
1559             real->str[i] == '\t'))
1560         break;
1561
1562       ++i;
1563     }
1564
1565   _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1566                                     real->str[i] == '\t'));
1567
1568   if (end)
1569     *end = i;
1570 }
1571
1572 /**
1573  * Skips whitespace from start, storing the first non-whitespace in *end.
1574  * (whitespace is space, tab, newline, CR).
1575  *
1576  * @param str the string
1577  * @param start where to start
1578  * @param end where to store the first non-whitespace byte index
1579  */
1580 void
1581 _dbus_string_skip_white (const DBusString *str,
1582                          int               start,
1583                          int              *end)
1584 {
1585   int i;
1586   DBUS_CONST_STRING_PREAMBLE (str);
1587   _dbus_assert (start <= real->len);
1588   _dbus_assert (start >= 0);
1589
1590   i = start;
1591   while (i < real->len)
1592     {
1593       if (!(real->str[i] == ' ' ||
1594             real->str[i] == '\n' ||
1595             real->str[i] == '\r' ||
1596             real->str[i] == '\t'))
1597         break;
1598
1599       ++i;
1600     }
1601
1602   _dbus_assert (i == real->len || !(real->str[i] == ' ' ||
1603                                     real->str[i] == '\t'));
1604
1605   if (end)
1606     *end = i;
1607 }
1608
1609 /**
1610  * Assigns a newline-terminated or \r\n-terminated line from the front
1611  * of the string to the given dest string. The dest string's previous
1612  * contents are deleted. If the source string contains no newline,
1613  * moves the entire source string to the dest string.
1614  *
1615  * @todo owen correctly notes that this is a stupid function (it was
1616  * written purely for test code,
1617  * e.g. dbus-message-builder.c). Probably should be enforced as test
1618  * code only with #ifdef DBUS_BUILD_TESTS
1619  *
1620  * @param source the source string
1621  * @param dest the destination string (contents are replaced)
1622  * @returns #FALSE if no memory, or source has length 0
1623  */
1624 dbus_bool_t
1625 _dbus_string_pop_line (DBusString *source,
1626                        DBusString *dest)
1627 {
1628   int eol;
1629   dbus_bool_t have_newline;
1630
1631   _dbus_string_set_length (dest, 0);
1632
1633   eol = 0;
1634   if (_dbus_string_find (source, 0, "\n", &eol))
1635     {
1636       have_newline = TRUE;
1637       eol += 1; /* include newline */
1638     }
1639   else
1640     {
1641       eol = _dbus_string_get_length (source);
1642       have_newline = FALSE;
1643     }
1644
1645   if (eol == 0)
1646     return FALSE; /* eof */
1647
1648   if (!_dbus_string_move_len (source, 0, eol,
1649                               dest, 0))
1650     {
1651       return FALSE;
1652     }
1653
1654   /* dump the newline and the \r if we have one */
1655   if (have_newline)
1656     {
1657       dbus_bool_t have_cr;
1658
1659       _dbus_assert (_dbus_string_get_length (dest) > 0);
1660
1661       if (_dbus_string_get_length (dest) > 1 &&
1662           _dbus_string_get_byte (dest,
1663                                  _dbus_string_get_length (dest) - 2) == '\r')
1664         have_cr = TRUE;
1665       else
1666         have_cr = FALSE;
1667
1668       _dbus_string_set_length (dest,
1669                                _dbus_string_get_length (dest) -
1670                                (have_cr ? 2 : 1));
1671     }
1672
1673   return TRUE;
1674 }
1675
1676 /**
1677  * Deletes up to and including the first blank space
1678  * in the string.
1679  *
1680  * @param str the string
1681  */
1682 void
1683 _dbus_string_delete_first_word (DBusString *str)
1684 {
1685   int i;
1686
1687   if (_dbus_string_find_blank (str, 0, &i))
1688     _dbus_string_skip_blank (str, i, &i);
1689
1690   _dbus_string_delete (str, 0, i);
1691 }
1692
1693 /**
1694  * Deletes any leading blanks in the string
1695  *
1696  * @param str the string
1697  */
1698 void
1699 _dbus_string_delete_leading_blanks (DBusString *str)
1700 {
1701   int i;
1702
1703   _dbus_string_skip_blank (str, 0, &i);
1704
1705   if (i > 0)
1706     _dbus_string_delete (str, 0, i);
1707 }
1708
1709 /**
1710  * Tests two DBusString for equality.
1711  *
1712  * @todo memcmp is probably faster
1713  *
1714  * @param a first string
1715  * @param b second string
1716  * @returns #TRUE if equal
1717  */
1718 dbus_bool_t
1719 _dbus_string_equal (const DBusString *a,
1720                     const DBusString *b)
1721 {
1722   const unsigned char *ap;
1723   const unsigned char *bp;
1724   const unsigned char *a_end;
1725   const DBusRealString *real_a = (const DBusRealString*) a;
1726   const DBusRealString *real_b = (const DBusRealString*) b;
1727   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1728   DBUS_GENERIC_STRING_PREAMBLE (real_b);
1729
1730   if (real_a->len != real_b->len)
1731     return FALSE;
1732
1733   ap = real_a->str;
1734   bp = real_b->str;
1735   a_end = real_a->str + real_a->len;
1736   while (ap != a_end)
1737     {
1738       if (*ap != *bp)
1739         return FALSE;
1740
1741       ++ap;
1742       ++bp;
1743     }
1744
1745   return TRUE;
1746 }
1747
1748 /**
1749  * Tests two DBusString for equality up to the given length.
1750  *
1751  * @todo write a unit test
1752  *
1753  * @todo memcmp is probably faster
1754  *
1755  * @param a first string
1756  * @param b second string
1757  * @param len the lengh
1758  * @returns #TRUE if equal for the given number of bytes
1759  */
1760 dbus_bool_t
1761 _dbus_string_equal_len (const DBusString *a,
1762                         const DBusString *b,
1763                         int               len)
1764 {
1765   const unsigned char *ap;
1766   const unsigned char *bp;
1767   const unsigned char *a_end;
1768   const DBusRealString *real_a = (const DBusRealString*) a;
1769   const DBusRealString *real_b = (const DBusRealString*) b;
1770   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1771   DBUS_GENERIC_STRING_PREAMBLE (real_b);
1772
1773   if (real_a->len != real_b->len &&
1774       (real_a->len < len || real_b->len < len))
1775     return FALSE;
1776
1777   ap = real_a->str;
1778   bp = real_b->str;
1779   a_end = real_a->str + MIN (real_a->len, len);
1780   while (ap != a_end)
1781     {
1782       if (*ap != *bp)
1783         return FALSE;
1784
1785       ++ap;
1786       ++bp;
1787     }
1788
1789   return TRUE;
1790 }
1791
1792 /**
1793  * Checks whether a string is equal to a C string.
1794  *
1795  * @param a the string
1796  * @param c_str the C string
1797  * @returns #TRUE if equal
1798  */
1799 dbus_bool_t
1800 _dbus_string_equal_c_str (const DBusString *a,
1801                           const char       *c_str)
1802 {
1803   const unsigned char *ap;
1804   const unsigned char *bp;
1805   const unsigned char *a_end;
1806   const DBusRealString *real_a = (const DBusRealString*) a;
1807   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1808   _dbus_assert (c_str != NULL);
1809
1810   ap = real_a->str;
1811   bp = (const unsigned char*) c_str;
1812   a_end = real_a->str + real_a->len;
1813   while (ap != a_end && *bp)
1814     {
1815       if (*ap != *bp)
1816         return FALSE;
1817
1818       ++ap;
1819       ++bp;
1820     }
1821
1822   if (ap != a_end || *bp)
1823     return FALSE;
1824
1825   return TRUE;
1826 }
1827
1828 /**
1829  * Checks whether a string starts with the given C string.
1830  *
1831  * @param a the string
1832  * @param c_str the C string
1833  * @returns #TRUE if string starts with it
1834  */
1835 dbus_bool_t
1836 _dbus_string_starts_with_c_str (const DBusString *a,
1837                                 const char       *c_str)
1838 {
1839   const unsigned char *ap;
1840   const unsigned char *bp;
1841   const unsigned char *a_end;
1842   const DBusRealString *real_a = (const DBusRealString*) a;
1843   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1844   _dbus_assert (c_str != NULL);
1845
1846   ap = real_a->str;
1847   bp = (const unsigned char*) c_str;
1848   a_end = real_a->str + real_a->len;
1849   while (ap != a_end && *bp)
1850     {
1851       if (*ap != *bp)
1852         return FALSE;
1853
1854       ++ap;
1855       ++bp;
1856     }
1857
1858   if (*bp == '\0')
1859     return TRUE;
1860   else
1861     return FALSE;
1862 }
1863
1864 /**
1865  * Returns whether a string ends with the given suffix
1866  *
1867  * @todo memcmp might make this faster.
1868  *
1869  * @param a the string
1870  * @param c_str the C-style string
1871  * @returns #TRUE if the string ends with the suffix
1872  */
1873 dbus_bool_t
1874 _dbus_string_ends_with_c_str (const DBusString *a,
1875                               const char       *c_str)
1876 {
1877   const unsigned char *ap;
1878   const unsigned char *bp;
1879   const unsigned char *a_end;
1880   unsigned long c_str_len;
1881   const DBusRealString *real_a = (const DBusRealString*) a;
1882   DBUS_GENERIC_STRING_PREAMBLE (real_a);
1883   _dbus_assert (c_str != NULL);
1884
1885   c_str_len = strlen (c_str);
1886   if (((unsigned long)real_a->len) < c_str_len)
1887     return FALSE;
1888
1889   ap = real_a->str + (real_a->len - c_str_len);
1890   bp = (const unsigned char*) c_str;
1891   a_end = real_a->str + real_a->len;
1892   while (ap != a_end)
1893     {
1894       if (*ap != *bp)
1895         return FALSE;
1896
1897       ++ap;
1898       ++bp;
1899     }
1900
1901   _dbus_assert (*ap == '\0');
1902   _dbus_assert (*bp == '\0');
1903
1904   return TRUE;
1905 }
1906
1907 static const signed char base64_table[] = {
1908   /* 0 */ 'A',
1909   /* 1 */ 'B',
1910   /* 2 */ 'C',
1911   /* 3 */ 'D',
1912   /* 4 */ 'E',
1913   /* 5 */ 'F',
1914   /* 6 */ 'G',
1915   /* 7 */ 'H',
1916   /* 8 */ 'I',
1917   /* 9 */ 'J',
1918   /* 10 */ 'K',
1919   /* 11 */ 'L',
1920   /* 12 */ 'M',
1921   /* 13 */ 'N',
1922   /* 14 */ 'O',
1923   /* 15 */ 'P',
1924   /* 16 */ 'Q',
1925   /* 17 */ 'R',
1926   /* 18 */ 'S',
1927   /* 19 */ 'T',
1928   /* 20 */ 'U',
1929   /* 21 */ 'V',
1930   /* 22 */ 'W',
1931   /* 23 */ 'X',
1932   /* 24 */ 'Y',
1933   /* 25 */ 'Z',
1934   /* 26 */ 'a',
1935   /* 27 */ 'b',
1936   /* 28 */ 'c',
1937   /* 29 */ 'd',
1938   /* 30 */ 'e',
1939   /* 31 */ 'f',
1940   /* 32 */ 'g',
1941   /* 33 */ 'h',
1942   /* 34 */ 'i',
1943   /* 35 */ 'j',
1944   /* 36 */ 'k',
1945   /* 37 */ 'l',
1946   /* 38 */ 'm',
1947   /* 39 */ 'n',
1948   /* 40 */ 'o',
1949   /* 41 */ 'p',
1950   /* 42 */ 'q',
1951   /* 43 */ 'r',
1952   /* 44 */ 's',
1953   /* 45 */ 't',
1954   /* 46 */ 'u',
1955   /* 47 */ 'v',
1956   /* 48 */ 'w',
1957   /* 49 */ 'x',
1958   /* 50 */ 'y',
1959   /* 51 */ 'z',
1960   /* 52 */ '0',
1961   /* 53 */ '1',
1962   /* 54 */ '2',
1963   /* 55 */ '3',
1964   /* 56 */ '4',
1965   /* 57 */ '5',
1966   /* 58 */ '6',
1967   /* 59 */ '7',
1968   /* 60 */ '8',
1969   /* 61 */ '9',
1970   /* 62 */ '+',
1971   /* 63 */ '/'
1972 };
1973
1974 /** The minimum char that's a valid char in Base64-encoded text */
1975 #define UNBASE64_MIN_CHAR (43)
1976 /** The maximum char that's a valid char in Base64-encoded text */
1977 #define UNBASE64_MAX_CHAR (122)
1978 /** Must subtract this from a char's integer value before offsetting
1979  * into unbase64_table
1980  */
1981 #define UNBASE64_TABLE_OFFSET UNBASE64_MIN_CHAR
1982 static const signed char unbase64_table[] = {
1983   /* 43 + */ 62,
1984   /* 44 , */ -1,
1985   /* 45 - */ -1,
1986   /* 46 . */ -1,
1987   /* 47 / */ 63,
1988   /* 48 0 */ 52,
1989   /* 49 1 */ 53,
1990   /* 50 2 */ 54,
1991   /* 51 3 */ 55,
1992   /* 52 4 */ 56,
1993   /* 53 5 */ 57,
1994   /* 54 6 */ 58,
1995   /* 55 7 */ 59,
1996   /* 56 8 */ 60,
1997   /* 57 9 */ 61,
1998   /* 58 : */ -1,
1999   /* 59 ; */ -1,
2000   /* 60 < */ -1,
2001   /* 61 = */ -1,
2002   /* 62 > */ -1,
2003   /* 63 ? */ -1,
2004   /* 64 @ */ -1,
2005   /* 65 A */ 0,
2006   /* 66 B */ 1,
2007   /* 67 C */ 2,
2008   /* 68 D */ 3,
2009   /* 69 E */ 4,
2010   /* 70 F */ 5,
2011   /* 71 G */ 6,
2012   /* 72 H */ 7,
2013   /* 73 I */ 8,
2014   /* 74 J */ 9,
2015   /* 75 K */ 10,
2016   /* 76 L */ 11,
2017   /* 77 M */ 12,
2018   /* 78 N */ 13,
2019   /* 79 O */ 14,
2020   /* 80 P */ 15,
2021   /* 81 Q */ 16,
2022   /* 82 R */ 17,
2023   /* 83 S */ 18,
2024   /* 84 T */ 19,
2025   /* 85 U */ 20,
2026   /* 86 V */ 21,
2027   /* 87 W */ 22,
2028   /* 88 X */ 23,
2029   /* 89 Y */ 24,
2030   /* 90 Z */ 25,
2031   /* 91 [ */ -1,
2032   /* 92 \ */ -1,
2033   /* 93 ] */ -1,
2034   /* 94 ^ */ -1,
2035   /* 95 _ */ -1,
2036   /* 96 ` */ -1,
2037   /* 97 a */ 26,
2038   /* 98 b */ 27,
2039   /* 99 c */ 28,
2040   /* 100 d */ 29,
2041   /* 101 e */ 30,
2042   /* 102 f */ 31,
2043   /* 103 g */ 32,
2044   /* 104 h */ 33,
2045   /* 105 i */ 34,
2046   /* 106 j */ 35,
2047   /* 107 k */ 36,
2048   /* 108 l */ 37,
2049   /* 109 m */ 38,
2050   /* 110 n */ 39,
2051   /* 111 o */ 40,
2052   /* 112 p */ 41,
2053   /* 113 q */ 42,
2054   /* 114 r */ 43,
2055   /* 115 s */ 44,
2056   /* 116 t */ 45,
2057   /* 117 u */ 46,
2058   /* 118 v */ 47,
2059   /* 119 w */ 48,
2060   /* 120 x */ 49,
2061   /* 121 y */ 50,
2062   /* 122 z */ 51
2063 };
2064
2065 /**
2066  * Encodes a string using Base64, as documented in RFC 2045.
2067  *
2068  * @param source the string to encode
2069  * @param start byte index to start encoding
2070  * @param dest string where encoded data should be placed
2071  * @param insert_at where to place encoded data
2072  * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2073  */
2074 dbus_bool_t
2075 _dbus_string_base64_encode (const DBusString *source,
2076                             int               start,
2077                             DBusString       *dest,
2078                             int               insert_at)
2079 {
2080   int source_len;
2081   unsigned int dest_len; /* unsigned for overflow checks below */
2082   const unsigned char *s;
2083   unsigned char *d;
2084   const unsigned char *triplet_end;
2085   const unsigned char *final_end;
2086   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2087   _dbus_assert (source != dest);
2088
2089   /* For each 24 bits (3 bytes) of input, we have 4 bytes of
2090    * output.
2091    */
2092   source_len = real_source->len - start;
2093   dest_len = (source_len / 3) * 4;
2094   if (source_len % 3 != 0)
2095     dest_len += 4;
2096
2097   if (dest_len > (unsigned int) real_dest->max_length)
2098     return FALSE;
2099
2100   if (source_len == 0)
2101     return TRUE;
2102
2103   if (!open_gap (dest_len, real_dest, insert_at))
2104     return FALSE;
2105
2106   d = real_dest->str + insert_at;
2107   s = real_source->str + start;
2108   final_end = real_source->str + (start + source_len);
2109   triplet_end = final_end - (source_len % 3);
2110   _dbus_assert (triplet_end <= final_end);
2111   _dbus_assert ((final_end - triplet_end) < 3);
2112
2113 #define ENCODE_64(v) (base64_table[ (unsigned char) (v) ])
2114 #define SIX_BITS_MASK (0x3f)
2115   _dbus_assert (SIX_BITS_MASK < _DBUS_N_ELEMENTS (base64_table));
2116
2117   while (s != triplet_end)
2118     {
2119       unsigned int triplet;
2120
2121       triplet = s[2] | (s[1] << 8) | (s[0] << 16);
2122
2123       /* Encode each 6 bits. */
2124
2125       *d++ = ENCODE_64 (triplet >> 18);
2126       *d++ = ENCODE_64 ((triplet >> 12) & SIX_BITS_MASK);
2127       *d++ = ENCODE_64 ((triplet >> 6) & SIX_BITS_MASK);
2128       *d++ = ENCODE_64 (triplet & SIX_BITS_MASK);
2129
2130       s += 3;
2131     }
2132
2133   switch (final_end - triplet_end)
2134     {
2135     case 2:
2136       {
2137         unsigned int doublet;
2138
2139         doublet = s[1] | (s[0] << 8);
2140
2141         *d++ = ENCODE_64 (doublet >> 12);
2142         *d++ = ENCODE_64 ((doublet >> 6) & SIX_BITS_MASK);
2143         *d++ = ENCODE_64 (doublet & SIX_BITS_MASK);
2144         *d++ = '=';
2145       }
2146       break;
2147     case 1:
2148       {
2149         unsigned int singlet;
2150
2151         singlet = s[0];
2152
2153         *d++ = ENCODE_64 ((singlet >> 6) & SIX_BITS_MASK);
2154         *d++ = ENCODE_64 (singlet & SIX_BITS_MASK);
2155         *d++ = '=';
2156         *d++ = '=';
2157       }
2158       break;
2159     case 0:
2160       break;
2161     }
2162
2163   _dbus_assert (d == (real_dest->str + (insert_at + dest_len)));
2164
2165   return TRUE;
2166 }
2167
2168 /**
2169  * Decodes a string from Base64, as documented in RFC 2045.
2170  *
2171  * @todo sort out the AUDIT comment in here. The case it mentions
2172  * ("====" or "x===") is not allowed in correct base64, so need to
2173  * decide what to do with that kind of input. Probably ignore it
2174  * since we ignore any other junk seen.
2175  *
2176  * @param source the string to decode
2177  * @param start byte index to start decode
2178  * @param dest string where decoded data should be placed
2179  * @param insert_at where to place decoded data
2180  * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2181  */
2182 dbus_bool_t
2183 _dbus_string_base64_decode (const DBusString *source,
2184                             int               start,
2185                             DBusString       *dest,
2186                             int               insert_at)
2187 {
2188   int source_len;
2189   const char *s;
2190   const char *end;
2191   DBusString result;
2192   unsigned int triplet = 0;
2193   int sextet_count;
2194   int pad_count;
2195   DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);
2196   _dbus_assert (source != dest);
2197
2198   source_len = real_source->len - start;
2199   s = real_source->str + start;
2200   end = real_source->str + source_len;
2201
2202   if (source_len == 0)
2203     return TRUE;
2204
2205   if (!_dbus_string_init (&result))
2206     return FALSE;
2207
2208   pad_count = 0;
2209   sextet_count = 0;
2210   while (s != end)
2211     {
2212       /* The idea is to just skip anything that isn't
2213        * a base64 char - it's allowed to have whitespace,
2214        * newlines, etc. in here. We also ignore trailing
2215        * base64 chars, though that's suspicious.
2216        */
2217
2218       if (*s >= UNBASE64_MIN_CHAR &&
2219           *s <= UNBASE64_MAX_CHAR)
2220         {
2221           if (*s == '=')
2222             {
2223               /* '=' is padding, doesn't represent additional data
2224                * but does increment our count.
2225                */
2226               pad_count += 1;
2227               sextet_count += 1;
2228             }
2229           else
2230             {
2231               int val;
2232
2233               val = unbase64_table[(*s) - UNBASE64_TABLE_OFFSET];
2234
2235               if (val >= 0)
2236                 {
2237                   triplet <<= 6;
2238                   triplet |= (unsigned int) val;
2239                   sextet_count += 1;
2240                 }
2241             }
2242
2243           if (sextet_count == 4)
2244             {
2245               /* no pad = 3 bytes, 1 pad = 2 bytes, 2 pad = 1 byte */
2246
2247
2248               /* AUDIT: Comment doesn't mention 4 pad => 0,
2249                *         3 pad => 1 byte, though the code should
2250                *        work fine if those are the required outputs.
2251                *
2252                *        I assume that the spec requires dropping
2253                *        the top two bits of, say, ///= which is > 2
2254                *        bytes worth of bits. (Or otherwise, you couldn't
2255                *        actually represent 2 byte sequences.
2256                */
2257
2258               if (pad_count < 1)
2259                 {
2260                   if (!_dbus_string_append_byte (&result,
2261                                                  triplet >> 16))
2262                     goto failed;
2263                 }
2264
2265               if (pad_count < 2)
2266                 {
2267                   if (!_dbus_string_append_byte (&result,
2268                                                  (triplet >> 8) & 0xff))
2269                     goto failed;
2270                 }
2271
2272               if (!_dbus_string_append_byte (&result,
2273                                              triplet & 0xff))
2274                 goto failed;
2275
2276               sextet_count = 0;
2277               pad_count = 0;
2278               triplet = 0;
2279             }
2280         }
2281
2282       ++s;
2283     }
2284
2285   if (!_dbus_string_move (&result, 0, dest, insert_at))
2286     {
2287       _dbus_string_free (&result);
2288       return FALSE;
2289     }
2290
2291   _dbus_string_free (&result);
2292
2293   return TRUE;
2294
2295  failed:
2296   _dbus_string_free (&result);
2297
2298   return FALSE;
2299 }
2300
2301 /**
2302  * Encodes a string in hex, the way MD5 and SHA-1 are usually
2303  * encoded. (Each byte is two hex digits.)
2304  *
2305  * @param source the string to encode
2306  * @param start byte index to start encoding
2307  * @param dest string where encoded data should be placed
2308  * @param insert_at where to place encoded data
2309  * @returns #TRUE if encoding was successful, #FALSE if no memory etc.
2310  */
2311 dbus_bool_t
2312 _dbus_string_hex_encode (const DBusString *source,
2313                          int               start,
2314                          DBusString       *dest,
2315                          int               insert_at)
2316 {
2317   DBusString result;
2318   const char hexdigits[16] = {
2319     '0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
2320     'a', 'b', 'c', 'd', 'e', 'f'
2321   };
2322   const unsigned char *p;
2323   const unsigned char *end;
2324   dbus_bool_t retval;
2325
2326   _dbus_assert (start <= _dbus_string_get_length (source));
2327
2328   if (!_dbus_string_init (&result))
2329     return FALSE;
2330
2331   retval = FALSE;
2332
2333   p = (const unsigned char*) _dbus_string_get_const_data (source);
2334   end = p + _dbus_string_get_length (source);
2335   p += start;
2336
2337   while (p != end)
2338     {
2339       if (!_dbus_string_append_byte (&result,
2340                                      hexdigits[(*p >> 4)]))
2341         goto out;
2342
2343       if (!_dbus_string_append_byte (&result,
2344                                      hexdigits[(*p & 0x0f)]))
2345         goto out;
2346
2347       ++p;
2348     }
2349
2350   if (!_dbus_string_move (&result, 0, dest, insert_at))
2351     goto out;
2352
2353   retval = TRUE;
2354
2355  out:
2356   _dbus_string_free (&result);
2357   return retval;
2358 }
2359
2360 /**
2361  * Decodes a string from hex encoding.
2362  *
2363  * @param source the string to decode
2364  * @param start byte index to start decode
2365  * @param dest string where decoded data should be placed
2366  * @param insert_at where to place decoded data
2367  * @returns #TRUE if decoding was successful, #FALSE if no memory etc.
2368  */
2369 dbus_bool_t
2370 _dbus_string_hex_decode (const DBusString *source,
2371                          int               start,
2372                          DBusString       *dest,
2373                          int               insert_at)
2374 {
2375   DBusString result;
2376   const unsigned char *p;
2377   const unsigned char *end;
2378   dbus_bool_t retval;
2379   dbus_bool_t high_bits;
2380
2381   _dbus_assert (start <= _dbus_string_get_length (source));
2382
2383   if (!_dbus_string_init (&result))
2384     return FALSE;
2385
2386   retval = FALSE;
2387
2388   high_bits = TRUE;
2389   p = (const unsigned char*) _dbus_string_get_const_data (source);
2390   end = p + _dbus_string_get_length (source);
2391   p += start;
2392
2393   while (p != end)
2394     {
2395       unsigned int val;
2396
2397       switch (*p)
2398         {
2399         case '0':
2400           val = 0;
2401           break;
2402         case '1':
2403           val = 1;
2404           break;
2405         case '2':
2406           val = 2;
2407           break;
2408         case '3':
2409           val = 3;
2410           break;
2411         case '4':
2412           val = 4;
2413           break;
2414         case '5':
2415           val = 5;
2416           break;
2417         case '6':
2418           val = 6;
2419           break;
2420         case '7':
2421           val = 7;
2422           break;
2423         case '8':
2424           val = 8;
2425           break;
2426         case '9':
2427           val = 9;
2428           break;
2429         case 'a':
2430         case 'A':
2431           val = 10;
2432           break;
2433         case 'b':
2434         case 'B':
2435           val = 11;
2436           break;
2437         case 'c':
2438         case 'C':
2439           val = 12;
2440           break;
2441         case 'd':
2442         case 'D':
2443           val = 13;
2444           break;
2445         case 'e':
2446         case 'E':
2447           val = 14;
2448           break;
2449         case 'f':
2450         case 'F':
2451           val = 15;
2452           break;
2453         default:
2454           val = 0;
2455           _dbus_verbose ("invalid character '%c' in hex encoded text\n",
2456                          *p);
2457           goto out;
2458         }
2459
2460       if (high_bits)
2461         {
2462           if (!_dbus_string_append_byte (&result,
2463                                          val << 4))
2464             goto out;
2465         }
2466       else
2467         {
2468           int len;
2469           unsigned char b;
2470
2471           len = _dbus_string_get_length (&result);
2472
2473           b = _dbus_string_get_byte (&result, len - 1);
2474
2475           b |= val;
2476
2477           _dbus_string_set_byte (&result, len - 1, b);
2478         }
2479
2480       high_bits = !high_bits;
2481
2482       ++p;
2483     }
2484
2485   if (!_dbus_string_move (&result, 0, dest, insert_at))
2486     goto out;
2487
2488   retval = TRUE;
2489
2490  out:
2491   _dbus_string_free (&result);
2492   return retval;
2493 }
2494
2495 /**
2496  * Checks that the given range of the string is valid ASCII with no
2497  * nul bytes. If the given range is not entirely contained in the
2498  * string, returns #FALSE.
2499  *
2500  * @todo this is inconsistent with most of DBusString in that
2501  * it allows a start,len range that isn't in the string.
2502  *
2503  * @param str the string
2504  * @param start first byte index to check
2505  * @param len number of bytes to check
2506  * @returns #TRUE if the byte range exists and is all valid ASCII
2507  */
2508 dbus_bool_t
2509 _dbus_string_validate_ascii (const DBusString *str,
2510                              int               start,
2511                              int               len)
2512 {
2513   const unsigned char *s;
2514   const unsigned char *end;
2515   DBUS_CONST_STRING_PREAMBLE (str);
2516   _dbus_assert (start >= 0);
2517   _dbus_assert (start <= real->len);
2518   _dbus_assert (len >= 0);
2519
2520   if (len > real->len - start)
2521     return FALSE;
2522
2523   s = real->str + start;
2524   end = s + len;
2525   while (s != end)
2526     {
2527       if (*s == '\0' ||
2528           ((*s & ~0x7f) != 0))
2529         return FALSE;
2530
2531       ++s;
2532     }
2533
2534   return TRUE;
2535 }
2536
2537 /**
2538  * Checks that the given range of the string is valid UTF-8. If the
2539  * given range is not entirely contained in the string, returns
2540  * #FALSE. If the string contains any nul bytes in the given range,
2541  * returns #FALSE. If the start and start+len are not on character
2542  * boundaries, returns #FALSE.
2543  *
2544  * @todo this is inconsistent with most of DBusString in that
2545  * it allows a start,len range that isn't in the string.
2546  *
2547  * @param str the string
2548  * @param start first byte index to check
2549  * @param len number of bytes to check
2550  * @returns #TRUE if the byte range exists and is all valid UTF-8
2551  */
2552 dbus_bool_t
2553 _dbus_string_validate_utf8  (const DBusString *str,
2554                              int               start,
2555                              int               len)
2556 {
2557   const unsigned char *p;
2558   const unsigned char *end;
2559   DBUS_CONST_STRING_PREAMBLE (str);
2560   _dbus_assert (start >= 0);
2561   _dbus_assert (start <= real->len);
2562   _dbus_assert (len >= 0);
2563
2564   if (len > real->len - start)
2565     return FALSE;
2566
2567   p = real->str + start;
2568   end = p + len;
2569
2570   while (p < end)
2571     {
2572       int i, mask = 0, char_len;
2573       dbus_unichar_t result;
2574       unsigned char c = (unsigned char) *p;
2575
2576       UTF8_COMPUTE (c, mask, char_len);
2577
2578       if (char_len == -1)
2579         break;
2580
2581       /* check that the expected number of bytes exists in the remaining length */
2582       if ((end - p) < char_len)
2583         break;
2584
2585       UTF8_GET (result, p, i, mask, char_len);
2586
2587       if (UTF8_LENGTH (result) != char_len) /* Check for overlong UTF-8 */
2588         break;
2589
2590       if (result == (dbus_unichar_t)-1)
2591         break;
2592
2593       if (!UNICODE_VALID (result))
2594         break;
2595
2596       p += char_len;
2597     }
2598
2599   /* See that we covered the entire length if a length was
2600    * passed in
2601    */
2602   if (p != end)
2603     return FALSE;
2604   else
2605     return TRUE;
2606 }
2607
2608 /**
2609  * Checks that the given range of the string is all nul bytes. If the
2610  * given range is not entirely contained in the string, returns
2611  * #FALSE.
2612  *
2613  * @todo this is inconsistent with most of DBusString in that
2614  * it allows a start,len range that isn't in the string.
2615  *
2616  * @param str the string
2617  * @param start first byte index to check
2618  * @param len number of bytes to check
2619  * @returns #TRUE if the byte range exists and is all nul bytes
2620  */
2621 dbus_bool_t
2622 _dbus_string_validate_nul (const DBusString *str,
2623                            int               start,
2624                            int               len)
2625 {
2626   const unsigned char *s;
2627   const unsigned char *end;
2628   DBUS_CONST_STRING_PREAMBLE (str);
2629   _dbus_assert (start >= 0);
2630   _dbus_assert (len >= 0);
2631   _dbus_assert (start <= real->len);
2632
2633   if (len > real->len - start)
2634     return FALSE;
2635
2636   s = real->str + start;
2637   end = s + len;
2638   while (s != end)
2639     {
2640       if (*s != '\0')
2641         return FALSE;
2642       ++s;
2643     }
2644
2645   return TRUE;
2646 }
2647
2648 /**
2649  * Clears all allocated bytes in the string to zero.
2650  *
2651  * @param str the string
2652  */
2653 void
2654 _dbus_string_zero (DBusString *str)
2655 {
2656   DBUS_STRING_PREAMBLE (str);
2657
2658   memset (real->str, '\0', real->allocated);
2659 }
2660 /** @} */
2661
2662 #ifdef DBUS_BUILD_TESTS
2663 #include "dbus-test.h"
2664 #include <stdio.h>
2665
2666 static void
2667 test_max_len (DBusString *str,
2668               int         max_len)
2669 {
2670   if (max_len > 0)
2671     {
2672       if (!_dbus_string_set_length (str, max_len - 1))
2673         _dbus_assert_not_reached ("setting len to one less than max should have worked");
2674     }
2675
2676   if (!_dbus_string_set_length (str, max_len))
2677     _dbus_assert_not_reached ("setting len to max len should have worked");
2678
2679   if (_dbus_string_set_length (str, max_len + 1))
2680     _dbus_assert_not_reached ("setting len to one more than max len should not have worked");
2681
2682   if (!_dbus_string_set_length (str, 0))
2683     _dbus_assert_not_reached ("setting len to zero should have worked");
2684 }
2685
2686 static void
2687 test_base64_roundtrip (const unsigned char *data,
2688                        int                  len)
2689 {
2690   DBusString orig;
2691   DBusString encoded;
2692   DBusString decoded;
2693
2694   if (len < 0)
2695     len = strlen (data);
2696
2697   if (!_dbus_string_init (&orig))
2698     _dbus_assert_not_reached ("could not init string");
2699
2700   if (!_dbus_string_init (&encoded))
2701     _dbus_assert_not_reached ("could not init string");
2702
2703   if (!_dbus_string_init (&decoded))
2704     _dbus_assert_not_reached ("could not init string");
2705
2706   if (!_dbus_string_append_len (&orig, data, len))
2707     _dbus_assert_not_reached ("couldn't append orig data");
2708
2709   if (!_dbus_string_base64_encode (&orig, 0, &encoded, 0))
2710     _dbus_assert_not_reached ("could not encode");
2711
2712   if (!_dbus_string_base64_decode (&encoded, 0, &decoded, 0))
2713     _dbus_assert_not_reached ("could not decode");
2714
2715   if (!_dbus_string_equal (&orig, &decoded))
2716     {
2717       const char *s;
2718
2719       printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
2720               _dbus_string_get_length (&orig),
2721               _dbus_string_get_length (&encoded),
2722               _dbus_string_get_length (&decoded));
2723       printf ("Original: %s\n", data);
2724       s = _dbus_string_get_const_data (&decoded);
2725       printf ("Decoded: %s\n", s);
2726       _dbus_assert_not_reached ("original string not the same as string decoded from base64");
2727     }
2728
2729   _dbus_string_free (&orig);
2730   _dbus_string_free (&encoded);
2731   _dbus_string_free (&decoded);
2732 }
2733
2734 static void
2735 test_hex_roundtrip (const unsigned char *data,
2736                     int                  len)
2737 {
2738   DBusString orig;
2739   DBusString encoded;
2740   DBusString decoded;
2741
2742   if (len < 0)
2743     len = strlen (data);
2744
2745   if (!_dbus_string_init (&orig))
2746     _dbus_assert_not_reached ("could not init string");
2747
2748   if (!_dbus_string_init (&encoded))
2749     _dbus_assert_not_reached ("could not init string");
2750
2751   if (!_dbus_string_init (&decoded))
2752     _dbus_assert_not_reached ("could not init string");
2753
2754   if (!_dbus_string_append_len (&orig, data, len))
2755     _dbus_assert_not_reached ("couldn't append orig data");
2756
2757   if (!_dbus_string_hex_encode (&orig, 0, &encoded, 0))
2758     _dbus_assert_not_reached ("could not encode");
2759
2760   if (!_dbus_string_hex_decode (&encoded, 0, &decoded, 0))
2761     _dbus_assert_not_reached ("could not decode");
2762
2763   if (!_dbus_string_equal (&orig, &decoded))
2764     {
2765       const char *s;
2766
2767       printf ("Original string %d bytes encoded %d bytes decoded %d bytes\n",
2768               _dbus_string_get_length (&orig),
2769               _dbus_string_get_length (&encoded),
2770               _dbus_string_get_length (&decoded));
2771       printf ("Original: %s\n", data);
2772       s = _dbus_string_get_const_data (&decoded);
2773       printf ("Decoded: %s\n", s);
2774       _dbus_assert_not_reached ("original string not the same as string decoded from base64");
2775     }
2776
2777   _dbus_string_free (&orig);
2778   _dbus_string_free (&encoded);
2779   _dbus_string_free (&decoded);
2780 }
2781
2782 typedef void (* TestRoundtripFunc) (const unsigned char *data,
2783                                     int                  len);
2784 static void
2785 test_roundtrips (TestRoundtripFunc func)
2786 {
2787   (* func) ("Hello this is a string\n", -1);
2788   (* func) ("Hello this is a string\n1", -1);
2789   (* func) ("Hello this is a string\n12", -1);
2790   (* func) ("Hello this is a string\n123", -1);
2791   (* func) ("Hello this is a string\n1234", -1);
2792   (* func) ("Hello this is a string\n12345", -1);
2793   (* func) ("", 0);
2794   (* func) ("1", 1);
2795   (* func) ("12", 2);
2796   (* func) ("123", 3);
2797   (* func) ("1234", 4);
2798   (* func) ("12345", 5);
2799   (* func) ("", 1);
2800   (* func) ("1", 2);
2801   (* func) ("12", 3);
2802   (* func) ("123", 4);
2803   (* func) ("1234", 5);
2804   (* func) ("12345", 6);
2805   {
2806     unsigned char buf[512];
2807     int i;
2808
2809     i = 0;
2810     while (i < _DBUS_N_ELEMENTS (buf))
2811       {
2812         buf[i] = i;
2813         ++i;
2814       }
2815     i = 0;
2816     while (i < _DBUS_N_ELEMENTS (buf))
2817       {
2818         (* func) (buf, i);
2819         ++i;
2820       }
2821   }
2822 }
2823
2824
2825 /**
2826  * @ingroup DBusStringInternals
2827  * Unit test for DBusString.
2828  *
2829  * @todo Need to write tests for _dbus_string_copy() and
2830  * _dbus_string_move() moving to/from each of start/middle/end of a
2831  * string. Also need tests for _dbus_string_move_len ()
2832  *
2833  * @returns #TRUE on success.
2834  */
2835 dbus_bool_t
2836 _dbus_string_test (void)
2837 {
2838   DBusString str;
2839   DBusString other;
2840   int i, end;
2841   long v;
2842   double d;
2843   int lens[] = { 0, 1, 2, 3, 4, 5, 10, 16, 17, 18, 25, 31, 32, 33, 34, 35, 63, 64, 65, 66, 67, 68, 69, 70, 71, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136 };
2844   char *s;
2845   dbus_unichar_t ch;
2846
2847   i = 0;
2848   while (i < _DBUS_N_ELEMENTS (lens))
2849     {
2850       if (!_dbus_string_init (&str))
2851         _dbus_assert_not_reached ("failed to init string");
2852
2853       set_max_length (&str, lens[i]);
2854
2855       test_max_len (&str, lens[i]);
2856       _dbus_string_free (&str);
2857
2858       ++i;
2859     }
2860
2861   /* Test shortening and setting length */
2862   i = 0;
2863   while (i < _DBUS_N_ELEMENTS (lens))
2864     {
2865       int j;
2866
2867       if (!_dbus_string_init (&str))
2868         _dbus_assert_not_reached ("failed to init string");
2869
2870       set_max_length (&str, lens[i]);
2871
2872       if (!_dbus_string_set_length (&str, lens[i]))
2873         _dbus_assert_not_reached ("failed to set string length");
2874
2875       j = lens[i];
2876       while (j > 0)
2877         {
2878           _dbus_assert (_dbus_string_get_length (&str) == j);
2879           if (j > 0)
2880             {
2881               _dbus_string_shorten (&str, 1);
2882               _dbus_assert (_dbus_string_get_length (&str) == (j - 1));
2883             }
2884           --j;
2885         }
2886
2887       _dbus_string_free (&str);
2888
2889       ++i;
2890     }
2891
2892   /* Test appending data */
2893   if (!_dbus_string_init (&str))
2894     _dbus_assert_not_reached ("failed to init string");
2895
2896   i = 0;
2897   while (i < 10)
2898     {
2899       if (!_dbus_string_append (&str, "a"))
2900         _dbus_assert_not_reached ("failed to append string to string\n");
2901
2902       _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 1);
2903
2904       if (!_dbus_string_append_byte (&str, 'b'))
2905         _dbus_assert_not_reached ("failed to append byte to string\n");
2906
2907       _dbus_assert (_dbus_string_get_length (&str) == i * 2 + 2);
2908
2909       ++i;
2910     }
2911
2912   _dbus_string_free (&str);
2913
2914   /* Check steal_data */
2915
2916   if (!_dbus_string_init (&str))
2917     _dbus_assert_not_reached ("failed to init string");
2918
2919   if (!_dbus_string_append (&str, "Hello World"))
2920     _dbus_assert_not_reached ("could not append to string");
2921
2922   i = _dbus_string_get_length (&str);
2923
2924   if (!_dbus_string_steal_data (&str, &s))
2925     _dbus_assert_not_reached ("failed to steal data");
2926
2927   _dbus_assert (_dbus_string_get_length (&str) == 0);
2928   _dbus_assert (((int)strlen (s)) == i);
2929
2930   dbus_free (s);
2931
2932   /* Check move */
2933
2934   if (!_dbus_string_append (&str, "Hello World"))
2935     _dbus_assert_not_reached ("could not append to string");
2936
2937   i = _dbus_string_get_length (&str);
2938
2939   if (!_dbus_string_init (&other))
2940     _dbus_assert_not_reached ("could not init string");
2941
2942   if (!_dbus_string_move (&str, 0, &other, 0))
2943     _dbus_assert_not_reached ("could not move");
2944
2945   _dbus_assert (_dbus_string_get_length (&str) == 0);
2946   _dbus_assert (_dbus_string_get_length (&other) == i);
2947
2948   if (!_dbus_string_append (&str, "Hello World"))
2949     _dbus_assert_not_reached ("could not append to string");
2950
2951   if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other)))
2952     _dbus_assert_not_reached ("could not move");
2953
2954   _dbus_assert (_dbus_string_get_length (&str) == 0);
2955   _dbus_assert (_dbus_string_get_length (&other) == i * 2);
2956
2957     if (!_dbus_string_append (&str, "Hello World"))
2958     _dbus_assert_not_reached ("could not append to string");
2959
2960   if (!_dbus_string_move (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2961     _dbus_assert_not_reached ("could not move");
2962
2963   _dbus_assert (_dbus_string_get_length (&str) == 0);
2964   _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2965
2966   _dbus_string_free (&other);
2967
2968   /* Check copy */
2969
2970   if (!_dbus_string_append (&str, "Hello World"))
2971     _dbus_assert_not_reached ("could not append to string");
2972
2973   i = _dbus_string_get_length (&str);
2974
2975   if (!_dbus_string_init (&other))
2976     _dbus_assert_not_reached ("could not init string");
2977
2978   if (!_dbus_string_copy (&str, 0, &other, 0))
2979     _dbus_assert_not_reached ("could not copy");
2980
2981   _dbus_assert (_dbus_string_get_length (&str) == i);
2982   _dbus_assert (_dbus_string_get_length (&other) == i);
2983
2984   if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other)))
2985     _dbus_assert_not_reached ("could not copy");
2986
2987   _dbus_assert (_dbus_string_get_length (&str) == i);
2988   _dbus_assert (_dbus_string_get_length (&other) == i * 2);
2989   _dbus_assert (_dbus_string_equal_c_str (&other,
2990                                           "Hello WorldHello World"));
2991
2992   if (!_dbus_string_copy (&str, 0, &other, _dbus_string_get_length (&other) / 2))
2993     _dbus_assert_not_reached ("could not copy");
2994
2995   _dbus_assert (_dbus_string_get_length (&str) == i);
2996   _dbus_assert (_dbus_string_get_length (&other) == i * 3);
2997   _dbus_assert (_dbus_string_equal_c_str (&other,
2998                                           "Hello WorldHello WorldHello World"));
2999
3000   _dbus_string_free (&str);
3001   _dbus_string_free (&other);
3002
3003   /* Check replace */
3004
3005   if (!_dbus_string_init (&str))
3006     _dbus_assert_not_reached ("failed to init string");
3007
3008   if (!_dbus_string_append (&str, "Hello World"))
3009     _dbus_assert_not_reached ("could not append to string");
3010
3011   i = _dbus_string_get_length (&str);
3012
3013   if (!_dbus_string_init (&other))
3014     _dbus_assert_not_reached ("could not init string");
3015
3016   if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3017                                  &other, 0, _dbus_string_get_length (&other)))
3018     _dbus_assert_not_reached ("could not replace");
3019
3020   _dbus_assert (_dbus_string_get_length (&str) == i);
3021   _dbus_assert (_dbus_string_get_length (&other) == i);
3022   _dbus_assert (_dbus_string_equal_c_str (&other, "Hello World"));
3023
3024   if (!_dbus_string_replace_len (&str, 0, _dbus_string_get_length (&str),
3025                                  &other, 5, 1))
3026     _dbus_assert_not_reached ("could not replace center space");
3027
3028   _dbus_assert (_dbus_string_get_length (&str) == i);
3029   _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3030   _dbus_assert (_dbus_string_equal_c_str (&other,
3031                                           "HelloHello WorldWorld"));
3032
3033
3034   if (!_dbus_string_replace_len (&str, 1, 1,
3035                                  &other,
3036                                  _dbus_string_get_length (&other) - 1,
3037                                  1))
3038     _dbus_assert_not_reached ("could not replace end character");
3039
3040   _dbus_assert (_dbus_string_get_length (&str) == i);
3041   _dbus_assert (_dbus_string_get_length (&other) == i * 2 - 1);
3042   _dbus_assert (_dbus_string_equal_c_str (&other,
3043                                           "HelloHello WorldWorle"));
3044
3045   _dbus_string_free (&str);
3046   _dbus_string_free (&other);
3047
3048   /* Check append/get unichar */
3049
3050   if (!_dbus_string_init (&str))
3051     _dbus_assert_not_reached ("failed to init string");
3052
3053   ch = 0;
3054   if (!_dbus_string_append_unichar (&str, 0xfffc))
3055     _dbus_assert_not_reached ("failed to append unichar");
3056
3057   _dbus_string_get_unichar (&str, 0, &ch, &i);
3058
3059   _dbus_assert (ch == 0xfffc);
3060   _dbus_assert (i == _dbus_string_get_length (&str));
3061
3062   _dbus_string_free (&str);
3063
3064   /* Check insert/set/get byte */
3065
3066   if (!_dbus_string_init (&str))
3067     _dbus_assert_not_reached ("failed to init string");
3068
3069   if (!_dbus_string_append (&str, "Hello"))
3070     _dbus_assert_not_reached ("failed to append Hello");
3071
3072   _dbus_assert (_dbus_string_get_byte (&str, 0) == 'H');
3073   _dbus_assert (_dbus_string_get_byte (&str, 1) == 'e');
3074   _dbus_assert (_dbus_string_get_byte (&str, 2) == 'l');
3075   _dbus_assert (_dbus_string_get_byte (&str, 3) == 'l');
3076   _dbus_assert (_dbus_string_get_byte (&str, 4) == 'o');
3077
3078   _dbus_string_set_byte (&str, 1, 'q');
3079   _dbus_assert (_dbus_string_get_byte (&str, 1) == 'q');
3080
3081   if (!_dbus_string_insert_byte (&str, 0, 255))
3082     _dbus_assert_not_reached ("can't insert byte");
3083
3084   if (!_dbus_string_insert_byte (&str, 2, 'Z'))
3085     _dbus_assert_not_reached ("can't insert byte");
3086
3087   if (!_dbus_string_insert_byte (&str, _dbus_string_get_length (&str), 'W'))
3088     _dbus_assert_not_reached ("can't insert byte");
3089
3090   _dbus_assert (_dbus_string_get_byte (&str, 0) == 255);
3091   _dbus_assert (_dbus_string_get_byte (&str, 1) == 'H');
3092   _dbus_assert (_dbus_string_get_byte (&str, 2) == 'Z');
3093   _dbus_assert (_dbus_string_get_byte (&str, 3) == 'q');
3094   _dbus_assert (_dbus_string_get_byte (&str, 4) == 'l');
3095   _dbus_assert (_dbus_string_get_byte (&str, 5) == 'l');
3096   _dbus_assert (_dbus_string_get_byte (&str, 6) == 'o');
3097   _dbus_assert (_dbus_string_get_byte (&str, 7) == 'W');
3098
3099   _dbus_string_free (&str);
3100
3101   /* Check append/parse int/double */
3102
3103   if (!_dbus_string_init (&str))
3104     _dbus_assert_not_reached ("failed to init string");
3105
3106   if (!_dbus_string_append_int (&str, 27))
3107     _dbus_assert_not_reached ("failed to append int");
3108
3109   i = _dbus_string_get_length (&str);
3110
3111   if (!_dbus_string_parse_int (&str, 0, &v, &end))
3112     _dbus_assert_not_reached ("failed to parse int");
3113
3114   _dbus_assert (v == 27);
3115   _dbus_assert (end == i);
3116
3117   _dbus_string_free (&str);
3118
3119   if (!_dbus_string_init (&str))
3120     _dbus_assert_not_reached ("failed to init string");
3121
3122   if (!_dbus_string_append_double (&str, 50.3))
3123     _dbus_assert_not_reached ("failed to append float");
3124
3125   i = _dbus_string_get_length (&str);
3126
3127   if (!_dbus_string_parse_double (&str, 0, &d, &end))
3128     _dbus_assert_not_reached ("failed to parse float");
3129
3130   _dbus_assert (d > (50.3 - 1e-6) && d < (50.3 + 1e-6));
3131   _dbus_assert (end == i);
3132
3133   _dbus_string_free (&str);
3134
3135   /* Test find */
3136   if (!_dbus_string_init (&str))
3137     _dbus_assert_not_reached ("failed to init string");
3138
3139   if (!_dbus_string_append (&str, "Hello"))
3140     _dbus_assert_not_reached ("couldn't append to string");
3141
3142   if (!_dbus_string_find (&str, 0, "He", &i))
3143     _dbus_assert_not_reached ("didn't find 'He'");
3144   _dbus_assert (i == 0);
3145
3146   if (!_dbus_string_find (&str, 0, "Hello", &i))
3147     _dbus_assert_not_reached ("didn't find 'Hello'");
3148   _dbus_assert (i == 0);
3149
3150   if (!_dbus_string_find (&str, 0, "ello", &i))
3151     _dbus_assert_not_reached ("didn't find 'ello'");
3152   _dbus_assert (i == 1);
3153
3154   if (!_dbus_string_find (&str, 0, "lo", &i))
3155     _dbus_assert_not_reached ("didn't find 'lo'");
3156   _dbus_assert (i == 3);
3157
3158   if (!_dbus_string_find (&str, 2, "lo", &i))
3159     _dbus_assert_not_reached ("didn't find 'lo'");
3160   _dbus_assert (i == 3);
3161
3162   if (_dbus_string_find (&str, 4, "lo", &i))
3163     _dbus_assert_not_reached ("did find 'lo'");
3164
3165   if (!_dbus_string_find (&str, 0, "l", &i))
3166     _dbus_assert_not_reached ("didn't find 'l'");
3167   _dbus_assert (i == 2);
3168
3169   if (!_dbus_string_find (&str, 0, "H", &i))
3170     _dbus_assert_not_reached ("didn't find 'H'");
3171   _dbus_assert (i == 0);
3172
3173   if (!_dbus_string_find (&str, 0, "", &i))
3174     _dbus_assert_not_reached ("didn't find ''");
3175   _dbus_assert (i == 0);
3176
3177   if (_dbus_string_find (&str, 0, "Hello!", NULL))
3178     _dbus_assert_not_reached ("Did find 'Hello!'");
3179
3180   if (_dbus_string_find (&str, 0, "Oh, Hello", NULL))
3181     _dbus_assert_not_reached ("Did find 'Oh, Hello'");
3182
3183   if (_dbus_string_find (&str, 0, "ill", NULL))
3184     _dbus_assert_not_reached ("Did find 'ill'");
3185
3186   if (_dbus_string_find (&str, 0, "q", NULL))
3187     _dbus_assert_not_reached ("Did find 'q'");
3188
3189   if (!_dbus_string_find_to (&str, 0, 2, "He", NULL))
3190     _dbus_assert_not_reached ("Didn't find 'He'");
3191
3192   if (_dbus_string_find_to (&str, 0, 2, "Hello", NULL))
3193     _dbus_assert_not_reached ("Did find 'Hello'");
3194
3195   if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'H', &i))
3196     _dbus_assert_not_reached ("Did not find 'H'");
3197   _dbus_assert (i == 0);
3198
3199   if (!_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str), 'o', &i))
3200     _dbus_assert_not_reached ("Did not find 'o'");
3201   _dbus_assert (i == _dbus_string_get_length (&str) - 1);
3202
3203   if (_dbus_string_find_byte_backward (&str, _dbus_string_get_length (&str) - 1, 'o', &i))
3204     _dbus_assert_not_reached ("Did find 'o'");
3205   _dbus_assert (i == -1);
3206
3207   if (_dbus_string_find_byte_backward (&str, 1, 'e', &i))
3208     _dbus_assert_not_reached ("Did find 'e'");
3209   _dbus_assert (i == -1);
3210
3211   if (!_dbus_string_find_byte_backward (&str, 2, 'e', &i))
3212     _dbus_assert_not_reached ("Didn't find 'e'");
3213   _dbus_assert (i == 1);
3214
3215   _dbus_string_free (&str);
3216
3217   /* Base 64 and Hex encoding */
3218   test_roundtrips (test_base64_roundtrip);
3219   test_roundtrips (test_hex_roundtrip);
3220
3221   return TRUE;
3222 }
3223
3224 #endif /* DBUS_BUILD_TESTS */