dbus-string.c 77.2 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
John Palmieri's avatar
John Palmieri committed
2
/* dbus-string.c String utility class (internal to D-Bus implementation)
3
 * 
4
 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat, Inc.
5
 * Copyright (C) 2006 Ralf Habacker <ralf.habacker@freenet.de>
6
 *
7
 * Licensed under the Academic Free License version 2.1
8
9
10
11
12
13
14
15
16
17
18
19
20
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22
23
24
 *
 */

25
#include <config.h>
26
#include "dbus-internals.h"
27
28
29
#include "dbus-string.h"
/* we allow a system header here, for speed/convenience */
#include <string.h>
30
31
/* for vsnprintf */
#include <stdio.h>
32
33
#define DBUS_CAN_USE_DBUS_STRING_PRIVATE 1
#include "dbus-string-private.h"
34
35
36
#include "dbus-marshal-basic.h" /* probably should be removed by moving the usage of DBUS_TYPE
                                 * into the marshaling-related files
                                 */
37
38
/* for DBUS_VA_COPY */
#include "dbus-sysdeps.h"
39
40

/**
41
 * @defgroup DBusString DBusString class
42
 * @ingroup  DBusInternals
43
 * @brief DBusString data structure for safer string handling
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 *
 * Types and functions related to DBusString. DBusString is intended
 * to be a string class that makes it hard to mess up security issues
 * (and just in general harder to write buggy code).  It should be
 * used (or extended and then used) rather than the libc stuff in
 * string.h.  The string class is a bit inconvenient at spots because
 * it handles out-of-memory failures and tries to be extra-robust.
 * 
 * A DBusString has a maximum length set at initialization time; this
 * can be used to ensure that a buffer doesn't get too big.  The
 * _dbus_string_lengthen() method checks for overflow, and for max
 * length being exceeded.
 * 
 * Try to avoid conversion to a plain C string, i.e. add methods on
 * the string object instead, only convert to C string when passing
 * things out to the public API. In particular, no sprintf, strcpy,
 * strcat, any of that should be used. The GString feature of
 * accepting negative numbers for "length of string" is also absent,
 * because it could keep us from detecting bogus huge lengths. i.e. if
 * we passed in some bogus huge length it would be taken to mean
 * "current length of string" instead of "broken crack"
65
66
67
68
69
70
 *
 * @todo #DBusString needs a lot of cleaning up; some of the
 * API is no longer used, and the API is pretty inconsistent.
 * In particular all the "append" APIs, especially those involving
 * alignment but probably lots of them, are no longer used by the
 * marshaling code which always does "inserts" now.
71
72
73
74
75
76
77
 */

/**
 * @addtogroup DBusString
 * @{
 */

78
79
80
static void
fixup_alignment (DBusRealString *real)
{
81
82
  unsigned char *aligned;
  unsigned char *real_block;
83
84
85
  unsigned int old_align_offset;

  /* we have to have extra space in real->allocated for the align offset and nul byte */
86
  _dbus_assert (real->len <= real->allocated - _DBUS_STRING_ALLOCATION_PADDING);
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
  
  old_align_offset = real->align_offset;
  real_block = real->str - old_align_offset;
  
  aligned = _DBUS_ALIGN_ADDRESS (real_block, 8);

  real->align_offset = aligned - real_block;
  real->str = aligned;
  
  if (old_align_offset != real->align_offset)
    {
      /* Here comes the suck */
      memmove (real_block + real->align_offset,
               real_block + old_align_offset,
               real->len + 1);
    }

  _dbus_assert (real->align_offset < 8);
  _dbus_assert (_DBUS_ALIGN_ADDRESS (real->str, 8) == real->str);
}
107

108
109
110
111
112
113
114
115
116
117
static void
undo_alignment (DBusRealString *real)
{
  if (real->align_offset != 0)
    {
      memmove (real->str - real->align_offset,
               real->str,
               real->len + 1);

      real->str = real->str - real->align_offset;
118
      real->align_offset = 0;
119
120
121
    }
}

122
/**
123
124
125
 * Initializes a string that can be up to the given allocation size
 * before it has to realloc. The string starts life with zero length.
 * The string must eventually be freed with _dbus_string_free().
Havoc Pennington's avatar
Havoc Pennington committed
126
 * 
127
 * @param str memory to hold the string
128
 * @param allocate_size amount to preallocate
129
130
 * @returns #TRUE on success, #FALSE if no memory
 */
131
dbus_bool_t
132
133
_dbus_string_init_preallocated (DBusString *str,
                                int         allocate_size)
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
{
  DBusRealString *real;
  
  _dbus_assert (str != NULL);

  _dbus_assert (sizeof (DBusString) == sizeof (DBusRealString));
  
  real = (DBusRealString*) str;

  /* It's very important not to touch anything
   * other than real->str if we're going to fail,
   * since we also use this function to reset
   * an existing string, e.g. in _dbus_string_steal_data()
   */
  
149
  real->str = dbus_malloc (_DBUS_STRING_ALLOCATION_PADDING + allocate_size);
150
  if (real->str == NULL)
151
152
    return FALSE;  
  
153
  real->allocated = _DBUS_STRING_ALLOCATION_PADDING + allocate_size;
154
155
156
  real->len = 0;
  real->str[real->len] = '\0';
  
157
  real->max_length = _DBUS_STRING_MAX_MAX_LENGTH;
158
159
160
  real->constant = FALSE;
  real->locked = FALSE;
  real->invalid = FALSE;
161
162
163
  real->align_offset = 0;
  
  fixup_alignment (real);
164
  
165
166
167
  return TRUE;
}

168
169
170
171
172
173
174
175
176
177
178
179
180
/**
 * Initializes a string. The string starts life with zero length.  The
 * string must eventually be freed with _dbus_string_free().
 * 
 * @param str memory to hold the string
 * @returns #TRUE on success, #FALSE if no memory
 */
dbus_bool_t
_dbus_string_init (DBusString *str)
{
  return _dbus_string_init_preallocated (str, 0);
}

181
#ifdef DBUS_BUILD_TESTS
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/* The max length thing is sort of a historical artifact
 * from a feature that turned out to be dumb; perhaps
 * we should purge it entirely. The problem with
 * the feature is that it looks like memory allocation
 * failure, but is not a transient or resolvable failure.
 */
static void
set_max_length (DBusString *str,
                int         max_length)
{
  DBusRealString *real;
  
  real = (DBusRealString*) str;

  real->max_length = max_length;
}
198
#endif /* DBUS_BUILD_TESTS */
199

200
201
202
203
/**
 * Initializes a constant string. The value parameter is not copied
 * (should be static), and the string may never be modified.
 * It is safe but not necessary to call _dbus_string_free()
204
 * on a const string. The string has a length limit of MAXINT - 8.
205
206
207
208
209
210
211
 * 
 * @param str memory to use for the string
 * @param value a string to be stored in str (not copied!!!)
 */
void
_dbus_string_init_const (DBusString *str,
                         const char *value)
212
{
213
214
  _dbus_assert (value != NULL);
  
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
  _dbus_string_init_const_len (str, value,
                               strlen (value));
}

/**
 * Initializes a constant string with a length. The value parameter is
 * not copied (should be static), and the string may never be
 * modified.  It is safe but not necessary to call _dbus_string_free()
 * on a const string.
 * 
 * @param str memory to use for the string
 * @param value a string to be stored in str (not copied!!!)
 * @param len the length to use
 */
void
_dbus_string_init_const_len (DBusString *str,
                             const char *value,
                             int         len)
233
234
235
236
{
  DBusRealString *real;
  
  _dbus_assert (str != NULL);
237
  _dbus_assert (len == 0 || value != NULL);
238
  _dbus_assert (len <= _DBUS_STRING_MAX_MAX_LENGTH);
239
240
  _dbus_assert (len >= 0);
  
241
242
  real = (DBusRealString*) str;
  
243
  real->str = (unsigned char*) value;
244
  real->len = len;
245
  real->allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING; /* a lie, just to avoid special-case assertions... */
246
  real->max_length = real->len + 1;
247
  real->constant = TRUE;
248
  real->locked = TRUE;
249
  real->invalid = FALSE;
250
  real->align_offset = 0;
251
252
253
254

  /* We don't require const strings to be 8-byte aligned as the
   * memory is coming from elsewhere.
   */
255
256
257
258
259
260
261
262
263
264
}

/**
 * Frees a string created by _dbus_string_init().
 *
 * @param str memory where the string is stored.
 */
void
_dbus_string_free (DBusString *str)
{
265
266
  DBusRealString *real = (DBusRealString*) str;
  DBUS_GENERIC_STRING_PREAMBLE (real);
267
268
269
  
  if (real->constant)
    return;
270
  dbus_free (real->str - real->align_offset);
271
272
273
274

  real->invalid = TRUE;
}

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
static dbus_bool_t
compact (DBusRealString *real,
         int             max_waste)
{
  unsigned char *new_str;
  int new_allocated;
  int waste;

  waste = real->allocated - (real->len + _DBUS_STRING_ALLOCATION_PADDING);

  if (waste <= max_waste)
    return TRUE;

  new_allocated = real->len + _DBUS_STRING_ALLOCATION_PADDING;

  new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
  if (_DBUS_UNLIKELY (new_str == NULL))
    return FALSE;

  real->str = new_str + real->align_offset;
  real->allocated = new_allocated;
  fixup_alignment (real);

  return TRUE;
}

301
302
303
304
#ifdef DBUS_BUILD_TESTS
/* Not using this feature at the moment,
 * so marked DBUS_BUILD_TESTS-only
 */
305
/**
306
307
308
309
310
 * Locks a string such that any attempts to change the string will
 * result in aborting the program. Also, if the string is wasting a
 * lot of memory (allocation is sufficiently larger than what the
 * string is really using), _dbus_string_lock() will realloc the
 * string's data to "compact" it.
311
312
313
314
315
316
317
318
319
320
321
322
323
 *
 * @param str the string to lock.
 */
void
_dbus_string_lock (DBusString *str)
{  
  DBUS_LOCKED_STRING_PREAMBLE (str); /* can lock multiple times */

  real->locked = TRUE;

  /* Try to realloc to avoid excess memory usage, since
   * we know we won't change the string further
   */
324
#define MAX_WASTE 48
325
  compact (real, MAX_WASTE);
326
}
327
#endif /* DBUS_BUILD_TESTS */
328

329
static dbus_bool_t
330
331
reallocate_for_length (DBusRealString *real,
                       int             new_length)
332
{
333
  int new_allocated;
334
  unsigned char *new_str;
335

336
337
338
  /* at least double our old allocation to avoid O(n), avoiding
   * overflow
   */
339
340
  if (real->allocated > (_DBUS_STRING_MAX_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING) / 2)
    new_allocated = _DBUS_STRING_MAX_MAX_LENGTH + _DBUS_STRING_ALLOCATION_PADDING;
341
342
  else
    new_allocated = real->allocated * 2;
343

344
  /* if you change the code just above here, run the tests without
345
   * the following assert-only hack before you commit
346
   */
347
348
349
350
351
352
  /* This is keyed off asserts in addition to tests so when you
   * disable asserts to profile, you don't get this destroyer
   * of profiles.
   */
#ifdef DBUS_DISABLE_ASSERT
#else
353
#ifdef DBUS_BUILD_TESTS
354
355
356
  new_allocated = 0; /* ensure a realloc every time so that we go
                      * through all malloc failure codepaths
                      */
357
358
359
#endif /* DBUS_BUILD_TESTS */
#endif /* !DBUS_DISABLE_ASSERT */

360
  /* But be sure we always alloc at least space for the new length */
361
  new_allocated = MAX (new_allocated,
362
                       new_length + _DBUS_STRING_ALLOCATION_PADDING);
363

364
365
  _dbus_assert (new_allocated >= real->allocated); /* code relies on this */
  new_str = dbus_realloc (real->str - real->align_offset, new_allocated);
366
  if (_DBUS_UNLIKELY (new_str == NULL))
367
    return FALSE;
368

369
370
371
  real->str = new_str + real->align_offset;
  real->allocated = new_allocated;
  fixup_alignment (real);
372
373
374
375

  return TRUE;
}

376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/**
 * Compacts the string to avoid wasted memory.  Wasted memory is
 * memory that is allocated but not actually required to store the
 * current length of the string.  The compact is only done if more
 * than the given amount of memory is being wasted (otherwise the
 * waste is ignored and the call does nothing).
 *
 * @param str the string
 * @param max_waste the maximum amount of waste to ignore
 * @returns #FALSE if the compact failed due to realloc failure
 */
dbus_bool_t
_dbus_string_compact (DBusString *str,
                      int         max_waste)
{
  DBUS_STRING_PREAMBLE (str);

  return compact (real, max_waste);
}

396
397
398
399
400
401
402
static dbus_bool_t
set_length (DBusRealString *real,
            int             new_length)
{
  /* Note, we are setting the length not including nul termination */

  /* exceeding max length is the same as failure to allocate memory */
403
  if (_DBUS_UNLIKELY (new_length > real->max_length))
404
    return FALSE;
405
  else if (new_length > (real->allocated - _DBUS_STRING_ALLOCATION_PADDING) &&
406
           _DBUS_UNLIKELY (!reallocate_for_length (real, new_length)))
407
408
409
410
    return FALSE;
  else
    {
      real->len = new_length;
411
      real->str[new_length] = '\0';
412
413
414
415
      return TRUE;
    }
}

416
417
418
419
420
421
422
423
static dbus_bool_t
open_gap (int             len,
          DBusRealString *dest,
          int             insert_at)
{
  if (len == 0)
    return TRUE;

424
425
426
  if (len > dest->max_length - dest->len)
    return FALSE; /* detected overflow of dest->len + len below */
  
427
428
429
430
431
432
433
434
435
436
  if (!set_length (dest, dest->len + len))
    return FALSE;

  memmove (dest->str + insert_at + len, 
           dest->str + insert_at,
           dest->len - len - insert_at);

  return TRUE;
}

437
#ifndef _dbus_string_get_data
438
439
440
441
442
443
444
445
446
/**
 * Gets the raw character buffer from the string.  The returned buffer
 * will be nul-terminated, but note that strings may contain binary
 * data so there may be extra nul characters prior to the termination.
 * This function should be little-used, extend DBusString or add
 * stuff to dbus-sysdeps.c instead. It's an error to use this
 * function on a const string.
 *
 * @param str the string
447
 * @returns the data
448
 */
449
450
char*
_dbus_string_get_data (DBusString *str)
451
452
453
{
  DBUS_STRING_PREAMBLE (str);
  
454
  return (char*) real->str;
455
}
456
#endif /* _dbus_string_get_data */
457

458
459
/* only do the function if we don't have the macro */
#ifndef _dbus_string_get_const_data
460
/**
461
462
 * Gets the raw character buffer from a const string.
 *
463
 * @param str the string
464
 * @returns the string data
465
 */
466
467
const char*
_dbus_string_get_const_data (const DBusString  *str)
468
469
470
{
  DBUS_CONST_STRING_PREAMBLE (str);
  
471
  return (const char*) real->str;
472
}
473
#endif /* _dbus_string_get_const_data */
474
475
476
477
478
479
480
481
482
483
484
485

/**
 * Gets a sub-portion of the raw character buffer from the
 * string. The "len" field is required simply for error
 * checking, to be sure you don't try to use more
 * string than exists. The nul termination of the
 * returned buffer remains at the end of the entire
 * string, not at start + len.
 *
 * @param str the string
 * @param start byte offset to return
 * @param len length of segment to return
486
 * @returns the string data
487
 */
488
char*
489
490
491
492
493
494
495
_dbus_string_get_data_len (DBusString *str,
                           int         start,
                           int         len)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (start >= 0);
  _dbus_assert (len >= 0);
496
497
  _dbus_assert (start <= real->len);
  _dbus_assert (len <= real->len - start);
498
  
499
  return (char*) real->str + start;
500
501
}

502
503
/* only do the function if we don't have the macro */
#ifndef _dbus_string_get_const_data_len
504
505
506
507
508
509
/**
 * const version of _dbus_string_get_data_len().
 *
 * @param str the string
 * @param start byte offset to return
 * @param len length of segment to return
510
 * @returns the string data
511
 */
512
const char*
513
514
515
516
517
518
519
_dbus_string_get_const_data_len (const DBusString  *str,
                                 int                start,
                                 int                len)
{
  DBUS_CONST_STRING_PREAMBLE (str);
  _dbus_assert (start >= 0);
  _dbus_assert (len >= 0);
520
521
  _dbus_assert (start <= real->len);
  _dbus_assert (len <= real->len - start);
522
  
523
  return (const char*) real->str + start;
524
}
525
#endif /* _dbus_string_get_const_data_len */
526

527
528
/* only do the function if we don't have the macro */
#ifndef _dbus_string_set_byte
529
530
531
532
533
534
535
536
537
538
539
540
541
542
/**
 * Sets the value of the byte at the given position.
 *
 * @param str the string
 * @param i the position
 * @param byte the new value
 */
void
_dbus_string_set_byte (DBusString    *str,
                       int            i,
                       unsigned char  byte)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (i < real->len);
543
544
  _dbus_assert (i >= 0);
  
545
546
  real->str[i] = byte;
}
547
#endif /* _dbus_string_set_byte */
548

549
550
/* only have the function if we didn't create a macro */
#ifndef _dbus_string_get_byte
551
/**
552
553
554
 * Gets the byte at the given position. It is
 * allowed to ask for the nul byte at the end of
 * the string.
555
556
557
558
559
 *
 * @param str the string
 * @param start the position
 * @returns the byte at that position
 */
560
unsigned char
561
562
563
564
_dbus_string_get_byte (const DBusString  *str,
                       int                start)
{
  DBUS_CONST_STRING_PREAMBLE (str);
565
  _dbus_assert (start <= real->len);
566
567
  _dbus_assert (start >= 0);
  
568
569
  return real->str[start];
}
570
#endif /* _dbus_string_get_byte */
571

572
/**
573
574
 * Inserts a number of bytes of a given value at the
 * given position.
575
576
577
 *
 * @param str the string
 * @param i the position
578
 * @param n_bytes number of bytes
579
580
581
582
 * @param byte the value to insert
 * @returns #TRUE on success
 */
dbus_bool_t
583
584
585
586
_dbus_string_insert_bytes (DBusString   *str,
			   int           i,
			   int           n_bytes,
			   unsigned char byte)
587
588
589
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (i <= real->len);
590
  _dbus_assert (i >= 0);
591
592
593
594
  _dbus_assert (n_bytes >= 0);

  if (n_bytes == 0)
    return TRUE;
595
  
596
  if (!open_gap (n_bytes, real, i))
597
598
    return FALSE;
  
599
  memset (real->str + i, byte, n_bytes);
600
601
602
603

  return TRUE;
}

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
/**
 * Inserts a single byte at the given position.
 *
 * @param str the string
 * @param i the position
 * @param byte the value to insert
 * @returns #TRUE on success
 */
dbus_bool_t
_dbus_string_insert_byte (DBusString   *str,
			   int           i,
			   unsigned char byte)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (i <= real->len);
  _dbus_assert (i >= 0);
  
  if (!open_gap (1, real, i))
    return FALSE;

  real->str[i] = byte;

  return TRUE;
}

629
630
631
632
633
634
635
636
637
638
639
640
641
642
/**
 * Like _dbus_string_get_data(), but removes the
 * gotten data from the original string. The caller
 * must free the data returned. This function may
 * fail due to lack of memory, and return #FALSE.
 *
 * @param str the string
 * @param data_return location to return the buffer
 * @returns #TRUE on success
 */
dbus_bool_t
_dbus_string_steal_data (DBusString        *str,
                         char             **data_return)
{
643
  int old_max_length;
644
645
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (data_return != NULL);
646
647

  undo_alignment (real);
648
  
649
  *data_return = (char*) real->str;
650

651
652
  old_max_length = real->max_length;
  
653
  /* reset the string */
654
  if (!_dbus_string_init (str))
655
656
    {
      /* hrm, put it back then */
657
      real->str = (unsigned char*) *data_return;
658
      *data_return = NULL;
659
      fixup_alignment (real);
660
661
662
      return FALSE;
    }

663
664
  real->max_length = old_max_length;

665
666
667
  return TRUE;
}

668
#ifdef DBUS_BUILD_TESTS
669
670
671
672
673
674
/**
 * Like _dbus_string_get_data_len(), but removes the gotten data from
 * the original string. The caller must free the data returned. This
 * function may fail due to lack of memory, and return #FALSE.
 * The returned string is nul-terminated and has length len.
 *
675
676
677
 * @todo this function is broken because on failure it
 * may corrupt the source string.
 * 
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 * @param str the string
 * @param data_return location to return the buffer
 * @param start the start of segment to steal
 * @param len the length of segment to steal
 * @returns #TRUE on success
 */
dbus_bool_t
_dbus_string_steal_data_len (DBusString        *str,
                             char             **data_return,
                             int                start,
                             int                len)
{
  DBusString dest;
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (data_return != NULL);
  _dbus_assert (start >= 0);
  _dbus_assert (len >= 0);
695
696
  _dbus_assert (start <= real->len);
  _dbus_assert (len <= real->len - start);
697

698
  if (!_dbus_string_init (&dest))
699
700
    return FALSE;

701
702
  set_max_length (&dest, real->max_length);
  
703
704
705
706
707
  if (!_dbus_string_move_len (str, start, len, &dest, 0))
    {
      _dbus_string_free (&dest);
      return FALSE;
    }
708

709
710
711
712
713
714
715
716
717
718
  _dbus_warn ("Broken code in _dbus_string_steal_data_len(), see @todo, FIXME\n");
  if (!_dbus_string_steal_data (&dest, data_return))
    {
      _dbus_string_free (&dest);
      return FALSE;
    }

  _dbus_string_free (&dest);
  return TRUE;
}
719
#endif /* DBUS_BUILD_TESTS */
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743

/**
 * Copies the data from the string into a char*
 *
 * @param str the string
 * @param data_return place to return the data
 * @returns #TRUE on success, #FALSE on no memory
 */
dbus_bool_t
_dbus_string_copy_data (const DBusString  *str,
                        char             **data_return)
{
  DBUS_CONST_STRING_PREAMBLE (str);
  _dbus_assert (data_return != NULL);
  
  *data_return = dbus_malloc (real->len + 1);
  if (*data_return == NULL)
    return FALSE;

  memcpy (*data_return, real->str, real->len + 1);

  return TRUE;
}

744
/**
745
746
747
 * Copies the contents of a DBusString into a different buffer. It is
 * a bug if avail_len is too short to hold the string contents. nul
 * termination is not copied, just the supplied bytes.
748
749
750
751
752
753
754
755
756
757
758
759
760
 * 
 * @param str a string
 * @param buffer a C buffer to copy data to
 * @param avail_len maximum length of C buffer
 */
void
_dbus_string_copy_to_buffer (const DBusString  *str,
			     char              *buffer,
			     int                avail_len)
{
  DBUS_CONST_STRING_PREAMBLE (str);

  _dbus_assert (avail_len >= 0);
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
  _dbus_assert (avail_len >= real->len);
  
  memcpy (buffer, real->str, real->len);
}

/**
 * Copies the contents of a DBusString into a different buffer. It is
 * a bug if avail_len is too short to hold the string contents plus a
 * nul byte. 
 * 
 * @param str a string
 * @param buffer a C buffer to copy data to
 * @param avail_len maximum length of C buffer
 */
void
_dbus_string_copy_to_buffer_with_nul (const DBusString  *str,
                                      char              *buffer,
                                      int                avail_len)
{
  DBUS_CONST_STRING_PREAMBLE (str);
781

782
783
784
785
  _dbus_assert (avail_len >= 0);
  _dbus_assert (avail_len > real->len);
  
  memcpy (buffer, real->str, real->len+1);
786
787
}

788
#ifdef DBUS_BUILD_TESTS
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
/**
 * Copies a segment of the string into a char*
 *
 * @param str the string
 * @param data_return place to return the data
 * @param start start index
 * @param len length to copy
 * @returns #FALSE if no memory
 */
dbus_bool_t
_dbus_string_copy_data_len (const DBusString  *str,
                            char             **data_return,
                            int                start,
                            int                len)
{
  DBusString dest;

  DBUS_CONST_STRING_PREAMBLE (str);
  _dbus_assert (data_return != NULL);
  _dbus_assert (start >= 0);
  _dbus_assert (len >= 0);
  _dbus_assert (start <= real->len);
  _dbus_assert (len <= real->len - start);

813
  if (!_dbus_string_init (&dest))
814
815
    return FALSE;

816
817
  set_max_length (&dest, real->max_length);

818
819
820
821
822
823
  if (!_dbus_string_copy_len (str, start, len, &dest, 0))
    {
      _dbus_string_free (&dest);
      return FALSE;
    }

824
825
826
827
828
829
830
831
832
  if (!_dbus_string_steal_data (&dest, data_return))
    {
      _dbus_string_free (&dest);
      return FALSE;
    }

  _dbus_string_free (&dest);
  return TRUE;
}
833
#endif /* DBUS_BUILD_TESTS */
834

835
836
/* Only have the function if we don't have the macro */
#ifndef _dbus_string_get_length
837
838
839
840
841
842
843
844
845
846
847
848
/**
 * Gets the length of a string (not including nul termination).
 *
 * @returns the length.
 */
int
_dbus_string_get_length (const DBusString  *str)
{
  DBUS_CONST_STRING_PREAMBLE (str);
  
  return real->len;
}
849
#endif /* !_dbus_string_get_length */
850
851
852
853
854
855
856

/**
 * Makes a string longer by the given number of bytes.  Checks whether
 * adding additional_length to the current length would overflow an
 * integer, and checks for exceeding a string's max length.
 * The new bytes are not initialized, other than nul-terminating
 * the end of the string. The uninitialized bytes may contain
857
 * nul bytes or other junk.
858
859
860
861
862
863
864
865
866
867
868
 *
 * @param str a string
 * @param additional_length length to add to the string.
 * @returns #TRUE on success.
 */
dbus_bool_t
_dbus_string_lengthen (DBusString *str,
                       int         additional_length)
{
  DBUS_STRING_PREAMBLE (str);  
  _dbus_assert (additional_length >= 0);
869

870
  if (_DBUS_UNLIKELY (additional_length > real->max_length - real->len))
871
    return FALSE; /* would overflow */
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
  
  return set_length (real,
                     real->len + additional_length);
}

/**
 * Makes a string shorter by the given number of bytes.
 *
 * @param str a string
 * @param length_to_remove length to remove from the string.
 */
void
_dbus_string_shorten (DBusString *str,
                      int         length_to_remove)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (length_to_remove >= 0);
  _dbus_assert (length_to_remove <= real->len);

  set_length (real,
              real->len - length_to_remove);
}

/**
 * Sets the length of a string. Can be used to truncate or lengthen
 * the string. If the string is lengthened, the function may fail and
 * return #FALSE. Newly-added bytes are not initialized, as with
 * _dbus_string_lengthen().
 *
 * @param str a string
 * @param length new length of the string.
 * @returns #FALSE on failure.
 */
dbus_bool_t
_dbus_string_set_length (DBusString *str,
                         int         length)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (length >= 0);

  return set_length (real, length);
}

915
static dbus_bool_t
916
917
918
919
align_insert_point_then_open_gap (DBusString *str,
                                  int        *insert_at_p,
                                  int         alignment,
                                  int         gap_size)
920
{
921
  unsigned long new_len; /* ulong to avoid _DBUS_ALIGN_VALUE overflow */
922
923
  unsigned long gap_pos;
  int insert_at;
924
925
926
  int delta;
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (alignment >= 1);
927
  _dbus_assert (alignment <= 8); /* it has to be a bug if > 8 */
928

929
930
931
932
933
934
935
936
  insert_at = *insert_at_p;

  _dbus_assert (insert_at <= real->len);
  
  gap_pos = _DBUS_ALIGN_VALUE (insert_at, alignment);
  new_len = real->len + (gap_pos - insert_at) + gap_size;
  
  if (_DBUS_UNLIKELY (new_len > (unsigned long) real->max_length))
937
938
    return FALSE;
  
939
940
941
  delta = new_len - real->len;
  _dbus_assert (delta >= 0);

942
943
944
945
946
  if (delta == 0) /* only happens if gap_size == 0 and insert_at is aligned already */
    {
      _dbus_assert (((unsigned long) *insert_at_p) == gap_pos);
      return TRUE;
    }
947

948
949
  if (_DBUS_UNLIKELY (!open_gap (new_len - real->len,
                                 real, insert_at)))
950
951
    return FALSE;

952
953
  /* nul the padding if we had to add any padding */
  if (gap_size < delta)
954
    {
955
956
      memset (&real->str[insert_at], '\0',
              gap_pos - insert_at);
957
    }
958
959
960

  *insert_at_p = gap_pos;
  
961
962
963
  return TRUE;
}

964
965
966
967
968
969
970
971
972
973
974
975
976
977
static dbus_bool_t
align_length_then_lengthen (DBusString *str,
                            int         alignment,
                            int         then_lengthen_by)
{
  int insert_at;

  insert_at = _dbus_string_get_length (str);
  
  return align_insert_point_then_open_gap (str,
                                           &insert_at,
                                           alignment, then_lengthen_by);
}

978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
/**
 * Align the length of a string to a specific alignment (typically 4 or 8)
 * by appending nul bytes to the string.
 *
 * @param str a string
 * @param alignment the alignment
 * @returns #FALSE if no memory
 */
dbus_bool_t
_dbus_string_align_length (DBusString *str,
                           int         alignment)
{
  return align_length_then_lengthen (str, alignment, 0);
}

993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
/**
 * Preallocate extra_bytes such that a future lengthening of the
 * string by extra_bytes is guaranteed to succeed without an out of
 * memory error.
 *
 * @param str a string
 * @param extra_bytes bytes to alloc
 * @returns #FALSE if no memory
 */
dbus_bool_t
_dbus_string_alloc_space (DBusString        *str,
                          int                extra_bytes)
{
  if (!_dbus_string_lengthen (str, extra_bytes))
    return FALSE;
  _dbus_string_shorten (str, extra_bytes);

  return TRUE;
}

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
static dbus_bool_t
append (DBusRealString *real,
        const char     *buffer,
        int             buffer_len)
{
  if (buffer_len == 0)
    return TRUE;

  if (!_dbus_string_lengthen ((DBusString*)real, buffer_len))
    return FALSE;

  memcpy (real->str + (real->len - buffer_len),
          buffer,
          buffer_len);

  return TRUE;
}

/**
 * Appends a nul-terminated C-style string to a DBusString.
 *
 * @param str the DBusString
 * @param buffer the nul-terminated characters to append
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_append (DBusString *str,
                     const char *buffer)
{
1042
  unsigned long buffer_len;
1043
1044
1045
1046
1047
  
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (buffer != NULL);
  
  buffer_len = strlen (buffer);
1048
1049
1050
  if (buffer_len > (unsigned long) real->max_length)
    return FALSE;
  
1051
1052
1053
  return append (real, buffer, buffer_len);
}

1054
1055
1056
/** assign 2 bytes from one string to another */
#define ASSIGN_2_OCTETS(p, octets) \
  *((dbus_uint16_t*)(p)) = *((dbus_uint16_t*)(octets));
1057

1058
/** assign 4 bytes from one string to another */
1059
1060
1061
1062
#define ASSIGN_4_OCTETS(p, octets) \
  *((dbus_uint32_t*)(p)) = *((dbus_uint32_t*)(octets));

#ifdef DBUS_HAVE_INT64
1063
/** assign 8 bytes from one string to another */
1064
1065
1066
#define ASSIGN_8_OCTETS(p, octets) \
  *((dbus_uint64_t*)(p)) = *((dbus_uint64_t*)(octets));
#else
1067
/** assign 8 bytes from one string to another */
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
#define ASSIGN_8_OCTETS(p, octets)              \
do {                                            \
  unsigned char *b;                             \
                                                \
  b = p;                                        \
                                                \
  *b++ = octets[0];                             \
  *b++ = octets[1];                             \
  *b++ = octets[2];                             \
  *b++ = octets[3];                             \
  *b++ = octets[4];                             \
  *b++ = octets[5];                             \
  *b++ = octets[6];                             \
  *b++ = octets[7];                             \
  _dbus_assert (b == p + 8);                    \
} while (0)
#endif /* DBUS_HAVE_INT64 */

1086
#ifdef DBUS_BUILD_TESTS
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
/**
 * Appends 4 bytes aligned on a 4 byte boundary
 * with any alignment padding initialized to 0.
 *
 * @param str the DBusString
 * @param octets 4 bytes to append
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_append_4_aligned (DBusString         *str,
                               const unsigned char octets[4])
{
  DBUS_STRING_PREAMBLE (str);
  
  if (!align_length_then_lengthen (str, 4, 4))
    return FALSE;

1104
  ASSIGN_4_OCTETS (real->str + (real->len - 4), octets);
1105
1106
1107

  return TRUE;
}
1108
#endif /* DBUS_BUILD_TESTS */
1109

1110
#ifdef DBUS_BUILD_TESTS
1111
1112
1113
1114
1115
/**
 * Appends 8 bytes aligned on an 8 byte boundary
 * with any alignment padding initialized to 0.
 *
 * @param str the DBusString
1116
 * @param octets 8 bytes to append
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_append_8_aligned (DBusString         *str,
                               const unsigned char octets[8])
{
  DBUS_STRING_PREAMBLE (str);
  
  if (!align_length_then_lengthen (str, 8, 8))
    return FALSE;

1128
1129
1130
1131
  ASSIGN_8_OCTETS (real->str + (real->len - 8), octets);

  return TRUE;
}
1132
#endif /* DBUS_BUILD_TESTS */
1133

1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
/**
 * Inserts 2 bytes aligned on a 2 byte boundary
 * with any alignment padding initialized to 0.
 *
 * @param str the DBusString
 * @param insert_at where to insert
 * @param octets 2 bytes to insert
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_insert_2_aligned (DBusString         *str,
                               int                 insert_at,
                               const unsigned char octets[4])
{
  DBUS_STRING_PREAMBLE (str);
  
  if (!align_insert_point_then_open_gap (str, &insert_at, 2, 2))
    return FALSE;

  ASSIGN_2_OCTETS (real->str + insert_at, octets);

  return TRUE;
}

1158
1159
1160
1161
1162
/**
 * Inserts 4 bytes aligned on a 4 byte boundary
 * with any alignment padding initialized to 0.
 *
 * @param str the DBusString
1163
 * @param insert_at where to insert
1164
1165
1166
1167
1168
1169
1170
1171
 * @param octets 4 bytes to insert
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_insert_4_aligned (DBusString         *str,
                               int                 insert_at,
                               const unsigned char octets[4])
{
1172
1173
  DBUS_STRING_PREAMBLE (str);
  
1174
  if (!align_insert_point_then_open_gap (str, &insert_at, 4, 4))
1175
1176
    return FALSE;

1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
  ASSIGN_4_OCTETS (real->str + insert_at, octets);

  return TRUE;
}

/**
 * Inserts 8 bytes aligned on an 8 byte boundary
 * with any alignment padding initialized to 0.
 *
 * @param str the DBusString
1187
 * @param insert_at where to insert
1188
1189
1190
1191
1192
1193
1194
1195
1196
 * @param octets 8 bytes to insert
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_insert_8_aligned (DBusString         *str,
                               int                 insert_at,
                               const unsigned char octets[8])
{
  DBUS_STRING_PREAMBLE (str);
1197
  
1198
1199
1200
  if (!align_insert_point_then_open_gap (str, &insert_at, 8, 8))
    return FALSE;

1201
1202
  _dbus_assert (_DBUS_ALIGN_VALUE (insert_at, 8) == (unsigned) insert_at);
  
1203
  ASSIGN_8_OCTETS (real->str + insert_at, octets);
1204
1205
1206
1207

  return TRUE;
}

1208
1209
1210
1211
1212
1213
1214
1215

/**
 * Inserts padding at *insert_at such to align it to the given
 * boundary. Initializes the padding to nul bytes. Sets *insert_at
 * to the aligned position.
 *
 * @param str the DBusString
 * @param insert_at location to be aligned
1216
 * @param alignment alignment boundary (1, 2, 4, or 8)
1217
1218
1219
1220
1221
1222
1223
1224
1225
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_insert_alignment (DBusString        *str,
                               int               *insert_at,
                               int                alignment)
{
  DBUS_STRING_PREAMBLE (str);
  
1226
  if (!align_insert_point_then_open_gap (str, insert_at, alignment, 0))
1227
1228
    return FALSE;

1229
  _dbus_assert (_DBUS_ALIGN_VALUE (*insert_at, alignment) == (unsigned) *insert_at);
1230
1231
1232
1233

  return TRUE;
}

1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
/**
 * Appends a printf-style formatted string
 * to the #DBusString.
 *
 * @param str the string
 * @param format printf format
 * @param args variable argument list
 * @returns #FALSE if no memory
 */
dbus_bool_t
_dbus_string_append_printf_valist  (DBusString        *str,
                                    const char        *format,
                                    va_list            args)
{
  int len;
1249
  va_list args_copy;
1250

1251
  DBUS_STRING_PREAMBLE (str);
1252
1253
1254

  DBUS_VA_COPY (args_copy, args);

1255
  /* Measure the message length without terminating nul */
John Palmieri's avatar
John Palmieri committed
1256
  len = _dbus_printf_string_upper_bound (format, args);
1257
1258

  if (!_dbus_string_lengthen (str, len))
1259
1260
1261
1262
1263
1264
    {
      /* don't leak the copy */
      va_end (args_copy);
      return FALSE;
    }
  
1265
  vsprintf ((char*) (real->str + (real->len - len)),
1266
1267
1268
            format, args_copy);

  va_end (args_copy);
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295

  return TRUE;
}

/**
 * Appends a printf-style formatted string
 * to the #DBusString.
 *
 * @param str the string
 * @param format printf format
 * @returns #FALSE if no memory
 */
dbus_bool_t
_dbus_string_append_printf (DBusString        *str,
                            const char        *format,
                            ...)
{
  va_list args;
  dbus_bool_t retval;
  
  va_start (args, format);
  retval = _dbus_string_append_printf_valist (str, format, args);
  va_end (args);

  return retval;
}

1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
/**
 * Appends block of bytes with the given length to a DBusString.
 *
 * @param str the DBusString
 * @param buffer the bytes to append
 * @param len the number of bytes to append
 * @returns #FALSE if not enough memory.
 */
dbus_bool_t
_dbus_string_append_len (DBusString *str,
                         const char *buffer,
                         int         len)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (buffer != NULL);
  _dbus_assert (len >= 0);

  return append (real, buffer, len);
}

/**
 * Appends a single byte to the string, returning #FALSE
 * if not enough memory.
 *
 * @param str the string
 * @param byte the byte to append
 * @returns #TRUE on success
 */
dbus_bool_t
_dbus_string_append_byte (DBusString    *str,
                          unsigned char  byte)
{
  DBUS_STRING_PREAMBLE (str);

  if (!set_length (real, real->len + 1))
    return FALSE;

  real->str[real->len-1] = byte;

  return TRUE;
}

1338
#ifdef DBUS_BUILD_TESTS
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
/**
 * Appends a single Unicode character, encoding the character
 * in UTF-8 format.
 *
 * @param str the string
 * @param ch the Unicode character
 */
dbus_bool_t
_dbus_string_append_unichar (DBusString    *str,
                             dbus_unichar_t ch)
{
  int len;
  int first;
  int i;
1353
  unsigned char *out;
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
  
  DBUS_STRING_PREAMBLE (str);

  /* this code is from GLib but is pretty standard I think */
  
  len = 0;
  
  if (ch < 0x80)
    {
      first = 0;
      len = 1;
    }
  else if (ch < 0x800)
    {
      first = 0xc0;
      len = 2;
    }
  else if (ch < 0x10000)
    {
      first = 0xe0;
      len = 3;
    }
   else if (ch < 0x200000)
    {
      first = 0xf0;
      len = 4;
    }
  else if (ch < 0x4000000)
    {
      first = 0xf8;
      len = 5;
    }
  else
    {
      first = 0xfc;
      len = 6;
    }

1392
1393
1394
  if (len > (real->max_length - real->len))
    return FALSE; /* real->len + len would overflow */
  
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
  if (!set_length (real, real->len + len))
    return FALSE;

  out = real->str + (real->len - len);
  
  for (i = len - 1; i > 0; --i)
    {
      out[i] = (ch & 0x3f) | 0x80;
      ch >>= 6;
    }
  out[0] = ch | first;

  return TRUE;
}
1409
#endif /* DBUS_BUILD_TESTS */
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440

static void
delete (DBusRealString *real,
        int             start,
        int             len)
{
  if (len == 0)
    return;
  
  memmove (real->str + start, real->str + start + len, real->len - (start + len));
  real->len -= len;
  real->str[real->len] = '\0';
}

/**
 * Deletes a segment of a DBusString with length len starting at
 * start. (Hint: to clear an entire string, setting length to 0
 * with _dbus_string_set_length() is easier.)
 *
 * @param str the DBusString
 * @param start where to start deleting
 * @param len the number of bytes to delete
 */
void
_dbus_string_delete (DBusString       *str,
                     int               start,
                     int               len)
{
  DBUS_STRING_PREAMBLE (str);
  _dbus_assert (start >= 0);
  _dbus_assert (len >= 0);
1441
1442
  _dbus_assert (start <= real->len);
  _dbus_assert (len <= real->len - start);
1443
  
1444
1445
1446
  delete (real, start, len);
}

1447
1448
1449
1450
1451
1452
1453
static dbus_bool_t
copy (DBusRealString *source,
      int             start,
      int             len,
      DBusRealString *dest,
      int             insert_at)
{
1454
1455
1456
  if (len == 0)
    return TRUE;

1457
1458
  if (!open_gap (len, dest, insert_at))
    return FALSE;
1459
  
1460
1461
1462
  memmove (dest->str + insert_at,
           source->str + start,
           len);
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504

  return TRUE;
}

/**
 * Checks assertions for two strings we're copying a segment between,
 * and declares real_source/real_dest variables.
 *
 * @param source the source string
 * @param start the starting offset
 * @param dest the dest string
 * @param insert_at where the copied segment is inserted
 */
#define DBUS_STRING_COPY_PREAMBLE(source, start, dest, insert_at)       \
  DBusRealString *real_source = (DBusRealString*) source;               \
  DBusRealString *real_dest = (DBusRealString*) dest;                   \
  _dbus_assert ((source) != (dest));                                    \
  DBUS_GENERIC_STRING_PREAMBLE (real_source);                           \
  DBUS_GENERIC_STRING_PREAMBLE (real_dest);                             \
  _dbus_assert (!real_dest->constant);                                  \
  _dbus_assert (!real_dest->locked);                                    \
  _dbus_assert ((start) >= 0);                                          \
  _dbus_assert ((start) <= real_source->len);                           \
  _dbus_assert ((insert_at) >= 0);                                      \
  _dbus_assert ((insert_at) <= real_dest->len)

/**
 * Moves the end of one string into another string. Both strings
 * must be initialized, valid strings.
 *
 * @param source the source string
 * @param start where to chop off the source string
 * @param dest the destination string
 * @param insert_at where to move the chopped-off part of source string
 * @returns #FALSE if not enough memory
 */
dbus_bool_t
_dbus_string_move (DBusString       *source,
                   int               start,
                   DBusString       *dest,
                   int               insert_at)
{
1505
1506
  DBusRealString *real_source = (DBusRealString*) source;
  _dbus_assert (start <= real_source->len);
1507
  
1508
1509
1510
  return _dbus_string_move_len (source, start,
                                real_source->len - start,
                                dest, insert_at);
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
}

/**
 * Like _dbus_string_move(), but does not delete the section
 * of the source string that's copied to the dest string.
 *
 * @param source the source string
 * @param start where to start copying the source string
 * @param dest the destination string
 * @param insert_at where to place the copied part of source string
 * @returns #FALSE if not enough memory
 */
dbus_bool_t
_dbus_string_copy (const DBusString *source,
                   int               start,
                   DBusString       *dest,
                   int               insert_at)
{
  DBUS_STRING_COPY_PREAMBLE (source, start, dest, insert_at);

  return copy (real_source, start,
               real_source->len - start,
               real_dest,
               insert_at);
}

/**
 * Like _dbus_string_move(), but can move a segment from
 * the middle of the source string.
1540
1541
1542
 *
 * @todo this doesn't do anything with max_length field.
 * we should probably just kill the max_length field though.