dbus/dbus-marshal-recursive.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-marshal-recursive.c  Marshalling routines for recursive types
   3  *
   4  * Copyright (C) 2004, 2005 Red Hat, Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-marshal-recursive.h"
  25 #include "dbus-marshal-basic.h"
  26 #include "dbus-internals.h"
  27
  28 /**
  29  * @addtogroup DBusMarshal
  30  * @{
  31  */
  32
  33 /** turn this on to get deluged in TypeReader verbose spam */
  34 #define RECURSIVE_MARSHAL_READ_TRACE  0
  35
  36 /** turn this on to get deluged in TypeWriter verbose spam */
  37 #define RECURSIVE_MARSHAL_WRITE_TRACE 0
  38
  39 static void
  40 free_fixups (DBusList **fixups)
  41 {
  42   DBusList *link;
  43
  44   link = _dbus_list_get_first_link (fixups);
  45   while (link != NULL)
  46     {
  47       DBusList *next;
  48
  49       next = _dbus_list_get_next_link (fixups, link);
  50
  51       dbus_free (link->data);
  52       _dbus_list_free_link (link);
  53
  54       link = next;
  55     }
  56
  57   *fixups = NULL;
  58 }
  59
  60 static void
  61 apply_and_free_fixups (DBusList      **fixups,
  62                        DBusTypeReader *reader)
  63 {
  64   DBusList *link;
  65
  66 #if RECURSIVE_MARSHAL_WRITE_TRACE
  67   if (*fixups)
  68     _dbus_verbose (" %d FIXUPS to apply\n",
  69                    _dbus_list_get_length (fixups));
  70 #endif
  71
  72   link = _dbus_list_get_first_link (fixups);
  73   while (link != NULL)
  74     {
  75       DBusList *next;
  76
  77       next = _dbus_list_get_next_link (fixups, link);
  78
  79       if (reader)
  80         {
  81           DBusArrayLenFixup *f;
  82
  83           f = link->data;
  84
  85 #if RECURSIVE_MARSHAL_WRITE_TRACE
  86           _dbus_verbose (" applying FIXUP to reader %p at pos %d new_len = %d old len %d\n",
  87                          reader, f->len_pos_in_reader, f->new_len,
  88                          _dbus_marshal_read_uint32 (reader->value_str,
  89                                                     f->len_pos_in_reader,
  90                                                     reader->byte_order, NULL));
  91 #endif
  92
  93           _dbus_marshal_set_uint32 ((DBusString*) reader->value_str,
  94                                     f->len_pos_in_reader,
  95                                     f->new_len,
  96                                     reader->byte_order);
  97         }
  98
  99       dbus_free (link->data);
 100       _dbus_list_free_link (link);
 101
 102       link = next;
 103     }
 104
 105   *fixups = NULL;
 106 }
 107
 108 /**
 109  * Virtual table for a type reader.
 110  */
 111 struct DBusTypeReaderClass
 112 {
 113   const char *name;       /**< name for debugging */
 114   int         id;         /**< index in all_reader_classes */
 115   dbus_bool_t types_only; /**< only iterates over types, not values */
 116   void        (* recurse)          (DBusTypeReader        *sub,
 117                                     DBusTypeReader        *parent); /**< recurse with this reader as sub */
 118   dbus_bool_t (* check_finished)   (const DBusTypeReader  *reader); /**< check whether reader is at the end */
 119   void        (* next)             (DBusTypeReader        *reader,
 120                                     int                    current_type); /**< go to the next value */
 121   void        (* init_from_mark)   (DBusTypeReader        *reader,
 122                                     const DBusTypeMark    *mark);  /**< uncompress from a mark */
 123 };
 124
 125 static int
 126 first_type_in_signature (const DBusString *str,
 127                          int               pos)
 128 {
 129   unsigned char t;
 130
 131   t = _dbus_string_get_byte (str, pos);
 132
 133   if (t == DBUS_STRUCT_BEGIN_CHAR)
 134     return DBUS_TYPE_STRUCT;
 135   else
 136     return t;
 137 }
 138
 139 static int
 140 element_type_get_alignment (const DBusString *str,
 141                             int               pos)
 142 {
 143   return _dbus_type_get_alignment (first_type_in_signature (str, pos));
 144 }
 145
 146 static void
 147 reader_init (DBusTypeReader    *reader,
 148              int                byte_order,
 149              const DBusString  *type_str,
 150              int                type_pos,
 151              const DBusString  *value_str,
 152              int                value_pos)
 153 {
 154   reader->byte_order = byte_order;
 155   reader->finished = FALSE;
 156   reader->type_str = type_str;
 157   reader->type_pos = type_pos;
 158   reader->value_str = value_str;
 159   reader->value_pos = value_pos;
 160 }
 161
 162 static void
 163 base_reader_recurse (DBusTypeReader *sub,
 164                      DBusTypeReader *parent)
 165 {
 166   /* point subreader at the same place as parent */
 167   reader_init (sub,
 168                parent->byte_order,
 169                parent->type_str,
 170                parent->type_pos,
 171                parent->value_str,
 172                parent->value_pos);
 173 }
 174
 175 static void
 176 struct_types_only_reader_recurse (DBusTypeReader *sub,
 177                                   DBusTypeReader *parent)
 178 {
 179   base_reader_recurse (sub, parent);
 180
 181   _dbus_assert (_dbus_string_get_byte (sub->type_str,
 182                                        sub->type_pos) == DBUS_STRUCT_BEGIN_CHAR);
 183
 184   sub->type_pos += 1;
 185 }
 186
 187 static void
 188 struct_reader_recurse (DBusTypeReader *sub,
 189                        DBusTypeReader *parent)
 190 {
 191   struct_types_only_reader_recurse (sub, parent);
 192
 193   /* struct has 8 byte alignment */
 194   sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 8);
 195 }
 196
 197 static void
 198 array_types_only_reader_recurse (DBusTypeReader *sub,
 199                                  DBusTypeReader *parent)
 200 {
 201   base_reader_recurse (sub, parent);
 202
 203   /* point type_pos at the array element type */
 204   sub->type_pos += 1;
 205
 206   /* Init with values likely to crash things if misused */
 207   sub->u.array.start_pos = _DBUS_INT_MAX;
 208   sub->array_len_offset = 7;
 209 }
 210
 211 /** compute position of array length given array_len_offset, which is
 212     the offset back from start_pos to end of the len */
 213 #define ARRAY_READER_LEN_POS(reader) \
 214   ((reader)->u.array.start_pos - ((int)(reader)->array_len_offset) - 4)
 215
 216 static int
 217 array_reader_get_array_len (const DBusTypeReader *reader)
 218 {
 219   dbus_uint32_t array_len;
 220   int len_pos;
 221
 222   len_pos = ARRAY_READER_LEN_POS (reader);
 223
 224   _dbus_assert (_DBUS_ALIGN_VALUE (len_pos, 4) == (unsigned) len_pos);
 225   array_len = _dbus_unpack_uint32 (reader->byte_order,
 226                                    _dbus_string_get_const_data_len (reader->value_str, len_pos, 4));
 227
 228 #if RECURSIVE_MARSHAL_READ_TRACE
 229   _dbus_verbose ("   reader %p len_pos %d array len %u len_offset %d\n",
 230                  reader, len_pos, array_len, reader->array_len_offset);
 231 #endif
 232
 233   _dbus_assert (reader->u.array.start_pos - len_pos - 4 < 8);
 234
 235   return array_len;
 236 }
 237
 238 static void
 239 array_reader_recurse (DBusTypeReader *sub,
 240                       DBusTypeReader *parent)
 241 {
 242   int alignment;
 243   int len_pos;
 244
 245   array_types_only_reader_recurse (sub, parent);
 246
 247   sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 4);
 248
 249   len_pos = sub->value_pos;
 250
 251   sub->value_pos += 4; /* for the length */
 252
 253   alignment = element_type_get_alignment (sub->type_str,
 254                                           sub->type_pos);
 255
 256   sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, alignment);
 257
 258   sub->u.array.start_pos = sub->value_pos;
 259   _dbus_assert ((sub->u.array.start_pos - (len_pos + 4)) < 8); /* only 3 bits in array_len_offset */
 260   sub->array_len_offset = sub->u.array.start_pos - (len_pos + 4);
 261
 262 #if RECURSIVE_MARSHAL_READ_TRACE
 263   _dbus_verbose ("    type reader %p array start = %d len_offset = %d array len = %d array element type = %s\n",
 264                  sub,
 265                  sub->u.array.start_pos,
 266                  sub->array_len_offset,
 267                  array_reader_get_array_len (sub),
 268                  _dbus_type_to_string (first_type_in_signature (sub->type_str,
 269                                                                 sub->type_pos)));
 270 #endif
 271 }
 272
 273 static void
 274 variant_reader_recurse (DBusTypeReader *sub,
 275                         DBusTypeReader *parent)
 276 {
 277   int sig_len;
 278
 279   base_reader_recurse (sub, parent);
 280
 281   /* Variant is 1 byte sig length (without nul), signature with nul,
 282    * padding to 8-boundary, then values
 283    */
 284
 285   sig_len = _dbus_string_get_byte (sub->value_str, sub->value_pos);
 286
 287   sub->type_str = sub->value_str;
 288   sub->type_pos = sub->value_pos + 1;
 289
 290   sub->value_pos = sub->type_pos + sig_len + 1;
 291
 292   sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 8);
 293
 294 #if RECURSIVE_MARSHAL_READ_TRACE
 295   _dbus_verbose ("    type reader %p variant containing '%s'\n",
 296                  sub,
 297                  _dbus_string_get_const_data_len (sub->type_str,
 298                                                   sub->type_pos, 0));
 299 #endif
 300 }
 301
 302 static dbus_bool_t
 303 array_reader_check_finished (const DBusTypeReader *reader)
 304 {
 305   int end_pos;
 306
 307   /* return the array element type if elements remain, and
 308    * TYPE_INVALID otherwise
 309    */
 310
 311   end_pos = reader->u.array.start_pos + array_reader_get_array_len (reader);
 312
 313   _dbus_assert (reader->value_pos <= end_pos);
 314   _dbus_assert (reader->value_pos >= reader->u.array.start_pos);
 315
 316   return reader->value_pos == end_pos;
 317 }
 318
 319 /* this is written a little oddly to try and overoptimize */
 320 static void
 321 skip_one_complete_type (const DBusString *type_str,
 322                         int              *type_pos)
 323 {
 324   const unsigned char *p;
 325   const unsigned char *start;
 326
 327   _dbus_assert (type_str != NULL);
 328   _dbus_assert (type_pos != NULL);
 329
 330   start = _dbus_string_get_const_data (type_str);
 331   p = start + *type_pos;
 332
 333   _dbus_assert (*p != DBUS_STRUCT_END_CHAR);
 334
 335   while (*p == DBUS_TYPE_ARRAY)
 336     ++p;
 337
 338   _dbus_assert (*p != DBUS_STRUCT_END_CHAR);
 339
 340   if (*p == DBUS_STRUCT_BEGIN_CHAR)
 341     {
 342       int depth;
 343
 344       depth = 1;
 345
 346       while (TRUE)
 347         {
 348           _dbus_assert (*p != DBUS_TYPE_INVALID);
 349
 350           ++p;
 351
 352           _dbus_assert (*p != DBUS_TYPE_INVALID);
 353
 354           if (*p == DBUS_STRUCT_BEGIN_CHAR)
 355             depth += 1;
 356           else if (*p == DBUS_STRUCT_END_CHAR)
 357             {
 358               depth -= 1;
 359               if (depth == 0)
 360                 {
 361                   ++p;
 362                   break;
 363                 }
 364             }
 365         }
 366     }
 367   else
 368     {
 369       ++p;
 370     }
 371
 372   *type_pos = (int) (p - start);
 373 }
 374
 375 static int
 376 find_len_of_complete_type (const DBusString *type_str,
 377                            int               type_pos)
 378 {
 379   int end;
 380
 381   end = type_pos;
 382
 383   skip_one_complete_type (type_str, &end);
 384
 385   return end - type_pos;
 386 }
 387
 388 static void
 389 base_reader_next (DBusTypeReader *reader,
 390                   int             current_type)
 391 {
 392   switch (current_type)
 393     {
 394     case DBUS_TYPE_STRUCT:
 395     case DBUS_TYPE_VARIANT:
 396       /* Scan forward over the entire container contents */
 397       {
 398         DBusTypeReader sub;
 399
 400         if (reader->klass->types_only && current_type == DBUS_TYPE_VARIANT)
 401           ;
 402         else
 403           {
 404             /* Recurse into the struct or variant */
 405             _dbus_type_reader_recurse (reader, &sub);
 406
 407             /* Skip everything in this subreader */
 408             while (_dbus_type_reader_next (&sub))
 409               {
 410                 /* nothing */;
 411               }
 412           }
 413         if (!reader->klass->types_only)
 414           reader->value_pos = sub.value_pos;
 415
 416         /* Now we are at the end of this container; for variants, the
 417          * subreader's type_pos is totally inapplicable (it's in the
 418          * value string) but we know that we increment by one past the
 419          * DBUS_TYPE_VARIANT
 420          */
 421         if (current_type == DBUS_TYPE_VARIANT)
 422           reader->type_pos += 1;
 423         else
 424           reader->type_pos = sub.type_pos;
 425       }
 426       break;
 427
 428     case DBUS_TYPE_ARRAY:
 429       {
 430         if (!reader->klass->types_only)
 431           _dbus_marshal_skip_array (reader->value_str,
 432                                     first_type_in_signature (reader->type_str,
 433                                                              reader->type_pos + 1),
 434                                     reader->byte_order,
 435                                     &reader->value_pos);
 436
 437         skip_one_complete_type (reader->type_str, &reader->type_pos);
 438       }
 439       break;
 440
 441     default:
 442       if (!reader->klass->types_only)
 443         _dbus_marshal_skip_basic (reader->value_str,
 444                                   current_type, reader->byte_order,
 445                                   &reader->value_pos);
 446
 447       reader->type_pos += 1;
 448       break;
 449     }
 450 }
 451
 452 static void
 453 struct_reader_next (DBusTypeReader *reader,
 454                     int             current_type)
 455 {
 456   int t;
 457
 458   base_reader_next (reader, current_type);
 459
 460   /* for STRUCT containers we return FALSE at the end of the struct,
 461    * for INVALID we return FALSE at the end of the signature.
 462    * In both cases we arrange for get_current_type() to return INVALID
 463    * which is defined to happen iff we're at the end (no more next())
 464    */
 465   t = _dbus_string_get_byte (reader->type_str, reader->type_pos);
 466   if (t == DBUS_STRUCT_END_CHAR)
 467     {
 468       reader->type_pos += 1;
 469       reader->finished = TRUE;
 470     }
 471 }
 472
 473 static void
 474 array_types_only_reader_next (DBusTypeReader *reader,
 475                               int             current_type)
 476 {
 477   /* We have one "element" to be iterated over
 478    * in each array, which is its element type.
 479    * So the finished flag indicates whether we've
 480    * iterated over it yet or not.
 481    */
 482   reader->finished = TRUE;
 483 }
 484
 485 static void
 486 array_reader_next (DBusTypeReader *reader,
 487                    int             current_type)
 488 {
 489   /* Skip one array element */
 490   int end_pos;
 491
 492   end_pos = reader->u.array.start_pos + array_reader_get_array_len (reader);
 493
 494 #if RECURSIVE_MARSHAL_READ_TRACE
 495   _dbus_verbose ("  reader %p array next START start_pos = %d end_pos = %d value_pos = %d current_type = %s\n",
 496                  reader,
 497                  reader->u.array.start_pos,
 498                  end_pos, reader->value_pos,
 499                  _dbus_type_to_string (current_type));
 500 #endif
 501
 502   _dbus_assert (reader->value_pos < end_pos);
 503   _dbus_assert (reader->value_pos >= reader->u.array.start_pos);
 504
 505   switch (first_type_in_signature (reader->type_str,
 506                                    reader->type_pos))
 507     {
 508     case DBUS_TYPE_STRUCT:
 509     case DBUS_TYPE_VARIANT:
 510       {
 511         DBusTypeReader sub;
 512
 513         /* Recurse into the struct or variant */
 514         _dbus_type_reader_recurse (reader, &sub);
 515
 516         /* Skip everything in this element */
 517         while (_dbus_type_reader_next (&sub))
 518           {
 519             /* nothing */;
 520           }
 521
 522         /* Now we are at the end of this element */
 523         reader->value_pos = sub.value_pos;
 524       }
 525       break;
 526
 527     case DBUS_TYPE_ARRAY:
 528       {
 529         _dbus_marshal_skip_array (reader->value_str,
 530                                   first_type_in_signature (reader->type_str,
 531                                                            reader->type_pos + 1),
 532                                   reader->byte_order,
 533                                   &reader->value_pos);
 534       }
 535       break;
 536
 537     default:
 538       {
 539         _dbus_marshal_skip_basic (reader->value_str,
 540                                   current_type, reader->byte_order,
 541                                   &reader->value_pos);
 542       }
 543       break;
 544     }
 545
 546 #if RECURSIVE_MARSHAL_READ_TRACE
 547   _dbus_verbose ("  reader %p array next END start_pos = %d end_pos = %d value_pos = %d current_type = %s\n",
 548                  reader,
 549                  reader->u.array.start_pos,
 550                  end_pos, reader->value_pos,
 551                  _dbus_type_to_string (current_type));
 552 #endif
 553
 554   _dbus_assert (reader->value_pos <= end_pos);
 555
 556   if (reader->value_pos == end_pos)
 557     {
 558       skip_one_complete_type (reader->type_str,
 559                               &reader->type_pos);
 560     }
 561 }
 562
 563 static void
 564 array_init_from_mark (DBusTypeReader     *reader,
 565                       const DBusTypeMark *mark)
 566 {
 567   /* Fill in the array-specific fields from the mark. The general
 568    * fields are already filled in.
 569    */
 570   reader->u.array.start_pos = mark->array_start_pos;
 571   reader->array_len_offset = mark->array_len_offset;
 572 }
 573
 574 static const DBusTypeReaderClass body_reader_class = {
 575   "body", 0,
 576   FALSE,
 577   NULL, /* body is always toplevel, so doesn't get recursed into */
 578   NULL,
 579   base_reader_next,
 580   NULL
 581 };
 582
 583 static const DBusTypeReaderClass body_types_only_reader_class = {
 584   "body types", 1,
 585   TRUE,
 586   NULL, /* body is always toplevel, so doesn't get recursed into */
 587   NULL,
 588   base_reader_next,
 589   NULL
 590 };
 591
 592 static const DBusTypeReaderClass struct_reader_class = {
 593   "struct", 2,
 594   FALSE,
 595   struct_reader_recurse,
 596   NULL,
 597   struct_reader_next,
 598   NULL
 599 };
 600
 601 static const DBusTypeReaderClass struct_types_only_reader_class = {
 602   "struct types", 3,
 603   TRUE,
 604   struct_types_only_reader_recurse,
 605   NULL,
 606   struct_reader_next,
 607   NULL
 608 };
 609
 610 static const DBusTypeReaderClass array_reader_class = {
 611   "array", 4,
 612   FALSE,
 613   array_reader_recurse,
 614   array_reader_check_finished,
 615   array_reader_next,
 616   array_init_from_mark
 617 };
 618
 619 static const DBusTypeReaderClass array_types_only_reader_class = {
 620   "array types", 5,
 621   TRUE,
 622   array_types_only_reader_recurse,
 623   NULL,
 624   array_types_only_reader_next,
 625   NULL
 626 };
 627
 628 static const DBusTypeReaderClass variant_reader_class = {
 629   "variant", 6,
 630   FALSE,
 631   variant_reader_recurse,
 632   NULL,
 633   base_reader_next,
 634   NULL
 635 };
 636
 637 static const DBusTypeReaderClass const *
 638 all_reader_classes[] = {
 639   &body_reader_class,
 640   &body_types_only_reader_class,
 641   &struct_reader_class,
 642   &struct_types_only_reader_class,
 643   &array_reader_class,
 644   &array_types_only_reader_class,
 645   &variant_reader_class
 646 };
 647
 648 /**
 649  * Initializes a type reader.
 650  *
 651  * @param reader the reader
 652  * @param byte_order the byte order of the block to read
 653  * @param type_str the signature of the block to read
 654  * @param type_pos location of signature
 655  * @param value_str the string containing values block
 656  * @param value_pos start of values block
 657  */
 658 void
 659 _dbus_type_reader_init (DBusTypeReader    *reader,
 660                         int                byte_order,
 661                         const DBusString  *type_str,
 662                         int                type_pos,
 663                         const DBusString  *value_str,
 664                         int                value_pos)
 665 {
 666   reader->klass = &body_reader_class;
 667
 668   reader_init (reader, byte_order, type_str, type_pos,
 669                value_str, value_pos);
 670
 671 #if RECURSIVE_MARSHAL_READ_TRACE
 672   _dbus_verbose ("  type reader %p init type_pos = %d value_pos = %d remaining sig '%s'\n",
 673                  reader, reader->type_pos, reader->value_pos,
 674                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 675 #endif
 676 }
 677
 678 /**
 679  * Initializes a type reader that's been compressed into a
 680  * DBusTypeMark.  The args have to be the same as those passed in to
 681  * create the original #DBusTypeReader.
 682  *
 683  * @param reader the reader
 684  * @param byte_order the byte order of the value block
 685  * @param type_str string containing the type signature
 686  * @param value_str string containing the values block
 687  * @param mark the mark to decompress from
 688  */
 689 void
 690 _dbus_type_reader_init_from_mark (DBusTypeReader     *reader,
 691                                   int                 byte_order,
 692                                   const DBusString   *type_str,
 693                                   const DBusString   *value_str,
 694                                   const DBusTypeMark *mark)
 695 {
 696   reader->klass = all_reader_classes[mark->container_type];
 697
 698   reader_init (reader, byte_order,
 699                mark->type_pos_in_value_str ? value_str : type_str,
 700                mark->type_pos,
 701                value_str, mark->value_pos);
 702
 703   if (reader->klass->init_from_mark)
 704     (* reader->klass->init_from_mark) (reader, mark);
 705
 706 #if RECURSIVE_MARSHAL_READ_TRACE
 707   _dbus_verbose ("  type reader %p init from mark type_pos = %d value_pos = %d remaining sig '%s'\n",
 708                  reader, reader->type_pos, reader->value_pos,
 709                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 710 #endif
 711 }
 712
 713 /**
 714  * Like _dbus_type_reader_init() but the iteration is over the
 715  * signature, not over values.
 716  *
 717  * @param reader the reader
 718  * @param type_str the signature string
 719  * @param type_pos location in the signature string
 720  */
 721 void
 722 _dbus_type_reader_init_types_only (DBusTypeReader    *reader,
 723                                    const DBusString  *type_str,
 724                                    int                type_pos)
 725 {
 726   reader->klass = &body_types_only_reader_class;
 727
 728   reader_init (reader, DBUS_COMPILER_BYTE_ORDER /* irrelevant */,
 729                type_str, type_pos, NULL, _DBUS_INT_MAX /* crashes if we screw up */);
 730
 731 #if RECURSIVE_MARSHAL_READ_TRACE
 732   _dbus_verbose ("  type reader %p init types only type_pos = %d remaining sig '%s'\n",
 733                  reader, reader->type_pos,
 734                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 735 #endif
 736 }
 737
 738 /**
 739  * Like _dbus_type_reader_init_from_mark() but only iterates over
 740  * the signature, not the values.
 741  *
 742  * @param reader the reader
 743  * @param type_str the signature string
 744  * @param mark the mark to decompress from
 745  */
 746 void
 747 _dbus_type_reader_init_types_only_from_mark (DBusTypeReader     *reader,
 748                                              const DBusString   *type_str,
 749                                              const DBusTypeMark *mark)
 750 {
 751   reader->klass = all_reader_classes[mark->container_type];
 752   _dbus_assert (reader->klass->types_only);
 753   _dbus_assert (!mark->type_pos_in_value_str);
 754
 755   reader_init (reader, DBUS_COMPILER_BYTE_ORDER, /* irrelevant */
 756                type_str, mark->type_pos,
 757                NULL, _DBUS_INT_MAX /* crashes if we screw up */);
 758
 759   if (reader->klass->init_from_mark)
 760     (* reader->klass->init_from_mark) (reader, mark);
 761
 762 #if RECURSIVE_MARSHAL_READ_TRACE
 763   _dbus_verbose ("  type reader %p init types only from mark type_pos = %d remaining sig '%s'\n",
 764                  reader, reader->type_pos,
 765                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 766 #endif
 767 }
 768
 769 /**
 770  * Compresses a type reader into a #DBusTypeMark, useful for example
 771  * if you want to cache a bunch of positions in a block of values.
 772  *
 773  * @param reader the reader
 774  * @param mark the mark to init
 775  */
 776 void
 777 _dbus_type_reader_save_mark (const DBusTypeReader *reader,
 778                              DBusTypeMark         *mark)
 779 {
 780   mark->type_pos_in_value_str = (reader->type_str == reader->value_str);
 781   mark->container_type = reader->klass->id;
 782   _dbus_assert (all_reader_classes[reader->klass->id] == reader->klass);
 783
 784   mark->type_pos = reader->type_pos;
 785   mark->value_pos = reader->value_pos;
 786
 787   /* these are just junk if the reader isn't really an array of course */
 788   mark->array_len_offset = reader->array_len_offset;
 789   mark->array_start_pos = reader->u.array.start_pos;
 790 }
 791
 792 /**
 793  * Gets the type of the value the reader is currently pointing to;
 794  * or for a types-only reader gets the type it's currently pointing to.
 795  * If the reader is at the end of a block or end of a container such
 796  * as an array, returns #DBUS_TYPE_INVALID.
 797  *
 798  * @param reader the reader
 799  */
 800 int
 801 _dbus_type_reader_get_current_type (const DBusTypeReader *reader)
 802 {
 803   int t;
 804
 805   if (reader->finished ||
 806       (reader->klass->check_finished &&
 807        (* reader->klass->check_finished) (reader)))
 808     t = DBUS_TYPE_INVALID;
 809   else
 810     t = first_type_in_signature (reader->type_str,
 811                                  reader->type_pos);
 812
 813   _dbus_assert (t != DBUS_STRUCT_END_CHAR);
 814   _dbus_assert (t != DBUS_STRUCT_BEGIN_CHAR);
 815
 816 #if 0
 817   _dbus_verbose ("  type reader %p current type_pos = %d type = %s\n",
 818                  reader, reader->type_pos,
 819                  _dbus_type_to_string (t));
 820 #endif
 821
 822   return t;
 823 }
 824
 825 /**
 826  * Gets the type of an element of the array the reader is currently
 827  * pointing to. It's an error to call this if
 828  * _dbus_type_reader_get_current_type() doesn't return #DBUS_TYPE_ARRAY
 829  * for this reader.
 830  *
 831  * @param reader the reader
 832  */
 833 int
 834 _dbus_type_reader_get_element_type (const DBusTypeReader  *reader)
 835 {
 836   int element_type;
 837
 838   _dbus_assert (_dbus_type_reader_get_current_type (reader) == DBUS_TYPE_ARRAY);
 839
 840   element_type = first_type_in_signature (reader->type_str,
 841                                           reader->type_pos + 1);
 842
 843   return element_type;
 844 }
 845
 846 /**
 847  * Gets the current position in the value block
 848  * @param reader the reader
 849  */
 850 int
 851 _dbus_type_reader_get_value_pos (const DBusTypeReader  *reader)
 852 {
 853   return reader->value_pos;
 854 }
 855
 856 /**
 857  * Get the address of the marshaled value in the data being read.  The
 858  * address may not be aligned; you have to align it to the type of the
 859  * value you want to read. Most of the demarshal routines do this for
 860  * you.
 861  *
 862  * @param reader the reader
 863  * @param value_location the address of the marshaled value
 864  */
 865 void
 866 _dbus_type_reader_read_raw (const DBusTypeReader  *reader,
 867                             const unsigned char  **value_location)
 868 {
 869   _dbus_assert (!reader->klass->types_only);
 870
 871   *value_location = _dbus_string_get_const_data_len (reader->value_str,
 872                                                      reader->value_pos,
 873                                                      0);
 874 }
 875
 876 /**
 877  * Reads a basic-typed value, as with _dbus_marshal_read_basic().
 878  *
 879  * @param reader the reader
 880  * @param value the address of the value
 881  */
 882 void
 883 _dbus_type_reader_read_basic (const DBusTypeReader    *reader,
 884                               void                    *value)
 885 {
 886   int t;
 887
 888   _dbus_assert (!reader->klass->types_only);
 889
 890   t = _dbus_type_reader_get_current_type (reader);
 891
 892   _dbus_marshal_read_basic (reader->value_str,
 893                             reader->value_pos,
 894                             t, value,
 895                             reader->byte_order,
 896                             NULL);
 897
 898
 899 #if RECURSIVE_MARSHAL_READ_TRACE
 900   _dbus_verbose ("  type reader %p read basic type_pos = %d value_pos = %d remaining sig '%s'\n",
 901                  reader, reader->type_pos, reader->value_pos,
 902                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 903 #endif
 904 }
 905
 906 /**
 907  * Reads a block of fixed-length basic values, from the current point
 908  * in an array to the end of the array.  Does not work for arrays of
 909  * string or container types.
 910  *
 911  * This function returns the array in-place; it does not make a copy,
 912  * and it does not swap the bytes.
 913  *
 914  * If you ask for #DBUS_TYPE_DOUBLE you will get a "const double*" back
 915  * and the "value" argument should be a "const double**" and so on.
 916  *
 917  * @param reader the reader to read from
 918  * @param value place to return the array values
 919  * @param n_elements place to return number of array elements
 920  */
 921 void
 922 _dbus_type_reader_read_fixed_multi (const DBusTypeReader  *reader,
 923                                     void                  *value,
 924                                     int                   *n_elements)
 925 {
 926   int element_type;
 927   int end_pos;
 928   int remaining_len;
 929   int alignment;
 930   int total_len;
 931
 932   _dbus_assert (!reader->klass->types_only);
 933   _dbus_assert (reader->klass == &array_reader_class);
 934
 935   element_type = first_type_in_signature (reader->type_str,
 936                                           reader->type_pos);
 937
 938   _dbus_assert (element_type != DBUS_TYPE_INVALID); /* why we don't use get_current_type() */
 939   _dbus_assert (_dbus_type_is_fixed (element_type));
 940
 941   alignment = _dbus_type_get_alignment (element_type);
 942
 943   _dbus_assert (reader->value_pos >= reader->u.array.start_pos);
 944
 945   total_len = array_reader_get_array_len (reader);
 946   end_pos = reader->u.array.start_pos + total_len;
 947   remaining_len = end_pos - reader->value_pos;
 948
 949 #if RECURSIVE_MARSHAL_READ_TRACE
 950   _dbus_verbose ("end_pos %d total_len %d remaining_len %d value_pos %d\n",
 951                  end_pos, total_len, remaining_len, reader->value_pos);
 952 #endif
 953
 954   _dbus_assert (remaining_len <= total_len);
 955
 956   if (remaining_len == 0)
 957     *(const DBusBasicValue**) value = NULL;
 958   else
 959     *(const DBusBasicValue**) value =
 960       (void*) _dbus_string_get_const_data_len (reader->value_str,
 961                                                reader->value_pos,
 962                                                remaining_len);
 963
 964   *n_elements = remaining_len / alignment;
 965   _dbus_assert ((remaining_len % alignment) == 0);
 966
 967 #if RECURSIVE_MARSHAL_READ_TRACE
 968   _dbus_verbose ("  type reader %p read fixed array type_pos = %d value_pos = %d remaining sig '%s'\n",
 969                  reader, reader->type_pos, reader->value_pos,
 970                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0));
 971 #endif
 972 }
 973
 974 /**
 975  * Initialize a new reader pointing to the first type and
 976  * corresponding value that's a child of the current container. It's
 977  * an error to call this if the current type is a non-container.
 978  *
 979  * Note that DBusTypeReader traverses values, not types. So if you
 980  * have an empty array of array of int, you can't recurse into it. You
 981  * can only recurse into each element.
 982  *
 983  * @param reader the reader
 984  * @param sub a reader to init pointing to the first child
 985  */
 986 void
 987 _dbus_type_reader_recurse (DBusTypeReader *reader,
 988                            DBusTypeReader *sub)
 989 {
 990   int t;
 991
 992   t = first_type_in_signature (reader->type_str, reader->type_pos);
 993
 994   switch (t)
 995     {
 996     case DBUS_TYPE_STRUCT:
 997       if (reader->klass->types_only)
 998         sub->klass = &struct_types_only_reader_class;
 999       else
1000         sub->klass = &struct_reader_class;
1001       break;
1002     case DBUS_TYPE_ARRAY:
1003       if (reader->klass->types_only)
1004         sub->klass = &array_types_only_reader_class;
1005       else
1006         sub->klass = &array_reader_class;
1007       break;
1008     case DBUS_TYPE_VARIANT:
1009       if (reader->klass->types_only)
1010         _dbus_assert_not_reached ("can't recurse into variant typecode");
1011       else
1012         sub->klass = &variant_reader_class;
1013       break;
1014     default:
1015       _dbus_verbose ("recursing into type %s\n", _dbus_type_to_string (t));
1016 #ifndef DBUS_DISABLE_CHECKS
1017       if (t == DBUS_TYPE_INVALID)
1018         _dbus_warn ("You can't recurse into an empty array or off the end of a message body\n");
1019 #endif /* DBUS_DISABLE_CHECKS */
1020
1021       _dbus_assert_not_reached ("don't yet handle recursing into this type");
1022     }
1023
1024   _dbus_assert (sub->klass == all_reader_classes[sub->klass->id]);
1025
1026   (* sub->klass->recurse) (sub, reader);
1027
1028 #if RECURSIVE_MARSHAL_READ_TRACE
1029   _dbus_verbose ("  type reader %p RECURSED type_pos = %d value_pos = %d remaining sig '%s'\n",
1030                  sub, sub->type_pos, sub->value_pos,
1031                  _dbus_string_get_const_data_len (sub->type_str, sub->type_pos, 0));
1032 #endif
1033 }
1034
1035 /**
1036  * Skip to the next value on this "level". e.g. the next field in a
1037  * struct, the next value in an array. Returns FALSE at the end of the
1038  * current container.
1039  *
1040  * @param reader the reader
1041  * @returns FALSE if nothing more to read at or below this level
1042  */
1043 dbus_bool_t
1044 _dbus_type_reader_next (DBusTypeReader *reader)
1045 {
1046   int t;
1047
1048   t = _dbus_type_reader_get_current_type (reader);
1049
1050 #if RECURSIVE_MARSHAL_READ_TRACE
1051   _dbus_verbose ("  type reader %p START next() { type_pos = %d value_pos = %d remaining sig '%s' current_type = %s\n",
1052                  reader, reader->type_pos, reader->value_pos,
1053                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0),
1054                  _dbus_type_to_string (t));
1055 #endif
1056
1057   if (t == DBUS_TYPE_INVALID)
1058     return FALSE;
1059
1060   (* reader->klass->next) (reader, t);
1061
1062 #if RECURSIVE_MARSHAL_READ_TRACE
1063   _dbus_verbose ("  type reader %p END next() type_pos = %d value_pos = %d remaining sig '%s' current_type = %s\n",
1064                  reader, reader->type_pos, reader->value_pos,
1065                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0),
1066                  _dbus_type_to_string (_dbus_type_reader_get_current_type (reader)));
1067 #endif
1068
1069   return _dbus_type_reader_get_current_type (reader) != DBUS_TYPE_INVALID;
1070 }
1071
1072 /**
1073  * Check whether there's another value on this "level". e.g. the next
1074  * field in a struct, the next value in an array. Returns FALSE at the
1075  * end of the current container.
1076  *
1077  * You probably don't want to use this; it makes for an awkward for/while
1078  * loop. A nicer one is "while ((current_type = get_current_type()) != INVALID)"
1079  *
1080  * @param reader the reader
1081  * @returns FALSE if nothing more to read at or below this level
1082  */
1083 dbus_bool_t
1084 _dbus_type_reader_has_next (const DBusTypeReader *reader)
1085 {
1086   /* Not efficient but works for now. */
1087   DBusTypeReader copy;
1088
1089   copy = *reader;
1090   return _dbus_type_reader_next (&copy);
1091 }
1092
1093 /**
1094  * Gets the string and range of said string containing the signature
1095  * of the current value. Essentially a more complete version of
1096  * _dbus_type_reader_get_current_type() (returns the full type
1097  * rather than only the outside of the onion).
1098  *
1099  * Note though that the first byte in a struct signature is
1100  * #DBUS_STRUCT_BEGIN_CHAR while the current type will be
1101  * #DBUS_TYPE_STRUCT so it isn't true that the first byte of the
1102  * signature is always the same as the current type. Another
1103  * difference is that this function will still return a signature when
1104  * inside an empty array; say you recurse into empty array of int32,
1105  * the signature is "i" but the current type will always be
1106  * #DBUS_TYPE_INVALID since there are no elements to be currently
1107  * pointing to.
1108  *
1109  * @param reader the reader
1110  * @param str_p place to return the string with the type in it
1111  * @param start_p place to return start of the type
1112  * @param len_p place to return the length of the type
1113  */
1114 void
1115 _dbus_type_reader_get_signature (const DBusTypeReader  *reader,
1116                                  const DBusString     **str_p,
1117                                  int                   *start_p,
1118                                  int                   *len_p)
1119 {
1120   *str_p = reader->type_str;
1121   *start_p = reader->type_pos;
1122   *len_p = find_len_of_complete_type (reader->type_str, reader->type_pos);
1123 }
1124
1125 typedef struct
1126 {
1127   DBusString replacement;
1128   int padding;
1129 } ReplacementBlock;
1130
1131 static dbus_bool_t
1132 replacement_block_init (ReplacementBlock *block,
1133                         DBusTypeReader   *reader)
1134 {
1135   if (!_dbus_string_init (&block->replacement))
1136     return FALSE;
1137
1138   /* % 8 is the padding to have the same align properties in
1139    * our replacement string as we do at the position being replaced
1140    */
1141   block->padding = reader->value_pos % 8;
1142
1143   if (!_dbus_string_lengthen (&block->replacement, block->padding))
1144     goto oom;
1145
1146   return TRUE;
1147
1148  oom:
1149   _dbus_string_free (&block->replacement);
1150   return FALSE;
1151 }
1152
1153 static dbus_bool_t
1154 replacement_block_replace (ReplacementBlock     *block,
1155                            DBusTypeReader       *reader,
1156                            const DBusTypeReader *realign_root)
1157 {
1158   DBusTypeWriter writer;
1159   DBusTypeReader realign_reader;
1160   DBusList *fixups;
1161   int orig_len;
1162
1163   _dbus_assert (realign_root != NULL);
1164
1165   orig_len = _dbus_string_get_length (&block->replacement);
1166
1167   realign_reader = *realign_root;
1168
1169 #if RECURSIVE_MARSHAL_WRITE_TRACE
1170   _dbus_verbose ("INITIALIZING replacement block writer %p at value_pos %d\n",
1171                  &writer, _dbus_string_get_length (&block->replacement));
1172 #endif
1173   _dbus_type_writer_init_values_only (&writer,
1174                                       realign_reader.byte_order,
1175                                       realign_reader.type_str,
1176                                       realign_reader.type_pos,
1177                                       &block->replacement,
1178                                       _dbus_string_get_length (&block->replacement));
1179
1180   _dbus_assert (realign_reader.value_pos <= reader->value_pos);
1181
1182 #if RECURSIVE_MARSHAL_WRITE_TRACE
1183   _dbus_verbose ("COPYING from reader at value_pos %d to writer %p starting after value_pos %d\n",
1184                  realign_reader.value_pos, &writer, reader->value_pos);
1185 #endif
1186   fixups = NULL;
1187   if (!_dbus_type_writer_write_reader_partial (&writer,
1188                                                &realign_reader,
1189                                                reader,
1190                                                block->padding,
1191                                                _dbus_string_get_length (&block->replacement) - block->padding,
1192                                                &fixups))
1193     goto oom;
1194
1195 #if RECURSIVE_MARSHAL_WRITE_TRACE
1196   _dbus_verbose ("REPLACEMENT at padding %d len %d\n", block->padding,
1197                  _dbus_string_get_length (&block->replacement) - block->padding);
1198   _dbus_verbose_bytes_of_string (&block->replacement, block->padding,
1199                                  _dbus_string_get_length (&block->replacement) - block->padding);
1200   _dbus_verbose ("TO BE REPLACED at value_pos = %d (align pad %d) len %d realign_reader.value_pos %d\n",
1201                  reader->value_pos, reader->value_pos % 8,
1202                  realign_reader.value_pos - reader->value_pos,
1203                  realign_reader.value_pos);
1204   _dbus_verbose_bytes_of_string (reader->value_str,
1205                                  reader->value_pos,
1206                                  realign_reader.value_pos - reader->value_pos);
1207 #endif
1208
1209   /* Move the replacement into position
1210    * (realign_reader should now be at the end of the block to be replaced)
1211    */
1212   if (!_dbus_string_replace_len (&block->replacement, block->padding,
1213                                  _dbus_string_get_length (&block->replacement) - block->padding,
1214                                  (DBusString*) reader->value_str,
1215                                  reader->value_pos,
1216                                  realign_reader.value_pos - reader->value_pos))
1217     goto oom;
1218
1219   /* Process our fixups now that we can't have an OOM error */
1220   apply_and_free_fixups (&fixups, reader);
1221
1222   return TRUE;
1223
1224  oom:
1225   _dbus_string_set_length (&block->replacement, orig_len);
1226   free_fixups (&fixups);
1227   return FALSE;
1228 }
1229
1230 static void
1231 replacement_block_free (ReplacementBlock *block)
1232 {
1233   _dbus_string_free (&block->replacement);
1234 }
1235
1236 /* In the variable-length case, we have to fix alignment after we insert.
1237  * The strategy is as follows:
1238  *
1239  *  - pad a new string to have the same alignment as the
1240  *    start of the current basic value
1241  *  - write the new basic value
1242  *  - copy from the original reader to the new string,
1243  *    which will fix the alignment of types following
1244  *    the new value
1245  *    - this copy has to start at realign_root,
1246  *      but not really write anything until it
1247  *      passes the value being set
1248  *    - as an optimization, we can stop copying
1249  *      when the source and dest values are both
1250  *      on an 8-boundary, since we know all following
1251  *      padding and alignment will be identical
1252  *  - copy the new string back to the original
1253  *    string, replacing the relevant part of the
1254  *    original string
1255  *  - now any arrays in the original string that
1256  *    contained the replaced string may have the
1257  *    wrong length; so we have to fix that
1258  */
1259 static dbus_bool_t
1260 reader_set_basic_variable_length (DBusTypeReader       *reader,
1261                                   int                   current_type,
1262                                   const void           *value,
1263                                   const DBusTypeReader *realign_root)
1264 {
1265   dbus_bool_t retval;
1266   ReplacementBlock block;
1267   DBusTypeWriter writer;
1268
1269   _dbus_assert (realign_root != NULL);
1270
1271   retval = FALSE;
1272
1273   if (!replacement_block_init (&block, reader))
1274     return FALSE;
1275
1276   /* Write the new basic value */
1277 #if RECURSIVE_MARSHAL_WRITE_TRACE
1278   _dbus_verbose ("INITIALIZING writer %p to write basic value at value_pos %d of replacement string\n",
1279                  &writer, _dbus_string_get_length (&block.replacement));
1280 #endif
1281   _dbus_type_writer_init_values_only (&writer,
1282                                       reader->byte_order,
1283                                       reader->type_str,
1284                                       reader->type_pos,
1285                                       &block.replacement,
1286                                       _dbus_string_get_length (&block.replacement));
1287 #if RECURSIVE_MARSHAL_WRITE_TRACE
1288   _dbus_verbose ("WRITING basic value to writer %p (replacement string)\n", &writer);
1289 #endif
1290   if (!_dbus_type_writer_write_basic (&writer, current_type, value))
1291     goto out;
1292
1293   if (!replacement_block_replace (&block,
1294                                   reader,
1295                                   realign_root))
1296     goto out;
1297
1298   retval = TRUE;
1299
1300  out:
1301   replacement_block_free (&block);
1302   return retval;
1303 }
1304
1305 static void
1306 reader_set_basic_fixed_length (DBusTypeReader *reader,
1307                                int             current_type,
1308                                const void     *value)
1309 {
1310   _dbus_marshal_set_basic ((DBusString*) reader->value_str,
1311                            reader->value_pos,
1312                            current_type,
1313                            value,
1314                            reader->byte_order,
1315                            NULL, NULL);
1316 }
1317
1318 /**
1319  * Sets a new value for the basic type value pointed to by the reader,
1320  * leaving the reader valid to continue reading. Any other readers
1321  * will be invalidated if you set a variable-length type such as a
1322  * string.
1323  *
1324  * The provided realign_root is the reader to start from when
1325  * realigning the data that follows the newly-set value. The reader
1326  * parameter must point to a value below the realign_root parameter.
1327  * If the type being set is fixed-length, then realign_root may be
1328  * #NULL. Only values reachable from realign_root will be realigned,
1329  * so if your string contains other values you will need to deal with
1330  * those somehow yourself. It is OK if realign_root is the same
1331  * reader as the reader parameter, though if you aren't setting the
1332  * root it may not be such a good idea.
1333  *
1334  * @todo DBusTypeReader currently takes "const" versions of the type
1335  * and value strings, and this function modifies those strings by
1336  * casting away the const, which is of course bad if we want to get
1337  * picky. (To be truly clean you'd have an object which contained the
1338  * type and value strings and set_basic would be a method on that
1339  * object... this would also make DBusTypeReader the same thing as
1340  * DBusTypeMark. But since DBusMessage is effectively that object for
1341  * D-BUS it doesn't seem worth creating some random object.)
1342  *
1343  * @todo optimize this by only rewriting until the old and new values
1344  * are at the same alignment. Frequently this should result in only
1345  * replacing the value that's immediately at hand.
1346  *
1347  * @param reader reader indicating where to set a new value
1348  * @param value address of the value to set
1349  * @param realign_root realign from here
1350  * @returns #FALSE if not enough memory
1351  */
1352 dbus_bool_t
1353 _dbus_type_reader_set_basic (DBusTypeReader       *reader,
1354                              const void           *value,
1355                              const DBusTypeReader *realign_root)
1356 {
1357   int current_type;
1358
1359   _dbus_assert (!reader->klass->types_only);
1360   _dbus_assert (reader->value_str == realign_root->value_str);
1361   _dbus_assert (reader->value_pos >= realign_root->value_pos);
1362
1363   current_type = _dbus_type_reader_get_current_type (reader);
1364
1365 #if RECURSIVE_MARSHAL_WRITE_TRACE
1366   _dbus_verbose ("  SET BASIC type reader %p type_pos = %d value_pos = %d remaining sig '%s' realign_root = %p with value_pos %d current_type = %s\n",
1367                  reader, reader->type_pos, reader->value_pos,
1368                  _dbus_string_get_const_data_len (reader->type_str, reader->type_pos, 0),
1369                  realign_root,
1370                  realign_root ? realign_root->value_pos : -1,
1371                  _dbus_type_to_string (current_type));
1372   _dbus_verbose_bytes_of_string (realign_root->value_str, realign_root->value_pos,
1373                                  _dbus_string_get_length (realign_root->value_str) -
1374                                  realign_root->value_pos);
1375 #endif
1376
1377   _dbus_assert (_dbus_type_is_basic (current_type));
1378
1379   if (_dbus_type_is_fixed (current_type))
1380     {
1381       reader_set_basic_fixed_length (reader, current_type, value);
1382       return TRUE;
1383     }
1384   else
1385     {
1386       _dbus_assert (realign_root != NULL);
1387       return reader_set_basic_variable_length (reader, current_type,
1388                                                value, realign_root);
1389     }
1390 }
1391
1392 /**
1393  * Recursively deletes any value pointed to by the reader, leaving the
1394  * reader valid to continue reading. Any other readers will be
1395  * invalidated.
1396  *
1397  * The provided realign_root is the reader to start from when
1398  * realigning the data that follows the newly-set value.
1399  * See _dbus_type_reader_set_basic() for more details on the
1400  * realign_root paramter.
1401  *
1402  * @todo for now this does not delete the typecodes associated with
1403  * the value, so this function should only be used for array elements.
1404  *
1405  * @param reader reader indicating where to delete a value
1406  * @param realign_root realign from here
1407  * @returns #FALSE if not enough memory
1408  */
1409 dbus_bool_t
1410 _dbus_type_reader_delete (DBusTypeReader        *reader,
1411                           const DBusTypeReader  *realign_root)
1412 {
1413   dbus_bool_t retval;
1414   ReplacementBlock block;
1415
1416   _dbus_assert (realign_root != NULL);
1417   _dbus_assert (reader->klass == &array_reader_class);
1418
1419   retval = FALSE;
1420
1421   if (!replacement_block_init (&block, reader))
1422     return FALSE;
1423
1424   if (!replacement_block_replace (&block,
1425                                   reader,
1426                                   realign_root))
1427     goto out;
1428
1429   retval = TRUE;
1430
1431  out:
1432   replacement_block_free (&block);
1433   return retval;
1434 }
1435
1436 /**
1437  * Compares two readers, which must be iterating over the same value data.
1438  * Returns #TRUE if the first parameter is further along than the second parameter.
1439  *
1440  * @param lhs left-hand-side (first) parameter
1441  * @param rhs left-hand-side (first) parameter
1442  * @returns whether lhs is greater than rhs
1443  */
1444 dbus_bool_t
1445 _dbus_type_reader_greater_than (const DBusTypeReader  *lhs,
1446                                 const DBusTypeReader  *rhs)
1447 {
1448   _dbus_assert (lhs->value_str == rhs->value_str);
1449
1450   return lhs->value_pos > rhs->value_pos;
1451 }
1452
1453 /*
1454  *
1455  *
1456  *         DBusTypeWriter
1457  *
1458  *
1459  *
1460  */
1461
1462 /**
1463  * Initialize a write iterator, which is used to write out values in
1464  * serialized D-BUS format.
1465  *
1466  * The type_pos passed in is expected to be inside an already-valid,
1467  * though potentially empty, type signature. This means that the byte
1468  * after type_pos must be either #DBUS_TYPE_INVALID (aka nul) or some
1469  * other valid type. #DBusTypeWriter won't enforce that the signature
1470  * is already valid (you can append the nul byte at the end if you
1471  * like), but just be aware that you need the nul byte eventually and
1472  * #DBusTypeWriter isn't going to write it for you.
1473  *
1474  * @param writer the writer to init
1475  * @param byte_order the byte order to marshal into
1476  * @param type_str the string to write typecodes into
1477  * @param type_pos where to insert typecodes
1478  * @param value_str the string to write values into
1479  * @param value_pos where to insert values
1480  *
1481  */
1482 void
1483 _dbus_type_writer_init (DBusTypeWriter *writer,
1484                         int             byte_order,
1485                         DBusString     *type_str,
1486                         int             type_pos,
1487                         DBusString     *value_str,
1488                         int             value_pos)
1489 {
1490   writer->byte_order = byte_order;
1491   writer->type_str = type_str;
1492   writer->type_pos = type_pos;
1493   writer->value_str = value_str;
1494   writer->value_pos = value_pos;
1495   writer->container_type = DBUS_TYPE_INVALID;
1496   writer->type_pos_is_expectation = FALSE;
1497   writer->enabled = TRUE;
1498
1499 #if RECURSIVE_MARSHAL_WRITE_TRACE
1500   _dbus_verbose ("writer %p init remaining sig '%s'\n", writer,
1501                  writer->type_str ?
1502                  _dbus_string_get_const_data_len (writer->type_str, writer->type_pos, 0) :
1503                  "unknown");
1504 #endif
1505 }
1506
1507 /**
1508  * Initialize a write iterator, with the signature to be provided
1509  * later.
1510  *
1511  * @param writer the writer to init
1512  * @param byte_order the byte order to marshal into
1513  * @param value_str the string to write values into
1514  * @param value_pos where to insert values
1515  *
1516  */
1517 void
1518 _dbus_type_writer_init_types_delayed (DBusTypeWriter *writer,
1519                                       int             byte_order,
1520                                       DBusString     *value_str,
1521                                       int             value_pos)
1522 {
1523   _dbus_type_writer_init (writer, byte_order,
1524                           NULL, 0, value_str, value_pos);
1525 }
1526
1527 /**
1528  * Adds type string to the writer, if it had none.
1529  *
1530  * @param writer the writer to init
1531  * @param type_str type string to add
1532  * @param type_pos type position
1533  *
1534  */
1535 void
1536 _dbus_type_writer_add_types (DBusTypeWriter *writer,
1537                              DBusString     *type_str,
1538                              int             type_pos)
1539 {
1540   if (writer->type_str == NULL) /* keeps us from using this as setter */
1541     {
1542       writer->type_str = type_str;
1543       writer->type_pos = type_pos;
1544     }
1545 }
1546
1547 /**
1548  * Removes type string from the writer.
1549  *
1550  * @param writer the writer to remove from
1551  */
1552 void
1553 _dbus_type_writer_remove_types (DBusTypeWriter *writer)
1554 {
1555   writer->type_str = NULL;
1556   writer->type_pos = -1;
1557 }
1558
1559 /**
1560  * Like _dbus_type_writer_init(), except the type string
1561  * passed in should correspond to an existing signature that
1562  * matches what you're going to write out. The writer will
1563  * check what you write vs. this existing signature.
1564  *
1565  * @param writer the writer to init
1566  * @param byte_order the byte order to marshal into
1567  * @param type_str the string with signature
1568  * @param type_pos start of signature
1569  * @param value_str the string to write values into
1570  * @param value_pos where to insert values
1571  *
1572  */
1573 void
1574 _dbus_type_writer_init_values_only (DBusTypeWriter   *writer,
1575                                     int               byte_order,
1576                                     const DBusString *type_str,
1577                                     int               type_pos,
1578                                     DBusString       *value_str,
1579                                     int               value_pos)
1580 {
1581   _dbus_type_writer_init (writer, byte_order,
1582                           (DBusString*)type_str, type_pos,
1583                           value_str, value_pos);
1584
1585   writer->type_pos_is_expectation = TRUE;
1586 }
1587
1588 static dbus_bool_t
1589 _dbus_type_writer_write_basic_no_typecode (DBusTypeWriter *writer,
1590                                            int             type,
1591                                            const void     *value)
1592 {
1593   if (writer->enabled)
1594     return _dbus_marshal_write_basic (writer->value_str,
1595                                       writer->value_pos,
1596                                       type,
1597                                       value,
1598                                       writer->byte_order,
1599                                       &writer->value_pos);
1600   else
1601     return TRUE;
1602 }
1603
1604 /* If our parent is an array, things are a little bit complicated.
1605  *
1606  * The parent must have a complete element type, such as
1607  * "i" or "aai" or "(ii)" or "a(ii)". There can't be
1608  * unclosed parens, or an "a" with no following type.
1609  *
1610  * To recurse, the only allowed operation is to recurse into the
1611  * first type in the element type. So for "i" you can't recurse, for
1612  * "ai" you can recurse into the array, for "(ii)" you can recurse
1613  * into the struct.
1614  *
1615  * If you recurse into the array for "ai", then you must specify
1616  * "i" for the element type of the array you recurse into.
1617  *
1618  * While inside an array at any level, we need to avoid writing to
1619  * type_str, since the type only appears once for the whole array,
1620  * it does not appear for each array element.
1621  *
1622  * While inside an array type_pos points to the expected next
1623  * typecode, rather than the next place we could write a typecode.
1624  */
1625 static void
1626 writer_recurse_init_and_check (DBusTypeWriter *writer,
1627                                int             container_type,
1628                                DBusTypeWriter *sub)
1629 {
1630   _dbus_type_writer_init (sub,
1631                           writer->byte_order,
1632                           writer->type_str,
1633                           writer->type_pos,
1634                           writer->value_str,
1635                           writer->value_pos);
1636
1637   sub->container_type = container_type;
1638
1639   if (writer->type_pos_is_expectation ||
1640       (sub->container_type == DBUS_TYPE_ARRAY || sub->container_type == DBUS_TYPE_VARIANT))
1641     sub->type_pos_is_expectation = TRUE;
1642   else
1643     sub->type_pos_is_expectation = FALSE;
1644
1645   sub->enabled = writer->enabled;
1646
1647 #ifndef DBUS_DISABLE_CHECKS
1648   if (writer->type_pos_is_expectation && writer->type_str)
1649     {
1650       int expected;
1651
1652       expected = first_type_in_signature (writer->type_str, writer->type_pos);
1653
1654       if (expected != sub->container_type)
1655         {
1656           _dbus_warn ("Writing an element of type %s, but the expected type here is %s\n",
1657                       _dbus_type_to_string (sub->container_type),
1658                       _dbus_type_to_string (expected));
1659           _dbus_assert_not_reached ("bad array element or variant content written");
1660         }
1661     }
1662 #endif /* DBUS_DISABLE_CHECKS */
1663
1664 #if RECURSIVE_MARSHAL_WRITE_TRACE
1665   _dbus_verbose ("  type writer %p recurse parent %s type_pos = %d value_pos = %d is_expectation = %d remaining sig '%s' enabled = %d\n",
1666                  writer,
1667                  _dbus_type_to_string (writer->container_type),
1668                  writer->type_pos, writer->value_pos, writer->type_pos_is_expectation,
1669                  writer->type_str ?
1670                  _dbus_string_get_const_data_len (writer->type_str, writer->type_pos, 0) :
1671                  "unknown",
1672                  writer->enabled);
1673   _dbus_verbose ("  type writer %p recurse sub %s   type_pos = %d value_pos = %d is_expectation = %d enabled = %d\n",
1674                  sub,
1675                  _dbus_type_to_string (sub->container_type),
1676                  sub->type_pos, sub->value_pos,
1677                  sub->type_pos_is_expectation,
1678                  sub->enabled);
1679 #endif
1680 }
1681
1682 static dbus_bool_t
1683 write_or_verify_typecode (DBusTypeWriter *writer,
1684                           int             typecode)
1685 {
1686   /* A subwriter inside an array or variant will have type_pos
1687    * pointing to the expected typecode; a writer not inside an array
1688    * or variant has type_pos pointing to the next place to insert a
1689    * typecode.
1690    */
1691 #if RECURSIVE_MARSHAL_WRITE_TRACE
1692   _dbus_verbose ("  type writer %p write_or_verify start type_pos = %d remaining sig '%s' enabled = %d\n",
1693                  writer, writer->type_pos,
1694                  writer->type_str ?
1695                  _dbus_string_get_const_data_len (writer->type_str, writer->type_pos, 0) :
1696                  "unknown",
1697                  writer->enabled);
1698 #endif
1699
1700   if (writer->type_str == NULL)
1701     return TRUE;
1702
1703   if (writer->type_pos_is_expectation)
1704     {
1705 #ifndef DBUS_DISABLE_CHECKS
1706       {
1707         int expected;
1708
1709         expected = _dbus_string_get_byte (writer->type_str, writer->type_pos);
1710
1711         if (expected != typecode)
1712           {
1713             _dbus_warn ("Array or variant type requires that type %s be written, but %s was written\n",
1714                         _dbus_type_to_string (expected), _dbus_type_to_string (typecode));
1715             _dbus_assert_not_reached ("bad type inserted somewhere inside an array or variant");
1716           }
1717       }
1718 #endif /* DBUS_DISABLE_CHECKS */
1719
1720       /* if immediately inside an array we'd always be appending an element,
1721        * so the expected type doesn't change; if inside a struct or something
1722        * below an array, we need to move through said struct or something.
1723        */
1724       if (writer->container_type != DBUS_TYPE_ARRAY)
1725         writer->type_pos += 1;
1726     }
1727   else
1728     {
1729       if (!_dbus_string_insert_byte (writer->type_str,
1730                                      writer->type_pos,
1731                                      typecode))
1732         return FALSE;
1733
1734       writer->type_pos += 1;
1735     }
1736
1737 #if RECURSIVE_MARSHAL_WRITE_TRACE
1738   _dbus_verbose ("  type writer %p write_or_verify end type_pos = %d remaining sig '%s'\n",
1739                  writer, writer->type_pos,
1740                  _dbus_string_get_const_data_len (writer->type_str, writer->type_pos, 0));
1741 #endif
1742
1743   return TRUE;
1744 }
1745
1746 static dbus_bool_t
1747 writer_recurse_struct (DBusTypeWriter   *writer,
1748                        const DBusString *contained_type,
1749                        int               contained_type_start,
1750                        int               contained_type_len,
1751                        DBusTypeWriter   *sub)
1752 {
1753   /* FIXME right now contained_type is ignored; we could probably
1754    * almost trivially fix the code so if it's present we
1755    * write it out and then set type_pos_is_expectation
1756    */
1757
1758   /* Ensure that we'll be able to add alignment padding and the typecode */
1759   if (writer->enabled)
1760     {
1761       if (!_dbus_string_alloc_space (sub->value_str, 8))
1762         return FALSE;
1763     }
1764
1765   if (!write_or_verify_typecode (sub, DBUS_STRUCT_BEGIN_CHAR))
1766     _dbus_assert_not_reached ("failed to insert struct typecode after prealloc");
1767
1768   if (writer->enabled)
1769     {
1770       if (!_dbus_string_insert_bytes (sub->value_str,
1771                                       sub->value_pos,
1772                                       _DBUS_ALIGN_VALUE (sub->value_pos, 8) - sub->value_pos,
1773                                       '\0'))
1774         _dbus_assert_not_reached ("should not have failed to insert alignment padding for struct");
1775       sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 8);
1776     }
1777
1778   return TRUE;
1779 }
1780
1781
1782 static dbus_bool_t
1783 writer_recurse_array (DBusTypeWriter   *writer,
1784                       const DBusString *contained_type,
1785                       int               contained_type_start,
1786                       int               contained_type_len,
1787                       DBusTypeWriter   *sub,
1788                       dbus_bool_t       is_array_append)
1789 {
1790   dbus_uint32_t value = 0;
1791   int alignment;
1792   int aligned;
1793
1794 #ifndef DBUS_DISABLE_CHECKS
1795   if (writer->container_type == DBUS_TYPE_ARRAY &&
1796       writer->type_str)
1797     {
1798       if (!_dbus_string_equal_substring (contained_type,
1799                                          contained_type_start,
1800                                          contained_type_len,
1801                                          writer->type_str,
1802                                          writer->u.array.element_type_pos + 1))
1803         {
1804           _dbus_warn ("Writing an array of '%s' but this is incompatible with the expected type of elements in the parent array\n",
1805                       _dbus_string_get_const_data_len (contained_type,
1806                                                        contained_type_start,
1807                                                        contained_type_len));
1808           _dbus_assert_not_reached ("incompatible type for child array");
1809         }
1810     }
1811 #endif /* DBUS_DISABLE_CHECKS */
1812
1813   if (writer->enabled && !is_array_append)
1814     {
1815       /* 3 pad + 4 bytes for the array length, and 4 bytes possible padding
1816        * before array values
1817        */
1818       if (!_dbus_string_alloc_space (sub->value_str, 3 + 4 + 4))
1819         return FALSE;
1820     }
1821
1822   if (writer->type_str != NULL)
1823     {
1824       sub->type_pos += 1; /* move to point to the element type, since type_pos
1825                            * should be the expected type for further writes
1826                            */
1827       sub->u.array.element_type_pos = sub->type_pos;
1828     }
1829
1830   if (!writer->type_pos_is_expectation)
1831     {
1832       /* sub is a toplevel/outermost array so we need to write the type data */
1833
1834       /* alloc space for array typecode, element signature */
1835       if (!_dbus_string_alloc_space (writer->type_str, 1 + contained_type_len))
1836         return FALSE;
1837
1838       if (!_dbus_string_insert_byte (writer->type_str,
1839                                      writer->type_pos,
1840                                      DBUS_TYPE_ARRAY))
1841         _dbus_assert_not_reached ("failed to insert array typecode after prealloc");
1842
1843       if (!_dbus_string_copy_len (contained_type,
1844                                   contained_type_start, contained_type_len,
1845                                   sub->type_str,
1846                                   sub->u.array.element_type_pos))
1847         _dbus_assert_not_reached ("should not have failed to insert array element typecodes");
1848     }
1849
1850   if (writer->type_str != NULL)
1851     {
1852       /* If the parent is an array, we hold type_pos pointing at the array element type;
1853        * otherwise advance it to reflect the array value we just recursed into
1854        */
1855       if (writer->container_type != DBUS_TYPE_ARRAY)
1856         writer->type_pos += 1 + contained_type_len;
1857       else
1858         _dbus_assert (writer->type_pos_is_expectation); /* because it's an array */
1859     }
1860
1861   if (writer->enabled)
1862     {
1863       /* Write (or jump over, if is_array_append) the length */
1864       sub->u.array.len_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 4);
1865
1866       if (is_array_append)
1867         {
1868           sub->value_pos += 4;
1869         }
1870       else
1871         {
1872           if (!_dbus_type_writer_write_basic_no_typecode (sub, DBUS_TYPE_UINT32,
1873                                                           &value))
1874             _dbus_assert_not_reached ("should not have failed to insert array len");
1875         }
1876
1877       _dbus_assert (sub->u.array.len_pos == sub->value_pos - 4);
1878
1879       /* Write alignment padding for array elements
1880        * Note that we write the padding *even for empty arrays*
1881        * to avoid wonky special cases
1882        */
1883       alignment = element_type_get_alignment (contained_type, contained_type_start);
1884
1885       aligned = _DBUS_ALIGN_VALUE (sub->value_pos, alignment);
1886       if (aligned != sub->value_pos)
1887         {
1888           if (!is_array_append)
1889             {
1890               if (!_dbus_string_insert_bytes (sub->value_str,
1891                                               sub->value_pos,
1892                                               aligned - sub->value_pos,
1893                                               '\0'))
1894                 _dbus_assert_not_reached ("should not have failed to insert alignment padding");
1895             }
1896
1897           sub->value_pos = aligned;
1898         }
1899
1900       sub->u.array.start_pos = sub->value_pos;
1901
1902       if (is_array_append)
1903         {
1904           dbus_uint32_t len;
1905
1906           _dbus_assert (_DBUS_ALIGN_VALUE (sub->u.array.len_pos, 4) ==
1907                         (unsigned) sub->u.array.len_pos);
1908           len = _dbus_unpack_uint32 (sub->byte_order,
1909                                      _dbus_string_get_const_data_len (sub->value_str,
1910                                                                       sub->u.array.len_pos,
1911                                                                       4));
1912
1913           sub->value_pos += len;
1914         }
1915     }
1916   else
1917     {
1918       /* not enabled, so we won't write the len_pos; set it to -1 to so indicate */
1919       sub->u.array.len_pos = -1;
1920       sub->u.array.start_pos = sub->value_pos;
1921     }
1922
1923   _dbus_assert (sub->u.array.len_pos < sub->u.array.start_pos);
1924   _dbus_assert (is_array_append || sub->u.array.start_pos == sub->value_pos);
1925
1926 #if RECURSIVE_MARSHAL_WRITE_TRACE
1927       _dbus_verbose ("  type writer %p recurse array done remaining sig '%s' array start_pos = %d len_pos = %d value_pos = %d\n", sub,
1928                      sub->type_str ?
1929                      _dbus_string_get_const_data_len (sub->type_str, sub->type_pos, 0) :
1930                      "unknown",
1931                      sub->u.array.start_pos, sub->u.array.len_pos, sub->value_pos);
1932 #endif
1933
1934   return TRUE;
1935 }
1936
1937 /* Variant value will normally have:
1938  *   1 byte signature length not including nul
1939  *   signature typecodes (nul terminated)
1940  *   padding to 8-boundary
1941  *   body according to signature
1942  *
1943  * The signature string can only have a single type
1944  * in it but that type may be complex/recursive.
1945  *
1946  * So a typical variant type with the integer 3 will have these
1947  * octets:
1948  *   0x1 'i' '\0' [padding to 8-boundary] 0x0 0x0 0x0 0x3
1949  *
1950  * For an array of 4-byte types stuffed into variants, the padding to
1951  * 8-boundary is only the 1 byte that is required for the 4-boundary
1952  * anyhow for all array elements after the first one. And for single
1953  * variants in isolation, wasting a few bytes is hardly a big deal.
1954  *
1955  * The main world of hurt for writing out a variant is that the type
1956  * string is the same string as the value string. Which means
1957  * inserting to the type string will move the value_pos; and it means
1958  * that inserting to the type string could break type alignment.
1959  *
1960  * This type alignment issue is why the body of the variant is always
1961  * 8-aligned. Then we know that re-8-aligning the start of the body
1962  * will always correctly align the full contents of the variant type.
1963  */
1964 static dbus_bool_t
1965 writer_recurse_variant (DBusTypeWriter   *writer,
1966                         const DBusString *contained_type,
1967                         int               contained_type_start,
1968                         int               contained_type_len,
1969                         DBusTypeWriter   *sub)
1970 {
1971   if (writer->enabled)
1972     {
1973       /* Allocate space for the worst case, which is 1 byte sig
1974        * length, nul byte at end of sig, and 7 bytes padding to
1975        * 8-boundary.
1976        */
1977       if (!_dbus_string_alloc_space (sub->value_str, contained_type_len + 9))
1978         return FALSE;
1979     }
1980
1981   /* write VARIANT typecode to the parent's type string */
1982   if (!write_or_verify_typecode (writer, DBUS_TYPE_VARIANT))
1983     return FALSE;
1984
1985   /* If not enabled, mark that we have no type_str anymore ... */
1986
1987   if (!writer->enabled)
1988     {
1989       sub->type_str = NULL;
1990       sub->type_pos = -1;
1991
1992       return TRUE;
1993     }
1994
1995   /* If we're enabled then continue ... */
1996
1997   if (!_dbus_string_insert_byte (sub->value_str,
1998                                  sub->value_pos,
1999                                  contained_type_len))
2000     _dbus_assert_not_reached ("should not have failed to insert variant type sig len");
2001
2002   sub->value_pos += 1;
2003
2004   /* Here we switch over to the expected type sig we're about to write */
2005   sub->type_str = sub->value_str;
2006   sub->type_pos = sub->value_pos;
2007
2008   if (!_dbus_string_copy_len (contained_type, contained_type_start, contained_type_len,
2009                               sub->value_str, sub->value_pos))
2010     _dbus_assert_not_reached ("should not have failed to insert variant type sig");
2011
2012   sub->value_pos += contained_type_len;
2013
2014   if (!_dbus_string_insert_byte (sub->value_str,
2015                                  sub->value_pos,
2016                                  DBUS_TYPE_INVALID))
2017     _dbus_assert_not_reached ("should not have failed to insert variant type nul termination");
2018
2019   sub->value_pos += 1;
2020
2021   if (!_dbus_string_insert_bytes (sub->value_str,
2022                                   sub->value_pos,
2023                                   _DBUS_ALIGN_VALUE (sub->value_pos, 8) - sub->value_pos,
2024                                   '\0'))
2025     _dbus_assert_not_reached ("should not have failed to insert alignment padding for variant body");
2026   sub->value_pos = _DBUS_ALIGN_VALUE (sub->value_pos, 8);
2027
2028   return TRUE;
2029 }
2030
2031 static dbus_bool_t
2032 _dbus_type_writer_recurse_contained_len (DBusTypeWriter   *writer,
2033                                          int               container_type,
2034                                          const DBusString *contained_type,
2035                                          int               contained_type_start,
2036                                          int               contained_type_len,
2037                                          DBusTypeWriter   *sub,
2038                                          dbus_bool_t       is_array_append)
2039 {
2040   writer_recurse_init_and_check (writer, container_type, sub);
2041
2042   switch (container_type)
2043     {
2044     case DBUS_TYPE_STRUCT:
2045       return writer_recurse_struct (writer,
2046                                     contained_type, contained_type_start, contained_type_len,
2047                                     sub);
2048       break;
2049     case DBUS_TYPE_ARRAY:
2050       return writer_recurse_array (writer,
2051                                    contained_type, contained_type_start, contained_type_len,
2052                                    sub, is_array_append);
2053       break;
2054     case DBUS_TYPE_VARIANT:
2055       return writer_recurse_variant (writer,
2056                                      contained_type, contained_type_start, contained_type_len,
2057                                      sub);
2058       break;
2059     default:
2060       _dbus_assert_not_reached ("tried to recurse into type that doesn't support that");
2061       return FALSE;
2062       break;
2063     }
2064 }
2065
2066 /**
2067  * Opens a new container and writes out the initial information for that container.
2068  *
2069  * @param writer the writer
2070  * @param container_type the type of the container to open
2071  * @param contained_type the array element type or variant content type
2072  * @param contained_type_start position to look for the type
2073  * @param sub the new sub-writer to write container contents
2074  * @returns #FALSE if no memory
2075  */
2076 dbus_bool_t
2077 _dbus_type_writer_recurse (DBusTypeWriter   *writer,
2078                            int               container_type,
2079                            const DBusString *contained_type,
2080                            int               contained_type_start,
2081                            DBusTypeWriter   *sub)
2082 {
2083   int contained_type_len;
2084
2085   if (contained_type)
2086     contained_type_len = find_len_of_complete_type (contained_type, contained_type_start);
2087   else
2088     contained_type_len = 0;
2089
2090   return _dbus_type_writer_recurse_contained_len (writer, container_type,
2091                                                   contained_type,
2092                                                   contained_type_start,
2093                                                   contained_type_len,
2094                                                   sub,
2095                                                   FALSE);
2096 }
2097
2098 /**
2099  * Append to an existing array. Essentially, the writer will read an
2100  * existing length at the write location; jump over that length; and
2101  * write new fields. On unrecurse(), the existing length will be
2102  * updated.
2103  *
2104  * @param writer the writer
2105  * @param contained_type element type
2106  * @param contained_type_start position of element type
2107  * @param sub the subwriter to init
2108  * @returns #FALSE if no memory
2109  */
2110 dbus_bool_t
2111 _dbus_type_writer_append_array (DBusTypeWriter   *writer,
2112                                 const DBusString *contained_type,
2113                                 int               contained_type_start,
2114                                 DBusTypeWriter   *sub)
2115 {
2116   int contained_type_len;
2117
2118   if (contained_type)
2119     contained_type_len = find_len_of_complete_type (contained_type, contained_type_start);
2120   else
2121     contained_type_len = 0;
2122
2123   return _dbus_type_writer_recurse_contained_len (writer, DBUS_TYPE_ARRAY,
2124                                                   contained_type,
2125                                                   contained_type_start,
2126                                                   contained_type_len,
2127                                                   sub,
2128                                                   TRUE);
2129 }
2130
2131 static int
2132 writer_get_array_len (DBusTypeWriter *writer)
2133 {
2134   _dbus_assert (writer->container_type == DBUS_TYPE_ARRAY);
2135   return writer->value_pos - writer->u.array.start_pos;
2136 }
2137
2138 /**
2139  * Closes a container created by _dbus_type_writer_recurse()
2140  * and writes any additional information to the values block.
2141  *
2142  * @param writer the writer
2143  * @param sub the sub-writer created by _dbus_type_writer_recurse()
2144  * @returns #FALSE if no memory
2145  */
2146 dbus_bool_t
2147 _dbus_type_writer_unrecurse (DBusTypeWriter *writer,
2148                              DBusTypeWriter *sub)
2149 {
2150   /* type_pos_is_expectation never gets unset once set, or we'd get all hosed */
2151   _dbus_assert (!writer->type_pos_is_expectation ||
2152                 (writer->type_pos_is_expectation && sub->type_pos_is_expectation));
2153
2154 #if RECURSIVE_MARSHAL_WRITE_TRACE
2155   _dbus_verbose ("  type writer %p unrecurse type_pos = %d value_pos = %d is_expectation = %d container_type = %s\n",
2156                  writer, writer->type_pos, writer->value_pos, writer->type_pos_is_expectation,
2157                  _dbus_type_to_string (writer->container_type));
2158   _dbus_verbose ("  type writer %p unrecurse sub type_pos = %d value_pos = %d is_expectation = %d container_type = %s\n",
2159                  sub, sub->type_pos, sub->value_pos,
2160                  sub->type_pos_is_expectation,
2161                  _dbus_type_to_string (sub->container_type));
2162 #endif
2163
2164   if (sub->container_type == DBUS_TYPE_STRUCT)
2165     {
2166       if (!write_or_verify_typecode (sub, DBUS_STRUCT_END_CHAR))
2167         return FALSE;
2168     }
2169   else if (sub->container_type == DBUS_TYPE_ARRAY)
2170     {
2171       if (sub->u.array.len_pos >= 0) /* len_pos == -1 if we weren't enabled when we passed it */
2172         {
2173           dbus_uint32_t len;
2174
2175           /* Set the array length */
2176           len = writer_get_array_len (sub);
2177           _dbus_marshal_set_uint32 (sub->value_str,
2178                                     sub->u.array.len_pos,
2179                                     len,
2180                                     sub->byte_order);
2181 #if RECURSIVE_MARSHAL_WRITE_TRACE
2182           _dbus_verbose ("    filled in sub array len to %u at len_pos %d\n",
2183                          len, sub->u.array.len_pos);
2184 #endif
2185         }
2186 #if RECURSIVE_MARSHAL_WRITE_TRACE
2187       else
2188         {
2189           _dbus_verbose ("    not filling in sub array len because we were disabled when we passed the len\n");
2190         }
2191 #endif
2192     }
2193
2194   /* Now get type_pos right for the parent writer. Here are the cases:
2195    *
2196    * Cases !writer->type_pos_is_expectation:
2197    *   (in these cases we want to update to the new insertion point)
2198    *
2199    * - if we recursed into a STRUCT then we didn't know in advance
2200    *   what the types in the struct would be; so we have to fill in
2201    *   that information now.
2202    *       writer->type_pos = sub->type_pos
2203    *
2204    * - if we recursed into anything else, we knew the full array
2205    *   type, or knew the single typecode marking VARIANT, so
2206    *   writer->type_pos is already correct.
2207    *       writer->type_pos should remain as-is
2208    *
2209    * - note that the parent is never an ARRAY or VARIANT, if it were
2210    *   then type_pos_is_expectation would be TRUE. The parent
2211    *   is thus known to be a toplevel or STRUCT.
2212    *
2213    * Cases where writer->type_pos_is_expectation:
2214    *   (in these cases we want to update to next expected type to write)
2215    *
2216    * - we recursed from STRUCT into STRUCT and we didn't increment
2217    *   type_pos in the parent just to stay consistent with the
2218    *   !writer->type_pos_is_expectation case (though we could
2219    *   special-case this in recurse_struct instead if we wanted)
2220    *       writer->type_pos = sub->type_pos
2221    *
2222    * - we recursed from STRUCT into ARRAY or VARIANT and type_pos
2223    *   for parent should have been incremented already
2224    *       writer->type_pos should remain as-is
2225    *
2226    * - we recursed from ARRAY into a sub-element, so type_pos in the
2227    *   parent is the element type and should remain the element type
2228    *   for the benefit of the next child element
2229    *       writer->type_pos should remain as-is
2230    *
2231    * - we recursed from VARIANT into its value, so type_pos in the
2232    *   parent makes no difference since there's only one value
2233    *   and we just finished writing it and won't use type_pos again
2234    *       writer->type_pos should remain as-is
2235    */
2236   if (writer->type_str != NULL)
2237     {
2238       if (sub->container_type == DBUS_TYPE_STRUCT &&
2239           (writer->container_type == DBUS_TYPE_STRUCT ||
2240            writer->container_type == DBUS_TYPE_INVALID))
2241         {
2242           /* Advance the parent to the next struct field */
2243           writer->type_pos = sub->type_pos;
2244         }
2245     }
2246
2247   writer->value_pos = sub->value_pos;
2248
2249 #if RECURSIVE_MARSHAL_WRITE_TRACE
2250   _dbus_verbose ("  type writer %p unrecursed type_pos = %d value_pos = %d remaining sig '%s'\n",
2251                  writer, writer->type_pos, writer->value_pos,
2252                  writer->type_str ?
2253                  _dbus_string_get_const_data_len (writer->type_str, writer->type_pos, 0) :
2254                  "unknown");
2255 #endif
2256
2257   return TRUE;
2258 }
2259
2260 /**
2261  * Writes out a basic type.
2262  *
2263  * @param writer the writer
2264  * @param type the type to write
2265  * @param value the address of the value to write
2266  * @returns #FALSE if no memory
2267  */
2268 dbus_bool_t
2269 _dbus_type_writer_write_basic (DBusTypeWriter *writer,
2270                                int             type,
2271                                const void     *value)
2272 {
2273   dbus_bool_t retval;
2274
2275   /* First ensure that our type realloc will succeed */
2276   if (!writer->type_pos_is_expectation && writer->type_str != NULL)
2277     {
2278       if (!_dbus_string_alloc_space (writer->type_str, 1))
2279         return FALSE;
2280     }
2281
2282   retval = FALSE;
2283
2284   if (!_dbus_type_writer_write_basic_no_typecode (writer, type, value))
2285     goto out;
2286
2287   if (!write_or_verify_typecode (writer, type))
2288     _dbus_assert_not_reached ("failed to write typecode after prealloc");
2289
2290   retval = TRUE;
2291
2292  out:
2293 #if RECURSIVE_MARSHAL_WRITE_TRACE
2294   _dbus_verbose ("  type writer %p basic type_pos = %d value_pos = %d is_expectation = %d enabled = %d\n",
2295                  writer, writer->type_pos, writer->value_pos, writer->type_pos_is_expectation,
2296                  writer->enabled);
2297 #endif
2298
2299   return retval;
2300 }
2301
2302 /**
2303  * Writes a block of fixed-length basic values, i.e. those that are
2304  * both _dbus_type_is_fixed() and _dbus_type_is_basic(). The block
2305  * must be written inside an array.
2306  *
2307  * The value parameter should be the address of said array of values,
2308  * so e.g. if it's an array of double, pass in "const double**"
2309  *
2310  * @param writer the writer
2311  * @param element_type type of stuff in the array
2312  * @param value address of the array
2313  * @param n_elements number of elements in the array
2314  * @returns #FALSE if no memory
2315  */
2316 dbus_bool_t
2317 _dbus_type_writer_write_fixed_multi (DBusTypeWriter        *writer,
2318                                      int                    element_type,
2319                                      const void            *value,
2320                                      int                    n_elements)
2321 {
2322   _dbus_assert (writer->container_type == DBUS_TYPE_ARRAY);
2323   _dbus_assert (_dbus_type_is_fixed (element_type));
2324   _dbus_assert (writer->type_pos_is_expectation);
2325   _dbus_assert (n_elements >= 0);
2326
2327 #if RECURSIVE_MARSHAL_WRITE_TRACE
2328   _dbus_verbose ("  type writer %p entering fixed multi type_pos = %d value_pos = %d n_elements %d\n",
2329                  writer, writer->type_pos, writer->value_pos, n_elements);
2330 #endif
2331
2332   if (!write_or_verify_typecode (writer, element_type))
2333     _dbus_assert_not_reached ("OOM should not happen if only verifying typecode");
2334
2335   if (writer->enabled)
2336     {
2337       if (!_dbus_marshal_write_fixed_multi (writer->value_str,
2338                                             writer->value_pos,
2339                                             element_type,
2340                                             value,
2341                                             n_elements,
2342                                             writer->byte_order,
2343                                             &writer->value_pos))
2344         return FALSE;
2345     }
2346
2347 #if RECURSIVE_MARSHAL_WRITE_TRACE
2348   _dbus_verbose ("  type writer %p fixed multi written new type_pos = %d new value_pos = %d n_elements %d\n",
2349                  writer, writer->type_pos, writer->value_pos, n_elements);
2350 #endif
2351
2352   return TRUE;
2353 }
2354
2355 static void
2356 enable_if_after (DBusTypeWriter       *writer,
2357                  DBusTypeReader       *reader,
2358                  const DBusTypeReader *start_after)
2359 {
2360   if (start_after)
2361     {
2362       if (!writer->enabled && _dbus_type_reader_greater_than (reader, start_after))
2363         {
2364           _dbus_type_writer_set_enabled (writer, TRUE);
2365 #if RECURSIVE_MARSHAL_WRITE_TRACE
2366           _dbus_verbose ("ENABLING writer %p at %d because reader at value_pos %d is after reader at value_pos %d\n",
2367                          writer, writer->value_pos, reader->value_pos, start_after->value_pos);
2368 #endif
2369         }
2370
2371       _dbus_assert ((!writer->enabled && !_dbus_type_reader_greater_than (reader, start_after)) ||
2372                     (writer->enabled && _dbus_type_reader_greater_than (reader, start_after)));
2373     }
2374 }
2375
2376 static dbus_bool_t
2377 append_fixup (DBusList               **fixups,
2378               const DBusArrayLenFixup *fixup)
2379 {
2380   DBusArrayLenFixup *f;
2381
2382   f = dbus_new (DBusArrayLenFixup, 1);
2383   if (f == NULL)
2384     return FALSE;
2385
2386   *f = *fixup;
2387
2388   if (!_dbus_list_append (fixups, f))
2389     {
2390       dbus_free (f);
2391       return FALSE;
2392     }
2393
2394   _dbus_assert (f->len_pos_in_reader == fixup->len_pos_in_reader);
2395   _dbus_assert (f->new_len == fixup->new_len);
2396
2397   return TRUE;
2398 }
2399
2400 /* This loop is trivial if you ignore all the start_after nonsense,
2401  * so if you're trying to figure it out, start by ignoring that
2402  */
2403 static dbus_bool_t
2404 writer_write_reader_helper (DBusTypeWriter       *writer,
2405                             DBusTypeReader       *reader,
2406                             const DBusTypeReader *start_after,
2407                             int                   start_after_new_pos,
2408                             int                   start_after_new_len,
2409                             DBusList            **fixups,
2410                             dbus_bool_t           inside_start_after)
2411 {
2412   int current_type;
2413
2414   while ((current_type = _dbus_type_reader_get_current_type (reader)) != DBUS_TYPE_INVALID)
2415     {
2416       if (_dbus_type_is_container (current_type))
2417         {
2418           DBusTypeReader subreader;
2419           DBusTypeWriter subwriter;
2420           const DBusString *sig_str;
2421           int sig_start;
2422           int sig_len;
2423           dbus_bool_t enabled_at_recurse;
2424           dbus_bool_t past_start_after;
2425           int reader_array_len_pos;
2426           int reader_array_start_pos;
2427           dbus_bool_t this_is_start_after;
2428
2429           /* type_pos is checked since e.g. in a struct the struct
2430            * and its first field have the same value_pos.
2431            * type_str will differ in reader/start_after for variants
2432            * where type_str is inside the value_str
2433            */
2434           if (!inside_start_after && start_after &&
2435               reader->value_pos == start_after->value_pos &&
2436               reader->type_str == start_after->type_str &&
2437               reader->type_pos == start_after->type_pos)
2438             this_is_start_after = TRUE;
2439           else
2440             this_is_start_after = FALSE;
2441
2442           _dbus_type_reader_recurse (reader, &subreader);
2443
2444           if (current_type == DBUS_TYPE_ARRAY)
2445             {
2446               reader_array_len_pos = ARRAY_READER_LEN_POS (&subreader);
2447               reader_array_start_pos = subreader.u.array.start_pos;
2448             }
2449           else
2450             {
2451               /* quiet gcc */
2452               reader_array_len_pos = -1;
2453               reader_array_start_pos = -1;
2454             }
2455
2456           _dbus_type_reader_get_signature (&subreader, &sig_str,
2457                                            &sig_start, &sig_len);
2458
2459 #if RECURSIVE_MARSHAL_WRITE_TRACE
2460           _dbus_verbose ("about to recurse into %s reader at %d subreader at %d writer at %d start_after reader at %d write target len %d inside_start_after = %d this_is_start_after = %d\n",
2461                          _dbus_type_to_string (current_type),
2462                          reader->value_pos,
2463                          subreader.value_pos,
2464                          writer->value_pos,
2465                          start_after ? start_after->value_pos : -1,
2466                          _dbus_string_get_length (writer->value_str),
2467                          inside_start_after, this_is_start_after);
2468 #endif
2469
2470           if (!inside_start_after && !this_is_start_after)
2471             enable_if_after (writer, &subreader, start_after);
2472           enabled_at_recurse = writer->enabled;
2473           if (!_dbus_type_writer_recurse_contained_len (writer, current_type,
2474                                                         sig_str, sig_start, sig_len,
2475                                                         &subwriter, FALSE))
2476             goto oom;
2477
2478 #if RECURSIVE_MARSHAL_WRITE_TRACE
2479           _dbus_verbose ("recursed into subwriter at %d write target len %d\n",
2480                          subwriter.value_pos,
2481                          _dbus_string_get_length (subwriter.value_str));
2482 #endif
2483
2484           if (!writer_write_reader_helper (&subwriter, &subreader, start_after,
2485                                            start_after_new_pos, start_after_new_len,
2486                                            fixups,
2487                                            inside_start_after ||
2488                                            this_is_start_after))
2489             goto oom;
2490
2491 #if RECURSIVE_MARSHAL_WRITE_TRACE
2492           _dbus_verbose ("about to unrecurse from %s subreader at %d writer at %d subwriter at %d  write target len %d\n",
2493                          _dbus_type_to_string (current_type),
2494                          subreader.value_pos,
2495                          writer->value_pos,
2496                          subwriter.value_pos,
2497                          _dbus_string_get_length (writer->value_str));
2498 #endif
2499
2500           if (!inside_start_after && !this_is_start_after)
2501             enable_if_after (writer, &subreader, start_after);
2502           past_start_after = writer->enabled;
2503           if (!_dbus_type_writer_unrecurse (writer, &subwriter))
2504             goto oom;
2505
2506           /* If we weren't enabled when we recursed, we didn't
2507            * write an array len; if we passed start_after
2508            * somewhere inside the array, then we need to generate
2509            * a fixup.
2510            */
2511           if (start_after != NULL &&
2512               !enabled_at_recurse && past_start_after &&
2513               current_type == DBUS_TYPE_ARRAY &&
2514               fixups != NULL)
2515             {
2516               DBusArrayLenFixup fixup;
2517               int bytes_written_after_start_after;
2518               int bytes_before_start_after;
2519               int old_len;
2520
2521               /* this subwriter access is moderately unkosher since we
2522                * already unrecursed, but it works as long as unrecurse
2523                * doesn't break us on purpose
2524                */
2525               bytes_written_after_start_after = writer_get_array_len (&subwriter);
2526
2527               bytes_before_start_after =
2528                 start_after->value_pos - reader_array_start_pos;
2529
2530               fixup.len_pos_in_reader = reader_array_len_pos;
2531               fixup.new_len =
2532                 bytes_before_start_after +
2533                 start_after_new_len +
2534                 bytes_written_after_start_after;
2535
2536               _dbus_assert (_DBUS_ALIGN_VALUE (fixup.len_pos_in_reader, 4) ==
2537                             (unsigned) fixup.len_pos_in_reader);
2538
2539               old_len = _dbus_unpack_uint32 (reader->byte_order,
2540                                              _dbus_string_get_const_data_len (reader->value_str,
2541                                                                               fixup.len_pos_in_reader, 4));
2542
2543               if (old_len != fixup.new_len && !append_fixup (fixups, &fixup))
2544                 goto oom;
2545
2546 #if RECURSIVE_MARSHAL_WRITE_TRACE
2547               _dbus_verbose ("Generated fixup len_pos_in_reader = %d new_len = %d reader_array_start_pos = %d start_after->value_pos = %d bytes_before_start_after = %d start_after_new_len = %d bytes_written_after_start_after = %d\n",
2548                              fixup.len_pos_in_reader,
2549                              fixup.new_len,
2550                              reader_array_start_pos,
2551                              start_after->value_pos,
2552                              bytes_before_start_after,
2553                              start_after_new_len,
2554                              bytes_written_after_start_after);
2555 #endif
2556             }
2557         }
2558       else
2559         {
2560           DBusBasicValue val;
2561
2562           _dbus_assert (_dbus_type_is_basic (current_type));
2563
2564 #if RECURSIVE_MARSHAL_WRITE_TRACE
2565           _dbus_verbose ("Reading basic value %s at %d\n",
2566                          _dbus_type_to_string (current_type),
2567                          reader->value_pos);
2568 #endif
2569
2570           _dbus_type_reader_read_basic (reader, &val);
2571
2572 #if RECURSIVE_MARSHAL_WRITE_TRACE
2573           _dbus_verbose ("Writing basic value %s at %d write target len %d inside_start_after = %d\n",
2574                          _dbus_type_to_string (current_type),
2575                          writer->value_pos,
2576                          _dbus_string_get_length (writer->value_str),
2577                          inside_start_after);
2578 #endif
2579           if (!inside_start_after)
2580             enable_if_after (writer, reader, start_after);
2581           if (!_dbus_type_writer_write_basic (writer, current_type, &val))
2582             goto oom;
2583 #if RECURSIVE_MARSHAL_WRITE_TRACE
2584           _dbus_verbose ("Wrote basic value %s, new value_pos %d write target len %d\n",
2585                          _dbus_type_to_string (current_type),
2586                          writer->value_pos,
2587                          _dbus_string_get_length (writer->value_str));
2588 #endif
2589         }
2590
2591       _dbus_type_reader_next (reader);
2592     }
2593
2594   return TRUE;
2595
2596  oom:
2597   if (fixups)
2598     apply_and_free_fixups (fixups, NULL); /* NULL for reader to apply to */
2599
2600   return FALSE;
2601 }
2602
2603 /**
2604  * Iterate through all values in the given reader, writing a copy of
2605  * each value to the writer.  The reader will be moved forward to its
2606  * end position.
2607  *
2608  * If a reader start_after is provided, it should be a reader for the
2609  * same data as the reader to be written. Only values occurring after
2610  * the value pointed to by start_after will be written to the writer.
2611  *
2612  * If start_after is provided, then the copy of the reader will be
2613  * partial. This means that array lengths will not have been copied.
2614  * The assumption is that you wrote a new version of the value at
2615  * start_after to the writer. You have to pass in the start position
2616  * and length of the new value. (If you are deleting the value
2617  * at start_after, pass in 0 for the length.)
2618  *
2619  * If the fixups parameter is non-#NULL, then any array length that
2620  * was read but not written due to start_after will be provided
2621  * as a #DBusArrayLenFixup. The fixup contains the position of the
2622  * array length in the source data, and the correct array length
2623  * assuming you combine the source data before start_after with
2624  * the written data at start_after and beyond.
2625  *
2626  * @param writer the writer to copy to
2627  * @param reader the reader to copy from
2628  * @param start_after #NULL or a reader showing where to start
2629  * @param start_after_new_pos the position of start_after equivalent in the target data
2630  * @param start_after_new_len the length of start_after equivalent in the target data
2631  * @param fixups list to append #DBusArrayLenFixup if the write was partial
2632  * @returns #FALSE if no memory
2633  */
2634 dbus_bool_t
2635 _dbus_type_writer_write_reader_partial (DBusTypeWriter       *writer,
2636                                         DBusTypeReader       *reader,
2637                                         const DBusTypeReader *start_after,
2638                                         int                   start_after_new_pos,
2639                                         int                   start_after_new_len,
2640                                         DBusList            **fixups)
2641 {
2642   DBusTypeWriter orig;
2643   int orig_type_len;
2644   int orig_value_len;
2645   int new_bytes;
2646   int orig_enabled;
2647
2648   orig = *writer;
2649   orig_type_len = _dbus_string_get_length (writer->type_str);
2650   orig_value_len = _dbus_string_get_length (writer->value_str);
2651   orig_enabled = writer->enabled;
2652
2653   if (start_after)
2654     _dbus_type_writer_set_enabled (writer, FALSE);
2655
2656   if (!writer_write_reader_helper (writer, reader, start_after,
2657                                    start_after_new_pos,
2658                                    start_after_new_len,
2659                                    fixups, FALSE))
2660     goto oom;
2661
2662   _dbus_type_writer_set_enabled (writer, orig_enabled);
2663   return TRUE;
2664
2665  oom:
2666   if (!writer->type_pos_is_expectation)
2667     {
2668       new_bytes = _dbus_string_get_length (writer->type_str) - orig_type_len;
2669       _dbus_string_delete (writer->type_str, orig.type_pos, new_bytes);
2670     }
2671   new_bytes = _dbus_string_get_length (writer->value_str) - orig_value_len;
2672   _dbus_string_delete (writer->value_str, orig.value_pos, new_bytes);
2673
2674   *writer = orig;
2675
2676   return FALSE;
2677 }
2678
2679 /**
2680  * Iterate through all values in the given reader, writing a copy of
2681  * each value to the writer.  The reader will be moved forward to its
2682  * end position.
2683  *
2684  * @param writer the writer to copy to
2685  * @param reader the reader to copy from
2686  * @returns #FALSE if no memory
2687  */
2688 dbus_bool_t
2689 _dbus_type_writer_write_reader (DBusTypeWriter       *writer,
2690                                 DBusTypeReader       *reader)
2691 {
2692   return _dbus_type_writer_write_reader_partial (writer, reader, NULL, 0, 0, NULL);
2693 }
2694
2695 /**
2696  * If disabled, a writer can still be iterated forward and recursed/unrecursed
2697  * but won't write any values. Types will still be written unless the
2698  * writer is a "values only" writer, because the writer needs access to
2699  * a valid signature to be able to iterate.
2700  *
2701  * @param writer the type writer
2702  * @param enabled #TRUE if values should be written
2703  */
2704 void
2705 _dbus_type_writer_set_enabled (DBusTypeWriter   *writer,
2706                                dbus_bool_t       enabled)
2707 {
2708   writer->enabled = enabled != FALSE;
2709 }
2710
2711 /** @} */ /* end of DBusMarshal group */
2712
2713 /* tests in dbus-marshal-recursive-util.c */