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-marshal-basic.h> /* this can become protocol.h when we merge */
31 #error "config.h not included here"
34 /* Features we need to port dbus-message:
35 * - memoize a position of a reader for small/fast access later
36 * - delete an array element and re-align the remainder of the array
37 * (not necessary yet to re-align remainder of entire string,
38 * though that's probably just as hard/easy)
39 * - set string, int, etc. values at a memoized position
40 * (implement generic set of any value? changes only
41 * value_str not type_str)
42 * - implement has_next()
43 * - the all-in-one-block array accessors
47 typedef struct DBusTypeReader DBusTypeReader;
48 typedef struct DBusTypeWriter DBusTypeWriter;
49 typedef struct DBusTypeReaderClass DBusTypeReaderClass;
53 dbus_uint32_t byte_order : 8;
55 dbus_uint32_t finished : 1; /* marks we're at end iterator for cases
56 * where we don't have another way to tell
58 const DBusString *type_str;
60 const DBusString *value_str;
63 const DBusTypeReaderClass *klass;
76 dbus_uint32_t byte_order : 8;
78 dbus_uint32_t container_type : 8;
80 dbus_uint32_t type_pos_is_expectation : 1; /* type_pos is an insertion point or an expected next type */
83 DBusString *value_str;
89 int start_pos; /* first element */
91 int element_type_pos; /* position of array element type in type_str */
96 void _dbus_type_reader_init (DBusTypeReader *reader,
98 const DBusString *type_str,
100 const DBusString *value_str,
102 void _dbus_type_reader_init_types_only (DBusTypeReader *reader,
103 const DBusString *type_str,
105 int _dbus_type_reader_get_current_type (DBusTypeReader *reader);
106 dbus_bool_t _dbus_type_reader_array_is_empty (DBusTypeReader *reader);
107 void _dbus_type_reader_read_basic (DBusTypeReader *reader,
109 dbus_bool_t _dbus_type_reader_read_array_of_basic (DBusTypeReader *reader,
113 void _dbus_type_reader_recurse (DBusTypeReader *reader,
114 DBusTypeReader *subreader);
115 dbus_bool_t _dbus_type_reader_next (DBusTypeReader *reader);
117 void _dbus_type_writer_init (DBusTypeWriter *writer,
119 DBusString *type_str,
121 DBusString *value_str,
123 dbus_bool_t _dbus_type_writer_write_basic (DBusTypeWriter *writer,
126 dbus_bool_t _dbus_type_writer_write_array (DBusTypeWriter *writer,
130 dbus_bool_t _dbus_type_writer_recurse_struct (DBusTypeWriter *writer,
131 DBusTypeWriter *sub);
132 dbus_bool_t _dbus_type_writer_recurse_array (DBusTypeWriter *writer,
133 const char *element_type,
134 DBusTypeWriter *sub);
135 dbus_bool_t _dbus_type_writer_recurse_variant (DBusTypeWriter *writer,
136 const char *contained_type,
137 DBusTypeWriter *sub);
138 dbus_bool_t _dbus_type_writer_unrecurse (DBusTypeWriter *writer,
139 DBusTypeWriter *sub);
143 #endif /* DBUS_MARSHAL_RECURSIVE_H */