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