1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-marshal-recursive.h Marshalling routines for recursive types
4 * Copyright (C) 2004 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
24 #ifndef DBUS_MARSHAL_RECURSIVE_H
25 #define DBUS_MARSHAL_RECURSIVE_H
28 #include <dbus/dbus-protocol.h>
29 #include <dbus/dbus-marshal-basic.h> /* this can vanish when we merge */
32 #error "config.h not included here"
35 /* Features we need to port dbus-message:
36 * - memoize a position of a reader for small/fast access later
37 * - delete an array element and re-align the remainder of the array
38 * (not necessary yet to re-align remainder of entire string,
39 * though that's probably just as hard/easy)
40 * (really this one is to set a complex-type array element to
41 * a new value, but for dbus-message.c delete-and-reappend would
43 * - set string, int, etc. values at a memoized position
44 * (implement generic set of any value? changes only
45 * value_str not type_str)
46 * - implement has_next()
47 * - the all-in-one-block array accessors
50 * - remember to try a HAVE_INT64=0 build at the end
53 typedef struct DBusTypeMark DBusTypeMark;
54 typedef struct DBusTypeReader DBusTypeReader;
55 typedef struct DBusTypeWriter DBusTypeWriter;
56 typedef struct DBusTypeReaderClass DBusTypeReaderClass;
58 /* The mark is a way to compress a TypeReader; it isn't all that
59 * successful though. The idea was to use this for caching header
60 * fields in dbus-message.c. However now I'm thinking why not cache
61 * the actual values (e.g. char*) and if the field needs to be set or
62 * deleted, just linear search for it. Those operations are uncommon,
63 * and getting the values should be fast and not involve all this type
68 dbus_uint32_t type_pos_in_value_str : 1;
69 dbus_uint32_t container_type : 3;
70 dbus_uint32_t array_len_offset : 3; /* bytes back from start_pos that len ends */
71 dbus_uint32_t type_pos : DBUS_MAXIMUM_MESSAGE_LENGTH_BITS;
72 dbus_uint32_t value_pos : DBUS_MAXIMUM_MESSAGE_LENGTH_BITS;
73 dbus_uint32_t array_start_pos : DBUS_MAXIMUM_MESSAGE_LENGTH_BITS;
78 dbus_uint32_t byte_order : 8;
80 dbus_uint32_t finished : 1; /* marks we're at end iterator for cases
81 * where we don't have another way to tell
83 dbus_uint32_t array_len_offset : 3; /* bytes back from start_pos that len ends */
84 const DBusString *type_str;
86 const DBusString *value_str;
89 const DBusTypeReaderClass *klass;
100 dbus_uint32_t byte_order : 8;
102 dbus_uint32_t container_type : 8;
104 dbus_uint32_t type_pos_is_expectation : 1; /* type_pos is an insertion point or an expected next type */
105 DBusString *type_str;
107 DBusString *value_str;
113 int start_pos; /* first element */
115 int element_type_pos; /* position of array element type in type_str */
120 void _dbus_type_reader_init (DBusTypeReader *reader,
122 const DBusString *type_str,
124 const DBusString *value_str,
126 void _dbus_type_reader_init_from_mark (DBusTypeReader *reader,
128 const DBusString *type_str,
129 const DBusString *value_str,
130 const DBusTypeMark *mark);
131 void _dbus_type_reader_init_types_only (DBusTypeReader *reader,
132 const DBusString *type_str,
134 void _dbus_type_reader_init_types_only_from_mark (DBusTypeReader *reader,
135 const DBusString *type_str,
136 const DBusTypeMark *mark);
137 void _dbus_type_reader_save_mark (const DBusTypeReader *reader,
139 int _dbus_type_reader_get_current_type (const DBusTypeReader *reader);
140 dbus_bool_t _dbus_type_reader_array_is_empty (const DBusTypeReader *reader);
141 void _dbus_type_reader_read_basic (const DBusTypeReader *reader,
143 dbus_bool_t _dbus_type_reader_read_array_of_basic (const DBusTypeReader *reader,
147 void _dbus_type_reader_recurse (DBusTypeReader *reader,
148 DBusTypeReader *subreader);
149 dbus_bool_t _dbus_type_reader_next (DBusTypeReader *reader);
150 dbus_bool_t _dbus_type_reader_has_next (const DBusTypeReader *reader);
151 void _dbus_type_reader_get_signature (const DBusTypeReader *reader,
152 const DBusString **str_p,
155 dbus_bool_t _dbus_type_reader_set_basic (DBusTypeReader *reader,
158 void _dbus_type_writer_init (DBusTypeWriter *writer,
160 DBusString *type_str,
162 DBusString *value_str,
164 dbus_bool_t _dbus_type_writer_write_basic (DBusTypeWriter *writer,
167 dbus_bool_t _dbus_type_writer_write_array (DBusTypeWriter *writer,
171 dbus_bool_t _dbus_type_writer_recurse (DBusTypeWriter *writer,
173 const DBusString *contained_type,
174 int contained_type_start,
175 DBusTypeWriter *sub);
176 dbus_bool_t _dbus_type_writer_unrecurse (DBusTypeWriter *writer,
177 DBusTypeWriter *sub);
178 dbus_bool_t _dbus_type_writer_write_reader (DBusTypeWriter *writer,
179 DBusTypeReader *reader);
181 #endif /* DBUS_MARSHAL_RECURSIVE_H */